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