Add descriptions to pods

[gitmo/Mouse.git] / lib / Mouse / Object.pm

diff --git a/lib/Mouse/Object.pm b/lib/Mouse/Object.pm
index 1dd5481..f1cd27e 100644 (file)
--- a/lib/Mouse/Object.pm
+++ b/lib/Mouse/Object.pm
@@ -1,68 +1,40 @@
-#!/usr/bin/env perl
 package Mouse::Object;
 use strict;
 use warnings;
-use MRO::Compat;
 
-use Scalar::Util 'blessed';
-use Carp 'confess';
+use Mouse::Util qw(does dump);
 
 sub new {
     my $class = shift;
-    my %args  = @_;
-    my $instance = bless {}, $class;
-
-    for my $attribute ($class->meta->attributes) {
-        my $key = $attribute->init_arg;
-        my $default;
-
-        if (!exists($args{$key})) {
-            if (exists($attribute->{default}) || exists($attribute->{builder})) {
-                unless ($attribute->{lazy}) {
-                    my $builder = $attribute->{builder};
-                    my $default = exists($attribute->{builder})
-                                ? $instance->$builder
-                                : ref($attribute->{default}) eq 'CODE'
-                                    ? $attribute->{default}->()
-                                    : $attribute->{default};
-
-                    $attribute->verify_type_constraint($default)
-                        if $attribute->has_type_constraint;
-
-                    $instance->{$key} = $default;
-
-                    Scalar::Util::weaken($instance->{$key})
-                        if $attribute->{weak_ref};
-                }
-            }
-            else {
-                if ($attribute->{required}) {
-                    confess "Attribute '$attribute->{name}' is required";
-                }
-            }
-        }
-
-        if (exists($args{$key})) {
-            $attribute->verify_type_constraint($args{$key})
-                if $attribute->has_type_constraint;
-
-            $instance->{$key} = $args{$key};
-
-            Scalar::Util::weaken($instance->{$key})
-                if $attribute->{weak_ref};
-
-            if ($attribute->{trigger}) {
-                $attribute->{trigger}->($instance, $args{$key}, $attribute);
-            }
-        }
-    }
 
-    $instance->BUILDALL(\%args);
+    $class->throw_error('Cannot call new() on an instance') if ref $class;
+
+    my $args = $class->BUILDARGS(@_);
 
+    my $instance = Mouse::Meta::Class->initialize($class)->new_object($args);
+    $instance->BUILDALL($args);
     return $instance;
 }
 
-sub DESTROY { shift->DEMOLISHALL }
+sub BUILDARGS {
+    my $class = shift;
+
+    if (scalar @_ == 1) {
+        (ref($_[0]) eq 'HASH')
+            || $class->meta->throw_error("Single parameters to new() must be a HASH ref");
+
+        return {%{$_[0]}};
+    }
+    else {
+        return {@_};
+    }
+}
+
+sub DESTROY {
+    my $self = shift;
+
+    $self->DEMOLISHALL();
+}
 
 sub BUILDALL {
     my $self = shift;
@@ -70,13 +42,13 @@ sub BUILDALL {
     # short circuit
     return unless $self->can('BUILD');
 
-    no strict 'refs';
-
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::BUILD' }{CODE}
+    for my $class (reverse $self->meta->linearized_isa) {
+        my $build = do{ no strict 'refs'; *{ $class . '::BUILD' }{CODE} }
             or next;
-        $code->($self, @_);
+
+        $self->$build(@_);
     }
+    return;
 }
 
 sub DEMOLISHALL {
@@ -85,13 +57,18 @@ sub DEMOLISHALL {
     # short circuit
     return unless $self->can('DEMOLISH');
 
-    no strict 'refs';
+    # We cannot count on being able to retrieve a previously made
+    # metaclass, _or_ being able to make a new one during global
+    # destruction. However, we should still be able to use mro at
+    # that time (at least tests suggest so ;)
 
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::DEMOLISH' }{CODE}
+    foreach my $class (@{ Mouse::Util::get_linear_isa(ref $self) }) {
+        my $demolish = do{ no strict 'refs'; *{ $class . '::DEMOLISH'}{CODE} }
             or next;
-        $code->($self, @_);
+
+        $self->$demolish();
     }
+    return;
 }
 
 1;
@@ -104,29 +81,57 @@ Mouse::Object - we don't need to steenkin' constructor
 
 =head1 METHODS
 
-=head2 new arguments -> object
+=head2 C<< new (Arguments) -> Object >>
+
+Instantiates a new C<Mouse::Object>. This is obviously intended for subclasses.
 
-Instantiates a new Mouse::Object. This is obviously intended for subclasses.
+=head2 C<< BUILDARGS (Arguments) -> HashRef >>
 
-=head2 BUILDALL \%args
+Lets you override the arguments that C<new> takes. Return a hashref of
+parameters.
 
-Calls L</BUILD> on each class in the class hierarchy. This is called at the
-end of L</new>.
+=head2 C<< BUILDALL (\%args) >>
 
-=head2 BUILD \%args
+Calls C<BUILD> on each class in the class hierarchy. This is called at the
+end of C<new>.
+
+=head2 C<< BUILD (\%args) >>
 
 You may put any business logic initialization in BUILD methods. You don't
 need to redispatch or return any specific value.
 
-=head2 DEMOLISHALL
+=head2 C<< DEMOLISHALL >>
 
-Calls L</DEMOLISH> on each class in the class hierarchy. This is called at
-L</DESTROY> time.
+Calls C<DEMOLISH> on each class in the class hierarchy. This is called at
+C<DESTROY> time.
 
-=head2 DEMOLISH
+=head2 C<< DEMOLISH >>
 
 You may put any business logic deinitialization in DEMOLISH methods. You don't
 need to redispatch or return any specific value.
 
+
+=head2 C<< does ($role_name) -> Bool >>
+
+This will check if the invocant's class B<does> a given C<$role_name>.
+This is similar to "isa" for object, but it checks the roles instead.
+
+=head2 C<<dump ($maxdepth) -> Str >>
+
+From the Moose POD:
+
+    C'mon, 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.
+
+The implementation was lifted directly from Moose::Object.
+
+=head1 SEE ALSO
+
+L<Moose::Object>
+
 =cut