bump the version so I can make svn Moose require this version
[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm
index 4aefe2d..1a9dc99 100644 (file)
@@ -5,235 +5,148 @@ use strict;
 use warnings;
 
 use Carp         'confess';
-use Scalar::Util 'reftype', 'blessed';
-use B            'svref_2object';
+use Scalar::Util 'weaken';
 
-our $VERSION   = '0.03';
+our $VERSION   = '0.78';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
-use overload '&{}' => sub { $_[0]->{body} },
-             fallback => 1;
+use base 'Class::MOP::Object';
 
-# introspection
-
-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 wrap { 
-    my $class = shift;
-    my $code  = shift;
-    ('CODE' eq (reftype($code) || ''))
+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') . ")";
-    bless { 
-        body => $code 
-    } => blessed($class) || $class;
-}
 
-sub body { (shift)->{body} }
+    ($params{package_name} && $params{name})
+        || confess "You must supply the package_name and name parameters $UPGRADE_ERROR_TEXT";
 
-# informational
+    my $self = $class->_new(\%params);
 
-sub package_name { 
-       my $code = shift->{body};
-#      (blessed($code))
-#              || confess "Can only ask the package name of a blessed CODE";
-       svref_2object($code)->GV->STASH->NAME;
-}
+    weaken($self->{associated_metaclass}) if $self->{associated_metaclass};
 
-sub name { 
-       my $code = shift->{body};
-#      (blessed($code))
-#              || confess "Can only ask the package name of a blessed CODE";   
-       svref_2object($code)->GV->NAME;
+    return $self;
 }
 
-sub fully_qualified_name {
-       my $code = shift;
-#      (blessed($code))
-#              || confess "Can only ask the package name of a blessed CODE";
-       $code->package_name . '::' . $code->name;               
+sub _new {
+    my $class = shift;
+    my $params = @_ == 1 ? $_[0] : {@_};
+
+    my $self = bless {
+        'body'                 => $params->{body},
+        'associated_metaclass' => $params->{associated_metaclass},
+        'package_name'         => $params->{package_name},
+        'name'                 => $params->{name},
+    } => $class;
 }
 
-package Class::MOP::Method::Wrapped;
+## accessors
 
-use strict;
-use warnings;
+sub body { (shift)->{'body'} }
 
-use Carp         'confess';
-use Scalar::Util 'reftype', 'blessed';
-use Sub::Name    'subname';
+sub associated_metaclass { shift->{'associated_metaclass'} }
 
-our $VERSION = '0.01';
+sub attach_to_class {
+    my ( $self, $class ) = @_;
+    $self->{associated_metaclass} = $class;
+    weaken($self->{associated_metaclass});
+}
 
-use base 'Class::MOP::Method'; 
+sub detach_from_class {
+    my $self = shift;
+    delete $self->{associated_metaclass};
+}
 
-# NOTE:
-# this ugly beast is the result of trying 
-# to micro optimize this as much as possible
-# while not completely loosing maintainability.
-# At this point it's "fast enough", after all
-# you can't get something for nothing :)
-my $_build_wrapped_method = sub {
-       my $modifier_table = shift;
-       my ($before, $after, $around) = (
-               $modifier_table->{before},
-               $modifier_table->{after},               
-               $modifier_table->{around},              
-       );
-       if (@$before && @$after) {
-               $modifier_table->{cache} = sub {
-                       $_->(@_) for @{$before};
-                       my @rval;
-                       ((defined wantarray) ?
-                               ((wantarray) ? 
-                                       (@rval = $around->{cache}->(@_)) 
-                                       : 
-                                       ($rval[0] = $around->{cache}->(@_)))
-                               :
-                               $around->{cache}->(@_));
-                       $_->(@_) for @{$after};                 
-                       return unless defined wantarray;
-                       return wantarray ? @rval : $rval[0];
-               }               
-       }
-       elsif (@$before && !@$after) {
-               $modifier_table->{cache} = sub {
-                       $_->(@_) for @{$before};
-                       return $around->{cache}->(@_);
-               }               
-       }
-       elsif (@$after && !@$before) {
-               $modifier_table->{cache} = sub {
-                       my @rval;
-                       ((defined wantarray) ?
-                               ((wantarray) ? 
-                                       (@rval = $around->{cache}->(@_)) 
-                                       : 
-                                       ($rval[0] = $around->{cache}->(@_)))
-                               :
-                               $around->{cache}->(@_));
-                       $_->(@_) for @{$after};                 
-                       return unless defined wantarray;
-                       return wantarray ? @rval : $rval[0];
-               }               
-       }
-       else {
-               $modifier_table->{cache} = $around->{cache};
-       }
-};
+sub package_name { (shift)->{'package_name'} }
 
-sub wrap {
-       my $class = shift;
-       my $code  = shift;
-       (blessed($code) && $code->isa('Class::MOP::Method'))
-               || confess "Can only wrap blessed CODE";        
-       my $modifier_table = { 
-               cache  => undef,
-               orig   => $code,
-               before => [],
-               after  => [],           
-               around => {
-                       cache   => $code->body,
-                       methods => [],          
-               },
-       };
-       $_build_wrapped_method->($modifier_table);
-       my $method = $class->SUPER::wrap(sub { $modifier_table->{cache}->(@_) });       
-       $method->{modifier_table} = $modifier_table;
-       $method;  
+sub name { (shift)->{'name'} }
+
+sub fully_qualified_name {
+    my $self = shift;
+    $self->package_name . '::' . $self->name;
 }
 
-sub get_original_method {
-       my $code = shift; 
-    $code->{modifier_table}->{orig};
+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 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";
-       #('CODE' eq (reftype($code) || ''))
-    #    || confess "You must supply a CODE reference for a modifier";                 
-       unshift @{$code->{modifier_table}->{before}} => $modifier;
-       $_build_wrapped_method->($code->{modifier_table});
+sub original_name {
+    my $self = shift;
+
+    $self->original_method
+        ? $self->original_method->original_name
+        : $self->name;
 }
 
-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";
-    #('CODE' eq (reftype($code) || ''))
-    #    || confess "You must supply a CODE reference for a modifier";                 
-       push @{$code->{modifier_table}->{after}} => $modifier;
-       $_build_wrapped_method->($code->{modifier_table});      
+sub original_fully_qualified_name {
+    my $self = shift;
+
+    $self->original_method
+        ? $self->original_method->original_fully_qualified_name
+        : $self->fully_qualified_name;
 }
 
-{
-       # NOTE:
-       # this is another possible canidate for 
-       # optimization as well. There is an overhead
-       # associated with the currying that, if 
-       # eliminated might make around modifiers
-       # more manageable.
-       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";
-           #('CODE' eq (reftype($code) || ''))
-           #    || confess "You must supply a CODE reference for a modifier";                  
-               unshift @{$code->{modifier_table}->{around}->{methods}} => $modifier;           
-               $code->{modifier_table}->{around}->{cache} = $compile_around_method->(
-                       @{$code->{modifier_table}->{around}->{methods}},
-                       $code->{modifier_table}->{orig}->body
-               );
-               $_build_wrapped_method->($code->{modifier_table});              
-       }       
+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. Basically all we do is to 
-bless the subroutine. 
-
-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. 
+The Method Protocol is very small, since methods in Perl 5 are just
+subroutines within the particular package. We provide a very basic
+introspection interface.
 
 =head1 METHODS
 
@@ -243,7 +156,7 @@ Suggestions for this are welcome.
 
 =item B<meta>
 
-This will return a B<Class::MOP::Class> instance which is related 
+This will return a B<Class::MOP::Class> instance which is related
 to this class.
 
 =back
@@ -252,9 +165,16 @@ to this class.
 
 =over 4
 
-=item B<wrap (&code)>
+=item B<wrap ($code, %params)>
 
-This simply blesses the C<&code> reference passed to it.
+This is the basic constructor, it returns a B<Class::MOP::Method>
+instance which wraps the given C<$code> reference. You must also set
+the C<package_name> and C<name> attributes in C<%params>.
+
+=item B<clone (%params)>
+
+This will make a copy of the object, allowing you to override
+any values by stuffing them in C<%params>.
 
 =back
 
@@ -264,37 +184,79 @@ This simply blesses the C<&code> reference passed to it.
 
 =item B<body>
 
+This returns the actual CODE reference of the particular instance.
+
 =item B<name>
 
+This returns the name of the CODE reference.
+
+=item B<associated_metaclass>
+
+The metaclass of the method
+
 =item B<package_name>
 
+This returns the package name that the CODE reference is attached to.
+
 =item B<fully_qualified_name>
 
-=back
+This returns the fully qualified name of the CODE reference.
 
-=head1 Class::MOP::Method::Wrapped METHODS
+=item B<original_method>
 
-=head2 Construction
+If this method object was created as a clone of some other method
+object, this returns the object that was cloned.
 
-=over 4
+=item B<original_name>
 
-=item B<wrap (&code)>
+This returns the original name of the CODE reference, wherever it was
+first defined.
 
-This simply blesses the C<&code> reference passed to it.
+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<get_original_method>
+=item B<original_package_name>
+
+This returns the original package name that the CODE reference is
+attached to, 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<original_fully_qualified_name>
+
+This returns the original fully qualified name of the CODE reference,
+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.
 
 =back
 
-=head2 Modifiers
+=head2 Metaclass
 
 =over 4
 
-=item B<add_before_modifier ($code)>
+=item B<attach_to_class>
+
+Sets the associated metaclass
+
+=item B<detach_from_class>
 
-=item B<add_after_modifier ($code)>
+Disassociates the method from the metaclass
 
-=item B<add_around_modifier ($code)>
+=back
+
+=head2 Miscellaneous
+
+=over 4
+
+=item B<execute>
+
+Executes the method. Be sure to pass in the instance, since the
+method expects it.
 
 =back
 
@@ -302,16 +264,14 @@ This simply blesses the C<&code> reference passed to it.
 
 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-2008 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