for mst and castaway
[gitmo/Moose.git] / lib / Moose / Object.pm
index 6df798f..fe22744 100644 (file)
@@ -3,32 +3,87 @@ package Moose::Object;
 
 use strict;
 use warnings;
-use metaclass;
+
+use Moose::Meta::Class;
+use metaclass 'Moose::Meta::Class';
+
+use Carp 'confess';
+
+our $VERSION   = '0.09';
+our $AUTHORITY = 'cpan:STEVAN';
 
 sub new {
-    my $class  = shift;
-       my %params = @_;
+    my $class = shift;
+    my %params;
+    if (scalar @_ == 1) {
+        if (defined $_[0]) {
+            (ref($_[0]) eq 'HASH')
+                || confess "Single parameters to new() must be a HASH ref";
+            %params = %{$_[0]};
+        }
+    }
+    else {
+        %params = @_;
+    }
        my $self = $class->meta->new_object(%params);
-       $self->BUILDALL(%params);
+       $self->BUILDALL(\%params);
        return $self;
 }
 
 sub BUILDALL {
-       my ($self, %params) = @_;
-       foreach my $method ($self->meta->find_all_methods_by_name('BUILD')) {
-               $method->{method}->($self, %params);
+    # NOTE: we ask Perl if we even 
+    # need to do this first, to avoid
+    # extra meta level calls
+       return unless $_[0]->can('BUILD');    
+       my ($self, $params) = @_;
+       foreach my $method (reverse $self->meta->find_all_methods_by_name('BUILD')) {
+               $method->{code}->($self, $params);
        }
 }
 
 sub DEMOLISHALL {
-       my $self = shift;
+    # NOTE: we ask Perl if we even 
+    # need to do this first, to avoid
+    # extra meta level calls    
+       return unless $_[0]->can('DEMOLISH');    
+       my $self = shift;       
        foreach my $method ($self->meta->find_all_methods_by_name('DEMOLISH')) {
-               $method->{method}->($self);
+               $method->{code}->($self);
        }       
 }
 
 sub DESTROY { goto &DEMOLISHALL }
 
+# new does() methods will be created 
+# as approiate see Moose::Meta::Role
+sub does {
+    my ($self, $role_name) = @_;
+    (defined $role_name)
+        || confess "You much supply a role name to does()";
+    my $meta = $self->meta;
+    foreach my $class ($meta->class_precedence_list) {
+        return 1 
+            if $meta->initialize($class)->does_role($role_name);            
+    }
+    return 0;   
+}
+
+# RANT:
+# Cmon, how many times have you written 
+# the following code while debugging:
+# 
+#  use Data::Dumper; 
+#  warn Dumper \%thing;
+#
+# It can get seriously annoying, so why 
+# not just do this ...
+sub dump { 
+    my $self = shift;
+    require Data::Dumper;
+    $Data::Dumper::Maxdepth = shift if @_;
+    Data::Dumper::Dumper $self;
+}
+
 1;
 
 __END__
@@ -37,24 +92,54 @@ __END__
 
 =head1 NAME
 
-Moose::Object - 
-
-=head1 SYNOPSIS
+Moose::Object - The base object for Moose
 
 =head1 DESCRIPTION
 
+This serves as the base object for all Moose classes. Every 
+effort will be made to ensure that all classes which C<use Moose> 
+will inherit from this class. It provides a default constructor 
+and destructor, which run all the BUILD and DEMOLISH methods in 
+the class tree.
+
+You don't actually I<need> to inherit from this in order to 
+use Moose though. It is just here to make life easier.
+
 =head1 METHODS
 
 =over 4
 
 =item B<meta>
 
+This will return the metaclass associated with the given class.
+
 =item B<new>
 
+This will create a new instance and call C<BUILDALL>.
+
 =item B<BUILDALL>
 
+This will call every C<BUILD> method in the inheritance hierarchy, 
+and pass it a hash-ref of the the C<%params> passed to C<new>.
+
 =item B<DEMOLISHALL>
 
+This will call every C<DEMOLISH> method in the inheritance hierarchy.
+
+=item B<does ($role_name)>
+
+This will check if the invocant's class C<does> a given C<$role_name>. 
+This is similar to C<isa> for object, but it checks the roles instead.
+
+=item B<dump ($maxdepth)>
+
+Cmon, how many times have you written the following code while debugging:
+
+ use Data::Dumper; 
+ warn Dumper $obj;
+
+It can get seriously annoying, so why not just use this.
+
 =back
 
 =head1 BUGS
@@ -63,20 +148,13 @@ All complex software has bugs lurking in it, and this module is no
 exception. If you find a bug please either email me, or add the bug
 to cpan-RT.
 
-=head1 CODE COVERAGE
-
-I use L<Devel::Cover> to test the code coverage of my tests, below is the 
-L<Devel::Cover> report on this module's test suite.
-
-=head1 ACKNOWLEDGEMENTS
-
 =head1 AUTHOR
 
 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006, 2007 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>