1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
|
package Type::Tiny::ConstrainedObject;
use 5.008001;
use strict;
use warnings;
BEGIN {
$Type::Tiny::ConstrainedObject::AUTHORITY = 'cpan:TOBYINK';
$Type::Tiny::ConstrainedObject::VERSION = '2.002001';
}
$Type::Tiny::ConstrainedObject::VERSION =~ tr/_//d;
sub _croak ($;@) { require Error::TypeTiny; goto \&Error::TypeTiny::croak }
use Type::Tiny ();
our @ISA = 'Type::Tiny';
my %errlabel = (
parent => 'a parent',
constraint => 'a constraint coderef',
inlined => 'an inlining coderef',
);
sub new {
my $proto = shift;
my %opts = ( @_ == 1 ) ? %{ $_[0] } : @_;
for my $key ( qw/ parent constraint inlined / ) {
next unless exists $opts{$key};
_croak(
'%s type constraints cannot have %s passed to the constructor',
$proto->_short_name,
$errlabel{$key},
);
}
$proto->SUPER::new( %opts );
} #/ sub new
sub has_parent {
!!1;
}
sub parent {
require Types::Standard;
Types::Standard::Object();
}
sub _short_name {
die "subclasses must implement this"; # uncoverable statement
}
my $i = 0;
my $_where_expressions = sub {
my $self = shift;
my $name = shift;
$name ||= "where expression check";
my ( %env, @codes );
while ( @_ ) {
my $expr = shift;
my $constraint = shift;
if ( !ref $constraint ) {
push @codes, sprintf( 'do { local $_ = %s; %s }', $expr, $constraint );
}
else {
require Types::Standard;
my $type =
Types::Standard::is_RegexpRef( $constraint )
? Types::Standard::StrMatch()->of( $constraint )
: Types::TypeTiny::to_TypeTiny( $constraint );
if ( $type->can_be_inlined ) {
push @codes,
sprintf(
'do { my $tmp = %s; %s }', $expr,
$type->inline_check( '$tmp' )
);
}
else {
++$i;
$env{ '$chk' . $i } = do { my $chk = $type->compiled_check; \$chk };
push @codes, sprintf( '$chk%d->(%s)', $i, $expr );
}
} #/ else [ if ( !ref $constraint )]
} #/ while ( @_ )
if ( keys %env ) {
# cannot inline
my $sub = Eval::TypeTiny::eval_closure(
source =>
sprintf( 'sub ($) { local $_ = shift; %s }', join( q( and ), @codes ) ),
description => sprintf( '%s for %s', $name, $self->name ),
environment => \%env,
);
return $self->where( $sub );
} #/ if ( keys %env )
else {
return $self->where( join( q( and ), @codes ) );
}
};
sub stringifies_to {
my $self = shift;
my ( $constraint ) = @_;
$self->$_where_expressions( "stringification check", q{"$_"}, $constraint );
}
sub numifies_to {
my $self = shift;
my ( $constraint ) = @_;
$self->$_where_expressions( "numification check", q{0+$_}, $constraint );
}
sub with_attribute_values {
my $self = shift;
my %constraint = @_;
$self->$_where_expressions(
"attributes check",
map { my $attr = $_; qq{\$_->$attr} => $constraint{$attr} }
sort keys %constraint,
);
}
1;
__END__
=pod
=encoding utf-8
=head1 NAME
Type::Tiny::ConstrainedObject - shared behavour for Type::Tiny::Class, etc
=head1 STATUS
This module is considered experiemental.
=head1 DESCRIPTION
=head2 Methods
The following methods exist for L<Type::Tiny::Class>, L<Type::Tiny::Role>,
L<Type::Tiny::Duck>, and any type constraints that inherit from
C<Object> or C<Overload> in L<Types::Standard>.
These methods will also work for L<Type::Tiny::Intersection> if at least
one of the types in the intersection provides these methods.
These methods will also work for L<Type::Tiny::Union> if all of the types
in the union provide these methods.
=over
=item C<< stringifies_to($constraint) >>
Generates a new child type constraint which checks the object's
stringification against a constraint. For example:
my $type = Type::Tiny::Class->new(class => 'URI');
my $child = $type->stringifies_to( StrMatch[qr/^http:/] );
$child->assert_valid( URI->new("http://example.com/") );
In the above example, C<< $child >> is a type constraint that
checks objects are blessed into (or inherit from) the URI class,
and when stringified (e.g. though overloading) the result
matches the regular expression C<< qr/^http:/ >>.
C<< $constraint >> may be a type constraint, something that
can be coerced to a type constraint (such as a coderef returning
a boolean), a string of Perl code operating on C<< $_ >>, or
a reference to a regular expression.
So the following would work:
my $child = $type->stringifies_to( sub { qr/^http:/ } );
my $child = $type->stringifies_to( qr/^http:/ );
my $child = $type->stringifies_to( 'm/^http:/' );
my $child = $type->where('"$_" =~ /^http:/');
=item C<< numifies_to($constraint) >>
The same as C<stringifies_to> but checks numification.
The following might be useful:
use Types::Standard qw(Int Overload);
my $IntLike = Int | Overload->numifies_to(Int)
=item C<< with_attribute_values($attr1 => $constraint1, ...) >>
This is best explained with an example:
use Types::Common qw( InstanceOf StrMatch IntRange );
my $person = InstanceOf['Local::Human'];
my $woman = $person->with_attribute_values(
gender => StrMatch[ qr/^F/i ],
age => IntRange[ 18 => () ],
);
$woman->assert_valid($alice);
This assertion will firstly check that C<< $alice >> is a
Local::Human, then check that C<< $alice->gender >> starts
with an "F", and lastly check that C<< $alice->age >> is
an integer at least 18.
Again, constraints can be type constraints, coderefs,
strings of Perl code, or regular expressions.
Technically the "attributes" don't need to be Moo/Moose/Mouse
attributes, but any methods which can be called with no
parameters and return a scalar.
=back
=head1 BUGS
Please report any bugs to
L<https://github.com/tobyink/p5-type-tiny/issues>.
=head1 SEE ALSO
L<Type::Tiny::Manual>.
L<Type::Tiny>.
=head1 AUTHOR
Toby Inkster E<lt>tobyink@cpan.orgE<gt>.
=head1 COPYRIGHT AND LICENCE
This software is copyright (c) 2019-2023 by Toby Inkster.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 DISCLAIMER OF WARRANTIES
THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
|