No constant.pm
[gitmo/Mouse.git] / lib / Mouse / Exporter.pm
index 8e54df1..e44c256 100644 (file)
@@ -6,7 +6,8 @@ use Carp qw(confess);
 
 my %SPEC;
 
-my $strict_bits = strict::bits(qw(subs refs vars));
+my $strict_bits;
+BEGIN{ $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()
@@ -14,7 +15,7 @@ require Mouse::Util;
 
 sub import{
     $^H              |= $strict_bits;         # strict->import;
-    ${^WARNING_BITS}  = $warnings::Bits{all}; # warnings->import;
+    ${^WARNING_BITS} |= $warnings::Bits{all}; # warnings->import;
     return;
 }
 
@@ -24,6 +25,29 @@ sub setup_import_methods{
 
     my $exporting_package = $args{exporting_package} ||= caller();
 
+    my($import, $unimport) = $class->build_import_methods(%args);
+
+    Mouse::Util::install_subroutines($exporting_package,
+        import   => $import,
+        unimport => $unimport,
+
+        export_to_level => sub {
+            my($package, $level, undef, @args) = @_; # the third argument is redundant
+            $package->import({ into_level => $level + 1 }, @args);
+        },
+        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
@@ -43,74 +67,67 @@ sub setup_import_methods{
         @export_from = ($exporting_package);
     }
 
-    {
-        my %exports;
-        my @removables;
-        my @all;
-
-        my @init_meta_methods;
-
-        foreach my $package(@export_from){
-            my $spec = $SPEC{$package} or next;
-
-            if(my $as_is = $spec->{as_is}){
-                foreach my $thingy (@{$as_is}){
-                    my($code_package, $code_name, $code);
-
-                    if(ref($thingy)){
-                        $code = $thingy;
-                        ($code_package, $code_name) = Mouse::Util::get_code_info($code);
-                    }
-                    else{
-                        no strict 'refs';
-                        $code_package = $package;
-                        $code_name    = $thingy;
-                        $code         = \&{ $code_package . '::' . $code_name };
-                   }
-
-                    push @all, $code_name;
-                    $exports{$code_name} = $code;
-                    if($code_package eq $package){
-                        push @removables, $code_name;
-                    }
-                }
-            }
+    my %exports;
+    my @removables;
+    my @all;
+
+    my @init_meta_methods;
 
-            if(my $init_meta = $package->can('init_meta')){
-                if(!grep{ $_ == $init_meta } @init_meta_methods){
-                    unshift @init_meta_methods, $init_meta;
+    foreach my $package(@export_from){
+        my $spec = $SPEC{$package} or next;
+
+        if(my $as_is = $spec->{as_is}){
+            foreach my $thingy (@{$as_is}){
+                my($code_package, $code_name, $code);
+
+                if(ref($thingy)){
+                    $code = $thingy;
+                    ($code_package, $code_name) = Mouse::Util::get_code_info($code);
+                }
+                else{
+                    $code_package = $package;
+                    $code_name    = $thingy;
+                    no strict 'refs';
+                    $code         = \&{ $code_package . '::' . $code_name };
+               }
+
+                push @all, $code_name;
+                $exports{$code_name} = $code;
+                if($code_package eq $package){
+                    push @removables, $code_name;
                 }
             }
         }
-        $args{EXPORTS}    = \%exports;
-        $args{REMOVABLES} = \@removables;
-
-        $args{groups}{all}     ||= \@all;
 
-        if(my $default_list = $args{groups}{default}){
-            my %default;
-            foreach my $keyword(@{$default_list}){
-                $default{$keyword} = $exports{$keyword}
-                    || confess(qq{The $exporting_package package does not export "$keyword"});
+        if(my $init_meta = $package->can('init_meta')){
+            if(!grep{ $_ == $init_meta } @init_meta_methods){
+                push @init_meta_methods, $init_meta;
             }
-            $args{DEFAULT} = \%default;
-        }
-        else{
-            $args{groups}{default} ||= \@all;
-            $args{DEFAULT}           = $args{EXPORTS};
         }
+    }
+    $args{EXPORTS}    = \%exports;
+    $args{REMOVABLES} = \@removables;
 
-        if(@init_meta_methods){
-            $args{INIT_META} = \@init_meta_methods;
+    $args{groups}{all}     ||= \@all;
+
+    if(my $default_list = $args{groups}{default}){
+        my %default;
+        foreach my $keyword(@{$default_list}){
+            $default{$keyword} = $exports{$keyword}
+                || confess(qq{The $exporting_package package does not export "$keyword"});
         }
+        $args{DEFAULT} = \%default;
+    }
+    else{
+        $args{groups}{default} ||= \@all;
+        $args{DEFAULT}           = $args{EXPORTS};
     }
 
-    no strict 'refs';
-
-    *{$exporting_package . '::import'}    = \&do_import;
-    *{$exporting_package . '::unimport'}  = \&do_unimport;
+    if(@init_meta_methods){
+        $args{INIT_META} = \@init_meta_methods;
+    }
 
-    return;
+    return (\&do_import, \&do_unimport);
 }
 
 
@@ -124,9 +141,17 @@ 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/^-//){
-            Mouse::Util::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->{groups}{$arg}
@@ -139,34 +164,47 @@ sub do_import {
     }
 
     $^H              |= $strict_bits;         # strict->import;
-    ${^WARNING_BITS}  = $warnings::Bits{all}; # warnings->import;
-
-    if($into eq 'main' && !$spec->{_export_to_main}){
-        warn qq{$package does not export its sugar to the 'main' package.\n};
-        return;
-    }
+    ${^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){
+        my @export_table;
         foreach my $keyword(@exports){
-            no strict 'refs';
-            *{$into.'::'.$keyword} = $spec->{EXPORTS}{$keyword}
-                || confess(qq{The $package package does not export "$keyword"});
+            push @export_table,
+                $keyword => ($spec->{EXPORTS}{$keyword}
+                    || confess(qq{The $package package does not export "$keyword"})
+                );
         }
+        Mouse::Util::install_subroutines($into, @export_table);
     }
     else{
-        my $default = $spec->{DEFAULT};
-        while(my($keyword, $code) = each %{$default}){
-            no strict 'refs';
-            *{$into.'::'.$keyword} = $code;
-        }
+        Mouse::Util::install_subroutines($into, %{$spec->{DEFAULT}});
     }
     return;
 }
@@ -186,6 +224,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};
@@ -197,42 +236,82 @@ sub do_unimport {
 sub _get_caller_package {
     my($arg) = @_;
 
-    # 2 extra level because it's called by import so there's a layer\r
-    # of indirection\r
-    my $offset = 1;\r
-
+    # 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.50_03
 
 =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<Mouse.pm>-like manner. It does this by building custom C<import>,
+C<unimport> methods for your module, based on a spec you provide.
+
+Note that C<Mouse::Exporter> does not provide the C<with_meta> option,
+but you can easily get the metaclass by C<< caller->meta >> as L</SYNOPSIS> shows.
+
+=head1 METHODS
+
+=head2 C<< setup_import_methods( ARGS ) >>
+
+=head2 C<< build_import_methods( ARGS ) -> (\&import, \&unimport) >>
 
 =head1 SEE ALSO
 
 L<Moose::Exporter>
 
 =cut
+