NAME

App::Kit::Obj::NS - Name space utility object

VERSION

This document describes App::Kit::Obj::NS version 0.1

SYNOPSIS

    my $ns = App::Kit::Obj::NS->new(…);
    $ns->ns()->have_mod(…)

DESCRIPTION

name space utility object

INTERFACE

new()

Returns the object.

Takes one required attribute: base. It should be an object or name space that it uses for the default “'base' related” methods.

base

Get and set the object’s base attribute

    my $base = $ns->base;
    $ns->base($obj);

have_mod()

Lazy wrapper of Module::Want’s have_mod().

is_ns()

Lazy wrapper of Module::Want’s is_ns().

normalize_ns()

Lazy wrapper of Module::Want’s normalize_ns().

ns2distname()

Lazy wrapper of Module::Want’s ns2distname().

distname2ns()

Lazy wrapper of Module::Want’s distname2ns().

sharedir()

Lazy wrapper of File::ShareDir’s sharedir() that returns false instead of throwing exception (in that case $@ will be set).

caller related

enable(FNS)

Takes one or more full name spaces to functions and enables them directly in the current package, loading the module if necessary.

    $app->ns->enable('Foo::Bar::zing')
    zing(…); # zing() is from Foo::Bar

'base' related

Eventually the 'base' to use will also be able to be given in the call to the method. For now, it must be set via the base attribute.

employ(ROLE)

Takes one or more role name spaces or objects and employs them in base via Role::Tiny}s apply_* methods (depending on what base is).

absorb(FNS)

Takes one or more full name spaces to functions and absorbs them directly into whatever base is. Taking into account that it was a function and now is a method.

    $app->ns->enable('Foo::Bar::zing')
    $base->zing(…); # zing() is from Foo::Bar

DIAGNOSTICS

'base' must be a valid namespace or object

The value you gave for base, either via new or via base(), is not a name space or an object.

CONFIGURATION AND ENVIRONMENT

Requires no configuration files or environment variables.

DEPENDENCIES

Moo for the object.

Lazy loaded as needed:

Module::Want File::ShareDir Role::Tiny

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

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

AUTHOR

Daniel Muey <http://drmuey.com/cpan_contact.pl>

LICENCE AND COPYRIGHT

Copyright (c) 2013, Daniel Muey <http://drmuey.com/cpan_contact.pl>. 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.

cpanm App::Kit

perl -MCPAN -e shell
install App::Kit