/ 
Git-Repository-Plugin-Blame-v1.4.0
River stage one • 3 direct dependents • 5 total dependents
/ Git::Repository::Plugin::Blame::Line

NAME

Git::Repository::Plugin::Blame::Line - Store the git blame information for a line of code.

VERSION

Version 1.4.0

SYNOPSIS

use Git::Repository::Plugin::Blame::Line;
my $line = Git::Repository::Plugin::Blame::Line->new(
	line_number       => $line_number,
	line              => $line,
	commit_attributes => \%commit_attributes,
	commit_id         => $commit_id,
);

print "The line number is " . $line->get_line_number() . "\n";
print "The line is " . $line->get_line() . "\n";
print "The commit ID is " . $line->get_commit_id() . "\n";
print "The commit attributes are: \n";
while ( my ( $name, $value ) = each( %{ $line->get_commit_attributes() } ) )
{
	print "   - $name: $value\n";
}

DESCRIPTION

This module stores the git blame information for a line of code.

METHODS

new()

Create a new Git::Repository::Plugin::Blame::Line object.

my $line = Git::Repository::Plugin::Blame::Line->new(
	line_number       => $line_number,
	line              => $line,
	commit_attributes => \%commit_attributes,
	commit_id         => $commit_id,
);

All parameters are mandatory:

  • 'line_number'

    The number of this line in the file that git blame was applied to.

  • 'line'

    The text/code of this line in the file that git blame was applied to.

  • 'commit_attributes'

    A hashref of attributes for the last commit that modified this line.

  • 'commit_id'

    The ID of the last commit that modified this line.

get_line_number()

Return the number of this line in the file that git blame was applied to.

my $line_number = $line->get_line_number();

get_line()

Return the text/code of this line in the file that git blame was applied to.

my $line = $line->get_line();

get_commit_id()

Return the SHA-1 of the last commit that modified this line.

my $commit_id = $line->get_commit_id();

get_commit_attributes()

Return the hashref of attributes for the last commit that modified this line.

my $commit_attributes = $line->get_commit_attributes();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/Git-Repository-Plugin-Blame/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Git::Repository::Plugin::Blame::Line

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2012-2017 Guillaume Aubert.

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

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.