5 Gitalist::Git::Project - Model of a git repository
9 my $gitrepo = dir('/repo/base/Gitalist');
10 my $project = Gitalist::Git::Project->new($gitrepo);
11 $project->name; # 'Gitalist'
12 $project->path; # '/repo/base/Gitalist/.git'
13 $project->description; # 'Unnamed repository.'
17 This class models a git repository, referred to in Gitalist
22 class Gitalist::Git::Project with Gitalist::Git::HasUtils {
23 # FIXME, use Types::Path::Class and coerce
24 use MooseX::Types::Common::String qw/NonEmptySimpleStr/;
25 use MooseX::Types::Path::Class qw/Dir/;
26 use MooseX::Types::Moose qw/Str Maybe Bool HashRef ArrayRef/;
27 use List::MoreUtils qw/any zip/;
29 use aliased 'Gitalist::Git::Object';
31 our $SHA1RE = qr/[0-9a-fA-F]{40}/;
33 around BUILDARGS (ClassName $class: Dir $dir) {
34 # Allows us to be called as Project->new($dir)
35 # Last path component becomes $self->name
36 # Full path to git objects becomes $self->path
37 my $name = $dir->dir_list(-1);
38 $dir = $dir->subdir('.git') if (-f $dir->file('.git', 'HEAD'));
39 confess("Can't find a git repository at " . $dir)
40 unless ( -f $dir->file('HEAD') );
41 return $class->$orig(name => $name,
49 The name of the Project. By default, this is derived from the path to the git repository.
52 has name => ( isa => NonEmptySimpleStr,
53 is => 'ro', required => 1 );
57 L<Path::Class:Dir> for the location of the git repository.
60 has path => ( isa => Dir,
61 is => 'ro', required => 1);
65 String containing .git/description
68 has description => ( isa => Str,
75 Owner of the files on disk.
78 has owner => ( isa => NonEmptySimpleStr,
85 L<DateTime> for the time of the last update.
86 undef if the repository has never been used.
89 has last_change => ( isa => Maybe['DateTime'],
96 Bool indicating whether this Project is bare.
99 has is_bare => ( isa => Bool,
103 -d $_[0]->path->parent->subdir->($_[0]->name)
110 ArrayRef of hashes containing the name and sha1 of all heads.
113 has heads => ( isa => ArrayRef[HashRef],
119 Hashref of ArrayRefs for each reference.
122 has references => ( isa => HashRef[ArrayRef[Str]],
127 $self->$_() for qw/last_change owner description/; # Ensure to build early.
132 =head2 head_hash ($head?)
134 Return the sha1 for HEAD, or any specified head.
137 method head_hash (Str $head?) {
138 my $output = $self->run_cmd(qw/rev-parse --verify/, $head || 'HEAD' );
139 confess("No such head: " . $head) unless defined $output;
141 my($sha1) = $output =~ /^($SHA1RE)$/;
145 =head2 list_tree ($sha1?)
147 Return an array of contents for a given tree.
148 The tree is specified by sha1, and defaults to HEAD.
149 Each item is a L<Gitalist::Git::Object>.
152 method list_tree (Str $sha1?) {
153 $sha1 ||= $self->head_hash;
155 my $output = $self->run_cmd(qw/ls-tree -z/, $sha1);
156 return unless defined $output;
159 for my $line (split /\0/, $output) {
160 my ($mode, $type, $object, $file) = split /\s+/, $line, 4;
161 push @ret, Object->new( mode => oct $mode,
171 =head2 get_object ($sha1)
173 Return a L<Gitalist::Git::Object> for the given sha1.
176 method get_object (NonEmptySimpleStr $sha1) {
177 unless ( $self->_is_valid_rev($sha1) ) {
178 $sha1 = $self->head_hash($sha1);
186 =head2 hash_by_path($sha1, $path, $type?)
188 Returns the sha1 for a given path, optionally limited by type.
191 method hash_by_path ($base, $path = '', $type?) {
193 # FIXME should this really just take the first result?
194 my @paths = $self->run_cmd('ls-tree', $base, '--', $path)
196 my $line = $paths[0];
198 #'100644 blob 0fa3f3a66fb6a137f6ec2c19351ed4d807070ffa panic.c'
199 $line =~ m/^([0-9]+) (.+) ($SHA1RE)\t/;
200 return defined $type && $type ne $2
205 =head2 list_revs($sha1, $count?, $skip?, \%search?, $file?)
207 Returns a list of revs for the given head ($sha1).
210 method list_revs ( NonEmptySimpleStr :$sha1!,
214 NonEmptySimpleStr :$file? ) {
215 $sha1 = $self->head_hash($sha1)
216 if !$sha1 || $sha1 !~ $SHA1RE;
220 $search->{type} = 'grep'
221 if $search->{type} eq 'commit';
223 # This seems a little fragile ...
224 qq[--$search->{type}=$search->{text}],
225 '--regexp-ignore-case',
226 $search->{regexp} ? '--extended-regexp' : '--fixed-strings'
230 my $output = $self->run_cmd(
233 (defined $count ? "--max-count=$count" : ()),
234 (defined $skip ? "--skip=$skip" : ()),
238 ($file ? $file : ()),
240 return unless $output;
242 my @revs = $self->_parse_rev_list($output);
247 =head2 diff($commit, $patch?, $parent?, $file?)
249 Generate a diff from a given L<Gitalist::Git::Object>.
253 method diff ( Gitalist::Git::Object :$commit!,
255 Maybe[NonEmptySimpleStr] :$parent?,
256 NonEmptySimpleStr :$file?
258 return $commit->diff( patch => $patch,
263 =head2 reflog(@lorgargs)
265 Return a list of hashes representing each reflog entry.
267 FIXME Should this return objects?
270 method reflog (@logargs) {
272 = $self->run_cmd(qw(log -g), @logargs)
273 =~ /(^commit.+?(?:(?=^commit)|(?=\z)))/msg;
275 # commit 02526fc15beddf2c64798a947fecdd8d11bf993d
276 # Reflog: HEAD@{14} (The Git Server <git@git.dev.venda.com>)
277 # Reflog message: push
278 # Author: Foo Barsby <fbarsby@example.com>
279 # Date: Thu Sep 17 12:26:05 2009 +0100
281 # Merge branch 'abc123'
284 # XXX Stuff like this makes me want to switch to Git::PurePerl
285 my($sha1, $type, $author, $date)
287 ^ commit \s+ ($SHA1RE)$
289 Reflog[ ]message: \s+ (.+?)$ \s+
290 Author: \s+ ([^<]+) <.*?$ \s+
294 pos($_) = index($_, $date) + length $date;
296 # Yeah, I just did that.
297 my($msg) = /\G\s+(\S.*)/sg;
303 # XXX Add DateTime goodness.
312 method _build__util {
313 Gitalist::Git::Util->new(
318 method _build_description {
319 return $self->gpp->description;
322 method _build_owner {
323 my ($gecos, $name) = (getpwuid $self->path->stat->uid)[6,0];
325 return length($gecos) ? $gecos : $name;
328 method _build_last_change {
330 my $output = $self->run_cmd(
331 qw{ for-each-ref --format=%(committer)
332 --sort=-committerdate --count=1 refs/heads
334 if (my ($epoch, $tz) = $output =~ /\s(\d+)\s+([+-]\d+)$/) {
335 my $dt = DateTime->from_epoch(epoch => $epoch);
336 $dt->set_time_zone($tz);
342 method _build_heads {
343 my @revlines = $self->run_cmd_list(qw/for-each-ref --sort=-committerdate /, '--format=%(objectname)%00%(refname)%00%(committer)', 'refs/heads');
345 for my $line (@revlines) {
346 my ($rev, $head, $commiter) = split /\0/, $line, 3;
347 $head =~ s!^refs/heads/!!;
349 push @ret, { sha1 => $rev, name => $head };
351 #FIXME: That isn't the time I'm looking for..
352 if (my ($epoch, $tz) = $line =~ /\s(\d+)\s+([+-]\d+)$/) {
353 my $dt = DateTime->from_epoch(epoch => $epoch);
354 $dt->set_time_zone($tz);
355 $ret[-1]->{last_change} = $dt;
362 method _build_references {
363 # 5dc01c595e6c6ec9ccda4f6f69c131c0dd945f8c refs/tags/v2.6.11
364 # c39ae07f393806ccf406ef966e9a15afc43cc36a refs/tags/v2.6.11^{}
365 my @reflist = $self->run_cmd_list(qw(show-ref --dereference))
369 push @{$refs{$1}}, $2
370 if m!^($SHA1RE)\srefs/(.*)$!;
377 method _is_valid_rev (Str $rev) {
378 return ($rev =~ /^($SHA1RE)$/);
381 method _parse_rev_list ($output) {
383 map $self->get_gpp_object($_),
384 grep $self->_is_valid_rev($_),
385 map split(/\n/, $_, 6), split /\0/, $output;
390 L<Gitalist::Git::Util> L<Gitalist::Git::Object>
392 =head1 AUTHORS AND COPYRIGHT
394 Catalyst application:
395 (C) 2009 Venda Ltd and Dan Brook <dbrook@venda.com>
397 Original gitweb.cgi from which this was derived:
398 (C) 2005-2006, Kay Sievers <kay.sievers@vrfy.org>
399 (C) 2005, Christian Gierke
403 FIXME - Is this going to be GPLv2 as per gitweb? If so this is broken..
405 This library is free software. You can redistribute it and/or modify
406 it under the same terms as Perl itself.