use strict;
use warnings;
-our $VERSION = '1.07';
-our $XS_VERSION = $VERSION;
-$VERSION = eval $VERSION;
-our $AUTHORITY = 'cpan:STEVAN';
-
+use Class::Load qw(is_class_loaded);
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);
-use XSLoader;
-
-XSLoader::load( 'Moose', $XS_VERSION );
-
my %EXPORT_SPEC;
sub setup_import_methods {
my ( $class, %args ) = @_;
- my $exporting_package = $args{exporting_package} ||= caller();
+ $args{exporting_package} ||= caller();
$class->build_import_methods(
%args,
);
}
+# A reminder to intrepid Moose hackers
+# there may be more than one level of exporter
+# don't make doy cry. -- perigrin
+
sub build_import_methods {
my ( $class, %args ) = @_;
my $exporting_package = $args{exporting_package} ||= caller();
+ my $meta_lookup = $args{meta_lookup} || sub { Class::MOP::class_of(shift) };
+
$EXPORT_SPEC{$exporting_package} = \%args;
my @exports_from = $class->_follow_also($exporting_package);
my $is_reexport = {};
my $exports = $class->_make_sub_exporter_params(
- [ @exports_from, $exporting_package ],
+ [ $exporting_package, @exports_from ],
$export_recorder,
$is_reexport,
+ $args{meta_lookup}, # so that we don't pass through the default
);
- my $exporter = Sub::Exporter::build_exporter(
- {
- exports => $exports,
- groups => { default => [':all'] }
- }
+ my $exporter = $class->_make_exporter(
+ $exports,
+ $is_reexport,
+ $meta_lookup,
);
my %methods;
$exporting_package,
$exporter,
\@exports_from,
- $is_reexport
+ $is_reexport,
+ $meta_lookup,
);
$methods{unimport} = $class->_make_unimport_sub(
$exporting_package,
$exports,
$export_recorder,
- $is_reexport
+ $is_reexport,
+ $meta_lookup,
);
$methods{init_meta} = $class->_make_init_meta(
$exporting_package,
- \%args
+ \%args,
+ $meta_lookup,
);
my $package = Class::MOP::Package->initialize($exporting_package);
return ( $methods{import}, $methods{unimport}, $methods{init_meta} );
}
-{
- my $seen = {};
+sub _make_exporter {
+ my ($class, $exports, $is_reexport, $meta_lookup) = @_;
- sub _follow_also {
- my $class = shift;
- my $exporting_package = shift;
+ return Sub::Exporter::build_exporter(
+ {
+ exports => $exports,
+ groups => { default => [':all'] },
+ installer => sub {
+ my ($arg, $to_export) = @_;
+ my $meta = $meta_lookup->($arg->{into});
- local %$seen = ( $exporting_package => 1 );
+ goto &Sub::Exporter::default_installer unless $meta;
- return uniq( _follow_also_real($exporting_package) );
- }
+ # 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
- sub _follow_also_real {
- my $exporting_package = shift;
+ my @filtered_to_export;
+ my %installed;
+ for (my $i = 0; $i < @{ $to_export }; $i += 2) {
+ my ($as, $cv) = @{ $to_export }[$i, $i + 1];
- if ( !exists $EXPORT_SPEC{$exporting_package} ) {
- my $loaded = Class::MOP::is_class_loaded($exporting_package);
+ next if !ref($as)
+ && $meta->has_package_symbol('&' . $as)
+ && $meta->get_package_symbol('&' . $as) == $cv;
- die "Package in also ($exporting_package) does not seem to "
- . "use Moose::Exporter"
- . ( $loaded ? "" : " (is it loaded?)" );
+ 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 } );
+ }
+ },
}
+ );
+}
- my $also = $EXPORT_SPEC{$exporting_package}{also};
+sub _follow_also {
+ my $class = shift;
+ my $exporting_package = shift;
- return unless defined $also;
+ _die_if_cycle_found_in_also_list_for_package($exporting_package);
- my @also = ref $also ? @{$also} : $also;
+ return uniq( _follow_also_real($exporting_package) );
+}
- for my $package (@also) {
- die
- "Circular reference in 'also' parameter to Moose::Exporter between $exporting_package and $package"
- if $seen->{$package};
+sub _follow_also_real {
+ my $exporting_package = shift;
+ my @also = _also_list_for_package($exporting_package);
+
+ return map { $_, _follow_also_real($_) } @also;
+}
+
+sub _also_list_for_package {
+ my $package = shift;
+
+ if ( !exists $EXPORT_SPEC{$package} ) {
+ my $loaded = is_class_loaded($package);
- $seen->{$package} = 1;
+ die "Package in also ($package) does not seem to "
+ . "use Moose::Exporter"
+ . ( $loaded ? "" : " (is it loaded?)" );
+ }
+
+ my $also = $EXPORT_SPEC{$package}{also};
+
+ return unless defined $also;
+
+ return ref $also ? @$also : $also;
+}
+
+# this is no Tarjan algorithm, but for the list sizes expected,
+# brute force will probably be fine (and more maintainable)
+sub _die_if_cycle_found_in_also_list_for_package {
+ my $package = shift;
+ _die_if_also_list_cycles_back_to_existing_stack(
+ [ _also_list_for_package($package) ],
+ [$package],
+ );
+}
+
+sub _die_if_also_list_cycles_back_to_existing_stack {
+ my ( $also_list, $existing_stack ) = @_;
+
+ return unless @$also_list && @$existing_stack;
+
+ for my $also_member (@$also_list) {
+ for my $stack_member (@$existing_stack) {
+ next unless $also_member eq $stack_member;
+
+ die
+ "Circular reference in 'also' parameter to Moose::Exporter between "
+ . join(
+ ', ',
+ @$existing_stack
+ ) . " and $also_member";
}
- return @also, map { _follow_also_real($_) } @also;
+ _die_if_also_list_cycles_back_to_existing_stack(
+ [ _also_list_for_package($also_member) ],
+ [ $also_member, @$existing_stack ],
+ );
}
}
+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 $is_reexport = shift;
+ my $class = shift;
+ my $packages = shift;
+ my $export_recorder = shift;
+ my $is_reexport = shift;
+ my $meta_lookup_override = shift;
my %exports;
+ my $current_meta_lookup;
for my $package ( @{$packages} ) {
my $args = $EXPORT_SPEC{$package}
or die "The $package package does not use Moose::Exporter\n";
+ $current_meta_lookup = $meta_lookup_override || $args->{meta_lookup};
+ $meta_lookup_override = $current_meta_lookup;
+
+ my $meta_lookup = $current_meta_lookup
+ || sub { Class::MOP::class_of(shift) };
+
for my $name ( @{ $args->{with_meta} } ) {
my $sub = $class->_sub_from_package( $package, $name )
or next;
$fq_name,
$sub,
$export_recorder,
- );
+ $meta_lookup,
+ ) unless exists $exports{$name};
}
for my $name ( @{ $args->{with_caller} } ) {
$fq_name,
$sub,
$export_recorder,
- );
+ ) unless exists $exports{$name};
}
- for my $name ( @{ $args->{as_is} } ) {
+ 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 ) {
$export_recorder->{$sub} = 1;
- $exports{$coderef_name} = sub {$sub};
+ $exports{$coderef_name} = sub { $sub }
+ unless exists $exports{$coderef_name};
}
}
my $fq_name = shift;
my $sub = shift;
my $export_recorder = shift;
+ my $meta_lookup = shift;
return sub {
my $caller = $CALLER;
my $wrapper = $self->_late_curry_wrapper(
$sub, $fq_name,
- sub { Class::MOP::class_of(shift) } => $caller
+ $meta_lookup => $caller
);
my $sub = subname( $fq_name => $wrapper );
my $exporting_package = shift;
my $exporter = shift;
my $exports_from = shift;
- my $is_reexport = shift;
+ my $is_reexport = shift;
+ my $meta_lookup = shift;
return sub {
= 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
# else (like Squirrel).
# 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;
}
+ {
+ # The metaroles will use Moose::Role, which in turn uses
+ # Moose::Exporter, which in turn sets $CALLER, so we need
+ # to protect against that.
+ local $CALLER = $CALLER;
+ _apply_metaroles(
+ $CALLER,
+ [$class, @$exports_from],
+ $meta_lookup
+ );
+ }
+
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.
local $CALLER = $CALLER;
- _apply_meta_traits( $CALLER, $traits );
+ _apply_meta_traits( $CALLER, $traits, $meta_lookup );
}
elsif ( @{$traits} ) {
require Moose;
}
$class->$exporter( $extra, @args );
-
- for my $name ( keys %{$is_reexport} ) {
- no strict 'refs';
- no warnings 'once';
- _flag_as_reexport( \*{ join q{::}, $CALLER, $name } );
- }
};
}
sub _strip_traits {
- my $idx = first_index { $_ eq '-traits' } @_;
+ my $idx = first_index { ( $_ || '' ) eq '-traits' } @_;
return ( [], @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
}
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_metaroles {
+ my ($class, $exports_from, $meta_lookup) = @_;
+
+ my $metaroles = _collect_metaroles($exports_from);
+ my $base_class_roles = delete $metaroles->{base_class_roles};
+
+ my $meta = $meta_lookup->($class);
+ # for instance, Moose.pm uses Moose::Util::TypeConstraints
+ return unless $meta;
+
+ Moose::Util::MetaRole::apply_metaroles(
+ for => $meta,
+ %$metaroles,
+ ) if keys %$metaroles;
+
+ Moose::Util::MetaRole::apply_base_class_roles(
+ for => $meta,
+ roles => $base_class_roles,
+ ) if $meta->isa('Class::MOP::Class')
+ && $base_class_roles && @$base_class_roles;
+}
+
+sub _collect_metaroles {
+ my ($exports_from) = @_;
+
+ my @old_style_role_types = map { "${_}_roles" } qw(
+ metaclass
+ attribute_metaclass
+ method_metaclass
+ wrapped_method_metaclass
+ instance_metaclass
+ constructor_class
+ destructor_class
+ error_class
+ );
+
+ my %class_metaroles;
+ my %role_metaroles;
+ my @base_class_roles;
+ my %old_style_roles;
+
+ for my $exporter (@$exports_from) {
+ my $data = $EXPORT_SPEC{$exporter};
+
+ if (exists $data->{class_metaroles}) {
+ for my $type (keys %{ $data->{class_metaroles} }) {
+ push @{ $class_metaroles{$type} ||= [] },
+ @{ $data->{class_metaroles}{$type} };
+ }
+ }
+
+ if (exists $data->{role_metaroles}) {
+ for my $type (keys %{ $data->{role_metaroles} }) {
+ push @{ $role_metaroles{$type} ||= [] },
+ @{ $data->{role_metaroles}{$type} };
+ }
+ }
+
+ if (exists $data->{base_class_roles}) {
+ push @base_class_roles, @{ $data->{base_class_roles} };
+ }
+
+ for my $type (@old_style_role_types) {
+ if (exists $data->{$type}) {
+ push @{ $old_style_roles{$type} ||= [] },
+ @{ $data->{$type} };
+ }
+ }
+ }
+
+ return {
+ (keys(%class_metaroles)
+ ? (class_metaroles => \%class_metaroles)
+ : ()),
+ (keys(%role_metaroles)
+ ? (role_metaroles => \%role_metaroles)
+ : ()),
+ (@base_class_roles
+ ? (base_class_roles => \@base_class_roles)
+ : ()),
+ %old_style_roles,
+ };
+}
+
sub _apply_meta_traits {
- my ( $class, $traits ) = @_;
+ my ( $class, $traits, $meta_lookup ) = @_;
return unless @{$traits};
- my $meta = Class::MOP::class_of($class);
+ my $meta = $meta_lookup->($class);
my $type = ( split /::/, ref $meta )[-1]
or Moose->throw_error(
my $exporting_package = shift;
my $exports = shift;
my $export_recorder = shift;
- my $is_reexport = shift;
+ my $is_reexport = shift;
+ my $meta_lookup = shift;
return sub {
my $caller = scalar caller();
$export_recorder,
$is_reexport,
);
- strict->unimport;
- warnings->unimport;
};
}
my $package = shift;
my $keywords = shift;
my $recorded_exports = shift;
- my $is_reexport = shift;
+ my $is_reexport = shift;
no strict 'refs';
}
}
+# maintain this for now for backcompat
+# make sure to return a sub to install in the same circumstances as previously
+# but this functionality now happens at the end of ->import
sub _make_init_meta {
shift;
- my $class = shift;
- my $args = shift;
+ my $class = shift;
+ my $args = shift;
+ my $meta_lookup = shift;
my %old_style_roles;
for my $role (
return sub {
shift;
- my %options = @_;
-
- return unless Class::MOP::class_of( $options{for_class} );
-
- 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},
- %base_class_roles,
- )
- if Class::MOP::class_of( $options{for_class} )
- ->isa('Moose::Meta::Class');
-
- return Class::MOP::class_of( $options{for_class} );
+ my %opts = @_;
+ $meta_lookup->($opts{for_class});
};
}
warnings->import;
}
-sub unimport {
- strict->unimport;
- warnings->unimport;
-}
-
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
=head1 DESCRIPTION
This module encapsulates the exporting of sugar functions in a
-C<Moose.pm>-like manner. It does this by building custom C<import>,
-C<unimport>, and C<init_meta> methods for your module, based on a spec you
-provide.
+C<Moose.pm>-like manner. It does this by building custom C<import> and
+C<unimport> methods for your module, based on a spec you provide.
It also lets you "stack" Moose-alike modules so you can export Moose's sugar
as well as your own, along with sugar from any random C<MooseX> module, as
=item B<< Moose::Exporter->setup_import_methods(...) >>
-When you call this method, C<Moose::Exporter> builds custom C<import>,
-C<unimport>, and C<init_meta> methods for your module. The C<import> method
+When you call this method, C<Moose::Exporter> builds custom C<import> and
+C<unimport> methods for your module. The C<import> method
will export the functions you specify, and can also re-export functions
-exported by some other module (like C<Moose.pm>).
+exported by some other module (like C<Moose.pm>). If you pass any parameters
+for L<Moose::Util::MetaRole>, the C<import> method will also call
+C<Moose::Util::MetaRole::apply_metaroles> and
+C<Moose::Util::MetaRole::apply_base_class_roles> as needed, after making
+sure the metaclass is initialized.
The C<unimport> method cleans the caller's namespace of all the exported
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<Moose::Util::MetaRole::apply_base_class_roles> as needed.
-
Note that if any of these methods already exist, they will not be
overridden, you will have to use C<build_import_methods> to get the
coderef that would be installed.
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
C<Moose::Exporter> also makes sure all these functions get removed
when C<unimport> is called.
+=item * meta_lookup => sub { ... }
+
+This is a function which will be called to provide the metaclass
+to be operated upon by the exporter. This is an advanced feature
+intended for use by package generator modules in the vein of
+L<MooseX::Role::Parameterized> in order to simplify reusing sugar
+from other modules that use C<Moose::Exporter>. This function is
+used, for example, to select the metaclass to bind to functions
+that are exported using the C<with_meta> option.
+
+This function will receive one parameter: the class name into which
+the sugar is being exported. The default implementation is:
+
+ sub { Class::MOP::class_of(shift) }
+
+Accordingly, this function is expected to return a metaclass.
+
=back
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_object_roles".
+are "class_metaroles", "role_metaroles", and "base_class_roles".
=item B<< Moose::Exporter->build_import_methods(...) >>
-Returns two or three code refs, one for C<import>, one for
-C<unimport>, and optionally one for C<init_meta>, if the appropriate
-options are passed in.
+Returns two code refs, one for C<import> and one for C<unimport>.
Accepts the additional C<install> option, which accepts an arrayref of method
-names to install into your exporting package. The valid options are C<import>,
-C<unimport>, and C<init_meta>. Calling C<setup_import_methods> is equivalent
-to calling C<build_import_methods> with C<< install => [qw(import unimport
-init_meta)] >> except that it doesn't also return the methods.
+names to install into your exporting package. The valid options are C<import>
+and C<unimport>. Calling C<setup_import_methods> is equivalent
+to calling C<build_import_methods> with C<< install => [qw(import unimport)] >>
+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>.
return Moose->init_meta( @_, metaclass => 'My::Metaclass' );
}
-Keep in mind that C<build_import_methods> will return an C<init_meta>
-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( ... );
-
- sub import {
- my $class = shift;
-
- ...
-
- $class->$import(...);
-
- ...
- }
-
- sub unimport { goto &$unimport }
-
- sub init_meta {
- my $class = shift;
-
- ...
-
- $class->$init_meta(...);
-
- ...
- }
-
=head1 METACLASS TRAITS
The C<import> method generated by C<Moose::Exporter> will allow the
See L<Moose/BUGS> for details on reporting bugs.
-=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>
-
-This library is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
-
=cut
projects / gitmo/Moose.git / blobdiff