}
}
-our $VERSION = '0.10007';
+our $VERSION = '0.10010';
$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
# when changing minimum version don't forget to adjust Makefile.PL as well
constant->import( TRACK_UNDEFER_FAIL => (
$INC{'Test/Builder.pm'} || $INC{'Test/Builder2.pm'}
and
- $0 =~ m|^ x?t / .+ \.t $|x
+ $0 =~ m{ ^ (?: \. \/ )? x?t / .+ \.t $}x
) ? 1 : 0 );
+
+ sub perlstring ($) { q{"}. quotemeta( shift ). q{"} };
}
# 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
# %$*@!?&!&#*$!!!
+
+my $illegal_accessors_warned;
sub _mk_group_accessors {
my($self, $maker, $group, @fields) = @_;
my $class = length (ref ($self) ) ? ref ($self) : $self;
my ($name, $field) = (ref $_) ? (@$_) : ($_, $_);
- Carp::croak("Illegal accessor name '$name'")
- unless $name =~ /\A[A-Z_a-z][0-9A-Z_a-z]*\z/;
+ if ($name !~ /\A[A-Z_a-z][0-9A-Z_a-z]*\z/) {
+
+ if ($name =~ /\0/) {
+ Carp::croak(sprintf
+ "Illegal accessor name %s - nulls should never appear in stash keys",
+ __CAG_ENV__::perlstring($name),
+ );
+ }
+ elsif (! $ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK} ) {
+ Carp::croak(
+ "Illegal accessor name '$name'. If you want CAG to attempt creating "
+ . 'it anyway (possible if Sub::Name is available) set '
+ . '$ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK}'
+ );
+ }
+ elsif (__CAG_ENV__::NO_SUBNAME) {
+ Carp::croak(
+ "Unable to install accessor with illegal name '$name': "
+ . 'Sub::Name not available'
+ );
+ }
+ elsif (
+ # Because one of the former maintainers of DBIC::SL is a raging
+ # idiot, there is now a ton of DBIC code out there that attempts
+ # to create column accessors with illegal names. In the interest
+ # of not cluttering the logs of unsuspecting victims (unsuspecting
+ # because these accessors are unusuable anyway) we provide an
+ # explicit "do not warn at all" escape, until all such code is
+ # fixed (this will be a loooooong time >:(
+ $ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK} ne 'DO_NOT_WARN'
+ and
+ ! $illegal_accessors_warned->{$class}++
+ ) {
+ Carp::carp(
+ "Installing illegal accessor '$name' into $class, see "
+ . 'documentation for more details'
+ );
+ }
+ }
Carp::carp("Having a data accessor named '$name' in '$class' is unwise.")
if $name =~ /\A(?: DESTROY | AUTOLOAD | CLONE )\z/x;
L<this post|http://lo-f.at/glahn/2009/08/WritingPowerfulAccessorsForPerlClasses.html>
for more information.
+=head2 Notes on accessor names
+
+In general method names in Perl are considered identifiers, and as such need to
+conform to the identifier specification of C<qr/\A[A-Z_a-z][0-9A-Z_a-z]*\z/>.
+While it is rather easy to invoke methods with non-standard names
+(C<< $obj->${\"anything goes"} >>), it is not possible to properly declare such
+methods without the use of L<Sub::Name>. Since this module must be able to
+function identically with and without its optional dependencies, starting with
+version C<0.10008> attempting to declare an accessor with a non-standard name
+is a fatal error (such operations would silently succeed since version
+C<0.08004>, as long as L<Sub::Name> is present, or otherwise would result in a
+syntax error during a string eval).
+
+Unfortunately in the years since C<0.08004> a rather large body of code
+accumulated in the wild that does attempt to declare accessors with funny
+names. One notable perpetrator is L<DBIx::Class::Schema::Loader>, which under
+certain conditions could create accessors of the C<column> group which start
+with numbers and/or some other punctuation (the proper way would be to declare
+columns with the C<accessor> attribute set to C<undef>).
+
+Therefore an escape mechanism is provided via the environment variable
+C<CAG_ILLEGAL_ACCESSOR_NAME_OK>. When set to a true value, one warning is
+issued B<per class> on attempts to declare an accessor with a non-conforming
+name, and as long as L<Sub::Name> is available all accessors will be properly
+created. Regardless of this setting, accessor names containing nulls C<"\0">
+are disallowed, due to various deficiencies in perl itself.
+
+If your code base has too many instances of illegal accessor declarations, and
+a fix is not feasible due to time constraints, it is possible to disable the
+warnings altogether by setting C<$ENV{CAG_ILLEGAL_ACCESSOR_NAME_OK}> to
+C<DO_NOT_WARN> (observe capitalization).
+
=head1 METHODS
=head2 mk_group_accessors
=head2 Benchmark
-This is the result of a set/get/set loop benchmark on perl 5.12.1 with
-thread support, showcasing most popular accessor builders: L<Moose>, L<Mouse>,
-L<Moo>, L<CAF|Class::Accessor::Fast>, L<CAF_XS|Class::Accessor::Fast::XS>,
-L<XSA|Class::XSAccessor>, and L<CAF_XSA|Class::XSAccessor::Compat>:
-
- Rate CAG moOse CAF moUse moo HANDMADE CAF_XS moUse_XS moo_XS CAF_XSA XSA CAG_XS
- CAG 169/s -- -21% -24% -32% -32% -34% -59% -63% -67% -67% -67% -67%
- moOse 215/s 27% -- -3% -13% -13% -15% -48% -53% -58% -58% -58% -58%
- CAF 222/s 31% 3% -- -10% -10% -13% -46% -52% -57% -57% -57% -57%
- moUse 248/s 46% 15% 11% -- -0% -3% -40% -46% -52% -52% -52% -52%
- moo 248/s 46% 15% 11% 0% -- -3% -40% -46% -52% -52% -52% -52%
- HANDMADE 255/s 50% 18% 14% 3% 3% -- -38% -45% -50% -51% -51% -51%
- CAF_XS 411/s 143% 91% 85% 66% 66% 61% -- -11% -20% -20% -21% -21%
- moUse_XS 461/s 172% 114% 107% 86% 86% 81% 12% -- -10% -11% -11% -11%
- moo_XS 514/s 204% 139% 131% 107% 107% 102% 25% 12% -- -0% -1% -1%
- CAF_XSA 516/s 205% 140% 132% 108% 108% 103% 26% 12% 0% -- -0% -0%
- XSA 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% -- -0%
- CAG_XS 519/s 206% 141% 133% 109% 109% 104% 26% 13% 1% 0% 0% --
-
-Benchmark program is available in the root of the
+This is the benchmark of 200 get/get/set/get/set cycles on perl 5.16.2 with
+thread support, showcasing how this modules L<simple (CAG_S)|/get_simple>,
+L<inherited (CAG_INH)|/get_inherited> and L<inherited with parent-class data
+(CAG_INHP)|/get_inherited> accessors stack up against most popular accessor
+builders: L<Moose>, L<Moo>, L<Mo>, L<Mouse> (both pure-perl and XS variant),
+L<Object::Tiny::RW (OTRW)|Object::Tiny::RW>,
+L<Class::Accessor (CA)|Class::Accessor>,
+L<Class::Accessor::Lite (CAL)|Class::Accessor::Lite>,
+L<Class::Accessor::Fast (CAF)|Class::Accessor::Fast>,
+L<Class::Accessor::Fast::XS (CAF_XS)|Class::Accessor::Fast::XS>
+and L<Class::XSAccessor (XSA)|Class::XSAccessor>
+
+ Rate CAG_INHP CAG_INH CA CAG_S CAF moOse OTRW CAL mo moUse HANDMADE moo CAF_XS moUse_XS XSA
+
+ CAG_INHP 287.021+-0.02/s -- -0.3% -10.0% -37.1% -53.1% -53.6% -53.7% -54.1% -56.9% -59.0% -59.6% -59.8% -78.7% -81.9% -83.5%
+
+ CAG_INH 288.025+-0.031/s 0.3% -- -9.7% -36.9% -52.9% -53.5% -53.5% -53.9% -56.7% -58.8% -59.5% -59.7% -78.6% -81.9% -83.5%
+
+ CA 318.967+-0.047/s 11.1% 10.7% -- -30.1% -47.9% -48.5% -48.5% -49.0% -52.1% -54.4% -55.1% -55.3% -76.3% -79.9% -81.7%
+
+ CAG_S 456.107+-0.054/s 58.9% 58.4% 43.0% -- -25.4% -26.3% -26.4% -27.0% -31.5% -34.8% -35.8% -36.1% -66.1% -71.3% -73.9%
+
+ CAF 611.745+-0.099/s 113.1% 112.4% 91.8% 34.1% -- -1.2% -1.2% -2.1% -8.1% -12.6% -14.0% -14.3% -54.5% -61.5% -64.9%
+
+ moOse 619.051+-0.059/s 115.7% 114.9% 94.1% 35.7% 1.2% -- -0.1% -1.0% -7.0% -11.6% -12.9% -13.3% -54.0% -61.0% -64.5%
+
+ OTRW 619.475+-0.1/s 115.8% 115.1% 94.2% 35.8% 1.3% 0.1% -- -0.9% -6.9% -11.5% -12.9% -13.2% -54.0% -61.0% -64.5%
+
+ CAL 625.106+-0.085/s 117.8% 117.0% 96.0% 37.1% 2.2% 1.0% 0.9% -- -6.1% -10.7% -12.1% -12.5% -53.5% -60.6% -64.2%
+
+ mo 665.44+-0.12/s 131.8% 131.0% 108.6% 45.9% 8.8% 7.5% 7.4% 6.5% -- -4.9% -6.4% -6.8% -50.5% -58.1% -61.9%
+
+ moUse 699.9+-0.15/s 143.9% 143.0% 119.4% 53.5% 14.4% 13.1% 13.0% 12.0% 5.2% -- -1.6% -2.0% -48.0% -55.9% -59.9%
+
+ HANDMADE 710.98+-0.16/s 147.7% 146.8% 122.9% 55.9% 16.2% 14.9% 14.8% 13.7% 6.8% 1.6% -- -0.4% -47.2% -55.2% -59.2%
+
+ moo 714.04+-0.13/s 148.8% 147.9% 123.9% 56.6% 16.7% 15.3% 15.3% 14.2% 7.3% 2.0% 0.4% -- -46.9% -55.0% -59.1%
+
+ CAF_XS 1345.55+-0.051/s 368.8% 367.2% 321.8% 195.0% 120.0% 117.4% 117.2% 115.3% 102.2% 92.2% 89.3% 88.4% -- -15.3% -22.9%
+
+ moUse_XS 1588+-0.036/s 453.3% 451.3% 397.9% 248.2% 159.6% 156.5% 156.3% 154.0% 138.6% 126.9% 123.4% 122.4% 18.0% -- -9.0%
+
+ XSA 1744.67+-0.052/s 507.9% 505.7% 447.0% 282.5% 185.2% 181.8% 181.6% 179.1% 162.2% 149.3% 145.4% 144.3% 29.7% 9.9% --
+
+Benchmarking program is available in the root of the
L<repository|http://search.cpan.org/dist/Class-Accessor-Grouped/>:
=head2 Notes on Class::XSAccessor
$xsa_autodetected++;
}
-my $perlstring;
-if ($] < '5.008') {
- require Data::Dumper;
- my $d = Data::Dumper->new([])->Indent(0)->Purity(0)->Pad('')->Useqq(1)->Terse(1)->Freezer('')->Toaster('');
- $perlstring = sub { $d->Values([shift])->Dump };
-}
-else {
- require B;
- $perlstring = \&B::perlstring;
-}
-
my $maker_templates = {
rw => {
cxsa_call => 'accessors',
pp_generator => sub {
# my ($group, $fieldname) = @_;
- my $quoted_fieldname = $perlstring->($_[1]);
+ my $quoted_fieldname = __CAG_ENV__::perlstring($_[1]);
sprintf <<'EOS', ($_[0], $quoted_fieldname) x 2;
@_ > 1
cxsa_call => 'getters',
pp_generator => sub {
# my ($group, $fieldname) = @_;
- my $quoted_fieldname = $perlstring->($_[1]);
+ my $quoted_fieldname = __CAG_ENV__::perlstring($_[1]);
sprintf <<'EOS', $_[0], $quoted_fieldname;
@_ > 1
cxsa_call => 'setters',
pp_generator => sub {
# my ($group, $fieldname) = @_;
- my $quoted_fieldname = $perlstring->($_[1]);
+ my $quoted_fieldname = __CAG_ENV__::perlstring($_[1]);
sprintf <<'EOS', $_[0], $quoted_fieldname;
@_ > 1
my $original_simple_getter = __PACKAGE__->can ('get_simple');
my $original_simple_setter = __PACKAGE__->can ('set_simple');
+my ($resolved_methods, $cag_produced_crefs);
+
+sub CLONE {
+ my @crefs = grep { defined $_ } values %{$cag_produced_crefs||{}};
+ $cag_produced_crefs = @crefs
+ ? { map { $_ => $_ } @crefs }
+ : undef
+ ;
+}
+
# Note!!! Unusual signature
$gen_accessor = sub {
my ($type, $class, $group, $field, $methname) = @_;
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 $ret = sub {
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 {
+ my $resolved_implementation = $resolved_methods->{$current_class}{$methname} ||= do {
if (
($current_class->can('get_simple')||0) == $original_simple_getter
&&
# 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)||0) ) {
-
- # there is no point in re-determining it on every subsequent call,
- # just store for future reference
- $cached_implementation->{$current_class} ||= $resolved_implementation;
+ if ( ! $cag_produced_crefs->{ $current_class->can($methname) || 0 } ) {
# older perls segfault if the cref behind the goto throws
# http://rt.perl.org/rt3/Public/Bug/Display.html?id=35878
goto $resolved_implementation;
}
+
if (__CAG_ENV__::TRACK_UNDEFER_FAIL) {
my $deferred_calls_seen = do {
no strict 'refs';
\%{"${current_class}::__cag_deferred_xs_shim_invocations"}
};
my @cframe = caller(0);
+
if (my $already_seen = $deferred_calls_seen->{$cframe[3]}) {
Carp::carp (
"Deferred version of method $cframe[3] invoked more than once (originally "
my $fq_name = "${current_class}::${methname}";
*$fq_name = Sub::Name::subname($fq_name, $resolved_implementation);
-
- # need to update what the shim expects too *in case* its
- # ->can was cached for some moronic reason
- $expected_cref = $resolved_implementation;
- Scalar::Util::weaken($expected_cref);
}
+ # now things are installed - one ref less to carry
+ delete $resolved_methods->{$current_class}{$methname};
+
+ # but need to record it in the expectation registry *in case* it
+ # was cached via ->can for some moronic reason
+ Scalar::Util::weaken( $cag_produced_crefs->{$resolved_implementation} = $resolved_implementation );
+
+
# 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_ENV__::BROKEN_GOTO;
goto $resolved_implementation;
};
- Scalar::Util::weaken($expected_cref); # to break the self-reference
- $ret;
+ Scalar::Util::weaken($cag_produced_crefs->{$ret} = $ret);
+
+ $ret; # returning shim
}
# no Sub::Name - just install the coderefs directly (compiling every time)
projects / p5sagit/Class-Accessor-Grouped.git / blobdiff