Add my name to spelling whitelist

[gitmo/MooseX-FollowPBP.git] / lib / MooseX / FollowPBP.pm

package MooseX::FollowPBP;

use strict;
use warnings;

use Moose 0.94 ();
use Moose::Exporter;
use Moose::Util::MetaRole;
use MooseX::FollowPBP::Role::Attribute;

my %metaroles = (
    class_metaroles => {
        attribute => ['MooseX::FollowPBP::Role::Attribute'],
    },
);

$metaroles{role_metaroles} = {
    applied_attribute => ['MooseX::FollowPBP::Role::Attribute'],
} if $Moose::VERSION >= 1.9900;

Moose::Exporter->setup_import_methods(%metaroles);

1;

# ABSTRACT: Name your accessors get_foo() and set_foo()

__END__

=pod

=head1 SYNOPSIS

    use Moose;
    use MooseX::FollowPBP;

    # make some attributes

=head1 DESCRIPTION

This module does not provide any methods. Simply loading it changes
the default naming policy for the loading class so that accessors are
separated into get and set methods. The get methods are prefixed with
"get_" as the accessor, while set methods are prefixed with
"set_". This is the naming style recommended by Damian Conway in
I<Perl Best Practices>.

If you define an attribute with a leading underscore, then both the
get and set method will also have an underscore prefix.

If you explicitly set a "reader" or "writer" name when creating an
attribute, then that attribute's naming scheme is left unchanged.

=head1 ACCESSORS IN ROLES

Prior to version 1.9900 of L<Moose>, attributes added to a class ended up with
that class's attribute traits. That means that if your class used
C<MooseX::FollowPBP>, any attributes provided by roles you consumed had the
semi-affordance style of accessor.

As of Moose 1.9900, that is no longer the case. Attributes provided by roles
no longer acquire the consuming class's attribute traits. However, with Moose
1.9900+, you can now use C<MooseX::FollowPBP> directly in roles. Attributes
defined by that role will have semi-affordance style accessors, regardless of
what attribute traits the consuming class has.

=head1 BUGS

Please report any bugs or feature requests to
C<bug-moosex-followpbp@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.

=cut