Merge branch 'master' of github.com:tla/stemmatology
[scpubgit/stemmatology.git] / lib / Text / Tradition / Collation / RelationshipStore.pm
index 6f46c14..334b5fe 100644 (file)
@@ -4,6 +4,7 @@ use strict;
 use warnings;
 use Text::Tradition::Error;
 use Text::Tradition::Collation::Relationship;
+use TryCatch;
 
 use Moose;
 
@@ -22,9 +23,38 @@ general) between readings.
 =begin testing
 
 use Text::Tradition;
+use TryCatch;
 
 use_ok( 'Text::Tradition::Collation::RelationshipStore' );
 
+# Add some relationships, and delete them
+
+my $cxfile = 't/data/Collatex-16.xml';
+my $t = Text::Tradition->new( 
+    'name'  => 'inline', 
+    'input' => 'CollateX',
+    'file'  => $cxfile,
+    );
+my $c = $t->collation;
+
+my @v1 = $c->add_relationship( 'n21', 'n22', { 'type' => 'meaning' } );
+is( scalar @v1, 1, "Added a single relationship" );
+is( $v1[0]->[0], 'n21', "Got correct node 1" );
+is( $v1[0]->[1], 'n22', "Got correct node 2" );
+my @v2 = $c->add_relationship( 'n9', 'n23', 
+       { 'type' => 'spelling', 'scope' => 'global' } );
+is( scalar @v2, 2, "Added a global relationship with two instances" );
+@v1 = $c->del_relationship( 'n22', 'n21' );
+is( scalar @v1, 1, "Deleted first relationship" );
+@v2 = $c->del_relationship( 'n8', 'n13' );
+is( scalar @v2, 2, "Deleted second global relationship" );
+try {
+       my @v3 = $c->del_relationship( 'n1', 'n2' );
+       ok( 0, "Should have errored on non-existent relationship" );
+} catch( Text::Tradition::Error $e ) {
+       like( $e->message, qr/No relationship defined/, "Attempt to delete non-existent relationship errored" );
+}
+
 =end testing
 
 =head1 METHODS
@@ -56,9 +86,24 @@ has 'graph' => (
        relationships => 'edges',
        add_reading => 'add_vertex',
        delete_reading => 'delete_vertex',
+       delete_relationship => 'delete_edge',
     },
        );
        
+around 'delete_relationship' => sub {
+       my $orig = shift;
+       my $self = shift;
+       my @vector;
+       if( @_ == 1 && ref( $_[0] ) eq 'ARRAY' ) {
+               # Dereference the edge arrayref that was passed.
+               my $edge = shift;
+               @vector = @$edge;
+       } else {
+               @vector = @_;
+       }
+       return $self->$orig( @vector );
+};
+       
 =head2 get_relationship
 
 Return the relationship object, if any, that exists between two readings.
@@ -66,7 +111,15 @@ Return the relationship object, if any, that exists between two readings.
 =cut
 
 sub get_relationship {
-       my( $self, @vector ) = @_;
+       my $self = shift;
+       my @vector;
+       if( @_ == 1 && ref( $_[0] ) eq 'ARRAY' ) {
+               # Dereference the edge arrayref that was passed.
+               my $edge = shift;
+               @vector = @$edge;
+       } else {
+               @vector = @_;
+       }
        my $relationship;
        if( $self->graph->has_edge_attribute( @vector, 'object' ) ) {
                $relationship = $self->graph->get_edge_attribute( @vector, 'object' );
@@ -79,6 +132,11 @@ sub _set_relationship {
        $self->graph->add_edge( @vector );
        $self->graph->set_edge_attribute( @vector, 'object', $relationship );
 }
+
+sub _remove_relationship {
+       my( $self, @vector ) = @_;
+       $self->graph->delete_edge( @vector );
+}
        
 =head2 create
 
@@ -224,6 +282,31 @@ sub add_relationship {
     return @pairs_set;
 }
 
+=head2 del_relationship( $source, $target )
+
+Removes the relationship between the given readings. If the relationship is
+non-local, removes the relationship everywhere in the graph.
+
+=cut
+
+sub del_relationship {
+       my( $self, $source, $target ) = @_;
+       my $rel = $self->get_relationship( $source, $target );
+       throw( "No relationship defined between $source and $target" ) unless $rel;
+       my @vectors = ( [ $source, $target ] );
+       $self->_remove_relationship( $source, $target );
+       if( $rel->nonlocal ) {
+               # Remove the relationship wherever it occurs.
+               my @rel_edges = grep { $self->get_relationship( @$_ ) == $rel }
+                       $self->relationships;
+               foreach my $re ( @rel_edges ) {
+                       $self->_remove_relationship( @$re );
+                       push( @vectors, $re );
+               }
+       }
+       return @vectors;
+}
+
 =head2 relationship_valid( $source, $target, $type )
 
 Checks whether a relationship of type $type may exist between the readings given
@@ -238,6 +321,7 @@ sub relationship_valid {
     if ( $rel eq 'transposition' || $rel eq 'repetition' ) {
                # Check that the two readings do (for a repetition) or do not (for
                # a transposition) appear in the same witness.
+               # TODO this might be called before witness paths are set...
                my %seen_wits;
                map { $seen_wits{$_} = 1 } $c->reading_witnesses( $source );
                foreach my $w ( $c->reading_witnesses( $target ) ) {
@@ -251,7 +335,13 @@ sub relationship_valid {
                }
        } else {
                # Check that linking the source and target in a relationship won't lead
-               # to a path loop for any witness.  First make a lookup table of all the
+               # to a path loop for any witness.  If they have the same rank then fine.
+               return( 1, "ok" ) 
+                       if $c->reading( $source )->has_rank
+                               && $c->reading( $target )->has_rank
+                               && $c->reading( $source )->rank == $c->reading( $target )->rank;
+               
+               # Otherwise, first make a lookup table of all the
                # readings related to either the source or the target.
                my @proposed_related = ( $source, $target );
                push( @proposed_related, $self->related_readings( $source, 'colocated' ) );
@@ -259,14 +349,22 @@ sub relationship_valid {
                my %pr_ids;
                map { $pr_ids{ $_ } = 1 } @proposed_related;
        
-               # None of these proposed related readings should have a neighbor that
-               # is also in proposed_related.
+               # The cumulative predecessors and successors of the proposed-related readings
+               # should not overlap.
+               my %all_pred;
+               my %all_succ;
                foreach my $pr ( keys %pr_ids ) {
-                       foreach my $neighbor( $c->sequence->neighbors( $pr ) ) {
-                               return( 0, "Would relate neighboring readings $pr and $neighbor" )
-                                       if exists $pr_ids{$neighbor};
-                       }
-               }               
+                       map { $all_pred{$_} = 1 } $c->sequence->all_predecessors( $pr );
+                       map { $all_succ{$_} = 1 } $c->sequence->all_successors( $pr );
+               }
+               foreach my $k ( keys %all_pred ) {
+                       return( 0, "Relationship would create witness loop" )
+                               if exists $all_succ{$k};
+               }
+               foreach my $k ( keys %pr_ids ) {
+                       return( 0, "Relationship would create witness loop" )
+                               if exists $all_pred{$k} || exists $all_succ{$k};
+               }
                return ( 1, "ok" );
        }
 }