small fix to compress_readings
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / Reading.pm
index 5a60823..f445420 100644 (file)
@@ -1,12 +1,21 @@
 package Text::Tradition::Collation::Reading;
 
 use Moose;
+use Moose::Util::TypeConstraints;
 use JSON qw/ from_json /;
 use Module::Load;
 use Text::Tradition::Error;
+use XML::Easy::Syntax qw( $xml10_name_rx $xml10_namestartchar_rx );
 use YAML::XS;
 use overload '""' => \&_stringify, 'fallback' => 1;
 
+subtype 'ReadingID',
+       as 'Str',
+       where { $_ =~ /\A$xml10_name_rx\z/ },
+       message { 'Reading ID must be a valid XML attribute string' };
+       
+no Moose::Util::TypeConstraints;
+
 =head1 NAME
 
 Text::Tradition::Collation::Reading - represents a reading (usually a word)
@@ -79,7 +88,7 @@ has 'collation' => (
 
 has 'id' => (
        is => 'ro',
-       isa => 'Str',
+       isa => 'ReadingID',
        required => 1,
        );
 
@@ -135,10 +144,23 @@ has 'rank' => (
     
 ## For morphological analysis
 
+has 'grammar_invalid' => (
+       is => 'rw',
+       isa => 'Bool',
+       default => undef,
+       );
+       
+has 'is_nonsense' => (
+       is => 'rw',
+       isa => 'Bool',
+       default => undef,
+       );
+
 has 'normal_form' => (
        is => 'rw',
        isa => 'Str',
-       predicate => 'has_normal_form',
+       predicate => '_has_normal_form',
+       clearer => '_clear_normal_form',
        );
 
 # Holds the lexemes for the reading.
@@ -146,6 +168,7 @@ has 'reading_lexemes' => (
        traits => ['Array'],
        isa => 'ArrayRef[Text::Tradition::Collation::Reading::Lexeme]',
        handles => {
+               lexeme => 'get',
                lexemes => 'elements',
                has_lexemes => 'count',
                clear_lexemes => 'clear',
@@ -160,12 +183,14 @@ has 'join_prior' => (
        is => 'ro',
        isa => 'Bool',
        default => undef,
+       writer => '_set_join_prior',
        );
        
 has 'join_next' => (
        is => 'ro',
        isa => 'Bool',
        default => undef,
+       writer => '_set_join_next',
        );
 
 
@@ -181,19 +206,28 @@ around BUILDARGS => sub {
                        
        # If one of our special booleans is set, we change the text and the
        # ID to match.
-       if( exists $args->{'is_lacuna'} && !exists $args->{'text'} ) {
+       if( exists $args->{'is_lacuna'} && $args->{'is_lacuna'} && !exists $args->{'text'} ) {
                $args->{'text'} = '#LACUNA#';
-       } elsif( exists $args->{'is_start'} ) {
-               $args->{'id'} = '#START#';  # Change the ID to ensure we have only one
+       } elsif( exists $args->{'is_start'} && $args->{'is_start'} ) {
+               $args->{'id'} = '__START__';  # Change the ID to ensure we have only one
                $args->{'text'} = '#START#';
                $args->{'rank'} = 0;
-       } elsif( exists $args->{'is_end'} ) {
-               $args->{'id'} = '#END#';        # Change the ID to ensure we have only one
+       } elsif( exists $args->{'is_end'} && $args->{'is_end'} ) {
+               $args->{'id'} = '__END__';      # Change the ID to ensure we have only one
                $args->{'text'} = '#END#';
-       } elsif( exists $args->{'is_ph'} ) {
+       } elsif( exists $args->{'is_ph'} && $args->{'is_ph'} ) {
                $args->{'text'} = $args->{'id'};
        }
        
+       # Backwards compatibility for non-XMLname IDs
+       my $rid = $args->{'id'};
+       $rid =~ s/\#/__/g;
+       $rid =~ s/[\/,]/./g;
+    if( $rid !~ /^$xml10_namestartchar_rx/ ) {
+       $rid = 'r'.$rid;
+    }
+       $args->{'id'} = $rid;
+       
        $class->$orig( $args );
 };
 
@@ -205,6 +239,21 @@ sub BUILD {
        }
 }
 
+# Make normal_form default to text, transparently.
+around 'normal_form' => sub {
+       my $orig = shift;
+       my $self = shift;
+       my( $arg ) = @_;
+       if( $arg && $arg eq $self->text ) {
+               $self->_clear_normal_form;
+               return $arg;
+       } elsif( !$arg && !$self->_has_normal_form ) {
+               return $self->text;
+       } else {
+               $self->$orig( @_ );
+       }
+};
+
 =head2 is_meta
 
 A meta attribute (ha ha), which should be true if any of our 'special'
@@ -358,6 +407,12 @@ sub _deserialize_lexemes {
        $self->add_lexeme( @lexemes );
 }
 
+sub disambiguated {
+       my $self = shift;
+       return 0 unless $self->has_lexemes;
+       return !grep { !$_->is_disambiguated } $self->lexemes;
+}
+
 ## Utility methods
 
 sub TO_JSON {