Convert from Module::Install to Dist::Zilla
[gitmo/MooseX-Types-Structured.git] / lib / MooseX / Meta / TypeConstraint / Structured.pm
index 44691e4..9a76e4c 100644 (file)
@@ -1,5 +1,6 @@
 package ## Hide from PAUSE
  MooseX::Meta::TypeConstraint::Structured;
+# ABSTRACT: MooseX::Meta::TypeConstraint::Structured - Structured type constraints.
 
 use Moose;
 use Devel::PartialDump;
@@ -7,9 +8,6 @@ use Moose::Util::TypeConstraints ();
 use MooseX::Meta::TypeCoercion::Structured;
 extends 'Moose::Meta::TypeConstraint';
 
-=head1 NAME
-
-MooseX::Meta::TypeConstraint::Structured - Structured type constraints.
 
 =head1 DESCRIPTION
 
@@ -19,15 +17,11 @@ idea here is that a Type Constraint could be something like, "An Int followed by
 an Int and then a Str" and that this could be done so with a declaration like:
 
     Tuple[Int,Int,Str]; ## Example syntax
-    
+
 So a structure is a list of Type constraints (the "Int,Int,Str" in the above
 example) which are intended to function together.
 
-=head1 ATTRIBUTES
-
-This class defines the following attributes.
-
-=head2 type_constraints
+=attr type_constraints
 
 A list of L<Moose::Meta::TypeConstraint> objects.
 
@@ -39,7 +33,7 @@ has 'type_constraints' => (
     predicate=>'has_type_constraints',
 );
 
-=head2 constraint_generator
+=attr constraint_generator
 
 A subref or closure that contains the way we validate incoming values against
 a set of type constraints.
@@ -58,16 +52,6 @@ has coercion => (
     builder => '_build_coercion',
 );
 
-=head1 METHODS
-
-This class defines the following methods.
-
-=head2 new
-
-Initialization stuff.
-
-=cut
-
 sub _build_coercion {
     my ($self) = @_;
     return MooseX::Meta::TypeCoercion::Structured->new(
@@ -75,9 +59,10 @@ sub _build_coercion {
     );
 }
 
-=head2 validate
+=method validate
 
 Messing with validate so that we can support niced error messages.
+
 =cut
 
 override 'validate' => sub {
@@ -98,7 +83,7 @@ override 'validate' => sub {
     }
 };
 
-=head2 generate_constraint_for ($type_constraints)
+=method generate_constraint_for ($type_constraints)
 
 Given some type constraints, use them to generate validation rules for an ref
 of values (to be passed at check time)
@@ -115,14 +100,13 @@ sub generate_constraint_for {
     };
 }
 
-=head2 parameterize (@type_constraints)
+=method parameterize (@type_constraints)
 
 Given a ref of type constraints, create a structured type.
 
 =cut
 
 sub parameterize {
-    
     my ($self, @type_constraints) = @_;
     my $class = ref $self;
     my $name = $self->name .'['. join(',', map {"$_"} @type_constraints) .']';
@@ -136,7 +120,7 @@ sub parameterize {
     );
 }
 
-=head2 __infer_constraint_generator
+=method __infer_constraint_generator
 
 This returns a CODEREF which generates a suitable constraint generator.  Not
 user servicable, you'll never call this directly.
@@ -152,12 +136,12 @@ sub __infer_constraint_generator {
             ## I'm not sure about this stuff but everything seems to work
             my $tc = shift @_;
             my $merged_tc = [@$tc, @{$self->parent->type_constraints}];
-            $self->constraint->($merged_tc, @_);            
+            $self->constraint->($merged_tc, @_);
         };
-    }    
+    }
 }
 
-=head2 compile_type_constraint
+=method compile_type_constraint
 
 hook into compile_type_constraint so we can set the correct validation rules.
 
@@ -165,17 +149,17 @@ hook into compile_type_constraint so we can set the correct validation rules.
 
 around 'compile_type_constraint' => sub {
     my ($compile_type_constraint, $self, @args) = @_;
-    
+
     if($self->has_type_constraints) {
         my $type_constraints = $self->type_constraints;
         my $constraint = $self->generate_constraint_for($type_constraints);
-        $self->_set_constraint($constraint);        
+        $self->_set_constraint($constraint);
     }
 
     return $self->$compile_type_constraint(@args);
 };
 
-=head2 create_child_type
+=method create_child_type
 
 modifier to make sure we get the constraint_generator
 
@@ -189,11 +173,11 @@ around 'create_child_type' => sub {
     );
 };
 
-=head2 is_a_type_of
+=method is_a_type_of
 
-=head2 is_subtype_of
+=method is_subtype_of
 
-=head2 equals
+=method equals
 
 Override the base class behavior.
 
@@ -204,7 +188,7 @@ sub equals {
     my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name);
 
     return unless $other->isa(__PACKAGE__);
-    
+
     return (
         $self->parent->equals($other->parent)
             and
@@ -263,7 +247,7 @@ sub is_subtype_of {
     }
 }
 
-=head2 type_constraints_equals
+=method type_constraints_equals
 
 Checks to see if the internal type constraints are equal.
 
@@ -288,14 +272,14 @@ sub _type_constraints_op_all {
     while(@self_type_constraints) {
         my $self_type_constraint = shift @self_type_constraints;
         my $other_type_constraint = shift @other_type_constraints;
-        
+
         $_ = Moose::Util::TypeConstraints::find_or_create_isa_type_constraint($_)
           for $self_type_constraint, $other_type_constraint;
 
         my $result = $self_type_constraint->$op($other_type_constraint);
         return unless $result;
     }
-    
+
     return 1; ##If we get this far, everything is good.
 }
 
@@ -313,17 +297,17 @@ sub _type_constraints_op_any {
     while(@self_type_constraints) {
         my $self_type_constraint = shift @self_type_constraints;
         my $other_type_constraint = shift @other_type_constraints;
-        
+
         $_ = Moose::Util::TypeConstraints::find_or_create_isa_type_constraint($_)
           for $self_type_constraint, $other_type_constraint;
-        
+
         return 1 if $self_type_constraint->$op($other_type_constraint);
     }
 
     return 0;
 }
 
-=head2 get_message
+=method get_message
 
 Give you a better peek into what's causing the error.  For now we stringify the
 incoming deep value with L<Devel::PartialDump> and pass that on to either your
@@ -345,15 +329,6 @@ The following modules or resources may be of interest.
 
 L<Moose>, L<Moose::Meta::TypeConstraint>
 
-=head1 AUTHOR
-
-John Napiorkowski, C<< <jjnapiork@cpan.org> >>
-
-=head1 COPYRIGHT & LICENSE
-
-This program is free software; you can redistribute it and/or modify
-it under the same terms as Perl itself.
-
 =cut
 
 __PACKAGE__->meta->make_immutable(inline_constructor => 0);