/
TypeConstraints.pm
1370 lines (1057 loc) · 40.6 KB
/
TypeConstraints.pm
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Moose::Util::TypeConstraints;
use Carp ();
use List::MoreUtils qw( all any );
use Scalar::Util qw( blessed reftype );
use Moose::Exporter;
our $VERSION = '0.92';
$VERSION = eval $VERSION;
our $AUTHORITY = 'cpan:STEVAN';
## --------------------------------------------------------
# Prototyped subs must be predeclared because we have a
# circular dependency with Moose::Meta::Attribute et. al.
# so in case of us being use'd first the predeclaration
# ensures the prototypes are in scope when consumers are
# compiled.
# dah sugah!
sub where (&);
sub via (&);
sub message (&);
sub optimize_as (&);
## --------------------------------------------------------
use Moose::Meta::TypeConstraint;
use Moose::Meta::TypeConstraint::Union;
use Moose::Meta::TypeConstraint::Parameterized;
use Moose::Meta::TypeConstraint::Parameterizable;
use Moose::Meta::TypeConstraint::Class;
use Moose::Meta::TypeConstraint::Role;
use Moose::Meta::TypeConstraint::Enum;
use Moose::Meta::TypeConstraint::DuckType;
use Moose::Meta::TypeCoercion;
use Moose::Meta::TypeCoercion::Union;
use Moose::Meta::TypeConstraint::Registry;
use Moose::Util::TypeConstraints::OptimizedConstraints;
Moose::Exporter->setup_import_methods(
as_is => [
qw(
type subtype class_type role_type maybe_type duck_type
as where message optimize_as
coerce from via
enum
find_type_constraint
register_type_constraint
match_on_type )
],
_export_to_main => 1,
);
## --------------------------------------------------------
## type registry and some useful functions for it
## --------------------------------------------------------
my $REGISTRY = Moose::Meta::TypeConstraint::Registry->new;
sub get_type_constraint_registry {$REGISTRY}
sub list_all_type_constraints { keys %{ $REGISTRY->type_constraints } }
sub export_type_constraints_as_functions {
my $pkg = caller();
no strict 'refs';
foreach my $constraint ( keys %{ $REGISTRY->type_constraints } ) {
my $tc = $REGISTRY->get_type_constraint($constraint)
->_compiled_type_constraint;
*{"${pkg}::${constraint}"}
= sub { $tc->( $_[0] ) ? 1 : undef }; # the undef is for compat
}
}
sub create_type_constraint_union {
my @type_constraint_names;
if ( scalar @_ == 1 && _detect_type_constraint_union( $_[0] ) ) {
@type_constraint_names = _parse_type_constraint_union( $_[0] );
}
else {
@type_constraint_names = @_;
}
( scalar @type_constraint_names >= 2 )
|| __PACKAGE__->_throw_error(
"You must pass in at least 2 type names to make a union");
my @type_constraints = map {
find_or_parse_type_constraint($_)
|| __PACKAGE__->_throw_error(
"Could not locate type constraint ($_) for the union");
} @type_constraint_names;
return Moose::Meta::TypeConstraint::Union->new(
type_constraints => \@type_constraints );
}
sub create_parameterized_type_constraint {
my $type_constraint_name = shift;
my ( $base_type, $type_parameter )
= _parse_parameterized_type_constraint($type_constraint_name);
( defined $base_type && defined $type_parameter )
|| __PACKAGE__->_throw_error(
"Could not parse type name ($type_constraint_name) correctly");
if ( $REGISTRY->has_type_constraint($base_type) ) {
my $base_type_tc = $REGISTRY->get_type_constraint($base_type);
return _create_parameterized_type_constraint(
$base_type_tc,
$type_parameter
);
}
else {
__PACKAGE__->_throw_error(
"Could not locate the base type ($base_type)");
}
}
sub _create_parameterized_type_constraint {
my ( $base_type_tc, $type_parameter ) = @_;
if ( $base_type_tc->can('parameterize') ) {
return $base_type_tc->parameterize($type_parameter);
}
else {
return Moose::Meta::TypeConstraint::Parameterized->new(
name => $base_type_tc->name . '[' . $type_parameter . ']',
parent => $base_type_tc,
type_parameter =>
find_or_create_isa_type_constraint($type_parameter),
);
}
}
#should we also support optimized checks?
sub create_class_type_constraint {
my ( $class, $options ) = @_;
# too early for this check
#find_type_constraint("ClassName")->check($class)
# || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
my %options = (
class => $class,
name => $class,
%{ $options || {} },
);
$options{name} ||= "__ANON__";
Moose::Meta::TypeConstraint::Class->new(%options);
}
sub create_role_type_constraint {
my ( $role, $options ) = @_;
# too early for this check
#find_type_constraint("ClassName")->check($class)
# || __PACKAGE__->_throw_error("Can't create a class type constraint because '$class' is not a class name");
my %options = (
role => $role,
name => $role,
%{ $options || {} },
);
$options{name} ||= "__ANON__";
Moose::Meta::TypeConstraint::Role->new(%options);
}
sub find_or_create_type_constraint {
my ( $type_constraint_name, $options_for_anon_type ) = @_;
if ( my $constraint
= find_or_parse_type_constraint($type_constraint_name) ) {
return $constraint;
}
elsif ( defined $options_for_anon_type ) {
# NOTE:
# if there is no $options_for_anon_type
# specified, then we assume they don't
# want to create one, and return nothing.
# otherwise assume that we should create
# an ANON type with the $options_for_anon_type
# options which can be passed in. It should
# be noted that these don't get registered
# so we need to return it.
# - SL
return Moose::Meta::TypeConstraint->new(
name => '__ANON__',
%{$options_for_anon_type}
);
}
return;
}
sub find_or_create_isa_type_constraint {
my $type_constraint_name = shift;
find_or_parse_type_constraint($type_constraint_name)
|| create_class_type_constraint($type_constraint_name);
}
sub find_or_create_does_type_constraint {
my $type_constraint_name = shift;
find_or_parse_type_constraint($type_constraint_name)
|| create_role_type_constraint($type_constraint_name);
}
sub find_or_parse_type_constraint {
my $type_constraint_name = normalize_type_constraint_name(shift);
my $constraint;
if ( $constraint = find_type_constraint($type_constraint_name) ) {
return $constraint;
}
elsif ( _detect_type_constraint_union($type_constraint_name) ) {
$constraint = create_type_constraint_union($type_constraint_name);
}
elsif ( _detect_parameterized_type_constraint($type_constraint_name) ) {
$constraint
= create_parameterized_type_constraint($type_constraint_name);
}
else {
return;
}
$REGISTRY->add_type_constraint($constraint);
return $constraint;
}
sub normalize_type_constraint_name {
my $type_constraint_name = shift;
$type_constraint_name =~ s/\s//g;
return $type_constraint_name;
}
sub _confess {
my $error = shift;
local $Carp::CarpLevel = $Carp::CarpLevel + 1;
Carp::confess($error);
}
## --------------------------------------------------------
## exported functions ...
## --------------------------------------------------------
sub find_type_constraint {
my $type = shift;
if ( blessed $type and $type->isa("Moose::Meta::TypeConstraint") ) {
return $type;
}
else {
return unless $REGISTRY->has_type_constraint($type);
return $REGISTRY->get_type_constraint($type);
}
}
sub register_type_constraint {
my $constraint = shift;
__PACKAGE__->_throw_error("can't register an unnamed type constraint")
unless defined $constraint->name;
$REGISTRY->add_type_constraint($constraint);
return $constraint;
}
# type constructors
sub type {
# back-compat version, called without sugar
if ( !any { ( reftype($_) || '' ) eq 'HASH' } @_ ) {
return _create_type_constraint( $_[0], undef, $_[1] );
}
my $name = shift;
my %p = map { %{$_} } @_;
return _create_type_constraint(
$name, undef, $p{where}, $p{message},
$p{optimize_as}
);
}
sub subtype {
# crazy back-compat code for being called without sugar ...
#
# subtype 'Parent', sub { where };
if ( scalar @_ == 2 && ( reftype( $_[1] ) || '' ) eq 'CODE' ) {
return _create_type_constraint( undef, @_ );
}
# subtype 'Parent', sub { where }, sub { message };
# subtype 'Parent', sub { where }, sub { message }, sub { optimized };
if ( scalar @_ >= 3 && all { ( reftype($_) || '' ) eq 'CODE' }
@_[ 1 .. $#_ ] ) {
return _create_type_constraint( undef, @_ );
}
# subtype 'Name', 'Parent', ...
if ( scalar @_ >= 2 && all { !ref } @_[ 0, 1 ] ) {
return _create_type_constraint(@_);
}
if ( @_ == 1 && !ref $_[0] ) {
__PACKAGE__->_throw_error(
'A subtype cannot consist solely of a name, it must have a parent'
);
}
# The blessed check is mostly to accommodate MooseX::Types, which
# uses an object which overloads stringification as a type name.
my $name = ref $_[0] && !blessed $_[0] ? undef : shift;
my %p = map { %{$_} } @_;
# subtype Str => where { ... };
if ( !exists $p{as} ) {
$p{as} = $name;
$name = undef;
}
return _create_type_constraint(
$name, $p{as}, $p{where}, $p{message},
$p{optimize_as}
);
}
sub class_type {
register_type_constraint(
create_class_type_constraint(
$_[0],
( defined( $_[1] ) ? $_[1] : () ),
)
);
}
sub role_type ($;$) {
register_type_constraint(
create_role_type_constraint(
$_[0],
( defined( $_[1] ) ? $_[1] : () ),
)
);
}
sub maybe_type {
my ($type_parameter) = @_;
register_type_constraint(
$REGISTRY->get_type_constraint('Maybe')->parameterize($type_parameter)
);
}
sub duck_type {
my ( $type_name, @methods ) = @_;
if ( ref $type_name eq 'ARRAY' && !@methods ) {
@methods = @$type_name;
$type_name = undef;
}
register_type_constraint(
create_duck_type_constraint(
$type_name,
\@methods,
)
);
}
sub coerce {
my ( $type_name, @coercion_map ) = @_;
_install_type_coercions( $type_name, \@coercion_map );
}
# The trick of returning @_ lets us avoid having to specify a
# prototype. Perl will parse this:
#
# subtype 'Foo'
# => as 'Str'
# => where { ... }
#
# as this:
#
# subtype( 'Foo', as( 'Str', where { ... } ) );
#
# If as() returns all it's extra arguments, this just works, and
# preserves backwards compatibility.
sub as { { as => shift }, @_ }
sub where (&) { { where => $_[0] } }
sub message (&) { { message => $_[0] } }
sub optimize_as (&) { { optimize_as => $_[0] } }
sub from {@_}
sub via (&) { $_[0] }
sub enum {
my ( $type_name, @values ) = @_;
# NOTE:
# if only an array-ref is passed then
# you get an anon-enum
# - SL
if ( ref $type_name eq 'ARRAY' && !@values ) {
@values = @$type_name;
$type_name = undef;
}
( scalar @values >= 2 )
|| __PACKAGE__->_throw_error(
"You must have at least two values to enumerate through");
my %valid = map { $_ => 1 } @values;
register_type_constraint(
create_enum_type_constraint(
$type_name,
\@values,
)
);
}
sub create_enum_type_constraint {
my ( $type_name, $values ) = @_;
Moose::Meta::TypeConstraint::Enum->new(
name => $type_name || '__ANON__',
values => $values,
);
}
sub create_duck_type_constraint {
my ( $type_name, $methods ) = @_;
Moose::Meta::TypeConstraint::DuckType->new(
name => $type_name || '__ANON__',
methods => $methods,
);
}
sub match_on_type {
my ($to_match, @cases) = @_;
my $default;
if (@cases % 2 != 0) {
$default = pop @cases;
(ref $default eq 'CODE')
|| __PACKAGE__->_throw_error("Default case must be a CODE ref, not $default");
}
while (@cases) {
my ($type, $action) = splice @cases, 0, 2;
unless (blessed $type && $type->isa('Moose::Meta::TypeConstraint')) {
$type = find_or_parse_type_constraint($type)
|| __PACKAGE__->_throw_error("Cannot find or parse the type '$type'")
}
(ref $action eq 'CODE')
|| __PACKAGE__->_throw_error("Match action must be a CODE ref, not $action");
if ($type->check($to_match)) {
local $_ = $to_match;
return $action->($to_match);
}
}
(defined $default)
|| __PACKAGE__->_throw_error("No cases matched for $to_match");
{
local $_ = $to_match;
return $default->($to_match);
}
}
## --------------------------------------------------------
## desugaring functions ...
## --------------------------------------------------------
sub _create_type_constraint ($$$;$$) {
my $name = shift;
my $parent = shift;
my $check = shift;
my $message = shift;
my $optimized = shift;
my $pkg_defined_in = scalar( caller(1) );
if ( defined $name ) {
my $type = $REGISTRY->get_type_constraint($name);
( $type->_package_defined_in eq $pkg_defined_in )
|| _confess(
"The type constraint '$name' has already been created in "
. $type->_package_defined_in
. " and cannot be created again in "
. $pkg_defined_in )
if defined $type;
$name =~ /^[\w:\.]+$/
or die qq{$name contains invalid characters for a type name.}
. qq{ Names can contain alphanumeric character, ":", and "."\n};
}
my %opts = (
name => $name,
package_defined_in => $pkg_defined_in,
( $check ? ( constraint => $check ) : () ),
( $message ? ( message => $message ) : () ),
( $optimized ? ( optimized => $optimized ) : () ),
);
my $constraint;
if (
defined $parent
and $parent
= blessed $parent
? $parent
: find_or_create_isa_type_constraint($parent)
) {
$constraint = $parent->create_child_type(%opts);
}
else {
$constraint = Moose::Meta::TypeConstraint->new(%opts);
}
$REGISTRY->add_type_constraint($constraint)
if defined $name;
return $constraint;
}
sub _install_type_coercions ($$) {
my ( $type_name, $coercion_map ) = @_;
my $type = find_type_constraint($type_name);
( defined $type )
|| __PACKAGE__->_throw_error(
"Cannot find type '$type_name', perhaps you forgot to load it");
if ( $type->has_coercion ) {
$type->coercion->add_type_coercions(@$coercion_map);
}
else {
my $type_coercion = Moose::Meta::TypeCoercion->new(
type_coercion_map => $coercion_map,
type_constraint => $type
);
$type->coercion($type_coercion);
}
}
## --------------------------------------------------------
## type notation parsing ...
## --------------------------------------------------------
{
# All I have to say is mugwump++ cause I know
# do not even have enough regexp-fu to be able
# to have written this (I can only barely
# understand it as it is)
# - SL
use re "eval";
my $valid_chars = qr{[\w:\.]};
my $type_atom = qr{ $valid_chars+ };
my $any;
my $type = qr{ $valid_chars+ (?: \[ \s* (??{$any}) \s* \] )? }x;
my $type_capture_parts
= qr{ ($valid_chars+) (?: \[ \s* ((??{$any})) \s* \] )? }x;
my $type_with_parameter
= qr{ $valid_chars+ \[ \s* (??{$any}) \s* \] }x;
my $op_union = qr{ \s* \| \s* }x;
my $union = qr{ $type (?: $op_union $type )+ }x;
$any = qr{ $type | $union }x;
sub _parse_parameterized_type_constraint {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{ $type_capture_parts }x;
return ( $1, $2 );
}
sub _detect_parameterized_type_constraint {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{ ^ $type_with_parameter $ }x;
}
sub _parse_type_constraint_union {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
my $given = shift;
my @rv;
while ( $given =~ m{ \G (?: $op_union )? ($type) }gcx ) {
push @rv => $1;
}
( pos($given) eq length($given) )
|| __PACKAGE__->_throw_error( "'$given' didn't parse (parse-pos="
. pos($given)
. " and str-length="
. length($given)
. ")" );
@rv;
}
sub _detect_type_constraint_union {
{ no warnings 'void'; $any; } # force capture of interpolated lexical
$_[0] =~ m{^ $type $op_union $type ( $op_union .* )? $}x;
}
}
## --------------------------------------------------------
# define some basic built-in types
## --------------------------------------------------------
# By making these classes immutable before creating all the types we
# below, we avoid repeatedly calling the slow MOP-based accessors.
$_->make_immutable(
inline_constructor => 1,
constructor_name => "_new",
# these are Class::MOP accessors, so they need inlining
inline_accessors => 1
) for grep { $_->is_mutable }
map { Class::MOP::class_of($_) }
qw(
Moose::Meta::TypeConstraint
Moose::Meta::TypeConstraint::Union
Moose::Meta::TypeConstraint::Parameterized
Moose::Meta::TypeConstraint::Parameterizable
Moose::Meta::TypeConstraint::Class
Moose::Meta::TypeConstraint::Role
Moose::Meta::TypeConstraint::Enum
Moose::Meta::TypeConstraint::DuckType
Moose::Meta::TypeConstraint::Registry
);
type 'Any' => where {1}; # meta-type including all
subtype 'Item' => as 'Any'; # 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($_) } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Value;
subtype 'Ref' => as 'Defined' => where { ref($_) } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Ref;
subtype 'Str' => as 'Value' => where {1} =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Str;
subtype 'Num' => as 'Str' =>
where { Scalar::Util::looks_like_number($_) } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Num;
subtype 'Int' => as 'Num' => where { "$_" =~ /^-?[0-9]+$/ } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Int;
subtype 'ScalarRef' => as 'Ref' => where { ref($_) eq 'SCALAR' } =>
optimize_as
\&Moose::Util::TypeConstraints::OptimizedConstraints::ScalarRef;
subtype 'CodeRef' => as 'Ref' => where { ref($_) eq 'CODE' } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::CodeRef;
subtype 'RegexpRef' => as 'Ref' => where { ref($_) eq 'Regexp' } =>
optimize_as
\&Moose::Util::TypeConstraints::OptimizedConstraints::RegexpRef;
subtype 'GlobRef' => as 'Ref' => where { ref($_) eq 'GLOB' } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::GlobRef;
# NOTE:
# scalar filehandles are GLOB refs,
# but a GLOB ref is not always a filehandle
subtype 'FileHandle' => as 'GlobRef' => where {
Scalar::Util::openhandle($_) || ( blessed($_) && $_->isa("IO::Handle") );
} => optimize_as
\&Moose::Util::TypeConstraints::OptimizedConstraints::FileHandle;
# NOTE:
# blessed(qr/.../) returns true,.. how odd
subtype 'Object' => as 'Ref' =>
where { blessed($_) && blessed($_) ne 'Regexp' } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Object;
# This type is deprecated.
subtype 'Role' => as 'Object' => where { $_->can('does') } =>
optimize_as \&Moose::Util::TypeConstraints::OptimizedConstraints::Role;
my $_class_name_checker = sub { };
subtype 'ClassName' => as 'Str' =>
where { Class::MOP::is_class_loaded($_) } => optimize_as
\&Moose::Util::TypeConstraints::OptimizedConstraints::ClassName;
subtype 'RoleName' => as 'ClassName' => where {
(Class::MOP::class_of($_) || return)->isa('Moose::Meta::Role');
} => optimize_as
\&Moose::Util::TypeConstraints::OptimizedConstraints::RoleName;
## --------------------------------------------------------
# parameterizable types ...
$REGISTRY->add_type_constraint(
Moose::Meta::TypeConstraint::Parameterizable->new(
name => 'ArrayRef',
package_defined_in => __PACKAGE__,
parent => find_type_constraint('Ref'),
constraint => sub { ref($_) eq 'ARRAY' },
optimized =>
\&Moose::Util::TypeConstraints::OptimizedConstraints::ArrayRef,
constraint_generator => sub {
my $type_parameter = shift;
my $check = $type_parameter->_compiled_type_constraint;
return sub {
foreach my $x (@$_) {
( $check->($x) ) || return;
}
1;
}
}
)
);
$REGISTRY->add_type_constraint(
Moose::Meta::TypeConstraint::Parameterizable->new(
name => 'HashRef',
package_defined_in => __PACKAGE__,
parent => find_type_constraint('Ref'),
constraint => sub { ref($_) eq 'HASH' },
optimized =>
\&Moose::Util::TypeConstraints::OptimizedConstraints::HashRef,
constraint_generator => sub {
my $type_parameter = shift;
my $check = $type_parameter->_compiled_type_constraint;
return sub {
foreach my $x ( values %$_ ) {
( $check->($x) ) || return;
}
1;
}
}
)
);
$REGISTRY->add_type_constraint(
Moose::Meta::TypeConstraint::Parameterizable->new(
name => 'Maybe',
package_defined_in => __PACKAGE__,
parent => find_type_constraint('Item'),
constraint => sub {1},
constraint_generator => sub {
my $type_parameter = shift;
my $check = $type_parameter->_compiled_type_constraint;
return sub {
return 1 if not( defined($_) ) || $check->($_);
return;
}
}
)
);
my @PARAMETERIZABLE_TYPES
= map { $REGISTRY->get_type_constraint($_) } qw[ArrayRef HashRef Maybe];
sub get_all_parameterizable_types {@PARAMETERIZABLE_TYPES}
sub add_parameterizable_type {
my $type = shift;
( blessed $type
&& $type->isa('Moose::Meta::TypeConstraint::Parameterizable') )
|| __PACKAGE__->_throw_error(
"Type must be a Moose::Meta::TypeConstraint::Parameterizable not $type"
);
push @PARAMETERIZABLE_TYPES => $type;
}
## --------------------------------------------------------
# end of built-in types ...
## --------------------------------------------------------
{
my @BUILTINS = list_all_type_constraints();
sub list_all_builtin_type_constraints {@BUILTINS}
}
sub _throw_error {
shift;
require Moose;
unshift @_, 'Moose';
goto &Moose::throw_error;
}
1;
__END__
=pod
=head1 NAME
Moose::Util::TypeConstraints - Type constraint system for Moose
=head1 SYNOPSIS
use Moose::Util::TypeConstraints;
subtype 'Natural'
=> as 'Int'
=> where { $_ > 0 };
subtype 'NaturalLessThanTen'
=> as 'Natural'
=> where { $_ < 10 }
=> message { "This number ($_) is not less than ten!" };
coerce 'Num'
=> from 'Str'
=> via { 0+$_ };
enum 'RGBColors' => qw(red green blue);
no Moose::Util::TypeConstraints;
=head1 DESCRIPTION
This module provides Moose with the ability to create custom type
constraints to be used in attribute definition.
=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, expressions are not typed, etc. etc. etc.
A type constraint is at heart a small "check if a value is valid"
function. A constraint can be associated with an attribute. This
simplifies parameter validation, and makes your code clearer to read,
because you can refer to constraints by name.
=head2 Slightly Less Important Caveat
It is B<always> a good idea to quote your type names.
This prevents Perl from trying to execute the call as an indirect
object call. This can be an issue when you have a subtype with the
same name as a valid class.
For instance:
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, is to quote the type name:
use DateTime;
subtype 'DateTime' => as 'Object' => where { $_->isa('DateTime') };
=head2 Default Type Constraints
This module also provides a simple hierarchy for Perl 5 types, here is
that hierarchy represented visually.
Any
Item
Bool
Maybe[`a]
Undef
Defined
Value
Num
Int
Str
ClassName
RoleName
Ref
ScalarRef
ArrayRef[`a]
HashRef[`a]
CodeRef
RegexpRef
GlobRef
FileHandle
Object
B<NOTE:> Any type followed by a type parameter C<[`a]> can be
parameterized, this means you can say:
ArrayRef[Int] # an array of integers
HashRef[CodeRef] # a hash of str to CODE ref mappings
Maybe[Str] # value may be a string, may be undefined
If Moose finds a name in brackets that it does not recognize as an
existing type, it assumes that this is a class name, for example
C<ArrayRef[DateTime]>.
B<NOTE:> Unless you parameterize a type, then it is invalid to include
the square brackets. I.e. C<ArrayRef[]> will be treated as a new type
name, I<not> as a parameterization of C<ArrayRef>.
B<NOTE:> The C<Undef> type constraint for the most part works
correctly now, but edge cases may still exist, please use it
sparingly.
B<NOTE:> The C<ClassName> type constraint does a complex package
existence check. This means that your class B<must> be loaded for this
type constraint to pass.
B<NOTE:> The C<RoleName> constraint checks a string is a I<package
name> which is a role, like C<'MyApp::Role::Comparable'>.
=head2 Type Constraint Naming
Type name declared via this module can only contain alphanumeric
characters, colons (:), and periods (.).
Since the types created by this module are global, it is suggested
that you namespace your types just as you would namespace your
modules. So instead of creating a I<Color> type for your
B<My::Graphics> module, you would call the type
I<My::Graphics::Types::Color> instead.
=head2 Use with Other Constraint Modules
This module can play nicely with other constraint modules with some
slight tweaking. The C<where> clause in types is expected to be a
C<CODE> reference which checks it's first argument and returns a
boolean. Since most constraint modules work in a similar way, it
should be simple to adapt them to work with Moose.
For instance, this is how you could use it with
L<Declare::Constraints::Simple> to declare a completely new type.
type 'HashOfArrayOfObjects',
{
where => IsHashRef(
-keys => HasLength,
-values => IsArrayRef(IsObject)
)
};
For more examples see the F<t/200_examples/004_example_w_DCS.t> test
file.
Here is an example of using L<Test::Deep> and it's non-test
related C<eq_deeply> function.
type 'ArrayOfHashOfBarsAndRandomNumbers'
=> where {
eq_deeply($_,
array_each(subhashof({
bar => isa('Bar'),
random_number => ignore()
})))
};
For a complete example see the
F<t/200_examples/005_example_w_TestDeep.t> test file.
=head1 FUNCTIONS
=head2 Type Constraint Constructors
The following functions are used to create type constraints. They
will also register the type constraints your create in a global
registry that is used to look types up by name.
See the L<SYNOPSIS> for an example of how to use these.
=over 4
=item B<< subtype 'Name' => as 'Parent' => where { } ... >>
This creates a named subtype.
If you provide a parent that Moose does not recognize, it will
automatically create a new class type constraint for this name.
When creating a named type, the C<subtype> function should either be
called with the sugar helpers (C<where>, C<message>, etc), or with a
name and a hashref of parameters:
subtype( 'Foo', { where => ..., message => ... } );
The valid hashref keys are C<as> (the parent), C<where>, C<message>,
and C<optimize_as>.