foo

[gitmo/Moose-Autobox.git] / lib / Moose / Autobox.pm

diff --git a/lib/Moose/Autobox.pm b/lib/Moose/Autobox.pm
index 42e0dd6..a36c1f5 100644 (file)
--- a/lib/Moose/Autobox.pm
+++ b/lib/Moose/Autobox.pm
@@ -9,8 +9,8 @@ use Scalar::Util ();
 
 our $VERSION = '0.01';
             
-#sub import {
-#    eval q|
+sub import {
+    eval q|
 package SCALAR;
 
 # NOTE:
@@ -45,9 +45,9 @@ with 'Moose::Autobox::Code';
 
 *does = \&Moose::Object::does;
   
-#    |;
-#    confess 'Could not create autobox packages because - ' . $@ if $@;
-#}               
+    |;
+    confess 'Could not create autobox packages because - ' . $@ if $@;
+}               
 
 1;
 
@@ -57,19 +57,56 @@ __END__
 
 =head1 NAME 
 
-Moose::Autobox - autoboxed for her pleasure
+Moose::Autobox - Autoboxed for her pleasure
 
 =head1 SYNOPOSIS
 
   use Moose::Autobox;
   use autobox;
   
-  'Print squares from 1 to 10'->print;  
-  [ 1 .. 10 ]->map(sub { $_ * $_ })->join(', ')->print;
+  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.
 
 =head1 DESCRIPTION
 
+Moose::Autobox provides an implementation of SCALAR, ARRAY, HASH
+& CODE for use with L<autobox>. It does this using a hierarchy of 
+roles in a manner similar to what Perl 6 I<might> do. This module, 
+like L<Class::MOP> and L<Moose>, was inspired by my work on the 
+Perl 6 Object Space, and the 'core types' implemented there.
+
+=head2 A quick word about autobox
+
+The L<autobox> module provides the ability for calling 'methods' 
+on normal Perl values like Scalars, Arrays, Hashes and Code 
+references. This gives the illusion that Perl's types are first-class 
+objects. However, this is only an illusion, albeit a very nice one.
+I created this module because L<autobox> itself does not actually 
+provide an implementation for the Perl types but instead only provides 
+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                   |
@@ -89,7 +126,7 @@ Moose::Autobox - autoboxed for her pleasure
   
 =head1 NOTES  
   
-  - String, Number & List are currently the only Values.
+  - 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