/ 
Module-Starter-Smart-v0.0.2
River stage one • 1 direct dependent • 2 total dependents
/ Module::Starter::Smart

NAME

Module::Starter::Smart - Add new modules into an existing distribution with this plugin

VERSION

version 0.0.2

SYNOPSIS

use Module::Starter qw/Module::Starter::Simple Module::Starter::Smart/;
Module::Starter->create_distro(%args);

# or in ~/.module-starter/config
plugin: Module::Starter::Simple Module::Starter::Smart

# create a new distribution named 'Foo-Bar'
$ module-starter --module=Foo::Bar

# 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 overrides the create_distro, create_modules, and create_t subroutines defined in whichever engine plugin in use (say, Module::Starter::Simple.) When invoked with a existing distribution, the plugin may bypass the create_basedir subroutine, pull in a list of existing modules as well as test files, create new modules, and recreate the manifest file accordingly.

Adding a new module to an existing distribution

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.

Placing an existing module into a new distribution

Let Foo::Baz be your existing module, and Globbo be the new distribution you will be creating.

Put Foo/Baz.pm in a lib directory if it's not already.

% mkdir lib
% cp -R /some/other/location/Foo ./lib
% ls -R ./lib
Foo/
./lib/Foo:
Baz.pm

Make sure you're in the parent directory that contains the lib directory. Then make your new distro, but give module-starter the name of your existing module, too:

% module-starter --distro=Globbo --module=Foo::Baz
Created starter directories and files

% ls -R Globbo
Build.PL  Changes   MANIFEST  README    lib/      t/

Globbo/lib:
Foo/

Globbo/lib/Foo:
Baz.pm

Globbo/t:
00.load.t       perlcritic.t    pod-coverage.t  pod.t

Foo/Baz.pm has been added to Globbo's lib directory.

Adding an existing module to an existing distribution

Say you have an existing distro, Foo::Bar, and you want to add to it an existing module, Foo::Baz:

% module-starter --module Foo::Baz --distro=Foo-Bar
Created starter directories and files

% ls -R Foo-Bar
Build.PL  Changes   MANIFEST  README    lib/      t/

Foo-Bar/lib:
Foo/

Foo-Bar/lib/Foo:
Bar.pm  Baz.pm

Foo-Bar/t:
00.load.t       perlcritic.t    pod-coverage.t  pod.t

Foo/Baz.pm has been placed in lib/Foo.

INTERFACE

No public methods. The module works by subclassing Module::Starter::Simple and rewiring its internal behaviors.

DEPENDENCIES

Module::Starter::Smart relies on Module::Starter::Simple to properly function. Be sure to load Module::Starter::Simple or any of its subclasses before Module::Starter::Smart when importing Module::Starter.

INCOMPATIBILITIES

The plugin works perfectly with other template plugins, i.e. Module::Starter::PBP (I started this module with its built-in templates. Hail Damian Conway!)

BUGS AND LIMITATIONS

No bugs have been reported.

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 wrote the entire section of use-cases.

AUTHOR

Ruey-Cheng Chen <rueycheng@gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2006, 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.