git::repository::log(3pm) [debian man page]

Git::Repository::Log(3pm)				User Contributed Perl Documentation				 Git::Repository::Log(3pm)

NAME

       Git::Repository::Log - Class representing git log data

SYNOPSIS

	   # load the Log plugin
	   use Git::Repository 'Log';

	   # get the log for last commit
	   my ($log) = Git::Repository->log( '-1' );

	   # get the author's email
	   print my $email = $log->author_email;

DESCRIPTION

       "Git::Repository::Log" is a class whose instances reprensent log items from a git log stream.

CONSTRUCTOR

       This method shouldn't be used directly. "Git::Repository::Log::Iterator" should be the preferred way to create "Git::Repository::Log"
       objects.

   new( @args )
       Create a new "Git::Repository::Log" instance, using the list of key/values passed as parameters. The supported keys are (from the output of
       "git log --pretty=raw"):

       commit
	   The commit id (ignore the extra information added by --decorate).

       tree
	   The tree id.

       parent
	   The parent list, separated by spaces.

       author
	   The author information.

       committer
	   The committer information.

       message
	   The log message (including the 4-space indent normally output by git log).

       extra
	   Any extra text that might be added by extra options passed to git log.

ACCESSORS

       The following accessors methods are recognized. They all return scalars, except for "parent()", which returns a list.

   Commit information
       commit
       tree
       parent

   Author and committer information
       author
       committer
	   The original author/committer line

       author_name
       committer_name
       author_email
       committer_email

   Date information
       author_gmtime
       committer_gmtime
       author_localtime
       committer_localtime
       author_tz
       committer_tz

   Log information
       raw_message
	   The log message with the 4-space indent output by git log.

       message
	   The unindented version of the log message.

       subject
       body

   Extra information
       extra

AUTHOR

       Philippe Bruhat (BooK), "<book at cpan.org>"

COPYRIGHT

       Copyright 2010 Philippe Bruhat (BooK), all rights reserved.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-28						 Git::Repository::Log(3pm)

Test::Git(3pm)						User Contributed Perl Documentation					    Test::Git(3pm)

NAME

       Test::Git - Helper functions for test scripts using Git

SYNOPSIS

	   use Test::More;
	   use Test::Git;

	   # check there is a git binary available, or skip all
	   has_git();

	   # check there is a minimum version of git available, or skip all
	   has_git( '1.6.5' );

	   # check the git we want to test has a minimum version, or skip all
	   has_git( '1.6.5', { git => '/path/to/alternative/git' } );

	   # normal plan
	   plan tests => 2;

	   # create a new, empty repository in a temporary location
	   # and return a Git::Repository object
	   my $r = test_repository();

	   # run some tests on the repository
	   ...

DESCRIPTION

       "Test::Git" provides a number of helpful functions when running test scripts that require the creation and management of a Git repository.

EXPORTED FUNCTIONS

   has_git( $version, \%options )
       Checks if there is a git binary available, or skips all tests.

       If the optional $version argument is provided, also checks if the available git binary has a version greater or equal to $version.

       This function also accepts an option hash of the same kind as those accepted by "Git::Repository" and "Git::Repository::Command".

       This function must be called before "plan()", as it performs a skip_all if requirements are not met.

   test_repository( %options )
       Creates a new empty git repository in a temporary location, and returns a "Git::Repository" object pointing to it.

       This function takes options as a hash. Each key will influence a different part of the creation process.

       This call is the equivalent of the default call with no options:

	   test_repository(
	       temp => [ CLEANUP => 1 ],    # File::Temp::tempdir options
	       init => [],		    # git init options
	       git  => {},		    # Git::Repository options
	   );

       To create a bare repository:

	   test_repository( init => [ '--bare' ] );

       To leave the repository in its location after the end of the test:

	   test_repository( temp => [ CLEANUP => 0 ] );

AUTHOR

       Philippe Bruhat (BooK), "<book at cpan.org>"

COPYRIGHT

       Copyright 2010-2011 Philippe Bruhat (BooK), all rights reserved.

LICENSE

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2011-12-28							    Test::Git(3pm)