lib/Mouse/Meta/Attribute.pm

   1 package Mouse::Meta::Attribute;
   2 use strict;
   3 use warnings;
   4
   5 use Carp ();
   6
   7 use Mouse::Util qw(:meta);
   8
   9 use Mouse::Meta::TypeConstraint;
  10 use Mouse::Meta::Method::Accessor;
  11
  12 sub _process_options{
  13     my($class, $name, $args) = @_;
  14
  15
  16     # XXX: for backward compatibility (with method modifiers)
  17     if($class->can('canonicalize_args') != \&canonicalize_args){
  18         %{$args} = $class->canonicalize_args($name, %{$args});
  19     }
  20
  21     # taken from Class::MOP::Attribute::new
  22
  23     defined($name)
  24         or $class->throw_error('You must provide a name for the attribute');
  25
  26     if(!exists $args->{init_arg}){
  27         $args->{init_arg} = $name;
  28     }
  29
  30     # 'required' requires eigher 'init_arg', 'builder', or 'default'
  31     my $can_be_required = defined( $args->{init_arg} );
  32
  33     if(exists $args->{builder}){
  34         $class->throw_error('builder must be a defined scalar value which is a method name')
  35             if ref $args->{builder} || !(defined $args->{builder});
  36
  37         $can_be_required++;
  38     }
  39     elsif(exists $args->{default}){
  40         if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
  41             $class->throw_error("References are not allowed as default values, you must "
  42                               . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
  43         }
  44         $can_be_required++;
  45     }
  46
  47     if( $args->{required} && !$can_be_required ) {
  48         $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
  49     }
  50
  51     # taken from Mouse::Meta::Attribute->new and _process_args->
  52
  53     if(exists $args->{is}){
  54         my $is = $args->{is};
  55
  56         if($is eq 'ro'){
  57             $args->{reader} ||= $name;
  58         }
  59         elsif($is eq 'rw'){
  60             if(exists $args->{writer}){
  61                 $args->{reader} ||= $name;
  62              }
  63              else{
  64                 $args->{accessor} ||= $name;
  65              }
  66         }
  67         elsif($is eq 'bare'){
  68             # do nothing, but don't complain (later) about missing methods
  69         }
  70         else{
  71             $is = 'undef' if !defined $is;
  72             $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
  73         }
  74     }
  75
  76     my $tc;
  77     if(exists $args->{isa}){
  78         $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
  79     }
  80     elsif(exists $args->{does}){
  81         # TODO
  82         # $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
  83     }
  84     $tc = $args->{type_constraint};
  85
  86     if($args->{coerce}){
  87         defined($tc)
  88             || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
  89
  90         $args->{weak_ref}
  91             && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
  92     }
  93
  94     if ($args->{lazy_build}) {
  95         exists($args->{default})
  96             && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
  97
  98         $args->{lazy}      = 1;
  99         $args->{builder} ||= "_build_${name}";
 100         if ($name =~ /^_/) {
 101             $args->{clearer}   ||= "_clear${name}";
 102             $args->{predicate} ||= "_has${name}";
 103         }
 104         else {
 105             $args->{clearer}   ||= "clear_${name}";
 106             $args->{predicate} ||= "has_${name}";
 107         }
 108     }
 109
 110     if ($args->{auto_deref}) {
 111         defined($tc)
 112             || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
 113
 114         ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') )
 115             || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
 116     }
 117
 118     if (exists $args->{trigger}) {
 119         ('CODE' eq ref $args->{trigger})
 120             || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
 121     }
 122
 123     if ($args->{lazy}) {
 124         (exists $args->{default} || defined $args->{builder})
 125             || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
 126     }
 127
 128     return;
 129 }
 130
 131 sub new {
 132     my $class = shift;
 133     my $name  = shift;
 134
 135     my %args  = (@_ == 1) ? %{ $_[0] } : @_;
 136
 137     $class->_process_options($name, \%args);
 138
 139     $args{name} = $name;
 140
 141     my $instance = bless \%args, $class;
 142
 143     # extra attributes
 144     if($class ne __PACKAGE__){
 145         $class->meta->_initialize_instance($instance,\%args);
 146     }
 147
 148 # XXX: there is no fast way to check attribute validity
 149 #    my @bad = ...;
 150 #    if(@bad){
 151 #        @bad = sort @bad;
 152 #        Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad");
 153 #    }
 154
 155     return $instance
 156 }
 157
 158 # readers
 159
 160 sub name                 { $_[0]->{name}                   }
 161 sub associated_class     { $_[0]->{associated_class}       }
 162
 163 sub accessor             { $_[0]->{accessor}               }
 164 sub reader               { $_[0]->{reader}                 }
 165 sub writer               { $_[0]->{writer}                 }
 166 sub predicate            { $_[0]->{predicate}              }
 167 sub clearer              { $_[0]->{clearer}                }
 168 sub handles              { $_[0]->{handles}                }
 169
 170 sub _is_metadata         { $_[0]->{is}                     }
 171 sub is_required          { $_[0]->{required}               }
 172 sub default              { $_[0]->{default}                }
 173 sub is_lazy              { $_[0]->{lazy}                   }
 174 sub is_lazy_build        { $_[0]->{lazy_build}             }
 175 sub is_weak_ref          { $_[0]->{weak_ref}               }
 176 sub init_arg             { $_[0]->{init_arg}               }
 177 sub type_constraint      { $_[0]->{type_constraint}        }
 178
 179 sub trigger              { $_[0]->{trigger}                }
 180 sub builder              { $_[0]->{builder}                }
 181 sub should_auto_deref    { $_[0]->{auto_deref}             }
 182 sub should_coerce        { $_[0]->{coerce}                 }
 183
 184 sub get_read_method      { $_[0]->{reader} || $_[0]->{accessor} }
 185 sub get_write_method     { $_[0]->{writer} || $_[0]->{accessor} }
 186
 187 # predicates
 188
 189 sub has_accessor         { exists $_[0]->{accessor}        }
 190 sub has_reader           { exists $_[0]->{reader}          }
 191 sub has_writer           { exists $_[0]->{writer}          }
 192 sub has_predicate        { exists $_[0]->{predicate}       }
 193 sub has_clearer          { exists $_[0]->{clearer}         }
 194 sub has_handles          { exists $_[0]->{handles}         }
 195
 196 sub has_default          { exists $_[0]->{default}         }
 197 sub has_type_constraint  { exists $_[0]->{type_constraint} }
 198 sub has_trigger          { exists $_[0]->{trigger}         }
 199 sub has_builder          { exists $_[0]->{builder}         }
 200
 201 sub has_read_method      { exists $_[0]->{reader} || exists $_[0]->{accessor} }
 202 sub has_write_method     { exists $_[0]->{writer} || exists $_[0]->{accessor} }
 203
 204 sub _create_args {
 205     $_[0]->{_create_args} = $_[1] if @_ > 1;
 206     $_[0]->{_create_args}
 207 }
 208
 209 sub interpolate_class{
 210     my($class, $name, $args) = @_;
 211
 212     if(my $metaclass = delete $args->{metaclass}){
 213         $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass );
 214     }
 215
 216     my @traits;
 217     if(my $traits_ref = delete $args->{traits}){
 218
 219         for (my $i = 0; $i < @{$traits_ref}; $i++) {
 220             my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1);
 221
 222             next if $class->does($trait);
 223
 224             push @traits, $trait;
 225
 226             # are there options?
 227             push @traits, $traits_ref->[++$i]
 228                 if ref($traits_ref->[$i+1]);
 229         }
 230
 231         if (@traits) {
 232             $class = Mouse::Meta::Class->create_anon_class(
 233                 superclasses => [ $class ],
 234                 roles        => \@traits,
 235                 cache        => 1,
 236             )->name;
 237         }
 238     }
 239
 240     return( $class, @traits );
 241 }
 242
 243 sub canonicalize_args{
 244     my ($self, $name, %args) = @_;
 245
 246     Carp::cluck("$self->canonicalize_args has been deprecated."
 247         . "Use \$self->_process_options instead.")
 248             if _MOUSE_VERBOSE;
 249
 250     return %args;
 251 }
 252
 253 sub create {
 254     my ($self, $class, $name, %args) = @_;
 255
 256     Carp::cluck("$self->create has been deprecated."
 257         . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
 258             if _MOUSE_VERBOSE;
 259
 260     # noop
 261     return $self;
 262 }
 263
 264 sub verify_against_type_constraint {
 265     my ($self, $value) = @_;
 266     my $tc = $self->type_constraint;
 267     return 1 unless $tc;
 268
 269     local $_ = $value;
 270     return 1 if $tc->check($value);
 271
 272     $self->verify_type_constraint_error($self->name, $value, $tc);
 273 }
 274
 275 sub verify_type_constraint_error {
 276     my($self, $name, $value, $type) = @_;
 277     $self->throw_error("Attribute ($name) does not pass the type constraint because: " . $type->get_message($value));
 278 }
 279
 280 sub coerce_constraint { ## my($self, $value) = @_;
 281     my $type = $_[0]->{type_constraint}
 282         or return $_[1];
 283     return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]);
 284 }
 285
 286 sub _canonicalize_handles {
 287     my $self    = shift;
 288     my $handles = shift;
 289
 290     if (ref($handles) eq 'HASH') {
 291         return %$handles;
 292     }
 293     elsif (ref($handles) eq 'ARRAY') {
 294         return map { $_ => $_ } @$handles;
 295     }
 296     else {
 297         $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
 298     }
 299 }
 300
 301 sub clone_and_inherit_options{
 302     my $self = shift;
 303     my $name = shift;
 304
 305     return ref($self)->new($name, %{$self}, (@_ == 1) ? %{$_[0]} : @_);
 306 }
 307
 308 sub clone_parent {
 309     my $self  = shift;
 310     my $class = shift;
 311     my $name  = shift;
 312     my %args  = ($self->get_parent_args($class, $name), @_);
 313
 314     Carp::cluck("$self->clone_parent has been deprecated."
 315         . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
 316         if _MOUSE_VERBOSE;
 317
 318     $self->clone_and_inherited_args($class, $name, %args);
 319 }
 320
 321 sub get_parent_args {
 322     my $self  = shift;
 323     my $class = shift;
 324     my $name  = shift;
 325
 326     for my $super ($class->linearized_isa) {
 327         my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
 328             or next;
 329         return %{ $super_attr->_create_args };
 330     }
 331
 332     $self->throw_error("Could not find an attribute by the name of '$name' to inherit from");
 333 }
 334
 335 sub associate_method{
 336     my ($attribute, $method) = @_;
 337     $attribute->{associated_methods}++;
 338     return;
 339 }
 340
 341 sub install_accessors{
 342     my($attribute) = @_;
 343
 344     my $metaclass       = $attribute->{associated_class};
 345
 346     foreach my $type(qw(accessor reader writer predicate clearer handles)){
 347         if(exists $attribute->{$type}){
 348             my $installer    = '_install_' . $type;
 349
 350             Mouse::Meta::Method::Accessor->$installer($attribute, $attribute->{$type}, $metaclass);
 351
 352             $attribute->{associated_methods}++;
 353         }
 354     }
 355
 356     if($attribute->can('create') != \&create){
 357         # backword compatibility
 358         $attribute->create($metaclass, $attribute->name, %{$attribute});
 359     }
 360
 361     return;
 362 }
 363
 364 sub throw_error{
 365     my $self = shift;
 366
 367     my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class';
 368     $metaclass->throw_error(@_, depth => 1);
 369 }
 370
 371 1;
 372
 373 __END__
 374
 375 =head1 NAME
 376
 377 Mouse::Meta::Attribute - attribute metaclass
 378
 379 =head1 METHODS
 380
 381 =head2 C<< new(%options) -> Mouse::Meta::Attribute >>
 382
 383 Instantiates a new Mouse::Meta::Attribute. Does nothing else.
 384
 385 It adds the following options to the constructor:
 386
 387 =over 4
 388
 389 =item C<< is => 'ro', 'rw', 'bare' >>
 390
 391 This provides a shorthand for specifying the C<reader>, C<writer>, or
 392 C<accessor> names. If the attribute is read-only ('ro') then it will
 393 have a C<reader> method with the same attribute as the name.
 394
 395 If it is read-write ('rw') then it will have an C<accessor> method
 396 with the same name. If you provide an explicit C<writer> for a
 397 read-write attribute, then you will have a C<reader> with the same
 398 name as the attribute, and a C<writer> with the name you provided.
 399
 400 Use 'bare' when you are deliberately not installing any methods
 401 (accessor, reader, etc.) associated with this attribute; otherwise,
 402 Moose will issue a deprecation warning when this attribute is added to a
 403 metaclass.
 404
 405 =item C<< isa => Type >>
 406
 407 This option accepts a type. The type can be a string, which should be
 408 a type name. If the type name is unknown, it is assumed to be a class
 409 name.
 410
 411 This option can also accept a L<Moose::Meta::TypeConstraint> object.
 412
 413 If you I<also> provide a C<does> option, then your C<isa> option must
 414 be a class name, and that class must do the role specified with
 415 C<does>.
 416
 417 =item C<< does => Role >>
 418
 419 This is short-hand for saying that the attribute's type must be an
 420 object which does the named role.
 421
 422 B<This option is not yet supported.>
 423
 424 =item C<< coerce => Bool >>
 425
 426 This option is only valid for objects with a type constraint
 427 (C<isa>). If this is true, then coercions will be applied whenever
 428 this attribute is set.
 429
 430 You can make both this and the C<weak_ref> option true.
 431
 432 =item C<< trigger => CodeRef >>
 433
 434 This option accepts a subroutine reference, which will be called after
 435 the attribute is set.
 436
 437 =item C<< required => Bool >>
 438
 439 An attribute which is required must be provided to the constructor. An
 440 attribute which is required can also have a C<default> or C<builder>,
 441 which will satisfy its required-ness.
 442
 443 A required attribute must have a C<default>, C<builder> or a
 444 non-C<undef> C<init_arg>
 445
 446 =item C<< lazy => Bool >>
 447
 448 A lazy attribute must have a C<default> or C<builder>. When an
 449 attribute is lazy, the default value will not be calculated until the
 450 attribute is read.
 451
 452 =item C<< weak_ref => Bool >>
 453
 454 If this is true, the attribute's value will be stored as a weak
 455 reference.
 456
 457 =item C<< auto_deref => Bool >>
 458
 459 If this is true, then the reader will dereference the value when it is
 460 called. The attribute must have a type constraint which defines the
 461 attribute as an array or hash reference.
 462
 463 =item C<< lazy_build => Bool >>
 464
 465 Setting this to true makes the attribute lazy and provides a number of
 466 default methods.
 467
 468   has 'size' => (
 469       is         => 'ro',
 470       lazy_build => 1,
 471   );
 472
 473 is equivalent to this:
 474
 475   has 'size' => (
 476       is        => 'ro',
 477       lazy      => 1,
 478       builder   => '_build_size',
 479       clearer   => 'clear_size',
 480       predicate => 'has_size',
 481   );
 482
 483 =back
 484
 485 =head2 C<< verify_against_type_constraint(Item) -> TRUE | ERROR >>
 486
 487 Checks that the given value passes this attribute's type constraint. Returns C<true>
 488 on success, otherwise C<confess>es.
 489
 490 =head2 C<< clone_and_inherit_options(options) -> Mouse::Meta::Attribute >>
 491
 492 Creates a new attribute in the owner class, inheriting options from parent classes.
 493 Accessors and helper methods are installed. Some error checking is done.
 494
 495 =head1 SEE ALSO
 496
 497 L<Moose::Meta::Attribute>
 498
 499 =cut
 500