Merge branch 'master' into attribute_helpers
[gitmo/Moose.git] / lib / Moose.pm
index b704397..2372d86 100644 (file)
@@ -1,12 +1,8 @@
-
 package Moose;
 
-use strict;
-use warnings;
-
 use 5.008;
 
-our $VERSION   = '0.72_01';
+our $VERSION   = '0.84';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -15,7 +11,7 @@ use Carp         'confess';
 
 use Moose::Exporter;
 
-use Class::MOP 0.78_02;
+use Class::MOP 0.88;
 
 use Moose::Meta::Class;
 use Moose::Meta::TypeConstraint;
@@ -36,15 +32,8 @@ use Moose::Meta::Role::Application::ToInstance;
 use Moose::Util::TypeConstraints;
 use Moose::Util ();
 
-sub _caller_info {
-    my $level = @_ ? ($_[0] + 1) : 2;
-    my %info;
-    @info{qw(package file line)} = caller($level);
-    return \%info;
-}
-
 sub throw_error {
-    # FIXME This 
+    # FIXME This
     shift;
     goto \&confess
 }
@@ -54,22 +43,10 @@ sub extends {
 
     Moose->throw_error("Must derive at least one class") unless @_;
 
-    my @supers = @_;
-    foreach my $super (@supers) {
-        Class::MOP::load_class($super);
-        Moose->throw_error("You cannot inherit from a Moose Role ($super)")
-            if $super->can('meta')  && 
-               blessed $super->meta &&
-               $super->meta->isa('Moose::Meta::Role')
-    }
-
-
-
     # this checks the metaclass to make sure
     # it is correct, sometimes it can get out
     # of sync when the classes are being built
-    my $meta = Moose::Meta::Class->initialize($class);
-    $meta->superclasses(@supers);
+    Moose::Meta::Class->initialize($class)->superclasses(@_);
 }
 
 sub with {
@@ -82,9 +59,9 @@ sub has {
     my $name  = shift;
 
     Moose->throw_error('Usage: has \'name\' => ( key => value, ... )')
-        if @_ == 1;
+        if @_ % 2 == 1;
 
-    my %options = ( definition_context => _caller_info(), @_ );
+    my %options = ( definition_context => Moose::Util::_caller_info(), @_ );
     my $attrs = ( ref($name) eq 'ARRAY' ) ? $name : [ ($name) ];
     Class::MOP::Class->initialize($class)->add_attribute( $_, %options ) for @$attrs;
 }
@@ -224,7 +201,7 @@ sub init_meta {
         my $method_meta = $class->meta;
 
         ( blessed($method_meta) && $method_meta->isa('Moose::Meta::Class') )
-            || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($meta)");
+            || Moose->throw_error("$class already has a &meta function, but it does not return a Moose::Meta::Class ($method_meta)");
 
         $meta = $method_meta;
     }
@@ -279,6 +256,7 @@ $_->make_immutable(
     Moose::Meta::Role
     Moose::Meta::Role::Method
     Moose::Meta::Role::Method::Required
+    Moose::Meta::Role::Method::Conflicting
 
     Moose::Meta::Role::Composite
 
@@ -374,7 +352,7 @@ or coercion.
 
 =head1 PROVIDED METHODS
 
-Moose provides a number of methods to all your classes, mostly through the 
+Moose provides a number of methods to all your classes, mostly through the
 inheritance of L<Moose::Object>. There is however, one exception.
 
 =over 4
@@ -404,7 +382,7 @@ superclasses still properly inherit from L<Moose::Object>.
 
 =item B<with (@roles)>
 
-This will apply a given set of C<@roles> to the local class. 
+This will apply a given set of C<@roles> to the local class.
 
 =item B<has $name|@$names =E<gt> %options>
 
@@ -452,9 +430,10 @@ is expected to have consumed.
 
 =item I<required =E<gt> (1|0)>
 
-This marks the attribute as being required. This means a I<defined> value must be
-supplied during class construction, and the attribute may never be set to
-C<undef> with an accessor.
+This marks the attribute as being required. This means a value must be
+supplied during class construction, I<or> the attribute must be lazy
+and have either a default or a builder. Note that c<required> does not
+say anything about the attribute's value, which can be C<undef>.
 
 =item I<weak_ref =E<gt> (1|0)>
 
@@ -476,14 +455,14 @@ This is only legal if your C<isa> option is either C<ArrayRef> or C<HashRef>.
 
 The I<trigger> option is a CODE reference which will be called after
 the value of the attribute is set. The CODE ref will be passed the
-instance itself and the updated value. You B<cannot> have a trigger on
+instance itself and the updated value. You B<can> have a trigger on
 a read-only attribute.
 
 B<NOTE:> Triggers will only fire when you B<assign> to the attribute,
 either in the constructor, or using the writer. Default and built values will
 B<not> cause the trigger to be fired.
 
-=item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | CODE>
+=item I<handles =E<gt> ARRAY | HASH | REGEXP | ROLE | DUCKTYPE | CODE>
 
 The I<handles> option provides Moose classes with automated delegation features.
 This is a pretty complex and powerful option. It accepts many different option
@@ -507,9 +486,9 @@ almost never want to do this, since it usually breaks your class. As with
 overriding locally defined methods, if you do want to do this, you should do it
 manually, not with Moose.
 
-You do not I<need> to have a reader (or accessor) for the attribute in order 
-to delegate to it. Moose will create a means of accessing the value for you, 
-however this will be several times B<less> efficient then if you had given 
+You do not I<need> to have a reader (or accessor) for the attribute in order
+to delegate to it. Moose will create a means of accessing the value for you,
+however this will be several times B<less> efficient then if you had given
 the attribute a reader (or accessor) to use.
 
 Below is the documentation for each option format:
@@ -557,6 +536,18 @@ In this example, the Tree package gets C<parent_node> and C<siblings> methods,
 which delegate to the C<node> and C<children> methods (respectively) of the Tree
 instance stored in the C<parent> slot.
 
+You may also use an array reference to curry arguments to the original method.
+
+  has 'thing' => (
+      ...
+      handles => { set_foo => [ set => [ 'foo' ] ] },
+  );
+
+  # $self->set_foo(...) calls $self->thing->set('foo', ...)
+
+The first element of the array reference is the original method name, and the
+second is an array reference of curried arguments.
+
 =item C<REGEXP>
 
 The regexp option works very similar to the ARRAY option, except that it builds
@@ -575,6 +566,14 @@ methods of the role and any required methods of the role. It should be noted
 that this does B<not> include any method modifiers or generated attribute
 methods (which is consistent with role composition).
 
+=item C<DUCKTYPE>
+
+With the duck type option, you pass a duck type object whose "interface" then
+becomes the list of methods to handle. The "interface" can be defined as; the
+list of methods passed to C<duck_type> to create a duck type object. For more
+information on C<duck_type> please check
+L<Moose::Util::TypeConstraint|Moose::Util::TypeConstraint>.
+
 =item C<CODE>
 
 This is the option to use when you really want to do something funky. You should
@@ -593,7 +592,7 @@ a HASH ref) of the methods you want mapped.
 This tells the class to use a custom attribute metaclass for this particular
 attribute. Custom attribute metaclasses are useful for extending the
 capabilities of the I<has> keyword: they are the simplest way to extend the MOP,
-but they are still a fairly advanced topic and too much to cover here, see 
+but they are still a fairly advanced topic and too much to cover here, see
 L<Moose::Cookbook::Meta::Recipe1> for more information.
 
 The default behavior here is to just load C<$metaclass_name>; however, we also
@@ -606,8 +605,8 @@ B<Moose::Meta::Attribute::Custom::$metaclass_name> as the metaclass name.
 
 =item I<traits =E<gt> [ @role_names ]>
 
-This tells Moose to take the list of C<@role_names> and apply them to the 
-attribute meta-object. This is very similar to the I<metaclass> option, but 
+This tells Moose to take the list of C<@role_names> and apply them to the
+attribute meta-object. This is very similar to the I<metaclass> option, but
 allows you to use more than one extension at a time.
 
 See L<TRAIT NAME RESOLUTION> for details on how a trait name is
@@ -661,12 +660,19 @@ to). See the L<initializer option docs in
 Class::MOP::Attribute|Class::MOP::Attribute/initializer> for more
 information.
 
+=item I<documentation> => $string
+
+An arbitrary string that can be retrieved later by calling C<<
+$attr->documentation >>.
+
+
+
 =back
 
 =item B<has +$name =E<gt> %options>
 
 This is variation on the normal attribute creator C<has> which allows you to
-clone and extend an attribute from a superclass or from a role. Here is an 
+clone and extend an attribute from a superclass or from a role. Here is an
 example of the superclass usage:
 
   package Foo;
@@ -707,12 +713,16 @@ Here is another example, but within the context of a role:
 
   has '+message' => (default => 'Hello I am My::Foo');
 
-In this case, we are basically taking the attribute which the role supplied 
-and altering it within the bounds of this feature. 
+In this case, we are basically taking the attribute which the role supplied
+and altering it within the bounds of this feature.
+
+Note that you can only extend an attribute from either a superclass or a role,
+you cannot extend an attribute in a role that composes over an attribute from
+another role.
 
-Aside from where the attributes come from (one from superclass, the other 
-from a role), this feature works exactly the same. This feature is restricted 
-somewhat, so as to try and force at least I<some> sanity into it. You are only 
+Aside from where the attributes come from (one from superclass, the other
+from a role), this feature works exactly the same. This feature is restricted
+somewhat, so as to try and force at least I<some> sanity into it. You are only
 allowed to change the following attributes:
 
 =over 4
@@ -739,12 +749,12 @@ Change if the attribute lazily initializes the slot.
 
 =item I<isa>
 
-You I<are> allowed to change the type without restriction. 
+You I<are> allowed to change the type without restriction.
 
-It is recommended that you use this freedom with caution. We used to 
-only allow for extension only if the type was a subtype of the parent's 
-type, but we felt that was too restrictive and is better left as a 
-policy decision. 
+It is recommended that you use this freedom with caution. We used to
+only allow for extension only if the type was a subtype of the parent's
+type, but we felt that was too restrictive and is better left as a
+policy decision.
 
 =item I<handles>
 
@@ -809,7 +819,7 @@ C<augment> work is best described in the L<Moose::Cookbook::Basics::Recipe6>.
 =item B<confess>
 
 This is the C<Carp::confess> function, and exported here because I use it
-all the time. 
+all the time.
 
 =item B<blessed>
 
@@ -819,10 +829,13 @@ C<ref> anywhere you need to test for an object's class name.
 
 =back
 
-=head1 METACLASS TRAITS
+=head1 METACLASS
 
-When you use Moose, you can also specify traits which will be applied
-to your metaclass:
+When you use Moose, you can specify which metaclass to use:
+
+    use Moose -metaclass => 'My::Meta::Class';
+
+You can also specify traits which will be applied to your metaclass:
 
     use Moose -traits => 'My::Trait';
 
@@ -884,6 +897,8 @@ specified by C<for_class>. This method injects a a C<meta> accessor
 into the class so you can get at this object. It also sets the class's
 superclass to C<base_class>, with L<Moose::Object> as the default.
 
+C<init_meta> returns the metaclass object for C<$class>.
+
 You can specify an alternate metaclass with the C<metaclass> option.
 
 For more detail on this topic, see L<Moose::Cookbook::Extending::Recipe2>.
@@ -948,11 +963,11 @@ unresolvable conflict.
 
 =head2 The MooseX:: namespace
 
-Generally if you're writing an extension I<for> Moose itself you'll want 
-to put your extension in the C<MooseX::> namespace. This namespace is 
-specifically for extensions that make Moose better or different in some 
-fundamental way. It is traditionally B<not> for a package that just happens 
-to use Moose. This namespace follows from the examples of the C<LWPx::> 
+Generally if you're writing an extension I<for> Moose itself you'll want
+to put your extension in the C<MooseX::> namespace. This namespace is
+specifically for extensions that make Moose better or different in some
+fundamental way. It is traditionally B<not> for a package that just happens
+to use Moose. This namespace follows from the examples of the C<LWPx::>
 and C<DBIx::> namespaces that perform the same function for C<LWP> and C<DBI>
 respectively.
 
@@ -1041,7 +1056,7 @@ See L<http://search.cpan.org/search?query=MooseX::> for extensions.
 
 =item The Art of the MetaObject Protocol
 
-I mention this in the L<Class::MOP> docs too, this book was critical in 
+I mention this in the L<Class::MOP> docs too, this book was critical in
 the development of both modules and is highly recommended.
 
 =back
@@ -1061,29 +1076,34 @@ want to understand them, I suggest you read this.
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+exception.
+
+Please report any bugs to C<bug-moose@rt.cpan.org>, or through the web
+interface at L<http://rt.cpan.org>.
 
 =head1 FEATURE REQUESTS
 
-We are very strict about what features we add to the Moose core, especially 
-the user-visible features. Instead we have made sure that the underlying 
-meta-system of Moose is as extensible as possible so that you can add your 
-own features easily. That said, occasionally there is a feature needed in the 
-meta-system to support your planned extension, in which case you should 
-either email the mailing list or join us on irc at #moose to discuss. The
-L<Moose::Manual::Contributing> has more detail about how and when you can
-contribute.
+We are very strict about what features we add to the Moose core, especially
+the user-visible features. Instead we have made sure that the underlying
+meta-system of Moose is as extensible as possible so that you can add your
+own features easily.
+
+That said, occasionally there is a feature needed in the meta-system
+to support your planned extension, in which case you should either
+email the mailing list (moose@perl.org) or join us on IRC at
+L<irc://irc.perl.org/#moose> to discuss. The
+L<Moose::Manual::Contributing> has more detail about how and when you
+can contribute.
 
 =head1 AUTHOR
 
-Moose is an open project, there are at this point dozens of people who have 
-contributed, and can contribute. If you have added anything to the Moose 
+Moose is an open project, there are at this point dozens of people who have
+contributed, and can contribute. If you have added anything to the Moose
 project you have a commit bit on this file and can add your name to the list.
 
 =head2 CABAL
 
-However there are only a few people with the rights to release a new version 
+However there are only a few people with the rights to release a new version
 of Moose. The Moose Cabal are the people to go to with questions regarding
 the wider purview of Moose, and help out maintaining not just the code
 but the community as well.
@@ -1138,6 +1158,8 @@ Sam (mugwump) Vilain
 
 Cory (gphat) Watson
 
+Dylan Hardison (doc fixes)
+
 ... and many other #moose folks
 
 =head1 COPYRIGHT AND LICENSE