/usr/lib/perl5/Moose/Exporter.pm is in libmoose-perl 2.1005-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 | package Moose::Exporter;
BEGIN {
$Moose::Exporter::AUTHORITY = 'cpan:STEVAN';
}
{
$Moose::Exporter::VERSION = '2.1005';
}
use strict;
use warnings;
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);
my %EXPORT_SPEC;
sub setup_import_methods {
my ( $class, %args ) = @_;
$args{exporting_package} ||= caller();
$class->build_import_methods(
%args,
install => [qw(import unimport init_meta)]
);
}
# 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 $export_recorder = {};
my $is_reexport = {};
my $exports = $class->_make_sub_exporter_params(
[ $exporting_package, @exports_from ],
$export_recorder,
$is_reexport,
$args{meta_lookup}, # so that we don't pass through the default
);
my $exporter = $class->_make_exporter(
$exports,
$is_reexport,
$meta_lookup,
);
my %methods;
$methods{import} = $class->_make_import_sub(
$exporting_package,
$exporter,
\@exports_from,
$is_reexport,
$meta_lookup,
);
$methods{unimport} = $class->_make_unimport_sub(
$exporting_package,
$exports,
$export_recorder,
$is_reexport,
$meta_lookup,
);
$methods{init_meta} = $class->_make_init_meta(
$exporting_package,
\%args,
$meta_lookup,
);
my $package = Class::MOP::Package->initialize($exporting_package);
for my $to_install ( @{ $args{install} || [] } ) {
my $symbol = '&' . $to_install;
next
unless $methods{$to_install}
&& !$package->has_package_symbol($symbol);
$package->add_package_symbol( $symbol, $methods{$to_install} );
}
return ( $methods{import}, $methods{unimport}, $methods{init_meta} );
}
sub _make_exporter {
my ($class, $exports, $is_reexport, $meta_lookup) = @_;
return Sub::Exporter::build_exporter(
{
exports => $exports,
groups => { default => [':all'] },
installer => sub {
my ($arg, $to_export) = @_;
my $meta = $meta_lookup->($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 } );
}
},
}
);
}
sub _follow_also {
my $class = shift;
my $exporting_package = shift;
_die_if_cycle_found_in_also_list_for_package($exporting_package);
return uniq( _follow_also_real($exporting_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);
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";
}
_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 $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;
my $fq_name = $package . '::' . $name;
$exports{$name} = $class->_make_wrapped_sub_with_meta(
$fq_name,
$sub,
$export_recorder,
$meta_lookup,
) unless exists $exports{$name};
}
for my $name ( @{ $args->{with_caller} } ) {
my $sub = $class->_sub_from_package( $package, $name )
or next;
my $fq_name = $package . '::' . $name;
$exports{$name} = $class->_make_wrapped_sub(
$fq_name,
$sub,
$export_recorder,
) unless exists $exports{$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;
my $coderef_pkg;
( $coderef_pkg, $coderef_name )
= Class::MOP::get_code_info($name);
if ( $coderef_pkg ne $package ) {
$is_reexport->{$coderef_name} = 1;
}
}
else {
$sub = $class->_sub_from_package( $package, $name )
or next;
$coderef_name = $name;
}
$export_recorder->{$sub} = 1;
$exports{$coderef_name} = sub { $sub }
unless exists $exports{$coderef_name};
}
}
return \%exports;
}
sub _sub_from_package {
my $sclass = shift;
my $package = shift;
my $name = shift;
my $sub = do {
no strict 'refs';
\&{ $package . '::' . $name };
};
return $sub if defined &$sub;
Carp::cluck "Trying to export undefined sub ${package}::${name}";
return;
}
our $CALLER;
sub _make_wrapped_sub {
my $self = shift;
my $fq_name = shift;
my $sub = shift;
my $export_recorder = shift;
# We need to set the package at import time, so that when
# package Foo imports has(), we capture "Foo" as the
# package. This lets other packages call Foo::has() and get
# the right package. This is done for backwards compatibility
# with existing production code, not because this is a good
# idea ;)
return sub {
my $caller = $CALLER;
my $wrapper = $self->_curry_wrapper( $sub, $fq_name, $caller );
my $sub = subname( $fq_name => $wrapper );
$export_recorder->{$sub} = 1;
return $sub;
};
}
sub _make_wrapped_sub_with_meta {
my $self = shift;
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,
$meta_lookup => $caller
);
my $sub = subname( $fq_name => $wrapper );
$export_recorder->{$sub} = 1;
return $sub;
};
}
sub _curry_wrapper {
my $class = shift;
my $sub = shift;
my $fq_name = shift;
my @extra = @_;
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 );
}
return $wrapper;
}
sub _late_curry_wrapper {
my $class = shift;
my $sub = shift;
my $fq_name = shift;
my $extra = shift;
my @ex_args = @_;
my $wrapper = sub {
# resolve curried arguments at runtime via this closure
my @curry = ( $extra->(@ex_args) );
return $sub->( @curry, @_ );
};
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 );
}
return $wrapper;
}
sub _make_import_sub {
shift;
my $exporting_package = shift;
my $exporter = shift;
my $exports_from = shift;
my $is_reexport = shift;
my $meta_lookup = shift;
return sub {
# I think we could use Sub::Exporter's collector feature
# to do this, but that would be rather gross, since that
# feature isn't really designed to return a value to the
# caller of the exporter sub.
#
# Also, this makes sure we preserve backwards compat for
# _get_caller, so it always sees the arguments in the
# expected order.
my $traits;
( $traits, @_ ) = _strip_traits(@_);
my $metaclass;
( $metaclass, @_ ) = _strip_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
# else (like Squirrel).
my $class = $exporting_package;
$CALLER = _get_caller(@_);
# this works because both pragmas set $^H (see perldoc
# perlvar) which affects the current compilation -
# i.e. the file who use'd us - which is why we don't need
# to do anything special to make it affect that file
# rather than this one (which is already compiled)
strict->import;
warnings->import;
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,
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, $meta_lookup );
}
elsif ( @{$traits} ) {
require Moose;
Moose->throw_error(
"Cannot provide traits when $class does not have an init_meta() method"
);
}
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' } @_;
return ( [], @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
my $traits = $_[ $idx + 1 ];
splice @_, $idx, 2;
$traits = [$traits] unless ref $traits;
return ( $traits, @_ );
}
sub _strip_metaclass {
my $idx = first_index { ( $_ || '' ) eq '-metaclass' } @_;
return ( undef, @_ ) unless $idx >= 0 && $#_ >= $idx + 1;
my $metaclass = $_[ $idx + 1 ];
splice @_, $idx, 2;
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, $meta_lookup ) = @_;
return unless @{$traits};
my $meta = $meta_lookup->($class);
my $type = $meta->isa('Moose::Meta::Role') ? 'Role'
: $meta->isa('Class::MOP::Class') ? 'Class'
: Moose->throw_error('Cannot determine metaclass type for '
. 'trait application. Meta isa '
. ref $meta);
my @resolved_traits = map {
ref $_
? $_
: Moose::Util::resolve_metatrait_alias( $type => $_ )
} @$traits;
return unless @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;
return
( ref $_[1] && defined $_[1]->{into} ) ? $_[1]->{into}
: ( ref $_[1] && defined $_[1]->{into_level} )
? caller( $offset + $_[1]->{into_level} )
: caller($offset);
}
sub _make_unimport_sub {
shift;
my $exporting_package = shift;
my $exports = shift;
my $export_recorder = shift;
my $is_reexport = shift;
my $meta_lookup = shift;
return sub {
my $caller = scalar caller();
Moose::Exporter->_remove_keywords(
$caller,
[ keys %{$exports} ],
$export_recorder,
$is_reexport,
);
};
}
sub _remove_keywords {
shift;
my $package = shift;
my $keywords = shift;
my $recorded_exports = shift;
my $is_reexport = shift;
no strict 'refs';
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};
}
}
}
# 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 $meta_lookup = shift;
my %old_style_roles;
for my $role (
map {"${_}_roles"}
qw(
metaclass
attribute_metaclass
method_metaclass
wrapped_method_metaclass
instance_metaclass
constructor_class
destructor_class
error_class
)
) {
$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};
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;
my %opts = @_;
$meta_lookup->($opts{for_class});
};
}
sub import {
strict->import;
warnings->import;
}
1;
# ABSTRACT: make an import() and unimport() just like Moose.pm
__END__
=pod
=head1 NAME
Moose::Exporter - make an import() and unimport() just like Moose.pm
=head1 VERSION
version 2.1005
=head1 SYNOPSIS
package MyApp::Moose;
use Moose ();
use Moose::Exporter;
Moose::Exporter->setup_import_methods(
with_meta => [ 'has_rw', 'sugar2' ],
as_is => [ 'sugar3', \&Some::Random::thing ],
also => 'Moose',
);
sub has_rw {
my ( $meta, $name, %options ) = @_;
$meta->add_attribute(
$name,
is => 'rw',
%options,
);
}
# then later ...
package MyApp::User;
use MyApp::Moose;
has 'name';
has_rw 'size';
thing;
no MyApp::Moose;
=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> 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
long as they all use C<Moose::Exporter>. This feature exists to let you bundle
a set of MooseX modules into a policy module that developers can use directly
instead of using Moose itself.
To simplify writing exporter modules, C<Moose::Exporter> also imports
C<strict> and C<warnings> into your exporter module, as well as into
modules that use it.
=head1 METHODS
This module provides two public methods:
=over 4
=item B<< Moose::Exporter->setup_import_methods(...) >>
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>). 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.
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.
This method accepts the following parameters:
=over 8
=item * with_meta => [ ... ]
This list of function I<names only> will be wrapped and then exported. The
wrapper will pass the metaclass object for the caller as its first argument.
Many sugar functions will need to use this metaclass object to do something to
the calling package.
=item * as_is => [ ... ]
This list of function names or sub references will be exported as-is. You can
identify a subroutine by reference, which is handy to re-export some other
module's functions directly by reference (C<\&Some::Package::function>).
If you do export some other package's function, this function will never be
removed by the C<unimport> method. The reason for this is we cannot know if
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
wants to export. These modules must also use C<Moose::Exporter>. The
most common use case will be to export the functions from C<Moose.pm>.
Functions specified by C<with_meta> or C<as_is> take precedence over
functions exported by modules specified by C<also>, so that a module
can selectively override functions exported by another module.
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_class_roles".
=item B<< Moose::Exporter->build_import_methods(...) >>
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>
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>.
=back
=head1 IMPORTING AND init_meta
If you want to set an alternative base object class or metaclass class, see
above for details on how this module can call L<Moose::Util::MetaRole> for
you.
If you want to do something that is not supported by this module, simply
define an C<init_meta> method in your class. The C<import> method that
C<Moose::Exporter> generates for you will call this method (if it exists). It
will always pass the caller to this method via the C<for_class> parameter.
Most of the time, your C<init_meta> method will probably just call C<<
Moose->init_meta >> to do the real work:
sub init_meta {
shift; # our class name
return Moose->init_meta( @_, metaclass => 'My::Metaclass' );
}
=head1 METACLASS TRAITS
The C<import> method generated by C<Moose::Exporter> will allow the
user of your module to specify metaclass traits in a C<-traits>
parameter passed as part of the import:
use Moose -traits => 'My::Meta::Trait';
use Moose -traits => [ 'My::Meta::Trait', 'My::Other::Trait' ];
These traits will be applied to the caller's metaclass
instance. Providing traits for an exporting class that does not create
a metaclass for the caller is an error.
=head1 BUGS
See L<Moose/BUGS> for details on reporting bugs.
=head1 AUTHOR
Moose is maintained by the Moose Cabal, along with the help of many contributors. See L<Moose/CABAL> and L<Moose/CONTRIBUTORS> for details.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Infinity Interactive, Inc..
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
|