HasStemma.pm

filter: Statementstmt 88.2% 45 / 51 Branchbran 40.0% 4 / 10 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 88.8% 8 / 9 Podpod 100% 2 / 2 totaltotal 81.9% 59 / 72 CC 7 SCAR 10.7
CC
7
Cov
80%
__ANON__
6.0
record_stemweb_result
4.1
add_stemma
3.2
CRAP 2.9
« Analysis/Result.pm ↑ Summary
1 package Text::Tradition::HasStemma;
2  
3 4 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 4 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 4 ▶use Moose::Role;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 4 ▶use Date::Parse;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 4 ▶use Text::Tradition::Stemma;
Subroutine BEGIN: called CC=1 SCAR=0.0
8  
9 =head1 NAME
10  
11 Text::Tradition::HasStemma - add-on to associate stemma hypotheses to
12 Text::Tradition objects
13  
14 =head1 DESCRIPTION
15  
16 It is often the case that, for a given text tradition, the order of copying
17 of the witnesses can or should be reconstructed (or at least the attempt
18 should be made.) This class is a role that can be applied to
19 Text::Tradition objects to record stemma hypotheses. See the documentation
20 for L<Text::Tradition::Stemma> for more information.
21  
22 =head1 METHODS
23  
24 =head2 stemmata
25  
26 Return a list of all stemmata associated with the tradition.
27  
28 =head2 stemma_count
29  
30 Return the number of stemma hypotheses defined for this tradition.
31  
32 =head2 stemma( $idx )
33  
34 Return the L<Text::Tradition::Stemma> object identified by the given index.
35  
36 =head2 clear_stemmata
37  
38 Delete all stemma hypotheses associated with this tradition.
39  
40 =head2 has_stemweb_jobid
41  
42 Returns true if there is currently a Stemweb job ID, indicating that a
43 stemma tree calculation from the Stemweb service is in process.
44  
45 =head2 stemweb_jobid
46  
47 Return the currently-running job ID (if any) for calculation of Stemweb
48 trees.
49  
50 =head2 set_stemweb_jobid( $jobid )
51  
52 Record a job ID for a Stemweb calculation.
53  
54 =cut
55  
56 has 'stemmata' => (
57 traits => ['Array'],
58 isa => 'ArrayRef[Text::Tradition::Stemma]',
59 handles => {
60 stemmata => 'elements',
61 _add_stemma => 'push',
62 stemma => 'get',
63 stemma_count => 'count',
64 clear_stemmata => 'clear',
65 },
66 4 ▶ default => sub { [] },
Subroutine __ANON__: called CC=1 SCAR=0.0
67 4 );
68
69 4 has 'stemweb_jobid' => (
70 is => 'ro',
71 isa => 'Str',
72 writer => 'set_stemweb_jobid',
73 predicate => 'has_stemweb_jobid',
74 clearer => '_clear_stemweb_jobid',
75 );
76
77 0 ▶before 'set_stemweb_jobid' => sub {
Subroutine __ANON__: not called CC=2 SCAR=17.9
78 0 my( $self ) = shift;
79 0 ▶ if( $self->has_stemweb_jobid ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($self->has_stemweb_jobid) 0 0 0
80 0 $self->throw( "Tradition already has a Stemweb jobid: "
81 . $self->stemweb_jobid );
82 }
83 4 };
84  
85 =head2 add_stemma( dotfile => $dotfile )
86 =head2 add_stemma( dot => $dotstring )
87 =head2 add_stemma( $stemma_obj )
88  
89 Initializes a Text::Tradition::Stemma object from the given dotfile,
90 and associates it with the tradition.
91  
92 =begin testing
93  
94 use Text::Tradition;
95  
96 my $t = Text::Tradition->new(
97 'name' => 'simple test',
98 'input' => 'Tabular',
99 'file' => 't/data/simple.txt',
100 );
101 is( $t->stemma_count, 0, "No stemmas added yet" );
102 my $s;
103 ok( $s = $t->add_stemma( dotfile => 't/data/simple.dot' ), "Added a simple stemma" );
104 is( ref( $s ), 'Text::Tradition::Stemma', "Got a stemma object returned" );
105 is( $t->stemma_count, 1, "Tradition claims to have a stemma" );
106 is( $t->stemma(0), $s, "Tradition hands back the right stemma" );
107  
108 =end testing
109  
110 =cut
111  
112 3 ▶sub add_stemma {
Subroutine add_stemma: called CC=3 SCAR=11.6
Pod documented
113 3 my $self = shift;
114 3 my $stemma;
115 3 ▶ if( ref( @_ ) eq 'Text::Tradition::Stemma' ) {
Branch: 1 branch
BranchTrueFalseTotal
if (ref @_ eq 'Text::Tradition::Stemma') { } 0 3 3
116 0 $stemma = shift;
117 } else {
118 3 $stemma = Text::Tradition::Stemma->new( @_ );
119 }
120 3 ▶ $self->_add_stemma( $stemma ) if $stemma;
Branch: 1 branch
BranchTrueFalseTotal
if $stemma 3 0 3
121 3 return $stemma;
122 }
123  
124 =head2 record_stemweb_result( $format, $data )
125  
126 Records the result returned by a Stemweb calculation, and clears any
127 existing job ID. Returns any new stemmata that were created.
128  
129 =begin testing
130  
131 use Text::Tradition;
132 use JSON qw/ from_json /;
133  
134 my $t = Text::Tradition->new(
135 'name' => 'Stemweb test',
136 'input' => 'Self',
137 'file' => 't/data/besoin.xml',
138 'stemweb_jobid' => '4',
139 );
140  
141 is( $t->stemma_count, 0, "No stemmas added yet" );
142  
143 my $answer = from_json( '{"status": 0, "job_id": "4", "algorithm": "RHM", "format": "newick", "start_time": "2013-10-26 10:44:14.050263", "result": "((((((((((((_A_F,_A_U),_A_V),_A_S),_A_T1),_A_T2),_A_A),_A_J),_A_B),_A_L),_A_D),_A_M),_A_C);\n", "end_time": "2013-10-26 10:45:55.398944"}' );
144 my $newst = $t->record_stemweb_result( $answer );
145 is( scalar @$newst, 1, "New stemma was returned from record_stemweb_result" );
146 is( $newst->[0], $t->stemma(0), "Answer has the right object" );
147 ok( !$t->has_stemweb_jobid, "Job ID was removed from tradition" );
148 is( $t->stemma_count, 1, "Tradition has new stemma" );
149 ok( $t->stemma(0)->is_undirected, "New stemma is undirected as it should be" );
150 is( $t->stemma(0)->identifier, "RHM 1382784254_0", "Stemma has correct identifier" );
151 is( $t->stemma(0)->from_jobid, 4, "New stemma has correct associated job ID" );
152 foreach my $wit ( $t->stemma(0)->witnesses ) {
153 ok( $t->has_witness( $wit ), "Extant stemma witness $wit exists in tradition" );
154 }
155  
156 =end testing
157  
158 =cut
159  
160 1 ▶sub record_stemweb_result {
Subroutine record_stemweb_result: called CC=4 SCAR=14.0
Pod documented
161 1 my( $self, $answer ) = @_;
162 1 my $jobid = $self->stemweb_jobid;
163 1 my $stemmata = [];
164 1 ▶ if( $answer->{format} eq 'dot' ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($answer->{'format'} eq 'dot') { } 0 1 1
elsif ($answer->{'format'} eq 'newick') { } 1 0 1
165 0 $self->add_stemma( dot => $answer->{result} );
166 } elsif( $answer->{format} eq 'newick' ) {
167 1 my $realsig;
168 1 map { $realsig->{$_->ascii_sigil} = $_->sigil } $self->witnesses;
169 1 $stemmata = Text::Tradition::Stemma->new_from_newick( $answer->{result} );
170 my $title = sprintf( "%s %d", $answer->{algorithm},
171 1 str2time( $answer->{start_time}, 'UTC' ) );
172 1 my $i = 0;
173 1 foreach my $stemma ( @$stemmata ) {
174 1 my $ititle = $title . "_$i"; $i++;
175 1 $stemma->set_identifier( $ititle );
176 1 $stemma->_set_from_jobid( $jobid );
177 # Convert back from ASCII sigla
178 1 $stemma->rename_witnesses( $realsig, 1 );
179 1 $self->_add_stemma( $stemma );
180 }
181 } else {
182 0 $self->throw( "Cannot parse tree results with format " . $answer->{format} );
183 }
184 1 $self->_clear_stemweb_jobid();
185 1 return $stemmata;
186 }
187  
188 4 1;
189  
190 =head1 LICENSE
191  
192 This package is free software and is provided "as is" without express
193 or implied warranty. You can redistribute it and/or modify it under
194 the same terms as Perl itself.
195  
196 =head1 AUTHOR
197  
198 Tara L Andrews E<lt>aurum@cpan.orgE<gt>
« Analysis/Result.pm ↑ Summary