use warnings;
use Carp 'confess';
-use Sub::Name 'subname';
use Scalar::Util 'blessed';
+use B 'svref_2object';
+use Sub::Exporter;
-our $VERSION = '0.02';
+our $VERSION = '0.10';
use Moose::Meta::TypeConstraint;
-
-sub import {
- shift;
- my $pkg = shift || caller();
- return if $pkg eq ':no_export';
- no strict 'refs';
- foreach my $export (qw(type subtype as where coerce from via)) {
- *{"${pkg}::${export}"} = \&{"${export}"};
- }
+use Moose::Meta::TypeCoercion;
+
+my @exports = qw/
+ type subtype as where message optimize_as
+ coerce from via
+ enum
+ find_type_constraint
+/;
+
+Sub::Exporter::setup_exporter({
+ exports => \@exports,
+ groups => { default => [':all'] }
+});
+
+sub unimport {
+ no strict 'refs';
+ my $class = caller();
+ # loop through the exports ...
+ foreach my $name (@exports) {
+ # if we find one ...
+ if (defined &{$class . '::' . $name}) {
+ my $keyword = \&{$class . '::' . $name};
+
+ # make sure it is from Moose
+ my $pkg_name = eval { svref_2object($keyword)->GV->STASH->NAME };
+ next if $@;
+ next if $pkg_name ne 'Moose::Util::TypeConstraints';
+
+ # and if it is from Moose then undef the slot
+ delete ${$class . '::'}{$name};
+ }
+ }
}
{
my %TYPES;
- sub find_type_constraint { $TYPES{$_[0]} }
-
- sub create_type_constraint {
- my ($name, $parent, $constraint) = @_;
- (not exists $TYPES{$name})
- || confess "The type constraint '$name' has already been created";
+ 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 = shift;
+ my $parent = shift;
+ my $check = shift;;
+
+ my ($message, $optimized);
+ for (@_) {
+ $message = $_->{message} if exists $_->{message};
+ $optimized = $_->{optimized} if exists $_->{optimized};
+ }
+
+ 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;
- $TYPES{$name} = Moose::Meta::TypeConstraint->new(
- name => $name,
+ my $constraint = Moose::Meta::TypeConstraint->new(
+ name => $name || '__ANON__',
parent => $parent,
- constraint => $constraint,
+ constraint => $check,
+ message => $message,
+ optimized => $optimized,
);
+ $TYPES{$name} = [ $pkg_defined_in, $constraint ] if defined $name;
+ return $constraint;
}
- sub find_type_coercion {
- my $type_name = shift;
- $TYPES{$type_name}->coercion_code;
- }
-
- sub register_type_coercion {
- my ($type_name, $type_coercion) = @_;
- my $type = $TYPES{$type_name};
+ 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";
- $type->set_coercion_code($type_coercion);
+ 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}"} = $TYPES{$constraint}->constraint_code;
+ *{"${pkg}::${constraint}"} = find_type_constraint($constraint)->_compiled_type_constraint;
}
}
}
+# type constructors
sub type ($$) {
my ($name, $check) = @_;
- create_type_constraint($name, undef, $check);
+ _create_type_constraint($name, undef, $check);
}
-sub subtype ($$;$) {
- if (scalar @_ == 3) {
- my ($name, $parent, $check) = @_;
- create_type_constraint($name, $parent, $check);
- }
- else {
- my ($parent, $check) = @_;
- $parent = find_type_constraint($parent);
- return Moose::Meta::TypeConstraint->new(
- name => '__ANON__',
- parent => $parent,
- constraint => $check,
- );
- }
+sub subtype ($$;$$$) {
+ unshift @_ => undef if scalar @_ <= 2;
+ goto &_create_type_constraint;
}
sub coerce ($@) {
my ($type_name, @coercion_map) = @_;
- my @coercions;
- while (@coercion_map) {
- my ($constraint_name, $action) = splice(@coercion_map, 0, 2);
- my $constraint = find_type_constraint($constraint_name)->constraint_code;
- (defined $constraint)
- || confess "Could not find the type constraint ($constraint_name)";
- push @coercions => [ $constraint, $action ];
- }
- register_type_coercion($type_name, sub {
- my $thing = shift;
- foreach my $coercion (@coercions) {
- my ($constraint, $converter) = @$coercion;
- if (defined $constraint->($thing)) {
- local $_ = $thing;
- return $converter->($thing);
- }
- }
- return $thing;
- });
+ _install_type_coercions($type_name, \@coercion_map);
}
-sub as ($) { $_[0] }
-sub from ($) { $_[0] }
-sub where (&) { $_[0] }
-sub via (&) { $_[0] }
+sub as ($) { $_[0] }
+sub from ($) { $_[0] }
+sub where (&) { $_[0] }
+sub via (&) { $_[0] }
+
+sub message (&) { +{ message => $_[0] } }
+sub optimize_as (&) { +{ optimized => $_[0] } }
+
+sub enum ($;@) {
+ my ($type_name, @values) = @_;
+ (scalar @values >= 2)
+ || confess "You must have at least two values to enumerate through";
+ 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
-type Value => where { !ref($_) };
-type Ref => where { ref($_) };
+subtype 'Undef' => as 'Item' => where { !defined($_) };
+subtype 'Defined' => as 'Item' => where { defined($_) };
-subtype Int => as Value => where { Scalar::Util::looks_like_number($_) };
-subtype Str => as Value => where { !Scalar::Util::looks_like_number($_) };
+subtype 'Bool'
+ => as 'Item'
+ => where { !defined($_) || $_ eq "" || "$_" eq '1' || "$_" eq '0' };
-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 'Value'
+ => as 'Defined'
+ => where { !ref($_) }
+ => optimize_as { defined($_[0]) && !ref($_[0]) };
+
+subtype 'Ref'
+ => as 'Defined'
+ => where { ref($_) }
+ => optimize_as { ref($_[0]) };
+
+subtype 'Str'
+ => as 'Value'
+ => where { 1 }
+ => optimize_as { defined($_[0]) && !ref($_[0]) };
+
+subtype 'Num'
+ => as 'Value'
+ => where { Scalar::Util::looks_like_number($_) }
+ => optimize_as { !ref($_[0]) && Scalar::Util::looks_like_number($_[0]) };
+
+subtype 'Int'
+ => as 'Num'
+ => where { "$_" =~ /^-?[0-9]+$/ }
+ => optimize_as { defined($_[0]) && !ref($_[0]) && $_[0] =~ /^-?[0-9]+$/ };
+
+subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } => optimize_as { ref($_[0]) eq 'SCALAR' };
+subtype 'ArrayRef' => as 'Ref' => where { ref($_) eq 'ARRAY' } => optimize_as { ref($_[0]) eq 'ARRAY' };
+subtype 'HashRef' => as 'Ref' => where { ref($_) eq 'HASH' } => optimize_as { ref($_[0]) eq 'HASH' };
+subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } => optimize_as { ref($_[0]) eq 'CODE' };
+subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } => optimize_as { ref($_[0]) eq 'Regexp' };
+subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } => optimize_as { ref($_[0]) eq 'GLOB' };
+
+# NOTE:
+# scalar filehandles are GLOB refs,
+# but a GLOB ref is not always a filehandle
+subtype 'FileHandle'
+ => as 'GlobRef'
+ => where { Scalar::Util::openhandle($_) }
+ => optimize_as { ref($_[0]) eq 'GLOB' && Scalar::Util::openhandle($_[0]) };
# 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' }
+ => optimize_as { blessed($_[0]) && blessed($_[0]) ne 'Regexp' };
+
+subtype 'Role'
+ => as 'Object'
+ => where { $_->can('does') }
+ => optimize_as { blessed($_[0]) && $_[0]->can('does') };
1;
use Moose::Util::TypeConstraints;
- type Num => where { Scalar::Util::looks_like_number($_) };
+ type 'Num' => where { Scalar::Util::looks_like_number($_) };
- subtype Natural
- => as Num
+ subtype 'Natural'
+ => as 'Num'
=> where { $_ > 0 };
- subtype NaturalLessThanTen
- => as Natural
- => where { $_ < 10 };
+ subtype 'NaturalLessThanTen'
+ => as 'Natural'
+ => where { $_ < 10 }
+ => message { "This number ($_) is not less than ten!" };
- coerce Num
- => from Str
+ coerce 'Num'
+ => from 'Str'
=> via { 0+$_ };
+
+ enum 'RGBColors' => qw(red green blue);
=head1 DESCRIPTION
to be are used in both attribute definitions and for method argument
validation.
-This is B<NOT> a type system for Perl 5.
+=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 Slightly Less Important Caveat
+
+It is almost always a good idea to quote your type and subtype names.
+This is to prevent perl from trying to execute the call as an indirect
+object call. This issue only seems to come up when you have a subtype
+the same name as a valid class, but when the issue does arise it tends
+to be quite annoying to debug.
+
+So for instance, this:
+
+ subtype DateTime => as Object => where { $_->isa('DateTime') };
+
+will I<Just Work>, while this:
+
+ use DateTime;
+ subtype DateTime => as Object => where { $_->isa('DateTime') };
+
+will fail silently and cause many headaches. The simple way to solve
+this, as well as future proof your subtypes from classes which have
+yet to have been created yet, is to simply do this:
+
+ use DateTime;
+ subtype 'DateTime' => as Object => where { $_->isa('DateTime') };
+
+=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
- Value
- Int
- Str
- Ref
- ScalarRef
- ArrayRef
- HashRef
- CodeRef
- RegexpRef
- Object
-
-Suggestions for improvement are welcome.
+ Item
+ Bool
+ Undef
+ Defined
+ Value
+ Num
+ Int
+ Str
+ Ref
+ ScalarRef
+ ArrayRef
+ HashRef
+ CodeRef
+ RegexpRef
+ GlobRef
+ FileHandle
+ Object
+ Role
+
+Suggestions for improvement are welcome.
+
+B<NOTE:> The C<Undef> type constraint does not work correctly
+in every occasion, please use it sparringly.
=head1 FUNCTIONS
=item B<find_type_constraint ($type_name)>
-=item B<create_type_constraint ($type_name, $type_constraint)>
+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<find_type_coercion>
+=item B<create_type_constraint_union (@type_constraint_names)>
-=item B<register_type_coercion>
+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>
-=item B<dump_type_constraints>
+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 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<type>
+=item B<type ($name, $where_clause)>
+
+This creates a base type, which has no parent.
+
+=item B<subtype ($name, $parent, $where_clause, ?$message)>
+
+This creates a named subtype.
+
+=item B<subtype ($parent, $where_clause, ?$message)>
+
+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<enum ($name, @values)>
+
+This will create a basic subtype for a given set of strings.
+The resulting constraint will be a subtype of C<Str> and
+will match any of the items in C<@values>. See the L<SYNOPSIS>
+for a simple example.
-=item B<subtype>
+B<NOTE:> This is not a true proper enum type, it is simple
+a convient constraint builder.
=item B<as>
+This is just sugar for the type constraint construction syntax.
+
=item B<where>
-=item B<coerce>
+This is just sugar for the type constraint construction syntax.
-=item B<from>
+=item B<message>
-=item B<via>
+This is just sugar for the type constraint construction syntax.
+
+=item B<optimize_as>
=back
-=head2 Built-in Type Constraints
+=head2 Type Coercion Constructors
-=over 4
+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.
-=item B<Any>
+See the L<SYNOPOSIS> for an example of how to use these.
-=item B<Value>
+=over 4
-=item B<Int>
+=item B<coerce>
+
+=item B<from>
-=item B<Str>
+This is just sugar for the type coercion construction syntax.
-=item B<Ref>
+=item B<via>
-=item B<ArrayRef>
+This is just sugar for the type coercion construction syntax.
-=item B<CodeRef>
+=back
-=item B<HashRef>
+=head2 Namespace Management
-=item B<RegexpRef>
+=over 4
-=item B<ScalarRef>
+=item B<unimport>
-=item B<Object>
+This will remove all the type constraint keywords from the
+calling class namespace.
=back
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