Checking in changes prior to tagging of version 0.88.
[gitmo/Mouse.git] / lib / Mouse / Object.pm
index 82cbec0..134be7a 100644 (file)
-#!/usr/bin/env perl
 package Mouse::Object;
-use strict;
-use warnings;
-use MRO::Compat;
-
-use Scalar::Util 'blessed';
-use Carp 'confess';
-
-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})) {
-                unless ($attribute->{lazy}) {
-                    if (ref($attribute->{default}) eq 'CODE') {
-                        $instance->{$key} = $attribute->{default}->();
-                        Scalar::Util::weaken($instance->{$key})
-                            if $attribute->{weak_ref};
-                    }
-                    else {
-                        $instance->{$key} = $attribute->{default};
-                        Scalar::Util::weaken($instance->{$key})
-                            if $attribute->{weak_ref};
-                    }
-                }
-            }
-            else {
-                if ($attribute->{required}) {
-                    confess "Attribute '$attribute->{name}' is required";
-                }
-            }
-        }
-
-        if (exists($args{$key})) {
-            $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);
-
-    return $instance;
-}
-
-sub DESTROY { shift->DEMOLISHALL }
-
-sub BUILDALL {
-    my $self = shift;
-
-    # short circuit
-    return unless $self->can('BUILD');
-
-    no strict 'refs';
-
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::BUILD' }{CODE}
-            or next;
-        $code->($self, @_);
-    }
-}
-
-sub DEMOLISHALL {
-    my $self = shift;
-
-    # short circuit
-    return unless $self->can('DEMOLISH');
-
-    no strict 'refs';
-
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::DEMOLISH' }{CODE}
-            or next;
-        $code->($self, @_);
-    }
-}
-
+use Mouse::Util qw(does dump meta); # enables strict and warnings
+# all the stuff are defined in XS or PP
 1;
-
 __END__
 
 =head1 NAME
 
-Mouse::Object - we don't need to steenkin' constructor
+Mouse::Object - The base object for Mouse classes
+
+=head1 VERSION
+
+This document describes Mouse version 0.88
 
 =head1 METHODS
 
-=head2 new arguments -> object
+=head2 C<< $class->new(%args | \%args) -> Object >>
 
-Instantiates a new Mouse::Object. This is obviously intended for subclasses.
+Instantiates a new C<Mouse::Object>. This is obviously intended for subclasses.
 
-=head2 BUILDALL \%args
+=head2 C<< $class->BUILDARGS(@args) -> HashRef >>
 
-Calls L</BUILD> on each class in the class hierarchy. This is called at the
-end of L</new>.
+Lets you override the arguments that C<new> takes.
+It must return a HashRef of parameters.
 
-=head2 BUILD \%args
+=head2 C<< $object->BUILDALL(\%args) >>
+
+Calls C<BUILD> on each class in the class hierarchy. This is called at the
+end of C<new>.
+
+=head2 C<< $object->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<< $object->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<< $object->DEMOLISH >>
 
 You may put any business logic deinitialization in DEMOLISH methods. You don't
 need to redispatch or return any specific value.
 
+=head2 C<< $object->does($role_name) -> Bool >>
+
+This will check if the invocant's class B<does> a given C<$role_name>.
+This is similar to C<isa> for object, but it checks the roles instead.
+
+=head2 C<< $object->dump($maxdepth) -> Str >>
+
+This is a handy utility for dumping an object with Data::Dumper.
+By default, the maximum depth is 3, to avoid making a mess.
+
+=head2 C<< $object->meta() -> MetaClass >>
+
+This is a method which provides access to the object's metaclass.
+
+=head1 SEE ALSO
+
+L<Moose::Object>
+
 =cut