Version 1.04

[gitmo/Moose.git] / lib / Moose / Meta / TypeConstraint / Enum.pm

diff --git a/lib/Moose/Meta/TypeConstraint/Enum.pm b/lib/Moose/Meta/TypeConstraint/Enum.pm
index c823040..6006993 100644 (file)
--- a/lib/Moose/Meta/TypeConstraint/Enum.pm
+++ b/lib/Moose/Meta/TypeConstraint/Enum.pm
@@ -1,18 +1,19 @@
-#!/usr/bin/perl
-
 package Moose::Meta::TypeConstraint::Enum;
 
 use strict;
 use warnings;
 use metaclass;
 
-our $VERSION   = '0.06';
+use Moose::Util::TypeConstraints ();
+
+our $VERSION   = '1.04';
+$VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
 use base 'Moose::Meta::TypeConstraint';
 
 __PACKAGE__->meta->add_attribute('values' => (
-    accessor  => 'values',
+    accessor => 'values',
 ));
 
 sub new {
@@ -20,7 +21,7 @@ sub new {
 
     $args{parent} = Moose::Util::TypeConstraints::find_type_constraint('Str');
 
-    my $self = $class->meta->new_object(%args);
+    my $self = $class->_new(\%args);
 
     $self->compile_type_constraint()
         unless $self->_has_compiled_type_constraint;
@@ -66,7 +67,12 @@ sub _compile_hand_optimized_type_constraint {
     sub { defined($_[0]) && !ref($_[0]) && exists $values{$_[0]} };
 }
 
-__PACKAGE__
+sub create_child_type {
+    my ($self, @args) = @_;
+    return Moose::Meta::TypeConstraint->new(@args, parent => $self);
+}
+
+1;
 
 __END__
 
@@ -76,20 +82,65 @@ __END__
 
 Moose::Meta::TypeConstraint::Enum - Type constraint for enumerated values.
 
+=head1 DESCRIPTION
+
+This class represents type constraints based on an enumerated list of
+acceptable values.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::TypeConstraint::Enum> is a subclass of
+L<Moose::Meta::TypeConstraint>.
+
 =head1 METHODS
 
 =over 4
 
-=item B<new>
+=item B<< Moose::Meta::TypeConstraint::Enum->new(%options) >>
+
+This creates a new enum type constraint based on the given
+C<%options>.
+
+It takes the same options as its parent, with several
+exceptions. First, it requires an additional option, C<values>. This
+should be an array reference containing a list of valid string
+values. Second, it automatically sets the parent to the C<Str> type.
+
+Finally, it ignores any provided C<constraint> option. The constraint
+is generated automatically based on the provided C<values>.
 
-=item B<equals>
+=item B<< $constraint->values >>
 
-=item B<constraint>
+Returns the array reference of acceptable values provided to the
+constructor.
 
-=item B<values>
+=item B<< $constraint->create_child_type >>
+
+This returns a new L<Moose::Meta::TypeConstraint> object with the type
+as its parent.
+
+Note that it does I<not> return a C<Moose::Meta::TypeConstraint::Enum>
+object!
 
 =back
 
+=head1 BUGS
+
+See L<Moose/BUGS> for details on reporting bugs.
+
+=head1 AUTHOR
+
+Yuval Kogman E<lt>nothingmuch@cpan.orgE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+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.
+
 =cut