bump version to 0.97

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

diff --git a/lib/Moose/Meta/TypeConstraint/Registry.pm b/lib/Moose/Meta/TypeConstraint/Registry.pm
index 3d1440a..c26ec26 100644 (file)
--- a/lib/Moose/Meta/TypeConstraint/Registry.pm
+++ b/lib/Moose/Meta/TypeConstraint/Registry.pm
@@ -6,9 +6,8 @@ use warnings;
 use metaclass;
 
 use Scalar::Util 'blessed';
-use Carp         'confess'; # FIXME Moose->throw_error
 
-our $VERSION   = '0.59';
+our $VERSION   = '0.97';
 $VERSION = eval $VERSION;
 our $AUTHORITY = 'cpan:STEVAN';
 
@@ -16,8 +15,8 @@ use base 'Class::MOP::Object';
 
 __PACKAGE__->meta->add_attribute('parent_registry' => (
     reader    => 'get_parent_registry',
-    writer    => 'set_parent_registry',    
-    predicate => 'has_parent_registry',    
+    writer    => 'set_parent_registry',
+    predicate => 'has_parent_registry',
 ));
 
 __PACKAGE__->meta->add_attribute('type_constraints' => (
@@ -25,7 +24,7 @@ __PACKAGE__->meta->add_attribute('type_constraints' => (
     default => sub { {} }
 ));
 
-sub new { 
+sub new {
     my $class = shift;
     my $self  = $class->_new(@_);
     return $self;
@@ -38,14 +37,18 @@ sub has_type_constraint {
 
 sub get_type_constraint {
     my ($self, $type_name) = @_;
-    return unless defined $type_name; 
+    return unless defined $type_name;
     $self->type_constraints->{$type_name}
 }
 
 sub add_type_constraint {
     my ($self, $type) = @_;
-    confess("No type supplied / type is not a valid type constraint") 
-        unless ($type && blessed $type && $type->isa('Moose::Meta::TypeConstraint'));
+
+    unless ( $type && blessed $type && $type->isa('Moose::Meta::TypeConstraint') ) {
+        require Moose;
+        Moose->throw_error("No type supplied / type is not a valid type constraint");
+    }
+
     $self->type_constraints->{$type->name} = $type;
 }
 
@@ -71,50 +74,77 @@ Moose::Meta::TypeConstraint::Registry - registry for type constraints
 
 =head1 DESCRIPTION
 
-This module is currently only use internally by L<Moose::Util::TypeConstraints>. 
-It can be used to create your own private type constraint registry as well, but 
-the details of that are currently left as an exercise to the reader. (One hint: 
-You can use the 'parent_registry' feature to connect your private version with the 
-base Moose registry and base Moose types will automagically be found too).
+This class is a registry that maps type constraint names to
+L<Moose::Meta::TypeConstraint> objects.
+
+Currently, it is only used internally by
+L<Moose::Util::TypeConstraints>, which creates a single global
+registry.
+
+=head1 INHERITANCE
+
+C<Moose::Meta::TypeConstraint::Registry> is a subclass of
+L<Class::MOP::Object>.
 
 =head1 METHODS
 
 =over 4
 
-=item B<meta>
+=item B<< Moose::Meta::TypeConstraint::Registry->new(%options) >>
+
+This creates a new registry object based on the provided C<%options>:
+
+=over 8
+
+=item * parent_registry
+
+This is an optional L<Moose::Meta::TypeConstraint::Registry>
+object.
+
+=item * type_constraints
+
+This is hash reference of type names to type objects. This is
+optional. Constraints can be added to the registry after it is
+created.
+
+=back
+
+=item B<< $registry->get_parent_registry >>
+
+Returns the registry's parent registry, if it has one.
+
+=item B<< $registry->has_parent_registry >>
+
+Returns true if the registry has a parent.
 
-=item B<new>
+=item B<< $registry->set_parent_registry($registry) >>
 
-=item B<get_parent_registry>
+Sets the parent registry.
 
-=item B<set_parent_registry ($registry)>
-    
-=item B<has_parent_registry>
+=item B<< $registry->get_type_constraint($type_name) >>
 
-=item B<type_constraints>
+This returns the L<Moose::Meta::TypeConstraint> object from the
+registry for the given name, if one exists.
 
-=item B<has_type_constraint ($type_name)>
+=item B<< $registry->has_type_constraint($type_name) >>
 
-=item B<get_type_constraint ($type_name)>
+Returns true if the registry has a type of the given name.
 
-Returns a type constraint object from the registry by name. Will return
-false if the supplied type name cannot be found.
+=item B<< $registry->add_type_constraint($type) >>
 
-=item B<add_type_constraint ($type)>
+Adds a new L<Moose::Meta::TypeConstraint> object to the registry.
 
-Adds a type constraint object to the registry. Will throw an exception if
-no type is supplied, or the supplied object does not inherit from 
-L<Moose::Meta::TypeConstraint>
+=item B<< $registry->find_type_constraint($type_name) >>
 
-=item B<find_type_constraint ($type_name)>
+This method looks in the current registry for the named type. If the
+type is not found, then this method will look in the registry's
+parent, if it has one.
 
 =back
 
 =head1 BUGS
 
-All complex software has bugs lurking in it, and this module is no 
-exception. If you find a bug please either email me, or add the bug
-to cpan-RT.
+See L<Moose/BUGS> for details on reporting bugs.
 
 =head1 AUTHOR
 
@@ -122,7 +152,7 @@ Stevan Little E<lt>stevan@iinteractive.comE<gt>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2006-2008 by Infinity Interactive, Inc.
+Copyright 2006-2010 by Infinity Interactive, Inc.
 
 L<http://www.iinteractive.com>