lib/Moose/Object.pm

   1
   2 package Moose::Object;
   3
   4 use strict;
   5 use warnings;
   6
   7 use if ( not our $__mx_is_compiled ), 'Moose::Meta::Class';
   8 use if ( not our $__mx_is_compiled ), metaclass => 'Moose::Meta::Class';
   9
  10 use Carp 'confess';
  11
  12 our $VERSION   = '0.13';
  13 our $AUTHORITY = 'cpan:STEVAN';
  14
  15 sub new {
  16     my $class = shift;
  17     my %params;
  18     if (scalar @_ == 1) {
  19         if (defined $_[0]) {
  20             (ref($_[0]) eq 'HASH')
  21                 || confess "Single parameters to new() must be a HASH ref";
  22             %params = %{$_[0]};
  23         }
  24     }
  25     else {
  26         %params = @_;
  27     }
  28     my $self = $class->meta->new_object(%params);
  29     $self->BUILDALL(\%params);
  30     return $self;
  31 }
  32
  33 sub BUILDALL {
  34     # NOTE: we ask Perl if we even
  35     # need to do this first, to avoid
  36     # extra meta level calls
  37     return unless $_[0]->can('BUILD');
  38     my ($self, $params) = @_;
  39     foreach my $method (reverse $self->meta->find_all_methods_by_name('BUILD')) {
  40         $method->{code}->body->($self, $params);
  41     }
  42 }
  43
  44 sub DEMOLISHALL {
  45     my $self = shift;
  46     foreach my $method ($self->meta->find_all_methods_by_name('DEMOLISH')) {
  47         $method->{code}->body->($self);
  48     }
  49 }
  50
  51 sub DESTROY {
  52     # NOTE: we ask Perl if we even
  53     # need to do this first, to avoid
  54     # extra meta level calls
  55     return unless $_[0]->can('DEMOLISH');
  56     # if we have an exception here ...
  57     if (my $e = $@) {
  58         # run DEMOLISHALL ourselves, ...
  59         (shift)->DEMOLISHALL;
  60         # then restore the exception ...
  61         $@ = $e;
  62         # and return ...
  63         return;
  64     }
  65     goto &DEMOLISHALL
  66 }
  67
  68 # new does() methods will be created
  69 # as approiate see Moose::Meta::Role
  70 sub does {
  71     my ($self, $role_name) = @_;
  72     (defined $role_name)
  73         || confess "You much supply a role name to does()";
  74     my $meta = $self->meta;
  75     foreach my $class ($meta->class_precedence_list) {
  76         my $m = $meta->initialize($class);
  77         return 1
  78             if $m->can('does_role') && $m->does_role($role_name);
  79     }
  80     return 0;
  81 }
  82
  83 # RANT:
  84 # Cmon, how many times have you written
  85 # the following code while debugging:
  86 #
  87 #  use Data::Dumper;
  88 #  warn Dumper \%thing;
  89 #
  90 # It can get seriously annoying, so why
  91 # not just do this ...
  92 sub dump {
  93     my $self = shift;
  94     require Data::Dumper;
  95     local $Data::Dumper::Maxdepth = shift if @_;
  96     Data::Dumper::Dumper $self;
  97 }
  98
  99 1;
 100
 101 __END__
 102
 103 =pod
 104
 105 =head1 NAME
 106
 107 Moose::Object - The base object for Moose
 108
 109 =head1 DESCRIPTION
 110
 111 This serves as the base object for all Moose classes. Every
 112 effort will be made to ensure that all classes which C<use Moose>
 113 will inherit from this class. It provides a default constructor
 114 and destructor, which run all the BUILD and DEMOLISH methods in
 115 the class tree.
 116
 117 You don't actually I<need> to inherit from this in order to
 118 use Moose though. It is just here to make life easier.
 119
 120 =head1 METHODS
 121
 122 =over 4
 123
 124 =item B<meta>
 125
 126 This will return the metaclass associated with the given class.
 127
 128 =item B<new>
 129
 130 This will create a new instance and call C<BUILDALL>.
 131
 132 =item B<BUILDALL>
 133
 134 This will call every C<BUILD> method in the inheritance hierarchy,
 135 and pass it a hash-ref of the the C<%params> passed to C<new>.
 136
 137 =item B<DEMOLISHALL>
 138
 139 This will call every C<DEMOLISH> method in the inheritance hierarchy.
 140
 141 =item B<does ($role_name)>
 142
 143 This will check if the invocant's class C<does> a given C<$role_name>.
 144 This is similar to C<isa> for object, but it checks the roles instead.
 145
 146 =item B<dump ($maxdepth)>
 147
 148 Cmon, how many times have you written the following code while debugging:
 149
 150  use Data::Dumper;
 151  warn Dumper $obj;
 152
 153 It can get seriously annoying, so why not just use this.
 154
 155 =back
 156
 157 =head1 BUGS
 158
 159 All complex software has bugs lurking in it, and this module is no
 160 exception. If you find a bug please either email me, or add the bug
 161 to cpan-RT.
 162
 163 =head1 AUTHOR
 164
 165 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 166
 167 =head1 COPYRIGHT AND LICENSE
 168
 169 Copyright 2006-2008 by Infinity Interactive, Inc.
 170
 171 L<http://www.iinteractive.com>
 172
 173 This library is free software; you can redistribute it and/or modify
 174 it under the same terms as Perl itself.
 175
 176 =cut