package MooX::Types::MooseLike; use strict; use warnings FATAL => 'all'; use Exporter 5.57 'import'; our @EXPORT_OK; push @EXPORT_OK, qw( exception_message inflate_type ); use Module::Runtime qw(require_module); use Carp qw(confess croak); use List::Util qw(first); our $VERSION = '0.29'; sub register_types { my ($type_definitions, $into, $moose_namespace) = @_; foreach my $type_def (@{$type_definitions}) { my $coderefs = make_type($type_def, $moose_namespace); install_type($type_def->{name}, $coderefs, $into); } return; } sub install_type { my ($type_name, $coderefs, $namespace) = @_; my $is_type_name = 'is_' . $type_name; my $type_full_name = $namespace . '::' . $type_name; my $is_type_full_name = $namespace . '::' . $is_type_name; { no strict 'refs'; ## no critic qw(TestingAndDebugging::ProhibitNoStrict) *{$type_full_name} = $coderefs->{type}; *{$is_type_full_name} = $coderefs->{is_type}; push @{"${namespace}::EXPORT_OK"}, $type_name, $is_type_name; } return; } sub make_type { my ($type_definition, $moose_namespace) = @_; my $test = $type_definition->{test}; if (my $subtype_of = $type_definition->{subtype_of}) { if (!ref $subtype_of) { my $from = $type_definition->{from} || croak "Must define a 'from' namespace for the parent type: $subtype_of when defining type: $type_definition->{name}"; $subtype_of = do { no strict 'refs'; &{$from . '::' . $subtype_of}(); }; } # Assume a (base) test always exists even if you must write: test => sub {1} my $base_test = $test; $test = sub { my $value = shift; local $@; eval { $subtype_of->($value); 1 } or return; # TODO implement: eval { $base_test->($value); 1 } paradigm if ($base_test) { $base_test->($value) or return; } return 1; }; } my $isa = sub { return if $test->(@_); local $Carp::Internal{"MooX::Types::MooseLike"} = 1; ## no critic qw(Variables::ProhibitPackageVars) confess $type_definition->{message}->(@_) ; ## no critic qw(ErrorHandling::RequireUseOfExceptions) }; if (ref $type_definition->{inflate}) { $Moo::HandleMoose::TYPE_MAP{$isa} = $type_definition->{inflate}; } elsif (exists $type_definition->{inflate} and not $type_definition->{inflate}) { # no-op } else { my $full_name = defined $moose_namespace ? "${moose_namespace}::" . $type_definition->{name} : $type_definition->{name}; $Moo::HandleMoose::TYPE_MAP{$isa} = sub { require_module($moose_namespace) if $moose_namespace; Moose::Util::TypeConstraints::find_type_constraint($full_name); }; } return { type => sub { # If we have a parameterized type then we want to check its values if (ref($_[0]) eq 'ARRAY') { my @params = @{$_[0]}; my $parameterized_isa = sub { # Types that take other types as a parameter have a parameterizable # part with the one exception: 'AnyOf' if (my $parameterizer = $type_definition->{parameterizable}) { # Can we assume @params is a list of coderefs? if(my $culprit = first { (ref($_) ne 'CODE') } @params) { croak "Expect all parameters to be coderefs, but found: $culprit"; } # Check the containing type. We could pass @_, but it is such that: # scalar @_ = 1 always in this context. In other words, # an $isa only type checks one thing at a time. $isa->($_[0]); # Run the nested type coderefs on each value foreach my $coderef (@params) { foreach my $value ($parameterizer->($_[0])) { $coderef->($value); } } } else { # Note that while $isa only checks on value at a time # We can pass it additional parameters as we do here. # These additional parameters are then used in the type definition # For example, see InstanceOf $isa->($_[0], @params); } }; if (ref $type_definition->{inflate}) { my $inflation = $type_definition->{inflate}; $Moo::HandleMoose::TYPE_MAP{$parameterized_isa} = sub { $inflation->(\@params) }; } # Remove old $isa, but return the rest of the arguments # so any specs defined after 'isa' don't get lost shift; return ($parameterized_isa, @_); } else { return $isa; } }, is_type => sub { $test->(@_) }, }; } sub exception_message { my ($attribute_value, $type) = @_; $attribute_value = defined $attribute_value ? $attribute_value : 'undef'; return "${attribute_value} is not ${type}!"; } sub inflate_type { my $coderef = shift; if (my $inflator = $Moo::HandleMoose::TYPE_MAP{$coderef}) { return $inflator->(); } return Moose::Meta::TypeConstraint->new( constraint => sub { eval { &$coderef; 1 } } ); } 1; __END__ =head1 NAME MooX::Types::MooseLike - some Moosish types and a type builder =head1 SYNOPSIS package MyApp::Types; use MooX::Types::MooseLike; use base qw(Exporter); our @EXPORT_OK = (); # Define some types my $defs = [{ name => 'MyType', test => sub { predicate($_[0]) }, message => sub { "$_[0] is not the type we want!" } }, { name => 'VarChar', test => sub { my ($value, $param) = @_; length($value) <= $param; }, message => sub { "$_[0] is too large! It should be less than or equal to $_[1]." } }]; # Make the types available - this adds them to @EXPORT_OK automatically. MooX::Types::MooseLike::register_types($defs, __PACKAGE__); ... # Somewhere in code that uses the type package MyApp::Foo; use Moo; use MyApp::Types qw(MyType VarChar); has attribute => ( is => 'ro', isa => MyType, ); has string => ( is => 'ro', isa => VarChar[25] ); =head1 DESCRIPTION This module provides a possibility to build your own set of Moose-like types. These custom types can then be used to describe fields in Moo-based classes. See L for a list of available base types. Its source also provides an example of how to build base types, along with both parameterizable and non-parameterizable. =head1 FUNCTIONS =head2 register_types B Install the given types within the package. This makes the types automatically exportable by adding them to @EXPORT_OK of the package. Types are expected to be an array ref where every type is of the following format: { name => 'MyType', test => sub { check_the_value_somehow($_[0]) }, message => sub { "$_[0] is not the type we want!" }, subtype_of => 'SomeParentType', # Optional from => 'Some::Parent::CoolTypes', # Optional parameterizable => sub { ... }, # Optional inflate => sub { ... }, # Optional } A type can be declared with a reference (I) to some previously declared type. In this case the new type will inherit the behaviour of the referenced type. The referenced type can come either from the same package or from a third party package: MooX::Types::MooseLike::register_types([{ name => 'GreaterThan10', subtype_of => 'Int', from => 'MooX::Types::MooseLike::Base', test => sub { $_[0] > 10 }, message => sub { 'not greater than 10' }, }], __PACKAGE__); MooX::Types::MooseLike::register_types([{ name => 'Between10And20', subtype_of => 'GreaterThan10', from => __PACKAGE__, test => sub { $_[0] < 20 }, message => sub { 'not an integer between 10 and 20' }, }], __PACKAGE__); MooX::Types::MooseLike::register_types([{ name => 'Between10And30', subtype_of => GreaterThan10(), test => sub { $_[0] < 30 }, message => sub { 'not an integer between 10 and 30' }, }], __PACKAGE__); =head2 exception_message B Helper function to be used in a type definition: { ... message => sub { return exception_message($_[0], 'a HashRef' }, ... } In the event of mismatching the type constraints it produces the message: " is not a HashRef!" =head2 inflate_type B Inflates the type to a Moose type. Requires Moose. =head1 SEE ALSO L - an example of building subtypes. L - an example of building parameterized types. L, L L - another implementation of type constraints. Compatible with L, L and L. =head1 AUTHOR mateu - Mateu X. Hunter (cpan:MATEU) =head1 CONTRIBUTORS mst - Matt S. Trout (cpan:MSTROUT) Mithaldu - Christian Walde (cpan:MITHALDU) Matt Phillips (cpan:MATTP) Arthur Axel fREW Schmidt (cpan:FREW) Toby Inkster (cpan:TOBYINK) Graham Knop (cpan:HAARG) Dmitry Matrosov (cpan:AMIDOS) =head1 COPYRIGHT Copyright (c) 2011-2015 the MooX::Types::MooseLike L and L as listed above. =head1 LICENSE This library is free software and may be distributed under the same terms as perl itself. =cut