Ruey-Cheng Chen > Module-Starter-Smart-0.0.4 > Module::Starter::Smart

Download:
Module-Starter-Smart-0.0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.0.4   Source   Latest Release: Module-Starter-Smart-0.0.5

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.

syntax highlighting: