-=pod
+package Moose::Cookbook::Snack::Keywords;
+
+# ABSTRACT: Restricted "keywords" in Moose
-=head1 NAME
+__END__
-Moose::Cookbook::Snack::Keywords - Restricted keywords in Moose
+=pod
=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.
+Moose exports a number of sugar functions in order to emulate Perl
+built-in keywords. These can cause clashes with other user-defined
+functions. This document provides a list of those keywords 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.
+C<S<use Moose>> adds a method called C<meta> to your class. If this
+conflicts with a method or function you are using, you can rename it,
+or prevent it from being installed entirely. To do this, pass the
+C<-meta_name> option when you C<S<use Moose>>. For instance:
+
+ # install it under a different name
+ use Moose -meta_name => 'moose_meta';
+
+ # don't install it at all
+ use Moose -meta_name => undef;
-=head2 Moose Keywords
+=head2 Moose Keywords
-If you are using L<Moose> or L<Moose::Role> its best to avoid these
+If you are using L<Moose> or L<Moose::Role> its best to avoid these
keywords:
=over 4
-=item extends
+=item extends
-=item with
+=item with
-=item has
+=item has
-=item before
+=item before
-=item after
+=item after
-=item around
+=item around
-=item super
+=item super
-=item override
+=item override
-=item inner
+=item inner
-=item augment
+=item augment
-=item make_immutable
+=item confess
-=item confess
-
-=item blessed
+=item blessed
=back
-=head2 Moose::Util::TypeConstraints Keywords
+=head2 Moose::Util::TypeConstraints Keywords
-If you are using L<Moose::Util::TypeConstraints> its best to avoid
-these keywords
+If you are using L<Moose::Util::TypeConstraints> its best to avoid
+these keywords
=over 4
-=item type
+=item type
+
+=item subtype
+
+=item class_type
-=item subtype
+=item role_type
-=item class_type
+=item maybe_type
-=item role_type
+=item duck_type
-=item as
+=item as
-=item where
+=item where
-=item message
+=item message
=item optimize_as
-=item coerce
+=item inline_as
-=item from
+=item coerce
+
+=item from
=item via
=head3 Turning off Moose
-To remove the keywords L<Moose> exports just add C<no Moose> at the bottom of
-your code, like so:
+To remove the sugar functions L<Moose> exports just add C<S<no Moose>>
+at the bottom of your code:
package Thing;
use Moose;
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.
+This will unexport the sugar functions that L<Moose> originally
+exported. The same will also work for L<Moose::Role> and
+L<Moose::Util::TypeConstraints>.
-=head3 Sub::Exporter
+=head3 Sub::Exporter features
-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.
+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" }
+ is => 'rw',
+ trigger => sub { print "NOM NOM" }
);
-
+
LOL::Cat->new->cheeseburger('KTHNXBYE');
See the L<Sub::Exporter> docs for more information.
-=head3 namespace::clean
+=head3 namespace::autoclean and namespace::clean
+
+You can also use L<namespace::autoclean> to clean up your namespace.
+This will remove all imported functions from your namespace. Note
+that if you are importing functions that are intended to be used as
+methods (this includes L<overload>, due to internal implementation
+details), it will remove these as well.
-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:
+Another option is to use L<namespace::clean> directly, but
+you must be careful not to remove C<meta> when doing so:
package Foo;
use Moose;
=item L<Sub::Exporter>
+=item L<namespace::autoclean>
+
=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
projects / gitmo/Moose.git / blobdiff