X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FClass%2FAccessor%2FGrouped.pm;h=35d21defb46172c499dbd9c8ef6fd2546498bca0;hb=727cd2c0d63510e3f59d936e5cb79b8c10fb4dcb;hp=74801f8f4ecdd466d4ed63d47a522f44debd3b25;hpb=45c3ca9b593b39c628b186bb0cce26d745db2c24;p=p5sagit%2FClass-Accessor-Grouped.git diff --git a/lib/Class/Accessor/Grouped.pm b/lib/Class/Accessor/Grouped.pm index 74801f8..35d21de 100644 --- a/lib/Class/Accessor/Grouped.pm +++ b/lib/Class/Accessor/Grouped.pm @@ -3,64 +3,100 @@ use strict; use warnings; use Carp (); use Scalar::Util (); -use MRO::Compat; +use Module::Runtime (); -our $VERSION = '0.10001'; +BEGIN { + # use M::R to work around the 5.8 require bugs + if ($] < 5.009_005) { + Module::Runtime::require_module('MRO::Compat'); + } + else { + require mro; + } +} + +our $VERSION = '0.10006'; $VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases -# when changing minimum version don't forget to adjust L and -# the Makefile.PL as well +# when changing minimum version don't forget to adjust Makefile.PL as well our $__minimum_xsa_version; -BEGIN { - $__minimum_xsa_version = '1.11'; -} +BEGIN { $__minimum_xsa_version = '1.13' } our $USE_XS; # the unless defined is here so that we can override the value # before require/use, *regardless* of the state of $ENV{CAG_USE_XS} $USE_XS = $ENV{CAG_USE_XS} - unless defined $USE_XS; + unless defined $USE_XS; + +BEGIN { + package # hide from PAUSE + __CAG_ENV__; + + die "Huh?! No minimum C::XSA version?!\n" + unless $__minimum_xsa_version; + + local $@; + require constant; + + # individual (one const at a time) imports so we are 5.6.2 compatible + # if we can - why not ;) + constant->import( NO_SUBNAME => eval { + Module::Runtime::require_module('Sub::Name') + } ? 0 : "$@" ); + + constant->import( NO_CXSA => ( !NO_SUBNAME() and eval { + Module::Runtime::use_module('Class::XSAccessor' => $__minimum_xsa_version) + } ) ? 0 : "$@" ); + + constant->import( BROKEN_GOTO => ($] < '5.008009') ? 1 : 0 ); + + constant->import( UNSTABLE_DOLLARAT => ($] < '5.013002') ? 1 : 0 ); + + constant->import( TRACK_UNDEFER_FAIL => ( + $INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'} + and + $0 =~ m|^ x?t / .+ \.t $|x + ) ? 1 : 0 ); +} # Yes this method is undocumented # Yes it should be a private coderef like all the rest at the end of this file # No we can't do that (yet) because the DBIC-CDBI compat layer overrides it # %$*@!?&!&#*$!!! sub _mk_group_accessors { - my($self, $maker, $group, @fields) = @_; - my $class = Scalar::Util::blessed $self || $self; + my($self, $maker, $group, @fields) = @_; + my $class = length (ref ($self) ) ? ref ($self) : $self; - no strict 'refs'; - no warnings 'redefine'; + no strict 'refs'; + no warnings 'redefine'; - # So we don't have to do lots of lookups inside the loop. - $maker = $self->can($maker) unless ref $maker; + # So we don't have to do lots of lookups inside the loop. + $maker = $self->can($maker) unless ref $maker; - foreach (@fields) { - if( $_ eq 'DESTROY' ) { - Carp::carp("Having a data accessor named DESTROY in ". - "'$class' is unwise."); - } + for (@fields) { - my ($name, $field) = (ref $_) - ? (@$_) - : ($_, $_) - ; + my ($name, $field) = (ref $_) ? (@$_) : ($_, $_); - my $alias = "_${name}_accessor"; + for (qw/DESTROY AUTOLOAD CLONE/) { + Carp::carp("Having a data accessor named '$name' in '$class' is unwise.") + if $name eq $_; + } - for my $meth ($name, $alias) { + my $alias = "_${name}_accessor"; - # the maker may elect to not return anything, meaning it already - # installed the coderef for us (e.g. lack of Sub::Name) - my $cref = $self->$maker($group, $field, $meth) - or next; + for ($name, $alias) { - my $fq_meth = "${class}::${meth}"; + # the maker may elect to not return anything, meaning it already + # installed the coderef for us (e.g. lack of Sub::Name) + my $cref = $self->$maker($group, $field, $_) + or next; - *$fq_meth = Sub::Name::subname($fq_meth, $cref); - #unless defined &{$class."\:\:$field"} - } + my $fq_meth = "${class}::$_"; + + *$fq_meth = Sub::Name::subname($fq_meth, $cref); + #unless defined &{$class."\:\:$field"} } + } }; # coderef is setup at the end for clarity @@ -72,6 +108,14 @@ Class::Accessor::Grouped - Lets you build groups of accessors =head1 SYNOPSIS + use base 'Class::Accessor::Grouped'; + + # make basic accessors for objects + __PACKAGE__->mk_group_accessors(simple => qw(id name email)); + + # make accessor that works for objects and classes + __PACKAGE__->mk_group_accessors(inherited => 'awesome_level'); + =head1 DESCRIPTION This class lets you build groups of accessors that will call different @@ -81,6 +125,8 @@ getters and setters. =head2 mk_group_accessors + __PACKAGE__->mk_group_accessors(simple => 'hair_length', [ hair_color => 'hc' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -105,14 +151,16 @@ be of the form [ $accessor, $field ]. =cut sub mk_group_accessors { - my ($self, $group, @fields) = @_; + my ($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_accessor', $group, @fields); - return; + $self->_mk_group_accessors('make_group_accessor', $group, @fields); + return; } =head2 mk_group_ro_accessors + __PACKAGE__->mk_group_ro_accessors(simple => 'birthdate', [ social_security_number => 'ssn' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -128,13 +176,16 @@ rather than setting the value. =cut sub mk_group_ro_accessors { - my($self, $group, @fields) = @_; + my($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_ro_accessor', $group, @fields); + return; } =head2 mk_group_wo_accessors + __PACKAGE__->mk_group_wo_accessors(simple => 'lie', [ subject => 'subj' ]); + =over 4 =item Arguments: $group, @fieldspec @@ -150,65 +201,12 @@ value rather than getting the value. =cut sub mk_group_wo_accessors { - my($self, $group, @fields) = @_; + my($self, $group, @fields) = @_; - $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); + $self->_mk_group_accessors('make_group_wo_accessor', $group, @fields); + return; } -=head2 make_group_accessor - -=over 4 - -=item Arguments: $group, $field, $method - -Returns: \&accessor_coderef ? - -=back - -Called by mk_group_accessors for each entry in @fieldspec. Either returns -a coderef which will be installed at C<&__PACKAGE__::$method>, or returns -C if it elects to install the coderef on its own. - -=cut - -sub make_group_accessor { $gen_accessor->('rw', @_) } - -=head2 make_group_ro_accessor - -=over 4 - -=item Arguments: $group, $field, $method - -Returns: \&accessor_coderef ? - -=back - -Called by mk_group_ro_accessors for each entry in @fieldspec. Either returns -a coderef which will be installed at C<&__PACKAGE__::$method>, or returns -C if it elects to install the coderef on its own. - -=cut - -sub make_group_ro_accessor { $gen_accessor->('ro', @_) } - -=head2 make_group_wo_accessor - -=over 4 - -=item Arguments: $group, $field, $method - -Returns: \&accessor_coderef ? - -=back - -Called by mk_group_wo_accessors for each entry in @fieldspec. Either returns -a coderef which will be installed at C<&__PACKAGE__::$method>, or returns -C if it elects to install the coderef on its own. - -=cut - -sub make_group_wo_accessor { $gen_accessor->('wo', @_) } - =head2 get_simple =over 4 @@ -225,7 +223,7 @@ name passed as an argument. =cut sub get_simple { - return $_[0]->{$_[1]}; + $_[0]->{$_[1]}; } =head2 set_simple @@ -244,7 +242,7 @@ for the field name passed as an argument. =cut sub set_simple { - return $_[0]->{$_[1]} = $_[2]; + $_[0]->{$_[1]} = $_[2]; } @@ -267,38 +265,30 @@ instances. =cut sub get_inherited { - my $class; - - if ( defined( $class = Scalar::Util::blessed $_[0] ) ) { - if (Scalar::Util::reftype $_[0] eq 'HASH') { - return $_[0]->{$_[1]} if exists $_[0]->{$_[1]}; - } - else { - Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); - } + if ( length (ref ($_[0]) ) ) { + if (Scalar::Util::reftype $_[0] eq 'HASH') { + return $_[0]->{$_[1]} if exists $_[0]->{$_[1]}; + # everything in @_ is aliased, an assignment won't work + splice @_, 0, 1, ref($_[0]); } else { - $class = $_[0]; + Carp::croak('Cannot get inherited value on an object instance that is not hash-based'); } + } - no strict 'refs'; - no warnings 'uninitialized'; + # if we got this far there is nothing in the instance + # OR this is a class call + # in any case $_[0] contains the class name (see splice above) + no strict 'refs'; + no warnings 'uninitialized'; - my $cag_slot = '::__cag_'. $_[1]; - return ${$class.$cag_slot} if defined(${$class.$cag_slot}); + my $cag_slot = '::__cag_'. $_[1]; + return ${$_[0].$cag_slot} if defined(${$_[0].$cag_slot}); - # we need to be smarter about recalculation, as @ISA (thus supers) can very well change in-flight - my $cur_gen = mro::get_pkg_gen ($class); - if ( $cur_gen != ${$class.'::__cag_pkg_gen__'} ) { - @{$class.'::__cag_supers__'} = $_[0]->get_super_paths; - ${$class.'::__cag_pkg_gen__'} = $cur_gen; - } - - for (@{$class.'::__cag_supers__'}) { - return ${$_.$cag_slot} if defined(${$_.$cag_slot}); - }; + do { return ${$_.$cag_slot} if defined(${$_.$cag_slot}) } + for $_[0]->get_super_paths; - return undef; + return undef; } =head2 set_inherited @@ -322,17 +312,16 @@ hash-based object. =cut sub set_inherited { - if (defined Scalar::Util::blessed $_[0]) { - if (Scalar::Util::reftype $_[0] eq 'HASH') { - return $_[0]->{$_[1]} = $_[2]; - } else { - Carp::croak('Cannot set inherited value on an object instance that is not hash-based'); - }; + if (length (ref ($_[0]) ) ) { + if (Scalar::Util::reftype $_[0] eq 'HASH') { + return $_[0]->{$_[1]} = $_[2]; } else { - no strict 'refs'; - - return ${$_[0].'::__cag_'.$_[1]} = $_[2]; + Carp::croak('Cannot set inherited value on an object instance that is not hash-based'); }; + } + + no strict 'refs'; + ${$_[0].'::__cag_'.$_[1]} = $_[2]; } =head2 get_component_class @@ -347,17 +336,17 @@ Returns: $value Gets the value of the specified component class. - __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); + __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); - $self->result_class->method(); + $self->result_class->method(); - ## same as - $self->get_component_class('result_class')->method(); + ## same as + $self->get_component_class('result_class')->method(); =cut sub get_component_class { - return $_[0]->get_inherited($_[1]); + $_[0]->get_inherited($_[1]); }; =head2 set_component_class @@ -373,37 +362,121 @@ Returns: $new_value Inherited accessor that automatically loads the specified class before setting it. This method will die if the specified class could not be loaded. - __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); - __PACKAGE__->result_class('MyClass'); + __PACKAGE__->mk_group_accessors('component_class' => 'result_class'); + __PACKAGE__->result_class('MyClass'); - $self->result_class->method(); + $self->result_class->method(); =cut sub set_component_class { - if ($_[2]) { - local $^W = 0; - require Class::Inspector; - if (Class::Inspector->installed($_[2]) && !Class::Inspector->loaded($_[2])) { - eval "require $_[2]"; + if (defined $_[2] and length $_[2]) { + # disable warnings, and prevent $_ being eaten away by a behind-the-scenes + # module loading + local ($^W, $_); - Carp::croak("Could not load $_[1] '$_[2]': ", $@) if $@; - }; - }; + if (__CAG_ENV__::UNSTABLE_DOLLARAT) { + my $err; + { + local $@; + eval { Module::Runtime::use_package_optimistically($_[2]) } + or $err = $@; + } + Carp::croak("Could not load $_[1] '$_[2]': $err") if defined $err; - return $_[0]->set_inherited($_[1], $_[2]); + } + else { + eval { Module::Runtime::use_package_optimistically($_[2]) } + or Carp::croak("Could not load $_[1] '$_[2]': $@"); + } + }; + + $_[0]->set_inherited($_[1], $_[2]); }; +=head1 INTERNAL METHODS + +These methods are documented for clarity, but are never meant to be called +directly, and are not really meant for overriding either. + =head2 get_super_paths -Returns a list of 'parent' or 'super' class names that the current class inherited from. +Returns a list of 'parent' or 'super' class names that the current class +inherited from. This is what drives the traversal done by L. =cut sub get_super_paths { - return @{mro::get_linear_isa( ref($_[0]) || $_[0] )}; + # get_linear_isa returns the class itself as the 1st element + # use @_ as a pre-allocated scratch array + (undef, @_) = @{mro::get_linear_isa( length( ref($_[0]) ) ? ref($_[0]) : $_[0] )}; + @_; }; +=head2 make_group_accessor + + __PACKAGE__->make_group_accessor('simple', 'hair_length', 'hair_length'); + __PACKAGE__->make_group_accessor('simple', 'hc', 'hair_color'); + +=over 4 + +=item Arguments: $group, $field, $accessor + +Returns: \&accessor_coderef ? + +=back + +Called by mk_group_accessors for each entry in @fieldspec. Either returns +a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns +C if it elects to install the coderef on its own. + +=cut + +sub make_group_accessor { $gen_accessor->('rw', @_) } + +=head2 make_group_ro_accessor + + __PACKAGE__->make_group_ro_accessor('simple', 'birthdate', 'birthdate'); + __PACKAGE__->make_group_ro_accessor('simple', 'ssn', 'social_security_number'); + +=over 4 + +=item Arguments: $group, $field, $accessor + +Returns: \&accessor_coderef ? + +=back + +Called by mk_group_ro_accessors for each entry in @fieldspec. Either returns +a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns +C if it elects to install the coderef on its own. + +=cut + +sub make_group_ro_accessor { $gen_accessor->('ro', @_) } + +=head2 make_group_wo_accessor + + __PACKAGE__->make_group_wo_accessor('simple', 'lie', 'lie'); + __PACKAGE__->make_group_wo_accessor('simple', 'subj', 'subject'); + +=over 4 + +=item Arguments: $group, $field, $accessor + +Returns: \&accessor_coderef ? + +=back + +Called by mk_group_wo_accessors for each entry in @fieldspec. Either returns +a coderef which will be installed at C<&__PACKAGE__::$accessor>, or returns +C if it elects to install the coderef on its own. + +=cut + +sub make_group_wo_accessor { $gen_accessor->('wo', @_) } + + =head1 PERFORMANCE To provide total flexibility L calls methods @@ -463,6 +536,8 @@ Christopher H. Laco Caelum: Rafael Kitover +frew: Arthur Axel "fREW" Schmidt + groditi: Guillermo Roditi Jason Plum @@ -489,66 +564,10 @@ it under the same terms as perl itself. ######################################################################## ######################################################################## -BEGIN { - - die "Huh?! No minimum C::XSA version?!\n" - unless $__minimum_xsa_version; - - local $@; - my $err; - - - $err = eval { require Sub::Name; 1; } ? undef : do { - delete $INC{'Sub/Name.pm'}; # because older perls suck - $@; - }; - *__CAG_NO_SUBNAME = $err - ? sub () { $err } - : sub () { 0 } - ; - - - $err = eval { - require Class::XSAccessor; - Class::XSAccessor->VERSION($__minimum_xsa_version); - require Sub::Name; - 1; - } ? undef : do { - delete $INC{'Sub/Name.pm'}; # because older perls suck - delete $INC{'Class/XSAccessor.pm'}; - $@; - }; - *__CAG_NO_CXSA = $err - ? sub () { $err } - : sub () { 0 } - ; - - - *__CAG_BROKEN_GOTO = ($] < '5.008009') - ? sub () { 1 } - : sub () { 0 } - ; - - - *__CAG_UNSTABLE_DOLLARAT = ($] < '5.013002') - ? sub () { 1 } - : sub () { 0 } - ; - - - *__CAG_TRACK_UNDEFER_FAIL = ( - $INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'} - and - $0 =~ m|^ x?t / .+ \.t $|x - ) ? sub () { 1 } - : sub () { 0 } - ; -} - # Autodetect unless flag supplied my $xsa_autodetected; if (! defined $USE_XS) { - $USE_XS = __CAG_NO_CXSA ? 0 : 1; + $USE_XS = __CAG_ENV__::NO_CXSA ? 0 : 1; $xsa_autodetected++; } @@ -580,7 +599,7 @@ my $maker_templates = { ? shift->$get('$field') : do { my \$caller = caller; - my \$class = ref \$_[0] || \$_[0]; + my \$class = length( ref(\$_[0]) ) ? ref(\$_[0]) : \$_[0]; Carp::croak(\"'\$caller' cannot alter the value of '$field' \". \"(read-only attributes of class '\$class')\"); } @@ -599,7 +618,7 @@ my $maker_templates = { ? shift->$set('$field', \@_) : do { my \$caller = caller; - my \$class = ref \$_[0] || \$_[0]; + my \$class = length ( ref(\$_[0]) ) ? ref(\$_[0]) : \$_[0]; Carp::croak(\"'\$caller' cannot access the value of '$field' \". \"(write-only attributes of class '\$class')\"); } @@ -619,9 +638,7 @@ my $original_simple_setter = __PACKAGE__->can ('set_simple'); # Note!!! Unusual signature $gen_accessor = sub { my ($type, $class, $group, $field, $methname) = @_; - if (my $c = Scalar::Util::blessed( $class )) { - $class = $c; - } + $class = ref $class if length ref $class; # When installing an XSA simple accessor, we need to make sure we are not # short-circuiting a (compile or runtime) get_simple/set_simple override. @@ -633,21 +650,21 @@ $gen_accessor = sub { # Thus the final method (properly labeled and all) is installed in the # calling-package's namespace if ($USE_XS and $group eq 'simple') { - die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_NO_CXSA ) - if __CAG_NO_CXSA; + die sprintf( "Class::XSAccessor requested but not available:\n%s\n", __CAG_ENV__::NO_CXSA ) + if __CAG_ENV__::NO_CXSA; my ($expected_cref, $cached_implementation); my $ret = $expected_cref = sub { - my $current_class = Scalar::Util::blessed( $_[0] ) || $_[0]; + my $current_class = length (ref ($_[0] ) ) ? ref ($_[0]) : $_[0]; # $cached_implementation will be set only if the shim got # 'around'ed, in which case it is handy to avoid re-running # this block over and over again my $resolved_implementation = $cached_implementation->{$current_class} || do { if ( - $current_class->can('get_simple') == $original_simple_getter + ($current_class->can('get_simple')||0) == $original_simple_getter && - $current_class->can('set_simple') == $original_simple_setter + ($current_class->can('set_simple')||0) == $original_simple_setter ) { # nothing has changed, might as well use the XS crefs # @@ -689,7 +706,7 @@ $gen_accessor = sub { # if after this shim was created someone wrapped it with an 'around', # we can not blindly reinstall the method slot - we will destroy the # wrapper. Silently chain execution further... - if ( !$expected_cref or $expected_cref != $current_class->can($methname) ) { + if ( !$expected_cref or $expected_cref != ($current_class->can($methname)||0) ) { # there is no point in re-determining it on every subsequent call, # just store for future reference @@ -697,12 +714,12 @@ $gen_accessor = sub { # older perls segfault if the cref behind the goto throws # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878 - return $resolved_implementation->(@_) if __CAG_BROKEN_GOTO; + return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO; goto $resolved_implementation; } - if (__CAG_TRACK_UNDEFER_FAIL) { + if (__CAG_ENV__::TRACK_UNDEFER_FAIL) { my $deferred_calls_seen = do { no strict 'refs'; \%{"${current_class}::__cag_deferred_xs_shim_invocations"} @@ -739,7 +756,7 @@ $gen_accessor = sub { # older perls segfault if the cref behind the goto throws # http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878 - return $resolved_implementation->(@_) if __CAG_BROKEN_GOTO; + return $resolved_implementation->(@_) if __CAG_ENV__::BROKEN_GOTO; goto $resolved_implementation; }; @@ -749,12 +766,12 @@ $gen_accessor = sub { } # no Sub::Name - just install the coderefs directly (compiling every time) - elsif (__CAG_NO_SUBNAME) { + elsif (__CAG_ENV__::NO_SUBNAME) { my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= $maker_templates->{$type}{pp_code}->($group, $field); no warnings 'redefine'; - local $@ if __CAG_UNSTABLE_DOLLARAT; + local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT; eval "sub ${class}::${methname} { $src }"; undef; # so that no further attempt will be made to install anything @@ -766,7 +783,7 @@ $gen_accessor = sub { my $src = $accessor_maker_cache->{source}{$type}{$group}{$field} ||= $maker_templates->{$type}{pp_code}->($group, $field); - local $@ if __CAG_UNSTABLE_DOLLARAT; + local $@ if __CAG_ENV__::UNSTABLE_DOLLARAT; eval "sub { my \$dummy; sub { \$dummy if 0; $src } }" or die $@; })->() }