lib/BoutrosLab/TSVStream/IO/Role/Dyn.pm

filter: Statementstmt 72.4% 42 / 58 Branchbran 28.5% 4 / 14 Conditioncond 16.6% 1 / 6 MC/DCmcdc 0.0% 0 / 4 Subroutinesub 83.3% 10 / 12 Podpod 0.0% 0 / 1 totaltotal 60.0% 57 / 95 CC 11 SCAR 19.5
CC
11
Cov
60%
__ANON__
20.0
BUILD
8.2
__ANON__
6.7
CRAP 7.0
« lib/BoutrosLab/TSVStream/IO/Role/Reader/Fixed.pm ↑ Summary lib/BoutrosLab/TSVStream/Format/AnnovarInput/Types.pm »
1 package BoutrosLab::TSVStream::IO::Role::Dyn;
2  
3 # safe Perl
4 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
7  
8 1 ▶use Moose::Role;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 1 ▶use namespace::autoclean;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 1 ▶use BoutrosLab::TSVStream::IO::Reader::Dyn;
Subroutine BEGIN: called CC=1 SCAR=0.0
12 1 ▶use BoutrosLab::TSVStream::IO::Writer::Dyn;
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 1 with 'BoutrosLab::TSVStream::IO::Role::Fixed';
15  
16 =head1 NAME
17  
18 BoutrosLab::TSVStreamDyn::IO::Role::Dyn
19  
20 =head1 SYNOPSIS
21  
22 # in a Moose class definition...
23  
24 my $_fields = [ qw(foo bar) ];
25 sub _fields { return $_fields }
26  
27 with 'BoutrosLab::TSVStream::IO::Role::Dyn';
28  
29 has 'foo' => ( ... );
30 has 'bar' => ( ... );
31 ...
32  
33 =head1 DESCRIPTION
34  
35 This role provides methods to create a file/iostream reader/writer
36 for a class, using a stream of lines with tab separated fields for
37 each record, converting to/from an object of the class. Usually,
38 the stream will start with an initial line that has the field names
39 as a tab separated record.
40  
41 This is essentially the same as a TSVStream::IO::Role::Fixed, but for
42 a TSVStream::IO::Role::Dyn the list of fixed name fields (which may be
43 empty), is followed by a dynamically determined list of extra fields.
44 The entire stream must consistently contain the same number of fields
45 in each record.
46  
47 This role provides attributes C<dyn_names> and C<dyn_values>,
48 which are both arrays of strings. C<dyn_names> contains the names
49 of the extra fields that follow the ones specified in _fields.
50 This attribute will have the same list of names for every record
51 returned from a single reader object, and should contain the same
52 list of names for every record passed to a single writer object.
53 C<dyn_values> is the list of values read or to be written for
54 each record in a stream (and these can be different, of course).
55  
56 This role also provided a BUILDARGS wrapper that alows the
57 constructor to be given field_values=>[fld1,fld2,...] instead of
58 providing each field explicitly by name. You can either provide
59 all of the values (both for the _fields and the dyn_fields) in this
60 one array, or else you can provide field_values=[fid1,fld2,...] and
61 dyn_values=>[dyn_1,dyn_2,...] as two separate arguments.
62  
63 =cut
64  
65 111 ▶sub _reader_class {
Subroutine _reader_class: called CC=1 SCAR=0.0
66 111 return 'BoutrosLab::TSVStream::IO::Reader::Dyn';
67 }
68  
69 0 ▶sub _writer_class {
Subroutine _writer_class: not called CC=1 SCAR=6.9
70 0 return 'BoutrosLab::TSVStream::IO::Writer::Dyn';
71 }
72  
73 1 has dyn_fields => (
74 is => 'ro',
75 required => 1,
76 isa => 'ArrayRef[Str]'
77 );
78  
79 1 has dyn_values => (
80 is => 'rw',
81 required => 1,
82 isa => 'ArrayRef[Str]'
83 );
84  
85 84 ▶around BUILDARGS => sub {
Subroutine __ANON__: called CC=6 SCAR=19.0
86 84 my $orig = shift;
87 84 my $class = shift;
88 84 ▶ my $arg = ref($_[0]) ? $_[0] : { @_ };
Branch: 1 branch
BranchTrueFalseTotal
ref $_[0] ? : 84 0 84
89 84 ▶ if (my $field_values = delete $arg->{field_values}) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $field_values = delete $arg->{"field_values"}) 84 0 84
90 84 my $fldnames = $class->_fields;
91 84 my @v = @$field_values;
92 84 ▶ if (defined $fldnames && ref($fldnames)) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $fldnames and ref $fldnames) 84 0 84
Condition33%1/3
defined $fldnames and ref $fldnames
!ll&&!rl&&r
0084
MC/DC0%0/2
defined $fldnames and ref $fldnames
defined $fldnames ref $fldnames
Truth table33%1/3
A and B
A= defined $fldnamesB= ref $fldnames
ABresult
0X0
100
111
93 84 $arg->{ $_ } = shift @v for @$fldnames;
94 }
95 84 $arg->{dyn_values} = \@v;
96 }
97 84 $class->$orig( $arg );
98 1 };
99  
100 # add a reader/writer access method for each dynamic fieldname
101 # (these are not attributes - they modify the values array)
102  
103 1 has install_methods => (
104 is => 'ro',
105 isa => 'Bool',
106 default => 0
107 );
108  
109 84 ▶sub BUILD {
Subroutine BUILD: called CC=3 SCAR=21.1
Pod undocumented
110 84 my $self = shift;
111 84 ▶ unless ($self->install_methods) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->install_methods) 84 0 84
112 84 $self->_check_dups( $self->_fields );
113 84 return;
114 }
115  
116 0 $self->_check_dups( @{ $self->_fields}, @{ $self->dyn_fields } );
117  
118 0 my $meta = $self->meta;
119 0 my $df = $self->dyn_fields;
120 0 ▶ while(my($ind, $fld) = each @$df) {
Branch: 1 branch
BranchTrueFalseTotal
if (() = each @$df) 0 0 0
121 0 ▶ $meta->add_method( $fld => sub {
Subroutine __ANON__: not called CC=4 SCAR=30.0
122 0 my $self = shift;
123 my $seen = $self->install_methods
124 0 ▶ && grep { $_ eq $fld } @{ $self->dyn_fields };
Condition0%0/3
$self->install_methods && grep({$_ eq $fld;} @{$self->dyn_fields;})
!ll&&!rl&&r
000
MC/DC0%0/2
$self->install_methods && grep({$_ eq $fld;} @{$self->dyn_fields;})
$self->install_methods grep({$_ eq $fld;} @{$self->dyn_fields;})
Truth table0%0/3
A && B
A= $self->install_methodsB= grep({$_ eq $fld;} @{$self->dyn_fields;})
ABresult
0X0
100
111
125 # print(
126 # " Validating attribute $fld against: (",
127 # join( ', ', @{ $self->dyn_fields } ),
128 # ") ",
129 # ( $seen ? "good\n" : "BAD\n" )
130 # );
131 0 ▶ croak( "calling dynamic attribute ($fld) not in this stream" )
Branch: 1 branch
BranchTrueFalseTotal
unless $seen 0 0 0
132 unless $seen;
133 0 my $values = $self->dyn_values;
134 0 ▶ $values->[$ind] = shift if @_;
Branch: 1 branch
BranchTrueFalseTotal
if @_ 0 0 0
135 0 $values->[$ind];
136 0 } );
137 }
138 }
139  
140  
141 =head1 AUTHOR
142  
143 John Macdonald - Boutros Lab
144  
145 =head1 ACKNOWLEDGEMENTS
146  
147 Paul Boutros, Phd, PI - Boutros Lab
148  
149 The Ontario Institute for Cancer Research
150  
151 =cut
152  
153 1 1;
154  
« lib/BoutrosLab/TSVStream/IO/Role/Reader/Fixed.pm ↑ Summary lib/BoutrosLab/TSVStream/Format/AnnovarInput/Types.pm »