TT/DBx/Field.pm untested

filter: Statementstmt 0.0% 0 / 104 Branchbran 0.0% 0 / 34 Conditioncond 0.0% 0 / 54 MC/DCmcdc 0.0% 0 / 31 Subroutinesub 0.0% 0 / 23 Podpod 0.0% 0 / 15 totaltotal 0.0% 0 / 261 CC 18 SCAR 25.4
CC
18
Cov
0%
open
30.0
copy
30.0
name2file
20.0
CRAP 12.7
1 ## -*- Mode: CPerl -*-
2 ## File: Lingua::TT::DBx::Field.pm
3 ## Author: Bryan Jurish <TT/IO.pm>
4 ## Descript: TT I/O: Berkely DB: enumerated fields
5  
6 package Lingua::TT::DBx::Field;
7 use Lingua::TT::DBFile;
8 use Lingua::TT::Enum;
9 use Lingua::TT::Persistent;
10 use DB_File;
11 use Fcntl;
12 use Carp;
13 use File::Copy qw();
14 use strict;
15  
16 ##==============================================================================
17 ## Globals & Constants
18  
19 our @ISA = qw(Lingua::TT::Persistent);
20  
21 ##==============================================================================
22 ## Constructors etc.
23  
24 ## $f = CLASS_OR_OBJECT->new(%opts)
25 ## + no implicit open() on new!
26 ## + %opts, %$doc:
27 ## ##-- user options
28 ## name => $name, ##-- field name (default=undef)
29 ## dir => $dir, ##-- base directory (default='.')
30 ## packfmt => $packfmt, ##-- packed $data format (default='L')
31 ## get => $codestr, ##-- code to get field data in $_=[$data1,$data2,...]
32 ## ## + compiled to a temporary sub $getsub = eval "sub { $codestr }"
33 ## ## + should return ARRAY of matched token data columns
34 ## ## + called as:
35 ## ## $field_value_string = join("\t", $getsub->());
36 ## ## + default: @$_
37 ##
38 ## ##-- low-level data
39 ## file => $file, ##-- basename of field data files (default=undef --> from 'name')
40 ## flags => $O_XYZ, ##-- flags mask for dbf
41 ## enum => $enum, ##-- Lingua::TT::Enum: "${file}.enum"
42 ## dbf => $dbfile, ##-- Lingua::TT::DBFile::PackedArray: "${file}.db"
43 ## data => $thingy, ##-- = $doc->{dbf}{data}
44 sub new {
45 my $that = shift;
46 my $f = bless({
47 name => undef,
48 dir => '.',
49 packfmt => 'L',
50 get => '@$_',
51 file => undef,
52 enum => undef,
53 dbf => undef,
54 data => undef,
55 @_
56 }, ref($that)||$that);
57 return $f;
58 }
59  
60 ## undef = $f->clear()
61 sub clear {
62 my $f = shift;
63 return if (!$f->opened);
64 $f->{enum}->clear;
65 $f->{dbf}->clear;
66 return $f;
67 }
68  
69 ##==============================================================================
70 ## Methods: I/O
71  
72 ## $file = $CLASS_OR_OBJ->name2file($name)
73 sub name2file {
74 my ($f,$name) = @_;
75 $name = $f->{name} if (!defined($name) && defined($f->{name}));
76 $name = '' if (!defined($name));
77 my $file = $name;
78 $file =~ s/[\s\/\:\;\#]/_/g;
79 $file = $f->{dir}.'/'.$name if (ref($f) && defined($f->{dir}));
80 return $file;
81 }
82  
83 ## $file = $f->filename()
84 sub filename {
85 return $_[0]->name2file();
86 }
87  
88 ## $bool = $f->opened()
89 sub opened {
90 return defined($_[0]{data});
91 }
92  
93 ## $f = $f->close(%opts)
94 ## + %opts:
95 ## nosync => $bool, ##-- if true, no sync() will be performed
96 sub close {
97 my ($f,%opts) = @_;
98 delete($f->{data});
99 if (!$opts{nosync}) {
100 $f->sync() or warn(ref($f)."::close(): sync failed: $!");
101 }
102 $f->{dbf}->close if (defined($f->{dbf}));
103 delete(@$f{qw(enum dbf)});
104 return $f;
105 }
106  
107 ## $bool = $f->sync()
108 ## + syncs enum to file too
109 sub sync {
110 my $f = shift;
111 my $rc = 1;
112 my $file = $f->{file};
113 if (defined($f->{enum}) && $file) {
114 $rc &&= $f->{enum}->saveNativeFile("$file.enum")
115 or warn(ref($f)."::sync(): save failed for enum file '$file.enum': $!");
116 }
117 if (defined($f->{dbf})) {
118 $rc &&= $f->{dbf}->sync()
119 or warn(ref($f)."::sync(): save failed for enum file '$file.enum': $!");
120 }
121 return $rc;
122 }
123  
124 ## $f = $f->open(%opts)
125 ## + %opts are as for new()
126 sub open {
127 my ($f,%opts) = @_;
128 $f->close() if ($f->opened());
129 @$f{keys %opts} = values(%opts);
130 confess(ref($f)."::open(): no 'name' key defined!") if (!defined($f->{name}));
131 my $file = $f->{file} = $f->filename();
132  
133 $f->{enum} = Lingua::TT::Enum->new();
134 $f->{dbf} = Lingua::TT::DBFile::PackedArray->new(packfmt=>$f->{packfmt});
135  
136 ##-- truncate enum?
137 if (defined($f->{flags}) && ($f->{flags}&O_TRUNC)) {
138 my $fh = IO::File->new(">${file}.enum")
139 or confess(ref($f)."::load(): truncate failed for enum file '$file.enum': $!");
140 $fh->close;
141 }
142  
143 ##-- load file(s)
144 $f->{enum}->loadNativeFile("${file}.enum")
145 or confess(ref($f)."::load() failed for field enum file '${file}.enum': $!");
146 $f->{dbf}->open($file.".db",
147 (defined($f->{flags}) ? (flags=>$f->{flags}) : qw()),
148 )
149 or confess(ref($f)."::open() failed for field data file '${file}.db': $!");
150  
151 ##-- local references
152 $f->{data} = $f->{dbf}{data};
153  
154 return $f;
155 }
156  
157 ## $bool = $f->copy($file2);
158 ## $bool = PACKAGE::copy($file1,$file2)
159 sub copy {
160 my ($f,$file2) = @_;
161 my $that = ref($f) || __PACKAGE__;
162 my $file1 = ref($f) ? $f->filename : $f;
163 confess("${that}::copy(): no source specified!") if (!defined($file1));
164 confess("${that}::copy(): no destination specified!") if (!defined($file2));
165 if (ref($f)) { $f->sync() or confess("${that}::copy(): sync failed: $!"); }
166 File::Copy::copy("$file1.enum","$file2.enum")
167 or confess("${that}::copy() failed for enum file from '$file1.enum' to '$file2.enum': $!");
168 File::Copy::copy("$file1.db","$file2.db")
169 or confess("${that}::copy() failed for DB file from '$file1.db' to '$file2.db': $!");
170 return 1;
171 }
172  
173 ## @filenames = $f->datafiles()
174 ## @filenames = $CLASS_OR_OBJ->datafiles($name)
175 ## @suffixes = $CLASS->datafiles()
176 sub datafiles {
177 my ($f,$name) = @_;
178 my $file = $f->name2file($name);
179 return ("$file.enum", "$file.db");
180 }
181  
182 ## $bool = $f->fileExists()
183 ## $bool = $f->fileExists($name)
184 sub fileExists {
185 my ($f,$name) = @_;
186 my $file = $f->name2file($name);
187 return (-e "$file.enum" && -e "$file.db");
188 }
189  
190 ## $bool = $f->truncate()
191 ## $bool = $f->truncate($name)
192 sub truncate {
193 my ($f,$name) = @_;
194 my $file = $f->name2file($name);
195 return ((!-e "$file.db" || unlink("$file.db"))
196 &&
197 (!-e "$file.enum" || CORE::truncate("$file.enum",0)));
198 }
199  
200 ##==============================================================================
201 ## Methods: I/O: TT::Persistent
202  
203 ## @keys = $f->noSaveKeys
204 sub noSaveKeys {
205 return qw(enum dbf data getsub);
206 }
207  
208 ##==============================================================================
209 ## Methods: Access and Manipulation
210  
211 ## $f = $f->compileClosures()
212 sub compileClosures {
213 my $f = shift;
214 $f->{getsub} = eval "sub { $f->{get} }";
215 return $f;
216 }
217  
218 ## $bool = $f->putToken(\@tok)
219 ## + adds field data for single token
220 our ($put_val,$put_id);
221 sub putToken {
222 local $_ = $_[1];
223 $put_val = join("\t",grep {defined($_)} $_[0]{getsub}->());
224 $put_id = $_[0]{enum}->getId($put_val) if (!defined($put_id=$_[0]{enum}{sym2id}{$put_val}));
225 push(@{$_[0]{data}}, pack($_[0]{packfmt},$put_id));
226 }
227  
228  
229 ##==============================================================================
230 ## Footer
231 1;
232  
233 __END__