foo
[gitmo/Moose-Autobox.git] / lib / Moose / Autobox.pm
index 5af7ff5..6a490ad 100644 (file)
@@ -4,7 +4,7 @@ package Moose::Autobox;
 use strict;
 use warnings;
 
-use Moose        qw(confess);
+use Carp        qw(confess);
 use Scalar::Util ();
 
 our $VERSION = '0.01';
@@ -12,20 +12,39 @@ our $VERSION = '0.01';
 sub import {
     eval q|
 package 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 ARRAY;
+use base 'UNIVERSAL';
 use Moose;
 with 'Moose::Autobox::Array';
 
+*does = \&Moose::Object::does;
+
 package HASH;
+use base 'UNIVERSAL';
 use Moose;
 with 'Moose::Autobox::Hash';
 
+*does = \&Moose::Object::does;
+
 package CODE;
+use base 'UNIVERSAL';
 use Moose;
-with 'Moose::Autobox::Code';    
+with 'Moose::Autobox::Code';  
+
+*does = \&Moose::Object::does;
+  
     |;
     confess 'Could not create autobox packages because - ' . $@ if $@;
 }               
@@ -38,31 +57,94 @@ __END__
 
 =head1 NAME 
 
-Moose::Autobox - autoboxed for her pleasure
+Moose::Autobox - Autoboxed for her pleasure
 
 =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
 
-  Any
-  Item 
-      Bool
-      Undef
-      Defined
-          Value
-              Num
-                Int
-              Str
-          Ref
-              ScalarRef
-              ArrayRef
-              HashRef
-              CodeRef
-              RegexpRef
-              Object   
-                  Role
+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                   |
+  +------------------------+-------------------------------+
+  |  Item                  |                               |
+  |      Undef             |                               |
+  |      Defined           |                               |
+  |          Scalar*     <-|- String, Number <--+          |
+  |          Ref           |                    |-- Value  |
+  |              Array*  <-|- List <------------+          |
+  |              Hash*     |                               |
+  |              Code*     |                               |
+  |                        |                               |
+  +------------------------+-------------------------------+
+                                                          
+  * indicates actual autoboxed types
+
+=head1 TODO
+
+=over 4
+
+=item More docs
+
+=item More tests
+
+=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 
@@ -82,7 +164,4 @@ L<http://www.iinteractive.com>
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself.
 
-
 =cut
-
-