X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FText%2FTradition%2FDirectory.pm;h=09aed7b0717b03077379405f5d657616a80ce2f6;hb=896fe649a80575aaa06d3484c09579a2cb34ba8a;hp=f10fda6023b920ebcdef2378357e0a4ef78602ed;hpb=ad1291eedd8a322ce64ba40683da4fb5f1c0b609;p=scpubgit%2Fstemmatology.git diff --git a/lib/Text/Tradition/Directory.pm b/lib/Text/Tradition/Directory.pm index f10fda6..09aed7b 100644 --- a/lib/Text/Tradition/Directory.pm +++ b/lib/Text/Tradition/Directory.pm @@ -3,9 +3,12 @@ package Text::Tradition::Directory; use strict; use warnings; use Moose; +use DBI; +use Encode qw/ decode_utf8 /; use KiokuDB::GC::Naive; use KiokuDB::TypeMap; use KiokuDB::TypeMap::Entry::Naive; +use Text::Tradition::Error; extends 'KiokuX::Model'; @@ -22,7 +25,7 @@ Text::Tradition::Directory - a KiokuDB interface for storing and retrieving trad ); my $tradition = Text::Tradition->new( @args ); - my $stemma = $tradition->add_stemma( $dotfile ); + my $stemma = $tradition->add_stemma( dotfile => $dotfile ); $d->save_tradition( $tradition ); foreach my $id ( $d->traditions ) { @@ -39,9 +42,9 @@ Text::Tradition::Directory is an interface for storing and retrieving text tradi Returns a Directory object. -=head2 tradition_ids +=head2 traditionlist -Returns the ID of all traditions in the database. +Returns a hashref mapping of ID => name for all traditions in the directory. =head2 tradition( $id ) @@ -51,9 +54,14 @@ Returns the Text::Tradition object of the given ID. Writes the given tradition to the database, returning its ID. +=head2 delete( $tradition ) + +Deletes the given tradition object from the database. +WARNING!! Garbage collection does not yet work. Use this sparingly. + =begin testing -use Test::Warn; +use TryCatch; use File::Temp; use Text::Tradition; use_ok 'Text::Tradition::Directory'; @@ -62,126 +70,225 @@ my $fh = File::Temp->new(); my $file = $fh->filename; $fh->close; my $dsn = "dbi:SQLite:dbname=$file"; - -my $d = Text::Tradition::Directory->new( 'dsn' => $dsn, - 'extra_args' => { 'create' => 1 } ); -is( ref $d, 'Text::Tradition::Directory', "Got directory object" ); - -my $scope = $d->new_scope; +my $uuid; my $t = Text::Tradition->new( 'name' => 'inline', 'input' => 'Tabular', 'file' => 't/data/simple.txt', ); -my $uuid = $d->save( $t ); -ok( $uuid, "Saved test tradition" ); - -my $s = $t->add_stemma( 't/data/simple.dot' ); -ok( $d->save( $t ), "Updated tradition with stemma" ); -is( $d->tradition( $uuid ), $t, "Correct tradition returned for id" ); -is( $d->tradition( $uuid )->stemma, $s, "...and it has the correct stemma" ); -warning_like { $d->save( $s ) } qr/not a Text::Tradition/, "Correctly failed to save stemma directly"; - -my $e = Text::Tradition::Directory->new( 'dsn' => $dsn ); -$scope = $e->new_scope; -is( scalar $e->tradition_ids, 1, "Directory index has our tradition" ); -my $te = $e->tradition( $uuid ); -is( $te->name, $t->name, "Retrieved the tradition from a new directory" ); -my $sid = $e->object_to_id( $te->stemma ); -warning_like { $e->tradition( $sid ) } qr/not a Text::Tradition/, "Did not retrieve stemma via tradition call"; -warning_like { $e->delete( $sid ) } qr/Cannot directly delete non-Tradition object/, "Stemma object not deleted from DB"; -$e->delete( $uuid ); -ok( !$e->exists( $uuid ), "Object is deleted from DB" ); -ok( !$e->exists( $sid ), "Object stemma also deleted from DB" ); -is( scalar $e->tradition_ids, 0, "Object is deleted from index" ); +{ + my $d = Text::Tradition::Directory->new( 'dsn' => $dsn, + 'extra_args' => { 'create' => 1 } ); + is( ref $d, 'Text::Tradition::Directory', "Got directory object" ); + + my $scope = $d->new_scope; + $uuid = $d->save( $t ); + ok( $uuid, "Saved test tradition" ); + + my $s = $t->add_stemma( dotfile => 't/data/simple.dot' ); + ok( $d->save( $t ), "Updated tradition with stemma" ); + is( $d->tradition( $uuid ), $t, "Correct tradition returned for id" ); + is( $d->tradition( $uuid )->stemma(0), $s, "...and it has the correct stemma" ); + try { + $d->save( $s ); + } catch( Text::Tradition::Error $e ) { + is( $e->ident, 'database error', "Got exception trying to save stemma directly" ); + like( $e->message, qr/Cannot directly save non-Tradition object/, + "Exception has correct message" ); + } +} +my $nt = Text::Tradition->new( + 'name' => 'CX', + 'input' => 'CollateX', + 'file' => 't/data/Collatex-16.xml', + ); +is( ref( $nt ), 'Text::Tradition', "Made new tradition" ); + +{ + my $f = Text::Tradition::Directory->new( 'dsn' => $dsn ); + my $scope = $f->new_scope; + is( scalar $f->traditionlist, 1, "Directory index has our tradition" ); + my $nuuid = $f->save( $nt ); + ok( $nuuid, "Stored second tradition" ); + my @tlist = $f->traditionlist; + is( scalar @tlist, 2, "Directory index has both traditions" ); + my $tf = $f->tradition( $uuid ); + my( $tlobj ) = grep { $_->{'id'} eq $uuid } @tlist; + is( $tlobj->{'name'}, $tf->name, "Directory index has correct tradition name" ); + is( $tf->name, $t->name, "Retrieved the tradition from a new directory" ); + my $sid = $f->object_to_id( $tf->stemma(0) ); + try { + $f->tradition( $sid ); + } catch( Text::Tradition::Error $e ) { + is( $e->ident, 'database error', "Got exception trying to fetch stemma directly" ); + like( $e->message, qr/not a Text::Tradition/, "Exception has correct message" ); + } + try { + $f->delete( $sid ); + } catch( Text::Tradition::Error $e ) { + is( $e->ident, 'database error', "Got exception trying to delete stemma directly" ); + like( $e->message, qr/Cannot directly delete non-Tradition object/, + "Exception has correct message" ); + } + + $f->delete( $uuid ); + ok( !$f->exists( $uuid ), "Object is deleted from DB" ); + ok( !$f->exists( $sid ), "Object stemma also deleted from DB" ); + is( scalar $f->traditionlist, 1, "Object is deleted from index" ); +} + +{ + my $g = Text::Tradition::Directory->new( 'dsn' => $dsn ); + my $scope = $g->new_scope; + is( scalar $g->traditionlist, 1, "Now one object in new directory index" ); + my $ntobj = $g->tradition( 'CX' ); + my @w1 = sort { $a->sigil cmp $b->sigil } $ntobj->witnesses; + my @w2 = sort{ $a->sigil cmp $b->sigil } $nt->witnesses; + is_deeply( \@w1, \@w2, "Looked up remaining tradition by name" ); +} =end testing =cut +use Text::Tradition::TypeMap::Entry; has +typemap => ( - is => 'rw', - isa => 'KiokuDB::TypeMap', - default => sub { - KiokuDB::TypeMap->new( - isa_entries => { - "Graph" => KiokuDB::TypeMap::Entry::Naive->new, - "Graph::AdjacencyMap" => KiokuDB::TypeMap::Entry::Naive->new, - } - ); - }, + is => 'rw', + isa => 'KiokuDB::TypeMap', + default => sub { + KiokuDB::TypeMap->new( + isa_entries => { + "Text::Tradition" => + KiokuDB::TypeMap::Entry::Naive->new(), + "Graph" => Text::Tradition::TypeMap::Entry->new(), + "Graph::AdjacencyMap" => Text::Tradition::TypeMap::Entry->new(), + } + ); + }, ); -has tradition_index => ( - traits => ['Hash'], - isa => 'HashRef[Str]', - handles => { - add_index => 'set', - del_index => 'delete', - name => 'get', - tradition_ids => 'keys', - }, - default => sub { {} }, - ); +# Push some columns into the extra_args +around BUILDARGS => sub { + my $orig = shift; + my $class = shift; + my $args; + if( @_ == 1 ) { + $args = $_[0]; + } else { + $args = { @_ }; + } + if( $args->{'dsn'} =~ /^dbi/ ) { # We're using Backend::DBI + my @column_args = ( 'columns', + [ 'name' => { 'data_type' => 'varchar', 'is_nullable' => 1 } ] ); + my $ea = $args->{'extra_args'}; + if( ref( $ea ) eq 'ARRAY' ) { + push( @$ea, @column_args ); + } elsif( ref( $ea ) eq 'HASH' ) { + $ea = { %$ea, @column_args }; + } else { + $ea = { @column_args }; + } + $args->{'extra_args'} = $ea; + } + return $class->$orig( $args ); +}; -# Populate the tradition index. -sub BUILD { +# before [ qw/ store update insert delete / ] => sub { +before [ qw/ delete / ] => sub { my $self = shift; - my $stream = $self->root_set; - until( $stream->is_done ) { - foreach my $obj ( $stream->items ) { - my $uuid = $self->object_to_id( $obj ); - if( ref( $obj ) eq 'Text::Tradition' ) { - $self->add_index( $uuid => $obj->name ); - } else { - warn "Found root object in DB that is not a Text::Tradition"; + my @nontrad; + foreach my $obj ( @_ ) { + if( ref( $obj ) && ref( $obj ) ne 'Text::Tradition' ) { + # Is it an id => Tradition hash? + if( ref( $obj ) eq 'HASH' && keys( %$obj ) == 1 ) { + my( $k ) = keys %$obj; + next if ref( $obj->{$k} ) eq 'Text::Tradition'; } + push( @nontrad, $obj ); } } - return $self; -} - -# If a tradition is deleted, remove it from the index. -around delete => sub { - my $orig = shift; - my $self = shift; - warn "Will only delete one tradition at a time" if @_ > 1; - my $arg = shift; - my $obj = ref( $arg ) ? $arg : $self->lookup( $arg ); - my $id = ref( $arg ) ? $self->object_to_id( $arg ) : $arg; - unless( ref $obj eq 'Text::Tradition' ) { - warn "Cannot directly delete non-Tradition object $obj"; - return; + if( @nontrad ) { + throw( "Cannot directly save non-Tradition object of type " + . ref( $nontrad[0] ) ); } - $self->$orig( $arg ); - my $gc = KiokuDB::GC::Naive->new( backend => $self->directory->backend ); - $self->$orig( $gc->garbage->members ); - $self->del_index( $id ); }; +# TODO Garbage collection doesn't work. Suck it up and live with the +# inflated DB. +# after delete => sub { +# my $self = shift; +# my $gc = KiokuDB::GC::Naive->new( backend => $self->directory->backend ); +# $self->directory->backend->delete( $gc->garbage->members ); +# }; + sub save { - my( $self, $obj ) = @_; - unless( ref( $obj ) eq 'Text::Tradition' ) { - warn "Object $obj is not a Text::Tradition"; - return; - } - my $uuid = $self->store( $obj ); - $self->add_index( $uuid => $obj->name ) if $uuid; - return $uuid; + my $self = shift; + return $self->store( @_ ); } - sub tradition { my( $self, $id ) = @_; my $obj = $self->lookup( $id ); - unless( ref( $obj ) eq 'Text::Tradition' ) { - warn "Retrieved object is a " . ref( $obj ) . ", not a Text::Tradition"; - return; + unless( $obj ) { + # Try looking up by name. + foreach my $item ( $self->traditionlist ) { + if( $item->{'name'} eq $id ) { + $obj = $self->lookup( $item->{'id'} ); + last; + } + } + } + if( $obj && ref( $obj ) ne 'Text::Tradition' ) { + throw( "Retrieved object is a " . ref( $obj ) . ", not a Text::Tradition" ); } return $obj; } +sub traditionlist { + my $self = shift; + # If we are using DBI, we can do it the easy way; if not, the hard way. + # Easy way still involves making a separate DBI connection. Ew. + my @tlist; + if( $self->dsn =~ /^dbi:(\w+):/ ) { + my $dbtype = $1; + my @connection = @{$self->directory->backend->connect_info}; + # Get rid of KiokuDB-specific arg + pop @connection if scalar @connection > 4; + $connection[3]->{'sqlite_unicode'} = 1 if $dbtype eq 'SQLite'; + $connection[3]->{'pg_enable_utf8'} = 1 if $dbtype eq 'Pg'; + my $dbh = DBI->connect( @connection ); + my $q = $dbh->prepare( 'SELECT id, name from entries WHERE class = "Text::Tradition"' ); + $q->execute(); + while( my @row = $q->fetchrow_array ) { + my( $id, $name ) = @row; + # Horrible horrible hack + $name = decode_utf8( $name ) if $dbtype eq 'mysql'; + push( @tlist, { 'id' => $row[0], 'name' => $row[1] } ); + } + } else { + $self->scan( sub { my $o = shift; + push( @tlist, { 'id' => $self->object_to_id( $o ), + 'name' => $o->name } ) } ); + } + return @tlist; +} + +sub throw { + Text::Tradition::Error->throw( + 'ident' => 'database error', + 'message' => $_[0], + ); +} + 1; - \ No newline at end of file +=head1 LICENSE + +This package is free software and is provided "as is" without express +or implied warranty. You can redistribute it and/or modify it under +the same terms as Perl itself. + +=head1 AUTHOR + +Tara L Andrews Eaurum@cpan.orgE