Merge branch 'master' of git://github.com/bobtfish/Gitalist

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

diff --git a/lib/Gitalist/Git/Repo.pm b/lib/Gitalist/Git/Repo.pm
index 4146575..4a5d491 100644 (file)
--- a/lib/Gitalist/Git/Repo.pm
+++ b/lib/Gitalist/Git/Repo.pm
@@ -1,10 +1,39 @@
 use MooseX::Declare;
 
+=head1 NAME
+
+Gitalist::Git::Repo - Model of a repository directory
+
+=head1 SYNOPSIS
+
+    my $repo = Gitalist::Git::Repo->new( repo_dir => $Dir );
+    my $project_list = $repo->projects;
+    my $first_project = @$project_list[0];
+    my $named_project = $repo->project('Gitalist');
+
+=head1 DESCRIPTION
+
+This class models a Gitalist Repo, which is a collection of
+Projects (git repositories).  It is used for creating Project
+objects to work with.
+
+=cut
+
+
 class Gitalist::Git::Repo {
     use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
     use MooseX::Types::Path::Class qw/Dir/;
     use MooseX::Types::Moose qw/ArrayRef/;
-    use Gitalist::Git::Project;
+    use aliased 'Gitalist::Git::Project';
+
+=head1 ATTRIBUTES
+
+=head2 repo_dir
+
+L<Path::Class::Dir> for the root of the Repo.
+
+=cut
+
     has repo_dir => (
         isa => Dir,
         is => 'ro',
@@ -12,37 +41,36 @@ class Gitalist::Git::Repo {
         coerce => 1,
     );
 
-    method project (NonEmptySimpleStr $project) {
-        return Gitalist::Git::Project->new(
-            name => $project,
-            path => $self->repo_dir->subdir($project),
-        );
-    }
+=head2 projects
 
+An array of L<Gitalist::Git::Project> for each valid git repo
+found in repo_dir.
 
-=head2 _is_git_repo
+=cut
 
-Determine whether a given directory (as a L<Path::Class::Dir> object) is a
-C<git> repo.
+    has projects => (
+        is => 'ro',
+        isa => ArrayRef['Gitalist::Git::Project'],
+        required => 1,
+        lazy_build => 1,
+    );
 
-=cut
 
-    method _is_git_repo ($dir) {
-        return -f $dir->file('HEAD') || -f $dir->file('.git', 'HEAD');
-    }
+=head1 METHODS
 
-=head2 list_projects
+=head2 project
 
-For the C<repo_dir> specified in the config return an array of projects where
-each item will contain the contents of L</project_info>.
+Returns a L<Gitalist::Git::Project> for the specified project
+name.
 
 =cut
 
-    has projects => (
-        isa => ArrayRef['Gitalist::Git::Project'],
-        reader => 'list_projects',
-        lazy_build => 1,
-    );
+    method project (NonEmptySimpleStr $project) {
+        my $path = $self->repo_dir->subdir($project);
+        die "Not a valid Project" unless $self->_is_git_repo($path);
+        return Project->new( $self->repo_dir->subdir($project) );
+    }
+
 
     method _build_projects {
         my $base = $self->repo_dir;
@@ -55,12 +83,30 @@ each item will contain the contents of L</project_info>.
             next unless -d $obj;
             next unless $self->_is_git_repo($obj);
 
-            push @ret, Gitalist::Git::Project->new(
-                name => $file,
-                path => $obj,
-            );
+            push @ret, $self->project($file);
         }
 
         return [sort { $a->name cmp $b->name } @ret];
     }
+
+    # Determine whether a given directory is a git repo.
+    method _is_git_repo ($dir) {
+        return -f $dir->file('HEAD') || -f $dir->file('.git', 'HEAD');
+    }
 }                               # end class
+
+__END__
+
+=head1 SEE ALSO
+
+L<Gitalist::Git::Project>
+
+=head1 AUTHORS
+
+See L<Gitalist> for authors.
+
+=head1 LICENSE
+
+See L<Gitalist> for the license.
+
+=cut