test for correctness of analysis groups; pursuant bugfixes

[scpubgit/stemmatology.git] / lib / Text / Tradition / Witness.pm

diff --git a/lib/Text/Tradition/Witness.pm b/lib/Text/Tradition/Witness.pm
index 551d3ea..f1dd5be 100644 (file)
--- a/lib/Text/Tradition/Witness.pm
+++ b/lib/Text/Tradition/Witness.pm
@@ -32,7 +32,12 @@ Create a new witness.  Options include:
 =item * sigil - A short code to represent the manuscript.  Required.
 
 =item * text - An array of strings (words) that contains the text of the
-manuscript.
+manuscript.  This should not change after the witness has been instantiated,
+and the path through the collation should always match it.
+
+=item * layertext - An array of strings (words) that contains the layered text,
+if any, of the manuscript.  This should not change after the witness has been 
+instantiated, and the path through the collation should always match it.
 
 =item * source - A reference to the text, such as a filename, if it is not
 given in the 'text' option.
@@ -104,6 +109,12 @@ has 'text' => (
        isa => 'ArrayRef[Str]',
        predicate => 'has_text',
        );
+       
+has 'layertext' => (
+       is => 'rw',
+       isa => 'ArrayRef[Str]',
+       predicate => 'has_layertext',
+       );
 
 # Source.  This is where we read in the witness, if not from a
 # pre-prepared collation.  It is probably a filename.
@@ -174,6 +185,66 @@ sub BUILD {
        }
 }
 
+=head2 export_as_json
+
+Exports the witness as a JSON structure, with the following keys:
+
+=over 4
+
+=item * id - The witness sigil
+
+=item * name - The witness identifier
+
+=item * tokens - An array of hashes of the form { "t":"WORD" }
+
+=back
+
+=begin testing
+
+use Text::Tradition;
+
+my @text = qw( This is a line of text );
+my $wit = Text::Tradition::Witness->new( 
+    'sigil' => 'A',
+    'text' => \@text,
+    'identifier' => 'test witness',
+     );
+my $jsonstruct = $wit->export_as_json;
+is( $jsonstruct->{'id'}, 'A', "got the right witness sigil" );
+is( $jsonstruct->{'name'}, 'test witness', "got the right identifier" );
+is( scalar @{$jsonstruct->{'tokens'}}, 6, "got six text tokens" );
+foreach my $idx ( 0 .. $#text ) {
+       is( $jsonstruct->{'tokens'}->[$idx]->{'t'}, $text[$idx], "tokens look OK" );
+}
+
+my @ctext = qw( when april with his showers sweet with fruit the drought of march 
+                               has pierced unto the root );
+my $trad = Text::Tradition->new(
+       'input' => 'CollateX',
+       'file' => 't/data/Collatex-16.xml' );
+
+$jsonstruct = $trad->witness('A')->export_as_json;
+is( $jsonstruct->{'id'}, 'A', "got the right witness sigil" );
+is( $jsonstruct->{'name'}, undef, "got undef for missing identifier" );
+is( scalar @{$jsonstruct->{'tokens'}}, 17, "got all text tokens" );
+foreach my $idx ( 0 .. $#ctext ) {
+       is( $jsonstruct->{'tokens'}->[$idx]->{'t'}, $ctext[$idx], "tokens look OK" );
+}
+
+=end testing
+
+=cut
+
+sub export_as_json {
+       my $self = shift;
+       my @wordlist = map { { 't' => $_ || '' } } @{$self->text};
+       return { 
+               'id' => $self->sigil,
+               'tokens' => \@wordlist,
+               'name' => $self->identifier,
+       };
+}
+
 no Moose;
 __PACKAGE__->meta->make_immutable;