Update Changes, bump version to 0.97_01, make copyright 2006-2010
[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm
index 6821e98..3e1a180 100644 (file)
@@ -5,9 +5,9 @@ use strict;
 use warnings;
 
 use Carp         'confess';
-use Scalar::Util 'weaken';
+use Scalar::Util 'weaken', 'reftype', 'blessed';
 
-our $VERSION   = '0.64_06';
+our $VERSION   = '0.97_01';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -18,15 +18,6 @@ use base 'Class::MOP::Object';
 # they should act like CODE refs.
 use overload '&{}' => sub { $_[0]->body }, fallback => 1;
 
-our $UPGRADE_ERROR_TEXT = q{
----------------------------------------------------------
-NOTE: this error is likely not an error, but a regression
-caused by the latest upgrade to Moose/Class::MOP. Consider
-upgrading any MooseX::* modules to their latest versions
-before spending too much time chasing this one down.
----------------------------------------------------------
-};
-
 # construction
 
 sub wrap {
@@ -37,13 +28,20 @@ sub wrap {
     my %params = @args;
     my $code = $params{body};
 
-    ('CODE' eq ref($code))
-        || confess "You must supply a CODE reference to bless, not (" . ($code || 'undef') . ")";
+    if (blessed($code) && $code->isa(__PACKAGE__)) {
+        my $method = $code->clone;
+        delete $params{body};
+        Class::MOP::class_of($class)->rebless_instance($method, %params);
+        return $method;
+    }
+    elsif (!ref $code || 'CODE' ne reftype($code)) {
+        confess "You must supply a CODE reference to bless, not (" . ($code || 'undef') . ")";
+    }
 
     ($params{package_name} && $params{name})
-        || confess "You must supply the package_name and name parameters $UPGRADE_ERROR_TEXT";
+        || confess "You must supply the package_name and name parameters";
 
-    my $self = (ref($class) || $class)->_new(\%params);
+    my $self = $class->_new(\%params);
 
     weaken($self->{associated_metaclass}) if $self->{associated_metaclass};
 
@@ -52,20 +50,23 @@ sub wrap {
 
 sub _new {
     my $class = shift;
+
+    return Class::MOP::Class->initialize($class)->new_object(@_)
+        if $class ne __PACKAGE__;
+
     my $params = @_ == 1 ? $_[0] : {@_};
 
-    my $self = bless {
+    return bless {
         'body'                 => $params->{body},
         'associated_metaclass' => $params->{associated_metaclass},
         'package_name'         => $params->{package_name},
         'name'                 => $params->{name},
+        'original_method'      => $params->{original_method},
     } => $class;
 }
 
 ## accessors
 
-sub body { (shift)->{'body'} }
-
 sub associated_metaclass { shift->{'associated_metaclass'} }
 
 sub attach_to_class {
@@ -79,19 +80,47 @@ sub detach_from_class {
     delete $self->{associated_metaclass};
 }
 
-sub package_name {
+sub fully_qualified_name {
     my $self = shift;
-    $self->{'package_name'} ||= (Class::MOP::get_code_info($self->body))[0];
+    $self->package_name . '::' . $self->name;
 }
 
-sub name {
+sub original_method { (shift)->{'original_method'} }
+
+sub _set_original_method { $_[0]->{'original_method'} = $_[1] }
+
+# It's possible that this could cause a loop if there is a circular
+# reference in here. That shouldn't ever happen in normal
+# circumstances, since original method only gets set when clone is
+# called. We _could_ check for such a loop, but it'd involve some sort
+# of package-lexical variable, and wouldn't be terribly subclassable.
+sub original_package_name {
     my $self = shift;
-    $self->{'name'} ||= (Class::MOP::get_code_info($self->body))[1];
+
+    $self->original_method
+        ? $self->original_method->original_package_name
+        : $self->package_name;
 }
 
-sub fully_qualified_name {
-    my $code = shift;
-    $code->package_name . '::' . $code->name;
+sub original_name {
+    my $self = shift;
+
+    $self->original_method
+        ? $self->original_method->original_name
+        : $self->name;
+}
+
+sub original_fully_qualified_name {
+    my $self = shift;
+
+    $self->original_method
+        ? $self->original_method->original_fully_qualified_name
+        : $self->fully_qualified_name;
+}
+
+sub execute {
+    my $self = shift;
+    $self->body->(@_);
 }
 
 # NOTE:
@@ -113,78 +142,124 @@ Class::MOP::Method - Method Meta Object
 =head1 DESCRIPTION
 
 The Method Protocol is very small, since methods in Perl 5 are just
-subroutines within the particular package. We provide a very basic
+subroutines in a specific package. We provide a very basic
 introspection interface.
 
 =head1 METHODS
 
-=head2 Introspection
-
 =over 4
 
-=item B<meta>
+=item B<< Class::MOP::Method->wrap($code, %options) >>
 
-This will return a B<Class::MOP::Class> instance which is related
-to this class.
+This is the constructor. It accepts a method body in the form of
+either a code reference or a L<Class::MOP::Method> instance, followed
+by a hash of options.
 
-=back
+The options are:
 
-=head2 Construction
+=over 8
 
-=over 4
+=item * name
+
+The method name (without a package name). This is required if C<$code>
+is a coderef.
 
-=item B<wrap ($code, %params)>
+=item * package_name
 
-This is the basic constructor, it returns a B<Class::MOP::Method>
-instance which wraps the given C<$code> reference. You can also
-set the C<package_name> and C<name> attributes using the C<%params>.
-If these are not set, then thier accessors will attempt to figure
-it out using the C<Class::MOP::get_code_info> function.
+The package name for the method. This is required if C<$code> is a
+coderef.
 
-=item B<clone (%params)>
+=item * associated_metaclass
 
-This will make a copy of the object, allowing you to override
-any values by stuffing them in C<%params>.
+An optional L<Class::MOP::Class> object. This is the metaclass for the
+method's class.
 
 =back
 
-=head2 Informational
+=item B<< $metamethod->clone(%params) >>
 
-=over 4
+This makes a shallow clone of the method object. In particular,
+subroutine reference itself is shared between all clones of a given
+method.
 
-=item B<body>
+When a method is cloned, the original method object will be available
+by calling C<original_method> on the clone.
 
-This returns the actual CODE reference of the particular instance.
+=item B<< $metamethod->body >>
 
-=item B<name>
+This returns a reference to the method's subroutine.
 
-This returns the name of the CODE reference.
+=item B<< $metamethod->name >>
 
-=item B<associated_metaclass>
+This returns the method's name
 
-The metaclass of the method
+=item B<< $metamethod->package_name >>
 
-=item B<package_name>
+This returns the method's package name.
 
-This returns the package name that the CODE reference is attached to.
+=item B<< $metamethod->fully_qualified_name >>
 
-=item B<fully_qualified_name>
+This returns the method's fully qualified name (package name and
+method name).
 
-This returns the fully qualified name of the CODE reference.
+=item B<< $metamethod->associated_metaclass >>
 
-=back
+This returns the L<Class::MOP::Class> object for the method, if one
+exists.
 
-=head2 Metaclass
+=item B<< $metamethod->original_method >>
 
-=over 4
+If this method object was created as a clone of some other method
+object, this returns the object that was cloned.
+
+=item B<< $metamethod->original_name >>
+
+This returns the method's original name, wherever it was first
+defined.
+
+If this method is a clone of a clone (of a clone, etc.), this method
+returns the name from the I<first> method in the chain of clones.
+
+=item B<< $metamethod->original_package_name >>
+
+This returns the method's original package name, wherever it was first
+defined.
+
+If this method is a clone of a clone (of a clone, etc.), this method
+returns the package name from the I<first> method in the chain of
+clones.
+
+=item B<< $metamethod->original_fully_qualified_name >>
+
+This returns the method's original fully qualified name, wherever it
+was first defined.
+
+If this method is a clone of a clone (of a clone, etc.), this method
+returns the fully qualified name from the I<first> method in the chain
+of clones.
+
+=item B<< $metamethod->attach_to_class($metaclass) >>
+
+Given a L<Class::MOP::Class> object, this method sets the associated
+metaclass for the method. This will overwrite any existing associated
+metaclass.
+
+=item B<< $metamethod->detach_from_class >>
+
+Removes any associated metaclass object for the method.
+
+=item B<< $metamethod->execute(...) >>
 
-=item B<attach_to_class>
+This executes the method. Any arguments provided will be passed on to
+the method itself.
 
-Sets the associated metaclass
+=item B<< Class::MOP::Method->meta >>
 
-=item B<detach_from_class>
+This will return a L<Class::MOP::Class> instance for this class.
 
-Disassociates the method from the metaclass
+It should also be noted that L<Class::MOP> will actually bootstrap
+this module by installing a number of attribute meta-objects into its
+metaclass.
 
 =back
 
@@ -194,7 +269,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>