Bump version to 0.65
[gitmo/Class-MOP.git] / lib / Class / MOP / Method / Accessor.pm
index 1c03e31..bf06963 100644 (file)
@@ -7,40 +7,45 @@ use warnings;
 use Carp         'confess';
 use Scalar::Util 'blessed', 'weaken';
 
-our $VERSION   = '0.01';
+our $VERSION   = '0.65';
 our $AUTHORITY = 'cpan:STEVAN';
 
-use base 'Class::MOP::Method';
+use base 'Class::MOP::Method::Generated';
 
 sub new {
     my $class   = shift;
     my %options = @_;
-    
+
     (exists $options{attribute})
         || confess "You must supply an attribute to construct with";
-        
+
     (exists $options{accessor_type})
-        || confess "You must supply an accessor_type to construct with"; 
-        
+        || confess "You must supply an accessor_type to construct with";
+
     (blessed($options{attribute}) && $options{attribute}->isa('Class::MOP::Attribute'))
-        || confess "You must supply an attribute which is a 'Class::MOP::Attribute' instance";    
-        
+        || confess "You must supply an attribute which is a 'Class::MOP::Attribute' instance";
+
+    ($options{package_name} && $options{name})
+        || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT";
+
     my $self = bless {
         # from our superclass
         '&!body'          => undef,
+        '$!package_name' => $options{package_name},
+        '$!name'         => $options{name},        
         # specific to this subclass
         '$!attribute'     => $options{attribute},
         '$!is_inline'     => ($options{is_inline} || 0),
-        '$!accessor_type' => $options{accessor_type},        
+        '$!accessor_type' => $options{accessor_type},
     } => $class;
-    
-    # we don't want this creating 
-    # a cycle in the code, if not 
+
+    # we don't want this creating
+    # a cycle in the code, if not
     # needed
     weaken($self->{'$!attribute'});
-    
-    $self->intialize_body;
-    
+
+    $self->initialize_body;
+
     return $self;
 }
 
@@ -48,20 +53,19 @@ sub new {
 
 sub associated_attribute { (shift)->{'$!attribute'}     }
 sub accessor_type        { (shift)->{'$!accessor_type'} }
-sub is_inline            { (shift)->{'$!is_inline'}     }
 
-## factory 
+## factory
 
-sub intialize_body {
+sub initialize_body {
     my $self = shift;
-    
+
     my $method_name = join "_" => (
-        'generate', 
-        $self->accessor_type, 
+        'generate',
+        $self->accessor_type,
         'method',
         ($self->is_inline ? 'inline' : ())
     );
-    
+
     eval { $self->{'&!body'} = $self->$method_name() };
     die $@ if $@;
 }
@@ -69,7 +73,7 @@ sub intialize_body {
 ## generators
 
 sub generate_accessor_method {
-    my $attr = (shift)->associated_attribute; 
+    my $attr = (shift)->associated_attribute;
     return sub {
         $attr->set_value($_[0], $_[1]) if scalar(@_) == 2;
         $attr->get_value($_[0]);
@@ -77,30 +81,30 @@ sub generate_accessor_method {
 }
 
 sub generate_reader_method {
-    my $attr = (shift)->associated_attribute; 
-    return sub { 
+    my $attr = (shift)->associated_attribute;
+    return sub {
         confess "Cannot assign a value to a read-only accessor" if @_ > 1;
         $attr->get_value($_[0]);
-    };   
+    };
 }
 
 sub generate_writer_method {
-    my $attr = (shift)->associated_attribute; 
+    my $attr = (shift)->associated_attribute;
     return sub {
         $attr->set_value($_[0], $_[1]);
     };
 }
 
 sub generate_predicate_method {
-    my $attr = (shift)->associated_attribute; 
-    return sub { 
+    my $attr = (shift)->associated_attribute;
+    return sub {
         $attr->has_value($_[0])
     };
 }
 
 sub generate_clearer_method {
-    my $attr = (shift)->associated_attribute; 
-    return sub { 
+    my $attr = (shift)->associated_attribute;
+    return sub {
         $attr->clear_value($_[0])
     };
 }
@@ -109,7 +113,7 @@ sub generate_clearer_method {
 
 
 sub generate_accessor_method_inline {
-    my $attr          = (shift)->associated_attribute; 
+    my $attr          = (shift)->associated_attribute;
     my $attr_name     = $attr->name;
     my $meta_instance = $attr->associated_class->instance_metaclass;
 
@@ -123,7 +127,7 @@ sub generate_accessor_method_inline {
 }
 
 sub generate_reader_method_inline {
-    my $attr          = (shift)->associated_attribute; 
+    my $attr          = (shift)->associated_attribute;
     my $attr_name     = $attr->name;
     my $meta_instance = $attr->associated_class->instance_metaclass;
 
@@ -137,7 +141,7 @@ sub generate_reader_method_inline {
 }
 
 sub generate_writer_method_inline {
-    my $attr          = (shift)->associated_attribute; 
+    my $attr          = (shift)->associated_attribute;
     my $attr_name     = $attr->name;
     my $meta_instance = $attr->associated_class->instance_metaclass;
 
@@ -151,12 +155,12 @@ sub generate_writer_method_inline {
 
 
 sub generate_predicate_method_inline {
-    my $attr          = (shift)->associated_attribute; 
+    my $attr          = (shift)->associated_attribute;
     my $attr_name     = $attr->name;
     my $meta_instance = $attr->associated_class->instance_metaclass;
 
-    my $code = eval 'sub {'
-        . 'defined ' . $meta_instance->inline_get_slot_value('$_[0]', "'$attr_name'") . ' ? 1 : 0'
+    my $code = eval 'sub {' .
+       $meta_instance->inline_is_slot_initialized('$_[0]', "'$attr_name'")
     . '}';
     confess "Could not generate inline predicate because : $@" if $@;
 
@@ -164,7 +168,7 @@ sub generate_predicate_method_inline {
 }
 
 sub generate_clearer_method_inline {
-    my $attr          = (shift)->associated_attribute; 
+    my $attr          = (shift)->associated_attribute;
     my $attr_name     = $attr->name;
     my $meta_instance = $attr->associated_class->instance_metaclass;
 
@@ -182,30 +186,85 @@ __END__
 
 =pod
 
-=head1 NAME 
+=head1 NAME
 
 Class::MOP::Method::Accessor - Method Meta Object for accessors
 
 =head1 SYNOPSIS
 
-  # ... more to come later maybe
+    use Class::MOP::Method::Accessor;
+
+    my $reader = Class::MOP::Method::Accessor->new(
+        attribute     => $attribute,
+        is_inline     => 1,
+        accessor_type => 'reader',
+    );
+
+    $reader->body->($instance); # call the reader method
 
 =head1 DESCRIPTION
 
+This is a C<Class::MOP::Method> subclass which is used interally
+by C<Class::MOP::Attribute> to generate accessor code. It can
+handle generation of readers, writers, predicate and clearer
+methods, both as closures and as more optimized inline methods.
+
 =head1 METHODS
 
 =over 4
 
-=item B<new>
+=item B<new (%options)>
+
+This creates the method based on the criteria in C<%options>,
+these options are:
+
+=over 4
+
+=item I<attribute>
+
+This must be an instance of C<Class::MOP::Attribute> which this
+accessor is being generated for. This paramter is B<required>.
+
+=item I<accessor_type>
 
-=item B<intialize_body>
+This is a string from the following set; reader, writer, accessor,
+predicate or clearer. This is used to determine which type of
+method is to be generated.
+
+=item I<is_inline>
+
+This is a boolean to indicate if the method should be generated
+as a closure, or as a more optimized inline version.
+
+=back
 
 =item B<accessor_type>
 
+This returns the accessor type which was passed into C<new>.
+
 =item B<is_inline>
 
+This returns the boolean which was passed into C<new>.
+
 =item B<associated_attribute>
 
+This returns the attribute instance which was passed into C<new>.
+
+=item B<initialize_body>
+
+This will actually generate the method based on the specified
+criteria passed to the constructor.
+
+=back
+
+=head2 Method Generators
+
+These methods will generate appropriate code references for
+the various types of accessors which are supported by
+C<Class::MOP::Attribute>. The names pretty much explain it all.
+
+=over 4
+
 =item B<generate_accessor_method>
 
 =item B<generate_accessor_method_inline>
@@ -234,12 +293,12 @@ Stevan Little E<lt>stevan@iinteractive.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