X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=blobdiff_plain;f=lib%2FMouse%2FExporter.pm;h=e3cb85a848be0546f216482683baf1bb67294bec;hp=5884c68a7bf1c6c6e949fc61bfdd566492d1e475;hb=3d7c6ec96a92be50258d124bdec61fb91bca3830;hpb=1ff34b4c204afd341fbb946205acb1a08fe2d4a4 diff --git a/lib/Mouse/Exporter.pm b/lib/Mouse/Exporter.pm index 5884c68..e3cb85a 100644 --- a/lib/Mouse/Exporter.pm +++ b/lib/Mouse/Exporter.pm @@ -4,17 +4,50 @@ use warnings; use Carp qw(confess); -use Mouse::Util qw(get_code_info not_supported); - my %SPEC; -my $strict_bits = strict::bits(qw(subs refs vars)); +use constant _strict_bits => strict::bits(qw(subs refs vars)); + +# it must be "require", because Mouse::Util depends on Mouse::Exporter, +# which depends on Mouse::Util::import() +require Mouse::Util; + +sub import{ + $^H |= _strict_bits; # strict->import; + ${^WARNING_BITS} |= $warnings::Bits{all}; # warnings->import; + return; +} + sub setup_import_methods{ my($class, %args) = @_; my $exporting_package = $args{exporting_package} ||= caller(); + my($import, $unimport) = $class->build_import_methods(%args); + + no strict 'refs'; + + *{$exporting_package . '::import'} = $import; + *{$exporting_package . '::unimport'} = $unimport; + + # for backward compatibility + *{$exporting_package . '::export_to_level'} = sub{ + my($package, $level, undef, @args) = @_; # the third argument is redundant + $package->import({ into_level => $level + 1 }, @args); + }; + *{$exporting_package . '::export'} = sub{ + my($package, $into, @args) = @_; + $package->import({ into => $into }, @args); + }; + return; +} + +sub build_import_methods{ + my($class, %args) = @_; + + my $exporting_package = $args{exporting_package} ||= caller(); + $SPEC{$exporting_package} = \%args; # canonicalize args @@ -27,7 +60,7 @@ sub setup_import_methods{ push @export_from, $current; my $also = $SPEC{$current}{also} or next; - push @stack, grep{ !$seen{$_}++ } @{ $also }; + push @stack, grep{ !$seen{$_}++ } ref($also) ? @{ $also } : $also; } } else{ @@ -50,7 +83,7 @@ sub setup_import_methods{ if(ref($thingy)){ $code = $thingy; - ($code_package, $code_name) = get_code_info($code); + ($code_package, $code_name) = Mouse::Util::get_code_info($code); } else{ no strict 'refs'; @@ -69,16 +102,16 @@ sub setup_import_methods{ if(my $init_meta = $package->can('init_meta')){ if(!grep{ $_ == $init_meta } @init_meta_methods){ - unshift @init_meta_methods, $init_meta; + push @init_meta_methods, $init_meta; } } } $args{EXPORTS} = \%exports; $args{REMOVABLES} = \@removables; - $args{group}{all} ||= \@all; + $args{groups}{all} ||= \@all; - if(my $default_list = $args{group}{default}){ + if(my $default_list = $args{groups}{default}){ my %default; foreach my $keyword(@{$default_list}){ $default{$keyword} = $exports{$keyword} @@ -87,8 +120,8 @@ sub setup_import_methods{ $args{DEFAULT} = \%default; } else{ - $args{group}{default} ||= \@all; - $args{DEFAULT} = $args{EXPORTS}; + $args{groups}{default} ||= \@all; + $args{DEFAULT} = $args{EXPORTS}; } if(@init_meta_methods){ @@ -96,12 +129,7 @@ sub setup_import_methods{ } } - no strict 'refs'; - - *{$exporting_package . '::import'} = \&do_import; - *{$exporting_package . '::unimport'} = \&do_unimport; - - return; + return (\&do_import, \&do_unimport); } @@ -115,12 +143,20 @@ sub do_import { my $into = _get_caller_package(ref($args[0]) ? shift @args : undef); my @exports; - foreach my $arg(@args){ + my @traits; + + while(@args){ + my $arg = shift @args; if($arg =~ s/^-//){ - not_supported "-$arg"; + if($arg eq 'traits'){ + push @traits, ref($args[0]) ? @{shift(@args)} : shift(@args); + } + else { + Mouse::Util::not_supported("-$arg"); + } } elsif($arg =~ s/^://){ - my $group = $spec->{group}{$arg} + my $group = $spec->{groups}{$arg} || confess(qq{The $package package does not export the group "$arg"}); push @exports, @{$group}; } @@ -129,20 +165,34 @@ sub do_import { } } - $^H |= $strict_bits; # strict->import; - ${^WARNING_BITS} = $warnings::Bits{all}; # warnings->import; - - if($into eq 'main' && !$spec->{_not_export_to_main}){ - warn qq{$package does not export its sugar to the 'main' package.\n}; - return; - } + $^H |= _strict_bits; # strict->import; + ${^WARNING_BITS} |= $warnings::Bits{all}; # warnings->import; if($spec->{INIT_META}){ + my $meta; foreach my $init_meta(@{$spec->{INIT_META}}){ - $into->$init_meta(for_class => $into); + $meta = $package->$init_meta(for_class => $into); } - # _apply_meta_traits($into); # TODO + if(@traits){ + my $type = (split /::/, ref $meta)[-1]; # e.g. "Class" for "My::Meta::Class" + @traits = + map{ + ref($_) ? $_ + : Mouse::Util::resolve_metaclass_alias($type => $_, trait => 1) + } @traits; + + require Mouse::Util::MetaRole; + Mouse::Util::MetaRole::apply_metaroles( + for => $into, + Mouse::Util::is_a_metarole($into->meta) + ? (role_metaroles => { role => \@traits }) + : (class_metaroles => { class => \@traits }), + ); + } + } + elsif(@traits){ + Carp::confess("Cannot provide traits when $package does not have an init_meta() method"); } if(@exports){ @@ -177,6 +227,7 @@ sub do_unimport { }; for my $keyword (@{ $spec->{REMOVABLES} }) { + next if !exists $stash->{$keyword}; my $gv = \$stash->{$keyword}; if(ref($gv) eq 'GLOB' && *{$gv}{CODE} == $spec->{EXPORTS}{$keyword}){ # make sure it is from us delete $stash->{$keyword}; @@ -188,42 +239,82 @@ sub do_unimport { sub _get_caller_package { my($arg) = @_; - # 2 extra level because it's called by import so there's a layer - # of indirection - my $offset = 1; - + # We need one extra level because it's called by import so there's a layer + # of indirection if(ref $arg){ return defined($arg->{into}) ? $arg->{into} - : defined($arg->{into_level}) ? scalar caller($offset + $arg->{into_level}) - : scalar caller($offset); + : defined($arg->{into_level}) ? scalar caller(1 + $arg->{into_level}) + : scalar caller(1); } else{ - return scalar caller($offset); + return scalar caller(1); } } -1; +#sub _spec{ %SPEC } +1; __END__ =head1 NAME -Mouse - The Mouse Exporter +Mouse::Exporter - make an import() and unimport() just like Mouse.pm + +=head1 VERSION + +This document describes Mouse version 0.49 =head1 SYNOPSIS - package MouseX::Foo; + package MyApp::Mouse; + + use Mouse (); use Mouse::Exporter; Mouse::Exporter->setup_import_methods( - + as_is => [ 'has_rw', 'other_sugar', \&Some::Random::thing ], + also => 'Mouse', ); + sub has_rw { + my $meta = caller->meta; + my ( $name, %options ) = @_; + $meta->add_attribute( + $name, + is => 'rw', + %options, + ); + } + + # then later ... + package MyApp::User; + + use MyApp::Mouse; + + has 'name'; + has_rw 'size'; + thing; + + no MyApp::Mouse; + =head1 DESCRIPTION +This module encapsulates the exporting of sugar functions in a +C-like manner. It does this by building custom C, +C methods for your module, based on a spec you provide. + +Note that C does not provide the C option, +but you can easily get the metaclass by C<< caller->meta >> as L shows. + +=head1 METHODS + +=head2 C<< setup_import_methods( ARGS ) >> + +=head2 C<< build_import_methods( ARGS ) -> (\&import, \&unimport) >> =head1 SEE ALSO L =cut +