blib/lib/Catmandu/Buffer.pm

filter: Statementstmt 100% 22 / 22 Branchbran 100% 2 / 2 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 9 / 9 Podpod 80.0% 4 / 5 totaltotal 97.3% 37 / 38 CC 2 SCAR 1.8
CC
2
Cov
100%
buffer_is_full
2.0
BEGIN
1.0
BEGIN
1.0
CRAP 1.2
« blib/lib/Catmandu/Fix/retain.pm ↑ Summary blib/lib/Catmandu/Hits.pm »
1 package Catmandu::Buffer;
2  
3 1 ▶use Catmandu::Sane;
Subroutine BEGIN: called CC=1 SCAR=0.0
4  
5 1 our $VERSION = '1.0201_02';
6  
7 1 ▶use Moo::Role;
Subroutine BEGIN: called CC=1 SCAR=0.0
8 1 ▶use namespace::clean;
Subroutine BEGIN: called CC=1 SCAR=0.0
9  
10 1 has buffer_size => (is => 'ro', lazy => 1, builder => 'default_buffer_size');
11 1 ▶has buffer => (is => 'rwp', lazy => 1, default => sub {[]});
Subroutine __ANON__: called CC=1 SCAR=0.0
12  
13 2 ▶sub default_buffer_size {100}
Subroutine default_buffer_size: called CC=1 SCAR=0.0
Pod undocumented
14  
15 sub clear_buffer {
16 1 ▶ $_[0]->_set_buffer([]);
Subroutine clear_buffer: called CC=1 SCAR=0.0
Pod documented
17 }
18  
19 sub buffer_used {
20 7 ▶ scalar @{$_[0]->buffer};
Subroutine buffer_used: called CC=1 SCAR=0.0
Pod documented
21 }
22  
23 sub buffer_is_full {
24 3 ▶ my $self = $_[0];
Subroutine buffer_is_full: called CC=2 SCAR=6.9
Pod documented
25 3 ▶ $self->buffer_used >= $self->buffer_size ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
$self->buffer_used >= $self->buffer_size ? : 1 2 3
26 }
27  
28 sub buffer_add {
29 2 ▶ my $buffer = shift->buffer;
Subroutine buffer_add: called CC=1 SCAR=0.0
Pod documented
30 2 push @$buffer, @_;
31 }
32  
33 1 1;
34  
35 __END__
36  
37 =pod
38  
39 =head1 NAME
40  
41 Catmandu::Buffer - A base class for modules that need an array buffer
42  
43 =head1 SYNOPSIS
44  
45 package MyPackage;
46  
47 use Moo;
48  
49 with 'Catmandu::Buffer';
50  
51 # Print only when the buffer is full...
52 sub print {
53 my ($self,$str) = @_;
54  
55 if ($self->buffer_is_full) {
56 print join "\n" , @{ $self->buffer };
57  
58 $self->clear_buffer;
59 }
60  
61 $self->buffer_add($str);
62 }
63  
64 package main;
65  
66 my $x = MyPackage->new;
67  
68 for (my $i = 0 ; $i < 1000 ; $i++) {
69 $x->print($x);
70 }
71  
72 =head1 ATTRIBUTES
73  
74 =head2 buffer
75  
76 A ARRAY reference to the content of the buffer.
77  
78 =head2 buffer_size(MAX)
79  
80 The maximum size of a buffer.
81  
82 =head1 METHODS
83  
84 =head2 clear_buffer()
85  
86 Empty the buffer.
87  
88 =head2 buffer_used()
89  
90 Returns a true value when there is content in the buffer.
91  
92 =head2 buffer_is_full()
93  
94 Returns a true value when the buffer has reached its maximum capacity.
95  
96 =head2 buffer_add($x)
97  
98 Adds $x to the buffer.
99  
100 =head1 SEE ALSO
101  
102 L<Catmandu::Solr::Bag>
103  
104 =cut
« blib/lib/Catmandu/Fix/retain.pm ↑ Summary blib/lib/Catmandu/Hits.pm »