changes-and-comments
[gitmo/Moose.git] / lib / Moose / Util / TypeConstraints.pm
index 63ba714..68ed3ee 100644 (file)
@@ -7,30 +7,44 @@ use warnings;
 use Carp         'confess';
 use Scalar::Util 'blessed';
 
-our $VERSION = '0.03';
+our $VERSION = '0.05';
 
 use Moose::Meta::TypeConstraint;
 use Moose::Meta::TypeCoercion;
 
-sub import {
-       shift;
-       my $pkg = shift || caller();
-       return if $pkg eq '-no-export';
-       no strict 'refs';
-       foreach my $export (qw(type subtype as where message coerce from via find_type_constraint)) {
-               *{"${pkg}::${export}"} = \&{"${export}"};
-       }       
+{
+    require Sub::Exporter;
+    
+    my @exports = qw[type subtype as where message coerce from via find_type_constraint enum];
+
+    Sub::Exporter->import( 
+        -setup => { 
+            exports => \@exports,
+            groups  => {
+                default => [':all']
+            }
+        }
+    );
 }
 
 {
     my %TYPES;
-    sub find_type_constraint { $TYPES{$_[0]}->[1] }
-
+    sub find_type_constraint { 
+        return $TYPES{$_[0]}->[1] 
+            if exists $TYPES{$_[0]};
+        return;
+    }
+    
+    sub _dump_type_constraints {
+        require Data::Dumper;        
+        Data::Dumper::Dumper(\%TYPES);
+    }
+    
     sub _create_type_constraint { 
         my ($name, $parent, $check, $message) = @_;
         my $pkg_defined_in = scalar(caller(1));
         ($TYPES{$name}->[0] eq $pkg_defined_in)
-            || confess "The type constraint '$name' has already been created"
+            || confess "The type constraint '$name' has already been created "
                  if defined $name && exists $TYPES{$name};                
         $parent = find_type_constraint($parent) if defined $parent;
         my $constraint = Moose::Meta::TypeConstraint->new(
@@ -55,6 +69,15 @@ sub import {
         $type->coercion($type_coercion);
     }
     
+    sub create_type_constraint_union {
+        my (@type_constraint_names) = @_;
+        return Moose::Meta::TypeConstraint->union(
+            map { 
+                find_type_constraint($_) 
+            } @type_constraint_names
+        );
+    }
+    
     sub export_type_contstraints_as_functions {
         my $pkg = caller();
            no strict 'refs';
@@ -87,17 +110,35 @@ sub where   (&) { $_[0] }
 sub via     (&) { $_[0] }
 sub message (&) { $_[0] }
 
+sub enum {
+    my ($type_name, @values) = @_;
+    my $regexp = join '|' => @values;
+       _create_type_constraint(
+           $type_name,
+           'Str',
+           sub { qr/^$regexp$/i }
+       );    
+}
+
 # define some basic types
 
-type 'Any' => where { 1 };
+type 'Any'  => where { 1 }; # meta-type including all
+type 'Item' => where { 1 }; # base-type 
+
+subtype 'Undef'   => as 'Item' => where { !defined($_) };
+subtype 'Defined' => as 'Item' => where {  defined($_) };
+
+subtype 'Bool'  => as 'Item' => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' };
+
+subtype 'Value' => as 'Defined' => where { !ref($_) };
+subtype 'Ref'   => as 'Defined' => where {  ref($_) };
 
-subtype 'Value' => as 'Any' => where { !ref($_) };
-subtype 'Ref'   => as 'Any' => where {  ref($_) };
+subtype 'Str' => as 'Value' => where { 1 };
 
-subtype 'Int' => as 'Value' => where {  Scalar::Util::looks_like_number($_) };
-subtype 'Str' => as 'Value' => where { !Scalar::Util::looks_like_number($_) };
+subtype 'Num' => as 'Value' => where { Scalar::Util::looks_like_number($_) };
+subtype 'Int' => as 'Num'   => where { "$_" =~ /^-?[0-9]+$/ };
 
-subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' };      
+subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' };
 subtype 'ArrayRef'  => as 'Ref' => where { ref($_) eq 'ARRAY'  };
 subtype 'HashRef'   => as 'Ref' => where { ref($_) eq 'HASH'   };      
 subtype 'CodeRef'   => as 'Ref' => where { ref($_) eq 'CODE'   };
@@ -107,6 +148,8 @@ subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' };
 # blessed(qr/.../) returns true,.. how odd
 subtype 'Object' => as 'Ref' => where { blessed($_) && blessed($_) ne 'Regexp' };
 
+subtype 'Role' => as 'Object' => where { $_->can('does') };
+
 1;
 
 __END__
@@ -129,11 +172,14 @@ Moose::Util::TypeConstraints - Type constraint system for Moose
   
   subtype NaturalLessThanTen 
       => as Natural
-      => where { $_ < 10 };
+      => where { $_ < 10 }
+      => message { "This number ($_) is not less than ten!" };
       
   coerce Num 
       => from Str
         => via { 0+$_ }; 
+        
+  enum RGBColors => qw(red green blue);
 
 =head1 DESCRIPTION
 
@@ -156,16 +202,22 @@ This module also provides a simple hierarchy for Perl 5 types, this
 could probably use some work, but it works for me at the moment.
 
   Any
-      Value
-          Int
-          Str
-      Ref
-          ScalarRef
-          ArrayRef
-          HashRef
-          CodeRef
-          RegexpRef
-          Object       
+  Item 
+      Bool
+      Undef
+      Defined
+          Value
+              Num
+                Int
+              Str
+          Ref
+              ScalarRef
+              ArrayRef
+              HashRef
+              CodeRef
+              RegexpRef
+              Object   
+                  Role
 
 Suggestions for improvement are welcome.
     
@@ -180,6 +232,11 @@ Suggestions for improvement are welcome.
 This function can be used to locate a specific type constraint 
 meta-object. What you do with it from there is up to you :)
 
+=item B<create_type_constraint_union (@type_constraint_names)>
+
+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>
 
 This will export all the current type constraints as functions 
@@ -202,16 +259,18 @@ See the L<SYNOPOSIS> for an example of how to use these.
 
 This creates a base type, which has no parent. 
 
-=item B<subtype ($name, $parent, $where_clause)>
+=item B<subtype ($name, $parent, $where_clause, ?$message)>
 
 This creates a named subtype. 
 
-=item B<subtype ($parent, $where_clause)>
+=item B<subtype ($parent, $where_clause, ?$message)>
 
 This creates an unnamed subtype and will return the type 
 constraint meta-object, which will be an instance of 
 L<Moose::Meta::TypeConstraint>. 
 
+=item B<enum ($name, @values)>
+
 =item B<as>
 
 This is just sugar for the type constraint construction syntax.
@@ -269,4 +328,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
\ No newline at end of file
+=cut