module::starter::plugin::template(3pm) [debian man page]
Module::Starter::Plugin::Template(3pm) User Contributed Perl Documentation Module::Starter::Plugin::Template(3pm)NAME
Module::Starter::Plugin::Template - module starter with templates
VERSION
Version 1.58
SYNOPSIS
use Module::Starter qw(
Module::Starter::Simple
Module::Starter::Plugin::Template
);
Module::Starter->create_distro(%args);
DESCRIPTION
This plugin is designed to be added to a Module::Starter::Simple-compatible Module::Starter class. It adds stub methods for template
retrieval and rendering, and it replaces all of Simple's _guts methods with methods that will retrieve and render the apropriate templates.
CLASS METHODS
"new(%args)"
This plugin calls the "new" supermethod and then initializes the template store and renderer. (See "templates" and "renderer" below.)
OBJECT METHODS
"templates()"
This method is used to initialize the template store on the Module::Starter object. It returns a hash of templates; each key is a filename
and each value is the body of the template. The filename Module.pm is used for the module template.
"renderer()"
This method is used to initialize the template renderer. Its result is stored in the object's "renderer" entry. The implementation will
determine its use.
"render($template, \%options)"
The "render" method will render the template passed to it, using the data in the Module::Starter object and in the hash of passed
parameters.
_guts methods
All of the "FILE_guts" methods from Module::Starter::Simple are subclassed to look something like this:
sub file_guts {
my $self = shift;
my %options;
@options{qw(first second third)} = @_;
my $template = $self->{templates}{filename};
$self->render($template, \%options);
}
These methods will need to be rewritten when (as is likely) Module::Starter::Simple's _guts methods are refactored into a registry.
module_guts
Makefile_PL_guts
MI_Makefile_PL_guts
Build_PL_guts
Changes_guts
README_guts
t_guts
MANIFEST_guts
item ignores_guts
AUTHOR
Ricardo SIGNES, "<rjbs at cpan.org>"
Bugs
Please report any bugs or feature requests to "bug-module-starter at rt.cpan.org", or through the web interface at <http://rt.cpan.org>. I
will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
COPYRIGHT
Copyright 2005-2007 Ricardo SIGNES, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
perl v5.12.4 2011-07-02 Module::Starter::Plugin::Template(3pm)
Check Out this Related Man Page
Module::Starter::Smart(3pm) User Contributed Perl Documentation Module::Starter::Smart(3pm)NAME
Module::Starter::Smart - A Module::Starter plugin for adding new modules into an existing distribution
VERSION
version 0.0.4
SYNOPSIS
use Module::Starter qw/Module::Starter::Smart/;
Module::Starter->create_distro(%args);
# or in ~/.module-starter/config
plugin: Module::Starter::Smart
# create a new distribution named 'Foo-Bar'
$ module-starter --module=Foo::Bar
# ... then add a new module
$ module-starter --module=Foo::Bar::Me --distro=Foo-Bar
DESCRIPTION
Module::Starter::Smart is a simple helper plugin for Module::Starter. It subclasses Module::Starter::Simple and provides its own
implementatoin for several file creation subroutines, such as "create_distro", "create_modules", "create_t", and so on. These new
implementations were designed to work with existing distributions.
When invoked, the plugin checks if the distribution is already created. If so, the plugin would bypass "create_basedir") and go ahead pull
in all the existing modules and test files; these information would be used later in the corresponding file creation subroutines for
skipping already-created files.
UPDATE: This plugin only covers the simplest use cases. For advanced usage, check out Module::Starter::AddModule.
Example
Say you have an existing distro, Goof-Ball, and you want to add a new module, Goof::Troop.
% ls -R Goof-Ball
Build.PL Changes MANIFEST README lib/ t/
Goof-Ball/lib:
Goof/
Goof-Ball/lib/Goof:
Ball.pm
Goof-Ball/t:
00.load.t perlcritic.t pod-coverage.t pod.t
Go to the directory containing your existing distribution and run module-starter, giving it the names of the existing distribution and the
new module:
% module-starter --distro=Goof-Ball --module=Goof::Troop
Created starter directories and files
% ls -R Goof-Ball
Build.PL Changes MANIFEST README lib/ t/
Goof-Ball/lib:
Goof/
Goof-Ball/lib/Goof:
Ball.pm Troop.pm
Goof-Ball/t:
00.load.t perlcritic.t pod-coverage.t pod.t
Troop.pm has been added to Goof-Ball/lib/Goof.
INTERFACE
No public methods. The module works by subclassing Module::Starter::Simple and rewiring its internal behaviors.
DEPENDENCIES
Module::Starter::Smart subclasses Module::Starter::Simple.
INCOMPATIBILITIES
The plugin works perfectly with other template plugins, i.e. Module::Starter::PBP (I started using it to develop this module)
BUGS AND LIMITATIONS
Please report any bugs or feature requests to "bug-module-starter-smart@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.
ACKNOWLEDGEMENT
Special thanks to David Messina, who kindly contributes the example.
AUTHOR
Ruey-Cheng Chen "<rueycheng@gmail.com>"
LICENCE AND COPYRIGHT
Copyright (c) 2006, 2012 Ruey-Cheng Chen "<rueycheng@gmail.com>". All rights reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
perl v5.14.2 2012-03-29 Module::Starter::Smart(3pm)