bump version and update Changes
[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm
index 912368a..9e111ae 100644 (file)
@@ -5,207 +5,270 @@ use strict;
 use warnings;
 
 use Carp         'confess';
-use Scalar::Util 'reftype', 'blessed';
-use B            'svref_2object';
+use Scalar::Util 'weaken';
 
-our $VERSION = '0.02';
+our $VERSION   = '0.79';
+$VERSION = eval $VERSION;
+our $AUTHORITY = 'cpan:STEVAN';
 
-# introspection
+use base 'Class::MOP::Object';
 
-sub meta { 
-    require Class::MOP::Class;
-    Class::MOP::Class->initialize(blessed($_[0]) || $_[0]);
-}
+# NOTE:
+# if poked in the right way,
+# 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 new { 
+sub wrap {
+    my ( $class, @args ) = @_;
+
+    unshift @args, 'body' if @args % 2 == 1;
+
+    my %params = @args;
+    my $code = $params{body};
+
+    ('CODE' eq ref($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";
+
+    my $self = $class->_new(\%params);
+
+    weaken($self->{associated_metaclass}) if $self->{associated_metaclass};
+
+    return $self;
+}
+
+sub _new {
     my $class = shift;
-    my $code  = shift;
-    (reftype($code) && reftype($code) eq 'CODE')
-        || confess "You must supply a CODE reference to bless";
-    bless $code => blessed($class) || $class;
+    my $params = @_ == 1 ? $_[0] : {@_};
+
+    my $self = bless {
+        'body'                 => $params->{body},
+        'associated_metaclass' => $params->{associated_metaclass},
+        'package_name'         => $params->{package_name},
+        'name'                 => $params->{name},
+    } => $class;
+}
+
+## accessors
+
+sub associated_metaclass { shift->{'associated_metaclass'} }
+
+sub attach_to_class {
+    my ( $self, $class ) = @_;
+    $self->{associated_metaclass} = $class;
+    weaken($self->{associated_metaclass});
+}
+
+sub detach_from_class {
+    my $self = shift;
+    delete $self->{associated_metaclass};
+}
+
+sub fully_qualified_name {
+    my $self = shift;
+    $self->package_name . '::' . $self->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;
 }
 
-{
-       my %MODIFIERS;
-       
-       sub wrap {
-               my $code = shift;
-               (blessed($code))
-                       || confess "Can only ask the package name of a blessed CODE";
-               my $modifier_table = { 
-                       orig   => $code,
-                       before => [],
-                       after  => [],           
-                       around => {
-                               cache   => $code,
-                               methods => [],
-                       },
-               };
-               my $method = $code->new(sub {
-                       $_->(@_) for @{$modifier_table->{before}};
-                       my (@rlist, $rval);
-                       if (defined wantarray) {
-                               if (wantarray) {
-                                       @rlist = $modifier_table->{around}->{cache}->(@_);
-                               }
-                               else {
-                                       $rval = $modifier_table->{around}->{cache}->(@_);
-                               }
-                       }
-                       else {
-                               $modifier_table->{around}->{cache}->(@_);
-                       }
-                       $_->(@_) for @{$modifier_table->{after}};                       
-                       return unless defined wantarray;
-                       return wantarray ? @rlist : $rval;
-               });     
-               $MODIFIERS{$method} = $modifier_table;
-               $method;  
-       }
-       
-       sub add_before_modifier {
-               my $code     = shift;
-               my $modifier = shift;
-               (exists $MODIFIERS{$code})
-                       || confess "You must first wrap your method before adding a modifier";          
-               (blessed($code))
-                       || confess "Can only ask the package name of a blessed CODE";
-           (reftype($modifier) && reftype($modifier) eq 'CODE')
-               || confess "You must supply a CODE reference for a modifier";                   
-               unshift @{$MODIFIERS{$code}->{before}} => $modifier;
-       }
-       
-       sub add_after_modifier {
-               my $code     = shift;
-               my $modifier = shift;
-               (exists $MODIFIERS{$code})
-                       || confess "You must first wrap your method before adding a modifier";          
-               (blessed($code))
-                       || confess "Can only ask the package name of a blessed CODE";
-           (reftype($modifier) && reftype($modifier) eq 'CODE')
-               || confess "You must supply a CODE reference for a modifier";                   
-               push @{$MODIFIERS{$code}->{after}} => $modifier;
-       }
-       
-       {
-               my $compile_around_method = sub {{
-               my $f1 = pop;
-               return $f1 unless @_;
-               my $f2 = pop;
-               push @_, sub { $f2->( $f1, @_ ) };
-                       redo;
-               }};
-       
-               sub add_around_modifier {
-                       my $code     = shift;
-                       my $modifier = shift;
-                       (exists $MODIFIERS{$code})
-                               || confess "You must first wrap your method before adding a modifier";          
-                       (blessed($code))
-                               || confess "Can only ask the package name of a blessed CODE";
-                   (reftype($modifier) && reftype($modifier) eq 'CODE')
-                       || confess "You must supply a CODE reference for a modifier";                   
-                       unshift @{$MODIFIERS{$code}->{around}->{methods}} => $modifier;         
-                       $MODIFIERS{$code}->{around}->{cache} = $compile_around_method->(
-                               @{$MODIFIERS{$code}->{around}->{methods}},
-                               $MODIFIERS{$code}->{orig}
-                       );
-               }       
-       }
+sub original_name {
+    my $self = shift;
+
+    $self->original_method
+        ? $self->original_method->original_name
+        : $self->name;
 }
 
-# informational
+sub original_fully_qualified_name {
+    my $self = shift;
 
-sub package_name { 
-       my $code = shift;
-       (blessed($code))
-               || confess "Can only ask the package name of a blessed CODE";
-       svref_2object($code)->GV->STASH->NAME;
+    $self->original_method
+        ? $self->original_method->original_fully_qualified_name
+        : $self->fully_qualified_name;
 }
 
-sub name { 
-       my $code = shift;
-       (blessed($code))
-               || confess "Can only ask the package name of a blessed CODE";   
-       svref_2object($code)->GV->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
+=head1 DESCRIPTION
 
-  # ... more to come later maybe
+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 DESCRIPTION
+=head1 METHODS
 
-The Method Protocol is very small, since methods in Perl 5 are just 
-subroutines within the particular package. Basically all we do is to 
-bless the subroutine. 
+=over 4
 
-Currently this package is largely unused. Future plans are to provide 
-some very simple introspection methods for the methods themselves. 
-Suggestions for this are welcome. 
+=item B<< Class::MOP::Method->wrap($code, %options) >>
 
-=head1 METHODS
+This is the constructor. It accepts a subroutine reference and a hash
+of options.
 
-=head2 Introspection
+The options are:
 
-=over 4
+=over 8
 
-=item B<meta>
+=item * name
 
-This will return a B<Class::MOP::Class> instance which is related 
-to this class.
+The method name (without a package name). This is required.
+
+=item * package_name
+
+The package name for the method. This is required.
+
+=item * associated_metaclass
+
+An optional L<Class::MOP::Class> object. This is the metaclass for the
+method's class.
 
 =back
 
-=head2 Construction
+=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<new (&code)>
+When a method is cloned, the original method object will be available
+by calling C<original_method> on the clone.
 
-This simply blesses the C<&code> reference passed to it.
+=item B<< $metamethod->body >>
 
-=back
+This returns a reference to the method's subroutine.
 
-=head2 Informational
+=item B<< $metamethod->name >>
 
-=over 4
+This returns the method's name
 
-=item B<name>
+=item B<< $metamethod->package_name >>
 
-=item B<package_name>
+This returns the method's package name.
 
-=back
+=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 >>
+
+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.
 
-=head1 SEE ALSO
+=item B<< $metamethod->original_package_name >>
 
-http://dirtsimple.org/2005/01/clos-style-method-combination-for.html
+This returns the method's original package name, wherever it was first
+defined.
 
-http://www.gigamonkeys.com/book/object-reorientation-generic-functions.html
+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.
 
-=head1 AUTHOR
+=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
+
+=head1 AUTHORS
 
 Stevan Little E<lt>stevan@iinteractive.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
 
-=cut
\ No newline at end of file