s/constraint/coercion/
[gitmo/Moose.git] / lib / Moose / Manual / Delta.pod
1 =pod
2
3 =head1 NAME
4
5 Moose::Manual::Delta - Important Changes in Moose
6
7 =head1 DESCRIPTION
8
9 This documents any important or noteworthy changes in Moose, with a
10 focus on backwards. This does duplicate data from the F<Changes> file,
11 but aims to provide more details and when possible workarounds.
12
13 Besides helping keep up with changes, you can also use this document
14 for finding the lowest version of Moose that supported a given
15 feature.  If you encounter a problem and have a solution but don't see
16 it documented here, or think we missed an important feature, please
17 send us a patch.
18
19 =head1 Version 0.73
20
21 Calling C<subtype> with a name as the only argument now throws an
22 exception. If you want an anonymous subtype do:
23
24     my $subtype = subtype as 'Foo';
25
26 This is related to the changes in version 0.71_01.
27
28 The C<is_needed> method in L<Moose::Meta::Method::Destructor> is now
29 only usable as a class method. Previously, it worked as a class or
30 object method, with a different internal implementation for each
31 version.
32
33 The internals of making a class immutable changed a lot in Class::MOP
34 0.78_02, and Moose's internals have changed along with it. The
35 external C<< $metaclass->make_immutable >> method still works the same
36 way.
37
38 =head1 Version 0.72
39
40 A mutable class accepted C<< Foo->new(undef) >> without complaint,
41 while an immutable class would blow up with an unhelpful error. Now,
42 in both cases we throw a helpful error instead.
43
44 This "feature" was originally added to allow for cases such as this:
45
46   my $args;
47
48   if ( something() ) {
49       $args = {...};
50   }
51
52   return My::Class->new($args);
53
54 But we decided this is a bad idea and a little too magical, because it
55 can easily mask real errors.
56
57 =head1 Version 0.71_01
58
59 Calling C<type> or C<subtype> without the sugar helpers (C<as>,
60 C<where>, C<message>) is now deprecated.
61
62 As a side effect, this meant we ended up using Perl prototypes on
63 C<as>, and code like this will no longer work:
64
65   use Moose::Util::TypeConstraints;
66   use Declare::Constraints::Simple -All;
67
68   subtype 'ArrayOfInts'
69       => as 'ArrayRef'
70       => IsArrayRef(IsInt);
71
72 Instead it must be changed to this:
73
74   subtype(
75       'ArrayOfInts' => {
76           as    => 'ArrayRef',
77           where => IsArrayRef(IsInt)
78       }
79   );
80
81 If you want to maintain backwards compat with older versions of Moose,
82 you must explicitly test Moose's C<VERSION>:
83
84   if ( Moose->VERSION < 0.71_01 ) {
85       subtype 'ArrayOfInts'
86           => as 'ArrayRef'
87           => IsArrayRef(IsInt);
88   }
89   else {
90       subtype(
91           'ArrayOfInts' => {
92               as    => 'ArrayRef',
93               where => IsArrayRef(IsInt)
94           }
95       );
96   }
97
98 =head1 Version 0.70
99
100 We no longer pass the meta-attribute object as a final argument to
101 triggers. This actually changed for inlined code a while back, but the
102 non-inlined version and the docs were still out of date.
103
104 If by some chance you actually used this feature, the workaround is
105 simple. You fetch the attribute object from out of the C<$self>
106 that is passed as the first argument to trigger, like so:
107
108   has 'foo' => (
109       is      => 'ro',
110       isa     => 'Any',
111       trigger => sub {
112           my ( $self, $value ) = @_;
113           my $attr = $self->meta->find_attribute_by_name('foo');
114
115           # ...
116       }
117   );
118
119 =head1 Version 0.66
120
121 If you created a subtype and passed a parent that Moose didn't know
122 about, it simply ignored the parent. Now it automatically creates the
123 parent as a class type. This may not be what you want, but is less
124 broken than before.
125
126 You could declare a name with subtype such as "Foo!Bar". Moose would
127 accept this allowed, but if you used it in a parameterized type such
128 as "ArrayRef[Foo!Bar]" it wouldn't work. We now do some vetting on
129 names created via the sugar functions, so that they can only contain
130 alphanumerics, ":", and ".".
131
132 =head1 Version 0.65
133
134 Methods created via an attribute can now fulfill a C<requires>
135 declaration for a role. Honestly we don't know why Stevan didn't make
136 this work originally, he was just insane or something.
137
138 Stack traces from inlined code will now report the line and file as
139 being in your class, as opposed to in Moose guts.
140
141 =head1 Version 0.62_02
142
143 When a class does not provide all of a role's required methods, the
144 error thrown now mentions all of the missing methods, as opposed to
145 just the first missing method.
146
147 Moose will no longer inline a constructor for your class unless it
148 inherits its constructor is inherited from Moose::Object, and will
149 warn when it doesn't inline. If you want to force inlining anyway,
150 pass C<< "replace_constructor => 1 >> to C<make_immutable>.
151
152 If you want to get rid of the warning, pass C<< inline_constructor =>
153 1 >>.
154
155 =head1 Version 0.62
156
157 Removed the (deprecated) C<make_immutable> keyword.
158
159 Removing an attribute from a class now also removes delegation
160 (C<handles>) methods installed for that attribute. This is correct
161 behavior, but if you were wrongly relying on it you might get bit.
162
163 =head1 Version 0.58
164
165 Roles now add methods by calling C<add_method>, not
166 C<alias_method>. They make sure to always provide a method object,
167 which will be cloned internally. This means that it is now possible to
168 track the source of a method provided by a role, and even follow its
169 history through intermediate roles.  This means that methods added by
170 a role now show up when looking at a class's method list/map.
171
172 Parameter and Union args are now sorted, this makes Int|Str the same
173 constraint as Str|Int. Also, incoming type constraint strings are
174 normalized to remove all whitespace differences. This is mostly for
175 internals and should not affect outside code.
176
177 L<Moose::Exporter> will no longer remove a subroutine that the
178 exporting package re-exports. Moose re-exports the Carp::confess
179 function, among others. The reasoning is that we cannot know whether
180 you have also explicitly imported those functions for your own use, so
181 we err on the safe side and always keep them.
182
183 =head1 Version 0.56
184
185 C<Moose::init_meta> should now be called as a method.
186
187 New modules for extension writers, L<Moose::Exporter> and
188 L<Moose::Util::MetaRole>.
189
190 =head1 Version 0.55_01
191
192 Implemented metaclass traits (and wrote a recipe for it):
193
194   use Moose -traits => 'Foo'
195
196 This should make writing small Moose extensions a little
197 easier.
198
199 =head1 Version 0.55
200
201 Fixed C<coerce> to accept anon types just like C<subtype> can.
202 So that you can do:
203
204   coerce $some_anon_type => from 'Str' => via { ... };
205
206 =head1 Version 0.51
207
208 Added C<BUILDARGS>, a new step in C<< Moose::Object->new() >>.
209
210 =head1 Version 0.49
211
212 Fixed how the C<< is => (ro|rw) >> works with custom defined
213 C<reader>, C<writer> and C<accessor> options. See the below table for
214 details:
215
216   is => ro, writer => _foo    # turns into (reader => foo, writer => _foo)
217   is => rw, writer => _foo    # turns into (reader => foo, writer => _foo)
218   is => rw, accessor => _foo  # turns into (accessor => _foo)
219   is => ro, accessor => _foo  # error, accesor is rw
220
221 =head1 Version 0.45
222
223 The C<before/around/after> method modifiers now support regexp
224 matching of method names. NOTE: this only works for classes, it is
225 currently not supported in roles, but, ... patches welcome.
226
227 The C<has> keyword for roles now accepts the same array ref form that
228 L<Moose>.pm does for classes.
229
230 A trigger on a read-only attribute is no longer an error, as it's
231 useful to trigger off of the constructor.
232
233 Subtypes of parameterizable types now are parameterizable types
234 themselves.
235
236 =head1 Version 0.44
237
238 Fixed issue where C<DEMOLISHALL> was eating the value in C<$@>, and so
239 not working correctly. It still kind of eats them, but so does vanilla
240 perl.
241
242 =head1 Version 0.41
243
244 Inherited attributes may now be extended without restriction on the
245 type ('isa', 'does').
246
247 The entire set of Moose::Meta::TypeConstraint::* classes were
248 refactored in this release. If you were relying on their internals you
249 should test your code carefully.
250
251 =head1 Version 0.40
252
253 Documenting the use of '+name' with attributes that come from recently
254 composed roles. It makes sense, people are using it, and so why not
255 just officially support it.
256
257 The C<< Moose::Meta::Class->create >> method now supports roles.
258
259 It is now possible to make anonymous enum types by passing C<enum> an
260 array reference instead of the C<< enum $name => @values >>.
261
262 =head1 Version 0.37
263
264 Added the C<make_immutable> keyword as a shortcut to calling
265 C<make_immutable> on the meta object. This eventually got removed!
266
267 Made C<< init_arg => undef >> work in Moose. This means "do not accept
268 a constructor parameter for this attribute".
269
270 Type errors now use the provided message. Prior to this release they
271 didn't.
272
273 =head1 Version 0.34
274
275 Moose is now a postmodern object system :)
276
277 The Role system was completely refactored. It is 100% backwards
278 compat, but the internals were totally changed. If you relied on the
279 internals then you are advised to test carefully.
280
281 Added method exclusion and aliasing for Roles in this release.
282
283 Added the L<Moose::Util::TypeConstraints::OptimizedConstraints>
284 module.
285
286 Passing a list of values to an accessor (which is only expecting one
287 value) used to be silently ignored, now it throws an error.
288
289 =head1 Version 0.26
290
291 Added parameterized types and did a pretty heavy refactoring of the
292 type constraint system.
293
294 Better framework extendability and better support for "making your own
295 Moose".
296
297 =head1 Version 0.25 or before
298
299 Honestly, you shouldn't be using versions of Moose that are this old,
300 so many bug fixes and speed improvements have been made you would be
301 crazy to not upgrade.
302
303 Also, I am tired of going through the Changelog so I am stopping here,
304 if anyone would like to continue this please feel free.
305
306 =head1 AUTHOR
307
308 Stevan Little E<lt>stevan@iinteractive.comE<gt>
309
310 =head1 COPYRIGHT AND LICENSE
311
312 Copyright 2009 by Infinity Interactive, Inc.
313
314 L<http://www.iinteractive.com>
315
316 This library is free software; you can redistribute it and/or modify
317 it under the same terms as Perl itself.
318
319 =cut