use Scalar::Util 'blessed', 'weaken', 'reftype';
use Carp 'confess';
+use Sub::Name 'subname';
use overload ();
-our $VERSION = '0.13';
+our $VERSION = '0.22';
our $AUTHORITY = 'cpan:STEVAN';
use Moose::Meta::Method::Accessor;
));
sub new {
- my ($class, $name, %options) = @_;
- $class->_process_options($name, \%options);
- return $class->SUPER::new($name, %options);
+ my ($class, $name, %options) = @_;
+ $class->_process_options($name, \%options);
+ return $class->SUPER::new($name, %options);
}
sub clone_and_inherit_options {
$actual_options{handles} = $options{handles};
delete $options{handles};
}
+
+ # handles can only be added, not changed
+ if ($options{builder}) {
+ confess "You can only add the 'builder' option, you cannot change it"
+ if $self->has_builder;
+ $actual_options{builder} = $options{builder};
+ delete $options{builder};
+ }
# isa can be changed, but only if the
# new type is a subtype
if ($options{isa}) {
my $type_constraint;
- if (blessed($options{isa}) && $options{isa}->isa('Moose::Meta::TypeConstraint')) {
- $type_constraint = $options{isa};
- }
- else {
- $type_constraint = Moose::Util::TypeConstraints::find_type_constraint($options{isa});
- (defined $type_constraint)
- || confess "Could not find the type constraint '" . $options{isa} . "'";
- }
- # NOTE:
- # check here to see if the new type
- # is a subtype of the old one
- ($type_constraint->is_subtype_of($self->type_constraint->name))
- || confess "New type constraint setting must be a subtype of inherited one"
- # iff we have a type constraint that is ...
- if $self->has_type_constraint;
- # then we use it :)
- $actual_options{type_constraint} = $type_constraint;
+ if (blessed($options{isa}) && $options{isa}->isa('Moose::Meta::TypeConstraint')) {
+ $type_constraint = $options{isa};
+ }
+ else {
+ $type_constraint = Moose::Util::TypeConstraints::find_or_create_type_constraint(
+ $options{isa}
+ );
+ (defined $type_constraint)
+ || confess "Could not find the type constraint '" . $options{isa} . "'";
+ }
+ # NOTE:
+ # check here to see if the new type
+ # is a subtype of the old one
+ ($type_constraint->is_subtype_of($self->type_constraint->name))
+ || confess "New type constraint setting must be a subtype of inherited one"
+ # iff we have a type constraint that is ...
+ if $self->has_type_constraint;
+ # then we use it :)
+ $actual_options{type_constraint} = $type_constraint;
delete $options{isa};
}
(scalar keys %options == 0)
sub _process_options {
my ($class, $name, $options) = @_;
- if (exists $options->{is}) {
- if ($options->{is} eq 'ro') {
- $options->{reader} ||= $name;
- (!exists $options->{trigger})
- || confess "Cannot have a trigger on a read-only attribute";
- }
- elsif ($options->{is} eq 'rw') {
- $options->{accessor} = $name;
+ if (exists $options->{is}) {
+ if ($options->{is} eq 'ro') {
+ $options->{reader} ||= $name;
+ (!exists $options->{trigger})
+ || confess "Cannot have a trigger on a read-only attribute";
+ }
+ elsif ($options->{is} eq 'rw') {
+ $options->{accessor} = $name;
((reftype($options->{trigger}) || '') eq 'CODE')
|| confess "Trigger must be a CODE ref"
if exists $options->{trigger};
- }
- else {
- confess "I do not understand this option (is => " . $options->{is} . ")"
- }
}
+ else {
+ confess "I do not understand this option (is => " . $options->{is} . ")"
+ }
+ }
- if (exists $options->{isa}) {
-
- if (exists $options->{does}) {
- if (eval { $options->{isa}->can('does') }) {
- ($options->{isa}->does($options->{does}))
- || confess "Cannot have an isa option and a does option if the isa does not do the does";
- }
- else {
- confess "Cannot have an isa option which cannot ->does()";
- }
+ if (exists $options->{isa}) {
+ if (exists $options->{does}) {
+ if (eval { $options->{isa}->can('does') }) {
+ ($options->{isa}->does($options->{does}))
+ || confess "Cannot have an isa option and a does option if the isa does not do the does";
+ }
+ else {
+ confess "Cannot have an isa option which cannot ->does()";
}
+ }
- # allow for anon-subtypes here ...
- if (blessed($options->{isa}) && $options->{isa}->isa('Moose::Meta::TypeConstraint')) {
- $options->{type_constraint} = $options->{isa};
- }
- else {
- $options->{type_constraint} = Moose::Util::TypeConstraints::find_or_create_type_constraint(
- $options->{isa} => {
- parent => Moose::Util::TypeConstraints::find_type_constraint('Object'),
- constraint => sub { $_[0]->isa($options->{isa}) }
- }
- );
- }
+ # allow for anon-subtypes here ...
+ if (blessed($options->{isa}) && $options->{isa}->isa('Moose::Meta::TypeConstraint')) {
+ $options->{type_constraint} = $options->{isa};
}
- elsif (exists $options->{does}) {
- # allow for anon-subtypes here ...
- if (blessed($options->{does}) && $options->{does}->isa('Moose::Meta::TypeConstraint')) {
- $options->{type_constraint} = $options->{isa};
+ else {
+ $options->{type_constraint} = Moose::Util::TypeConstraints::find_or_create_type_constraint(
+ $options->{isa} => {
+ parent => Moose::Util::TypeConstraints::find_type_constraint('Object'),
+ constraint => sub { $_[0]->isa($options->{isa}) }
}
- else {
- $options->{type_constraint} = Moose::Util::TypeConstraints::find_or_create_type_constraint(
- $options->{does} => {
- parent => Moose::Util::TypeConstraints::find_type_constraint('Role'),
- constraint => sub { $_[0]->does($options->{does}) }
+ );
+ }
+ }
+ elsif (exists $options->{does}) {
+ # allow for anon-subtypes here ...
+ if (blessed($options->{does}) && $options->{does}->isa('Moose::Meta::TypeConstraint')) {
+ $options->{type_constraint} = $options->{does};
+ }
+ else {
+ $options->{type_constraint} = Moose::Util::TypeConstraints::find_or_create_type_constraint(
+ $options->{does} => {
+ parent => Moose::Util::TypeConstraints::find_type_constraint('Role'),
+ constraint => sub {
+ Moose::Util::does_role($_[0], $options->{does})
}
- );
}
+ );
}
+ }
- if (exists $options->{coerce} && $options->{coerce}) {
- (exists $options->{type_constraint})
- || confess "You cannot have coercion without specifying a type constraint";
+ if (exists $options->{coerce} && $options->{coerce}) {
+ (exists $options->{type_constraint})
+ || confess "You cannot have coercion without specifying a type constraint";
confess "You cannot have a weak reference to a coerced value"
if $options->{weak_ref};
- }
+ }
- if (exists $options->{auto_deref} && $options->{auto_deref}) {
- (exists $options->{type_constraint})
- || confess "You cannot auto-dereference without specifying a type constraint";
- ($options->{type_constraint}->is_a_type_of('ArrayRef') ||
+ if (exists $options->{auto_deref} && $options->{auto_deref}) {
+ (exists $options->{type_constraint})
+ || confess "You cannot auto-dereference without specifying a type constraint";
+ ($options->{type_constraint}->is_a_type_of('ArrayRef') ||
$options->{type_constraint}->is_a_type_of('HashRef'))
- || confess "You cannot auto-dereference anything other than a ArrayRef or HashRef";
- }
+ || confess "You cannot auto-dereference anything other than a ArrayRef or HashRef";
+ }
- if (exists $options->{lazy_build} && $options->{lazy_build} == 1) {
- confess("You can not use lazy_build and default for the same attribute")
- if exists $options->{default};
- $options->{lazy} = 1;
- $options->{required} = 1;
- if($name =~ /^_/){
- $options->{builder} ||= "_build${name}";
- $options->{clearer} ||= "_clear${name}";
- $options->{predicate} ||= "_has${name}";
- } else {
- $options->{builder} ||= "build_${name}";
- $options->{clearer} ||= "clear_${name}";
- $options->{predicate} ||= "has_${name}";
- }
+ if (exists $options->{lazy_build} && $options->{lazy_build} == 1) {
+ confess("You can not use lazy_build and default for the same attribute")
+ if exists $options->{default};
+ $options->{lazy} = 1;
+ $options->{required} = 1;
+ $options->{builder} ||= "_build_${name}";
+ if ($name =~ /^_/) {
+ $options->{clearer} ||= "_clear${name}";
+ $options->{predicate} ||= "_has${name}";
+ }
+ else {
+ $options->{clearer} ||= "clear_${name}";
+ $options->{predicate} ||= "has_${name}";
}
+ }
- if (exists $options->{lazy} && $options->{lazy}) {
- (exists $options->{default} || exists $options->{builder} )
- || confess "You cannot have lazy attribute without specifying a default value for it";
- }
+ if (exists $options->{lazy} && $options->{lazy}) {
+ (exists $options->{default} || defined $options->{builder} )
+ || confess "You cannot have lazy attribute without specifying a default value for it";
+ }
+
+ if ( $options->{required} && !( ( !exists $options->{init_arg} || defined $options->{init_arg} ) || exists $options->{default} || defined $options->{builder} ) ) {
+ confess "You cannot have a required attribute without a default, builder, or an init_arg";
+ }
}
# try to fetch the init arg from the %params ...
my $val;
- if (exists $params->{$init_arg}) {
+ my $value_is_set;
+ if ( defined($init_arg) and exists $params->{$init_arg}) {
$val = $params->{$init_arg};
-
- if (!defined $val && $self->is_required) {
- confess "Attribute (" . $self->name . ") is required and cannot be undef";
- }
+ $value_is_set = 1;
}
else {
# skip it if it's lazy
# and die if it's required and doesn't have a default value
confess "Attribute (" . $self->name . ") is required"
if $self->is_required && !$self->has_default && !$self->has_builder;
- }
- # if nothing was in the %params, we can use the
- # attribute's default value (if it has one)
- if (!defined $val && $self->has_default) {
- $val = $self->default($instance);
- } elsif (!defined $val && $self->has_builder) {
- my $builder = $self->builder;
- if($builder = $instance->can($builder)){
- $val = $instance->$builder;
- } else {
- confess(blessed($instance)." does not support builder method '$builder' for attribute '" . $self->name . "'");
+ # if nothing was in the %params, we can use the
+ # attribute's default value (if it has one)
+ if ($self->has_default) {
+ $val = $self->default($instance);
+ $value_is_set = 1;
+ }
+ elsif ($self->has_builder) {
+ if (my $builder = $instance->can($self->builder)){
+ $val = $instance->$builder;
+ $value_is_set = 1;
+ }
+ else {
+ confess(blessed($instance)." does not support builder method '".$self->builder."' for attribute '" . $self->name . "'");
+ }
}
}
- if (defined $val || $self->has_default) {
- if ($self->has_type_constraint) {
- my $type_constraint = $self->type_constraint;
- if ($self->should_coerce && $type_constraint->has_coercion) {
- $val = $type_constraint->coerce($val);
- }
- (defined($type_constraint->check($val)))
- || confess "Attribute (" .
- $self->name .
- ") does not pass the type constraint (" .
- $type_constraint->name .
- ") with '" .
- (defined $val
- ? (blessed($val) && overload::Overloaded($val)
- ? overload::StrVal($val)
- : $val)
- : 'undef') .
- "'";
- }
+ return unless $value_is_set;
+
+ if ($self->has_type_constraint) {
+ my $type_constraint = $self->type_constraint;
+ if ($self->should_coerce && $type_constraint->has_coercion) {
+ $val = $type_constraint->coerce($val);
}
+ $type_constraint->check($val)
+ || confess "Attribute ("
+ . $self->name
+ . ") does not pass the type constraint because: "
+ . $type_constraint->get_message($val);
+ }
- $meta_instance->set_slot_value($instance, $self->name, $val);
+ $self->set_initial_value($instance, $val);
$meta_instance->weaken_slot_value($instance, $self->name)
if ref $val && $self->is_weak_ref;
}
## Slot management
+# FIXME:
+# this duplicates too much code from
+# Class::MOP::Attribute, we need to
+# refactor these bits eventually.
+# - SL
+sub _set_initial_slot_value {
+ my ($self, $meta_instance, $instance, $value) = @_;
+
+ my $slot_name = $self->name;
+
+ return $meta_instance->set_slot_value($instance, $slot_name, $value)
+ unless $self->has_initializer;
+
+ my ($type_constraint, $can_coerce);
+ if ($self->has_type_constraint) {
+ $type_constraint = $self->type_constraint;
+ $can_coerce = ($self->should_coerce && $type_constraint->has_coercion);
+ }
+
+ my $callback = sub {
+ my $val = shift;
+ if ($type_constraint) {
+ $val = $type_constraint->coerce($val)
+ if $can_coerce;
+ $type_constraint->check($val)
+ || confess "Attribute ("
+ . $slot_name
+ . ") does not pass the type constraint because: "
+ . $type_constraint->get_message($val);
+ }
+ $meta_instance->set_slot_value($instance, $slot_name, $val);
+ };
+
+ my $initializer = $self->initializer;
+
+ # most things will just want to set a value, so make it first arg
+ $instance->$initializer($value, $callback, $self);
+}
+
sub set_value {
my ($self, $instance, $value) = @_;
if ($self->should_coerce) {
$value = $type_constraint->coerce($value);
- }
- defined($type_constraint->_compiled_type_constraint->($value))
- || confess "Attribute ($attr_name) does not pass the type constraint ("
- . $type_constraint->name
- . ") with "
- . (defined($value)
- ? ("'" .
- (blessed($value) && overload::Overloaded($value)
- ? overload::StrVal($value)
- : $value)
- . "'")
- : "undef")
- if defined($value);
+ }
+ $type_constraint->_compiled_type_constraint->($value)
+ || confess "Attribute ("
+ . $self->name
+ . ") does not pass the type constraint because "
+ . $type_constraint->get_message($value);
}
my $meta_instance = Class::MOP::Class->initialize(blessed($instance))
my ($self, $instance) = @_;
if ($self->is_lazy) {
- unless ($self->has_value($instance)) {
- if ($self->has_default) {
- my $default = $self->default($instance);
- $self->set_value($instance, $default);
- }
- if ( $self->has_builder ){
- my $builder = $self->builder;
- if($builder = $instance->can($builder)){
- $self->set_value($instance, $instance->$builder);
- } else {
- confess(blessed($instance)." does not support builder method '$builder' for attribute '" . $self->name . "'");
- }
- } else {
- $self->set_value($instance, undef);
+ unless ($self->has_value($instance)) {
+ if ($self->has_default) {
+ my $default = $self->default($instance);
+ $self->set_initial_value($instance, $default);
+ }
+ if ( $self->has_builder ){
+ if (my $builder = $instance->can($self->builder)){
+ $self->set_initial_value($instance, $instance->$builder);
+ }
+ else {
+ confess(blessed($instance)
+ . " does not support builder method '"
+ . $self->builder
+ . "' for attribute '"
+ . $self->name
+ . "'");
}
+ }
+ else {
+ $self->set_initial_value($instance, undef);
}
+ }
}
if ($self->should_auto_deref) {
# to delagate to, see that method for details
my %handles = $self->_canonicalize_handles();
- # find the name of the accessor for this attribute
- my $accessor_name = $self->reader || $self->accessor;
- (defined $accessor_name)
- || confess "You cannot install delegation without a reader or accessor for the attribute";
-
- # make sure we handle HASH accessors correctly
- ($accessor_name) = keys %{$accessor_name}
- if ref($accessor_name) eq 'HASH';
+ # find the accessor method for this attribute
+ my $accessor = $self->get_read_method_ref;
+ # then unpack it if we need too ...
+ $accessor = $accessor->body if blessed $accessor;
# install the delegation ...
my $associated_class = $self->associated_class;
foreach my $handle (keys %handles) {
my $method_to_call = $handles{$handle};
+ my $class_name = $associated_class->name;
+ my $name = "${class_name}::${handle}";
(!$associated_class->has_method($handle))
|| confess "You cannot overwrite a locally defined method ($handle) with a delegation";
# any of these methods, as they will
# override the ones in your class, which
# is almost certainly not what you want.
- next if $handle =~ /^BUILD|DEMOLISH$/ || Moose::Object->can($handle);
+
+ # FIXME warn when $handle was explicitly specified, but not if the source is a regex or something
+ #cluck("Not delegating method '$handle' because it is a core method") and
+ next if $class_name->isa("Moose::Object") and $handle =~ /^BUILD|DEMOLISH$/ || Moose::Object->can($handle);
if ((reftype($method_to_call) || '') eq 'CODE') {
- $associated_class->add_method($handle => $method_to_call);
+ $associated_class->add_method($handle => subname $name, $method_to_call);
}
else {
- $associated_class->add_method($handle => sub {
- # FIXME
- # we should check for lack of
- # a callable return value from
- # the accessor here
- my $proxy = (shift)->$accessor_name();
- @_ = ($proxy, @_);
- goto &{ $proxy->can($method_to_call)};
+ # NOTE:
+ # we used to do a goto here, but the
+ # goto didn't handle failure correctly
+ # (it just returned nothing), so I took
+ # that out. However, the more I thought
+ # about it, the less I liked it doing
+ # the goto, and I prefered the act of
+ # delegation being actually represented
+ # in the stack trace.
+ # - SL
+ $associated_class->add_method($handle => subname $name, sub {
+ my $proxy = (shift)->$accessor();
+ (defined $proxy)
+ || confess "Cannot delegate $handle to $method_to_call because " .
+ "the value of " . $self->name . " is not defined";
+ $proxy->$method_to_call(@_);
});
}
}
Any coercion to convert values is done before checking the type constraint.
To check a value against a type constraint before setting it, fetch the
-attribute instance using L<Moose::Meta::Attribute/find_attribute_by_name>,
+attribute instance using L<Class::MOP::Class/find_attribute_by_name>,
fetch the type_constraint from the attribute using L<Moose::Meta::Attribute/type_constraint>
and call L<Moose::Meta::TypeConstraint/check>. See L<Moose::Cookbook::RecipeX>
for an example.
#If your attribute name starts with an underscore:
has '_foo' => (lazy_build => 1);
#is the same as
- has '_foo' => (lazy => 1, required => 1, builder => '_build_foo', predicate => '_has_foo', clearer => '_clear_foo');
+ has '_foo' => (lazy => 1, required => 1, predicate => '_has_foo', clearer => '_clear_foo', builder => '_build__foo);
# or
- has '_foo' => (lazy => 1, required => 1, builder => '_build_foo', default => sub{shift->_build_foo}, clearer => '_clear_foo');
+ has '_foo' => (lazy => 1, required => 1, predicate => '_has_foo', clearer => '_clear_foo', default => sub{shift->_build__foo});
#If your attribute name does not start with an underscore:
- has 'foo' => (lazy => 1, required => 1, builder => 'build_foo', predicate => 'has_foo', clearer => 'clear_foo');
+ has 'foo' => (lazy_build => 1);
+ #is the same as
+ has 'foo' => (lazy => 1, required => 1, predicate => 'has_foo', clearer => 'clear_foo', builder => '_build_foo);
# or
- has '_foo' => (lazy => 1, required => 1, builder => '_build_foo', default => sub{shift->build_foo}, clearer => '_clear_foo');
+ has 'foo' => (lazy => 1, required => 1, predicate => 'has_foo', clearer => 'clear_foo', default => sub{shift->_build_foo});
+
+The reason for the different naming of the C<builder> is that the C<builder>
+method is a private method while the C<clearer> and C<predicate> methods
+are public methods.
NOTE: This means your class should provide a method whose name matches the value
-of the builder part, in this case _build_foo or build_foo.
+of the builder part, in this case _build__foo or _build_foo.
=item B<should_coerce>
=head1 COPYRIGHT AND LICENSE
-Copyright 2006, 2007 by Infinity Interactive, Inc.
+Copyright 2006-2008 by Infinity Interactive, Inc.
L<http://www.iinteractive.com>
projects / gitmo/Moose.git / blobdiff