Commit | Line | Data |
3fef8ce8 |
1 | package Moose::Meta::TypeConstraint::Class; |
2 | |
3 | use strict; |
4 | use warnings; |
5 | use metaclass; |
6 | |
28412c0b |
7 | use Scalar::Util 'blessed'; |
8 | use Moose::Util::TypeConstraints (); |
3fef8ce8 |
9 | |
e6ab9ca5 |
10 | our $VERSION = '0.83'; |
75b95414 |
11 | $VERSION = eval $VERSION; |
28412c0b |
12 | our $AUTHORITY = 'cpan:STEVAN'; |
3fef8ce8 |
13 | |
28412c0b |
14 | use base 'Moose::Meta::TypeConstraint'; |
3fef8ce8 |
15 | |
336824fa |
16 | __PACKAGE__->meta->add_attribute('class' => ( |
4078709c |
17 | reader => 'class', |
336824fa |
18 | )); |
19 | |
3fef8ce8 |
20 | sub new { |
336824fa |
21 | my ( $class, %args ) = @_; |
22 | |
336824fa |
23 | $args{parent} = Moose::Util::TypeConstraints::find_type_constraint('Object'); |
0779da92 |
24 | my $self = $class->_new(\%args); |
336824fa |
25 | |
dabed765 |
26 | $self->_create_hand_optimized_type_constraint; |
dabed765 |
27 | $self->compile_type_constraint(); |
336824fa |
28 | |
3fef8ce8 |
29 | return $self; |
30 | } |
31 | |
dabed765 |
32 | sub _create_hand_optimized_type_constraint { |
33 | my $self = shift; |
34 | my $class = $self->class; |
4078709c |
35 | $self->hand_optimized_type_constraint( |
d03bd989 |
36 | sub { |
37 | blessed( $_[0] ) && $_[0]->isa($class) |
4078709c |
38 | } |
39 | ); |
dabed765 |
40 | } |
41 | |
3fef8ce8 |
42 | sub parents { |
43 | my $self = shift; |
44 | return ( |
45 | $self->parent, |
336824fa |
46 | map { |
47 | # FIXME find_type_constraint might find a TC named after the class but that isn't really it |
48 | # I did this anyway since it's a convention that preceded TypeConstraint::Class, and it should DWIM |
49 | # if anybody thinks this problematic please discuss on IRC. |
50 | # a possible fix is to add by attr indexing to the type registry to find types of a certain property |
51 | # regardless of their name |
d03bd989 |
52 | Moose::Util::TypeConstraints::find_type_constraint($_) |
53 | || |
620db045 |
54 | __PACKAGE__->new( class => $_, name => "__ANON__" ) |
1d9c3b75 |
55 | } Class::MOP::class_of($self->class)->superclasses, |
3fef8ce8 |
56 | ); |
57 | } |
58 | |
d9e17f80 |
59 | sub equals { |
60 | my ( $self, $type_or_name ) = @_; |
61 | |
dabed765 |
62 | my $other = Moose::Util::TypeConstraints::find_type_constraint($type_or_name); |
d9e17f80 |
63 | |
4c015454 |
64 | return unless defined $other; |
dabed765 |
65 | return unless $other->isa(__PACKAGE__); |
66 | |
67 | return $self->class eq $other->class; |
d9e17f80 |
68 | } |
69 | |
3fef8ce8 |
70 | sub is_a_type_of { |
d9e17f80 |
71 | my ($self, $type_or_name) = @_; |
3fef8ce8 |
72 | |
d9e17f80 |
73 | my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name); |
74 | |
75 | ($self->equals($type) || $self->is_subtype_of($type_or_name)); |
3fef8ce8 |
76 | } |
77 | |
78 | sub is_subtype_of { |
d9e17f80 |
79 | my ($self, $type_or_name_or_class ) = @_; |
80 | |
81 | if ( not ref $type_or_name_or_class ) { |
82 | # it might be a class |
83 | return 1 if $self->class->isa( $type_or_name_or_class ); |
84 | } |
85 | |
86 | my $type = Moose::Util::TypeConstraints::find_type_constraint($type_or_name_or_class); |
d03bd989 |
87 | |
4c015454 |
88 | return unless defined $type; |
d9e17f80 |
89 | |
90 | if ( $type->isa(__PACKAGE__) ) { |
91 | # if $type_or_name_or_class isn't a class, it might be the TC name of another ::Class type |
92 | # or it could also just be a type object in this branch |
93 | return $self->class->isa( $type->class ); |
94 | } else { |
95 | # the only other thing we are a subtype of is Object |
96 | $self->SUPER::is_subtype_of($type); |
97 | } |
3fef8ce8 |
98 | } |
99 | |
97534a9b |
100 | # This is a bit counter-intuitive, but a child type of a Class type |
101 | # constraint is not itself a Class type constraint (it has no class |
102 | # attribute). This whole create_child_type thing needs some changing |
103 | # though, probably making MMC->new a factory or something. |
104 | sub create_child_type { |
2fb4885e |
105 | my ($self, @args) = @_; |
106 | return Moose::Meta::TypeConstraint->new(@args, parent => $self); |
97534a9b |
107 | } |
108 | |
d414e17c |
109 | sub get_message { |
110 | my $self = shift; |
111 | my ($value) = @_; |
112 | |
113 | if ($self->has_message) { |
114 | return $self->SUPER::get_message(@_); |
115 | } |
116 | |
117 | $value = (defined $value ? overload::StrVal($value) : 'undef'); |
118 | return "Validation failed for '" . $self->name . "' failed with value $value (not isa " . $self->class . ")"; |
119 | } |
120 | |
3fef8ce8 |
121 | 1; |
122 | |
123 | __END__ |
28412c0b |
124 | |
3fef8ce8 |
125 | =pod |
126 | |
127 | =head1 NAME |
128 | |
129 | Moose::Meta::TypeConstraint::Class - Class/TypeConstraint parallel hierarchy |
130 | |
9f4bf6b8 |
131 | =head1 DESCRIPTION |
132 | |
133 | This class represents type constraints for a class. |
134 | |
135 | =head1 INHERITANCE |
136 | |
137 | C<Moose::Meta::TypeConstraint::Class> is a subclass of |
138 | L<Moose::Meta::TypeConstraint>. |
139 | |
3fef8ce8 |
140 | =head1 METHODS |
141 | |
142 | =over 4 |
143 | |
9f4bf6b8 |
144 | =item B<< Moose::Meta::TypeConstraint::Class->new(%options) >> |
145 | |
146 | This creates a new class type constraint based on the given |
147 | C<%options>. |
148 | |
149 | It takes the same options as its parent, with two exceptions. First, |
150 | it requires an additional option, C<class>, which is name of the |
151 | constraint's class. Second, it automatically sets the parent to the |
152 | C<Object> type. |
153 | |
154 | The constructor also overrides the hand optimized type constraint with |
155 | one it creates internally. |
3fef8ce8 |
156 | |
9f4bf6b8 |
157 | =item B<< $constraint->class >> |
4078709c |
158 | |
9f4bf6b8 |
159 | Returns the class name associated with the constraint. |
3fef8ce8 |
160 | |
9f4bf6b8 |
161 | =item B<< $constraint->parents >> |
3fef8ce8 |
162 | |
9f4bf6b8 |
163 | Returns all the type's parent types, corresponding to its parent |
164 | classes. |
d9e17f80 |
165 | |
2870fb09 |
166 | =item B<< $constraint->is_subtype_of($type_name_or_object) >> |
3fef8ce8 |
167 | |
9f4bf6b8 |
168 | If the given type is also a class type, then this checks that the |
169 | type's class is a subclass of the other type's class. |
3fef8ce8 |
170 | |
38bf0e17 |
171 | Otherwise it falls back to the implementation in |
9f4bf6b8 |
172 | L<Moose::Meta::TypeConstraint>. |
3fef8ce8 |
173 | |
9f4bf6b8 |
174 | =item B<< $constraint->create_child_type(%options) >> |
3fef8ce8 |
175 | |
9f4bf6b8 |
176 | This returns a new L<Moose::Meta::TypeConstraint> object with the type |
177 | as its parent. |
28412c0b |
178 | |
9f4bf6b8 |
179 | Note that it does I<not> return a |
180 | C<Moose::Meta::TypeConstraint::Class> object! |
97534a9b |
181 | |
f561b856 |
182 | =item B<< $constraint->get_message($value) >> |
183 | |
184 | This is the same as L<Moose::Meta::TypeConstraint/get_message> except |
185 | that it explicitly says C<isa> was checked. This is to help users deal |
186 | with accidentally autovivified type constraints. |
187 | |
3fef8ce8 |
188 | =back |
189 | |
28412c0b |
190 | =head1 BUGS |
191 | |
d03bd989 |
192 | All complex software has bugs lurking in it, and this module is no |
28412c0b |
193 | exception. If you find a bug please either email me, or add the bug |
194 | to cpan-RT. |
195 | |
196 | =head1 AUTHOR |
197 | |
198 | Yuval Kogman E<lt>nothingmuch@cpan.orgE<gt> |
199 | |
200 | =head1 COPYRIGHT AND LICENSE |
201 | |
2840a3b2 |
202 | Copyright 2006-2009 by Infinity Interactive, Inc. |
28412c0b |
203 | |
204 | L<http://www.iinteractive.com> |
205 | |
206 | This library is free software; you can redistribute it and/or modify |
207 | it under the same terms as Perl itself. |
208 | |
3fef8ce8 |
209 | =cut |