/ 
MooseX-Extended-0.10
River stage one • 1 direct dependent • 1 total dependent
/ MooseX::Extended::Role

NAME

MooseX::Extended::Role - MooseX::Extended roles

VERSION

version 0.10

SYNOPSIS

package Not::Corinna::Role::Created {
    use MooseX::Extended::Role types => ['PositiveInt'];

    field created => ( isa => PositiveInt, default => sub { time } );
}

Similar to MooseX::Extended, providing almost everything that module provides. However, for obvious reasons, it does not include MooseX::StrictConstructor or make your class immutable, or set the C3 mro.

Note that there is no need to add a 1 at the end of the role.

CONFIGURATION

You may pass an import list to MooseX::Extended::Role.

use MooseX::Extended::Role
  excludes => [qw/WarnOnConflict carp/],         # I don't want these features
  types    => [qw/compile PositiveInt HashRef/]; # I want these type tools

types

Allows you to import any types provided by MooseX::Extended::Types.

This:

use MooseX::Extended::Role types => [qw/compile PositiveInt HashRef/];

Is identical to this:

use MooseX::Extended::Role;
use MooseX::Extended::Types qw( compile PositiveInt HashRef );

excludes

You may find some features to be annoying, or even cause potential bugs (e.g., if you have a `croak` method, our importing of Carp::croak will be a problem. You can exclude the following:

  • WarnOnConflict

    use MooseX::Extended::Role excludes => ['WarnOnConflict'];

    Excluding this removes the MooseX::Role::WarnOnConflict role.

  • autoclean

    use MooseX::Extended::Role excludes => ['autoclean'];

    Excluding this will no longer import namespace::autoclean.

  • carp

    use MooseX::Extended::Role excludes => ['carp'];

    Excluding this will no longer import Carp::croak and Carp::carp.

  • true

    use MooseX::Extended::Role excludes => ['carp'];

    Excluding this will require your module to end in a true value.

IDENTICAL METHOD NAMES IN CLASSES AND ROLES

In Moose if a class defines a method of the name as the method of a role it's consuming, the role's method is silently discarded. With MooseX::Extended::Role, you get a warning. This makes maintenance easier when to prevent you from accidentally overriding a method.

For example:

package My::Role {
    use MooseX::Extended::Role;

    sub name {'Ovid'}
}

package My::Class {
    use MooseX::Extended;
    with 'My::Role';
    sub name {'Bob'}
}

The above code will still run, but you'll get a very verbose warning:

The class My::Class has implicitly overridden the method (name) from
role My::Role. If this is intentional, please exclude the method from
composition to silence this warning (see Moose::Cookbook::Roles::Recipe2)

To silence the warning, just be explicit about your intent:

package My::Class {
    use MooseX::Extended;
    with 'My::Role' => { -excludes => ['name'] };
    sub name {'Bob'}
}

AUTHOR

Curtis "Ovid" Poe <curtis.poe@gmail.com>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2022 by Curtis "Ovid" Poe.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)