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 Path::Class;
- use Gitalist::Git::Project;
- has repo_dir => ( isa => NonEmptySimpleStr,
- is => 'ro',
- required => 1 );
+ use MooseX::Types::Path::Class qw/Dir/;
+ use MooseX::Types::Moose qw/ArrayRef/;
+ use aliased 'Gitalist::Git::Project';
+
+=head1 ATTRIBUTES
-=head2 _is_git_repo
+=head2 repo_dir
-Determine whether a given directory (as a L<Path::Class::Dir> object) is a
-C<git> repo.
+L<Path::Class::Dir> for the root of the Repo.
=cut
- method _is_git_repo ($dir) {
- return -f $dir->file('HEAD') || -f $dir->file('.git', 'HEAD');
- }
+ has repo_dir => (
+ isa => Dir,
+ is => 'ro',
+ required => 1,
+ coerce => 1,
+ );
-=head2 project_dir
+=head2 projects
-The directory under which the given project will reside i.e C<.git/..>
+An array of L<Gitalist::Git::Project> for each valid git repo
+found in repo_dir.
=cut
- method project_dir ($project) {
- -f $project->file('.git', 'HEAD')
- ? $project->subdir('.git')
- : $project;
- }
+ has projects => (
+ is => 'ro',
+ isa => ArrayRef['Gitalist::Git::Project'],
+ required => 1,
+ lazy_build => 1,
+ );
+
+
+=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
- method list_projects {
- my $base = dir($self->repo_dir);
- my @ret;
+ 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;
my $dh = $base->open || die "Could not open $base";
+ my @ret;
while (my $file = $dh->read) {
next if $file =~ /^.{1,2}$/;
next unless -d $obj;
next unless $self->_is_git_repo($obj);
- # FIXME - Is resolving project_dir here sane?
- # I think not, just pass $obj down, and
- # resolve $project->path and $project->is_bare
- # in BUILDARGS
- push @ret, Gitalist::Git::Project->new( name => $file,
- path => $self->project_dir($obj),
- );
+ push @ret, $self->project($file);
}
- return [sort { $a->{name} cmp $b->{name} } @ret];
+ return [sort { $a->name cmp $b->name } @ret];
}
-=head2 dir_from_project_name
+ # 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
-Get the corresponding directory of a given project.
+__END__
-=cut
+=head1 SEE ALSO
- method dir_from_project_name (Str $project) {
- return dir($self->repo_dir)->subdir($project);
- }
+L<Gitalist::Git::Project>
+=head1 AUTHORS
+See L<Gitalist> for authors.
-} # end class
+=head1 LICENSE
+
+See L<Gitalist> for the license.
+
+=cut