use 5.006;
use strict;
use warnings;
package Git::Wrapper;
{
$Git::Wrapper::VERSION = '0.017';
}
#ABSTRACT: Wrap git(7) command-line interface
our $DEBUG=0;
use File::pushd;
use File::Temp;
use IPC::Cmd qw(can_run);
use IPC::Open3 qw();
use Sort::Versions;
use Symbol;
my $GIT = ( defined $ENV{GIT_WRAPPER_GIT} ) ? $ENV{GIT_WRAPPER_GIT} : 'git';
sub new {
my ($class, $arg, %opt) = @_;
my $self = bless { dir => $arg, %opt } => $class;
die "usage: $class->new(\$dir)" unless $self->dir;
return $self;
}
sub has_git_in_path { can_run('git') }
sub dir { shift->{dir} }
sub _opt {
my $name = shift;
$name =~ tr/_/-/;
return length($name) == 1
? "-$name"
: "--$name"
;
}
sub _cmd {
my $self = shift;
my $cmd = shift;
my $opt = ref $_[0] eq 'HASH' ? shift : {};
my @cmd = $GIT;
for (grep { /^-/ } keys %$opt) {
(my $name = $_) =~ s/^-//;
my $val = delete $opt->{$_};
next if $val eq '0';
push @cmd, _opt($name) . ($val eq '1' ? "" : "=$val");
}
push @cmd, $cmd;
for my $name (keys %$opt) {
my $val = delete $opt->{$name};
next if $val eq '0';
( $name, $val ) = $self->_message_tempfile( $val )
if $self->_win32_multiline_commit_msg( $cmd, $name, $val );
push @cmd, _opt($name) . ($val eq '1' ? "" : "=$val");
}
push @cmd, @_;
#print "running [@cmd]\n";
my( @out , @err );
{
my $d = pushd $self->dir unless $cmd eq 'clone';
my ($wtr, $rdr, $err);
$err = Symbol::gensym;
print STDERR join(' ',@cmd),"\n" if $DEBUG;
my $pid = IPC::Open3::open3($wtr, $rdr, $err, @cmd);
close $wtr;
chomp(@out = <$rdr>);
chomp(@err = <$err>);
waitpid $pid, 0;
};
#print "status: $?\n";
if ($?) {
die Git::Wrapper::Exception->new(
output => \@out,
error => \@err,
status => $? >> 8,
);
}
chomp(@out);
return @out;
}
sub _win32_multiline_commit_msg {
my ( $self, $cmd, $name, $val ) = @_;
return 0 if $^O ne "MSWin32";
return 0 if $cmd ne "commit";
return 0 if $name ne "m" and $name ne "message";
return 0 if $val !~ /\n/;
return 1;
}
sub _message_tempfile {
my ( $self, $message ) = @_;
my $tmp = File::Temp->new( UNLINK => 0 );
$tmp->print( $message );
return ( "file", '"'.$tmp->filename.'"' );
}
sub AUTOLOAD {
my $self = shift;
(my $meth = our $AUTOLOAD) =~ s/.+:://;
return if $meth eq 'DESTROY';
$meth =~ tr/_/-/;
return $self->_cmd($meth, @_);
}
sub version {
my $self = shift;
my ($version) = $self->_cmd('version');
$version =~ s/^git version //;
return $version;
}
sub log {
my $self = shift;
my $opt = ref $_[0] eq 'HASH' ? shift : {};
$opt->{no_color} = 1;
$opt->{pretty} = 'medium';
my @out = $self->_cmd(log => $opt, @_);
my @logs;
while (my $line = shift @out) {
die "unhandled: $line" unless $line =~ /^commit (\S+)/;
my $current = Git::Wrapper::Log->new($1);
$line = shift @out; # next line;
while ($line =~ /^(\S+):\s+(.+)$/) {
$current->attr->{lc $1} = $2;
$line = shift @out; # next line;
}
die "no blank line separating head from message" if $line;
my ( $initial_indent ) = $out[0] =~ /^(\s*)/ if @out;
my $message = '';
while (
@out
and $out[0] !~ /^commit (\S+)/
and length($line = shift @out)
) {
$line =~ s/^$initial_indent//; # strip just the indenting added by git
$message .= "$line\n";
}
$current->message($message);
push @logs, $current;
}
return @logs;
}
sub supports_log_raw_dates {
my $self = shift;
# The '--date=raw' option to 'git log' was added in version 1.6.2
return 0 if ( versioncmp( $self->version , '1.6.2' ) eq -1 );
return 1;
}
sub supports_status_porcelain {
my $self = shift;
# The '--porcelain' option to git status was added in version 1.7.0
return 0 if ( versioncmp( $self->version , '1.7' ) eq -1 );
return 1;
}
my %STATUS_CONFLICTS = map { $_ => 1 } qw
;
sub status {
my $self = shift;
return $self->_cmd('status' , @_ )
unless $self->supports_status_porcelain;
my $opt = ref $_[0] eq 'HASH' ? shift : {};
$opt->{$_} = 1 for qw;
my @out = $self->_cmd(status => $opt, @_);
my $statuses = Git::Wrapper::Statuses->new;
return $statuses if !@out;
for (@out) {
my ($x, $y, $from, $to) = $_ =~ /\A(.)(.) (.*?)(?: -> (.*))?\z/;
if ($STATUS_CONFLICTS{"$x$y"}) {
$statuses->add('conflict', "$x$y", $from, $to);
}
elsif ($x eq '?' && $y eq '?') {
$statuses->add('unknown', '?', $from, $to);
}
else {
$statuses->add('changed', $y, $from, $to)
if $y ne ' ';
$statuses->add('indexed', $x, $from, $to)
if $x ne ' ';
}
}
return $statuses;
}
package Git::Wrapper::Exception;
{
$Git::Wrapper::Exception::VERSION = '0.017';
}
sub new { my $class = shift; bless { @_ } => $class }
use overload (
q("") => 'error',
fallback => 1,
);
sub output { join "", map { "$_\n" } @{ shift->{output} } }
sub error { join "", map { "$_\n" } @{ shift->{error} } }
sub status { shift->{status} }
package Git::Wrapper::Log;
{
$Git::Wrapper::Log::VERSION = '0.017';
}
sub new {
my ($class, $id, %arg) = @_;
return bless {
id => $id,
attr => {},
%arg,
} => $class;
}
sub id { shift->{id} }
sub attr { shift->{attr} }
sub message { @_ > 1 ? ($_[0]->{message} = $_[1]) : $_[0]->{message} }
sub date { shift->attr->{date} }
sub author { shift->attr->{author} }
1;
package Git::Wrapper::Statuses;
{
$Git::Wrapper::Statuses::VERSION = '0.017';
}
sub new { return bless {} => shift }
sub add {
my ($self, $type, $mode, $from, $to) = @_;
my $status = Git::Wrapper::Status->new($mode, $from, $to);
push @{ $self->{ $type } }, $status;
}
sub get {
my ($self, $type) = @_;
return @{ defined $self->{$type} ? $self->{$type} : [] };
}
sub is_dirty {
my( $self ) = @_;
return keys %$self ? 1 : 0;
}
1;
package Git::Wrapper::Status;
{
$Git::Wrapper::Status::VERSION = '0.017';
}
my %modes = (
M => 'modified',
A => 'added',
D => 'deleted',
R => 'renamed',
C => 'copied',
U => 'conflict',
'?' => 'unknown',
DD => 'both deleted',
AA => 'both added',
UU => 'both modified',
AU => 'added by us',
DU => 'deleted by us',
UA => 'added by them',
UD => 'deleted by them',
);
sub new {
my ($class, $mode, $from, $to) = @_;
return bless {
mode => $mode,
from => $from,
to => $to,
} => $class;
}
sub mode { $modes{ shift->{mode} } }
sub from { shift->{from} }
sub to { defined( $_[0]->{to} ) ? $_[0]->{to} : '' }
=pod
=head1 NAME
Git::Wrapper - Wrap git(7) command-line interface
=head1 VERSION
version 0.017
=head1 SYNOPSIS
my $git = Git::Wrapper->new('/var/foo');
$git->commit(...)
print $_->message for $git->log;
=head1 DESCRIPTION
Git::Wrapper provides an API for git(7) that uses Perl data structures for
argument passing, instead of CLI-style C<--options> as L does.
=head1 METHODS
Except as documented, every git subcommand is available as a method on a
Git::Wrapper object. Replace any hyphens in the git command with underscores.
The first argument should be a hashref containing options and their values.
Boolean options are either true (included) or false (excluded). The remaining
arguments are passed as ordinary command arguments.
$git->commit({ all => 1, message => "stuff" });
$git->checkout("mybranch");
Output is available as an array of lines, each chomped.
@sha1s_and_titles = $git->rev_list({ all => 1, pretty => 'oneline' });
If a git command exits nonzero, a C object will be
thrown. It has three useful methods:
=over
=item * error
error message
=item * output
normal output, as a single string
=item * status
the exit status
=back
The exception stringifies to the error message.
=head2 new
my $git = Git::Wrapper->new($dir);
=head2 dir
print $git->dir; # /var/foo
=head2 version
my $version = $git->version; # 1.6.1.4.8.15.16.23.42
=head2 log
my @logs = $git->log;
Instead of giving back an arrayref of lines, the C method returns a list
of C objects. They have four methods:
=over
=item * id
=item * author
=item * date
=item * message
=back
=head2 has_git_in_path
This method returns a true or false value indicating if there is a 'git'
binary in the current $PATH.
=head2 supports_status_porcelain
=head2 supports_log_raw_dates
These methods return a true or false value (1 or 0) indicating whether the git
binary being used has support for these options. (The '--porcelain' option on
'git status' and the '--date=raw' option on 'git log', respectively.)
These are primarily for use in this distribution's test suite, but may also be
useful when writing code using Git::Wrapper that might be run with different
versions of the underlying git binary.
=head2 status
When running with an underlying git binary that returns false for the
L method, this method will act like any other
wrapped command: it will return output as an array of chomped lines.
When running with an underlying git binary that returns true for the
L method, this method instead returns an
instance of Git::Wrapper::Statuses:
my $statuses = $git->status;
Git::Wrapper:Statuses has two public methods. First, C:
my $dirty_flag = $statuses->is_dirty;
which returns a true/false value depending on whether the repository has any
uncommitted changes.
Second, C:
my @status = $statuses->get($group)
which returns an array of Git::Wrapper::Status objects, one per file changed.
There are four status groups, each of which may contain zero or more changes.
=over
=item * indexed : Changed & added to the index (aka, will be committed)
=item * changed : Changed but not in the index (aka, won't be committed)
=item * unknown : Untracked files
=item * conflict : Merge conflicts
=back
Note that a single file can occur in more than one group. Eg, a modified file
that has been added to the index will appear in the 'indexed' list. If it is
subsequently further modified it will additionally appear in the 'changed'
group.
A Git::Wrapper::Status object has three methods you can call:
my $from = $status->from;
The file path of the changed file, relative to the repo root. For renames,
this is the original path.
my $to = $status->to;
Renames returns the new path/name for the path. In all other cases returns
an empty string.
my $mode = $status->mode;
Indicates what has changed about the file.
Within each group (except 'conflict') a file can be in one of a number of
modes, although some modes only occur in some groups (eg, 'added' never appears
in the 'unknown' group).
=over
=item * modified
=item * added
=item * deleted
=item * renamed
=item * copied
=item * conflict
=back
All files in the 'unknown' group will have a mode of 'unknown' (which is
redundant but at least consistent).
The 'conflict' group instead has the following modes.
=over
=item * 'both deleted' : deleted on both branches
=item * 'both added' : added on both branches
=item * 'both modified' : modified on both branches
=item * 'added by us' : added only on our branch
=item * 'deleted by us' : deleted only on our branch
=item * 'added by them' : added on the branch we are merging in
=item * 'deleted by them' : deleted on the branch we are merging in
=back
See git-status man page for more details.
=head3 Example
my $git = Git::Wrapper->new('/path/to/git/repo');
my $statuses = $git->status;
for my $type (qw) {
my @states = $statuses->get($type)
or next;
print "Files in state $type\n";
for (@states) {
print ' ', $_->mode, ' ', $_->from;
print ' renamed to ', $_->to
if $_->mode eq 'renamed';
print "\n";
}
}
=head1 COMPATIBILITY
On Win32 Git::Wrapper is incompatible with msysGit installations earlier than
Git-1.7.1-preview20100612 due to a bug involving the return value of a git
command in cmd/git.cmd. If you use the msysGit version distributed with
GitExtensions or an earlier version of msysGit, tests will fail during
installation of this module. You can get the latest version of msysGit on the
Google Code project page: L
=head1 ENVIRONMENT VARIABLES
Git::Wrapper normally uses the first 'git' binary in your path, but if the
GIT_WRAPPER_GIT environment variable is set, that value will be used instead.
=head1 SEE ALSO
L is the git implementation for L, a generic interface to
version-controle systems.
Git itself is at L.
=head1 BUGS
Please report any bugs or feature requests to
C, or through the web interface at
L. I will be notified, and then you'll automatically be
notified of progress on your bug as I make changes.
=head1 AUTHORS
=over 4
=item *
Hans Dieter Pearcey
=item *
Chris Prather
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2008 by Hans Dieter Pearcey.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__