use strict;
use warnings;
-use Sub::Name 'subname';
+use Carp 'confess';
use Scalar::Util 'blessed';
-our $VERSION = '0.01';
-
-sub import {
- shift;
- my $pkg = shift || caller();
- return if $pkg eq ':no_export';
- no strict 'refs';
- foreach my $export (qw(
- type subtype as where
- )) {
- *{"${pkg}::${export}"} = \&{"${export}"};
- }
-
- foreach my $constraint (qw(
- Any
- Value Ref
- Str Int
- ScalarRef ArrayRef HashRef CodeRef RegexpRef
- Object
- )) {
- *{"${pkg}::${constraint}"} = \&{"${constraint}"};
- }
-
+our $VERSION = '0.05';
+
+use Moose::Meta::TypeConstraint;
+use Moose::Meta::TypeCoercion;
+
+{
+ 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;
+{
+ my %TYPES;
+ 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 "
+ if defined $name && exists $TYPES{$name};
+ $parent = find_type_constraint($parent) if defined $parent;
+ my $constraint = Moose::Meta::TypeConstraint->new(
+ name => $name || '__ANON__',
+ parent => $parent,
+ constraint => $check,
+ message => $message,
+ );
+ $TYPES{$name} = [ $pkg_defined_in, $constraint ] if defined $name;
+ return $constraint;
+ }
+
+ sub _install_type_coercions {
+ my ($type_name, $coercion_map) = @_;
+ my $type = find_type_constraint($type_name);
+ (!$type->has_coercion)
+ || confess "The type coercion for '$type_name' has already been registered";
+ my $type_coercion = Moose::Meta::TypeCoercion->new(
+ type_coercion_map => $coercion_map,
+ type_constraint => $type
+ );
+ $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';
+ foreach my $constraint (keys %TYPES) {
+ *{"${pkg}::${constraint}"} = find_type_constraint($constraint)->_compiled_type_constraint;
+ }
+ }
+}
-# might need this later
-#sub find_type_constraint { $TYPES{$_[0]} }
+# type constructors
sub type ($$) {
my ($name, $check) = @_;
- my $pkg = caller();
- my $full_name = "${pkg}::${name}";
- no strict 'refs';
- *{$full_name} = $TYPES{$name} = subname $full_name => sub {
- return $TYPES{$name} unless defined $_[0];
- local $_ = $_[0];
- return undef unless $check->($_[0]);
- $_[0];
- };
+ _create_type_constraint($name, undef, $check);
+}
+
+sub subtype ($$;$$) {
+ unshift @_ => undef if scalar @_ <= 2;
+ _create_type_constraint(@_);
}
-sub subtype ($$;$) {
- my ($name, $parent, $check) = @_;
- if (defined $check) {
- my $pkg = caller();
- my $full_name = "${pkg}::${name}";
- no strict 'refs';
- $parent = $TYPES{$parent} unless $parent && ref($parent) eq 'CODE';
- *{$full_name} = $TYPES{$name} = subname $full_name => sub {
- return $TYPES{$name} unless defined $_[0];
- local $_ = $_[0];
- return undef unless defined $parent->($_[0]) && $check->($_[0]);
- $_[0];
- };
- }
- else {
- ($parent, $check) = ($name, $parent);
- $parent = $TYPES{$parent} unless $parent && ref($parent) eq 'CODE';
- return subname((caller() . '::__anon_subtype__') => sub {
- return $TYPES{$name} unless defined $_[0];
- local $_ = $_[0];
- return undef unless defined $parent->($_[0]) && $check->($_[0]);
- $_[0];
- });
- }
+sub coerce ($@) {
+ my ($type_name, @coercion_map) = @_;
+ _install_type_coercions($type_name, \@coercion_map);
}
-sub as ($) { $_[0] }
-sub where (&) { $_[0] }
+sub as ($) { $_[0] }
+sub from ($) { $_[0] }
+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($_) };
-type Value => where { !ref($_) };
-type Ref => 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 ArrayRef => as Ref => where { ref($_) eq 'ARRAY' };
-subtype HashRef => as Ref => where { ref($_) eq 'HASH' };
-subtype CodeRef => as Ref => where { ref($_) eq 'CODE' };
-subtype RegexpRef => as Ref => where { ref($_) eq 'Regexp' };
+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' };
+subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' };
# NOTE:
# blessed(qr/.../) returns true,.. how odd
-subtype Object => as Ref => where { blessed($_) && blessed($_) ne 'Regexp' };
+subtype 'Object' => as 'Ref' => where { blessed($_) && blessed($_) ne 'Regexp' };
+
+subtype 'Role' => as 'Object' => where { $_->can('does') };
1;
=head1 NAME
-Moose::Util::TypeConstraints -
+Moose::Util::TypeConstraints - Type constraint system for Moose
=head1 SYNOPSIS
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
+This module provides Moose with the ability to create type contraints
+to be are used in both attribute definitions and for method argument
+validation.
+
+=head2 Important Caveat
+
+This is B<NOT> a type system for Perl 5. These are type constraints,
+and they are not used by Moose unless you tell it to. No type
+inference is performed, expression are not typed, etc. etc. etc.
+
+This is simply a means of creating small constraint functions which
+can be used to simplify your own type-checking code.
+
+=head2 Default Type Constraints
+
+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
+ Item
+ Bool
+ Undef
+ Defined
+ Value
+ Num
+ Int
+ Str
+ Ref
+ ScalarRef
+ ArrayRef
+ HashRef
+ CodeRef
+ RegexpRef
+ Object
+ Role
+
+Suggestions for improvement are welcome.
+
=head1 FUNCTIONS
-=head2 Type Constraint Constructors
+=head2 Type Constraint Registry
=over 4
-=item B<type>
+=item B<find_type_constraint ($type_name)>
-=item B<subtype>
+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<as>
+=item B<create_type_constraint_union (@type_constraint_names)>
-=item B<where>
+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
+into the caller's namespace. Right now, this is mostly used for
+testing, but it might prove useful to others.
=back
-=head2 Built-in Type Constraints
+=head2 Type Constraint Constructors
+
+The following functions are used to create type constraints.
+They will then register the type constraints in a global store
+where Moose can get to them if it needs to.
+
+See the L<SYNOPOSIS> for an example of how to use these.
=over 4
-=item B<Any>
+=item B<type ($name, $where_clause)>
-=item B<Value>
+This creates a base type, which has no parent.
-=item B<Int>
+=item B<subtype ($name, $parent, $where_clause, ?$message)>
-=item B<Str>
+This creates a named subtype.
-=item B<Ref>
+=item B<subtype ($parent, $where_clause, ?$message)>
-=item B<ArrayRef>
+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<CodeRef>
+=item B<enum ($name, @values)>
-=item B<HashRef>
+=item B<as>
+
+This is just sugar for the type constraint construction syntax.
-=item B<RegexpRef>
+=item B<where>
-=item B<ScalarRef>
+This is just sugar for the type constraint construction syntax.
-=item B<Object>
+=item B<message>
+
+This is just sugar for the type constraint construction syntax.
+
+=back
+
+=head2 Type Coercion Constructors
+
+Type constraints can also contain type coercions as well. In most
+cases Moose will run the type-coercion code first, followed by the
+type constraint check. This feature should be used carefully as it
+is very powerful and could easily take off a limb if you are not
+careful.
+
+See the L<SYNOPOSIS> for an example of how to use these.
+
+=over 4
+
+=item B<coerce>
+
+=item B<from>
+
+This is just sugar for the type coercion construction syntax.
+
+=item B<via>
+
+This is just sugar for the type coercion construction syntax.
=back
exception. If you find a bug please either email me, or add the bug
to cpan-RT.
-=head1 CODE COVERAGE
-
-I use L<Devel::Cover> to test the code coverage of my tests, below is the
-L<Devel::Cover> report on this module's test suite.
-
-=head1 ACKNOWLEDGEMENTS
-
=head1 AUTHOR
Stevan Little E<lt>stevan@iinteractive.comE<gt>
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
projects / gitmo/Moose.git / blobdiff