/ 
MooseX-OneArgNew-0.006
River stage three • 3 direct dependents • 845 total dependents
/ MooseX::OneArgNew

NAME

MooseX::OneArgNew - teach ->new to accept single, non-hashref arguments

VERSION

version 0.006

SYNOPSIS

In our class definition:

package Delivery;
use Moose;
with('MooseX::OneArgNew' => {
  type     => 'Existing::Message::Type',
  init_arg => 'message',
});

has message => (isa => 'Existing::Message::Type', required => 1);

has to => (
  is   => 'ro',
  isa  => 'Str',
  lazy => 1,
  default => sub {
    my ($self) = @_;
    $self->message->get('To');
  },
);

When making a message:

# The traditional way:

my $delivery = Delivery->new({ message => $message });
# or
my $delivery = Delivery->new({ message => $message, to => $to });

# With one-arg new:

my $delivery = Delivery->new($message);

DESCRIPTION

MooseX::OneArgNew lets your constructor take a single argument, which will be translated into the value for a one-entry hashref. It is a parameterized role with three parameters:

type

The Moose type that the single argument must be for the one-arg form to work. This should be an existing type, and may be either a string type or a MooseX::Type.

init_arg

This is the string that will be used as the key for the hashref constructed from the one-arg call to new.

coerce

If true, a single argument to new will be coerced into the expected type if possible. Keep in mind that if there are no coercions for the type, this will be an error, and that if a coercion from HashRef exists, you might be getting yourself into a weird situation.

WARNINGS

You can apply MooseX::OneArgNew more than once, but if more than one application's type matches a single argument to new, the behavior is undefined and likely to cause bugs.

It would be a very bad idea to supply a type that could accept a normal hashref of arguments to new.

PERL VERSION

This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

AUTHOR

Ricardo Signes <rjbs@semiotic.systems>

CONTRIBUTORS

  • George Hartzell <hartzell@alerce.com>

  • William Orr <will@worrbase.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 by Ricardo Signes.

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