Commit | Line | Data |
52d358e2 |
1 | package MooseX::Types; |
16ddefbf |
2 | use Moose; |
8af0a70d |
3 | |
4 | =head1 NAME |
5 | |
52d358e2 |
6 | MooseX::Types - Organise your Moose types in libraries |
8af0a70d |
7 | |
8 | =cut |
9 | |
8af0a70d |
10 | use Moose::Util::TypeConstraints; |
4c2125a4 |
11 | use MooseX::Types::TypeDecorator; |
b0db42a9 |
12 | use MooseX::Types::Base (); |
13 | use MooseX::Types::Util qw( filter_tags ); |
52d358e2 |
14 | use MooseX::Types::UndefinedType; |
b0db42a9 |
15 | use MooseX::Types::CheckedUtilExports (); |
16 | use Carp::Clan qw( ^MooseX::Types ); |
17 | use Sub::Name; |
18 | use Scalar::Util 'reftype'; |
9616cebc |
19 | |
20 | use namespace::clean -except => [qw( meta )]; |
8af0a70d |
21 | |
eba48805 |
22 | use 5.008; |
86a2a6b8 |
23 | our $VERSION = '0.18'; |
8af0a70d |
24 | my $UndefMsg = q{Action for type '%s' not yet defined in library '%s'}; |
25 | |
26 | =head1 SYNOPSIS |
27 | |
9616cebc |
28 | =head2 Library Definition |
29 | |
8af0a70d |
30 | package MyLibrary; |
8af0a70d |
31 | |
32 | # predeclare our own types |
52d358e2 |
33 | use MooseX::Types |
475bbd1d |
34 | -declare => [qw( |
35 | PositiveInt NegativeInt |
36 | ArrayRefOfPositiveInt ArrayRefOfAtLeastThreeNegativeInts |
37 | LotsOfInnerConstraints StrOrArrayRef |
6cfbfdbc |
38 | MyDateTime |
475bbd1d |
39 | )]; |
8af0a70d |
40 | |
41 | # import builtin types |
b0db42a9 |
42 | use MooseX::Types::Moose qw/Int HashRef/; |
8af0a70d |
43 | |
77134b88 |
44 | # type definition. |
8af0a70d |
45 | subtype PositiveInt, |
46 | as Int, |
47 | where { $_ > 0 }, |
48 | message { "Int is not larger than 0" }; |
49 | |
50 | subtype NegativeInt, |
51 | as Int, |
52 | where { $_ < 0 }, |
53 | message { "Int is not smaller than 0" }; |
54 | |
55 | # type coercion |
56 | coerce PositiveInt, |
57 | from Int, |
58 | via { 1 }; |
59 | |
d9002a85 |
60 | # with parameterized constraints. |
475bbd1d |
61 | |
62 | subtype ArrayRefOfPositiveInt, |
d9002a85 |
63 | as ArrayRef[PositiveInt]; |
475bbd1d |
64 | |
65 | subtype ArrayRefOfAtLeastThreeNegativeInts, |
d9002a85 |
66 | as ArrayRef[NegativeInt], |
475bbd1d |
67 | where { scalar(@$_) > 2 }; |
68 | |
69 | subtype LotsOfInnerConstraints, |
d9002a85 |
70 | as ArrayRef[ArrayRef[HashRef[Int]]]; |
475bbd1d |
71 | |
72 | # with TypeConstraint Unions |
73 | |
74 | subtype StrOrArrayRef, |
75 | as Str|ArrayRef; |
76 | |
6cfbfdbc |
77 | # class types |
78 | |
b0db42a9 |
79 | class_type 'DateTime'; |
80 | |
6cfbfdbc |
81 | # or better |
82 | |
83 | class_type MyDateTime, { class => 'DateTime' }; |
84 | |
85 | coerce MyDateTime, |
b0db42a9 |
86 | from HashRef, |
87 | via { DateTime->new(%$_) }; |
88 | |
8af0a70d |
89 | 1; |
90 | |
9616cebc |
91 | =head2 Usage |
92 | |
8af0a70d |
93 | package Foo; |
94 | use Moose; |
95 | use MyLibrary qw( PositiveInt NegativeInt ); |
96 | |
97 | # use the exported constants as type names |
98 | has 'bar', |
99 | isa => PositiveInt, |
100 | is => 'rw'; |
101 | has 'baz', |
102 | isa => NegativeInt, |
103 | is => 'rw'; |
104 | |
105 | sub quux { |
106 | my ($self, $value); |
107 | |
108 | # test the value |
109 | print "positive\n" if is_PositiveInt($value); |
110 | print "negative\n" if is_NegativeInt($value); |
111 | |
112 | # coerce the value, NegativeInt doesn't have a coercion |
113 | # helper, since it didn't define any coercions. |
114 | $value = to_PositiveInt($value) or die "Cannot coerce"; |
115 | } |
116 | |
117 | 1; |
118 | |
119 | =head1 DESCRIPTION |
120 | |
121 | The types provided with L<Moose> are by design global. This package helps |
122 | you to organise and selectively import your own and the built-in types in |
123 | libraries. As a nice side effect, it catches typos at compile-time too. |
124 | |
125 | However, the main reason for this module is to provide an easy way to not |
126 | have conflicts with your type names, since the internal fully qualified |
127 | names of the types will be prefixed with the library's name. |
128 | |
129 | This module will also provide you with some helper functions to make it |
130 | easier to use Moose types in your code. |
131 | |
6beeae32 |
132 | String type names will produce a warning, unless it's for a C<class_type> or |
133 | C<role_type> declared within the library, or a fully qualified name like |
134 | C<'MyTypeLibrary::Foo'>. |
b0db42a9 |
135 | |
8af0a70d |
136 | =head1 TYPE HANDLER FUNCTIONS |
137 | |
138 | =head2 $type |
139 | |
140 | A constant with the name of your type. It contains the type's fully |
141 | qualified name. Takes no value, as all constants. |
142 | |
143 | =head2 is_$type |
144 | |
145 | This handler takes a value and tests if it is a valid value for this |
146 | C<$type>. It will return true or false. |
147 | |
148 | =head2 to_$type |
149 | |
150 | A handler that will take a value and coerce it into the C<$type>. It will |
151 | return a false value if the type could not be coerced. |
152 | |
153 | B<Important Note>: This handler will only be exported for types that can |
154 | do type coercion. This has the advantage that a coercion to a type that |
155 | cannot hasn't defined any coercions will lead to a compile-time error. |
156 | |
157 | =head1 LIBRARY DEFINITION |
158 | |
52d358e2 |
159 | A MooseX::Types is just a normal Perl module. Unlike Moose |
8af0a70d |
160 | itself, it does not install C<use strict> and C<use warnings> in your |
161 | class by default, so this is up to you. |
162 | |
163 | The only thing a library is required to do is |
164 | |
52d358e2 |
165 | use MooseX::Types -declare => \@types; |
8af0a70d |
166 | |
167 | with C<@types> being a list of types you wish to define in this library. |
168 | This line will install a proper base class in your package as well as the |
169 | full set of L<handlers|/"TYPE HANDLER FUNCTIONS"> for your declared |
170 | types. It will then hand control over to L<Moose::Util::TypeConstraints>' |
171 | C<import> method to export the functions you will need to declare your |
172 | types. |
173 | |
174 | If you want to use Moose' built-in types (e.g. for subtyping) you will |
175 | want to |
176 | |
52d358e2 |
177 | use MooseX::Types::Moose @types; |
8af0a70d |
178 | |
52d358e2 |
179 | to import the helpers from the shipped L<MooseX::Types::Moose> |
8af0a70d |
180 | library which can export all types that come with Moose. |
181 | |
182 | You will have to define coercions for your types or your library won't |
183 | export a L</to_$type> coercion helper for it. |
184 | |
21a1dfe2 |
185 | Note that you currently cannot define types containing C<::>, since |
249888e7 |
186 | exporting would be a problem. |
187 | |
559cf3d8 |
188 | You also don't need to use C<warnings> and C<strict>, since the |
189 | definition of a library automatically exports those. |
190 | |
8af0a70d |
191 | =head1 LIBRARY USAGE |
192 | |
193 | You can import the L<"type helpers"|/"TYPE HANDLER FUNCTIONS"> of a |
194 | library by C<use>ing it with a list of types to import as arguments. If |
195 | you want all of them, use the C<:all> tag. For example: |
196 | |
197 | use MyLibrary ':all'; |
198 | use MyOtherLibrary qw( TypeA TypeB ); |
199 | |
52d358e2 |
200 | MooseX::Types comes with a library of Moose' built-in types called |
201 | L<MooseX::Types::Moose>. |
8af0a70d |
202 | |
16ddefbf |
203 | The exporting mechanism is, since version 0.5, implemented via a wrapper |
204 | around L<Sub::Exporter>. This means you can do something like this: |
205 | |
206 | use MyLibrary TypeA => { -as => 'MyTypeA' }, |
207 | TypeB => { -as => 'MyTypeB' }; |
208 | |
c20dc98b |
209 | =head1 WRAPPING A LIBRARY |
210 | |
211 | You can define your own wrapper subclasses to manipulate the behaviour |
212 | of a set of library exports. Here is an example: |
213 | |
214 | package MyWrapper; |
215 | use strict; |
216 | use Class::C3; |
52d358e2 |
217 | use base 'MooseX::Types::Wrapper'; |
c20dc98b |
218 | |
219 | sub coercion_export_generator { |
220 | my $class = shift; |
221 | my $code = $class->next::method(@_); |
222 | return sub { |
223 | my $value = $code->(@_); |
224 | warn "Coercion returned undef!" |
225 | unless defined $value; |
226 | return $value; |
227 | }; |
228 | } |
229 | |
230 | 1; |
231 | |
232 | This class wraps the coercion generator (e.g., C<to_Int()>) and warns |
233 | if a coercion returned an undefined value. You can wrap any library |
234 | with this: |
235 | |
236 | package Foo; |
237 | use strict; |
238 | use MyWrapper MyLibrary => [qw( Foo Bar )], |
239 | Moose => [qw( Str Int )]; |
240 | |
241 | ... |
242 | 1; |
243 | |
244 | The C<Moose> library name is a special shortcut for |
52d358e2 |
245 | L<MooseX::Types::Moose>. |
c20dc98b |
246 | |
247 | =head2 Generator methods you can overload |
248 | |
249 | =over 4 |
250 | |
251 | =item type_export_generator( $short, $full ) |
252 | |
253 | Creates a closure returning the type's L<Moose::Meta::TypeConstraint> |
254 | object. |
255 | |
256 | =item check_export_generator( $short, $full, $undef_message ) |
257 | |
258 | This creates the closure used to test if a value is valid for this type. |
259 | |
260 | =item coercion_export_generator( $short, $full, $undef_message ) |
261 | |
262 | This is the closure that's doing coercions. |
263 | |
264 | =back |
265 | |
266 | =head2 Provided Parameters |
267 | |
268 | =over 4 |
269 | |
270 | =item $short |
271 | |
272 | The short, exported name of the type. |
273 | |
274 | =item $full |
275 | |
276 | The fully qualified name of this type as L<Moose> knows it. |
277 | |
278 | =item $undef_message |
279 | |
280 | A message that will be thrown when type functionality is used but the |
281 | type does not yet exist. |
282 | |
0ad3779e |
283 | =back |
284 | |
077ac262 |
285 | =head1 RECURSIVE SUBTYPES |
286 | |
287 | As of version 0.08, L<Moose::Types> has experimental support for Recursive |
288 | subtypes. This will allow: |
289 | |
290 | subtype Tree() => as HashRef[Str|Tree]; |
291 | |
292 | Which validates things like: |
293 | |
294 | {key=>'value'}; |
295 | {key=>{subkey1=>'value', subkey2=>'value'}} |
296 | |
297 | And so on. This feature is new and there may be lurking bugs so don't be afraid |
298 | to hunt me down with patches and test cases if you have trouble. |
299 | |
475bbd1d |
300 | =head1 NOTES REGARDING TYPE UNIONS |
301 | |
302 | L<MooseX::Types> uses L<MooseX::Types::TypeDecorator> to do some overloading |
303 | which generally allows you to easily create union types: |
304 | |
305 | subtype StrOrArrayRef, |
306 | as Str|ArrayRef; |
307 | |
308 | As with parameterized constrains, this overloading extends to modules using the |
309 | types you define in a type library. |
310 | |
311 | use Moose; |
312 | use MooseX::Types::Moose qw(HashRef Int); |
313 | |
314 | has 'attr' => (isa=>HashRef|Int); |
315 | |
316 | And everything should just work as you'd think. |
77134b88 |
317 | |
8af0a70d |
318 | =head1 METHODS |
319 | |
320 | =head2 import |
321 | |
52d358e2 |
322 | Installs the L<MooseX::Types::Base> class into the caller and |
e211870f |
323 | exports types according to the specification described in |
324 | L</"LIBRARY DEFINITION">. This will continue to |
325 | L<Moose::Util::TypeConstraints>' C<import> method to export helper |
326 | functions you will need to declare your types. |
327 | |
8af0a70d |
328 | =cut |
329 | |
330 | sub import { |
331 | my ($class, %args) = @_; |
332 | my $callee = caller; |
333 | |
559cf3d8 |
334 | # everyone should want this |
335 | strict->import; |
336 | warnings->import; |
337 | |
8af0a70d |
338 | # inject base class into new library |
339 | { no strict 'refs'; |
52d358e2 |
340 | unshift @{ $callee . '::ISA' }, 'MooseX::Types::Base'; |
8af0a70d |
341 | } |
342 | |
343 | # generate predeclared type helpers |
e211870f |
344 | if (my @orig_declare = @{ $args{ -declare } || [] }) { |
345 | my ($tags, $declare) = filter_tags @orig_declare; |
16ddefbf |
346 | my @to_export; |
e211870f |
347 | |
348 | for my $type (@$declare) { |
249888e7 |
349 | |
350 | croak "Cannot create a type containing '::' ($type) at the moment" |
351 | if $type =~ /::/; |
352 | |
16ddefbf |
353 | # add type to library and remember to export |
8af0a70d |
354 | $callee->add_type($type); |
16ddefbf |
355 | push @to_export, $type; |
8af0a70d |
356 | } |
16ddefbf |
357 | |
358 | $callee->import({ -full => 1, -into => $callee }, @to_export); |
8af0a70d |
359 | } |
360 | |
361 | # run type constraints import |
b0db42a9 |
362 | Moose::Util::TypeConstraints->import({ into => $callee }); |
363 | |
364 | # override some with versions that check for syntax errors |
365 | MooseX::Types::CheckedUtilExports->import({ into => $callee }); |
366 | |
367 | 1; |
8af0a70d |
368 | } |
369 | |
370 | =head2 type_export_generator |
371 | |
e211870f |
372 | Generate a type export, e.g. C<Int()>. This will return either a |
373 | L<Moose::Meta::TypeConstraint> object, or alternatively a |
52d358e2 |
374 | L<MooseX::Types::UndefinedType> object if the type was not |
e211870f |
375 | yet defined. |
376 | |
8af0a70d |
377 | =cut |
378 | |
379 | sub type_export_generator { |
a706b0f2 |
380 | my ($class, $type, $name) = @_; |
686e5888 |
381 | |
382 | ## Return an anonymous subroutine that will generate the proxied type |
383 | ## constraint for you. |
4e6dc81d |
384 | |
1150ce72 |
385 | return subname "__TYPE__::$name" => sub { |
b0db42a9 |
386 | my $type_constraint = $class->create_base_type_constraint($name); |
387 | |
e088dd03 |
388 | if(defined(my $params = shift @_)) { |
686e5888 |
389 | ## We currently only allow a TC to accept a single, ArrayRef |
390 | ## parameter, as in HashRef[Int], where [Int] is what's inside the |
391 | ## ArrayRef passed. |
b0db42a9 |
392 | if(reftype $params eq 'ARRAY') { |
e088dd03 |
393 | $type_constraint = $class->create_arged_type_constraint($name, @$params); |
b0db42a9 |
394 | } elsif(!defined $type_constraint) { |
395 | croak "Syntax error in type definition (did you forget a comma" |
396 | . " after $type?)"; |
e088dd03 |
397 | } else { |
b0db42a9 |
398 | croak "Argument must be an ArrayRef to create a parameterized " |
399 | . "type, Eg.: ${type}[Int]. Got: ".ref($params)."." |
e088dd03 |
400 | } |
e088dd03 |
401 | } |
e7d06577 |
402 | |
e088dd03 |
403 | $type_constraint = defined($type_constraint) ? $type_constraint |
404 | : MooseX::Types::UndefinedType->new($name); |
475bbd1d |
405 | |
d9002a85 |
406 | my $type_decorator = $class->create_type_decorator($type_constraint); |
bb5b7b28 |
407 | |
686e5888 |
408 | ## If there are additional args, that means it's probably stuff that |
409 | ## needs to be returned to the subtype. Not an ideal solution here but |
410 | ## doesn't seem to cause trouble. |
411 | |
d9002a85 |
412 | if(@_) { |
413 | return ($type_decorator, @_); |
414 | } else { |
415 | return $type_decorator; |
416 | } |
e211870f |
417 | }; |
8af0a70d |
418 | } |
419 | |
a706b0f2 |
420 | =head2 create_arged_type_constraint ($name, @args) |
421 | |
686e5888 |
422 | Given a String $name with @args find the matching typeconstraint and parameterize |
423 | it with @args. |
a706b0f2 |
424 | |
425 | =cut |
426 | |
427 | sub create_arged_type_constraint { |
371efa05 |
428 | my ($class, $name, @args) = @_; |
429 | my $type_constraint = Moose::Util::TypeConstraints::find_or_create_type_constraint("$name"); |
8a58233c |
430 | my $parameterized = $type_constraint->parameterize(@args); |
431 | # It's obnoxious to have to parameterize before looking for the TC, but the |
432 | # alternative is to hard-code the assumption that the name is |
433 | # "$name[$args[0]]", which would be worse. |
434 | if (my $existing = |
435 | Moose::Util::TypeConstraints::find_type_constraint($parameterized->name)) { |
436 | return $existing; |
437 | } |
438 | Moose::Util::TypeConstraints::register_type_constraint($parameterized); |
439 | return $parameterized; |
a706b0f2 |
440 | } |
441 | |
442 | =head2 create_base_type_constraint ($name) |
443 | |
444 | Given a String $name, find the matching typeconstraint. |
445 | |
446 | =cut |
447 | |
448 | sub create_base_type_constraint { |
449 | my ($class, $name) = @_; |
450 | return find_type_constraint($name); |
451 | } |
452 | |
453 | =head2 create_type_decorator ($type_constraint) |
454 | |
455 | Given a $type_constraint, return a lightweight L<MooseX::Types::TypeDecorator> |
456 | instance. |
457 | |
458 | =cut |
459 | |
460 | sub create_type_decorator { |
461 | my ($class, $type_constraint) = @_; |
475bbd1d |
462 | return MooseX::Types::TypeDecorator->new($type_constraint); |
a706b0f2 |
463 | } |
464 | |
8af0a70d |
465 | =head2 coercion_export_generator |
466 | |
e211870f |
467 | This generates a coercion handler function, e.g. C<to_Int($value)>. |
468 | |
8af0a70d |
469 | =cut |
470 | |
471 | sub coercion_export_generator { |
472 | my ($class, $type, $full, $undef_msg) = @_; |
473 | return sub { |
474 | my ($value) = @_; |
475 | |
476 | # we need a type object |
477 | my $tobj = find_type_constraint($full) or croak $undef_msg; |
478 | my $return = $tobj->coerce($value); |
479 | |
480 | # non-successful coercion returns false |
481 | return unless $tobj->check($return); |
482 | |
483 | return $return; |
484 | } |
485 | } |
486 | |
487 | =head2 check_export_generator |
488 | |
e211870f |
489 | Generates a constraint check closure, e.g. C<is_Int($value)>. |
490 | |
8af0a70d |
491 | =cut |
492 | |
493 | sub check_export_generator { |
494 | my ($class, $type, $full, $undef_msg) = @_; |
495 | return sub { |
496 | my ($value) = @_; |
497 | |
498 | # we need a type object |
499 | my $tobj = find_type_constraint($full) or croak $undef_msg; |
500 | |
501 | return $tobj->check($value); |
502 | } |
503 | } |
504 | |
e211870f |
505 | =head1 CAVEATS |
506 | |
686e5888 |
507 | The following are lists of gotcha's and their workarounds for developers coming |
508 | from the standard string based type constraint names |
509 | |
510 | =head2 Uniqueness |
511 | |
e211870f |
512 | A library makes the types quasi-unique by prefixing their names with (by |
513 | default) the library package name. If you're only using the type handler |
52d358e2 |
514 | functions provided by MooseX::Types, you shouldn't ever have to use |
e211870f |
515 | a type's actual full name. |
516 | |
686e5888 |
517 | =head2 Argument separation ('=>' versus ',') |
518 | |
519 | The Perlop manpage has this to say about the '=>' operator: "The => operator is |
520 | a synonym for the comma, but forces any word (consisting entirely of word |
521 | characters) to its left to be interpreted as a string (as of 5.001). This |
522 | includes words that might otherwise be considered a constant or function call." |
523 | |
524 | Due to this stringification, the following will NOT work as you might think: |
525 | |
526 | subtype StrOrArrayRef => as Str|ArrayRef; |
527 | |
528 | The 'StrOrArrayRef' will have it's stringification activated this causes the |
529 | subtype to not be created. Since the bareword type constraints are not strings |
530 | you really should not try to treat them that way. You will have to use the ',' |
531 | operator instead. The author's of this package realize that all the L<Moose> |
532 | documention and examples nearly uniformly use the '=>' version of the comma |
533 | operator and this could be an issue if you are converting code. |
534 | |
535 | Patches welcome for discussion. |
077ac262 |
536 | |
537 | =head2 Compatibility with Sub::Exporter |
538 | |
539 | If you want to use L<Sub::Exporter> with a Type Library, you need to make sure |
540 | you export all the type constraints declared AS WELL AS any additional export |
541 | targets. For example if you do: |
542 | |
543 | package TypeAndSubExporter; { |
544 | |
545 | use MooseX::Types::Moose qw(Str); |
546 | use MooseX::Types -declare => [qw(MyStr)]; |
547 | use Sub::Exporter -setup => { exports => [ qw(something) ] }; |
548 | |
549 | subtype MyStr, |
550 | as Str; |
551 | |
552 | sub something { |
553 | return 1; |
554 | } |
555 | |
556 | } 1; |
557 | |
558 | package Foo; { |
559 | use TypeAndSubExporter qw(MyStr); |
560 | } 1; |
561 | |
562 | You'll get a '"MyStr" is not exported by the TypeAndSubExporter module' error. |
563 | Upi can workaround by: |
564 | |
565 | - use Sub::Exporter -setup => { exports => [ qw(something) ] }; |
566 | + use Sub::Exporter -setup => { exports => [ qw(something MyStr) ] }; |
567 | |
568 | This is a workaround and I am exploring how to make these modules work better |
569 | together. I realize this workaround will lead a lot of duplication in your |
570 | export declarations and will be onerous for large type libraries. Patches and |
571 | detailed test cases welcome. See the tests directory for a start on this. |
686e5888 |
572 | |
8af0a70d |
573 | =head1 SEE ALSO |
574 | |
16ddefbf |
575 | L<Moose>, |
576 | L<Moose::Util::TypeConstraints>, |
577 | L<MooseX::Types::Moose>, |
578 | L<Sub::Exporter> |
8af0a70d |
579 | |
b55332a8 |
580 | =head1 ACKNOWLEDGEMENTS |
8af0a70d |
581 | |
b55332a8 |
582 | Many thanks to the C<#moose> cabal on C<irc.perl.org>. |
8af0a70d |
583 | |
b55332a8 |
584 | =head1 AUTHOR |
475bbd1d |
585 | |
b55332a8 |
586 | Robert "phaylon" Sedlacek <rs@474.at> |
587 | |
588 | =head1 CONTRIBUTORS |
589 | |
590 | jnapiorkowski: John Napiorkowski <jjnapiork@cpan.org> |
591 | |
592 | caelum: Rafael Kitover <rkitover@cpan.org> |
593 | |
97cc8c9f |
594 | rafl: Florian Ragwitz <rafl@debian.org> |
595 | |
86a2a6b8 |
596 | hdp: Hans Dieter Pearcey <hdp@cpan.org> |
597 | |
b55332a8 |
598 | =head1 COPYRIGHT & LICENSE |
599 | |
600 | Copyright (c) 2007-2009 Robert Sedlacek |
8af0a70d |
601 | |
602 | This program is free software; you can redistribute it and/or modify |
603 | it under the same terms as perl itself. |
604 | |
605 | =cut |
606 | |
607 | 1; |