use Mouse::Meta::TypeConstraint;
-sub _process_options{
- my($class, $name, $args) = @_;
+my %valid_options = map { $_ => undef } (
+ 'accessor',
+ 'auto_deref',
+ 'builder',
+ 'clearer',
+ 'coerce',
+ 'default',
+ 'documentation',
+ 'does',
+ 'handles',
+ 'init_arg',
+ 'insertion_order',
+ 'is',
+ 'isa',
+ 'lazy',
+ 'lazy_build',
+ 'name',
+ 'predicate',
+ 'reader',
+ 'required',
+ 'traits',
+ 'trigger',
+ 'type_constraint',
+ 'weak_ref',
+ 'writer',
+
+ # internally used
+ 'associated_class',
+ 'associated_methods',
+
+ # Moose defines, but Mouse doesn't
+ #'definition_context',
+ #'initializer',
+
+ # special case for AttributeHelpers
+ 'provides',
+ 'curries',
+);
+
+our @CARP_NOT = qw(Mouse::Meta::Class);
- # XXX: for backward compatibility (with method modifiers)
- if($class->can('canonicalize_args') != \&canonicalize_args){
- %{$args} = $class->canonicalize_args($name, %{$args});
- }
-
- # taken from Class::MOP::Attribute::new
-
- defined($name)
- or $class->throw_error('You must provide a name for the attribute');
-
- if(!exists $args->{init_arg}){
- $args->{init_arg} = $name;
- }
-
- # 'required' requires eigher 'init_arg', 'builder', or 'default'
- my $can_be_required = defined( $args->{init_arg} );
-
- if(exists $args->{builder}){
- # XXX:
- # Moose refuses a CODE ref builder, but Mouse doesn't for backward compatibility
- # This feature will be changed in a future. (gfx)
- $class->throw_error('builder must be a defined scalar value which is a method name')
- #if ref $args->{builder} || !defined $args->{builder};
- if !defined $args->{builder};
-
- $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( $args->{required} && !$can_be_required ) {
- $class->throw_error("You cannot have a required attribute ($name) without a default, builder, or an init_arg");
- }
-
- # taken from Mouse::Meta::Attribute->new and _process_args->
-
- if(exists $args->{is}){
- my $is = $args->{is};
-
- if($is eq 'ro'){
- $args->{reader} ||= $name;
- }
- 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)");
- }
- }
-
- my $tc;
- if(exists $args->{isa}){
- $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint($args->{isa});
- }
- elsif(exists $args->{does}){
- $args->{type_constraint} = Mouse::Util::TypeConstraints::find_or_create_does_type_constraint($args->{does});
- }
- $tc = $args->{type_constraint};
-
- if($args->{coerce}){
- defined($tc)
- || $class->throw_error("You cannot have coercion without specifying a type constraint on attribute ($name)");
+sub new {
+ my $class = shift;
+ my $name = shift;
- $args->{weak_ref}
- && $class->throw_error("You cannot have a weak reference to a coerced value on attribute ($name)");
- }
+ my $args = $class->Mouse::Object::BUILDARGS(@_);
- if ($args->{lazy_build}) {
- exists($args->{default})
- && $class->throw_error("You can not use lazy_build and default for the same attribute ($name)");
+ $class->_process_options($name, $args);
- $args->{lazy} = 1;
- $args->{builder} ||= "_build_${name}";
- if ($name =~ /^_/) {
- $args->{clearer} ||= "_clear${name}";
- $args->{predicate} ||= "_has${name}";
- }
- else {
- $args->{clearer} ||= "clear_${name}";
- $args->{predicate} ||= "has_${name}";
- }
- }
+ $args->{name} = $name;
- if ($args->{auto_deref}) {
- defined($tc)
- || $class->throw_error("You cannot auto-dereference without specifying a type constraint on attribute ($name)");
+ # check options
+ # (1) known by core
+ my @bad = grep{ !exists $valid_options{$_} } keys %{$args};
- ( $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)");
+ # (2) known by subclasses
+ if(@bad && $class ne __PACKAGE__){
+ my %valid_attrs = (
+ map { $_ => undef }
+ grep { defined }
+ map { $_->init_arg() }
+ $class->meta->get_all_attributes()
+ );
+ @bad = grep{ !exists $valid_attrs{$_} } @bad;
}
- if (exists $args->{trigger}) {
- ('CODE' eq ref $args->{trigger})
- || $class->throw_error("Trigger must be a CODE ref on attribute ($name)");
+ # (3) bad options found
+ if(@bad){
+ Carp::carp(
+ "Found unknown argument(s) passed to '$name' attribute constructor in '$class': "
+ . Mouse::Util::english_list(@bad));
}
- 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");
+ my $self = bless $args, $class;
+ if($class ne __PACKAGE__){
+ $class->meta->_initialize_object($self, $args);
}
-
- return;
+ return $self;
}
-sub new {
- my $class = shift;
- my $name = shift;
-
- my %args = (@_ == 1) ? %{ $_[0] } : @_;
-
- $class->_process_options($name, \%args);
-
- $args{name} = $name;
+sub has_read_method { $_[0]->has_reader || $_[0]->has_accessor }
+sub has_write_method { $_[0]->has_writer || $_[0]->has_accessor }
- my $self = bless \%args, $class;
+sub get_read_method { $_[0]->reader || $_[0]->accessor }
+sub get_write_method { $_[0]->writer || $_[0]->accessor }
- # extra attributes
- if($class ne __PACKAGE__){
- $class->meta->_initialize_object($self, \%args);
- }
-
-# 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 $self;
+sub get_read_method_ref{
+ my($self) = @_;
+ return $self->{_read_method_ref}
+ ||= $self->_get_accessor_method_ref('get_read_method', '_generate_reader');
}
-sub has_read_method { $_[0]->has_reader || $_[0]->has_accessor }
-sub has_write_method { $_[0]->has_writer || $_[0]->has_accessor }
-
-sub _create_args { # DEPRECATED
- $_[0]->{_create_args} = $_[1] if @_ > 1;
- $_[0]->{_create_args}
+sub get_write_method_ref{
+ my($self) = @_;
+ return $self->{_write_method_ref}
+ ||= $self->_get_accessor_method_ref('get_write_method', '_generate_writer');
}
sub interpolate_class{
return( $class, @traits );
}
-sub canonicalize_args{ # DEPRECATED
- my ($self, $name, %args) = @_;
-
- Carp::cluck("$self->canonicalize_args has been deprecated."
- . "Use \$self->_process_options instead.")
- if Mouse::Util::_MOUSE_VERBOSE;
-
- return %args;
-}
-
-sub create { # DEPRECATED
- my ($self, $class, $name, %args) = @_;
-
- Carp::cluck("$self->create has been deprecated."
- . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
- if Mouse::Util::_MOUSE_VERBOSE;
-
- # noop
- return $self;
-}
-
sub _coerce_and_verify {
- my($self, $value, $instance) = @_;
+ #my($self, $value, $instance) = @_;
+ my($self, $value) = @_;
my $type_constraint = $self->{type_constraint};
return $value if !defined $type_constraint;
return 1 if !$type_constraint;
return 1 if $type_constraint->check($value);
- $self->verify_type_constraint_error($self->name, $value, $type_constraint);
+ $self->_throw_type_constraint_error($value, $type_constraint);
}
-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 { # DEPRECATED
- my $type = $_[0]->{type_constraint}
- or return $_[1];
+sub _throw_type_constraint_error {
+ my($self, $value, $type) = @_;
- Carp::cluck("coerce_constraint() has been deprecated, which was an internal utility anyway");
+ $self->throw_error(
+ sprintf q{Attribute (%s) does not pass the type constraint because: %s},
+ $self->name,
+ $type->get_message($value),
+ );
+}
- return Mouse::Util::TypeConstraints->typecast_constraints($_[0]->associated_class->name, $type, $_[1]);
+sub illegal_options_for_inheritance {
+ return qw(reader writer accessor clearer predicate);
}
sub clone_and_inherit_options{
- my($self, %args) = @_;
+ my $self = shift;
+ my $args = $self->Mouse::Object::BUILDARGS(@_);
- my($attribute_class, @traits) = ref($self)->interpolate_class(\%args);
+ foreach my $illegal($self->illegal_options_for_inheritance) {
+ if(exists $args->{$illegal} and exists $self->{$illegal}) {
+ $self->throw_error("Illegal inherited option: $illegal");
+ }
+ }
- $args{traits} = \@traits if @traits;
- # do not inherit the 'handles' attribute
foreach my $name(keys %{$self}){
- if(!exists $args{$name} && $name ne 'handles'){
- $args{$name} = $self->{$name};
+ if(!exists $args->{$name}){
+ $args->{$name} = $self->{$name}; # inherit from self
}
}
- return $attribute_class->new($self->name, %args);
-}
-sub clone_parent { # DEPRECATED
- my $self = shift;
- my $class = shift;
- my $name = shift;
- my %args = ($self->get_parent_args($class, $name), @_);
+ my($attribute_class, @traits) = ref($self)->interpolate_class($args);
+ $args->{traits} = \@traits if @traits;
- Carp::cluck("$self->clone_parent has been deprecated."
- . "Use \$meta->add_attribute and \$attr->install_accessors instead.")
- if Mouse::Util::_MOUSE_VERBOSE;
-
- $self->clone_and_inherited_args($class, $name, %args);
-}
-
-sub get_parent_args { # DEPRECATED
- my $self = shift;
- my $class = shift;
- my $name = shift;
+ # remove temporary caches
+ foreach my $attr(keys %{$args}){
+ if($attr =~ /\A _/xms){
+ delete $args->{$attr};
+ }
+ }
- for my $super ($class->linearized_isa) {
- my $super_attr = $super->can("meta") && $super->meta->get_attribute($name)
- or next;
- return %{ $super_attr->_create_args };
+ # remove default if lazy_build => 1
+ if($args->{lazy_build}) {
+ delete $args->{default};
}
- $self->throw_error("Could not find an attribute by the name of '$name' to inherit from");
+ return $attribute_class->new($self->name, $args);
}
-sub get_read_method {
- return $_[0]->reader || $_[0]->accessor
-}
-sub get_write_method {
- return $_[0]->writer || $_[0]->accessor
-}
-
sub _get_accessor_method_ref {
my($self, $type, $generator) = @_;
}
}
-sub get_read_method_ref{
- my($self) = @_;
- return $self->{_read_method_ref} ||= $self->_get_accessor_method_ref('get_read_method', '_generate_reader');
-}
-
-sub get_write_method_ref{
- my($self) = @_;
- return $self->{_write_method_ref} ||= $self->_get_accessor_method_ref('get_write_method', '_generate_writer');
-}
-
sub set_value {
my($self, $object, $value) = @_;
return $self->get_write_method_ref()->($object, $value);
return $accessor_ref->($object);
}
-
-sub _canonicalize_handles {
- my($self, $handles) = @_;
-
- if (ref($handles) eq 'HASH') {
- return %$handles;
- }
- elsif (ref($handles) eq 'ARRAY') {
- return map { $_ => $_ } @$handles;
- }
- elsif (ref($handles) eq 'Regexp') {
- my $class_or_role = ($self->{isa} || $self->{does})
- || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)");
-
- my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify
- return map { $_ => $_ }
- grep { !Mouse::Object->can($_) && $_ =~ $handles }
- Mouse::Util::is_a_metarole($meta)
- ? $meta->get_method_list
- : $meta->get_all_method_names;
- }
- else {
- $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
- }
-}
-
sub associate_method{
- my ($attribute, $method_name) = @_;
+ #my($attribute, $method_name) = @_;
+ my($attribute) = @_;
$attribute->{associated_methods}++;
return;
}
-sub delegation_metaclass() { 'Mouse::Meta::Method::Delegation' }
-
sub install_accessors{
my($attribute) = @_;
# install delegation
if(exists $attribute->{handles}){
- my $delegation_class = $attribute->delegation_metaclass;
my %handles = $attribute->_canonicalize_handles($attribute->{handles});
- my $reader = $attribute->get_read_method_ref;
- Mouse::Util::load_class($delegation_class);
+ while(my($handle, $method_to_call) = each %handles){
+ if($metaclass->has_method($handle)) {
+ $attribute->throw_error("You cannot overwrite a locally defined method ($handle) with a delegation");
+ }
- while(my($handle_name, $method_to_call) = each %handles){
- my $code = $delegation_class->_generate_delegation($attribute, $metaclass,
- $reader, $handle_name, $method_to_call);
+ $metaclass->add_method($handle =>
+ $attribute->_make_delegation_method(
+ $handle, $method_to_call));
- $metaclass->add_method($handle_name => $code);
- $attribute->associate_method($handle_name);
+ $attribute->associate_method($handle);
}
}
- if($attribute->can('create') != \&create){
- # backword compatibility
- $attribute->create($metaclass, $attribute->name, %{$attribute});
- }
-
return;
}
-sub throw_error{
- my $self = shift;
+sub delegation_metaclass() { ## no critic
+ 'Mouse::Meta::Method::Delegation'
+}
- my $metaclass = (ref $self && $self->associated_class) || 'Mouse::Meta::Class';
- $metaclass->throw_error(@_, depth => 1);
+sub _canonicalize_handles {
+ my($self, $handles) = @_;
+
+ if (ref($handles) eq 'HASH') {
+ return %$handles;
+ }
+ elsif (ref($handles) eq 'ARRAY') {
+ return map { $_ => $_ } @$handles;
+ }
+ elsif ( ref($handles) eq 'CODE' ) {
+ my $class_or_role = ( $self->{isa} || $self->{does} )
+ || $self->throw_error( "Cannot find delegate metaclass for attribute " . $self->name );
+ return $handles->( $self, Mouse::Meta::Class->initialize("$class_or_role"));
+ }
+ elsif (ref($handles) eq 'Regexp') {
+ my $class_or_role = ($self->{isa} || $self->{does})
+ || $self->throw_error("Cannot delegate methods based on a Regexp without a type constraint (isa)");
+
+ my $meta = Mouse::Meta::Class->initialize("$class_or_role"); # "" for stringify
+ return map { $_ => $_ }
+ grep { !Mouse::Object->can($_) && $_ =~ $handles }
+ Mouse::Util::is_a_metarole($meta)
+ ? $meta->get_method_list
+ : $meta->get_all_method_names;
+ }
+ else {
+ $self->throw_error("Unable to canonicalize the 'handles' option with $handles");
+ }
+}
+
+sub _make_delegation_method {
+ my($self, $handle, $method_to_call) = @_;
+ return Mouse::Util::load_class($self->delegation_metaclass)
+ ->_generate_delegation($self, $handle, $method_to_call);
}
1;
=head1 VERSION
-This document describes Mouse version 0.44
+This document describes Mouse version 0.70
+
+=head1 DESCRIPTION
+
+This is a meta object protocol for Mouse attributes,
+which is a subset of Moose::Meta::Attribute.
=head1 METHODS