bump version to 0.94
[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm
index 55b22fb..6602310 100644 (file)
@@ -5,123 +5,261 @@ use strict;
 use warnings;
 
 use Carp         'confess';
-use Scalar::Util 'reftype', 'blessed';
-use B            'svref_2object';
+use Scalar::Util 'weaken', 'reftype', 'blessed';
 
-our $VERSION   = '0.05';
+our $VERSION   = '0.94';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Class::MOP::Object';
 
 # NOTE:
-# if poked in the right way, 
+# if poked in the right way,
 # they should act like CODE refs.
 use overload '&{}' => sub { $_[0]->body }, fallback => 1;
 
-# introspection
+# construction
 
-sub meta { 
-    require Class::MOP::Class;
-    Class::MOP::Class->initialize(blessed($_[0]) || $_[0]);
-}
+sub wrap {
+    my ( $class, @args ) = @_;
 
-# construction
+    unshift @args, 'body' if @args % 2 == 1;
+
+    my %params = @args;
+    my $code = $params{body};
+
+    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') . ")";
+    }
 
-sub wrap { 
+    ($params{package_name} && $params{name})
+        || confess "You must supply the package_name and name parameters";
+
+    my $self = $class->_new(\%params);
+
+    weaken($self->{associated_metaclass}) if $self->{associated_metaclass};
+
+    return $self;
+}
+
+sub _new {
     my $class = shift;
-    my $code  = shift;
-    ('CODE' eq (reftype($code) || ''))
-        || confess "You must supply a CODE reference to bless, not (" . ($code || 'undef') . ")";
-    bless { 
-        '&!body' => $code 
-    } => blessed($class) || $class;
+
+    return Class::MOP::Class->initialize($class)->new_object(@_)
+        if $class ne __PACKAGE__;
+
+    my $params = @_ == 1 ? $_[0] : {@_};
+
+    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'} }
 
-# TODO - add associated_class
+sub attach_to_class {
+    my ( $self, $class ) = @_;
+    $self->{associated_metaclass} = $class;
+    weaken($self->{associated_metaclass});
+}
 
-# informational
+sub detach_from_class {
+    my $self = shift;
+    delete $self->{associated_metaclass};
+}
 
-# NOTE: 
-# this may not be the same name 
-# as the class you got it from
-# This gets the package stash name 
-# associated with the actual CODE-ref
-sub package_name { 
-       my $code = (shift)->body;
-       svref_2object($code)->GV->STASH->NAME;
+sub fully_qualified_name {
+    my $self = shift;
+    $self->package_name . '::' . $self->name;
 }
 
-# NOTE: 
-# this may not be the same name 
-# as the method name it is stored
-# with. This gets the name associated
-# with the actual CODE-ref
-sub name { 
-       my $code = (shift)->body;
-       svref_2object($code)->GV->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->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:
+# the Class::MOP bootstrap
+# will create this for us
+# - SL
+# sub clone { ... }
+
 1;
 
 __END__
 
 =pod
 
-=head1 NAME 
+=head1 NAME
 
 Class::MOP::Method - Method Meta Object
 
-=head1 SYNOPSIS
-
-  # ... more to come later maybe
-
 =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 
+The Method Protocol is very small, since methods in Perl 5 are just
+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
 
-=item B<wrap (&code)>
+The method name (without a package name). This is required if C<$code>
+is a coderef.
+
+=item * package_name
+
+The package name for the method. This is required if C<$code> is a
+coderef.
+
+=item * associated_metaclass
+
+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.
+
+When a method is cloned, the original method object will be available
+by calling C<original_method> on the clone.
+
+=item B<< $metamethod->body >>
+
+This returns a reference to the method's subroutine.
+
+=item B<< $metamethod->name >>
+
+This returns the method's name
+
+=item B<< $metamethod->package_name >>
+
+This returns the method's package name.
+
+=item B<< $metamethod->fully_qualified_name >>
+
+This returns the method's fully qualified name (package name and
+method name).
+
+=item B<< $metamethod->associated_metaclass >>
+
+This returns the L<Class::MOP::Class> object for the method, if one
+exists.
+
+=item B<< $metamethod->original_method >>
 
-=item B<body>
+If this method object was created as a clone of some other method
+object, this returns the object that was cloned.
 
-=item B<name>
+=item B<< $metamethod->original_name >>
 
-=item B<package_name>
+This returns the method's original name, wherever it was first
+defined.
 
-=item B<fully_qualified_name>
+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(...) >>
+
+This executes the method. Any arguments provided will be passed on to
+the method itself.
+
+=item B<< Class::MOP::Method->meta >>
+
+This will return a L<Class::MOP::Class> instance for this class.
+
+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
 
@@ -129,16 +267,14 @@ to this class.
 
 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
-Yuval Kogman E<lt>nothingmuch@woobling.comE<gt>
-
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006-2009 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. 
+it under the same terms as Perl itself.
 
 =cut