Devel::PackagePath - Inspect and Manipulate a Path based on a Package Name


Devel-PackagePath documentation Contained in the Devel-PackagePath distribution.

Index


Code Index:

NAME

Top

Devel::PackagePath - Inspect and Manipulate a Path based on a Package Name

VERSION

Top

This document describes Devel::PackagePath version 0.0.1

SYNOPSIS

Top

    use Devel::PackagePath;

    my $path = Devel::PackagePath->new( package => 'MyApp::Base::Object', base => 'lib');
    $path->create; # creates lib/MyApp/Base

DESCRIPTION

Top

Devel::PackagePath is a simple way to inspect and manipulate a path based on a package name. I went looking for a way to do this when building a class generator for another project and didn't find anything simple.

METHODS

Top

new

package PackageName

A package name to turn into a path.

base Str

A base directory, defaults to '.'.

create

Create the path on the filesystem.

path

Get the path back as a string.

CONFIGURATION AND ENVIRONMENT

Top

Devel::PackagePath requires no configuration files or environment variables.

DEPENDENCIES

Top

Squirrel, MooseX::Types::Path::Class

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

Please report any bugs or feature requests to bug-devel-generatepackagepath@rt.cpan.org, or through the web interface at http:/ / rt . cpan . org .

AUTHOR

Top

Chris Prather <perigrin@cpan.org> based on an IRC conversation with Matt Trout.

LICENCE AND COPYRIGHT

Top

DISCLAIMER OF WARRANTY

Top

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.


Devel-PackagePath documentation Contained in the Devel-PackagePath distribution.

package Devel::PackagePath;
use Moose;
our $VERSION = 0.03;
use MooseX::Types::Path::Class qw(Dir);

has package => (
    isa      => 'Str',
    is       => 'ro',
    required => 1,
);

has base => (
    isa     => 'Str',
    is      => 'ro',
    lazy    => 1,
    default => '.',
);

has directory => (
    isa        => Dir,
    is         => 'ro',
    lazy_build => 1,
    handles    => {
        create => 'mkpath',
        path   => 'stringify',
    },
);

sub _build_directory {
    my @pkg_list = split '::', $_[0]->package;
    pop @pkg_list;    # pop off the file name
    Path::Class::Dir->new( $_[0]->base, @pkg_list );
}

has file_name => (
    isa        => 'Str',
    is         => 'ro',
    lazy_build => 1,
);

sub _build_file_name {
    return ( split '::', $_[0]->package )[-1] . '.pm';
}

no Moose;
1;
__END__