Clearer error message for get_repository.

[catagits/Gitalist.git] / lib / Gitalist / Git / CollectionOfRepositories.pm

diff --git a/lib/Gitalist/Git/CollectionOfRepositories.pm b/lib/Gitalist/Git/CollectionOfRepositories.pm
index 031a659..cea9050 100644 (file)
--- a/lib/Gitalist/Git/CollectionOfRepositories.pm
+++ b/lib/Gitalist/Git/CollectionOfRepositories.pm
@@ -6,30 +6,91 @@ role Gitalist::Git::CollectionOfRepositories {
     use Moose::Autobox;
     use aliased 'Gitalist::Git::Repository';
 
-    has projects => (
+    has repositories => (
         is => 'ro',
         isa => ArrayRef['Gitalist::Git::Repository'],
         required => 1,
         lazy_build => 1,
     );
     method get_repository (NonEmptySimpleStr $name) {
-        my $path = $self->_get_path_for_project_name($name);
-        die "Not a valid git repository."
+        my $path = $self->_get_path_for_repository_name($name);
+        die "Couldn't get_repository '$name' - not a valid git repository."
             unless $self->_is_git_repo($path);
         return Repository->new( $path );
     }
     # Determine whether a given directory is a git repo.
+    # http://www.kernel.org/pub/software/scm/git/docs/gitrepository-layout.html
     method _is_git_repo ($dir) {
         return -f $dir->file('HEAD') || -f $dir->file('.git', 'HEAD');
     }
     requires qw/
-        _build_projects
-        _get_path_for_project_name
+        _build_repositories
+        _get_path_for_repository_name
     /;
 
-    around _build_projects {
+    around _build_repositories {
         [sort { $a->name cmp $b->name } $self->$orig->flatten];
     }
 }
 
 1;
+
+=head1 NAME
+
+Gitalist::Git::CollectionOfRepositories - Interface and partial implementation of a collection of git repositories
+
+=head1 SYNOPSIS
+
+    package My::Example::CollectionOfRepositories;
+    use Moose::Role;
+    use namespace::autoclean;
+
+    with 'Gitalist::Git::CollectionOfRepositories';
+
+    sub _build_repositories {
+        my $self = shift;
+        [ $self->get_repository('Gitalist') ];
+    }
+    sub _get_path_for_repository_name {
+        my ($self, $name) = @_;
+        '/var/example/' . $name . '.git';
+    }
+
+    my $collection = My::Example::CollectionOfRepositories->new
+    my $repository_list = $collection->repositories;
+    my $only_repository = $repository_list->[0];
+    my $named_repository = $repo->get_repository('Gitalist');
+
+=head1 DESCRIPTION
+
+This role provides an abstraction for a list of Repository directories.
+
+=head1 ATTRIBUTES
+
+=head2 repositories
+
+An array of all L<Gitalist::Git::Repository>s.
+
+=head1 METHODS
+
+=head2 get_repository (Str $name)
+
+Returns a L<Gitalist::Git::Repository> for the given name.
+If C<$name> is not a valid git repository an exception will be thrown.
+
+=head1 SEE ALSO
+
+L<Gitalist::Git::CollectionOfRepositories::FromListOfDirectories>,
+L<Gitalist::Git::CollectionOfRepositories::FromDirectory>,
+L<Gitalist::Git::Repository>.
+
+=head1 AUTHORS
+
+See L<Gitalist> for authors.
+
+=head1 LICENSE
+
+See L<Gitalist> for the license.
+
+=cut
+