1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
|
=pod
=head1 NAME
Moose::Cookbook::Snack::Keywords - Restricted keywords in Moose
=head1 DESCRIPTION
There are several keywords exported by L<Moose> that can cause clashes
against other user-defined barewords. The following document provides
a list of those keywords in a single place for easy reference.
=head2 The 'meta' keyword
While most of the reserved keywords collisions can be avoided, however
I<meta> is the only one you B<can not> override. Do not attempt to override
I<meta>, it will break the Moose internals.
=head2 Moose Keywords
If you are using L<Moose> or L<Moose::Role> its best to avoid these
keywords:
=over 4
=item extends
=item with
=item has
=item before
=item after
=item around
=item super
=item override
=item inner
=item augment
=item make_immutable
=item confess
=item blessed
=back
=head2 Moose::Util::TypeConstraints Keywords
If you are using L<Moose::Util::TypeConstraints> its best to avoid
these keywords
=over 4
=item type
=item subtype
=item class_type
=item role_type
=item as
=item where
=item message
=item optimize_as
=item coerce
=item from
=item via
=item enum
=item find_type_constraint
=item register_type_constraint
=back
=head2 Avoiding collisions
=head3 Turning off Moose
To remove the keywords L<Moose> exports just add C<no Moose> at the bottom of
your code, like so:
package Thing;
use Moose;
# code here
no Moose;
This will un-export the keywords that L<Moose> originally exported. The same
will also work for L<Moose::Role> and L<Moose::Util::TypeConstraints>. It is
general L<Moose> policy that this feature is used.
=head3 Sub::Exporter
L<Moose>, L<Moose::Role> and L<Moose::Util::TypeConstraints> all use
L<Sub::Exporter> to handle all their exporting needs. This means that all the
features that L<Sub::Exporter> provides are also available to them.
For instance, with L<Sub::Exporter> you can rename keywords, like so:
package LOL::Cat;
use Moose 'has' => { -as => 'i_can_haz' };
i_can_haz 'cheeseburger' => (
is => 'rw',
trigger => sub { print "NOM NOM" }
);
LOL::Cat->new->cheeseburger('KTHNXBYE');
See the L<Sub::Exporter> docs for more information.
=head3 namespace::clean
You can also use L<namespace::clean> to clean up your namespace, but you must
be careful not to remove C<meta> with this. Here is an example of that usage:
package Foo;
use Moose;
use namespace::clean -except => 'meta';
# ...
=head1 SEE ALSO
=over 4
=item L<Moose>
=item L<Moose::Role>
=item L<Moose::Utils::TypeConstraints>
=item L<Sub::Exporter>
=item L<namespace::clean>
=back
=head1 AUTHOR
John Goulah C<E<lt>jgoulah@cpan.org<gt>>
Stevan Little E<lt>stevan@iinteractive.comE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2006-2008 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|