Revamped Moose::Meta::Class docs and updated coverage & spelling lists
[gitmo/Moose.git] / lib / Moose / Meta / Class.pm
index ebe618a..d7317fe 100644 (file)
@@ -11,11 +11,11 @@ use List::Util qw( first );
 use List::MoreUtils qw( any all uniq );
 use Scalar::Util 'weaken', 'blessed';
 
-our $VERSION   = '0.57';
+our $VERSION   = '0.72';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
-use Moose::Meta::Method::Overriden;
+use Moose::Meta::Method::Overridden;
 use Moose::Meta::Method::Augmented;
 use Moose::Error::Default;
 
@@ -90,8 +90,8 @@ sub create_anon_class {
     
     # something like Super::Class|Super::Class::2=Role|Role::1
     my $cache_key = join '=' => (
-        join('|', sort @{$options{superclasses} || []}),
-        join('|', sort @{$options{roles}        || []}),
+        join('|', @{$options{superclasses} || []}),
+        join('|', sort @{$options{roles}   || []}),
     );
     
     if ($cache_ok && defined $ANON_CLASSES{$cache_key}) {
@@ -152,33 +152,31 @@ sub excludes_role {
 }
 
 sub new_object {
-    my $class = shift;
+    my $class  = shift;
     my $params = @_ == 1 ? $_[0] : {@_};
-    my $self = $class->SUPER::new_object($params);
-    foreach my $attr ($class->compute_all_applicable_attributes()) {
-        # if we have a trigger, then ...
-        if ($attr->can('has_trigger') && $attr->has_trigger) {
-            # make sure we have an init-arg ...
-            if (defined(my $init_arg = $attr->init_arg)) {
-                # now make sure an init-arg was passes ...
-                if (exists $params->{$init_arg}) {
-                    # and if get here, fire the trigger
-                    $attr->trigger->(
-                        $self, 
-                        # check if there is a coercion
-                        ($attr->should_coerce
-                            # and if so, we need to grab the 
-                            # value that is actually been stored
-                            ? $attr->get_read_method_ref->($self)
-                            # otherwise, just get the value from
-                            # the constructor params
-                            : $params->{$init_arg}), 
-                        $attr
-                    );
-                }
-            }       
-        }
+    my $self   = $class->SUPER::new_object($params);
+
+    foreach my $attr ( $class->compute_all_applicable_attributes() ) {
+
+        next unless $attr->can('has_trigger') && $attr->has_trigger;
+
+        my $init_arg = $attr->init_arg;
+
+        next unless defined $init_arg;
+
+        next unless exists $params->{$init_arg};
+
+        $attr->trigger->(
+            $self,
+            (
+                  $attr->should_coerce
+                ? $attr->get_read_method_ref->($self)
+                : $params->{$init_arg}
+            ),
+            $attr
+        );
     }
+
     return $self;
 }
 
@@ -188,7 +186,7 @@ sub construct_instance {
     my $meta_instance = $class->get_meta_instance;
     # FIXME:
     # the code below is almost certainly incorrect
-    # but this is foreign inheritence, so we might
+    # but this is foreign inheritance, so we might
     # have to kludge it in the end.
     my $instance = $params->{'__INSTANCE__'} || $meta_instance->create_instance();
     foreach my $attr ($class->compute_all_applicable_attributes()) {
@@ -197,74 +195,6 @@ sub construct_instance {
     return $instance;
 }
 
-# FIXME:
-# This is ugly
-sub get_method_map {
-    my $self = shift;
-
-    my $current = Class::MOP::check_package_cache_flag($self->name);
-
-    if (defined $self->{'_package_cache_flag'} && $self->{'_package_cache_flag'} == $current) {
-        return $self->{'methods'};
-    }
-
-    $self->{_package_cache_flag} = $current;
-
-    my $map  = $self->{'methods'};
-
-    my $class_name       = $self->name;
-    my $method_metaclass = $self->method_metaclass;
-
-    my %all_code = $self->get_all_package_symbols('CODE');
-
-    foreach my $symbol (keys %all_code) {
-        my $code = $all_code{$symbol};
-
-        next if exists  $map->{$symbol} &&
-                defined $map->{$symbol} &&
-                        $map->{$symbol}->body == $code;
-
-        my ($pkg, $name) = Class::MOP::get_code_info($code);
-
-        if ($pkg->can('meta')
-            # NOTE:
-            # we don't know what ->meta we are calling
-            # here, so we need to be careful cause it
-            # just might blow up at us, or just complain
-            # loudly (in the case of Curses.pm) so we
-            # just be a little overly cautious here.
-            # - SL
-            && eval { no warnings; blessed($pkg->meta) }
-            && $pkg->meta->isa('Moose::Meta::Role')) {
-            #my $role = $pkg->meta->name;
-            #next unless $self->does_role($role);
-        }
-        else {
-            
-            # NOTE:
-            # in 5.10 constant.pm the constants show up 
-            # as being in the right package, but in pre-5.10
-            # they show up as constant::__ANON__ so we 
-            # make an exception here to be sure that things
-            # work as expected in both.
-            # - SL
-            unless ($pkg eq 'constant' && $name eq '__ANON__') {
-                next if ($pkg  || '') ne $class_name ||
-                        (($name || '') ne '__ANON__' && ($pkg  || '') ne $class_name);
-            }
-
-        }
-
-        $map->{$symbol} = $method_metaclass->wrap(
-            $code,
-            package_name => $class_name,
-            name         => $symbol
-        );
-    }
-
-    return $map;
-}
-
 ### ---------------------------------------------
 
 sub add_attribute {
@@ -282,7 +212,7 @@ sub add_override_method_modifier {
     (!$self->has_method($name))
         || $self->throw_error("Cannot add an override method if a local method is already present");
 
-    $self->add_method($name => Moose::Meta::Method::Overriden->new(
+    $self->add_method($name => Moose::Meta::Method::Overridden->new(
         method  => $method,
         class   => $self,
         package => $_super_package, # need this for roles
@@ -308,7 +238,7 @@ sub _find_next_method_by_name_which_is_not_overridden {
     my ($self, $name) = @_;
     foreach my $method ($self->find_all_methods_by_name($name)) {
         return $method->{code}
-            if blessed($method->{code}) && !$method->{code}->isa('Moose::Meta::Method::Overriden');
+            if blessed($method->{code}) && !$method->{code}->isa('Moose::Meta::Method::Overridden');
     }
     return undef;
 }
@@ -449,7 +379,7 @@ sub _find_common_ancestor {
 
     # FIXME? This doesn't account for multiple inheritance (not sure
     # if it needs to though). For example, is somewhere in $meta1's
-    # history it inherits from both ClassA and ClassB, and $meta
+    # history it inherits from both ClassA and ClassB, and $meta2
     # inherits from ClassB & ClassA, does it matter? And what crazy
     # fool would do that anyway?
 
@@ -584,7 +514,7 @@ sub _process_inherited_attribute {
     my ($self, $attr_name, %options) = @_;
     my $inherited_attr = $self->find_attribute_by_name($attr_name);
     (defined $inherited_attr)
-        || $self->throw_error("Could not find an attribute by the name of '$attr_name' to inherit from", data => $attr_name);
+        || $self->throw_error("Could not find an attribute by the name of '$attr_name' to inherit from in ${\$self->name}", data => $attr_name);
     if ($inherited_attr->isa('Moose::Meta::Attribute')) {
         return $inherited_attr->clone_and_inherit_options(%options);
     }
@@ -706,163 +636,116 @@ Moose::Meta::Class - The Moose metaclass
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Class> with Moose specific
-extensions.
+This class is a subclass of L<Class::MOP::Class> that provides
+additional Moose-specific functionality.
 
-For the most part, the only time you will ever encounter an
-instance of this class is if you are doing some serious deep
-introspection. To really understand this class, you need to refer
-to the L<Class::MOP::Class> documentation.
+To really understand this class, you will probably need to start with
+the L<Class::MOP::Class> documentation. This class can be understood
+as a set of additional features on top of the basic feature provided
+by that parent class.
 
 =head1 METHODS
 
 =over 4
 
-=item B<initialize>
-
-=item B<create>
-
-Overrides original to accept a list of roles to apply to
-the created class.
+=item B<< Moose::Meta::Class->initialize($package_name, %options) >>
 
-   my $metaclass = Moose::Meta::Class->create( 'New::Class', roles => [...] );
+This overrides the parent's method in order to provide its own
+defaults for the C<attribute_metaclass>, C<instance_metaclass>, and
+C<method_metaclass> options.
 
-=item B<create_anon_class>
+These all default to the appropriate Moose class.
 
-Overrides original to support roles and caching.
+=item B<< Moose::Meta::Class->create($package_name, %options) >>
 
-   my $metaclass = Moose::Meta::Class->create_anon_class(
-       superclasses => ['Foo'],
-       roles        => [qw/Some Roles Go Here/],
-       cache        => 1,
-   );
+This overrides the parent's method in order to accept a C<roles>
+option. This should be an array reference containing one more roles
+that the class does.
 
-=item B<make_immutable>
+  my $metaclass = Moose::Meta::Class->create( 'New::Class', roles => [...] );
 
-Override original to add default options for inlining destructor
-and altering the Constructor metaclass.
+=item B<< Moose::Meta::Class->create_anon_class >>
 
-=item B<create_immutable_transformer>
+This overrides the parent's method to accept a C<roles> option, just
+as C<create> does.
 
-Override original to lock C<add_role> and memoize C<calculate_all_roles>
+It also accepts a C<cache> option. If this is true, then the anonymous
+class will be cached based on its superclasses and roles. If an
+existing anonymous class in the cache has the same superclasses and
+roles, it will be reused.
 
-=item B<new_object>
+  my $metaclass = Moose::Meta::Class->create_anon_class(
+      superclasses => ['Foo'],
+      roles        => [qw/Some Roles Go Here/],
+      cache        => 1,
+  );
 
-We override this method to support the C<trigger> attribute option.
+=item B<< $metaclass->make_immutable(%options) >>
 
-=item B<construct_instance>
+This overrides the parent's method to add a few options. Specifically,
+it uses the Moose-specific constructor and destructor classes, and
+enables inlining the destructor.
 
-This provides some Moose specific extensions to this method, you
-almost never call this method directly unless you really know what
-you are doing.
+Also, since Moose always inlines attributes, it sets the
+C<inline_accessors> option to false.
 
-This method makes sure to handle the moose weak-ref, type-constraint
-and type coercion features.
+=item B<< $metaclass->new_object(%params) >>
 
-=item B<get_method_map>
+This overrides the parent's method in order to add support for
+attribute triggers.
 
-This accommodates Moose::Meta::Role::Method instances, which are
-aliased, instead of added, but still need to be counted as valid
-methods.
+=item B<< $metaclass->add_override_method_modifier($name, $sub) >>
 
-=item B<add_override_method_modifier ($name, $method)>
+This adds an C<override> method modifier to the package.
 
-This will create an C<override> method modifier for you, and install
-it in the package.
+=item B<< $metaclass->add_augment_method_modifier($name, $sub) >>
 
-=item B<add_augment_method_modifier ($name, $method)>
+This adds an C<augment> method modifier to the package.
 
-This will create an C<augment> method modifier for you, and install
-it in the package.
+=item B<< $metaclass->calculate_all_roles >>
 
-=item B<calculate_all_roles>
+This will return a unique array of C<Moose::Meta::Role> instances
+which are attached to this class.
 
-=item B<roles>
+=item B<< $metaclass->add_role($role) >>
 
-This will return an array of C<Moose::Meta::Role> instances which are
-attached to this class.
+This takes a L<Moose::Meta::Role> object, and adds it to the class's
+list of roles. This I<does not> actually apply the role to the class.
 
-=item B<add_role ($role)>
+=item B<< $metaclass->does_role($role_name) >>
 
-This takes an instance of C<Moose::Meta::Role> in C<$role>, and adds it
-to the list of associated roles.
+This returns a boolean indicating whether or not the class does the
+specified role. This tests both the class and its parents.
 
-=item B<does_role ($role_name)>
+=item B<< $metaclass->excludes_role($role_name) >>
 
-This will test if this class C<does> a given C<$role_name>. It will
-not only check it's local roles, but ask them as well in order to
-cascade down the role hierarchy.
+A class excludes a role if it has already composed a role which
+excludes the named role. This tests both the class and its parents.
 
-=item B<excludes_role ($role_name)>
+=item B<< $metaclass->add_attribute($attr_name, %params|$params) >>
 
-This will test if this class C<excludes> a given C<$role_name>. It will
-not only check it's local roles, but ask them as well in order to
-cascade down the role hierarchy.
+This overrides the parent's method in order to allow the parameters to
+be provided as a hash reference.
 
-=item B<add_attribute ($attr_name, %params|$params)>
+=item B<< $metaclass->constructor_class ($class_name) >>
 
-This method does the same thing as L<Class::MOP::Class::add_attribute>, but adds
-support for taking the C<$params> as a HASH ref.
-
-=item B<constructor_class ($class_name)>
-
-=item B<destructor_class ($class_name)>
+=item B<< $metaclass->destructor_class ($class_name) >>
 
 These are the names of classes used when making a class
 immutable. These default to L<Moose::Meta::Method::Constructor> and
 L<Moose::Meta::Method::Destructor> respectively. These accessors are
 read-write, so you can use them to change the class name.
 
-=item B<error_class ($class_name)>
+=item B<< $metaclass->error_class($class_name) >>
 
-The name of the class used to throw errors. This default to
+The name of the class used to throw errors. This defaults to
 L<Moose::Error::Default>, which generates an error with a stacktrace
 just like C<Carp::confess>.
 
-=item B<check_metaclass_compatibility>
-
-Moose overrides this method from C<Class::MOP::Class> and attempts to
-fix some incompatibilities before doing the check.
-
-=item B<throw_error $message, %extra>
+=item B<< $metaclass->throw_error($message, %extra) >>
 
 Throws the error created by C<create_error> using C<raise_error>
 
-=item B<create_error $message, %extra>
-
-Creates an error message or object.
-
-The default behavior is C<create_error_confess>.
-
-If C<error_class> is set uses C<create_error_object>. Otherwise uses
-C<error_builder> (a code reference or variant name), and calls the appropriate
-C<create_error_$builder> method.
-
-=item B<error_builder $builder_name>
-
-Get or set the error builder. Defaults to C<confess>.
-
-=item B<error_class $class_name>
-
-Get or set the error class. Has no default.
-
-=item B<create_error_confess %args>
-
-Creates an error using L<Carp/longmess>
-
-=item B<create_error_croak %args>
-
-Creates an error using L<Carp/shortmess>
-
-=item B<create_error_object %args>
-
-Calls C<new> on the C<class> parameter in C<%args>. Usable with C<error_class>
-to support custom error objects for your meta class.
-
-=item B<raise_error $error>
-
-Dies with an error object or string.
-
 =back
 
 =head1 BUGS
@@ -877,7 +760,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>