File Coverage

blib/lib/Biblio/COUNTER/Processor/Atomize.pm

Criterion	Covered	Total	%
statement	9	36	25.0
branch	0	10	0.0
condition	0	2	0.0
subroutine	3	7	42.8
pod	0	3	0.0
total	12	58	20.6

line	stmt	bran	cond	sub	pod	time	code
1							package Biblio::COUNTER::Processor::Atomize;
2
3	1			1		1070	use warnings;
	1					3
	1					34
4	1			1		2184	use strict;
	1					5
	1					67
5
6	1			1		6	use Biblio::COUNTER::Processor;
	1					2
	1					1663
7
8							@Biblio::COUNTER::Processor::Atomize::ISA = qw(Biblio::COUNTER::Processor);
9
10							sub begin_report {
11	0			0	0		my ($self, $report) = @_;
12	0						$self->{'number'} = 1;
13							}
14
15							sub end_report {
16	0			0	0		my ($self, $report) = @_;
17	0						undef $self->{'number'};
18							}
19
20							sub end_record {
21	0			0	0		my ($self, $report, $rec) = @_;
22	0		0				my $cb = $self->{'callback'} \|\|= \&_default_callback;
23	0						my $count = delete $rec->{'count'};
24	0						foreach my $period (sort keys %$count) {
25	0						my $period_counts = $count->{$period};
26	0	0					if (ref $period_counts) {
27	0						while (my ($metric, $count) = each %$period_counts) {
28	0						$cb->(
29							'processor' => $self,
30							'report' => $report,
31							'recnum' => $self->{'number'}++,
32							%$rec,
33							'period' => $period,
34							'metric' => $metric,
35							'count' => $count,
36							);
37							}
38							}
39							else {
40	0						die "Huh?";
41							}
42							}
43							}
44
45							sub _default_callback {
46	0			0			my %data = @_;
47	0						my $code = $data{'code'} = $data{'report'}->canonical_report_code;
48	0						$data{'file'} = $data{'processor'}->{'file'};
49	0						my @header = qw(Type File Platform Period Metric Count Title Publisher);
50	0						my @data = @data{qw(code file platform period metric count title publisher)};
51	0	0					if ($code =~ /^J/) {
		0
52	0						push @header, "Print ISSN", "Online ISSN";
53	0						push @data, @data{qw(print_issn online_issn)};
54							}
55							elsif ($code =~ /^B/) {
56	0						push @header, "ISBN";
57	0						push @data, @data{qw(isbn)};
58							}
59	0	0					if ($data{'recnum'} == 1) {
60	0						print join("\t", @header), "\n";
61							}
62	0	0					print join("\t", map { defined $_ ? $_ : '' } @data), "\n";
	0
63							}
64
65
66							1;
67
68							=pod
69
70							=head1 NAME
71
72							Biblio::COUNTER::Processor::Atomize - break a COUNTER report into itsy pieces
73
74							=head1 SYNOPSIS
75
76							use Biblio::COUNTER::Processor::Atomize;
77							$processor = Biblio::COUNTER::Processor::Atomize->new;
78							$report = $processor->run($file_or_filehandle);
79
80							=head1 DESCRIPTION
81
82							B breaks a COUNTER report into
83							tiny pieces (figuratively speaking) and executes a callback for each
84							valid usage number it finds.
85
86							The callback function should look something like this:
87
88							sub my_callback {
89							my %data = @_;
90							$title = $data{title};
91							$count = $data{count};
92							$metric = $data{metric};
93							$period = $data{period};
94							# etc.
95							}
96
97							The following elements may appear in the hash passed to the callback function:
98
99							=over 4
100
101							=item B
102
103							The short code that indicates the type of the report (e.g., C or C).
104
105							=item B
106
107							The name of the file containing the report. Set to C<-> if processing
108							standard input.
109
110							=item B
111
112							The Biblio::COUNTER::Processor::Atomize instance.
113
114							=item B
115
116							The instance of the appropriate subclass of Biblio::COUNTER::Report
117
118							=item B
119
120							A string of the form I denoting the period in question.
121
122							=item B
123
124							The type of event counted (C, C, C, or
125							C).
126
127							=item B
128
129							The count itself. The callback is B executed for a blank or invalid count.
130
131							=item B
132
133							The platform on which the resource was provided.
134
135							=item B </td> </tr> <tr> <td class="h" > <a name="136">136</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="137">137</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The resource title. </td> </tr> <tr> <td class="h" > <a name="138">138</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="139">139</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<publisher> </td> </tr> <tr> <td class="h" > <a name="140">140</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="141">141</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The resource's publisher. May be the empty string. </td> </tr> <tr> <td class="h" > <a name="142">142</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="143">143</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<print_issn> (journal reports only) </td> </tr> <tr> <td class="h" > <a name="144">144</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="145">145</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The journal's print ISSN. </td> </tr> <tr> <td class="h" > <a name="146">146</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="147">147</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<online_issn> (journal reports only) </td> </tr> <tr> <td class="h" > <a name="148">148</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="149">149</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The journal's online ISSN. </td> </tr> <tr> <td class="h" > <a name="150">150</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="151">151</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<isbn> (book reports only) </td> </tr> <tr> <td class="h" > <a name="152">152</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="153">153</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The book's ISBN. </td> </tr> <tr> <td class="h" > <a name="154">154</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="155">155</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="156">156</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="157">157</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 PUBLIC METHODS </td> </tr> <tr> <td class="h" > <a name="158">158</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="159">159</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =over 4 </td> </tr> <tr> <td class="h" > <a name="160">160</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="161">161</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<new>(I<%args>) </td> </tr> <tr> <td class="h" > <a name="162">162</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="163">163</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> $foo = Biblio::COUNTER::Processor::Atomize->new; </td> </tr> <tr> <td class="h" > <a name="164">164</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="165">165</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> I<%args> is a list of (key, value) pairs. The only key that means </td> </tr> <tr> <td class="h" > <a name="166">166</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> anything is B<callback>; the value associated with it is a reference to </td> </tr> <tr> <td class="h" > <a name="167">167</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> the desired callback function. </td> </tr> <tr> <td class="h" > <a name="168">168</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="169">169</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> The desired callback function prints (to standard output) a single </td> </tr> <tr> <td class="h" > <a name="170">170</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> tab-delimited line for each datum, with a header. Each line of output has </td> </tr> <tr> <td class="h" > <a name="171">171</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> the following elements, in the order listed: </td> </tr> <tr> <td class="h" > <a name="172">172</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="173">173</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =over 4 </td> </tr> <tr> <td class="h" > <a name="174">174</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="175">175</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<code> </td> </tr> <tr> <td class="h" > <a name="176">176</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="177">177</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<file> </td> </tr> <tr> <td class="h" > <a name="178">178</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="179">179</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<platform> </td> </tr> <tr> <td class="h" > <a name="180">180</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="181">181</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<period> </td> </tr> <tr> <td class="h" > <a name="182">182</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="183">183</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<metric> </td> </tr> <tr> <td class="h" > <a name="184">184</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="185">185</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<count> </td> </tr> <tr> <td class="h" > <a name="186">186</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="187">187</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<title> </td> </tr> <tr> <td class="h" > <a name="188">188</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="189">189</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<publisher> </td> </tr> <tr> <td class="h" > <a name="190">190</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="191">191</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<print_issn> (journal reports only) </td> </tr> <tr> <td class="h" > <a name="192">192</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="193">193</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<online_issn> (journal reports only) </td> </tr> <tr> <td class="h" > <a name="194">194</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="195">195</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<isbn> (book reports only) </td> </tr> <tr> <td class="h" > <a name="196">196</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="197">197</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="198">198</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="199">199</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =item B<run>(I<$file>) </td> </tr> <tr> <td class="h" > <a name="200">200</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="201">201</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> $report = $processor->run($what); </td> </tr> <tr> <td class="h" > <a name="202">202</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="203">203</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Process the given report. </td> </tr> <tr> <td class="h" > <a name="204">204</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="205">205</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> I<$what> may be a file handle, the name of a file, or an instance of </td> </tr> <tr> <td class="h" > <a name="206">206</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> (a subclass of) L<Biblio::COUNTER::Report\|Biblio::COUNTER::Report>. </td> </tr> <tr> <td class="h" > <a name="207">207</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="208">208</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =back </td> </tr> <tr> <td class="h" > <a name="209">209</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="210">210</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 INHERITANCE </td> </tr> <tr> <td class="h" > <a name="211">211</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="212">212</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> B<Biblio::COUNTER::Processor::Atomize> is designed to be inheritable. </td> </tr> <tr> <td class="h" > <a name="213">213</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="214">214</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 BUGS </td> </tr> <tr> <td class="h" > <a name="215">215</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="216">216</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> There are no known bugs. Please report bugs to the author via e-mail </td> </tr> <tr> <td class="h" > <a name="217">217</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> (see below). </td> </tr> <tr> <td class="h" > <a name="218">218</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="219">219</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 AUTHOR </td> </tr> <tr> <td class="h" > <a name="220">220</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="221">221</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Paul Hoffman (nkuitse AT cpan DOT org) </td> </tr> <tr> <td class="h" > <a name="222">222</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="223">223</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 COPYRIGHT </td> </tr> <tr> <td class="h" > <a name="224">224</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="225">225</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> Copyright 2008 Paul M. Hoffman. </td> </tr> <tr> <td class="h" > <a name="226">226</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="227">227</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> This is free software, and is made available under the same terms as Perl </td> </tr> <tr> <td class="h" > <a name="228">228</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> itself. </td> </tr> <tr> <td class="h" > <a name="229">229</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="230">230</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> =head1 SEE ALSO </td> </tr> <tr> <td class="h" > <a name="231">231</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="232">232</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> L<Biblio::COUNTER> </td> </tr> <tr> <td class="h" > <a name="233">233</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="234">234</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> L<Biblio::COUNTER::Report> </td> </tr> <tr> <td class="h" > <a name="235">235</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> <tr> <td class="h" > <a name="236">236</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> L<Biblio::COUNTER::Report::Processor> </td> </tr> <tr> <td class="h" > <a name="237">237</a> </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td > </td> <td class="s"> </td> </tr> </table> </body> </html>