prepping for 0.08
[gitmo/Moose-Autobox.git] / lib / Moose / Autobox.pm
index 77fd0c6..e56e56f 100644 (file)
@@ -6,50 +6,72 @@ use warnings;
 
 use Carp        qw(confess);
 use Scalar::Util ();
+use Moose::Util  ();
+
+our $VERSION = '0.08';
+
+use base 'autobox';
+
+use Moose::Autobox::Undef;
 
-our $VERSION = '0.02';
-            
 sub import {
-    eval q|
-package # hide from PAUSE
-    SCALAR;
-# NOTE:
-# this doesnt make sense, but 
-# I need to prevent Moose from 
-# assiging to @ISA
-use base 'UNIVERSAL';
-use Moose;
-with 'Moose::Autobox::Scalar';
-
-*does = \&Moose::Object::does;
-
-package # hide from PAUSE
-    ARRAY;
-use base 'UNIVERSAL';
-use Moose;
-with 'Moose::Autobox::Array';
-
-*does = \&Moose::Object::does;
-
-package # hide from PAUSE
-    HASH;
-use base 'UNIVERSAL';
-use Moose;
-with 'Moose::Autobox::Hash';
-
-*does = \&Moose::Object::does;
-
-package # hide from PAUSE 
-    CODE;
-use base 'UNIVERSAL';
-use Moose;
-with 'Moose::Autobox::Code';  
-
-*does = \&Moose::Object::does;
-    |;
-    confess 'Could not create autobox packages because - ' . $@ if $@;
-}               
+    (shift)->SUPER::import(
+        DEFAULT => 'Moose::Autobox::',
+        UNDEF   => 'Moose::Autobox::Undef',
+    );
+}
+
+sub mixin_additional_role {
+    my ($class, $type, $role) = @_;
+    ($type =~ /SCALAR|ARRAY|HASH|CODE/)
+        || confess "Can only add additional roles to SCALAR, ARRAY, HASH or CODE";
+    Moose::Util::apply_all_roles(('Moose::Autobox::' . $type)->meta, ($role));
+}
+
+{
+                        
+    package Moose::Autobox::SCALAR;
+
+    use Moose::Autobox::Scalar;
+
+    use metaclass 'Moose::Meta::Class';
+
+    Moose::Util::apply_all_roles(__PACKAGE__->meta, ('Moose::Autobox::Scalar'));
+
+    *does = \&Moose::Object::does;
+
+    package Moose::Autobox::ARRAY;
+
+    use Moose::Autobox::Array;
+
+    use metaclass 'Moose::Meta::Class';
+
+    Moose::Util::apply_all_roles(__PACKAGE__->meta, ('Moose::Autobox::Array'));
 
+    *does = \&Moose::Object::does;
+
+    package Moose::Autobox::HASH;
+
+    use Moose::Autobox::Hash;
+
+    use metaclass 'Moose::Meta::Class';
+
+    Moose::Util::apply_all_roles(__PACKAGE__->meta, ('Moose::Autobox::Hash'));
+
+    *does = \&Moose::Object::does;
+
+    package Moose::Autobox::CODE;
+
+    use Moose::Autobox::Code;
+
+    use metaclass 'Moose::Meta::Class';
+
+    Moose::Util::apply_all_roles(__PACKAGE__->meta, ('Moose::Autobox::Code'));
+
+    *does = \&Moose::Object::does;            
+} 
+                 
 1;
 
 __END__
@@ -58,30 +80,15 @@ __END__
 
 =head1 NAME 
 
-Moose::Autobox - Autoboxed for her pleasure
+Moose::Autobox - Autoboxed wrappers for Native Perl datatypes 
 
 =head1 SYNOPOSIS
 
   use Moose::Autobox;
-  use autobox;
   
   print 'Print squares from 1 to 10 : ';
   print [ 1 .. 10 ]->map(sub { $_ * $_ })->join(', ');
 
-=head1 CAVEAT
-
-First, a warning.
-
-This module is very very very very very very very experimental. It 
-makes use of a very experimental module (L<autobox>) and uses some 
-shiney new technology (L<Moose::Role>) to accomplish it's goals.
-
-Use this at your own risk. If it breaks the lamp in the living room
-and your mother yells at you, don't come complaining to me.
-
-Also, as this is so experimental, it's API should not be considered 
-to be stable. It could very well change in radical ways.
-
 =head1 DESCRIPTION
 
 Moose::Autobox provides an implementation of SCALAR, ARRAY, HASH
@@ -102,31 +109,41 @@ the 'hooks' for others to add implementation too.
 
 =head2 Is this for real? or just play?
 
-My intent is to try and make this module as production worthy as 
-possible. This may or may not be possible, depending on how well 
-L<autobox> works out. At this point, I have high hopes for things
-but only time (and more tests and code) will tell.
-
-=head1 ROLES
-
-This is a rough diagram of the roles involved to get our 4 
-autoboxed types (SCALAR, ARRAY, HASH & CODE). 
-                                                          
-  +------------------------+-------------------------------+
-  |  Identity              |  Behavioral                   |
-  +------------------------+-------------------------------+
-  |  Item                  |                               |
-  |      Undef             |                               |
-  |      Defined           |                               |
-  |          Scalar*     <-|- String, Number <--+          |
-  |          Ref           |                    |-- Value  |
-  |              Array*  <-|- List <------------+          |
-  |              Hash*     |                               |
-  |              Code*     |                               |
-  |                        |                               |
-  +------------------------+-------------------------------+
-                                                          
-  * indicates actual autoboxed types
+Several people are using this module in serious applications and 
+it seems to be quite stable. The underlying technologies of L<autobox>
+and L<Moose::Role> are also considered stable. There is some performance
+hit, but as I am fond of saying, nothing in life is free. If you have 
+any questions regarding this module, either email me, or stop by #moose
+on irc.perl.org and ask around.
+
+=head2 Adding additional methods
+
+B<Moose::Autobox> asks L<autobox> to use the B<Moose::Autobox::*> namespace 
+prefix so as to avoid stepping on the toes of other L<autobox> modules. This 
+means that if you want to add methods to a particular perl type 
+(i.e. - monkeypatch), then you must do this:
+
+  sub Moose::Autobox::SCALAR::bar { 42 }
+
+instead of this:
+
+  sub SCALAR::bar { 42 }
+
+as you would with vanilla autobox.
+
+=head1 METHODS
+
+=over 4
+
+=item B<mixin_additional_role ($type, $role)>
+
+This will mixin an additonal C<$role> into a certain C<$type>. The 
+types can be SCALAR, ARRAY, HASH or CODE.
+
+This can be used to add additional methods to the types, see the 
+F<examples/units/> directory for some examples.
+
+=back
 
 =head1 TODO
 
@@ -138,14 +155,6 @@ autoboxed types (SCALAR, ARRAY, HASH & CODE).
 
 =back
   
-=head1 NOTES  
-  
-  - String, Number & List are currently the only 'Value's.
-  
-  - Indexed is pretty much an interface, we probably will 
-    need more of these (see Smalltalk Collection Trait 
-    Refactoring)
-  
 =head1 BUGS
 
 All complex software has bugs lurking in it, and this module is no 
@@ -156,9 +165,17 @@ to cpan-RT.
 
 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
+B<with contributions from:>
+
+Anders (Debolaz) Nor Berle
+
+Matt (mst) Trout
+
+renormalist
+
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006 by Infinity Interactive, Inc.
+Copyright 2006-2008 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>