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