bump version to 0.75_01
[gitmo/Moose.git] / lib / Moose / Meta / Method / Destructor.pm
index e6c8749..ea644e6 100644 (file)
@@ -4,10 +4,10 @@ package Moose::Meta::Method::Destructor;
 use strict;
 use warnings;
 
-use Carp         'confess';
 use Scalar::Util 'blessed', 'weaken';
 
-our $VERSION   = '0.54';
+our $VERSION   = '0.75_01';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Moose::Meta::Method',
@@ -17,52 +17,56 @@ sub new {
     my $class   = shift;
     my %options = @_;
     
-    (exists $options{options} && ref $options{options} eq 'HASH')
-        || confess "You must pass a hash of options";    
-        
+    (ref $options{options} eq 'HASH')
+        || $class->throw_error("You must pass a hash of options", data => $options{options});
+
     ($options{package_name} && $options{name})
-        || confess "You must supply the package_name and name parameters $Class::MOP::Method::UPGRADE_ERROR_TEXT";        
-    
+        || $class->throw_error("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},              
+        'body'                 => undef, 
+        'package_name'         => $options{package_name},
+        'name'                 => $options{name},              
         # ...
-        '%!options'              => $options{options},        
-        '$!associated_metaclass' => $options{metaclass},
+        'options'              => $options{options},        
+        'associated_metaclass' => $options{metaclass},
     } => $class;
 
     # we don't want this creating 
     # a cycle in the code, if not 
     # needed
-    weaken($self->{'$!associated_metaclass'});    
+    weaken($self->{'associated_metaclass'});    
 
-    $self->initialize_body;
+    $self->_initialize_body;
 
     return $self;    
 }
 
 ## accessors 
 
-sub options              { (shift)->{'%!options'}              }
-sub associated_metaclass { (shift)->{'$!associated_metaclass'} }
+sub options              { (shift)->{'options'}              }
 
 ## method
 
-sub is_needed { 
-    my $self = shift;
-    # if called as a class method
-    # then must pass in a class name
-    unless (blessed $self) {
-        (blessed $_[0] && $_[0]->isa('Class::MOP::Class')) 
-            || confess "When calling is_needed as a class method you must pass a class name";
-        return $_[0]->meta->can('DEMOLISH');
-    }
-    defined $self->{'&!body'} ? 1 : 0 
+sub is_needed {
+    my $self      = shift;
+    my $metaclass = shift;
+
+    ( blessed $metaclass && $metaclass->isa('Class::MOP::Class') )
+        || $self->throw_error(
+        "The is_needed method expected a metaclass object as its arugment");
+
+    return $metaclass->find_method_by_name('DEMOLISH');
 }
 
 sub initialize_body {
+    Carp::cluck('The initialize_body method has been made private.'
+        . " The public version is deprecated and will be removed in a future release.\n");
+    shift->_initialize_body;
+}
+
+sub _initialize_body {
     my $self = shift;
     # TODO:
     # the %options should also include a both 
@@ -88,12 +92,12 @@ sub initialize_body {
     $source .= ";\n" . '}'; 
     warn $source if $self->options->{debug};    
     
-    my $code;
-    {
-        $code = eval $source;
-        confess "Could not eval the destructor :\n\n$source\n\nbecause :\n\n$@" if $@;
-    }
-    $self->{'&!body'} = $code;
+    my $code = $self->_compile_code(
+        environment => {},
+        code => $source,
+    ) or $self->throw_error("Could not eval the destructor :\n\n$source\n\nbecause :\n\n$@", error => $@, data => $source);
+
+    $self->{'body'} = $code;
 }
 
 
@@ -109,28 +113,49 @@ Moose::Meta::Method::Destructor - Method Meta Object for destructors
 
 =head1 DESCRIPTION
 
-This is a subclass of L<Class::MOP::Method> which handles 
-constructing an approprate Destructor method. This is primarily 
-used in the making of immutable metaclasses, otherwise it is 
-not particularly useful.
+This class is a subclass of L<Class::MOP::Class::Generated> that
+provides Moose-specific functionality for inlining destructors.
+
+To understand this class, you should read the the
+L<Class::MOP::Class::Generated> documentation as well.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::Method::Destructor> is a subclass of
+L<Moose::Meta::Method> I<and> L<Class::MOP::Method::Generated>.
 
 =head1 METHODS
 
 =over 4
 
-=item B<new>
+=item B<< Moose::Meta;:Method::Destructor->new(%options) >>
+
+This constructs a new object. It accepts the following options:
 
-=item B<attributes>
+=over 8
 
-=item B<meta_instance>
+=item * package_name
 
-=item B<options>
+The package for the class in which the destructor is being
+inlined. This option is required.
 
-=item B<is_needed>
+=item * name
+
+The name of the destructor method. This option is required.
+
+=item * metaclass
+
+The metaclass for the class this destructor belongs to. This is
+optional, as it can be set later by calling C<<
+$metamethod->attach_to_class >>.
+
+=back
 
-=item B<initialize_body>
+=item B<< Moose::Meta;:Method::Destructor->is_needed($metaclass) >>
 
-=item B<associated_metaclass>
+Given a L<Moose::Meta::Class> object, this method returns a boolean
+indicating whether the class needs a destructor. If the class or any
+of its parents defines a C<DEMOLISH> method, it needs a destructor.
 
 =back
 
@@ -140,7 +165,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2009 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>