NAME

MooseX::Role::Nameable - automatic class short names

VERSION

Version 1.01

SYNOPSIS

This role provides a method to automatically generate a short name for a Moose class from the package name. This is especially useful for classes that are used in conjunction with the factory pattern. When this role is included, the name for the access function is required. In addition, a regex may be defined to modify how the value is extracted. By default, the last namespace in the package is used. The short name assumes the package is in camel-case and normalizes it following some simple rules:

        - convert to lower case
        - words are separated by underscores
        - acronyms are treated as a single word

Example usage:

        package Foo::Base;
        use Moose;
        with
                'MooseX::Role::Nameable' => {name => 'type'},
                'MooseX::Role::Nameable' => {name => 'nationality', regex => qr{::([^:]+)Child$}};
        __PACKAGE__->meta->make_immutable;

        package Foo::AmericanChild;
        use Moose;
        extends 'Foo::Base';
        __PACKAGE__->meta->make_immutable;

        package Foo::BritishChild;
        use Moose;
        extends 'Foo::Base';
        __PACKAGE__->meta->make_immutable;

        package main;

        my $child1 = Foo::AmericanChild->new;
        my $child2 = Foo::BritishChild->new;

        local $\="\n";
        print $_->type . ':' . $_->nationality for ($child1, $child2);
        # =>
        # american_child:american
        # british_child:british

AUTHOR

Aaron Cohen, <aarondcohen at gmail.com>

ACKNOWLEDGEMENTS

This module was made possible by Shutterstock (@ShutterTech). Additional open source projects from Shutterstock can be found at code.shutterstock.com.

BUGS

Please report any bugs or feature requests to bug-MooseX-Role-Nameable at rt.cpan.org, or through the web interface at https://github.com/aarondcohen/perl-moosex-role-nameable/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc MooseX::Role::Nameable

You can also look for information at:

• Official GitHub Repo

  https://github.com/aarondcohen/perl-moosex-role-nameable

• GitHub's Issue Tracker (report bugs here)

  https://github.com/aarondcohen/perl-moosex-role-nameable/issues

• CPAN Ratings

  http://cpanratings.perl.org/d/MooseX-Role-Nameable

• Official CPAN Page

  http://search.cpan.org/dist/MooseX-Role-Nameable/

LICENSE AND COPYRIGHT

Copyright 2013 Aaron Cohen.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.