From: gfx <gfuji@cpan.org>
Date: Wed, 7 Oct 2009 05:29:58 +0000 (+0900)
Subject: Tweaks and documenting Mouse::Exporter
X-Git-Tag: 0.37_03~22
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=gitmo%2FMouse.git;a=commitdiff_plain;h=8cbcbb47d0f02077d07873c553494a884d9c085f

Tweaks and documenting Mouse::Exporter
---

diff --git a/lib/Mouse/Exporter.pm b/lib/Mouse/Exporter.pm
index 8e54df1..05bd169 100644
--- a/lib/Mouse/Exporter.pm
+++ b/lib/Mouse/Exporter.pm
@@ -124,6 +124,7 @@ sub do_import {
     my $into = _get_caller_package(ref($args[0]) ? shift @args : undef);
 
     my @exports;
+
     foreach my $arg(@args){
         if($arg =~ s/^-//){
             Mouse::Util::not_supported("-$arg");
@@ -194,20 +195,20 @@ sub do_unimport {
     return;
 }
 
+# 1 extra level because it's called by import so there's a layer
+# of indirection
+sub _LEVEL(){ 1 }
+
 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;
-
     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(_LEVEL + $arg->{into_level})
+             :                               scalar caller(_LEVEL);
     }
     else{
-        return scalar caller($offset);
+        return scalar caller(_LEVEL);
     }
 }
 
@@ -217,19 +218,49 @@ __END__
 
 =head1 NAME
 
-Mouse - The Mouse Exporter
+Mouse::Exporter - make an import() and unimport() just like Mouse.pm
 
 =head1 SYNOPSIS
 
-    package MouseX::Foo;
-    use Mouse::Exporter;
-
-    Mouse::Exporter->setup_import_methods(
-
-    );
+    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 SEE ALSO
 
diff --git a/t/055-exporter.t b/t/055-exporter.t
index c089885..7f945c6 100644
--- a/t/055-exporter.t
+++ b/t/055-exporter.t
@@ -22,6 +22,10 @@ BEGIN{
     Mouse::Exporter->setup_import_methods(
         as_is => [\&bar],
         also  => [qw(MyMouse)],
+
+#        groups => {
+#            foobar_only => [qw(foo bar)],
+#        },
     );
 
     sub bar{ 200 }
@@ -62,3 +66,16 @@ can_ok 'MyMouseEx', qw(import unimport);
     ok !defined(&bar), 'foo is also unimported';
     ok !defined(&has), 'has is also unimported';
 }
+
+# exporting groups are not implemented in Moose::Exporter
+#{
+#    package MyAppExTags;
+#    use Test::More;
+#    use MyMouseEx qw(:foobar_only);
+#
+#    can_ok __PACKAGE__, 'meta';
+#    ok defined(&foo);
+#    ok defined(&bar);
+#    ok!defined(&has), "export tags";
+#}
+