Git::Repository::Plugin(3)

NAME
Git::Repository::Plugin - Base class for Git::Repository plugins

VERSION
version 1.311

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;

DESCRIPTION
Git::Repository::Plugin allows one to define new methods for Git::Repository, that will be imported in the Git::Repository namespace.

The SYNOPSIS provides a full example.

The documentation of Git::Repository describes how to load plugins with all the methods they provide, or only a selection of them.

METHODS
Git::Repository::Plugin provides a single method:

  install
    $plugin->install( @keywords );

Install all keywords provided in the Git::Repository namespace.

If called with an empty list, will install all available keywords.

SUBCLASSING

  Adding methods to Git::Repository
When creating a plugin, the new keywords (i.e. methods) that are added by the plugin to Git::Repository must be returned by a "_keywords()" method.

  Adding attributes to Git::Repository
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 "_plugin_name_attribute", where name is the plugin lowercase name, and attribute is the attribute name.

ACKNOWLEDGEMENTS
Thanks to Todd Rinaldo, who wanted to add more methods to Git::Repository, which made me look for a solution that would preserve the minimalism of Git::Repository.

After a not-so-good design using @ISA (so Git::Repository would inherit the extra methods), further discussions with Aristotle Pagaltzis and a quick peek at Dancer's plugin management helped me come up with the current design. Thank you Aristotle and the Dancer team.

Further improvements to the plugin system proposed by Aristotle Pagaltzis.

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.

AUTHOR
Philippe Bruhat (BooK) <book@cpan.org>

COPYRIGHT
Copyright 2010-2014 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.