Karen Etheridge > MooseX-SlurpyConstructor-1.2 > MooseX::SlurpyConstructor

Download:
MooseX-SlurpyConstructor-1.2.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.2   Source  

NAME ^

MooseX::SlurpyConstructor - Make your object constructor collect all unknown attributes

VERSION ^

version 1.2

SYNOPSIS ^

    package My::Class;

    use Moose;
    use MooseX::SlurpyConstructor;

    has fixed => (
        is      => 'ro',
    );

    has slurpy => (
        is      => 'ro',
        slurpy  => 1,
    );

    package main;

    ASDF->new({
        fixed => 100, unknown1 => "a", unknown2 => [ 1..3 ]
    })->dump;

    # returns:
    #   $VAR1 = bless( {
    #       'slurpy' => {
    #           'unknown2' => [
    #               1,
    #               2,
    #               3
    #           ],
    #           'unknown1' => 'a'
    #       },
    #       'fixed' => 100
    #   }, 'ASDF' );

DESCRIPTION ^

Including this module within Moose-based classes, and declaring an attribute as 'slurpy' will allow capturing of all unknown constructor arguments in the given attribute.

As of Moose 1.9900, this module can also be used in a role, in which case the constructor of the consuming class will become slurpy.

OPTIONAL RESTRICTIONS ^

No additional options are added to your 'slurpy' attribute, so if you want to make it read-only, or restrict its type constraint to a HashRef of specific types, you should state that yourself. Typical usage may include any or all of the options below:

    has slurpy => (
        is => 'ro',
        isa => 'HashRef',
        init_arg => undef,
        lazy => 1,
        default => sub { {} },
        traits => ['Hash'],
        handles => {
            slurpy_values => 'elements',
        },
    );

For more information on these options, see Moose::Manual::Attributes and Moose::Meta::Attribute::Native::Trait::Hash.

SEE ALSO ^

MooseX::StrictConstructor

The opposite of this module, making constructors die on unknown arguments. If both of these are used together, StrictConstructor will always take precedence.

This module can also be used in migrating code from vanilla Moose to using MooseX::StrictConstructor. That was one of my original motivations for writing it; to allow staged migration.

BUGS ^

Please report any bugs or feature requests to bug-moosex-slurpyconstructor@rt.cpan.org, or through the web interface at http://rt.cpan.org. The module maintainers will be notified, and then you'll automatically be notified of progress on your bug as changes are made.

You can also use the normal Moose support channels - see Moose#GETTING_HELP.

HISTORY ^

This module was originally written by Mark Morgan <makk384@gmail.com>, with some bugfix patches by Christian Walde.

It was completely rewritten for Moose 2.0 by Karen Etheridge <ether@cpan.org>, drawing heavily on MooseX::StrictConstructor.

ACKNOWLEDGEMENTS ^

Thanks to the folks from moose mailing list and IRC channels for helping me find my way around some of the Moose bits I didn't know of before writing this module.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Karen Etheridge.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: