use strict;
use warnings;
-our $VERSION = '0.93';
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
-
use Class::MOP;
use List::MoreUtils qw( first_index uniq );
use Moose::Util::MetaRole;
+use Scalar::Util qw(reftype);
use Sub::Exporter 0.980;
use Sub::Name qw(subname);
sub setup_import_methods {
my ( $class, %args ) = @_;
- my $exporting_package = $args{exporting_package} ||= caller();
+ $args{exporting_package} ||= caller();
$class->build_import_methods(
%args,
$EXPORT_SPEC{$exporting_package} = \%args;
- my @exports_from = $class->_follow_also( $exporting_package );
+ my @exports_from = $class->_follow_also($exporting_package);
my $export_recorder = {};
+ my $is_reexport = {};
my $exports = $class->_make_sub_exporter_params(
- [ @exports_from, $exporting_package ], $export_recorder,
+ [ @exports_from, $exporting_package ],
+ $export_recorder,
+ $is_reexport,
);
- my $exporter = Sub::Exporter::build_exporter(
- {
- exports => $exports,
- groups => { default => [':all'] }
- }
- );
+ my $exporter = $class->_make_exporter($exports, $is_reexport);
my %methods;
- $methods{import} = $class->_make_import_sub( $exporting_package,
- $exporter, \@exports_from );
+ $methods{import} = $class->_make_import_sub(
+ $exporting_package,
+ $exporter,
+ \@exports_from,
+ $is_reexport
+ );
- $methods{unimport} = $class->_make_unimport_sub( $exporting_package,
- $exports, $export_recorder );
+ $methods{unimport} = $class->_make_unimport_sub(
+ $exporting_package,
+ $exports,
+ $export_recorder,
+ $is_reexport
+ );
- $methods{init_meta} = $class->_make_init_meta( $exporting_package,
- \%args );
+ $methods{init_meta} = $class->_make_init_meta(
+ $exporting_package,
+ \%args
+ );
my $package = Class::MOP::Package->initialize($exporting_package);
for my $to_install ( @{ $args{install} || [] } ) {
$package->add_package_symbol( $symbol, $methods{$to_install} );
}
- return ( $methods{import}, $methods{unimport}, $methods{init_meta} )
+ return ( $methods{import}, $methods{unimport}, $methods{init_meta} );
+}
+
+sub _make_exporter {
+ my ($class, $exports, $is_reexport) = @_;
+
+ return Sub::Exporter::build_exporter(
+ {
+ exports => $exports,
+ groups => { default => [':all'] },
+ installer => sub {
+ my ($arg, $to_export) = @_;
+ my $meta = Class::MOP::class_of($arg->{into});
+
+ goto &Sub::Exporter::default_installer unless $meta;
+
+ # don't overwrite existing symbols with our magically flagged
+ # version of it if we would install the same sub that's already
+ # in the importer
+
+ my @filtered_to_export;
+ my %installed;
+ for (my $i = 0; $i < @{ $to_export }; $i += 2) {
+ my ($as, $cv) = @{ $to_export }[$i, $i + 1];
+
+ next if !ref($as)
+ && $meta->has_package_symbol('&' . $as)
+ && $meta->get_package_symbol('&' . $as) == $cv;
+
+ push @filtered_to_export, $as, $cv;
+ $installed{$as} = 1 unless ref $as;
+ }
+
+ Sub::Exporter::default_installer($arg, \@filtered_to_export);
+
+ for my $name ( keys %{$is_reexport} ) {
+ no strict 'refs';
+ no warnings 'once';
+ next unless exists $installed{$name};
+ _flag_as_reexport( \*{ join q{::}, $arg->{into}, $name } );
+ }
+ },
+ }
+ );
}
{
local %$seen = ( $exporting_package => 1 );
- return uniq( _follow_also_real($exporting_package) );
+ return reverse uniq( _follow_also_real($exporting_package) );
}
sub _follow_also_real {
my $exporting_package = shift;
- if (!exists $EXPORT_SPEC{$exporting_package}) {
+ if ( !exists $EXPORT_SPEC{$exporting_package} ) {
my $loaded = Class::MOP::is_class_loaded($exporting_package);
die "Package in also ($exporting_package) does not seem to "
- . "use Moose::Exporter"
- . ($loaded ? "" : " (is it loaded?)");
+ . "use Moose::Exporter"
+ . ( $loaded ? "" : " (is it loaded?)" );
}
my $also = $EXPORT_SPEC{$exporting_package}{also};
my @also = ref $also ? @{$also} : $also;
- for my $package (@also)
- {
- die "Circular reference in 'also' parameter to Moose::Exporter between $exporting_package and $package"
+ for my $package (@also) {
+ die
+ "Circular reference in 'also' parameter to Moose::Exporter between $exporting_package and $package"
if $seen->{$package};
$seen->{$package} = 1;
}
}
+sub _parse_trait_aliases {
+ my $class = shift;
+ my ($package, $aliases) = @_;
+
+ my @ret;
+ for my $alias (@$aliases) {
+ my $name;
+ if (ref($alias)) {
+ reftype($alias) eq 'ARRAY'
+ or Moose->throw_error(reftype($alias) . " references are not "
+ . "valid arguments to the 'trait_aliases' "
+ . "option");
+
+ ($alias, $name) = @$alias;
+ }
+ else {
+ ($name = $alias) =~ s/.*:://;
+ }
+ push @ret, subname "${package}::${name}" => sub () { $alias };
+ }
+
+ return @ret;
+}
+
sub _make_sub_exporter_params {
- my $class = shift;
- my $packages = shift;
- my $export_recorder = shift;
+ my $class = shift;
+ my $packages = shift;
+ my $export_recorder = shift;
+ my $is_reexport = shift;
my %exports;
);
}
- for my $name ( @{ $args->{as_is} } ) {
- my ($sub, $coderef_name);
+ my @extra_exports = $class->_parse_trait_aliases(
+ $package, $args->{trait_aliases},
+ );
+ for my $name ( @{ $args->{as_is} }, @extra_exports ) {
+ my ( $sub, $coderef_name );
if ( ref $name ) {
$sub = $name;
( $coderef_pkg, $coderef_name )
= Class::MOP::get_code_info($name);
- # Moose re-exports things from Carp and Scalar::Util. Usually,
- # we want to remove those again at unimport time. However, the
- # importing package might have imported those symbols
- # explicitly after using Moose ala
- #
- # use Moose;
- # use Carp qw( confess );
- #
- # In this case, we don't want to remove 'confess' when
- # unimporting. To do that, we wrap the exports from other
- # packages in anonymous coderef. Then, at unimport time, we
- # can figure out if the package symbol still contains the
- # coderef we exported, or if the user overwrote it with
- # something else we don't want to remove.
if ( $coderef_pkg ne $package ) {
- $sub = sub { goto &$name };
- &Scalar::Util::set_prototype( $sub, prototype $name );
+ $is_reexport->{$coderef_name} = 1;
}
}
else {
$export_recorder->{$sub} = 1;
- $exports{$coderef_name} = sub { $sub };
+ $exports{$coderef_name} = sub {$sub};
}
}
}
sub _sub_from_package {
- my $sclass = shift;
+ my $sclass = shift;
my $package = shift;
- my $name = shift;
+ my $name = shift;
my $sub = do {
no strict 'refs';
return $sub if defined &$sub;
- Carp::cluck
- "Trying to export undefined sub ${package}::${name}";
+ Carp::cluck "Trying to export undefined sub ${package}::${name}";
return;
}
return sub {
my $caller = $CALLER;
- my $wrapper = $self->_curry_wrapper($sub, $fq_name, $caller);
+ my $wrapper = $self->_curry_wrapper( $sub, $fq_name, $caller );
- my $sub = subname($fq_name => $wrapper);
+ my $sub = subname( $fq_name => $wrapper );
$export_recorder->{$sub} = 1;
return sub {
my $caller = $CALLER;
- my $wrapper = $self->_late_curry_wrapper($sub, $fq_name,
- sub { Class::MOP::class_of(shift) } => $caller);
+ my $wrapper = $self->_late_curry_wrapper(
+ $sub, $fq_name,
+ sub { Class::MOP::class_of(shift) } => $caller
+ );
- my $sub = subname($fq_name => $wrapper);
+ my $sub = subname( $fq_name => $wrapper );
$export_recorder->{$sub} = 1;
my $fq_name = shift;
my @extra = @_;
- my $wrapper = sub { $sub->(@extra, @_) };
- if (my $proto = prototype $sub) {
+ my $wrapper = sub { $sub->( @extra, @_ ) };
+ if ( my $proto = prototype $sub ) {
+
# XXX - Perl's prototype sucks. Use & to make set_prototype
# ignore the fact that we're passing "private variables"
- &Scalar::Util::set_prototype($wrapper, $proto);
+ &Scalar::Util::set_prototype( $wrapper, $proto );
}
return $wrapper;
}
my @ex_args = @_;
my $wrapper = sub {
+
# resolve curried arguments at runtime via this closure
- my @curry = ( $extra->( @ex_args ) );
- return $sub->(@curry, @_);
+ my @curry = ( $extra->(@ex_args) );
+ return $sub->( @curry, @_ );
};
- if (my $proto = prototype $sub) {
+ if ( my $proto = prototype $sub ) {
+
# XXX - Perl's prototype sucks. Use & to make set_prototype
# ignore the fact that we're passing "private variables"
- &Scalar::Util::set_prototype($wrapper, $proto);
+ &Scalar::Util::set_prototype( $wrapper, $proto );
}
return $wrapper;
}
my $exporting_package = shift;
my $exporter = shift;
my $exports_from = shift;
+ my $is_reexport = shift;
return sub {
my $metaclass;
( $metaclass, @_ ) = _strip_metaclass(@_);
- $metaclass = Moose::Util::resolve_metaclass_alias(
- 'Class' => $metaclass
- ) if defined $metaclass && length $metaclass;
+ $metaclass
+ = Moose::Util::resolve_metaclass_alias( 'Class' => $metaclass )
+ if defined $metaclass && length $metaclass;
+
+ my $meta_name;
+ ( $meta_name, @_ ) = _strip_meta_name(@_);
# Normally we could look at $_[0], but in some weird cases
# (involving goto &Moose::import), $_[0] ends as something
my $did_init_meta;
for my $c ( grep { $_->can('init_meta') } $class, @{$exports_from} ) {
+
# init_meta can apply a role, which when loaded uses
# Moose::Exporter, which in turn sets $CALLER, so we need
# to protect against that.
local $CALLER = $CALLER;
- $c->init_meta( for_class => $CALLER, metaclass => $metaclass );
+ $c->init_meta(
+ for_class => $CALLER,
+ metaclass => $metaclass,
+ meta_name => $meta_name,
+ );
$did_init_meta = 1;
}
if ( $did_init_meta && @{$traits} ) {
+
# The traits will use Moose::Role, which in turn uses
# Moose::Exporter, which in turn sets $CALLER, so we need
# to protect against that.
);
}
- goto $exporter;
+ my ( undef, @args ) = @_;
+ my $extra = shift @args if ref $args[0] eq 'HASH';
+
+ $extra ||= {};
+ if ( !$extra->{into} ) {
+ $extra->{into_level} ||= 0;
+ $extra->{into_level}++;
+ }
+
+ $class->$exporter( $extra, @args );
};
}
-
sub _strip_traits {
- my $idx = first_index { $_ eq '-traits' } @_;
+ my $idx = first_index { ( $_ || '' ) eq '-traits' } @_;
return ( [], @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
splice @_, $idx, 2;
- $traits = [ $traits ] unless ref $traits;
+ $traits = [$traits] unless ref $traits;
return ( $traits, @_ );
}
sub _strip_metaclass {
- my $idx = first_index { $_ eq '-metaclass' } @_;
+ my $idx = first_index { ( $_ || '' ) eq '-metaclass' } @_;
return ( undef, @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
return ( $metaclass, @_ );
}
+sub _strip_meta_name {
+ my $idx = first_index { ( $_ || '' ) eq '-meta_name' } @_;
+
+ return ( 'meta', @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
+
+ my $meta_name = $_[ $idx + 1 ];
+
+ splice @_, $idx, 2;
+
+ return ( $meta_name, @_ );
+}
+
sub _apply_meta_traits {
my ( $class, $traits ) = @_;
my $type = ( split /::/, ref $meta )[-1]
or Moose->throw_error(
'Cannot determine metaclass type for trait application . Meta isa '
- . ref $meta );
+ . ref $meta );
- my @resolved_traits
- = map {
- ref $_ ? $_ : Moose::Util::resolve_metatrait_alias( $type => $_ )
- }
- @$traits;
+ my @resolved_traits = map {
+ ref $_
+ ? $_
+ : Moose::Util::resolve_metatrait_alias( $type => $_ )
+ } @$traits;
return unless @resolved_traits;
- Moose::Util::MetaRole::apply_metaclass_roles(
- for_class => $class,
- metaclass_roles => \@resolved_traits,
- );
+ my %args = ( for => $class );
+
+ if ( $meta->isa('Moose::Meta::Role') ) {
+ $args{role_metaroles} = { role => \@resolved_traits };
+ }
+ else {
+ $args{class_metaroles} = { class => \@resolved_traits };
+ }
+
+ Moose::Util::MetaRole::apply_metaroles(%args);
}
sub _get_caller {
+
# 1 extra level because it's called by import so there's a layer
# of indirection
my $offset = 1;
my $exporting_package = shift;
my $exports = shift;
my $export_recorder = shift;
+ my $is_reexport = shift;
return sub {
my $caller = scalar caller();
$caller,
[ keys %{$exports} ],
$export_recorder,
+ $is_reexport,
);
};
}
my $package = shift;
my $keywords = shift;
my $recorded_exports = shift;
+ my $is_reexport = shift;
no strict 'refs';
- foreach my $name ( @{ $keywords } ) {
+ foreach my $name ( @{$keywords} ) {
if ( defined &{ $package . '::' . $name } ) {
my $sub = \&{ $package . '::' . $name };
# make sure it is from us
next unless $recorded_exports->{$sub};
+ if ( $is_reexport->{$name} ) {
+ no strict 'refs';
+ next
+ unless _export_is_flagged(
+ \*{ join q{::} => $package, $name } );
+ }
+
# and if it is from us, then undef the slot
delete ${ $package . '::' }{$name};
}
my $class = shift;
my $args = shift;
- my %metaclass_roles;
+ my %old_style_roles;
for my $role (
map {"${_}_roles"}
- qw(metaclass
+ qw(
+ metaclass
attribute_metaclass
method_metaclass
wrapped_method_metaclass
constructor_class
destructor_class
error_class
- application_to_class_class
- application_to_role_class
- application_to_instance_class)
+ )
) {
- $metaclass_roles{$role} = $args->{$role} if exists $args->{$role};
+ $old_style_roles{$role} = $args->{$role}
+ if exists $args->{$role};
}
my %base_class_roles;
%base_class_roles = ( roles => $args->{base_class_roles} )
if exists $args->{base_class_roles};
- return unless %metaclass_roles || %base_class_roles;
+ my %new_style_roles = map { $_ => $args->{$_} }
+ grep { exists $args->{$_} } qw( class_metaroles role_metaroles );
+
+ return unless %new_style_roles || %old_style_roles || %base_class_roles;
return sub {
shift;
return unless Class::MOP::class_of( $options{for_class} );
- Moose::Util::MetaRole::apply_metaclass_roles(
- for_class => $options{for_class},
- %metaclass_roles,
- );
+ if ( %new_style_roles || %old_style_roles ) {
+ Moose::Util::MetaRole::apply_metaroles(
+ for => $options{for_class},
+ %new_style_roles,
+ %old_style_roles,
+ );
+ }
Moose::Util::MetaRole::apply_base_class_roles(
for_class => $options{for_class},
1;
-__END__
-
-=head1 NAME
+# ABSTRACT: make an import() and unimport() just like Moose.pm
-Moose::Exporter - make an import() and unimport() just like Moose.pm
+__END__
=head1 SYNOPSIS
exported by some other module (like C<Moose.pm>).
The C<unimport> method cleans the caller's namespace of all the exported
-functions.
+functions. This includes any functions you re-export from other
+packages. However, if the consumer of your package also imports those
+functions from the original package, they will I<not> be cleaned.
If you pass any parameters for L<Moose::Util::MetaRole>, this method will
generate an C<init_meta> for you as well (see below for details). This
-C<init_meta> will call C<Moose::Util::MetaRole::apply_metaclass_roles> and
+C<init_meta> will call C<Moose::Util::MetaRole::apply_metaroles> and
C<Moose::Util::MetaRole::apply_base_class_roles> as needed.
Note that if any of these methods already exist, they will not be
the caller I<also> explicitly imported the sub themselves, and therefore wants
to keep it.
+=item * trait_aliases => [ ... ]
+
+This is a list of package names which should have shortened aliases exported,
+similar to the functionality of L<aliased>. Each element in the list can be
+either a package name, in which case the export will be named as the last
+namespace component of the package, or an arrayref, whose first element is the
+package to alias to, and second element is the alias to export.
+
=item * also => $name or \@names
This is a list of modules which contain functions that the caller
=back
-Any of the C<*_roles> options for
-C<Moose::Util::MetaRole::apply_metaclass_roles> and
-C<Moose::Util::MetaRole::base_class_roles> are also acceptable.
+You can also provide parameters for C<Moose::Util::MetaRole::apply_metaroles>
+and C<Moose::Util::MetaRole::base_class_roles>. Specifically, valid parameters
+are "class_metaroles", "role_metaroles", and "base_class_roles".
=item B<< Moose::Exporter->build_import_methods(...) >>
to calling C<build_import_methods> with C<< install => [qw(import unimport
init_meta)] >> except that it doesn't also return the methods.
+The C<import> method is built using L<Sub::Exporter>. This means that it can
+take a hashref of the form C<< { into => $package } >> to specify the package
+it operates on.
+
Used by C<setup_import_methods>.
=back
method for you, which you can also call from within your custom
C<init_meta>:
- my ( $import, $unimport, $init_meta ) =
- Moose::Exporter->build_import_methods( ... );
+ my ( $import, $unimport, $init_meta )
+ = Moose::Exporter->build_import_methods(...);
sub import {
- my $class = shift;
+ my $class = shift;
- ...
+ ...
- $class->$import(...);
+ # You can either pass an explicit package to import into ...
+ $class->$import( { into => scalar(caller) }, ... );
- ...
+ ...;
}
+ # ... or you can use 'goto' to provide the correct caller info to the
+ # generated method
sub unimport { goto &$unimport }
sub init_meta {
- my $class = shift;
+ my $class = shift;
- ...
+ ...
- $class->$init_meta(...);
+ $class->$init_meta(...);
- ...
+ ...
}
=head1 METACLASS TRAITS
instance. Providing traits for an exporting class that does not create
a metaclass for the caller is an error.
-=head1 AUTHOR
-
-Dave Rolsky E<lt>autarch@urth.orgE<gt>
-
-This is largely a reworking of code in Moose.pm originally written by
-Stevan Little and others.
-
-=head1 COPYRIGHT AND LICENSE
-
-Copyright 2009 by Infinity Interactive, Inc.
-
-L<http://www.iinteractive.com>
+=head1 BUGS
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
+See L<Moose/BUGS> for details on reporting bugs.
=cut