[gitmo/Class-MOP.git] / lib / Class / MOP / Method.pm


package Class::MOP::Method;

use strict;
use warnings;

use Carp         'confess';
use Scalar::Util 'blessed';

our $VERSION   = '0.65';
our $AUTHORITY = 'cpan:STEVAN';

use base 'Class::MOP::Object';

# 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, @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";

    bless {
        'body'         => $code,
        'package_name' => $params{package_name},
        'name'         => $params{name},
    } => blessed($class) || $class;
}

## accessors

sub body { (shift)->{'body'} }

# TODO - add associated_class

# informational

sub package_name {
    my $self = shift;
    $self->{'package_name'} ||= (Class::MOP::get_code_info($self->body))[0];
}

sub name {
    my $self = shift;
    $self->{'name'} ||= (Class::MOP::get_code_info($self->body))[1];
}

sub fully_qualified_name {
    my $code = shift;
    $code->package_name . '::' . $code->name;
}

# NOTE:
# the Class::MOP bootstrap
# will create this for us
# - SL
# sub clone { ... }

1;

__END__

=pod

=head1 NAME

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
introspection interface.

=head1 METHODS

=head2 Introspection

=over 4

=item B<meta>

This will return a B<Class::MOP::Class> instance which is related
to this class.

=back

=head2 Construction

=over 4

=item B<wrap ($code, %params)>

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.

=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

=head2 Informational

=over 4

=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<package_name>

This returns the package name that the CODE reference is attached to.

=item B<fully_qualified_name>

This returns the fully qualified name of the CODE reference.

=back

=head1 AUTHORS

Stevan Little E<lt>stevan@iinteractive.comE<gt>

=head1 COPYRIGHT AND LICENSE

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.

=cut
Commit	Line	Data
8b978dd5	1
	2	package Class::MOP::Method;
	3
	4	use strict;
	5	use warnings;
	6
2eb717d5	7	use Carp 'confess';
9b522fc4	8	use Scalar::Util 'blessed';
2eb717d5	9
2e5c1a3f	10	our $VERSION = '0.65';
f0480c45	11	our $AUTHORITY = 'cpan:STEVAN';
de19f115	12
b1897d4d	13	use base 'Class::MOP::Object';
b1897d4d	14
ce2ae40f	15	# NOTE:
32202ce2	16	# if poked in the right way,
ce2ae40f	17	# they should act like CODE refs.
c23184fc	18	use overload '&{}' => sub { $_[0]->body }, fallback => 1;
7855ddba	19
32202ce2	20	our $UPGRADE_ERROR_TEXT = q{
	21	---------------------------------------------------------
	22	NOTE: this error is likely not an error, but a regression
	23	caused by the latest upgrade to Moose/Class::MOP. Consider
	24	upgrading any MooseX::* modules to their latest versions
	25	before spending too much time chasing this one down.
	26	---------------------------------------------------------
	27	};
	28
de19f115	29	# construction
de19f115	30
32202ce2	31	sub wrap {
5caf45ce	32	my ( $class, @args ) = @_;
	33
	34	unshift @args, 'body' if @args % 2 == 1;
	35
	36	my %params = @args;
	37	my $code = $params{body};
32202ce2	38
9b522fc4	39	('CODE' eq ref($code))
4d47b77f	40	\|\| confess "You must supply a CODE reference to bless, not (" . ($code \|\| 'undef') . ")";
32202ce2	41
b38f3848	42	($params{package_name} && $params{name})
32202ce2	43	\|\| confess "You must supply the package_name and name parameters $UPGRADE_ERROR_TEXT";
	44
	45	bless {
8683db0e	46	'body' => $code,
	47	'package_name' => $params{package_name},
	48	'name' => $params{name},
7855ddba	49	} => blessed($class) \|\| $class;
de19f115	50	}
de19f115	51
ce2ae40f	52	## accessors
ce2ae40f	53
8683db0e	54	sub body { (shift)->{'body'} }
7855ddba	55
b1897d4d	56	# TODO - add associated_class
b1897d4d	57
de19f115	58	# informational
de19f115	59
32202ce2	60	sub package_name {
4c105333	61	my $self = shift;
8683db0e	62	$self->{'package_name'} \|\|= (Class::MOP::get_code_info($self->body))[0];
de19f115	63	}
de19f115	64
32202ce2	65	sub name {
4c105333	66	my $self = shift;
8683db0e	67	$self->{'name'} \|\|= (Class::MOP::get_code_info($self->body))[1];
2eb717d5	68	}
de19f115	69
96ceced8	70	sub fully_qualified_name {
4c105333	71	my $code = shift;
4c105333	72	$code->package_name . '::' . $code->name;
96ceced8	73	}
96ceced8	74
4c105333	75	# NOTE:
	76	# the Class::MOP bootstrap
	77	# will create this for us
	78	# - SL
	79	# sub clone { ... }
	80
8b978dd5	81	1;
	82
	83	__END__
	84
	85	=pod
	86
32202ce2	87	=head1 NAME
8b978dd5	88
	89	Class::MOP::Method - Method Meta Object
	90
8b978dd5	91	=head1 DESCRIPTION
8b978dd5	92
32202ce2	93	The Method Protocol is very small, since methods in Perl 5 are just
32202ce2	94	subroutines within the particular package. We provide a very basic
86482605	95	introspection interface.
fe122940	96
2eb717d5	97	=head1 METHODS
2eb717d5	98
de19f115	99	=head2 Introspection
2eb717d5	100
de19f115	101	=over 4
fe122940	102
2eb717d5	103	=item B<meta>
2eb717d5	104
32202ce2	105	This will return a B<Class::MOP::Class> instance which is related
fe122940	106	to this class.
fe122940	107
2eb717d5	108	=back
2eb717d5	109
de19f115	110	=head2 Construction
	111
	112	=over 4
	113
4c105333	114	=item B<wrap ($code, %params)>
127d39a7	115
32202ce2	116	This is the basic constructor, it returns a B<Class::MOP::Method>
32202ce2	117	instance which wraps the given C<$code> reference. You can also
4c105333	118	set the C<package_name> and C<name> attributes using the C<%params>.
32202ce2	119	If these are not set, then thier accessors will attempt to figure
4c105333	120	it out using the C<Class::MOP::get_code_info> function.
	121
	122	=item B<clone (%params)>
	123
32202ce2	124	This will make a copy of the object, allowing you to override
4c105333	125	any values by stuffing them in C<%params>.
de19f115	126
de19f115	127	=back
	128
	129	=head2 Informational
	130
	131	=over 4
	132
7855ddba	133	=item B<body>
7855ddba	134
127d39a7	135	This returns the actual CODE reference of the particular instance.
127d39a7	136
de19f115	137	=item B<name>
de19f115	138
127d39a7	139	This returns the name of the CODE reference.
127d39a7	140
de19f115	141	=item B<package_name>
de19f115	142
127d39a7	143	This returns the package name that the CODE reference is attached to.
127d39a7	144
96ceced8	145	=item B<fully_qualified_name>
96ceced8	146
127d39a7	147	This returns the fully qualified name of the CODE reference.
127d39a7	148
96ceced8	149	=back
96ceced8	150
1a09d9cc	151	=head1 AUTHORS
8b978dd5	152
a2e85e6c	153	Stevan Little E<lt>stevan@iinteractive.comE<gt>
8b978dd5	154
	155	=head1 COPYRIGHT AND LICENSE
	156
69e3ab0a	157	Copyright 2006-2008 by Infinity Interactive, Inc.
8b978dd5	158
	159	L<http://www.iinteractive.com>
	160
	161	This library is free software; you can redistribute it and/or modify
32202ce2	162	it under the same terms as Perl itself.
8b978dd5	163
16e960bd	164	=cut
16e960bd	165