blib/lib/FTN/Message/serialno/File.pm

filter: Statementstmt 88.1% 74 / 84 Branchbran 46.1% 24 / 52 Conditioncond 38.1% 8 / 21 MC/DCmcdc 0.0% 0 / 13 Subroutinesub 85.7% 12 / 14 Podpod 50.0% 2 / 4 totaltotal 63.8% 120 / 188 SCAR 43.4
CC
35
Cov
68%
initialize
71.6
get_serialno
11.7
full_filename
2.0
CRAP 77.0
↑ Summary Build »
1 package FTN::Message::serialno::File;
2  
3 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 ▶use warnings FATAL => 'all';
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 3 ▶use File::Spec ();
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 3 ▶use parent 'FTN::Message::serialno';
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 use constant {
11 3 FILE_EXTENSION => 'sn',
12 FILENAME_PATTERN => '^([0-9a-fA-F]{1,8})$',
13 FILENAME_FORMAT => '%x',
14 SERIALNO_FORMAT => '%08x',
15 MAX_TRIES => 5,
16 3 ▶ };
Subroutine BEGIN: called CC=1 SCAR=0.0
17  
18 =encoding utf8
19  
20 =head1 NAME
21  
22 FTN::Message::serialno::File - handles FTN message serialno via file in dedicated directory
23  
24 =head1 VERSION
25  
26 Version 20141120
27  
28 =cut
29  
30 3 our $VERSION = '20141120';
31  
32 =head1 SYNOPSIS
33  
34 use FTN::Message::serialno::File ();
35  
36 my $serialno = FTN::Message::serialno::File -> new( directory => '/home/user/ftn/_serialno' );
37  
38 my $new_serialno = $serialno -> get_serialno;
39  
40 die 'cannot get new serialno' unless defined $new_serialno;
41  
42 # use $new_serialno value for constructing new message
43  
44 =head1 DESCRIPTION
45  
46 This class is for handling serialno value for new FTN messages. Assigns consecutive unique values.
47  
48 =head1 USAGE
49  
50 This class has the following methods:
51  
52 =head2 new
53  
54 Class constructor. Has the following options:
55  
56 =cut
57  
58 sub initialize {
59 1 ▶ my $self = shift;
Subroutine initialize: called CC=23 SCAR=42.7
Pod undocumented
60  
61 1 my %param = @_;
62  
63 =over
64  
65 =item * directory
66  
67 The only mandatory option. Specifies directory where files with serialno are being created and removed. It is recommended to have it as a dedicated directory and not to keep any other files in it.
68  
69 FTN::Message::serialno::File -> new( directory => '/some/dir' );
70  
71 =cut
72  
73 # directory
74 die 'directory parameter should be defined!'
75 unless $param{directory}
76 1 ▶ && -d $param{directory};
Branch: 1 branch
BranchTrueFalseTotal
unless $param{"directory"} and -d $param{"directory"} 0 1 1
Condition33%1/3
$param{"directory"} and -d $param{"directory"}
!ll&&!rl&&r
001
MC/DC0%0/2
$param{"directory"} and -d $param{"directory"}
$param{"directory"} -d $param{"directory"}
Truth table33%1/3
A and B
A= $param{"directory"}B= -d $param{"directory"}
ABresult
0X0
100
111
77  
78 1 $self -> {directory} = $param{directory};
79  
80  
81 =item * file_extension
82  
83 Serialno files extension. Dot before its value will be added.
84  
85 FTN::Message::serialno::File -> new( directory => '/some/dir',
86 file_extension => 'seq',
87 );
88  
89 Default value is 'sn'.
90  
91 =cut
92  
93 1 ▶ my $extension = exists $param{file_extension}? $param{file_extension} : FILE_EXTENSION;
Branch: 1 branch
BranchTrueFalseTotal
exists $param{'file_extension'} ? : 0 1 1
94  
95 =item * filename_pattern
96  
97 Defines pattern and matching files in the directory are considered as serialno files and hence can be removed/renamed. File extension shouldn't be specified as it's added automatically.
98  
99 =cut
100  
101 1 ▶ my $pattern = $param{filename_pattern} || FILENAME_PATTERN;
Condition50%1/2
$param{'filename_pattern'} || '^([0-9a-fA-F]{1,8})$'
l!l
01
MC/DC0%0/1
$param{'filename_pattern'} || '^([0-9a-fA-F]{1,8})$'
$param{'filename_pattern'}
Truth table50%1/2
A
A= $param{'filename_pattern'}
Aresult
11
00
102  
103 =item * filename_format
104  
105 Defines filename format (as in printf) with encoded serialno value. File extension shouldn't be specified as it's added automatically. Filename created with filename_format should match filename_pattern.
106  
107 Default value is '%x'.
108  
109 =cut
110  
111 1 ▶ $self -> {filename_format} = $param{filename_format} || FILENAME_FORMAT;
Condition50%1/2
$param{'filename_format'} || '%x'
l!l
01
MC/DC0%0/1
$param{'filename_format'} || '%x'
$param{'filename_format'}
Truth table50%1/2
A
A= $param{'filename_format'}
Aresult
11
00
112 1 ▶ if ( defined $extension
Branch: 1 branch
BranchTrueFalseTotal
if (defined $extension and length $extension) 1 0 1
Condition33%1/3
defined $extension and length $extension
!ll&&!rl&&r
001
MC/DC0%0/2
defined $extension and length $extension
defined $extension length $extension
Truth table33%1/3
A and B
A= defined $extensionB= length $extension
ABresult
0X0
100
111
113 && length $extension
114 ) {
115 1 ▶ if ( substr( $pattern, -1 ) eq '$' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (substr($pattern, -1) eq '$') { } 1 0 1
116 1 $pattern = substr( $pattern, 0, -1 ) . '\.' . $extension . '$';
117 } else {
118 0 $pattern .= '\.' . $extension;
119 }
120 1 $self -> {filename_format} .= '.' . $extension;
121 }
122 1 $self -> {filename_pattern} = qr/$pattern/;
123  
124  
125 # validate that filename_pattern will match filename_format
126 1 my $t = sprintf $self -> {filename_format}, 1;
127 1 ▶ die 'not matching filename_format ( ' . $self -> {filename_format} . ' ) and filename_pattern ( ' . $self -> {filename_pattern} . ' )'
Branch: 1 branch
BranchTrueFalseTotal
unless $t =~ /$self->{"filename_pattern"}/ 0 1 1
128 unless $t =~ m/$self->{filename_pattern}/;
129  
130  
131 # decode filename
132 $self -> {decode_filename} = $param{decode_filename} && ref $param{decode_filename} eq 'CODE'?
133 $param{decode_filename}
134 : sub {
135 6 ▶ shift =~ m/$self->{filename_pattern}/?
Subroutine __ANON__: called CC=2 SCAR=6.9
Branch: 1 branch
BranchTrueFalseTotal
(shift()) =~ /$self->{'filename_pattern'}/ ? : 2 4 6
136 hex( $1 )
137 : undef;
138 1 ▶ };
Branch: 1 branch
BranchTrueFalseTotal
$param{'decode_filename'} && ref $param{'decode_filename'} eq 'CODE' ? : 0 1 1
Condition33%1/3
$param{"decode_filename"} and ref $param{"decode_filename"} eq "CODE"
!ll&&!rl&&r
100
MC/DC0%0/2
$param{"decode_filename"} and ref $param{"decode_filename"} eq "CODE"
$param{"decode_filename"} ref $param{"decode_filename"} eq "CODE"
Truth table33%1/3
A and B
A= $param{"decode_filename"}B= ref $param{"decode_filename"} eq "CODE"
ABresult
0X0
100
111
139  
140 # encode filename
141 $self -> {encode_filename} = $param{encode_filename} && ref $param{encode_filename} eq 'CODE'?
142 $param{encode_filename}
143 : sub {
144 3 ▶ sprintf $self -> {filename_format}, shift;
Subroutine __ANON__: called CC=1 SCAR=0.0
145 1 ▶ };
Branch: 1 branch
BranchTrueFalseTotal
$param{'encode_filename'} && ref $param{'encode_filename'} eq 'CODE' ? : 0 1 1
Condition33%1/3
$param{"encode_filename"} and ref $param{"encode_filename"} eq "CODE"
!ll&&!rl&&r
100
MC/DC0%0/2
$param{"encode_filename"} and ref $param{"encode_filename"} eq "CODE"
$param{"encode_filename"} ref $param{"encode_filename"} eq "CODE"
Truth table33%1/3
A and B
A= $param{"encode_filename"}B= ref $param{"encode_filename"} eq "CODE"
ABresult
0X0
100
111
146  
147 die 'incorrect decode_filename and/or encode_filename'
148 1 ▶ unless $self -> {decode_filename}( $self -> {encode_filename}( 1 ) ) == 1;
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"decode_filename"}->($self->{"encode_filename"}->(1)) == 1 0 1 1
149  
150  
151 =item * max_tries
152  
153 Defines how many times renaming of the file is tried before it is considered failed.
154  
155 Default value is 5.
156  
157 =cut
158  
159 # max_tries for renaming
160 1 ▶ $self -> {max_tries} = $param{max_tries} && $param{max_tries} =~ m/^(\d+)$/?
Branch: 1 branch
BranchTrueFalseTotal
$param{'max_tries'} && $param{'max_tries'} =~ /^(\d+)$/ ? : 0 1 1
Condition33%1/3
$param{"max_tries"} and $param{"max_tries"} =~ /^(\d+)$/
!ll&&!rl&&r
100
MC/DC0%0/2
$param{"max_tries"} and $param{"max_tries"} =~ /^(\d+)$/
$param{"max_tries"} $param{"max_tries"} =~ /^(\d+)$/
Truth table33%1/3
A and B
A= $param{"max_tries"}B= $param{"max_tries"} =~ /^(\d+)$/
ABresult
0X0
100
111
161 $1
162 : MAX_TRIES;
163  
164  
165 =item * very_first_init
166  
167 Defines reference to a function for generating very first serialno value in case there are no matching files in the directory.
168  
169 The possible values:
170  
171 =over 6
172  
173 =item * CURRENT_UNIXTIME
174  
175 use current unixtime as a starting value.
176  
177 FTN::Message::serialno::File -> new( directory => '/some/dir',
178 very_first_init => 'CURRENT_UNIXTIME',
179 );
180
181  
182 =item * CURRENT_UNIXTIME_MINUS_3_YEARS
183  
184 use current unixtime minus 3 years as a starting value.
185  
186 =item * user defined function
187  
188 FTN::Message::serialno::File -> new( directory => '/some/dir',
189 very_first_init => sub {
190 42; # voices in my head tell me to use 42
191 },
192 );
193  
194 =back
195  
196 Default value is function returning 1.
197  
198 =cut
199  
200 # very_first_init
201 1 ▶ if ( $param{very_first_init} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($param{"very_first_init"}) 0 1 1
202 0 ▶ if ( ref $param{very_first_init} eq 'CODE' ) {
Branch: 3 branches
BranchTrueFalseTotal
if (ref $param{'very_first_init'} eq 'CODE') { } 0 0 0
elsif ($param{'very_first_init'} eq 'CURRENT_UNIXTIME_MINUS_3_YEARS') { } 0 0 0
elsif ($param{'very_first_init'} eq 'CURRENT_UNIXTIME') { } 0 0 0
203 0 $self -> {very_first_init} = $param{very_first_init};
204 } elsif ( $param{very_first_init} eq 'CURRENT_UNIXTIME_MINUS_3_YEARS' ) {
205 0 ▶ $self -> {very_first_init} = sub { time - 3 * 365 * 24 * 60 * 60 };
Subroutine __ANON__: not called CC=1 SCAR=6.9
206 } elsif ( $param{very_first_init} eq 'CURRENT_UNIXTIME' ) {
207 0 ▶ $self -> {very_first_init} = sub { time; };
Subroutine __ANON__: not called CC=1 SCAR=6.9
208 }
209 }
210  
211 1 ▶ $self -> {very_first_init} = sub { 1; }
Subroutine __ANON__: called CC=1 SCAR=0.0
212 1 ▶ unless $self -> {very_first_init};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"very_first_init"} 1 0 1
213  
214 =item * serialno_format
215  
216 serialno format (as in printf) for a return value. Can be changed in case you want another casing ('%08X') or no leading zeroes ('%x') for example.
217  
218 Default value is '%08x'.
219  
220 =back
221  
222 =cut
223  
224 1 ▶ $self -> {serialno_format} = $param{serialno_format} || SERIALNO_FORMAT;
Condition50%1/2
$param{'serialno_format'} || '%08x'
l!l
01
MC/DC0%0/1
$param{'serialno_format'} || '%08x'
$param{'serialno_format'}
Truth table50%1/2
A
A= $param{'serialno_format'}
Aresult
11
00
225 }
226  
227  
228 sub new {
229 1 ▶ ref( my $class = shift ) and Carp::croak 'I am only a class method!';
Subroutine new: called CC=2 SCAR=7.0
Pod documented
Branch: 1 branch
BranchTrueFalseTotal
ref(my $class = shift()) and Carp::croak("I am only a class method!") 0 1 1
230  
231 1 my $self = $class -> SUPER::new( @_ );
232  
233 1 initialize( $self, @_ ); # not $self -> initialize!
234  
235 1 $self;
236 }
237  
238  
239 =head2 get_serialno()
240  
241 Method that does all the work and returns either new valid serialno value or undef.
242  
243 If this is the very first run and no signs of previous serialno values, creates new file with starting value and returns it.
244  
245 If there is just one file with previous serialno value, tries to rename it to a new value (up to defined value (constructor option) times due to parallel execution) and returns that new value on success.
246  
247 If there are more than one file with previous serialno values, sorts them and removes all but last one. Then tries previous approach with last value.
248  
249 If renaming fails more than allowed count, undef is returned.
250  
251 =cut
252  
253 sub get_serialno {
254 2 ▶ ref( my $self = shift ) or Carp::croak 'I am only an object method!';
Subroutine get_serialno: called CC=10 SCAR=24.6
Pod documented
Branch: 1 branch
BranchTrueFalseTotal
ref(my $self = shift()) or Carp::croak("I am only an object method!") 0 2 2
255  
256 2 my $try = 1;
257 2 my $new_serialno;
258  
259 {
260 2 opendir my $dh, $self -> {directory}
261 2 ▶ or die "can't opendir $self->{directory}: $!";
Branch: 1 branch
BranchTrueFalseTotal
opendir my $dh, $self->{"directory"} or die qq[can't opendir $self->{"directory"}: $!] 0 2 2
262  
263 0 my @found_file = sort { $a -> [ 1 ] <=> $b -> [ 1 ] }
264 map {
265 2 my $filename = $_;
266 5 my @r;
267  
268 5 my $t = $self -> {decode_filename}( $filename );
269 5 ▶ if ( defined $t ) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $t) 1 4 5
270 1 my $full_name = $self -> full_filename( $filename );
271  
272 1 ▶ push @r,
Branch: 1 branch
BranchTrueFalseTotal
if -f $full_name 1 0 1
273 [ $full_name,
274 $t,
275 ]
276 if -f $full_name;
277 }
278  
279 5 @r;
280 } readdir $dh;
281  
282 2 closedir $dh;
283  
284 2 ▶ if ( @found_file ) {
Branch: 1 branch
BranchTrueFalseTotal
if (@found_file) { } 1 1 2
285 # as old numbers can be deleted by other process, we don't care about errors here, so let's do it in one shot
286 1 ▶ unlink map $_ -> [ 0 ],
Branch: 1 branch
BranchTrueFalseTotal
if @found_file > 1 0 1 1
287 splice @found_file, 0, -1
288 if @found_file > 1;
289  
290 # here we try to rename
291 1 my $new_id = ( $found_file[ 0 ][ 1 ] + 1 ) & 0xffffffff;
292 1 my $new_file = $self -> full_filename( $self -> {encode_filename}( $new_id ) );
293  
294 1 ▶ if ( rename $found_file[ 0 ][ 0 ], $new_file ) {
Branch: 1 branch
BranchTrueFalseTotal
if (rename $found_file[0][0], $new_file) { } 0 0 0
295 0 $new_serialno = sprintf $self -> {serialno_format}, $new_id;
296 } else { # might be a parallel request
297 0 ▶ redo if $try++ < $self -> {max_tries};
Branch: 1 branch
BranchTrueFalseTotal
if $try++ < $self->{"max_tries"} 0 0 0
298 }
299 } else { # nothing in found_file. must be the very first run. create new file and return id
300 1 my $id = $self -> {very_first_init}();
301  
302 1 my $fn = $self -> full_filename( $self -> {encode_filename}( $id ) );
303 1 ▶ open my $fh, '>', $fn
Branch: 1 branch
BranchTrueFalseTotal
open my $fh, ">", $fn or die 'cannot create file ' . $fn . ': ' . $! 0 1 1
304 or die 'cannot create file ' . $fn . ': ' . $!;
305 1 print $fh $id; # save start value there for a history
306 1 close $fh;
307  
308 1 $new_serialno = sprintf $self -> {serialno_format}, $id;
309 }
310 }
311  
312 1 $new_serialno;
313 }
314  
315  
316 sub full_filename {
317 3 ▶ ref( my $self = shift ) or Carp::croak 'I am only an object method!';
Subroutine full_filename: called CC=2 SCAR=7.1
Pod undocumented
Branch: 1 branch
BranchTrueFalseTotal
ref(my $self = shift()) or Carp::croak("I am only an object method!") 0 3 3
318  
319 3 my $filename = shift;
320  
321 File::Spec -> catfile( $self -> {directory},
322 3 $filename,
323 );
324 }
325  
326 =head1 AUTHOR
327  
328 Valery Kalesnik, C<< <valkoles at gmail.com> >>
329  
330 =head1 BUGS
331  
332 Please report any bugs or feature requests to C<bug-ftn-message-serialno-file at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FTN-Message-serialno-File>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
333  
334 =head1 SUPPORT
335  
336 You can find documentation for this module with the perldoc command.
337  
338 perldoc FTN::Message::serialno::File
339  
340  
341 You can also look for information at:
342  
343 =over 4
344  
345 =item * RT: CPAN's request tracker (report bugs here)
346  
347 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=FTN-Message-serialno-File>
348  
349 =item * AnnoCPAN: Annotated CPAN documentation
350  
351 L<http://annocpan.org/dist/FTN-Message-serialno-File>
352  
353 =item * CPAN Ratings
354  
355 L<http://cpanratings.perl.org/d/FTN-Message-serialno-File>
356  
357 =item * Search CPAN
358  
359 L<http://search.cpan.org/dist/FTN-Message-serialno-File/>
360  
361 =back
362  
363  
364 =head1 ACKNOWLEDGEMENTS
365  
366  
367 =head1 LICENSE AND COPYRIGHT
368  
369 Copyright 2014 Valery Kalesnik.
370  
371 This program is free software; you can redistribute it and/or modify it
372 under the terms of the the Artistic License (2.0). You may obtain a
373 copy of the full license at:
374  
375 L<http://www.perlfoundation.org/artistic_license_2_0>
376  
377 Any use, modification, and distribution of the Standard or Modified
378 Versions is governed by this Artistic License. By using, modifying or
379 distributing the Package, you accept this license. Do not use, modify,
380 or distribute the Package, if you do not accept this license.
381  
382 If your Modified Version has been derived from a Modified Version made
383 by someone other than you, you are nevertheless required to ensure that
384 your Modified Version complies with the requirements of this license.
385  
386 This license does not grant you the right to use any trademark, service
387 mark, tradename, or logo of the Copyright Holder.
388  
389 This license includes the non-exclusive, worldwide, free-of-charge
390 patent license to make, have made, use, offer to sell, sell, import and
391 otherwise transfer the Package with respect to any patent claims
392 licensable by the Copyright Holder that are necessarily infringed by the
393 Package. If you institute patent litigation (including a cross-claim or
394 counterclaim) against any party alleging that the Package constitutes
395 direct or contributory patent infringement, then this Artistic License
396 to you shall terminate on the date that such litigation is filed.
397  
398 Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
399 AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
400 THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
401 PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
402 YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
403 CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
404 CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
405 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
406  
407 =cut
408  
409 3 1;
↑ Summary Build »