1 package Text::Tradition::Parser::Tabular;
9 Text::Tradition::Parser::Tabular
15 my $t_from_file = Text::Tradition->new(
18 'file' => '/path/to/collation.csv',
22 my $t_from_string = Text::Tradition->new(
25 'string' => $tab_separated_collation,
31 Parser module for Text::Tradition to read an alignment table format, such as CSV.
35 =head2 B<parse>( $tradition, $option_hash )
37 Takes an initialized tradition and a set of options; creates the
38 appropriate nodes and edges on the graph, as well as the appropriate
39 witness objects. The $option_hash must contain either a 'file' or a
40 'string' argument with the table to be parsed; it may also contain a
41 'sep_char' argument to specify how the fields are separated.
43 The table should have witnesses arranged in columns, with the witness sigla
44 in the first row. Empty cells are interpreted as omissions (and thus
45 stemmatologically relevant.) Longer lacunae in the text, to be disregarded
46 in cladistic analysis, may be represented by filling the appropriate cells
47 with the tag '#LACUNA#'.
49 If a witness name ends in the collation's ac_label, it will be treated as
50 an 'ante-correction' version of the 'main' witness whose sigil it shares.
55 binmode STDOUT, ":utf8";
56 binmode STDERR, ":utf8";
57 eval { no warnings; binmode $DB::OUT, ":utf8"; };
59 my $csv = 't/data/florilegium.csv';
60 my $t = Text::Tradition->new(
67 is( ref( $t ), 'Text::Tradition', "Parsed florilegium CSV file" );
69 ### TODO Check these figures
71 is( scalar $t->collation->readings, 311, "Collation has all readings" );
72 is( scalar $t->collation->paths, 361, "Collation has all paths" );
73 is( scalar $t->witnesses, 13, "Collation has all witnesses" );
76 # Check that we have the right witnesses
78 map { $seen_wits{$_} = 0 } qw/ A B C D E F G H K P Q S T /;
79 foreach my $wit ( $t->witnesses ) {
80 $seen_wits{$wit->sigil} = 1;
82 is( scalar keys %seen_wits, 13, "No extra witnesses were made" );
83 foreach my $k ( keys %seen_wits ) {
84 ok( $seen_wits{$k}, "Witness $k still exists" );
87 # Check that the witnesses have the right texts
88 foreach my $wit ( $t->witnesses ) {
89 my $origtext = join( ' ', @{$wit->text} );
90 my $graphtext = $t->collation->path_text( $wit->sigil );
91 is( $graphtext, $origtext, "Collation matches original for witness " . $wit->sigil );
94 # Check that the a.c. witnesses have the right text
95 map { $seen_wits{$_} = 0 } qw/ A B C D F G H K S /;
96 foreach my $k ( keys %seen_wits ) {
97 my $wit = $t->witness( $k );
98 if( $seen_wits{$k} ) {
99 ok( $wit->is_layered, "Witness $k got marked as layered" );
100 ok( $wit->has_layertext, "Witness $k has an a.c. version" );
101 my $origtext = join( ' ', @{$wit->layertext} );
102 my $acsig = $wit->sigil . $t->collation->ac_label;
103 my $graphtext = $t->collation->path_text( $acsig );
104 is( $graphtext, $origtext, "Collation matches original a.c. for witness $k" );
106 ok( !$wit->is_layered, "Witness $k not marked as layered" );
107 ok( !$wit->has_layertext, "Witness $k has no a.c. version" );
116 my( $tradition, $opts ) = @_;
117 my $c = $tradition->collation; # shorthand
118 my $csv_options = { 'binary' => 1 };
119 $csv_options->{'sep_char'} = $opts->{'sep_char'} || "\t";
120 if( $csv_options->{'sep_char'} eq "\t" ) {
121 # If it is really tab separated, nothing is an escape char.
122 $csv_options->{'quote_char'} = undef;
124 my $csv = Text::CSV_XS->new( $csv_options );
127 if( exists $opts->{'string' } ) {
128 my @lines = split( "\n", $opts->{'string'} );
129 foreach my $l ( @lines ) {
130 my $status = $csv->parse( $l );
132 push( @$alignment_table, [ $csv->fields ] );
134 warn "Could not parse line $l: " . $csv->error_input;
137 } elsif( exists $opts->{'file'} ) {
138 open( my $fh, $opts->{'file'} )
139 or warn "Could not open input file " . $opts->{'file'};
140 binmode( $fh, ':utf8' );
141 while( my $row = $csv->getline( $fh ) ) {
142 push( @$alignment_table, $row );
146 warn "Could not find string or file option to parse";
150 # Set up the witnesses we find in the first line
152 my %ac_wits; # Track layered witness -> main witness mapping
153 foreach my $sigil ( @{$alignment_table->[0]} ) {
154 my $wit = $tradition->add_witness( 'sigil' => $sigil );
155 $wit->path( [ $c->start ] );
156 push( @witnesses, $wit );
157 my $aclabel = $c->ac_label;
158 if( $sigil =~ /^(.*)\Q$aclabel\E$/ ) {
159 $ac_wits{$sigil} = $1;
163 # Save the original witness text sequences. Have to loop back through
164 # the witness columns after we have identified all the a.c. witnesses.
165 foreach my $idx ( 0 .. $#{$alignment_table->[0]} ) {
166 my @sequence = map { $_->[$idx] } @{$alignment_table};
167 my $sigil = shift @sequence;
168 my $is_layer = exists( $ac_wits{$sigil} );
169 my $wit = $tradition->witness( $is_layer ? $ac_wits{$sigil} : $sigil );
170 # Now get rid of gaps and meta-readings like #LACUNA#
171 my @words = grep { $_ && $_ !~ /^\#.*\#$/ } @sequence;
172 $is_layer ? $wit->layertext( \@words ) : $wit->text( \@words );
175 # Now for the next rows, make nodes as necessary, assign their ranks, and
176 # add them to the witness paths.
177 foreach my $idx ( 1 .. $#{$alignment_table} ) {
178 my $row = $alignment_table->[$idx];
179 my $nodes = make_nodes( $c, $row, $idx );
180 foreach my $w ( 0 .. $#{$row} ) {
181 # push the appropriate node onto the appropriate witness path
182 my $word = $row->[$w];
184 my $reading = $nodes->{$word};
185 my $wit = $witnesses[$w];
186 push( @{$wit->path}, $reading );
187 } # else skip it for empty readings.
191 # Collapse our lacunae into a single node and
192 # push the end node onto all paths.
193 $c->end->rank( scalar @$alignment_table );
194 foreach my $wit ( @witnesses ) {
196 my $last_rdg = shift @$p;
197 my $new_p = [ $last_rdg ];
198 foreach my $rdg ( @$p ) {
199 # Omit the reading if we are in a lacuna already.
200 next if $rdg->is_lacuna && $last_rdg->is_lacuna;
201 # Save the reading otherwise.
202 push( @$new_p, $rdg );
205 push( @$new_p, $c->end );
206 $wit->path( $new_p );
209 # Fold any a.c. witnesses into their main witness objects, and
210 # delete the independent a.c. versions.
211 foreach my $a ( keys %ac_wits ) {
212 my $ac_wit = $tradition->witness( $a );
213 my $main_wit = $tradition->witness( $ac_wits{$a} );
214 next unless $main_wit;
215 $main_wit->is_layered(1);
216 $main_wit->uncorrected_path( $ac_wit->path );
217 $tradition->del_witness( $ac_wit );
221 $c->make_witness_paths;
222 # Delete our unused lacuna nodes.
223 foreach my $rdg ( grep { $_->is_lacuna } $c->readings ) {
224 $c->del_reading( $rdg ) unless $c->reading_witnesses( $rdg );
227 # Do a consistency check.
228 foreach my $wit ( $tradition->witnesses ) {
229 my $pathtext = $c->path_text( $wit->sigil );
230 my $origtext = join( ' ', @{$wit->text} );
231 warn "Text differs for witness " . $wit->sigil
232 unless $pathtext eq $origtext;
233 if( $wit->is_layered ) {
234 $pathtext = $c->path_text( $wit->sigil.$c->ac_label );
235 $origtext = join( ' ', @{$wit->layertext} );
236 warn "Ante-corr text differs for witness " . $wit->sigil
237 unless $pathtext eq $origtext;
239 warn "Text " . $wit->sigil . " has a layered text but is not marked as layered"
240 if $wit->has_layertext;
246 my( $collation, $row, $index ) = @_;
248 foreach my $w ( @$row ) {
249 $unique{$w} = 1 if $w;
252 foreach my $w ( keys %unique ) {
254 'id' => "$index,$ctr",
258 $rargs->{'is_lacuna'} = 1 if $w eq '#LACUNA#';
259 my $r = $collation->add_reading( $rargs );
270 This package is free software and is provided "as is" without express
271 or implied warranty. You can redistribute it and/or modify it under
272 the same terms as Perl itself.
276 Tara L Andrews E<lt>aurum@cpan.orgE<gt>