package Git::Repository::Plugin;
$Git::Repository::Plugin::VERSION = '1.314';
use strict;
use warnings;
use 5.006;
use Carp;
sub install {
my ( $class, @keywords ) = @_;
no strict 'refs';
# get the list of keywords to install
my %keyword = map { $_ => 1 } my @all_keywords = $class->_keywords;
@keywords = @all_keywords if !@keywords;
@keywords = grep {
!( !exists $keyword{$_} and carp "Unknown keyword '$_' in $class" )
} @keywords;
carp "No keywords installed from $class" if !@keywords;
# install keywords
*{"Git::Repository::$_"} = \&{"$class\::$_"} for @keywords;
}
sub _keywords {
my ($class) = @_;
no strict 'refs';
carp "Use of \@KEYWORDS by $class is deprecated";
return @{"$class\::KEYWORDS"};
}
1;
# ABSTRACT: Base class for Git::Repository plugins
__END__
=pod
=head1 NAME
Git::Repository::Plugin - Base class for Git::Repository plugins
=head1 VERSION
version 1.314
=head1 SYNOPSIS
package Git::Repository::Plugin::Hello;
use Git::Repository::Plugin;
our @ISA = qw( Git::Repository::Plugin );
sub _keywords { return qw( hello hello_gitdir ) }
sub hello { return "Hello, git world!\n"; }
sub hello_gitdir { return "Hello, " . $_[0]->git_dir . "!\n"; }
1;
=head1 DESCRIPTION
L<Git::Repository::Plugin> allows one to define new methods for
L<Git::Repository>, that will be imported in the L<Git::Repository>
namespace.
The L<SYNOPSIS> provides a full example.
The documentation of L<Git::Repository> describes how to load plugins
with all the methods they provide, or only a selection of them.
=head1 METHODS
L<Git::Repository::Plugin> provides a single method:
=head2 install
$plugin->install( @keywords );
Install all keywords provided in the L<Git::Repository> namespace.
If called with an empty list, will install all available keywords.
=head1 SUBCLASSING
=head2 Adding methods to L<Git::Repository>
When creating a plugin, the new keywords (i.e. methods) that are added
by the plugin to L<Git::Repository> must be returned by a C<_keywords()>
method.
=head2 Adding attributes to L<Git::Repository>
L<Git::Repository> is a blessed hash reference.
If extra attributes are needed, the recommended name for the hash key (to
avoid name clashes between plugins) is C<_plugin_I<name>_I<attribute>>,
where I<name> is the plugin lowercase name, and I<attribute> is the
attribute name.
=head1 ACKNOWLEDGEMENTS
Thanks to Todd Rinaldo, who wanted to add more methods to
L<Git::Repository>, which made me look for a solution that would preserve
the minimalism of L<Git::Repository>.
After a not-so-good design using @ISA (so L<Git::Repository> would
I<inherit> the extra methods), further discussions with Aristotle
Pagaltzis and a quick peek at L<Dancer>'s plugin management helped me
come up with the current design. Thank you Aristotle and the L<Dancer>
team.
Further improvements to the plugin system proposed by Aristotle Pagaltzis.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Git-Repository or by email to
bug-git-repository@rt.cpan.org.
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
Philippe Bruhat (BooK) <book@cpan.org>
=head1 COPYRIGHT
Copyright 2010-2014 Philippe Bruhat (BooK), all rights reserved.
=head1 LICENSE
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
=cut