Initial Commit
This commit is contained in:
Riley Schneider
447
database/perl/vendor/lib/namespace/autoclean.pm
vendored
Normal file
447
database/perl/vendor/lib/namespace/autoclean.pm
vendored
Normal file
@@ -0,0 +1,447 @@
|
||||
use strict;
|
||||
use warnings;
|
||||
|
||||
package namespace::autoclean; # git description: 0.28-24-g964adcf
|
||||
# ABSTRACT: Keep imports out of your namespace
|
||||
# KEYWORDS: namespaces clean dirty imports exports subroutines methods development
|
||||
|
||||
our $VERSION = '0.29';
|
||||
|
||||
use B::Hooks::EndOfScope 0.12;
|
||||
use List::Util qw( first );
|
||||
use namespace::clean 0.20;
|
||||
|
||||
#pod =head1 SYNOPSIS
|
||||
#pod
|
||||
#pod package Foo;
|
||||
#pod use namespace::autoclean;
|
||||
#pod use Some::Package qw/imported_function/;
|
||||
#pod
|
||||
#pod sub bar { imported_function('stuff') }
|
||||
#pod
|
||||
#pod # later on:
|
||||
#pod Foo->bar; # works
|
||||
#pod Foo->imported_function; # will fail. imported_function got cleaned after compilation
|
||||
#pod
|
||||
#pod =head1 DESCRIPTION
|
||||
#pod
|
||||
#pod When you import a function into a Perl package, it will naturally also be
|
||||
#pod available as a method.
|
||||
#pod
|
||||
#pod The C<namespace::autoclean> pragma will remove all imported symbols at the end
|
||||
#pod of the current package's compile cycle. Functions called in the package itself
|
||||
#pod will still be bound by their name, but they won't show up as methods on your
|
||||
#pod class or instances.
|
||||
#pod
|
||||
#pod This module is very similar to L<namespace::clean|namespace::clean>, except it
|
||||
#pod will clean all imported functions, no matter if you imported them before or
|
||||
#pod after you C<use>d the pragma. It will also not touch anything that looks like a
|
||||
#pod method.
|
||||
#pod
|
||||
#pod If you're writing an exporter and you want to clean up after yourself (and your
|
||||
#pod peers), you can use the C<-cleanee> switch to specify what package to clean:
|
||||
#pod
|
||||
#pod package My::MooseX::namespace::autoclean;
|
||||
#pod use strict;
|
||||
#pod
|
||||
#pod use namespace::autoclean (); # no cleanup, just load
|
||||
#pod
|
||||
#pod sub import {
|
||||
#pod namespace::autoclean->import(
|
||||
#pod -cleanee => scalar(caller),
|
||||
#pod );
|
||||
#pod }
|
||||
#pod
|
||||
#pod =head1 WHAT IS AND ISN'T CLEANED
|
||||
#pod
|
||||
#pod C<namespace::autoclean> will leave behind anything that it deems a method. For
|
||||
#pod L<Moose> classes, this the based on the C<get_method_list> method
|
||||
#pod on from the L<Class::MOP::Class|metaclass>. For non-Moose classes, anything
|
||||
#pod defined within the package will be identified as a method. This should match
|
||||
#pod Moose's definition of a method. Additionally, the magic subs installed by
|
||||
#pod L<overload> will not be cleaned.
|
||||
#pod
|
||||
#pod =head1 PARAMETERS
|
||||
#pod
|
||||
#pod =head2 -also => [ ITEM | REGEX | SUB, .. ]
|
||||
#pod
|
||||
#pod =head2 -also => ITEM
|
||||
#pod
|
||||
#pod =head2 -also => REGEX
|
||||
#pod
|
||||
#pod =head2 -also => SUB
|
||||
#pod
|
||||
#pod Sometimes you don't want to clean imports only, but also helper functions
|
||||
#pod you're using in your methods. The C<-also> switch can be used to declare a list
|
||||
#pod of functions that should be removed additional to any imports:
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => ['some_function', 'another_function'];
|
||||
#pod
|
||||
#pod If only one function needs to be additionally cleaned the C<-also> switch also
|
||||
#pod accepts a plain string:
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => 'some_function';
|
||||
#pod
|
||||
#pod In some situations, you may wish for a more I<powerful> cleaning solution.
|
||||
#pod
|
||||
#pod The C<-also> switch can take a Regex or a CodeRef to match against local
|
||||
#pod function names to clean.
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => qr/^_/
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => sub { $_ =~ m{^_} };
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => [qr/^_/ , qr/^hidden_/ ];
|
||||
#pod
|
||||
#pod use namespace::autoclean -also => [sub { $_ =~ m/^_/ or $_ =~ m/^hidden/ }, sub { uc($_) == $_ } ];
|
||||
#pod
|
||||
#pod =head2 -except => [ ITEM | REGEX | SUB, .. ]
|
||||
#pod
|
||||
#pod =head2 -except => ITEM
|
||||
#pod
|
||||
#pod =head2 -except => REGEX
|
||||
#pod
|
||||
#pod =head2 -except => SUB
|
||||
#pod
|
||||
#pod This takes exactly the same options as C<-also> except that anything this
|
||||
#pod matches will I<not> be cleaned.
|
||||
#pod
|
||||
#pod =head1 CAVEATS
|
||||
#pod
|
||||
#pod When used with L<Moo> classes, the heuristic used to check for methods won't
|
||||
#pod work correctly for methods from roles consumed at compile time.
|
||||
#pod
|
||||
#pod package My::Class;
|
||||
#pod use Moo;
|
||||
#pod use namespace::autoclean;
|
||||
#pod
|
||||
#pod # Bad, any consumed methods will be cleaned
|
||||
#pod BEGIN { with 'Some::Role' }
|
||||
#pod
|
||||
#pod # Good, methods from role will be maintained
|
||||
#pod with 'Some::Role';
|
||||
#pod
|
||||
#pod Additionally, method detection may not work properly in L<Mouse> classes in
|
||||
#pod perls earlier than 5.10.
|
||||
#pod
|
||||
#pod =head1 SEE ALSO
|
||||
#pod
|
||||
#pod =for :list
|
||||
#pod * L<namespace::clean>
|
||||
#pod * L<B::Hooks::EndOfScope>
|
||||
#pod * L<namespace::sweep>
|
||||
#pod * L<Sub::Exporter::ForMethods>
|
||||
#pod * L<Sub::Name>
|
||||
#pod * L<Sub::Install>
|
||||
#pod * L<Test::CleanNamespaces>
|
||||
#pod * L<Dist::Zilla::Plugin::Test::CleanNamespaces>
|
||||
#pod
|
||||
#pod =cut
|
||||
|
||||
sub import {
|
||||
my ($class, %args) = @_;
|
||||
|
||||
my $subcast = sub {
|
||||
my $i = shift;
|
||||
return $i if ref $i eq 'CODE';
|
||||
return sub { $_ =~ $i } if ref $i eq 'Regexp';
|
||||
return sub { $_ eq $i };
|
||||
};
|
||||
|
||||
my $runtest = sub {
|
||||
my ($code, $method_name) = @_;
|
||||
local $_ = $method_name;
|
||||
return $code->();
|
||||
};
|
||||
|
||||
my $cleanee = exists $args{-cleanee} ? $args{-cleanee} : scalar caller;
|
||||
|
||||
my @also = map $subcast->($_), (
|
||||
exists $args{-also}
|
||||
? (ref $args{-also} eq 'ARRAY' ? @{ $args{-also} } : $args{-also})
|
||||
: ()
|
||||
);
|
||||
|
||||
my @except = map $subcast->($_), (
|
||||
exists $args{-except}
|
||||
? (ref $args{-except} eq 'ARRAY' ? @{ $args{-except} } : $args{-except})
|
||||
: ()
|
||||
);
|
||||
|
||||
on_scope_end {
|
||||
my $subs = namespace::clean->get_functions($cleanee);
|
||||
my $method_check = _method_check($cleanee);
|
||||
|
||||
my @clean = grep {
|
||||
my $method = $_;
|
||||
! first { $runtest->($_, $method) } @except
|
||||
and ( !$method_check->($method)
|
||||
or first { $runtest->($_, $method) } @also)
|
||||
} keys %$subs;
|
||||
|
||||
namespace::clean->clean_subroutines($cleanee, @clean);
|
||||
};
|
||||
}
|
||||
|
||||
sub _method_check {
|
||||
my $package = shift;
|
||||
if (
|
||||
(defined &Class::MOP::class_of and my $meta = Class::MOP::class_of($package))
|
||||
) {
|
||||
my %methods = map +($_ => 1), $meta->get_method_list;
|
||||
$methods{meta} = 1
|
||||
if $meta->isa('Moose::Meta::Role') && Moose->VERSION < 0.90;
|
||||
return sub { $_[0] =~ /^\(/ || $methods{$_[0]} };
|
||||
}
|
||||
else {
|
||||
my $does = $package->can('does') ? 'does'
|
||||
: $package->can('DOES') ? 'DOES'
|
||||
: undef;
|
||||
require Sub::Identify;
|
||||
return sub {
|
||||
return 1 if $_[0] =~ /^\(/;
|
||||
my $coderef = do { no strict 'refs'; \&{ $package . '::' . $_[0] } };
|
||||
my $code_stash = Sub::Identify::stash_name($coderef);
|
||||
return 1 if $code_stash eq $package;
|
||||
return 1 if $code_stash eq 'constant';
|
||||
# TODO: consider if we really need this eval
|
||||
return 1 if $does && eval { $package->$does($code_stash) };
|
||||
return 0;
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=pod
|
||||
|
||||
=encoding UTF-8
|
||||
|
||||
=head1 NAME
|
||||
|
||||
namespace::autoclean - Keep imports out of your namespace
|
||||
|
||||
=head1 VERSION
|
||||
|
||||
version 0.29
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
package Foo;
|
||||
use namespace::autoclean;
|
||||
use Some::Package qw/imported_function/;
|
||||
|
||||
sub bar { imported_function('stuff') }
|
||||
|
||||
# later on:
|
||||
Foo->bar; # works
|
||||
Foo->imported_function; # will fail. imported_function got cleaned after compilation
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
When you import a function into a Perl package, it will naturally also be
|
||||
available as a method.
|
||||
|
||||
The C<namespace::autoclean> pragma will remove all imported symbols at the end
|
||||
of the current package's compile cycle. Functions called in the package itself
|
||||
will still be bound by their name, but they won't show up as methods on your
|
||||
class or instances.
|
||||
|
||||
This module is very similar to L<namespace::clean|namespace::clean>, except it
|
||||
will clean all imported functions, no matter if you imported them before or
|
||||
after you C<use>d the pragma. It will also not touch anything that looks like a
|
||||
method.
|
||||
|
||||
If you're writing an exporter and you want to clean up after yourself (and your
|
||||
peers), you can use the C<-cleanee> switch to specify what package to clean:
|
||||
|
||||
package My::MooseX::namespace::autoclean;
|
||||
use strict;
|
||||
|
||||
use namespace::autoclean (); # no cleanup, just load
|
||||
|
||||
sub import {
|
||||
namespace::autoclean->import(
|
||||
-cleanee => scalar(caller),
|
||||
);
|
||||
}
|
||||
|
||||
=head1 WHAT IS AND ISN'T CLEANED
|
||||
|
||||
C<namespace::autoclean> will leave behind anything that it deems a method. For
|
||||
L<Moose> classes, this the based on the C<get_method_list> method
|
||||
on from the L<Class::MOP::Class|metaclass>. For non-Moose classes, anything
|
||||
defined within the package will be identified as a method. This should match
|
||||
Moose's definition of a method. Additionally, the magic subs installed by
|
||||
L<overload> will not be cleaned.
|
||||
|
||||
=head1 PARAMETERS
|
||||
|
||||
=head2 -also => [ ITEM | REGEX | SUB, .. ]
|
||||
|
||||
=head2 -also => ITEM
|
||||
|
||||
=head2 -also => REGEX
|
||||
|
||||
=head2 -also => SUB
|
||||
|
||||
Sometimes you don't want to clean imports only, but also helper functions
|
||||
you're using in your methods. The C<-also> switch can be used to declare a list
|
||||
of functions that should be removed additional to any imports:
|
||||
|
||||
use namespace::autoclean -also => ['some_function', 'another_function'];
|
||||
|
||||
If only one function needs to be additionally cleaned the C<-also> switch also
|
||||
accepts a plain string:
|
||||
|
||||
use namespace::autoclean -also => 'some_function';
|
||||
|
||||
In some situations, you may wish for a more I<powerful> cleaning solution.
|
||||
|
||||
The C<-also> switch can take a Regex or a CodeRef to match against local
|
||||
function names to clean.
|
||||
|
||||
use namespace::autoclean -also => qr/^_/
|
||||
|
||||
use namespace::autoclean -also => sub { $_ =~ m{^_} };
|
||||
|
||||
use namespace::autoclean -also => [qr/^_/ , qr/^hidden_/ ];
|
||||
|
||||
use namespace::autoclean -also => [sub { $_ =~ m/^_/ or $_ =~ m/^hidden/ }, sub { uc($_) == $_ } ];
|
||||
|
||||
=head2 -except => [ ITEM | REGEX | SUB, .. ]
|
||||
|
||||
=head2 -except => ITEM
|
||||
|
||||
=head2 -except => REGEX
|
||||
|
||||
=head2 -except => SUB
|
||||
|
||||
This takes exactly the same options as C<-also> except that anything this
|
||||
matches will I<not> be cleaned.
|
||||
|
||||
=head1 CAVEATS
|
||||
|
||||
When used with L<Moo> classes, the heuristic used to check for methods won't
|
||||
work correctly for methods from roles consumed at compile time.
|
||||
|
||||
package My::Class;
|
||||
use Moo;
|
||||
use namespace::autoclean;
|
||||
|
||||
# Bad, any consumed methods will be cleaned
|
||||
BEGIN { with 'Some::Role' }
|
||||
|
||||
# Good, methods from role will be maintained
|
||||
with 'Some::Role';
|
||||
|
||||
Additionally, method detection may not work properly in L<Mouse> classes in
|
||||
perls earlier than 5.10.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
=over 4
|
||||
|
||||
=item *
|
||||
|
||||
L<namespace::clean>
|
||||
|
||||
=item *
|
||||
|
||||
L<B::Hooks::EndOfScope>
|
||||
|
||||
=item *
|
||||
|
||||
L<namespace::sweep>
|
||||
|
||||
=item *
|
||||
|
||||
L<Sub::Exporter::ForMethods>
|
||||
|
||||
=item *
|
||||
|
||||
L<Sub::Name>
|
||||
|
||||
=item *
|
||||
|
||||
L<Sub::Install>
|
||||
|
||||
=item *
|
||||
|
||||
L<Test::CleanNamespaces>
|
||||
|
||||
=item *
|
||||
|
||||
L<Dist::Zilla::Plugin::Test::CleanNamespaces>
|
||||
|
||||
=back
|
||||
|
||||
=head1 SUPPORT
|
||||
|
||||
Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=namespace-autoclean>
|
||||
(or L<bug-namespace-autoclean@rt.cpan.org|mailto:bug-namespace-autoclean@rt.cpan.org>).
|
||||
|
||||
There is also a mailing list available for users of this distribution, at
|
||||
L<http://lists.perl.org/list/moose.html>.
|
||||
|
||||
There is also an irc channel available for users of this distribution, at
|
||||
L<C<#moose> on C<irc.perl.org>|irc://irc.perl.org/#moose>.
|
||||
|
||||
=head1 AUTHOR
|
||||
|
||||
Florian Ragwitz <rafl@debian.org>
|
||||
|
||||
=head1 CONTRIBUTORS
|
||||
|
||||
=for stopwords Karen Etheridge Graham Knop Dave Rolsky Kent Fredric Tomas Doran Shawn M Moore Felix Ostmann Chris Prather Andrew Rodland
|
||||
|
||||
=over 4
|
||||
|
||||
=item *
|
||||
|
||||
Karen Etheridge <ether@cpan.org>
|
||||
|
||||
=item *
|
||||
|
||||
Graham Knop <haarg@haarg.org>
|
||||
|
||||
=item *
|
||||
|
||||
Dave Rolsky <autarch@urth.org>
|
||||
|
||||
=item *
|
||||
|
||||
Kent Fredric <kentfredric@gmail.com>
|
||||
|
||||
=item *
|
||||
|
||||
Tomas Doran <bobtfish@bobtfish.net>
|
||||
|
||||
=item *
|
||||
|
||||
Shawn M Moore <cpan@sartak.org>
|
||||
|
||||
=item *
|
||||
|
||||
Felix Ostmann <sadrak@cpan.org>
|
||||
|
||||
=item *
|
||||
|
||||
Chris Prather <chris@prather.org>
|
||||
|
||||
=item *
|
||||
|
||||
Andrew Rodland <arodland@cpan.org>
|
||||
|
||||
=back
|
||||
|
||||
=head1 COPYRIGHT AND LICENCE
|
||||
|
||||
This software is copyright (c) 2009 by Florian Ragwitz.
|
||||
|
||||
This is free software; you can redistribute it and/or modify it under
|
||||
the same terms as the Perl 5 programming language system itself.
|
||||
|
||||
=cut
|
||||
466
database/perl/vendor/lib/namespace/clean.pm
vendored
Normal file
466
database/perl/vendor/lib/namespace/clean.pm
vendored
Normal file
@@ -0,0 +1,466 @@
|
||||
package namespace::clean;
|
||||
|
||||
use warnings;
|
||||
use strict;
|
||||
|
||||
our $VERSION = '0.27';
|
||||
$VERSION = eval $VERSION if $VERSION =~ /_/; # numify for warning-free dev releases
|
||||
|
||||
our $STORAGE_VAR = '__NAMESPACE_CLEAN_STORAGE';
|
||||
|
||||
use B::Hooks::EndOfScope 'on_scope_end';
|
||||
|
||||
# FIXME This is a crock of shit, needs to go away
|
||||
# currently here to work around https://rt.cpan.org/Ticket/Display.html?id=74151
|
||||
# kill with fire when PS::XS is *finally* fixed
|
||||
BEGIN {
|
||||
my $provider;
|
||||
|
||||
if ( "$]" < 5.008007 ) {
|
||||
require Package::Stash::PP;
|
||||
$provider = 'Package::Stash::PP';
|
||||
}
|
||||
else {
|
||||
require Package::Stash;
|
||||
$provider = 'Package::Stash';
|
||||
}
|
||||
eval <<"EOS" or die $@;
|
||||
|
||||
sub stash_for (\$) {
|
||||
$provider->new(\$_[0]);
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
EOS
|
||||
}
|
||||
|
||||
use namespace::clean::_Util qw( DEBUGGER_NEEDS_CV_RENAME DEBUGGER_NEEDS_CV_PIVOT );
|
||||
|
||||
# Built-in debugger CV-retrieval fixups necessary before perl 5.15.5:
|
||||
# since we are deleting the glob where the subroutine was originally
|
||||
# defined, the assumptions below no longer hold.
|
||||
#
|
||||
# In 5.8.9 ~ 5.13.5 (inclusive) the debugger assumes that a CV can
|
||||
# always be found under sub_fullname($sub)
|
||||
# Workaround: use sub naming to properly name the sub hidden in the package's
|
||||
# deleted-stash
|
||||
#
|
||||
# In the rest of the range ( ... ~ 5.8.8 and 5.13.6 ~ 5.15.4 ) the debugger
|
||||
# assumes the name of the glob passed to entersub can be used to find the CV
|
||||
# Workaround: realias the original glob to the deleted-stash slot
|
||||
#
|
||||
# While the errors manifest themselves inside perl5db.pl, they are caused by
|
||||
# problems inside the interpreter. If enabled ($^P & 0x01) and existent,
|
||||
# the DB::sub sub will be called by the interpreter for any sub call rather
|
||||
# that call the sub directly. It is provided the real sub to call in $DB::sub,
|
||||
# but the value given has the issues described above. We only have to enable
|
||||
# the workaround if DB::sub will be used.
|
||||
#
|
||||
# Can not tie constants to the current value of $^P directly,
|
||||
# as the debugger can be enabled during runtime (kinda dubious)
|
||||
#
|
||||
|
||||
my $RemoveSubs = sub {
|
||||
my $cleanee = shift;
|
||||
my $store = shift;
|
||||
my $cleanee_stash = stash_for($cleanee);
|
||||
my $deleted_stash;
|
||||
|
||||
SYMBOL:
|
||||
for my $f (@_) {
|
||||
|
||||
# ignore already removed symbols
|
||||
next SYMBOL if $store->{exclude}{ $f };
|
||||
|
||||
my $sub = $cleanee_stash->get_symbol("&$f")
|
||||
or next SYMBOL;
|
||||
|
||||
my $need_debugger_fixup =
|
||||
( DEBUGGER_NEEDS_CV_RENAME or DEBUGGER_NEEDS_CV_PIVOT )
|
||||
&&
|
||||
$^P & 0x01
|
||||
&&
|
||||
defined &DB::sub
|
||||
&&
|
||||
ref(my $globref = \$cleanee_stash->namespace->{$f}) eq 'GLOB'
|
||||
&&
|
||||
( $deleted_stash ||= stash_for("namespace::clean::deleted::$cleanee") )
|
||||
;
|
||||
|
||||
# convince the Perl debugger to work
|
||||
# see the comment on top
|
||||
if ( DEBUGGER_NEEDS_CV_RENAME and $need_debugger_fixup ) {
|
||||
#
|
||||
# Note - both get_subname and set_subname are only compiled when CV_RENAME
|
||||
# is true ( the 5.8.9 ~ 5.12 range ). On other perls this entire block is
|
||||
# constant folded away, and so are the definitions in ::_Util
|
||||
#
|
||||
# Do not be surprised that they are missing without DEBUGGER_NEEDS_CV_RENAME
|
||||
#
|
||||
namespace::clean::_Util::get_subname( $sub ) eq ( $cleanee_stash->name . "::$f" )
|
||||
and
|
||||
$deleted_stash->add_symbol(
|
||||
"&$f",
|
||||
namespace::clean::_Util::set_subname( $deleted_stash->name . "::$f", $sub ),
|
||||
);
|
||||
}
|
||||
elsif ( DEBUGGER_NEEDS_CV_PIVOT and $need_debugger_fixup ) {
|
||||
$deleted_stash->add_symbol("&$f", $sub);
|
||||
}
|
||||
|
||||
my @symbols = map {
|
||||
my $name = $_ . $f;
|
||||
my $def = $cleanee_stash->get_symbol($name);
|
||||
defined($def) ? [$name, $def] : ()
|
||||
} '$', '@', '%', '';
|
||||
|
||||
$cleanee_stash->remove_glob($f);
|
||||
|
||||
# if this perl needs no renaming trick we need to
|
||||
# rename the original glob after the fact
|
||||
DEBUGGER_NEEDS_CV_PIVOT
|
||||
and
|
||||
$need_debugger_fixup
|
||||
and
|
||||
*$globref = $deleted_stash->namespace->{$f};
|
||||
|
||||
$cleanee_stash->add_symbol(@$_) for @symbols;
|
||||
}
|
||||
};
|
||||
|
||||
sub clean_subroutines {
|
||||
my ($nc, $cleanee, @subs) = @_;
|
||||
$RemoveSubs->($cleanee, {}, @subs);
|
||||
}
|
||||
|
||||
sub import {
|
||||
my ($pragma, @args) = @_;
|
||||
|
||||
my (%args, $is_explicit);
|
||||
|
||||
ARG:
|
||||
while (@args) {
|
||||
|
||||
if ($args[0] =~ /^\-/) {
|
||||
my $key = shift @args;
|
||||
my $value = shift @args;
|
||||
$args{ $key } = $value;
|
||||
}
|
||||
else {
|
||||
$is_explicit++;
|
||||
last ARG;
|
||||
}
|
||||
}
|
||||
|
||||
my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller;
|
||||
if ($is_explicit) {
|
||||
on_scope_end {
|
||||
$RemoveSubs->($cleanee, {}, @args);
|
||||
};
|
||||
}
|
||||
else {
|
||||
|
||||
# calling class, all current functions and our storage
|
||||
my $functions = $pragma->get_functions($cleanee);
|
||||
my $store = $pragma->get_class_store($cleanee);
|
||||
my $stash = stash_for($cleanee);
|
||||
|
||||
# except parameter can be array ref or single value
|
||||
my %except = map {( $_ => 1 )} (
|
||||
$args{ -except }
|
||||
? ( ref $args{ -except } eq 'ARRAY' ? @{ $args{ -except } } : $args{ -except } )
|
||||
: ()
|
||||
);
|
||||
|
||||
# register symbols for removal, if they have a CODE entry
|
||||
for my $f (keys %$functions) {
|
||||
next if $except{ $f };
|
||||
next unless $stash->has_symbol("&$f");
|
||||
$store->{remove}{ $f } = 1;
|
||||
}
|
||||
|
||||
on_scope_end {
|
||||
$RemoveSubs->($cleanee, $store, keys %{ $store->{remove} });
|
||||
};
|
||||
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
sub unimport {
|
||||
my ($pragma, %args) = @_;
|
||||
|
||||
# the calling class, the current functions and our storage
|
||||
my $cleanee = exists $args{ -cleanee } ? $args{ -cleanee } : scalar caller;
|
||||
my $functions = $pragma->get_functions($cleanee);
|
||||
my $store = $pragma->get_class_store($cleanee);
|
||||
|
||||
# register all unknown previous functions as excluded
|
||||
for my $f (keys %$functions) {
|
||||
next if $store->{remove}{ $f }
|
||||
or $store->{exclude}{ $f };
|
||||
$store->{exclude}{ $f } = 1;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
sub get_class_store {
|
||||
my ($pragma, $class) = @_;
|
||||
my $stash = stash_for($class);
|
||||
my $var = "%$STORAGE_VAR";
|
||||
$stash->add_symbol($var, {})
|
||||
unless $stash->has_symbol($var);
|
||||
return $stash->get_symbol($var);
|
||||
}
|
||||
|
||||
sub get_functions {
|
||||
my ($pragma, $class) = @_;
|
||||
|
||||
my $stash = stash_for($class);
|
||||
return {
|
||||
map { $_ => $stash->get_symbol("&$_") }
|
||||
$stash->list_all_symbols('CODE')
|
||||
};
|
||||
}
|
||||
|
||||
'Danger! Laws of Thermodynamics may not apply.'
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
namespace::clean - Keep imports and functions out of your namespace
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
package Foo;
|
||||
use warnings;
|
||||
use strict;
|
||||
|
||||
use Carp qw(croak); # 'croak' will be removed
|
||||
|
||||
sub bar { 23 } # 'bar' will be removed
|
||||
|
||||
# remove all previously defined functions
|
||||
use namespace::clean;
|
||||
|
||||
sub baz { bar() } # 'baz' still defined, 'bar' still bound
|
||||
|
||||
# begin to collection function names from here again
|
||||
no namespace::clean;
|
||||
|
||||
sub quux { baz() } # 'quux' will be removed
|
||||
|
||||
# remove all functions defined after the 'no' unimport
|
||||
use namespace::clean;
|
||||
|
||||
# Will print: 'No', 'No', 'Yes' and 'No'
|
||||
print +(__PACKAGE__->can('croak') ? 'Yes' : 'No'), "\n";
|
||||
print +(__PACKAGE__->can('bar') ? 'Yes' : 'No'), "\n";
|
||||
print +(__PACKAGE__->can('baz') ? 'Yes' : 'No'), "\n";
|
||||
print +(__PACKAGE__->can('quux') ? 'Yes' : 'No'), "\n";
|
||||
|
||||
1;
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
=head2 Keeping packages clean
|
||||
|
||||
When you define a function, or import one, into a Perl package, it will
|
||||
naturally also be available as a method. This does not per se cause
|
||||
problems, but it can complicate subclassing and, for example, plugin
|
||||
classes that are included via multiple inheritance by loading them as
|
||||
base classes.
|
||||
|
||||
The C<namespace::clean> pragma will remove all previously declared or
|
||||
imported symbols at the end of the current package's compile cycle.
|
||||
Functions called in the package itself will still be bound by their
|
||||
name, but they won't show up as methods on your class or instances.
|
||||
|
||||
By unimporting via C<no> you can tell C<namespace::clean> to start
|
||||
collecting functions for the next C<use namespace::clean;> specification.
|
||||
|
||||
You can use the C<-except> flag to tell C<namespace::clean> that you
|
||||
don't want it to remove a certain function or method. A common use would
|
||||
be a module exporting an C<import> method along with some functions:
|
||||
|
||||
use ModuleExportingImport;
|
||||
use namespace::clean -except => [qw( import )];
|
||||
|
||||
If you just want to C<-except> a single sub, you can pass it directly.
|
||||
For more than one value you have to use an array reference.
|
||||
|
||||
=head3 Late binding caveat
|
||||
|
||||
Note that the L<technique used by this module|/IMPLEMENTATION DETAILS> relies
|
||||
on perl having resolved all names to actual code references during the
|
||||
compilation of a scope. While this is almost always what the interpreter does,
|
||||
there are some exceptions, notably the L<sort SUBNAME|perlfunc/sort> style of
|
||||
the C<sort> built-in invocation. The following example will not work, because
|
||||
C<sort> does not try to resolve the function name to an actual code reference
|
||||
until B<runtime>.
|
||||
|
||||
use MyApp::Utils 'my_sorter';
|
||||
use namespace::clean;
|
||||
|
||||
my @sorted = sort my_sorter @list;
|
||||
|
||||
You need to work around this by forcing a compile-time resolution like so:
|
||||
|
||||
use MyApp::Utils 'my_sorter';
|
||||
use namespace::clean;
|
||||
|
||||
my $my_sorter_cref = \&my_sorter;
|
||||
|
||||
my @sorted = sort $my_sorter_cref @list;
|
||||
|
||||
=head2 Explicitly removing functions when your scope is compiled
|
||||
|
||||
It is also possible to explicitly tell C<namespace::clean> what packages
|
||||
to remove when the surrounding scope has finished compiling. Here is an
|
||||
example:
|
||||
|
||||
package Foo;
|
||||
use strict;
|
||||
|
||||
# blessed NOT available
|
||||
|
||||
sub my_class {
|
||||
use Scalar::Util qw( blessed );
|
||||
use namespace::clean qw( blessed );
|
||||
|
||||
# blessed available
|
||||
return blessed shift;
|
||||
}
|
||||
|
||||
# blessed NOT available
|
||||
|
||||
=head2 Moose
|
||||
|
||||
When using C<namespace::clean> together with L<Moose> you want to keep
|
||||
the installed C<meta> method. So your classes should look like:
|
||||
|
||||
package Foo;
|
||||
use Moose;
|
||||
use namespace::clean -except => 'meta';
|
||||
...
|
||||
|
||||
Same goes for L<Moose::Role>.
|
||||
|
||||
=head2 Cleaning other packages
|
||||
|
||||
You can tell C<namespace::clean> that you want to clean up another package
|
||||
instead of the one importing. To do this you have to pass in the C<-cleanee>
|
||||
option like this:
|
||||
|
||||
package My::MooseX::namespace::clean;
|
||||
use strict;
|
||||
|
||||
use namespace::clean (); # no cleanup, just load
|
||||
|
||||
sub import {
|
||||
namespace::clean->import(
|
||||
-cleanee => scalar(caller),
|
||||
-except => 'meta',
|
||||
);
|
||||
}
|
||||
|
||||
If you don't care about C<namespace::clean>s discover-and-C<-except> logic, and
|
||||
just want to remove subroutines, try L</clean_subroutines>.
|
||||
|
||||
=head1 METHODS
|
||||
|
||||
=head2 clean_subroutines
|
||||
|
||||
This exposes the actual subroutine-removal logic.
|
||||
|
||||
namespace::clean->clean_subroutines($cleanee, qw( subA subB ));
|
||||
|
||||
will remove C<subA> and C<subB> from C<$cleanee>. Note that this will remove the
|
||||
subroutines B<immediately> and not wait for scope end. If you want to have this
|
||||
effect at a specific time (e.g. C<namespace::clean> acts on scope compile end)
|
||||
it is your responsibility to make sure it runs at that time.
|
||||
|
||||
=head2 import
|
||||
|
||||
Makes a snapshot of the current defined functions and installs a
|
||||
L<B::Hooks::EndOfScope> hook in the current scope to invoke the cleanups.
|
||||
|
||||
|
||||
=head2 unimport
|
||||
|
||||
This method will be called when you do a
|
||||
|
||||
no namespace::clean;
|
||||
|
||||
It will start a new section of code that defines functions to clean up.
|
||||
|
||||
=head2 get_class_store
|
||||
|
||||
This returns a reference to a hash in a passed package containing
|
||||
information about function names included and excluded from removal.
|
||||
|
||||
=head2 get_functions
|
||||
|
||||
Takes a class as argument and returns all currently defined functions
|
||||
in it as a hash reference with the function name as key and a typeglob
|
||||
reference to the symbol as value.
|
||||
|
||||
=head1 IMPLEMENTATION DETAILS
|
||||
|
||||
This module works through the effect that a
|
||||
|
||||
delete $SomePackage::{foo};
|
||||
|
||||
will remove the C<foo> symbol from C<$SomePackage> for run time lookups
|
||||
(e.g., method calls) but will leave the entry alive to be called by
|
||||
already resolved names in the package itself. C<namespace::clean> will
|
||||
restore and therefor in effect keep all glob slots that aren't C<CODE>.
|
||||
|
||||
A test file has been added to the perl core to ensure that this behaviour
|
||||
will be stable in future releases.
|
||||
|
||||
Just for completeness sake, if you want to remove the symbol completely,
|
||||
use C<undef> instead.
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
L<B::Hooks::EndOfScope>
|
||||
|
||||
=head1 THANKS
|
||||
|
||||
Many thanks to Matt S Trout for the inspiration on the whole idea.
|
||||
|
||||
=head1 AUTHORS
|
||||
|
||||
=over
|
||||
|
||||
=item *
|
||||
|
||||
Robert 'phaylon' Sedlacek <rs@474.at>
|
||||
|
||||
=item *
|
||||
|
||||
Florian Ragwitz <rafl@debian.org>
|
||||
|
||||
=item *
|
||||
|
||||
Jesse Luehrs <doy@tozt.net>
|
||||
|
||||
=item *
|
||||
|
||||
Peter Rabbitson <ribasushi@cpan.org>
|
||||
|
||||
=item *
|
||||
|
||||
Father Chrysostomos <sprout@cpan.org>
|
||||
|
||||
=back
|
||||
|
||||
=head1 COPYRIGHT AND LICENSE
|
||||
|
||||
This software is copyright (c) 2011 by L</AUTHORS>
|
||||
|
||||
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
|
||||
112
database/perl/vendor/lib/namespace/clean/_Util.pm
vendored
Normal file
112
database/perl/vendor/lib/namespace/clean/_Util.pm
vendored
Normal file
@@ -0,0 +1,112 @@
|
||||
### !!!ACHTUNG!!!
|
||||
#
|
||||
# This module is to be loaded at configure time straight from the Makefile.PL
|
||||
# in order to get access to some of the constants / utils
|
||||
# None of the dependencies will be available yet at this point, so make
|
||||
# sure to never use anything beyond what the minimum supported perl came with
|
||||
# (no, relying on configure_requires is not ok)
|
||||
|
||||
package # hide from the pauses
|
||||
namespace::clean::_Util;
|
||||
|
||||
use warnings;
|
||||
use strict;
|
||||
|
||||
use base 'Exporter';
|
||||
our @EXPORT_OK = qw( DEBUGGER_NEEDS_CV_RENAME DEBUGGER_NEEDS_CV_PIVOT );
|
||||
|
||||
use constant DEBUGGER_NEEDS_CV_RENAME => ( ( "$]" > 5.008_008 ) and ( "$]" < 5.013_006 ) );
|
||||
use constant DEBUGGER_NEEDS_CV_PIVOT => ( ( ! DEBUGGER_NEEDS_CV_RENAME ) and ( "$]" < 5.015_005 ) );
|
||||
|
||||
# FIXME - ideally this needs to be provided by some abstraction lib
|
||||
# but we don't have that yet
|
||||
BEGIN {
|
||||
#
|
||||
# Note - both get_subname and set_subname are only called by one block
|
||||
# which is compiled away unless CV_RENAME is true ( the 5.8.9 ~ 5.12 range ).
|
||||
# Hence we compile/provide the definitions here only when needed
|
||||
#
|
||||
DEBUGGER_NEEDS_CV_RENAME and ( eval <<'EOS' or die $@ );
|
||||
{
|
||||
my( $sub_name_loaded, $sub_util_loaded );
|
||||
|
||||
sub _namer_load_error {
|
||||
return '' if $sub_util_loaded or $sub_name_loaded;
|
||||
|
||||
# if S::N is loaded first *and* so is B - then go with that, otherwise
|
||||
# prefer Sub::Util as S::U will provide a faster get_subname and will
|
||||
# not need further require() calls
|
||||
# this is rather arbitrary but remember this code exists only perls
|
||||
# between 5.8.9 ~ 5.13.5
|
||||
|
||||
# when changing version also change in Makefile.PL
|
||||
my $sn_ver = 0.04;
|
||||
|
||||
local $@;
|
||||
my $err = '';
|
||||
|
||||
(
|
||||
! (
|
||||
$INC{"B.pm"}
|
||||
and
|
||||
$INC{"Sub/Name.pm"}
|
||||
and
|
||||
eval { Sub::Name->VERSION($sn_ver) }
|
||||
)
|
||||
and
|
||||
eval { require Sub::Util }
|
||||
and
|
||||
# see https://github.com/moose/Moo/commit/dafa5118
|
||||
defined &Sub::Util::set_subname
|
||||
and
|
||||
$sub_util_loaded = 1
|
||||
)
|
||||
or
|
||||
(
|
||||
eval { require Sub::Name and Sub::Name->VERSION($sn_ver) }
|
||||
and
|
||||
$sub_name_loaded = 1
|
||||
)
|
||||
or
|
||||
$err = "When running under -d on this perl $], namespace::clean requires either Sub::Name $sn_ver or Sub::Util to be installed"
|
||||
;
|
||||
|
||||
$err;
|
||||
}
|
||||
|
||||
sub set_subname {
|
||||
if( my $err = _namer_load_error() ) {
|
||||
die $err;
|
||||
}
|
||||
elsif( $sub_name_loaded ) {
|
||||
&Sub::Name::subname;
|
||||
}
|
||||
elsif( $sub_util_loaded ) {
|
||||
&Sub::Util::set_subname;
|
||||
}
|
||||
else {
|
||||
die "How the fuck did we get here? Read source and debug please!";
|
||||
}
|
||||
}
|
||||
|
||||
sub get_subname {
|
||||
if(
|
||||
_namer_load_error()
|
||||
or
|
||||
! $sub_util_loaded
|
||||
) {
|
||||
require B;
|
||||
my $gv = B::svref_2object( $_[0] )->GV;
|
||||
join '::', $gv->STASH->NAME, $gv->NAME;
|
||||
}
|
||||
else {
|
||||
&Sub::Util::subname;
|
||||
}
|
||||
}
|
||||
}
|
||||
1;
|
||||
EOS
|
||||
|
||||
}
|
||||
|
||||
1;
|
||||
Reference in New Issue
Block a user