Add descriptions to pods

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

diff --git a/lib/Squirrel.pm b/lib/Squirrel.pm
index 039b7e4..bbbad76 100644 (file)
--- a/lib/Squirrel.pm
+++ b/lib/Squirrel.pm
@@ -1,22 +1,21 @@
-#!/usr/bin/perl
-
 package Squirrel;
-
 use strict;
 use warnings;
 
 sub _choose_backend {
     if ( $INC{"Moose.pm"} ) {
         return {
+            backend  => 'Moose',
             import   => \&Moose::import,
             unimport => \&Moose::unimport,
-        }
+        };
     } else {
         require Mouse;
         return {
+            backend  => 'Mouse',
             import   => \&Mouse::import,
             unimport => \&Mouse::unimport,
-        }
+        };
     }
 }
 
@@ -31,14 +30,21 @@ sub _handlers {
 }
 
 sub import {
-    goto $_[0]->_handlers->{import};
+    require Carp;
+    Carp::carp("Squirrel is deprecated. Please use Any::Moose instead. It fixes a number of design problems that Squirrel has.");
+
+    my $handlers = shift->_handlers;
+    unshift @_, $handlers->{backend};
+    goto &{$handlers->{import}};
 }
 
 sub unimport {
-    goto $_[0]->_handlers->{unimport};
+    my $handlers = shift->_handlers;
+    unshift @_, $handlers->{backend};
+    goto &{$handlers->{unimport}};
 }
 
-__PACKAGE__
+1;
 
 __END__
 
@@ -46,26 +52,36 @@ __END__
 
 =head1 NAME
 
-Squirrel - Use L<Mouse>, unless L<Moose> is already loaded.
+Squirrel - Use Mouse, unless Moose is already loaded. (DEPRECATED)
 
 =head1 SYNOPSIS
 
-       use Squirrel;
+    use Squirrel;
 
     has goggles => (
         is => "rw", 
     );
 
+=head1 DEPRECATION
+
+C<Squirrel> is deprecated. C<Any::Moose> provides the same functionality,
+but better. :)
+
 =head1 DESCRIPTION
 
-L<Moose> and L<Squirrel> are TEH BEST FRENDS, but if L<Moose> isn't there
+L<Moose> and L<Squirrel> are THE BEST FRIENDS, but if L<Moose> isn't there
 L<Squirrel> will hang out with L<Mouse> as well.
 
 When your own code doesn't actually care whether or not you use L<Moose> or
 L<Mouse> you can use either, and let your users decide for you.
 
 This lets you run with minimal dependencies and have a faster startup, but if
-L<Moose> is already in use you get all the benefits of using that.
+L<Moose> is already in use you get all the benefits of using that
+(transformability, introspection, more opportunities for code reuse, etc).
+
+=head1 SEE ALSO
+
+L<Any::Moose>
 
 =cut