fixing the authors lists and adding the ClassName type constraint
[gitmo/Moose.git] / lib / Moose / Util / TypeConstraints.pm
index 74739c1..9dfa98b 100644 (file)
@@ -9,9 +9,29 @@ use Scalar::Util 'blessed';
 use B            'svref_2object';
 use Sub::Exporter;
 
-our $VERSION   = '0.11';
+our $VERSION   = '0.12';
 our $AUTHORITY = 'cpan:STEVAN';
 
+# Prototyped subs must be predeclared because we have a circular dependency
+# with Moose::Meta::Attribute et. al. so in case of us being use'd first the
+# predeclaration ensures the prototypes are in scope when consumers are
+# compiled
+
+sub find_type_constraint ($);
+sub _create_type_constraint ($$$;$$);
+sub _install_type_coercions ($$);
+sub create_type_constraint_union (@);
+sub type ($$;$$);
+sub subtype ($$;$$$);
+sub coerce ($@);
+sub as      ($);
+sub from    ($);
+sub where   (&);
+sub via     (&);
+sub message     (&);
+sub optimize_as (&);
+sub enum ($;@);
+
 use Moose::Meta::TypeConstraint;
 use Moose::Meta::TypeCoercion;
 
@@ -67,14 +87,18 @@ sub unimport {
         
         my ($message, $optimized);
         for (@_) {
-            $message   = $_->{message} if exists $_->{message};
+            $message   = $_->{message}   if exists $_->{message};
             $optimized = $_->{optimized} if exists $_->{optimized};            
         }
 
-        my $pkg_defined_in = scalar(caller(1));
+        my $pkg_defined_in = scalar(caller(0));
+        
         ($TYPES{$name}->[0] eq $pkg_defined_in)
-            || confess "The type constraint '$name' has already been created "
-                 if defined $name && exists $TYPES{$name};                
+            || confess ("The type constraint '$name' has already been created in " 
+                       . $TYPES{$name}->[0] . " and cannot be created again in "
+                       . $pkg_defined_in)
+                 if defined $name && exists $TYPES{$name};   
+                              
         $parent = find_type_constraint($parent) if defined $parent;
         my $constraint = Moose::Meta::TypeConstraint->new(
             name       => $name || '__ANON__',
@@ -108,20 +132,24 @@ sub unimport {
         );
     }
     
-    sub export_type_contstraints_as_functions {
+    sub export_type_constraints_as_functions {
         my $pkg = caller();
            no strict 'refs';
        foreach my $constraint (keys %TYPES) {
                *{"${pkg}::${constraint}"} = find_type_constraint($constraint)->_compiled_type_constraint;
        }        
-    }    
+    }
+    
+    *Moose::Util::TypeConstraints::export_type_contstraints_as_functions = \&export_type_constraints_as_functions;
+    
+    sub list_all_type_constraints { keys %TYPES }   
 }
 
 # type constructors
 
-sub type ($$) {
-       my ($name, $check) = @_;
-       _create_type_constraint($name, undef, $check);
+sub type ($$;$$) {
+    splice(@_, 1, 0, undef);
+       goto &_create_type_constraint;  
 }
 
 sub subtype ($$;$$$) {
@@ -217,6 +245,16 @@ subtype 'Role'
     => as 'Object' 
     => where { $_->can('does') }
     => optimize_as { blessed($_[0]) && $_[0]->can('does') };
+    
+subtype 'ClassName' 
+    => as 'Str' 
+    => where { eval { $_->isa('UNIVERSAL') } }
+    => optimize_as { !ref($_[0]) && eval { $_[0]->isa('UNIVERSAL') } };    
+
+{
+    my @BUILTINS = list_all_type_constraints();
+    sub list_all_builtin_type_constraints { @BUILTINS }
+}
 
 1;
 
@@ -301,6 +339,7 @@ could probably use some work, but it works for me at the moment.
               Num
                 Int
               Str
+                ClassName
           Ref
               ScalarRef
               ArrayRef
@@ -317,6 +356,12 @@ Suggestions for improvement are welcome.
 B<NOTE:> The C<Undef> type constraint does not work correctly 
 in every occasion, please use it sparringly.
 
+B<NOTE:> The C<ClassName> type constraint is simply a subtype 
+of string which responds true to C<isa('UNIVERSAL')>. This means
+that your class B<must> be loaded for this type constraint to 
+pass. I know this is not ideal for all, but it is a saner 
+restriction then most others. 
+
 =head2 Use with Other Constraint Modules
 
 This module should play fairly nicely with other constraint 
@@ -327,7 +372,7 @@ modules work in a similar way, it should be simple to adapt
 them to work with Moose.
 
 For instance, this is how you could use it with 
-L<Declare::Constraint::Simple> to declare a completely new type. 
+L<Declare::Constraints::Simple> to declare a completely new type. 
 
   type 'HashOfArrayOfObjects' 
       => IsHashRef(
@@ -367,12 +412,28 @@ meta-object. What you do with it from there is up to you :)
 Given a list of C<@type_constraint_names>, this will return a 
 B<Moose::Meta::TypeConstraint::Union> instance.
 
-=item B<export_type_contstraints_as_functions>
+=item B<export_type_constraints_as_functions>
 
 This will export all the current type constraints as functions 
 into the caller's namespace. Right now, this is mostly used for 
 testing, but it might prove useful to others.
 
+=item B<export_type_contstraints_as_functions>
+
+Alias for the above function.
+
+=item B<list_all_type_constraints>
+
+This will return a list of type constraint names, you can then 
+fetch them using C<find_type_constraint ($type_name)> if you 
+want to.
+
+=item B<list_all_builtin_type_constraints>
+
+This will return a list of builtin type constraints, meaning, 
+those which are defined in this module. See the section 
+labeled L<Default Type Constraints> for a complete list.
+
 =back
 
 =head2 Type Constraint Constructors
@@ -381,7 +442,7 @@ The following functions are used to create type constraints.
 They will then register the type constraints in a global store 
 where Moose can get to them if it needs to. 
 
-See the L<SYNOPOSIS> for an example of how to use these.
+See the L<SYNOPSIS> for an example of how to use these.
 
 =over 4
 
@@ -441,7 +502,7 @@ code first, followed by the type constraint check. This feature
 should be used carefully as it is very powerful and could easily 
 take off a limb if you are not careful.
 
-See the L<SYNOPOSIS> for an example of how to use these.
+See the L<SYNOPSIS> for an example of how to use these.
 
 =over 4