lib/Mouse/Meta/Attribute.pm

   1 package Mouse::Meta::Attribute;
   2 use Mouse::Util qw(:meta); # enables strict and warnings
   3
   4 use Carp ();
   5
   6 use Mouse::Meta::TypeConstraint;
   7
   8 my %valid_options = map { $_ => undef } (
   9   'accessor',
  10   'auto_deref',
  11   'builder',
  12   'clearer',
  13   'coerce',
  14   'default',
  15   'documentation',
  16   'does',
  17   'handles',
  18   'init_arg',
  19   'insertion_order',
  20   'is',
  21   'isa',
  22   'lazy',
  23   'lazy_build',
  24   'name',
  25   'predicate',
  26   'reader',
  27   'required',
  28   'traits',
  29   'trigger',
  30   'type_constraint',
  31   'weak_ref',
  32   'writer',
  33
  34   # internally used
  35   'associated_class',
  36   'associated_methods',
  37
  38   # Moose defines, but Mouse doesn't
  39   #'definition_context',
  40   #'initializer',
  41
  42   # special case for AttributeHelpers
  43   'provides',
  44   'curries',
  45 );
  46
  47 our @CARP_NOT = qw(Mouse::Meta::Class);
  48
  49 sub new {
  50     my $class = shift;
  51     my $name  = shift;
  52
  53     my $args  = $class->Mouse::Object::BUILDARGS(@_);
  54
  55     $class->_process_options($name, $args);
  56
  57     $args->{name} = $name;
  58
  59     # check options
  60     # (1) known by core
  61     my @bad = grep{ !exists $valid_options{$_} } keys %{$args};
  62
  63     # (2) known by subclasses
  64     if(@bad && $class ne __PACKAGE__){
  65         my %valid_attrs = (
  66             map { $_ => undef }
  67             grep { defined }
  68             map { $_->init_arg() }
  69             $class->meta->get_all_attributes()
  70         );
  71         @bad = grep{ !exists $valid_attrs{$_} } @bad;
  72     }
  73
  74     # (3) bad options found
  75     if(@bad){
  76         Carp::carp(
  77             "Found unknown argument(s) passed to '$name' attribute constructor in '$class': "
  78             . Mouse::Util::english_list(@bad));
  79     }
  80
  81     my $self = bless $args, $class;
  82
  83     # extra attributes
  84     if($class ne __PACKAGE__){
  85         $class->meta->_initialize_object($self, $args);
  86     }
  87
  88     return $self;
  89 }
  90
  91 sub has_read_method      { $_[0]->has_reader || $_[0]->has_accessor }
  92 sub has_write_method     { $_[0]->has_writer || $_[0]->has_accessor }
  93
  94 sub interpolate_class{
  95     my($class, $args) = @_;
  96
  97     if(my $metaclass = delete $args->{metaclass}){
  98         $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass );
  99     }
 100
 101     my @traits;
 102     if(my $traits_ref = delete $args->{traits}){
 103
 104         for (my $i = 0; $i < @{$traits_ref}; $i++) {
 105             my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1);
 106
 107             next if $class->does($trait);
 108
 109             push @traits, $trait;
 110
 111             # are there options?
 112             push @traits, $traits_ref->[++$i]
 113                 if ref($traits_ref->[$i+1]);
 114         }
 115
 116         if (@traits) {
 117             $class = Mouse::Meta::Class->create_anon_class(
 118                 superclasses => [ $class ],
 119                 roles        => \@traits,
 120                 cache        => 1,
 121             )->name;
 122         }
 123     }
 124
 125     return( $class, @traits );
 126 }
 127
 128 sub _coerce_and_verify {
 129     #my($self, $value, $instance) = @_;
 130     my($self, $value) = @_;
 131
 132     my $type_constraint = $self->{type_constraint};
 133     return $value if !defined $type_constraint;
 134
 135     if ($self->should_coerce && $type_constraint->has_coercion) {
 136         $value = $type_constraint->coerce($value);
 137     }
 138
 139     $self->verify_against_type_constraint($value);
 140
 141     return $value;
 142 }
 143
 144 sub verify_against_type_constraint {
 145     my ($self, $value) = @_;
 146
 147     my $type_constraint = $self->{type_constraint};
 148     return 1 if !$type_constraint;
 149     return 1 if $type_constraint->check($value);
 150
 151     $self->_throw_type_constraint_error($value, $type_constraint);
 152 }
 153
 154 sub _throw_type_constraint_error {
 155     my($self, $value, $type) = @_;
 156
 157     $self->throw_error(
 158         sprintf q{Attribute (%s) does not pass the type constraint because: %s},
 159             $self->name,
 160             $type->get_message($value),
 161     );
 162 }
 163
 164 sub illegal_options_for_inheritance {
 165     return qw(reader writer accessor clearer predicate);
 166 }
 167
 168 sub clone_and_inherit_options{
 169     my $self = shift;
 170     my $args = $self->Mouse::Object::BUILDARGS(@_);
 171
 172     foreach my $illegal($self->illegal_options_for_inheritance) {
 173         if(exists $args->{$illegal} and exists $self->{$illegal}) {
 174             $self->throw_error("Illegal inherited option: $illegal");
 175         }
 176     }
 177
 178     foreach my $name(keys %{$self}){
 179         if(!exists $args->{$name}){
 180             $args->{$name} = $self->{$name}; # inherit from self
 181         }
 182     }
 183
 184     my($attribute_class, @traits) = ref($self)->interpolate_class($args);
 185     $args->{traits} = \@traits if @traits;
 186
 187     # remove temporary caches
 188     foreach my $attr(keys %{$args}){
 189         if($attr =~ /\A _/xms){
 190             delete $args->{$attr};
 191         }
 192     }
 193
 194     # remove default if lazy_build => 1
 195     if($args->{lazy_build}) {
 196         delete $args->{default};
 197     }
 198
 199     return $attribute_class->new($self->name, $args);
 200 }
 201
 202 sub get_read_method {
 203     return $_[0]->reader || $_[0]->accessor
 204 }
 205 sub get_write_method {
 206     return $_[0]->writer || $_[0]->accessor
 207 }
 208
 209 sub _get_accessor_method_ref {
 210     my($self, $type, $generator) = @_;
 211
 212     my $metaclass = $self->associated_class
 213         || $self->throw_error('No asocciated class for ' . $self->name);
 214
 215     my $accessor = $self->$type();
 216     if($accessor){
 217         return $metaclass->get_method_body($accessor);
 218     }
 219     else{
 220         return $self->accessor_metaclass->$generator($self, $metaclass);
 221     }
 222 }
 223
 224 sub get_read_method_ref{
 225     my($self) = @_;
 226     return $self->{_read_method_ref} ||= $self->_get_accessor_method_ref('get_read_method', '_generate_reader');
 227 }
 228
 229 sub get_write_method_ref{
 230     my($self) = @_;
 231     return $self->{_write_method_ref} ||= $self->_get_accessor_method_ref('get_write_method', '_generate_writer');
 232 }
 233
 234 sub set_value {
 235     my($self, $object, $value) = @_;
 236     return $self->get_write_method_ref()->($object, $value);
 237 }
 238
 239 sub get_value {
 240     my($self, $object) = @_;
 241     return $self->get_read_method_ref()->($object);
 242 }
 243
 244 sub has_value {
 245     my($self, $object) = @_;
 246     my $accessor_ref = $self->{_predicate_ref}
 247         ||= $self->_get_accessor_method_ref('predicate', '_generate_predicate');
 248
 249     return $accessor_ref->($object);
 250 }
 251
 252 sub clear_value {
 253     my($self, $object) = @_;
 254     my $accessor_ref = $self->{_crealer_ref}
 255         ||= $self->_get_accessor_method_ref('clearer', '_generate_clearer');
 256
 257     return $accessor_ref->($object);
 258 }
 259
 260
 261 sub associate_method{
 262     #my($attribute, $method_name) = @_;
 263     my($attribute) = @_;
 264     $attribute->{associated_methods}++;
 265     return;
 266 }
 267
 268 sub install_accessors{
 269     my($attribute) = @_;
 270
 271     my $metaclass      = $attribute->associated_class;
 272     my $accessor_class = $attribute->accessor_metaclass;
 273
 274     foreach my $type(qw(accessor reader writer predicate clearer)){
 275         if(exists $attribute->{$type}){
 276             my $generator = '_generate_' . $type;
 277             my $code      = $accessor_class->$generator($attribute, $metaclass);
 278             $metaclass->add_method($attribute->{$type} => $code);
 279             $attribute->associate_method($attribute->{$type});
 280         }
 281     }
 282
 283     # install delegation
 284     if(exists $attribute->{handles}){
 285         my %handles = $attribute->_canonicalize_handles($attribute->{handles});
 286
 287         while(my($handle, $method_to_call) = each %handles){
 288             if($metaclass->has_method($handle)) {
 289                 $attribute->throw_error("You cannot overwrite a locally defined method ($handle) with a delegation");
 290             }
 291
 292             $metaclass->add_method($handle =>
 293                 $attribute->_make_delegation_method(
 294                     $handle, $method_to_call));
 295
 296             $attribute->associate_method($handle);
 297         }
 298     }
 299
 300     return;
 301 }
 302
 303 sub delegation_metaclass() { ## no critic
 304     'Mouse::Meta::Method::Delegation'
 305 }
 306
 307 sub _canonicalize_handles {
 308     my($self, $handles) = @_;
 309
 310     if (ref($handles) eq 'HASH') {
 311         return %$handles;
 312     }
 313     elsif (ref($handles) eq 'ARRAY') {
 314         return map { $_ => $_ } @$handles;
 315     }
 316     elsif ( ref($handles) eq 'CODE' ) {
 317         my $class_or_role = ( $self->{isa} || $self->{does} )
 318             || $self->throw_error( "Cannot find delegate metaclass for attribute " . $self->name );
 319         return $handles->( $self, Mouse::Meta::Class->initialize("$class_or_role"));
 320     }
 321     elsif (ref($handles) eq 'Regexp') {
 322         my $class_or_role = ($self->{isa} || $self->{does})
 323             || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)");
 324
 325         my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify
 326         return map  { $_ => $_ }
 327                grep { !Mouse::Object->can($_) && $_ =~ $handles }
 328                    Mouse::Util::is_a_metarole($meta)
 329                         ? $meta->get_method_list
 330                         : $meta->get_all_method_names;
 331     }
 332     else {
 333         $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
 334     }
 335 }
 336
 337 sub _make_delegation_method {
 338     my($self, $handle, $method_to_call) = @_;
 339     return Mouse::Util::load_class($self->delegation_metaclass)
 340         ->_generate_delegation($self, $handle, $method_to_call);
 341 }
 342
 343 1;
 344 __END__
 345
 346 =head1 NAME
 347
 348 Mouse::Meta::Attribute - The Mouse attribute metaclass
 349
 350 =head1 VERSION
 351
 352 This document describes Mouse version 0.70
 353
 354 =head1 DESCRIPTION
 355
 356 This is a meta object protocol for Mouse attributes,
 357 which is a subset of Moose::Meta::Attribute.
 358
 359 =head1 METHODS
 360
 361 =head2 C<< new(%options) -> Mouse::Meta::Attribute >>
 362
 363 Instantiates a new Mouse::Meta::Attribute. Does nothing else.
 364
 365 It adds the following options to the constructor:
 366
 367 =over 4
 368
 369 =item C<< is => 'ro', 'rw', 'bare' >>
 370
 371 This provides a shorthand for specifying the C<reader>, C<writer>, or
 372 C<accessor> names. If the attribute is read-only ('ro') then it will
 373 have a C<reader> method with the same attribute as the name.
 374
 375 If it is read-write ('rw') then it will have an C<accessor> method
 376 with the same name. If you provide an explicit C<writer> for a
 377 read-write attribute, then you will have a C<reader> with the same
 378 name as the attribute, and a C<writer> with the name you provided.
 379
 380 Use 'bare' when you are deliberately not installing any methods
 381 (accessor, reader, etc.) associated with this attribute; otherwise,
 382 Moose will issue a deprecation warning when this attribute is added to a
 383 metaclass.
 384
 385 =item C<< isa => Type >>
 386
 387 This option accepts a type. The type can be a string, which should be
 388 a type name. If the type name is unknown, it is assumed to be a class
 389 name.
 390
 391 This option can also accept a L<Moose::Meta::TypeConstraint> object.
 392
 393 If you I<also> provide a C<does> option, then your C<isa> option must
 394 be a class name, and that class must do the role specified with
 395 C<does>.
 396
 397 =item C<< does => Role >>
 398
 399 This is short-hand for saying that the attribute's type must be an
 400 object which does the named role.
 401
 402 B<This option is not yet supported.>
 403
 404 =item C<< coerce => Bool >>
 405
 406 This option is only valid for objects with a type constraint
 407 (C<isa>). If this is true, then coercions will be applied whenever
 408 this attribute is set.
 409
 410 You can make both this and the C<weak_ref> option true.
 411
 412 =item C<< trigger => CodeRef >>
 413
 414 This option accepts a subroutine reference, which will be called after
 415 the attribute is set.
 416
 417 =item C<< required => Bool >>
 418
 419 An attribute which is required must be provided to the constructor. An
 420 attribute which is required can also have a C<default> or C<builder>,
 421 which will satisfy its required-ness.
 422
 423 A required attribute must have a C<default>, C<builder> or a
 424 non-C<undef> C<init_arg>
 425
 426 =item C<< lazy => Bool >>
 427
 428 A lazy attribute must have a C<default> or C<builder>. When an
 429 attribute is lazy, the default value will not be calculated until the
 430 attribute is read.
 431
 432 =item C<< weak_ref => Bool >>
 433
 434 If this is true, the attribute's value will be stored as a weak
 435 reference.
 436
 437 =item C<< auto_deref => Bool >>
 438
 439 If this is true, then the reader will dereference the value when it is
 440 called. The attribute must have a type constraint which defines the
 441 attribute as an array or hash reference.
 442
 443 =item C<< lazy_build => Bool >>
 444
 445 Setting this to true makes the attribute lazy and provides a number of
 446 default methods.
 447
 448   has 'size' => (
 449       is         => 'ro',
 450       lazy_build => 1,
 451   );
 452
 453 is equivalent to this:
 454
 455   has 'size' => (
 456       is        => 'ro',
 457       lazy      => 1,
 458       builder   => '_build_size',
 459       clearer   => 'clear_size',
 460       predicate => 'has_size',
 461   );
 462
 463 =back
 464
 465 =head2 C<< associate_method(MethodName) >>
 466
 467 Associates a method with the attribute. Typically, this is called internally
 468 when an attribute generates its accessors.
 469
 470 Currently the argument I<MethodName> is ignored in Mouse.
 471
 472 =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >>
 473
 474 Checks that the given value passes this attribute's type constraint. Returns C<true>
 475 on success, otherwise C<confess>es.
 476
 477 =head2 C<< clone_and_inherit_options(options) -> Mouse::Meta::Attribute >>
 478
 479 Creates a new attribute in the owner class, inheriting options from parent classes.
 480 Accessors and helper methods are installed. Some error checking is done.
 481
 482 =head2 C<< get_read_method_ref >>
 483
 484 =head2 C<< get_write_method_ref >>
 485
 486 Returns the subroutine reference of a method suitable for reading or
 487 writing the attribute's value in the associated class. These methods
 488 always return a subroutine reference, regardless of whether or not the
 489 attribute is read- or write-only.
 490
 491 =head1 SEE ALSO
 492
 493 L<Moose::Meta::Attribute>
 494
 495 L<Class::MOP::Attribute>
 496
 497 =cut
 498