package Git::Gitalist::Repository;
use Moose;
with qw(
Git::Gitalist::HasUtils
Git::Gitalist::Serializable
);
use Method::Signatures;
use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
use MooseX::Types::Moose qw/Str Maybe Bool HashRef ArrayRef/;
use MooseX::Types::DateTime qw/DateTime/;
use MooseX::Types::Path::Class qw/Dir/;
use Git::Gitalist::Types qw/SHA1/;
use aliased 'DateTime' => 'DT';
use List::MoreUtils qw/any zip/;
use Encode qw/decode/;
use if $^O ne 'MSWin32' => 'I18N::Langinfo', qw/langinfo CODESET/;
use Git::Gitalist::Object::Blob;
use Git::Gitalist::Object::Tree;
use Git::Gitalist::Object::Commit;
use Git::Gitalist::Object::Tag;
use Git::Gitalist::Head;
use Git::Gitalist::Tag;
our $SHA1RE = qr/[0-9a-fA-F]{40}/;
has name => (
isa => NonEmptySimpleStr,
is => 'ro',
required => 1,
);
has path => (
isa => Dir,
is => 'ro',
required => 1,
coerce => 1,
traits => ['DoNotSerialize'],
);
has description => (
isa => Str,
is => 'ro',
lazy_build => 1,
);
has owner => (
isa => NonEmptySimpleStr,
is => 'ro',
lazy_build => 1,
);
has last_change => (
isa => Maybe[DateTime],
is => 'ro',
lazy_build => 1,
);
has is_bare => (
isa => Bool,
is => 'ro',
lazy => 1,
default => sub {
-d $_[0]->path->parent->subdir($_[0]->name)
},
);
has heads => (
isa => ArrayRef['Git::Gitalist::Head'],
is => 'ro',
lazy_build => 1,
);
has tags => (
isa => ArrayRef['Git::Gitalist::Tag'],
is => 'ro',
lazy_build => 1,
);
has references => (
isa => HashRef[ArrayRef[Str]],
is => 'ro',
lazy_build => 1,
);
around BUILDARGS => method($orig: $class, $dir, Str $override_name = '') {
$dir = Path::Class::dir($dir) unless ref $dir;
# Allows us to be called as Repository->new($dir)
# Last path component becomes $self->name
# Full path to git objects becomes $self->path
my $name = $dir->dir_list(-1);
if(-f $dir->file('.git', 'HEAD')) { # Non-bare repo above .git
$dir = $dir->subdir('.git');
$name = $dir->dir_list(-2, 1); # .../name/.git
} elsif('.git' eq $dir->dir_list(-1)) { # Non-bare repo in .git
$name = $dir->dir_list(-2);
}
confess("Can't find a git repository at " . $dir)
unless -f $dir->file('HEAD');
return $class->$orig(name => $override_name || $name,
path => $dir);
};
method BUILD($args) {
$self->$_() for qw/last_change owner description /; # Ensure to build early.
}
## Public methods
method head_hash (Str $head?) {
my $output = $self->run_cmd(qw/rev-parse --verify/, $head || 'HEAD' );
confess("No such head: " . $head) unless defined $output;
my($sha1) = $output =~ /^($SHA1RE)$/;
return $sha1;
}
method get_object (MooseX::Types::Common::String::NonEmptySimpleStr $sha1) {
unless (is_SHA1($sha1)) {
$sha1 = $self->head_hash($sha1);
}
my $type = $self->run_cmd('cat-file', '-t', $sha1);
chomp($type);
my $class = 'Git::Gitalist::Object::' . ucfirst($type);
$class->new(
repository => $self,
sha1 => $sha1,
type => $type,
);
}
method list_revs ( MooseX::Types::Common::String::NonEmptySimpleStr :$sha1!,
Int :$count?,
Int :$skip?,
HashRef :$search?,
MooseX::Types::Common::String::NonEmptySimpleStr :$file? ) {
$sha1 = $self->head_hash($sha1)
if !$sha1 || $sha1 !~ $SHA1RE;
my @search_opts;
if ($search and exists $search->{text}) {
$search->{type} = 'grep'
if $search->{type} eq 'commit';
@search_opts = (
# This seems a little fragile ...
qq[--$search->{type}=$search->{text}],
'--regexp-ignore-case',
$search->{regexp} ? '--extended-regexp' : '--fixed-strings'
);
}
my $output = $self->run_cmd(
'rev-list',
'--header',
(defined $count ? "--max-count=$count" : ()),
(defined $skip ? "--skip=$skip" : ()),
@search_opts,
$sha1,
'--',
($file ? $file : ()),
);
return unless $output;
my @revs = $self->_parse_rev_list($output);
return @revs;
}
method snapshot (MooseX::Types::Common::String::NonEmptySimpleStr :$sha1,
MooseX::Types::Common::String::NonEmptySimpleStr :$format
) {
# TODO - only valid formats are 'tar' and 'zip'
my $formats = { tgz => 'tar', zip => 'zip' };
unless (exists $formats->{$format}) {
die("No such format: $format");
}
$format = $formats->{$format};
my $name = $self->name;
$name =~ s,([^/])/*\.git$,$1,;
my $filename = $name;
$filename .= "-$sha1.$format";
$name =~ s/\047/\047\\\047\047/g;
my @cmd = ('archive', "--format=$format", "--prefix=$name/", $sha1);
return ($filename, $self->run_cmd_fh(@cmd));
# TODO - support compressed archives
}
## BUILDERS
method _build_util {
Git::Gitalist::Util->new(
repository => $self,
);
}
method _build_description {
my $description = "";
eval {
$description = $self->path->file('description')->slurp;
utf8::decode($description);
chomp $description;
};
$description = "Unnamed repository, edit the .git/description file to set a description"
if $description eq "Unnamed repository; edit this file 'description' to name the repository.";
return $description;
}
method _build_owner {
return 'system' if $^O =~ 'MSWin32';
my ($gecos, $name) = map { decode(langinfo(CODESET()), $_) } (getpwuid $self->path->stat->uid)[6,0];
$gecos =~ s/,+$//;
return length($gecos) ? $gecos : $name;
}
method _build_last_change {
my $last_change;
my $output = $self->run_cmd(
qw{ for-each-ref --format=%(committer)
--sort=-committerdate --count=1 refs/heads
});
if (my ($epoch, $tz) = $output =~ /\s(\d+)\s+([+-]\d+)$/) {
my $dt = DT->from_epoch(epoch => $epoch);
$dt->set_time_zone($tz);
$last_change = $dt;
}
return $last_change;
}
method _build_heads {
my @revlines = $self->run_cmd_list(qw/for-each-ref --sort=-committerdate /, '--format=%(objectname)%00%(refname)%00%(committer)', 'refs/heads');
my @ret;
for my $line (@revlines) {
push @ret, Git::Gitalist::Head->new($line);
}
return \@ret;
}
method _build_tags {
my @revlines = $self->run_cmd_list('for-each-ref',
'--sort=-creatordate',
'--format=%(objectname) %(objecttype) %(refname) %(*objectname) %(*objecttype) %(subject)%00%(creator)',
'refs/tags'
);
return [
map Git::Gitalist::Tag->new($_),
grep Git::Gitalist::Tag::is_valid_tag($_), @revlines
];
}
method _build_references {
# 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
# c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
my @reflist = $self->run_cmd_list(qw(show-ref --dereference))
or return;
my %refs;
for (@reflist) {
push @{$refs{$1}}, $2
if m!^($SHA1RE)\srefs/(.*)$!;
}
return \%refs;
}
## Private methods
method _parse_rev_list ($output) {
return
map $self->get_gpp_object($_),
grep is_SHA1($_),
map split(/\n/, $_, 6), split /\0/, $output;
}
1;
__END__
=head1 NAME
Git::Gitalist::Repository - Model of a git repository
=head1 SYNOPSIS
my $gitrepo = dir('/repo/base/Gitalist');
my $repository = Git::Gitalist::Repository->new($gitrepo);
$repository->name; # 'Gitalist'
$repository->path; # '/repo/base/Gitalist/.git'
$repository->description; # 'Unnamed repository.'
=head1 DESCRIPTION
This class models a git repository, referred to in Gitalist
as a "Repository".
=head1 ATTRIBUTES
=head2 name
The name of the Repository. If unspecified, this will be derived from the path to the git repository.
=head2 path
L<Path::Class:Dir> for the filesystem path to the git repository.
=head2 description
The contents of .git/description.
=head2 owner
Owner of the files on the filesystem.
=head2 last_change
The L<DateTime> of the last modification of the repository. This will be C<undef> if the repository has never been used.
=head2 is_bare
True if this is a bare git repository.
=head2 heads
=head2 tags
An array of the name and sha1 of all heads/tags in the repository.
=head2 references
Hashref of ArrayRefs for each reference.
=head1 METHODS
=head2 head_hash ($head?)
Return the sha1 for HEAD, or any specified head.
=head2 get_object ($sha1)
Return an appropriate subclass of L<Git::Gitalist::Object> for the given sha1.
=head2 list_revs ($sha1, $count?, $skip?, \%search?, $file?)
Returns a list of revs for the given head ($sha1).
=head2 snapshot ($sha1, $format)
Generate an archived snapshot of the repository.
$sha1 should be a commit or tree.
Returns a filehandle to read from.
=head2 diff ($commit, $patch?, $parent?, $file?)
Generate a diff from a given L<Git::Gitalist::Object>.
=head2 reflog (@lorgargs)
Return a list of hashes representing each reflog entry.
FIXME Should this return objects?
=head1 SEE ALSO
L<Git::Gitalist::Util> L<Git::Gitalist::Object>
=head1 AUTHORS
See L<Git::Gitalist> for authors.
=head1 LICENSE
See L<Git::Gitalist> for the license.
=cut