Get sane debugging info for the setup of everything
[catagits/Gitalist.git] / lib / Gitalist / Git / CollectionOfRepositories / FromDirectory.pm
1 use MooseX::Declare;
2
3 class Gitalist::Git::CollectionOfRepositories::FromDirectory
4     with Gitalist::Git::CollectionOfRepositories {
5     use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
6     use MooseX::Types::Path::Class qw/Dir/;
7
8     has repo_dir => (
9         isa => Dir,
10         is => 'ro',
11         required => 1,
12         coerce => 1,
13     );
14
15     method debug_string { 'repository directory ' . $self->repo_dir }
16
17     method BUILD {
18         # Make sure repo_dir is an absolute path so that
19         # ->contains() works correctly.
20         $self->repo_dir->resolve;
21     }
22
23     method _get_path_for_repository_name (NonEmptySimpleStr $name) {
24         my $path = $self->repo_dir->subdir($name)->resolve;
25         die "Directory traversal prohibited"
26             unless $self->repo_dir->contains($path);
27         return $path;
28     }
29
30     method _get_repo_from_name (NonEmptySimpleStr $name) {
31         return Gitalist::Git::Repository->new($self->_get_path_for_repository_name($name));
32     }
33
34     ## Builders
35     method _build_repositories {
36         my $dh = $self->repo_dir->open || die "Could not open repo_dir";
37         my @ret;
38         while (my $dir_entry = $dh->read) {
39             # try to get a repository for each entry in repo_dir
40              eval {
41                  my $p = $self->get_repository($dir_entry);
42                  push @ret, $p;
43             };
44          }
45         return \@ret;
46     }
47 }                               # end class
48
49 __END__
50
51 =head1 NAME
52
53 Gitalist::Git::CollectionOfRepositories::FromDirectory - Model of a directory containing git repositories
54
55 =head1 SYNOPSIS
56
57     my $repo = Gitalist::Git::CollectionOfRepositories::FromDirectory->new( repo_dir => $Dir );
58     my $repository_list = $repo->repositories;
59     my $first_repository = $repository_list->[0];
60     my $named_repository = $repo->get_repository('Gitalist');
61
62 =head1 DESCRIPTION
63
64 This class provides a list of Repositories found in the given directory.
65
66 =head1 ATTRIBUTES
67
68 =head2 repo_dir (C<Path::Class::Dir>)
69
70 The filesystem root of the C<Repo>.
71
72 =head1 SEE ALSO
73
74 L<Gitalist::Git::CollectionOfRepositories>, L<Gitalist::Git::Repository>
75
76 =head1 AUTHORS
77
78 See L<Gitalist> for authors.
79
80 =head1 LICENSE
81
82 See L<Gitalist> for the license.
83
84 =cut