Checking in changes prior to tagging of version 0.88.
[gitmo/Mouse.git] / lib / Mouse / Object.pm
index dcb8590..134be7a 100644 (file)
-#!/usr/bin/env perl
 package Mouse::Object;
-use strict;
-use warnings;
-use MRO::Compat;
-
-use Scalar::Util qw/blessed weaken/;
-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 ($attribute->has_default || $attribute->has_builder) {
-                my $default = $attribute->default;
-
-                unless ($attribute->is_lazy) {
-                    my $builder = $attribute->builder;
-                    my $value = $attribute->has_builder
-                              ? $instance->$builder
-                              : ref($default) eq 'CODE'
-                                  ? $default->()
-                                  : $default;
-
-                    $attribute->verify_type_constraint($value)
-                        if $attribute->has_type_constraint;
-
-                    $instance->{$key} = $value;
-
-                    weaken($instance->{$key})
-                        if $attribute->weak_ref;
-                }
-            }
-            else {
-                if ($attribute->is_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};
-
-            weaken($instance->{$key})
-                if $attribute->weak_ref;
-
-            if ($attribute->has_trigger) {
-                $attribute->trigger->($instance, $args{$key}, $attribute);
-            }
-        }
-    }
-
-    $instance->BUILDALL(\%args);
+use Mouse::Util qw(does dump meta); # enables strict and warnings
+# all the stuff are defined in XS or PP
+1;
+__END__
 
-    return $instance;
-}
+=head1 NAME
 
-sub DESTROY { shift->DEMOLISHALL }
+Mouse::Object - The base object for Mouse classes
 
-sub BUILDALL {
-    my $self = shift;
+=head1 VERSION
 
-    # short circuit
-    return unless $self->can('BUILD');
+This document describes Mouse version 0.88
 
-    no strict 'refs';
+=head1 METHODS
 
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::BUILD' }{CODE}
-            or next;
-        $code->($self, @_);
-    }
-}
+=head2 C<< $class->new(%args | \%args) -> Object >>
 
-sub DEMOLISHALL {
-    my $self = shift;
+Instantiates a new C<Mouse::Object>. This is obviously intended for subclasses.
 
-    # short circuit
-    return unless $self->can('DEMOLISH');
+=head2 C<< $class->BUILDARGS(@args) -> HashRef >>
 
-    no strict 'refs';
+Lets you override the arguments that C<new> takes.
+It must return a HashRef of parameters.
 
-    for my $class ($self->meta->linearized_isa) {
-        my $code = *{ $class . '::DEMOLISH' }{CODE}
-            or next;
-        $code->($self, @_);
-    }
-}
+=head2 C<< $object->BUILDALL(\%args) >>
 
-1;
+Calls C<BUILD> on each class in the class hierarchy. This is called at the
+end of C<new>.
 
-__END__
+=head2 C<< $object->BUILD(\%args) >>
 
-=head1 NAME
+You may put any business logic initialization in BUILD methods. You don't
+need to redispatch or return any specific value.
 
-Mouse::Object - we don't need to steenkin' constructor
+=head2 C<< $object->DEMOLISHALL >>
 
-=head1 METHODS
+Calls C<DEMOLISH> on each class in the class hierarchy. This is called at
+C<DESTROY> time.
 
-=head2 new arguments -> object
+=head2 C<< $object->DEMOLISH >>
 
-Instantiates a new Mouse::Object. This is obviously intended for subclasses.
+You may put any business logic deinitialization in DEMOLISH methods. You don't
+need to redispatch or return any specific value.
 
-=head2 BUILDALL \%args
+=head2 C<< $object->does($role_name) -> Bool >>
 
-Calls L</BUILD> on each class in the class hierarchy. This is called at the
-end of L</new>.
+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 BUILD \%args
+=head2 C<< $object->dump($maxdepth) -> Str >>
 
-You may put any business logic initialization in BUILD methods. You don't
-need to redispatch or return any specific value.
+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 DEMOLISHALL
+=head2 C<< $object->meta() -> MetaClass >>
 
-Calls L</DEMOLISH> on each class in the class hierarchy. This is called at
-L</DESTROY> time.
+This is a method which provides access to the object's metaclass.
 
-=head2 DEMOLISH
+=head1 SEE ALSO
 
-You may put any business logic deinitialization in DEMOLISH methods. You don't
-need to redispatch or return any specific value.
+L<Moose::Object>
 
 =cut