Tweaks and documenting Mouse::Exporter

[gitmo/Mouse.git] / lib / Mouse / Exporter.pm

diff --git a/lib/Mouse/Exporter.pm b/lib/Mouse/Exporter.pm
index 8e54df1..05bd169 100644 (file)
--- 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\r
+# of indirection\r
+sub _LEVEL(){ 1 }
+
 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
-
     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;\r
+\r
+    use Mouse ();\r
+    use Mouse::Exporter;\r
+\r
+    Mouse::Exporter->setup_import_methods(\r
+      as_is     => [ 'has_rw', 'other_sugar', \&Some::Random::thing ],\r
+      also      => 'Mouse',\r
+    );\r
+\r
+    sub has_rw {
+        my $meta = caller->meta;\r
+        my ( $name, %options ) = @_;\r
+        $meta->add_attribute(\r
+          $name,\r
+          is => 'rw',\r
+          %options,\r
+        );\r
+    }\r
+\r
+    # then later ...\r
+    package MyApp::User;\r
+
+    use MyApp::Mouse;\r
+\r
+    has 'name';\r
+    has_rw 'size';\r
+    thing;\r
+\r
+    no MyApp::Mouse;
 
 =head1 DESCRIPTION
 
+This module encapsulates the exporting of sugar functions in a\r
+C<Mouse.pm>-like manner. It does this by building custom C<import>,\r
+C<unimport> methods for your module, based on a spec you provide.\r
+
+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