lib/MooseX/StrictConstructor.pm

   1 package MooseX::StrictConstructor;
   2
   3 use strict;
   4 use warnings;
   5
   6 use Moose 0.94 ();
   7 use Moose::Exporter;
   8 use Moose::Util::MetaRole;
   9 use MooseX::StrictConstructor::Role::Object;
  10 use MooseX::StrictConstructor::Role::Meta::Class;
  11
  12 Moose::Exporter->setup_import_methods(
  13     class_metaroles => {
  14         class =>
  15             ['MooseX::StrictConstructor::Role::Meta::Class']
  16     },
  17     base_class_roles => ['MooseX::StrictConstructor::Role::Object'],
  18 );
  19
  20 1;
  21
  22 # ABSTRACT: Make your object constructors blow up on unknown attributes
  23
  24 __END__
  25
  26 =pod
  27
  28 =head1 SYNOPSIS
  29
  30     package My::Class;
  31
  32     use Moose;
  33     use MooseX::StrictConstructor;
  34
  35     has 'size' => ...;
  36
  37     # then later ...
  38
  39     # this blows up because color is not a known attribute
  40     My::Class->new( size => 5, color => 'blue' );
  41
  42 =head1 DESCRIPTION
  43
  44 Simply loading this module makes your constructors "strict". If your
  45 constructor is called with an attribute init argument that your class
  46 does not declare, then it calls "Carp::confess()". This is a great way
  47 to catch small typos.
  48
  49 =head2 Subverting Strictness
  50
  51 You may find yourself wanting to have your constructor accept a
  52 parameter which does not correspond to an attribute.
  53
  54 In that case, you'll probably also be writing a C<BUILD()> or
  55 C<BUILDARGS()> method to deal with that parameter. In a C<BUILDARGS()>
  56 method, you can simply make sure that this parameter is not included
  57 in the hash reference you return. Otherwise, in a C<BUILD()> method,
  58 you can delete it from the hash reference of parameters.
  59
  60   sub BUILD {
  61       my $self   = shift;
  62       my $params = shift;
  63
  64       if ( delete $params->{do_something} ) {
  65           ...
  66       }
  67   }
  68
  69 =head1 BUGS
  70
  71 Please report any bugs or feature requests to
  72 C<bug-moosex-strictconstructor@rt.cpan.org>, or through the web
  73 interface at L<http://rt.cpan.org>.  I will be notified, and then
  74 you'll automatically be notified of progress on your bug as I make
  75 changes.
  76
  77 =cut