@@ -1,10 +1,4 @@ -# Copyright (c) 2008 by Ricardo Signes. All rights reserved. -# Licensed under terms of Perl itself (the "License"). -# You may not use this file except in compliance with the License. -# A copy of the License was distributed with this file or you may obtain a -# copy of the License from http://dev.perl.org/licenses/ - -Revision history for CPAN-Metabase +Revision history for Metabase 0.01 in progress - original skeleton created at Oslo QA hackathon 2008 Changes @@ -1,8 +1,8 @@ require 5.006; use inc::Module::Install; -all_from('lib/CPAN/Metabase.pm'); +all_from('lib/Metabase.pm'); -requires('CPAN::Metabase::Fact' => 0); +requires('Metabase::Fact' => 0); requires('Test::More' => '0.47'); requires('Data::GUID' => 0); Makefile.PL @@ -4,7 +4,7 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase; +package Metabase; use 5.006; use strict; use warnings; @@ -14,7 +14,7 @@ $VERSION = eval $VERSION; # convert '1.23_45' to 1.2345 =head1 NAME -CPAN::Metabase - a database for metadata about CPAN distributions +Metabase - a database for metadata about CPAN distributions =head1 DESCRIPTION @@ -23,13 +23,13 @@ It can be used to store, retrieve, and search this information, which can be of arbitrary and mixed types. The metabase was built as a means of storing reports from the CPAN Testers. -When CPAN::Metabase was initially developed, CPAN Testers reports were sent by +When Metabase was initially developed, CPAN Testers reports were sent by individual testers to a single email server, which then forwarded them to a USENET group, which was considered the authoritative store. This presented problems: some testers couldn't send email, the system wasn't very searchable or mirrorable, and the data inside the system was entirely unstructured. -CPAN::Metabase aims to avoid all of those problems by being transport-neutral, +Metabase aims to avoid all of those problems by being transport-neutral, searchable and mirrorable by design, and geared toward storing structured data. Simplicity is another design goal: while it has several moving parts, they're all simple and designed to be replaceable and extensible, rather than to be a lib/CPAN/Metabase.pm @@ -4,7 +4,7 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Archive; +package Metabase::Archive; use Moose::Role; our $VERSION = '0.01'; @@ -21,7 +21,7 @@ __END__ =head1 NAME -CPAN::Metabase::Archive - Abstract base class for CPAN::Metabase storage +Metabase::Archive - Abstract base class for Metabase storage =head1 SYNOPSIS lib/CPAN/Metabase/Archive.pm @@ -4,11 +4,11 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Archive::Filesystem; +package Metabase::Archive::Filesystem; use Moose; use Moose::Util::TypeConstraints; -use CPAN::Metabase::Fact; +use Metabase::Fact; use Carp (); use Data::GUID (); use File::Slurp (); @@ -18,7 +18,7 @@ use Path::Class (); our $VERSION = '0.01'; $VERSION = eval $VERSION; # convert '1.23_45' to 1.2345 -with 'CPAN::Metabase::Archive'; +with 'Metabase::Archive'; subtype 'ExistingDir' => as 'Object' @@ -63,7 +63,7 @@ sub store { # given guid, retrieve it and return it # type is directory path -# class isa CPAN::Metabase::Fact::Subclass +# class isa Metabase::Fact::Subclass sub extract { my ($self, $guid) = @_; @@ -86,7 +86,7 @@ sub extract { } # reconstruct fact meta and extract type to find the class - my $class = CPAN::Metabase::Fact->class_from_type($fact_meta->{type}); + my $class = Metabase::Fact->class_from_type($fact_meta->{type}); # recreate the class # XXX should this be from_struct rather than new? -- dagolden, 2009-03-31 @@ -117,7 +117,7 @@ __END__ =head1 NAME -CPAN::Metabase::Archive::Filesystem - CPAN::Metabase file-based storage +Metabase::Archive::Filesystem - Metabase file-based storage =head1 SYNOPSIS lib/CPAN/Metabase/Archive/Filesystem.pm @@ -4,12 +4,12 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Archive::SQLite; +package Metabase::Archive::SQLite; use Moose; use Moose::Util::TypeConstraints; use MooseX::Types::Path::Class; -use CPAN::Metabase::Fact; +use Metabase::Fact; use Carp (); use Data::GUID (); use JSON::XS (); @@ -21,7 +21,7 @@ use Compress::Zlib qw(compress uncompress); our $VERSION = '0.01'; $VERSION = eval $VERSION; # convert '1.23_45' to 1.2345 -with 'CPAN::Metabase::Archive'; +with 'Metabase::Archive'; has 'filename' => ( is => 'ro', @@ -95,7 +95,7 @@ sub store { # given guid, retrieve it and return it # type is directory path -# class isa CPAN::Metabase::Fact::Subclass +# class isa Metabase::Fact::Subclass sub extract { my ( $self, $guid ) = @_; my $dbh = $self->dbh; @@ -114,7 +114,7 @@ sub extract { my $meta = JSON::XS->new->decode($json); # reconstruct fact meta and extract type to find the class - my $class = CPAN::Metabase::Fact->class_from_type($type); + my $class = Metabase::Fact->class_from_type($type); # recreate the class # XXX should this be from_struct rather than new? -- dagolden, 2009-03-31 @@ -132,7 +132,7 @@ __END__ =head1 NAME -CPAN::Metabase::Archive::SQLite - CPAN::Metabase SQLite-based storage +Metabase::Archive::SQLite - Metabase SQLite-based storage =head1 SYNOPSIS lib/CPAN/Metabase/Archive/SQLite.pm @@ -1,11 +1,11 @@ -package CPAN::Metabase::Gateway; +package Metabase::Gateway; use Moose; -use CPAN::Metabase::Librarian; +use Metabase::Librarian; use Data::GUID; -use CPAN::Metabase::Fact; -use CPAN::Metabase::User::Profile; +use Metabase::Fact; +use Metabase::User::Profile; # XXX life becomes a lot easier if we say that fact classes MUST have 1-to-1 # relationship with a .pm file. -- dagolden, 2009-03-31 @@ -27,13 +27,13 @@ has approved_types => ( has librarian => ( is => 'ro', - isa => 'CPAN::Metabase::Librarian', + isa => 'Metabase::Librarian', required => 1, ); has secret_librarian => ( is => 'ro', - isa => 'CPAN::Metabase::Librarian', + isa => 'Metabase::Librarian', required => 1, ); @@ -45,7 +45,7 @@ sub _build_approved_types { while ( my $class = shift @queue ) { push @approved, $class; # XXX $class->can('fact_classes') ?? -- dagolden, 2009-03-31 - push @queue, $class->fact_classes if $class->isa('CPAN::Metabase::Report'); + push @queue, $class->fact_classes if $class->isa('Metabase::Report'); } return [ map { $_->type } @approved ]; } @@ -68,15 +68,15 @@ sub __submitter_profile { }; my $given_fact = eval { - CPAN::Metabase::User::Profile->from_struct($profile_struct); + Metabase::User::Profile->from_struct($profile_struct); }; return unless $profile_fact and $given_fact; - my ($profile_secret_fact) = grep { $_->isa('CPAN::Metabase::User::Secret') } + my ($profile_secret_fact) = grep { $_->isa('Metabase::User::Secret') } $profile_fact->facts; - my ($given_secret_fact) = grep { $_->isa('CPAN::Metabase::User::Secret') } + my ($given_secret_fact) = grep { $_->isa('Metabase::User::Secret') } $given_fact->facts; my $profile_secret = $profile_secret_fact->content; @@ -135,7 +135,7 @@ sub handle_submission { die "'$type' is not an approved fact type" unless grep { $type eq $_ } $self->approved_types; - my $class = CPAN::Metabase::Fact->class_from_type($type); + my $class = Metabase::Fact->class_from_type($type); my $fact = eval { $class->from_struct($struct) } or die "Unable to create a '$class' object: $@"; lib/CPAN/Metabase/Gateway.pm @@ -4,7 +4,7 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Index; +package Metabase::Index; use Moose::Role; our $VERSION = '0.01'; @@ -26,7 +26,7 @@ __END__ =head1 NAME -CPAN::Metabase::Index - Abstract base class for CPAN::Metabase indexing +Metabase::Index - Abstract base class for Metabase indexing =head1 SYNOPSIS lib/CPAN/Metabase/Index.pm @@ -4,7 +4,7 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Index::FlatFile; +package Metabase::Index::FlatFile; use Moose; use Moose::Util::TypeConstraints; @@ -16,7 +16,7 @@ use JSON::XS; our $VERSION = '0.01'; $VERSION = eval $VERSION; # convert '1.23_45' to 1.2345 -with 'CPAN::Metabase::Index'; +with 'Metabase::Index'; subtype 'File' => as 'Object' @@ -114,7 +114,7 @@ sub _match { =head1 NAME -CPAN::Metabase::Index::FlatFile - CPAN::Metabase flat-file index +Metabase::Index::FlatFile - Metabase flat-file index =head1 SYNOPSIS lib/CPAN/Metabase/Index/FlatFile.pm @@ -4,13 +4,13 @@ # A copy of the License was distributed with this file or you may obtain a # copy of the License from http://dev.perl.org/licenses/ -package CPAN::Metabase::Librarian; +package Metabase::Librarian; use Moose; use Moose::Util::TypeConstraints; use Carp (); use CPAN::DistnameInfo; -use CPAN::Metabase::Archive; -use CPAN::Metabase::Index; +use Metabase::Archive; +use Metabase::Index; use Data::GUID (); our $VERSION = '0.01'; @@ -18,13 +18,13 @@ $VERSION = eval $VERSION; # convert '1.23_45' to 1.2345 has 'archive' => ( is => 'ro', - isa => 'CPAN::Metabase::Archive', + isa => 'Metabase::Archive', required => 1, ); has 'index' => ( is => 'ro', - isa => 'CPAN::Metabase::Index', + isa => 'Metabase::Index', required => 1, ); @@ -32,6 +32,8 @@ has 'index' => ( sub store { my ($self, $fact) = @_; + # XXX: This needs to be made a per-resource-type analyzer. -- rjbs, + # 2009-04-02 my $d = CPAN::DistnameInfo->new($fact->resource); # Don't store existing GUIDs; this should never happen, since we're just @@ -65,7 +67,7 @@ __END__ =head1 NAME -CPAN::Metabase::Librarian - no human would stack books this way +Metabase::Librarian - no human would stack books this way =head1 SYNOPSIS lib/CPAN/Metabase/Librarian.pm @@ -1,4 +1,4 @@ -The Indexer part of CPAN::Metabase will be a Solr server. Solr is a web +The Indexer part of Metabase will be a Solr server. Solr is a web interface to Lucene. It is powerful and flexible and meets our needs very well. solr/README @@ -9,5 +9,5 @@ use warnings; use Test::More tests => 1; -require_ok( 'CPAN::Metabase::Index' ); +require_ok( 'Metabase::Index' ); t/index/base.t @@ -21,16 +21,16 @@ plan tests => 14; #-------------------------------------------------------------------------# -require_ok( 'CPAN::Metabase::Index::FlatFile' ); +require_ok( 'Metabase::Index::FlatFile' ); ok( my $archive = $TEST->test_archive, 'created archive' ); -isa_ok( $archive, 'CPAN::Metabase::Archive::SQLite' ); +isa_ok( $archive, 'Metabase::Archive::SQLite' ); ok( my $index = $TEST->test_index, 'created an index' ); -isa_ok( $index, 'CPAN::Metabase::Index::FlatFile' ); +isa_ok( $index, 'Metabase::Index::FlatFile' ); ok( my $fact = $TEST->test_fact, "created a fact" ); -isa_ok( $fact, 'CPAN::Metabase::Fact::TestFact' ); +isa_ok( $fact, 'Metabase::Fact::TestFact' ); ok( my $guid = $archive->store( $fact ), "stored a fact" ); t/index/flatfile.t @@ -14,23 +14,23 @@ close $store_dir->file('metabase.index')->openw; has test_gateway => ( is => 'ro', - isa => 'CPAN::Metabase::Gateway', + isa => 'Metabase::Gateway', lazy => 1, default => sub { - require CPAN::Metabase::Analyzer::Test; - my $gateway = CPAN::Metabase::Gateway->new({ - fact_classes => [ 'CPAN::Metabase::Fact::TestFact' ], + require Metabase::Analyzer::Test; + my $gateway = Metabase::Gateway->new({ + fact_classes => [ 'Metabase::Fact::TestFact' ], }); } ); has test_fact => ( is => 'ro', - isa => 'CPAN::Metabase::Fact', + isa => 'Metabase::Fact', lazy => 1, default => sub { - require CPAN::Metabase::Fact::TestFact; - CPAN::Metabase::Fact::TestFact->new( + require Metabase::Fact::TestFact; + Metabase::Fact::TestFact->new( resource => 'JOHNDOE/Foo-Bar-1.23.tar.gz', content => "I smell something fishy.", ); @@ -39,11 +39,11 @@ has test_fact => ( has test_archive => ( is => 'ro', - isa => 'CPAN::Metabase::Archive::SQLite', + isa => 'Metabase::Archive::SQLite', lazy => 1, default => sub { - require CPAN::Metabase::Archive::SQLite; - CPAN::Metabase::Archive::SQLite->new( + require Metabase::Archive::SQLite; + Metabase::Archive::SQLite->new( filename => "$temp_dir/store.db", compressed => 0, ); @@ -52,11 +52,11 @@ has test_archive => ( has test_index => ( is => 'ro', - isa => 'CPAN::Metabase::Index::FlatFile', + isa => 'Metabase::Index::FlatFile', lazy => 1, default => sub { - require CPAN::Metabase::Index::FlatFile; - CPAN::Metabase::Index::FlatFile->new( + require Metabase::Index::FlatFile; + Metabase::Index::FlatFile->new( index_file => "$temp_dir/store/metabase.index", ); }, @@ -64,11 +64,11 @@ has test_index => ( has test_librarian => ( is => 'ro', - isa => 'CPAN::Metabase::Librarian', + isa => 'Metabase::Librarian', lazy => 1, default => sub { - require CPAN::Metabase::Librarian; - CPAN::Metabase::Librarian->new( + require Metabase::Librarian; + Metabase::Librarian->new( archive => $_[0]->test_archive, 'index' => $_[0]->test_index, ); t/lib/Test/Metabase/Util.pm @@ -2,4 +2,4 @@ use strict; use warnings; use Test::More tests => 1; -use_ok('CPAN::Metabase::Gateway'); +use_ok('Metabase::Gateway'); t/lib/gateway.t @@ -21,12 +21,12 @@ plan tests => 10; #-------------------------------------------------------------------------# -require_ok( 'CPAN::Metabase::Librarian' ); +require_ok( 'Metabase::Librarian' ); ok( my $librarian = $TEST->test_librarian, 'created librarian' ); ok( my $fact = $TEST->test_fact, "created a fact" ); -isa_ok( $fact, 'CPAN::Metabase::Fact::TestFact' ); +isa_ok( $fact, 'Metabase::Fact::TestFact' ); ok( my $guid = $librarian->store($fact, { user_id => 'Larry' }), t/librarian/simple.t @@ -9,5 +9,5 @@ use warnings; use Test::More tests => 1; -require_ok( 'CPAN::Metabase::Archive' ); +require_ok( 'Metabase::Archive' ); t/storage/base.t @@ -13,7 +13,7 @@ use File::Temp (); use File::Path (); use lib 't/lib'; -use CPAN::Metabase::Fact::TestFact; +use Metabase::Fact::TestFact; #--------------------------------------------------------------------------# @@ -23,13 +23,13 @@ my $dist_id = 'UNKNOWN/Foo-Bar-1.23.tar.gz'; plan tests => 10; -require_ok( 'CPAN::Metabase::Archive::Filesystem' ); +require_ok( 'Metabase::Archive::Filesystem' ); # die on missing or non-existing directory my $re_bad_root_dir = qr/\QAttribute (root_dir)\E/; -throws_ok { CPAN::Metabase::Archive::Filesystem->new() } $re_bad_root_dir; +throws_ok { Metabase::Archive::Filesystem->new() } $re_bad_root_dir; throws_ok { - CPAN::Metabase::Archive::Filesystem->new(root_dir => 'doesntexist') + Metabase::Archive::Filesystem->new(root_dir => 'doesntexist') } $re_bad_root_dir; # store into a temp directory @@ -39,15 +39,15 @@ File::Path::mkpath( $temp_root ); my $archive; lives_ok { - $archive = CPAN::Metabase::Archive::Filesystem->new(root_dir => "$temp_root"); + $archive = Metabase::Archive::Filesystem->new(root_dir => "$temp_root"); } "created store at '$temp_root'"; -my $fact = CPAN::Metabase::Fact::TestFact->new( +my $fact = Metabase::Fact::TestFact->new( resource => $dist_id, content => "I smell something fishy.", ); -isa_ok( $fact, 'CPAN::Metabase::Fact::TestFact' ); +isa_ok( $fact, 'Metabase::Fact::TestFact' ); ok( my $guid = $archive->store( $fact ), "stored a fact" ); t/storage/filesystem.t 57a05ae2361e110623df8d2785048de342f264f8 Ricardo SIGNES rjbs@cpan.org http://github.com/dagolden/metabase/commit/832ee54e0c345e88c9404ffacdd20c91897eea2e 832ee54e0c345e88c9404ffacdd20c91897eea2e 2009-04-02T06:39:00-07:00 2009-04-02T06:39:00-07:00 the great renaming also, a comment 6e1eeb6394763e8be929362df309783585161b3c Ricardo SIGNES rjbs@cpan.org