X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FMoose%2FMeta%2FTypeCoercion.pm;h=2eb96e1b9a3248dc58ddaed1d90c49986defbcb3;hb=8b5074ce1a5038824f1e1177cd00d1bcfec5a9fb;hp=4f08eb97650740d10be495761884c237bb80d2ac;hpb=a532c4ac93ebdcbd09cd455dbb49caf8a7de1912;p=gitmo%2FMoose.git

diff --git a/lib/Moose/Meta/TypeCoercion.pm b/lib/Moose/Meta/TypeCoercion.pm
index 4f08eb9..2eb96e1 100644
--- a/lib/Moose/Meta/TypeCoercion.pm
+++ b/lib/Moose/Meta/TypeCoercion.pm
@@ -8,7 +8,7 @@ use metaclass;
 use Moose::Meta::Attribute;
 use Moose::Util::TypeConstraints ();
 
-our $VERSION   = '0.71_01';
+our $VERSION   = '0.97';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -29,9 +29,9 @@ __PACKAGE__->meta->add_attribute('compiled_type_coercion' => (
     accessor => '_compiled_type_coercion'
 ));
 
-sub new { 
+sub new {
     my $class = shift;
-    my $self  = $class->meta->new_object(@_);
+    my $self  = Class::MOP::class_of($class)->new_object(@_);
     $self->compile_type_coercion;
     return $self;
 }
@@ -49,22 +49,22 @@ sub compile_type_coercion {
             Moose->throw_error("Could not find the type constraint ($constraint_name) to coerce from");
         }
 
-        push @coercions => [ 
-            $type_constraint->_compiled_type_constraint, 
-            $action 
+        push @coercions => [
+            $type_constraint->_compiled_type_constraint,
+            $action
         ];
     }
-    $self->_compiled_type_coercion(sub { 
+    $self->_compiled_type_coercion(sub {
         my $thing = shift;
         foreach my $coercion (@coercions) {
             my ($constraint, $converter) = @$coercion;
             if ($constraint->($thing)) {
-                local $_ = $thing;                
+                local $_ = $thing;
                 return $converter->($thing);
             }
         }
         return $thing;
-    });    
+    });
 }
 
 sub has_coercion_for_type {
@@ -75,12 +75,12 @@ sub has_coercion_for_type {
 
 sub add_type_coercions {
     my ($self, @new_coercion_map) = @_;
-        
-    my $coercion_map = $self->type_coercion_map;    
+
+    my $coercion_map = $self->type_coercion_map;
     my %has_coercion = @$coercion_map;
-    
+
     while (@new_coercion_map) {
-        my ($constraint_name, $action) = splice(@new_coercion_map, 0, 2);        
+        my ($constraint_name, $action) = splice(@new_coercion_map, 0, 2);
 
         if ( exists $has_coercion{$constraint_name} ) {
             require Moose;
@@ -89,7 +89,7 @@ sub add_type_coercions {
 
         push @{$coercion_map} => ($constraint_name, $action);
     }
-    
+
     # and re-compile ...
     $self->compile_type_coercion;
 }
@@ -109,42 +109,72 @@ Moose::Meta::TypeCoercion - The Moose Type Coercion metaclass
 
 =head1 DESCRIPTION
 
-For the most part, the only time you will ever encounter an 
-instance of this class is if you are doing some serious deep 
-introspection. This API should not be considered final, but 
-it is B<highly unlikely> that this will matter to a regular 
-Moose user.
+A type coercion object is basically a mapping of one or more type
+constraints and the associated coercions subroutines.
 
-If you wish to use features at this depth, please come to the 
-#moose IRC channel on irc.perl.org and we can talk :)
+It's unlikely that you will need to instantiate an object of this
+class directly, as it's part of the deep internals of Moose.
 
 =head1 METHODS
 
 =over 4
 
-=item B<meta>
+=item B<< Moose::Meta::TypeCoercion->new(%options) >>
+
+Creates a new type coercion object, based on the options provided.
+
+=over 8
+
+=item * type_constraint
+
+This is the L<Moose::Meta::TypeConstraint> object for the type that is
+being coerced I<to>.
+
+=back
+
+=item B<< $coercion->type_coercion_map >>
+
+This returns the map of type constraints to coercions as an array
+reference. The values of the array alternate between type names and
+subroutine references which implement the coercion.
+
+The value is an array reference because coercions are tried in the
+order they are added.
+
+=item B<< $coercion->type_constraint >>
+
+This returns the L<Moose::Meta::TypeConstraint> that was passed to the
+constructor.
+
+=item B<< $coercion->has_coercion_for_type($type_name) >>
+
+Returns true if the coercion can coerce the named type.
+
+=item B<< $coercion->add_type_coercions( $type_name => $sub, ... ) >>
 
-=item B<new>
+This method takes a list of type names and subroutine references. If
+the coercion already has a mapping for a given type, it throws an
+exception.
 
-=item B<compile_type_coercion>
+Coercions are actually
 
-=item B<coerce>
+=item B<< $coercion->coerce($value) >>
 
-=item B<type_coercion_map>
+This method takes a value and applies the first valid coercion it
+finds.
 
-=item B<type_constraint>
+This means that if the value could belong to more than type in the
+coercion object, the first coercion added is used.
 
-=item B<has_coercion_for_type>
+=item B<< Moose::Meta::TypeCoercion->meta >>
 
-=item B<add_type_coercions>
+This will return a L<Class::MOP::Class> instance for this class.
 
 =back
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+See L<Moose/BUGS> for details on reporting bugs.
 
 =head1 AUTHOR
 
@@ -152,11 +182,11 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2009 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
 
 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. 
+it under the same terms as Perl itself.
 
 =cut