-#!/usr/bin/env perl
package Mouse::Meta::Attribute;
use strict;
use warnings;
-use Carp 'confess';
-use Scalar::Util 'blessed';
+use Carp ();
+use Scalar::Util qw(weaken);
-sub new {
- my $class = shift;
- my %args = @_;
+use Mouse::Util;
- my $name = $args{name};
+use Mouse::Meta::TypeConstraint;
+use Mouse::Meta::Method::Accessor;
- $args{init_arg} = $name
- unless exists $args{init_arg};
-
- $args{is} ||= '';
+sub BUILDARGS{
+ my $class = shift;
+ my $name = shift;
+ my %args = (@_ == 1) ? %{$_[0]} : @_;
- bless \%args, $class;
-}
+ $args{name} = $name;
-sub name { $_[0]->{name} }
-sub class { $_[0]->{class} }
-sub _is_metadata { $_[0]->{is} }
-sub is_required { $_[0]->{required} }
-sub default { $_[0]->{default} }
-sub is_lazy { $_[0]->{lazy} }
-sub is_lazy_build { $_[0]->{lazy_build} }
-sub predicate { $_[0]->{predicate} }
-sub clearer { $_[0]->{clearer} }
-sub handles { $_[0]->{handles} }
-sub is_weak_ref { $_[0]->{weak_ref} }
-sub init_arg { $_[0]->{init_arg} }
-sub type_constraint { $_[0]->{type_constraint} }
-sub trigger { $_[0]->{trigger} }
-sub builder { $_[0]->{builder} }
-sub should_auto_deref { $_[0]->{auto_deref} }
-
-sub has_default { exists $_[0]->{default} }
-sub has_predicate { exists $_[0]->{predicate} }
-sub has_clearer { exists $_[0]->{clearer} }
-sub has_handles { exists $_[0]->{handles} }
-sub has_type_constraint { exists $_[0]->{type_constraint} }
-sub has_trigger { exists $_[0]->{trigger} }
-sub has_builder { exists $_[0]->{builder} }
+ # XXX: for backward compatibility (with method modifiers)
+ if($class->can('canonicalize_args') != \&canonicalize_args){
+ %args = $class->canonicalize_args($name, %args);
+ }
-sub _create_args {
- $_[0]->{_create_args} = $_[1] if @_ > 1;
- $_[0]->{_create_args}
+ return \%args;
}
-sub generate_accessor {
- my $attribute = shift;
+sub new {
+ my $class = shift;
+ my $args = $class->BUILDARGS(@_);
+
+ my $name = $args->{name};
- my $name = $attribute->name;
- my $key = $name;
- my $default = $attribute->default;
- my $type = $attribute->type_constraint;
- my $constraint = $attribute->find_type_constraint;
- my $builder = $attribute->builder;
+ # taken from Class::MOP::Attribute::new
- my $trigger = $attribute->trigger;
- my $before = $trigger->{before};
- my $after = $trigger->{after};
- my $around = $trigger->{around};
+ defined($name)
+ or $class->throw_error('You must provide a name for the attribute');
- my $accessor = 'sub {
- my $self = shift;';
+ if(!exists $args->{init_arg}){
+ $args->{init_arg} = $name;
+ }
- if ($attribute->_is_metadata eq 'rw') {
- $accessor .= 'if (@_) {
- local $_ = $_[0];';
+ # 'required' requires eigher 'init_arg', 'builder', or 'default'
+ my $can_be_required = defined( $args->{init_arg} );
- if ($before) {
- $accessor .= '$before->($self, $_, $attribute);';
- }
+ if(exists $args->{builder}){
+ $class->throw_error('builder must be a defined scalar value which is a method name')
+ if ref $args->{builder} || !(defined $args->{builder});
- if ($around) {
- $accessor .= '$around->(sub {
- my $self = shift;
- $_ = $_[0];
- ';
+ $can_be_required++;
+ }
+ elsif(exists $args->{default}){
+ if(ref $args->{default} && ref($args->{default}) ne 'CODE'){
+ $class->throw_error("References are not allowed as default values, you must "
+ . "wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])");
}
+ $can_be_required++;
+ }
- if ($constraint) {
- $accessor .= 'unless ($constraint->()) {
- my $display = defined($_) ? overload::StrVal($_) : "undef";
- Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display");
- }'
- }
+ if( $args->{required} && !$can_be_required ) {
+ $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
+ }
- $accessor .= '$self->{$key} = $_;';
+ # taken from Mouse::Meta::Attribute->new and _process_args->
- if ($attribute->is_weak_ref) {
- $accessor .= 'Scalar::Util::weaken($self->{$key}) if ref($self->{$key});';
- }
+ if(exists $args->{is}){
+ my $is = $args->{is};
- if ($around) {
- $accessor .= '}, $self, $_, $attribute);';
+ if($is eq 'ro'){
+ $args->{reader} ||= $name;
}
-
- if ($after) {
- $accessor .= '$after->($self, $_, $attribute);';
+ elsif($is eq 'rw'){
+ if(exists $args->{writer}){
+ $args->{reader} ||= $name;
+ }
+ else{
+ $args->{accessor} ||= $name;
+ }
}
+ elsif($is eq 'bare'){
+ # do nothing, but don't complain (later) about missing methods
+ }
+ else{
+ $is = 'undef' if !defined $is;
+ $class->throw_error("I do not understand this option (is => $is) on attribute ($name)");
+ }
+ }
- $accessor .= '}';
+ my $tc;
+ if(exists $args->{isa}){
+ $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
}
- else {
- $accessor .= 'confess "Cannot assign a value to a read-only accessor" if @_;';
+ elsif(exists $args->{does}){
+ $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
}
+ $tc = $args->{type_constraint};
- if ($attribute->is_lazy) {
- $accessor .= '$self->{$key} = ';
-
- $accessor .= $attribute->has_builder
- ? '$self->$builder'
- : ref($default) eq 'CODE'
- ? '$default->($self)'
- : '$default';
+ if($args->{coerce}){
+ defined($tc)
+ || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
- $accessor .= ' if !exists($self->{$key});';
+ $args->{weak_ref}
+ && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
}
- if ($attribute->should_auto_deref) {
- if ($attribute->type_constraint eq 'ArrayRef') {
- $accessor .= 'if (wantarray) {
- return @{ $self->{$key} || [] };
- }';
+ if ($args->{lazy_build}) {
+ exists($args->{default})
+ && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
+
+ $args->{lazy} = 1;
+ $args->{builder} ||= "_build_${name}";
+ if ($name =~ /^_/) {
+ $args->{clearer} ||= "_clear${name}";
+ $args->{predicate} ||= "_has${name}";
}
else {
- $accessor .= 'if (wantarray) {
- return %{ $self->{$key} || {} };
- }';
+ $args->{clearer} ||= "clear_${name}";
+ $args->{predicate} ||= "has_${name}";
}
}
- $accessor .= 'return $self->{$key};
- }';
+ if ($args->{auto_deref}) {
+ defined($tc)
+ || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
- return eval $accessor;
-}
+ ( $tc->is_a_type_of('ArrayRef') || $tc->is_a_type_of('HashRef') )
+ || $class->throw_error("You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)");
+ }
-sub generate_predicate {
- my $attribute = shift;
- my $key = $attribute->name;
+ if (exists $args->{trigger}) {
+ ('CODE' eq ref $args->{trigger})
+ || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
+ }
- my $predicate = 'sub { exists($_[0]->{$key}) }';
+ if ($args->{lazy}) {
+ (exists $args->{default} || defined $args->{builder})
+ || $class->throw_error("You cannot have lazy attribute ($name) without specifying a default value for it");
+ }
- return eval $predicate;
-}
+ my $instance = bless $args, $class;
-sub generate_clearer {
- my $attribute = shift;
- my $key = $attribute->name;
+ # extra attributes
+ if($class ne __PACKAGE__){
+ $class->meta->_initialize_instance($instance, $args);
+ }
- my $predicate = 'sub { delete($_[0]->{$key}) }';
+# XXX: there is no fast way to check attribute validity
+# my @bad = ...;
+# if(@bad){
+# @bad = sort @bad;
+# Carp::cluck("Found unknown argument(s) passed to '$name' attribute constructor in '$class': @bad");
+# }
- return eval $predicate;
+ return $instance
}
-sub generate_handles {
- my $attribute = shift;
- my $reader = $attribute->name;
- my %handles = $attribute->_canonicalize_handles($attribute->handles);
+sub does {
+ my ($self, $role_name) = @_;
+ my $meta = Mouse::Meta::Class->initialize(ref($self) || $self);
- my %method_map;
+ (defined $role_name)
+ || $meta->throw_error("You must supply a role name to does()");
- for my $local_method (keys %handles) {
- my $remote_method = $handles{$local_method};
+ return $meta->does_role($role_name);
+};
- my $method = 'sub {
- my $self = shift;
- $self->$reader->$remote_method(@_)
- }';
-
- $method_map{$local_method} = eval $method;
- }
-
- return \%method_map;
-}
-
-sub create {
- my ($self, $class, $name, %args) = @_;
+# readers
- $args{name} = $name;
- $args{class} = $class;
+sub name { $_[0]->{name} }
+sub associated_class { $_[0]->{associated_class} }
- %args = $self->canonicalize_args($name, %args);
- $self->validate_args($name, \%args);
+sub accessor { $_[0]->{accessor} }
+sub reader { $_[0]->{reader} }
+sub writer { $_[0]->{writer} }
+sub predicate { $_[0]->{predicate} }
+sub clearer { $_[0]->{clearer} }
+sub handles { $_[0]->{handles} }
- $args{type_constraint} = delete $args{isa}
- if exists $args{isa};
+sub _is_metadata { $_[0]->{is} }
+sub is_required { $_[0]->{required} }
+sub default { $_[0]->{default} }
+sub is_lazy { $_[0]->{lazy} }
+sub is_lazy_build { $_[0]->{lazy_build} }
+sub is_weak_ref { $_[0]->{weak_ref} }
+sub init_arg { $_[0]->{init_arg} }
+sub type_constraint { $_[0]->{type_constraint} }
- my $attribute = $self->new(%args);
- $attribute->_create_args(\%args);
+sub trigger { $_[0]->{trigger} }
+sub builder { $_[0]->{builder} }
+sub should_auto_deref { $_[0]->{auto_deref} }
+sub should_coerce { $_[0]->{coerce} }
- my $meta = $class->meta;
+sub get_read_method { $_[0]->{reader} || $_[0]->{accessor} }
+sub get_write_method { $_[0]->{writer} || $_[0]->{accessor} }
- $meta->add_attribute($attribute);
+# predicates
- # install an accessor
- if ($attribute->_is_metadata eq 'rw' || $attribute->_is_metadata eq 'ro') {
- my $accessor = $attribute->generate_accessor;
- no strict 'refs';
- *{ $class . '::' . $name } = $accessor;
- }
+sub has_accessor { exists $_[0]->{accessor} }
+sub has_reader { exists $_[0]->{reader} }
+sub has_writer { exists $_[0]->{writer} }
+sub has_predicate { exists $_[0]->{predicate} }
+sub has_clearer { exists $_[0]->{clearer} }
+sub has_handles { exists $_[0]->{handles} }
- for my $method (qw/predicate clearer/) {
- my $predicate = "has_$method";
- if ($attribute->$predicate) {
- my $generator = "generate_$method";
- my $coderef = $attribute->$generator;
- no strict 'refs';
- *{ $class . '::' . $attribute->$method } = $coderef;
- }
- }
+sub has_default { exists $_[0]->{default} }
+sub has_type_constraint { exists $_[0]->{type_constraint} }
+sub has_trigger { exists $_[0]->{trigger} }
+sub has_builder { exists $_[0]->{builder} }
- if ($attribute->has_handles) {
- my $method_map = $attribute->generate_handles;
- for my $method_name (keys %$method_map) {
- no strict 'refs';
- *{ $class . '::' . $method_name } = $method_map->{$method_name};
- }
- }
+sub has_read_method { exists $_[0]->{reader} || exists $_[0]->{accessor} }
+sub has_write_method { exists $_[0]->{writer} || exists $_[0]->{accessor} }
- return $attribute;
+sub _create_args {
+ $_[0]->{_create_args} = $_[1] if @_ > 1;
+ $_[0]->{_create_args}
}
-sub canonicalize_args {
- my $self = shift;
- my $name = shift;
- my %args = @_;
+sub accessor_metaclass { 'Mouse::Meta::Method::Accessor' }
- if ($args{lazy_build}) {
- $args{lazy} = 1;
- $args{required} = 1;
- $args{builder} = "_build_${name}"
- if !exists($args{builder});
- if ($name =~ /^_/) {
- $args{clearer} = "_clear${name}" if !exists($args{clearer});
- $args{predicate} = "_has${name}" if !exists($args{predicate});
- }
- else {
- $args{clearer} = "clear_${name}" if !exists($args{clearer});
- $args{predicate} = "has_${name}" if !exists($args{predicate});
- }
+sub interpolate_class_and_new{
+ my($class, $name, $args) = @_;
+
+ if(my $metaclass = delete $args->{metaclass}){
+ $class = Mouse::Util::resolve_metaclass_alias( Attribute => $metaclass );
}
- return %args;
-}
-sub validate_args {
- my $self = shift;
- my $name = shift;
- my $args = shift;
-
- confess "You can not use lazy_build and default for the same attribute ($name)"
- if $args->{lazy_build} && exists $args->{default};
+ if(my $traits_ref = delete $args->{traits}){
+ my @traits;
+ for (my $i = 0; $i < @{$traits_ref}; $i++) {
+ my $trait = Mouse::Util::resolve_metaclass_alias(Attribute => $traits_ref->[$i], trait => 1);
- confess "You cannot have lazy attribute ($name) without specifying a default value for it"
- if $args->{lazy}
- && !exists($args->{default})
- && !exists($args->{builder});
+ next if $class->does($trait);
- confess "References are not allowed as default values, you must wrap the default of '$name' in a CODE reference (ex: sub { [] } and not [])"
- if ref($args->{default})
- && ref($args->{default}) ne 'CODE';
+ push @traits, $trait;
- confess "You cannot auto-dereference without specifying a type constraint on attribute ($name)"
- if $args->{auto_deref} && !exists($args->{isa});
+ # are there options?
+ push @traits, $traits_ref->[++$i]
+ if ref($traits_ref->[$i+1]);
+ }
- confess "You cannot auto-dereference anything other than a ArrayRef or HashRef on attribute ($name)"
- if $args->{auto_deref}
- && $args->{isa} ne 'ArrayRef'
- && $args->{isa} ne 'HashRef';
+ if (@traits) {
+ $class = Mouse::Meta::Class->create_anon_class(
+ superclasses => [ $class ],
+ roles => \@traits,
+ cache => 1,
+ )->name;
- if ($args->{trigger}) {
- if (ref($args->{trigger}) eq 'CODE') {
- $args->{trigger} = {
- after => $args->{trigger},
- };
+ $args->{traits} = \@traits;
}
-
- confess "Trigger must be a CODE or HASH ref on attribute ($name)"
- if ref($args->{trigger}) ne 'HASH';
}
- return 1;
+ return $class->new($name, $args);
}
-sub find_type_constraint {
- my $self = shift;
- my $type = $self->type_constraint;
+sub canonicalize_args{
+ my ($self, $name, %args) = @_;
+
+ Carp::cluck("$self->canonicalize_args has been deprecated."
+ . "Use \$self->BUILDARGS instead.");
- return unless $type;
+ return %args;
+}
- my $checker = Mouse::TypeRegistry->optimized_constraints->{$type};
- return $checker if $checker;
+sub create {
+ my ($self, $class, $name, %args) = @_;
- return sub { blessed($_) && blessed($_) eq $type };
+ Carp::cluck("$self->create has been deprecated."
+ . "Use \$meta->add_attribute and \$attr->install_accessors instead.");
+
+ # noop
+ return $self;
}
-sub verify_type_constraint {
- my $self = shift;
- local $_ = shift;
+sub verify_against_type_constraint {
+ my ($self, $value) = @_;
+ my $tc = $self->type_constraint;
+ return 1 unless $tc;
- my $type = $self->type_constraint
- or return 1;
- my $constraint = $self->find_type_constraint;
+ local $_ = $value;
+ return 1 if $tc->check($value);
- return 1 if $constraint->($_);
+ $self->verify_type_constraint_error($self->name, $value, $tc);
+}
- my $name = $self->name;
- my $display = defined($_) ? overload::StrVal($_) : 'undef';
- Carp::confess("Attribute ($name) does not pass the type constraint because: Validation failed for \'$type\' failed with value $display");
+sub verify_type_constraint_error {
+ my($self, $name, $value, $type) = @_;
+ $self->throw_error("Attribute ($name) does not pass the type constraint because: " . $type->get_message($value));
+}
+
+sub coerce_constraint { ## my($self, $value) = @_;
+ my $type = $_[0]->{type_constraint}
+ or return $_[1];
+ return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $_[0]->type_constraint, $_[1]);
}
sub _canonicalize_handles {
return map { $_ => $_ } @$handles;
}
else {
- confess "Unable to canonicalize the 'handles' option with $handles";
+ $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
}
}
+sub clone_and_inherit_options{
+ my $self = shift;
+ my $name = shift;
+
+ return ref($self)->new($name, %{$self}, @_ == 1 ? %{$_[0]} : @_);
+}
+
sub clone_parent {
my $self = shift;
my $class = shift;
my $name = shift;
my %args = ($self->get_parent_args($class, $name), @_);
+ Carp::cluck("$self->clone_parent has been deprecated."
+ . "Use \$meta->add_attribute and \$attr->install_accessors instead.");
+
+
$self->create($class, $name, %args);
}
my $class = shift;
my $name = shift;
- for my $super ($class->meta->linearized_isa) {
+ for my $super ($class->linearized_isa) {
my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
or next;
return %{ $super_attr->_create_args };
}
- confess "Could not find an attribute by the name of '$name' to inherit from";
+ $self->throw_error("Could not find an attribute by the name of '$name' to inherit from");
+}
+
+sub install_accessors{
+ my($attribute) = @_;
+
+ my $metaclass = $attribute->{associated_class};
+ my $generator_class = $attribute->accessor_metaclass;
+
+ foreach my $type(qw(accessor reader writer predicate clearer handles)){
+ if(exists $attribute->{$type}){
+ my $installer = '_install_' . $type;
+ $generator_class->$installer($attribute, $attribute->{$type}, $metaclass);
+ $attribute->{associated_methods}++;
+ }
+ }
+
+ if($attribute->can('create') != \&create){
+ $attribute->create($metaclass, $attribute->name, %{$attribute});
+ }
+
+ return;
+}
+
+sub throw_error{
+ my $self = shift;
+
+ my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class';
+ $metaclass->throw_error(@_, depth => 1);
}
1;
=head2 name -> AttributeName
-=head2 class -> OwnerClass
+=head2 associated_class -> OwnerClass
=head2 is_required -> Bool
Informational methods.
-=head2 generate_accessor -> CODE
-
-Creates a new code reference for the attribute's accessor.
-
-=head2 generate_predicate -> CODE
-
-Creates a new code reference for the attribute's predicate.
-
-=head2 generate_clearer -> CODE
-
-Creates a new code reference for the attribute's clearer.
-
-=head2 generate_handles -> { MethodName => CODE }
-
-Creates a new code reference for each of the attribute's handles methods.
-
-=head2 find_type_constraint -> CODE
-
-Returns a code reference which can be used to check that a given value passes
-this attribute's type constraint;
-
-=head2 verify_type_constraint Item -> 1 | ERROR
+=head2 verify_against_type_constraint Item -> 1 | ERROR
Checks that the given value passes this attribute's type constraint. Returns 1
on success, otherwise C<confess>es.
projects / gitmo/Mouse.git / blobdiff