rollback some stuff to reset my brain a bit

[gitmo/MooseX-Types-Structured.git] / lib / MooseX / Meta / TypeConstraint / Role / Structured.pm

diff --git a/lib/MooseX/Meta/TypeConstraint/Role/Structured.pm b/lib/MooseX/Meta/TypeConstraint/Role/Structured.pm
index 73b9b8b..6f2afff 100644 (file)
--- a/lib/MooseX/Meta/TypeConstraint/Role/Structured.pm
+++ b/lib/MooseX/Meta/TypeConstraint/Role/Structured.pm
@@ -1,22 +1,45 @@
 package MooseX::Meta::TypeConstraint::Role::Structured;
 
 use Moose::Role;
+use Moose::Util::TypeConstraints;
+requires qw(_normalize_args signature_equals);
 
 =head1 NAME
 
 MooseX::Meta::TypeConstraint::Role::Structured - Structured Type Constraints
 
-=head1 VERSION
+=head1 DESCRIPTION
 
-0.01
+This Role defines the interface and basic behavior of Structured Type Constraints.
 
-=cut
+Structured type constraints let you assign an internal pattern of type
+constraints to a 'container' constraint.  The goal is to make it easier to
+declare constraints like "ArrayRef[Int, Int, Str]" where the constraint is an
+ArrayRef of three elements and the internal constraint on the three is Int, Int
+and Str.
 
-our $VERSION = '0.01';
+To accomplish this, we add an attribute to the base L<Moose::Meta::TypeConstraint>
+to hold a L</signature>, which is a reference to a pattern of type constraints.
+We then override L</constraint> to check our incoming value to the attribute
+against this signature pattern.  Additionally we allow L</optional_signature> to
+hold any optional type constraints.  The overall goal is to support something
+like:
 
-=head1 DESCRIPTION
+    has 'attr' => (isa=>'Tuple[Int, Str, Optional[Int, Int]]');
+
+These classes define how the underlying support for this works.
+
+=head1 TYPES
+
+The following types are defined in this class.
+
+=head2 Moose::Meta::TypeConstraint
 
-STUB - TBD
+Used to make sure we can properly validate incoming signatures.
+
+=cut
+
+class_type 'Moose::Meta::TypeConstraint';
 
 =head1 ATTRIBUTES
 
@@ -35,23 +58,22 @@ has 'signature' => (
     required=>1,
 );
 
-=head1 METHODS
-
-This class defines the following methods.
-
-=head2 _normalize_args
+=head2 optional_signature
 
-Get arguments into a known state or die trying.  Ideally we try to make this
-into a HashRef so we can match it up with the L</signature> HashRef.
+This is a signature of internal contraints for the contents of the outer
+contraint container.  These are optional constraints.
 
 =cut
 
-    
-=head2 constraint
+has 'optional_signature' => (
+    is=>'ro',
+    isa=>'Ref',
+    predicate=>'has_optional_signature',
+);
 
-The constraint is basically validating the L</signature> against the incoming
+=head1 METHODS
 
-=cut
+This class defines the following methods.
 
 =head2 equals
 
@@ -59,11 +81,21 @@ modifier to make sure equals descends into the L</signature>
 
 =cut
 
-=head2 signature_equals
-
-Check that the signature equals another signature.
-
-=cut
+around 'equals' => sub {
+    my ($equals, $self, $compared_type_constraint) = @_;
+    
+    ## Make sure we are comparing typeconstraints of the same base class
+    return unless $compared_type_constraint->isa(__PACKAGE__);
+    
+    ## Make sure the base equals is also good
+    return unless $self->$equals($compared_type_constraint);
+    
+    ## Make sure the signatures match
+    return unless $self->signature_equals($compared_type_constraint);
+   
+    ## If we get this far, the two are equal
+    return 1;
+};
 
 =head1 AUTHOR