Commit | Line | Data |
600f7f85 |
1 | =pod |
2 | |
3 | =head1 NAME |
4 | |
5 | Moose::Manual::Delta - Important Changes in Moose |
6 | |
7 | =head1 DESCRIPTION |
8 | |
0f13f53c |
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. |
600f7f85 |
18 | |
c378a61a |
19 | =head1 0.93 |
20 | |
21 | =over 4 |
22 | |
23 | =item Calling $object->new() is no longer deprecated |
24 | |
76c89056 |
25 | We decided to undeprecate this. Now it just works. |
c378a61a |
26 | |
d99ec58b |
27 | =item Both C<get_method_map> and C<get_attribute_map> is deprecated |
fa6da135 |
28 | |
d99ec58b |
29 | These metaclass methods were never meant to be public, and they are both now |
30 | deprecated. The work around if you still need the functionality they provided |
31 | is to iterate over the list of names manually. |
fa6da135 |
32 | |
33 | my %fields = map { $_ => $meta->get_attribute($_) } $meta->get_attribute_list; |
34 | |
d99ec58b |
35 | This was actually a change in L<Class::MOP>, but this version of Moose |
36 | requires a version of L<Class::MOP> that includes said change. |
37 | |
c378a61a |
38 | =back |
39 | |
b98ef150 |
40 | =head1 0.90 |
871f82f8 |
41 | |
c985327a |
42 | =over 4 |
43 | |
93ef4ba1 |
44 | =item Added Native delegation for Code refs |
45 | |
46 | See L<Moose::Meta::Attribute::Native::Trait::Code> for details. |
47 | |
3f5ff7d0 |
48 | =item Calling $object->new() is deprecated |
49 | |
50 | Moose has long supported this, but it's never really been documented, and we |
51 | don't think this is a good practice. If you want to construct an object from |
52 | an existing object, you should provide some sort of alternate constructor like |
53 | C<< $object->clone >>. |
54 | |
55 | Calling C<< $object->new >> now issues a warning, and will be an error in a |
56 | future release. |
57 | |
19e60fdd |
58 | =item Moose no longer warns if you call C<make_immutable> for a class with mutable ancestors |
59 | |
60 | While in theory this is a good thing to warn about, we found so many |
61 | exceptions to this that doing this properly became quite problematic. |
62 | |
93ef4ba1 |
63 | =back |
64 | |
65 | =head1 Version 0.89_02 |
66 | |
67 | =over 4 |
4f0d4488 |
68 | |
871f82f8 |
69 | =item New Native delegation methods from L<List::Util> and L<List::MoreUtils> |
70 | |
71 | In particular, we now have C<reduce>, C<shuffle>, C<uniq>, and C<natatime>. |
72 | |
3023f1e4 |
73 | =item The Moose::Exporter with_caller feature is now deprecated |
74 | |
75 | Use C<with_meta> instead. The C<with_caller> option will start warning in a |
76 | future release. |
77 | |
9b9a5a07 |
78 | =item Moose now warns if you call C<make_immutable> for a class with mutable ancestors |
79 | |
80 | This is dangerous because modifying a class after a subclass has been |
90b20bd6 |
81 | immutabilized will lead to incorrect results in the subclass, due to inlining, |
9b9a5a07 |
82 | caching, etc. This occasionally happens accidentally, when a class loads one |
83 | of its subclasses in the middle of its class definition, so pointing out that |
84 | this may cause issues should be helpful. Metaclasses (classes that inherit |
85 | from L<Class::MOP::Object>) are currently exempt from this check, since at the |
90b20bd6 |
86 | moment we aren't very consistent about which metaclasses we immutabilize. |
9b9a5a07 |
87 | |
bce5d4a5 |
88 | =item C<enum> and C<duck_type> now take arrayrefs for all forms |
89 | |
90 | Previously, calling these functions with a list would take the first element of |
91 | the list as the type constraint name, and use the remainder as the enum values |
92 | or method names. This makes the interface inconsistent with the anon-type forms |
93 | of these functions (which must take an arrayref), and a free-form list where |
94 | the first value is sometimes special is hard to validate (and harder to give |
95 | reasonable error messages for). These functions have been changed to take |
96 | arrayrefs in all their forms - so, C<< enum 'My::Type' => [qw(foo bar)] >> is |
97 | now the preferred way to create an enum type constraint. The old syntax still |
98 | works for now, but it will hopefully be deprecated and removed in a future |
99 | release. |
100 | |
871f82f8 |
101 | =back |
102 | |
4ada9618 |
103 | =head1 Version 0.89_01 |
a3d98218 |
104 | |
af44c00c |
105 | L<Moose::Meta::Attribute::Native> has been moved into the Moose core from |
a3d98218 |
106 | L<MooseX::AttributeHelpers>. Major changes include: |
107 | |
ebaaa391 |
108 | =over 4 |
a3d98218 |
109 | |
110 | =item C<traits>, not C<metaclass> |
111 | |
93ced2bd |
112 | Method providers are only available via traits. |
a3d98218 |
113 | |
114 | =item C<handles>, not C<provides> or C<curries> |
115 | |
93ced2bd |
116 | The C<provides> syntax was like core Moose C<< handles => HASHREF >> |
117 | syntax, but with the keys and values reversed. This was confusing, |
118 | and AttributeHelpers now uses C<< handles => HASHREF >> in a way that |
119 | should be intuitive to anyone already familiar with how it is used for |
120 | other attributes. |
a3d98218 |
121 | |
93ced2bd |
122 | The C<curries> functionality provided by AttributeHelpers has been |
123 | generalized to apply to all cases of C<< handles => HASHREF >>, though |
124 | not every piece of functionality has been ported (currying with a |
125 | CODEREF is not supported). |
a3d98218 |
126 | |
1853a27e |
127 | =item C<empty> is now C<is_empty>, and means empty, not non-empty |
af44c00c |
128 | |
129 | Previously, the C<empty> method provided by Arrays and Hashes returned true if |
130 | the attribute was B<not> empty (no elements). Now it returns true if the |
1853a27e |
131 | attribute B<is> empty. It was also renamed to C<is_empty>, to reflect this. |
af44c00c |
132 | |
9a14bd29 |
133 | =item C<find> was renamed to C<first>, and C<first> and C<last> were removed |
28b96142 |
134 | |
135 | L<List::Util> refers to the functionality that we used to provide under C<find> |
136 | as L<first|List::Util/first>, so that will likely be more familiar (and will |
9a14bd29 |
137 | fit in better if we decide to add more List::Util functions). C<first> and |
138 | C<last> were removed, since their functionality is easily duplicated with |
139 | curries of C<get>. |
28b96142 |
140 | |
141 | =item Helpers that take a coderef of one argument now use C<$_> |
142 | |
143 | Subroutines passed as the first argument to C<first>, C<map>, and C<grep> now |
144 | receive their argument in C<$_> rather than as a parameter to the subroutine. |
145 | Helpers that take a coderef of two or more arguments remain using the argument |
146 | list (there are technical limitations to using C<$a> and C<$b> like C<sort> |
147 | does). |
148 | |
af44c00c |
149 | See L<Moose::Meta::Attribute::Native> for the new documentation. |
a3d98218 |
150 | |
ebaaa391 |
151 | =back |
152 | |
85e2b15a |
153 | The C<alias> and C<excludes> role parameters have been renamed to C<-alias> |
154 | and C<-excludes>. The old names still work, but new code should use the new |
155 | names, and eventually the old ones will be deprecated and removed. |
156 | |
4ada9618 |
157 | =head1 Version 0.89 |
158 | |
8a8856de |
159 | C<< use Moose -metaclass => 'Foo' >> now does alias resolution, just like |
160 | C<-traits> (and the C<metaclass> and C<traits> options to C<has>). |
161 | |
27f2f43f |
162 | Added two functions C<meta_class_alias> and C<meta_attribute_alias> to |
163 | L<Moose::Util>, to simplify aliasing metaclasses and metatraits. This is |
164 | a wrapper around the old |
165 | |
166 | package Moose::Meta::Class::Custom::Trait::FooTrait; |
167 | sub register_implementation { 'My::Meta::Trait' } |
168 | |
169 | way of doing this. |
170 | |
4831e2de |
171 | =head1 Version 0.84 |
172 | |
9f52cce5 |
173 | When an attribute generates I<no> accessors, we now warn. This is to help |
174 | users who forget the C<is> option. If you really do not want any accessors, |
3de02fd8 |
175 | you can use C<< is => 'bare' >>. You can maintain back compat with older |
176 | versions of Moose by using something like: |
177 | |
178 | ($Moose::VERSION >= 0.84 ? is => 'bare' : ()) |
9f52cce5 |
179 | |
180 | When an accessor overwrites an existing method, we now warn. To work around |
181 | this warning (if you really must have this behavior), you can explicitly |
182 | remove the method before creating it as an accessor: |
183 | |
184 | sub foo {} |
185 | |
186 | __PACKAGE__->meta->remove_method('foo'); |
187 | |
188 | has foo => ( |
189 | is => 'ro', |
190 | ); |
191 | |
192 | When an unknown option is passed to C<has>, we now warn. You can silence |
193 | the warning by fixing your code. :) |
194 | |
4831e2de |
195 | The C<Role> type has been deprecated. On its own, it was useless, |
196 | since it just checked C<< $object->can('does') >>. If you were using |
197 | it as a parent type, just call C<role_type('Role::Name')> to create an |
198 | appropriate type instead. |
199 | |
7d6b451f |
200 | =head1 Version 0.78 |
201 | |
202 | C<use Moose::Exporter;> now imports C<strict> and C<warnings> into packages |
203 | that use it. |
204 | |
c3fdacda |
205 | =head1 Version 0.77 |
206 | |
207 | C<DEMOLISHALL> and C<DEMOLISH> now receive an argument indicating whether or |
208 | not we are in global destruction. |
209 | |
00c61603 |
210 | =head1 Version 0.76 |
211 | |
9f0b3b64 |
212 | Type constraints no longer run coercions for a value that already matches the |
213 | constraint. This may affect some (arguably buggy) edge case coercions that |
214 | rely on side effects in the C<via> clause. |
215 | |
f869fc4a |
216 | =head1 Version 0.75 |
217 | |
218 | L<Moose::Exporter> now accepts the C<-metaclass> option for easily |
219 | overriding the metaclass (without L<metaclass>). This works for classes |
220 | and roles. |
221 | |
39ab7714 |
222 | =head1 Version 0.74 |
223 | |
85cf0647 |
224 | Added a C<duck_type> sugar function to L<Moose::Util::TypeConstraints> |
225 | to make integration with non-Moose classes easier. It simply checks if |
226 | C<< $obj->can() >> a list of methods. |
39ab7714 |
227 | |
612fd754 |
228 | A number of methods (mostly inherited from L<Class::MOP>) have been |
229 | renamed with a leading underscore to indicate their internal-ness. The |
230 | old method names will still work for a while, but will warn that the |
231 | method has been renamed. In a few cases, the method will be removed |
232 | entirely in the future. This may affect MooseX authors who were using |
233 | these methods. |
234 | |
600f7f85 |
235 | =head1 Version 0.73 |
236 | |
0f13f53c |
237 | Calling C<subtype> with a name as the only argument now throws an |
600f7f85 |
238 | exception. If you want an anonymous subtype do: |
239 | |
240 | my $subtype = subtype as 'Foo'; |
241 | |
0f13f53c |
242 | This is related to the changes in version 0.71_01. |
600f7f85 |
243 | |
501db4e6 |
244 | The C<is_needed> method in L<Moose::Meta::Method::Destructor> is now |
245 | only usable as a class method. Previously, it worked as a class or |
246 | object method, with a different internal implementation for each |
247 | version. |
248 | |
249 | The internals of making a class immutable changed a lot in Class::MOP |
250 | 0.78_02, and Moose's internals have changed along with it. The |
251 | external C<< $metaclass->make_immutable >> method still works the same |
252 | way. |
253 | |
600f7f85 |
254 | =head1 Version 0.72 |
255 | |
0f13f53c |
256 | A mutable class accepted C<< Foo->new(undef) >> without complaint, |
257 | while an immutable class would blow up with an unhelpful error. Now, |
258 | in both cases we throw a helpful error instead. |
600f7f85 |
259 | |
0f13f53c |
260 | This "feature" was originally added to allow for cases such as this: |
600f7f85 |
261 | |
262 | my $args; |
0f13f53c |
263 | |
264 | if ( something() ) { |
265 | $args = {...}; |
600f7f85 |
266 | } |
0f13f53c |
267 | |
600f7f85 |
268 | return My::Class->new($args); |
269 | |
0f13f53c |
270 | But we decided this is a bad idea and a little too magical, because it |
271 | can easily mask real errors. |
600f7f85 |
272 | |
273 | =head1 Version 0.71_01 |
274 | |
0f13f53c |
275 | Calling C<type> or C<subtype> without the sugar helpers (C<as>, |
276 | C<where>, C<message>) is now deprecated. |
277 | |
278 | As a side effect, this meant we ended up using Perl prototypes on |
279 | C<as>, and code like this will no longer work: |
600f7f85 |
280 | |
281 | use Moose::Util::TypeConstraints; |
282 | use Declare::Constraints::Simple -All; |
0f13f53c |
283 | |
284 | subtype 'ArrayOfInts' |
600f7f85 |
285 | => as 'ArrayRef' |
286 | => IsArrayRef(IsInt); |
287 | |
288 | Instead it must be changed to this: |
289 | |
0f13f53c |
290 | subtype( |
291 | 'ArrayOfInts' => { |
292 | as => 'ArrayRef', |
293 | where => IsArrayRef(IsInt) |
294 | } |
600f7f85 |
295 | ); |
296 | |
0f13f53c |
297 | If you want to maintain backwards compat with older versions of Moose, |
298 | you must explicitly test Moose's C<VERSION>: |
600f7f85 |
299 | |
0f13f53c |
300 | if ( Moose->VERSION < 0.71_01 ) { |
301 | subtype 'ArrayOfInts' |
600f7f85 |
302 | => as 'ArrayRef' |
303 | => IsArrayRef(IsInt); |
304 | } |
305 | else { |
0f13f53c |
306 | subtype( |
307 | 'ArrayOfInts' => { |
308 | as => 'ArrayRef', |
309 | where => IsArrayRef(IsInt) |
310 | } |
600f7f85 |
311 | ); |
312 | } |
313 | |
314 | =head1 Version 0.70 |
315 | |
0f13f53c |
316 | We no longer pass the meta-attribute object as a final argument to |
317 | triggers. This actually changed for inlined code a while back, but the |
318 | non-inlined version and the docs were still out of date. |
319 | |
320 | If by some chance you actually used this feature, the workaround is |
321 | simple. You fetch the attribute object from out of the C<$self> |
322 | that is passed as the first argument to trigger, like so: |
323 | |
324 | has 'foo' => ( |
325 | is => 'ro', |
326 | isa => 'Any', |
327 | trigger => sub { |
328 | my ( $self, $value ) = @_; |
329 | my $attr = $self->meta->find_attribute_by_name('foo'); |
330 | |
331 | # ... |
332 | } |
333 | ); |
600f7f85 |
334 | |
335 | =head1 Version 0.66 |
336 | |
0f13f53c |
337 | If you created a subtype and passed a parent that Moose didn't know |
338 | about, it simply ignored the parent. Now it automatically creates the |
339 | parent as a class type. This may not be what you want, but is less |
340 | broken than before. |
600f7f85 |
341 | |
0f13f53c |
342 | You could declare a name with subtype such as "Foo!Bar". Moose would |
343 | accept this allowed, but if you used it in a parameterized type such |
344 | as "ArrayRef[Foo!Bar]" it wouldn't work. We now do some vetting on |
345 | names created via the sugar functions, so that they can only contain |
346 | alphanumerics, ":", and ".". |
600f7f85 |
347 | |
348 | =head1 Version 0.65 |
349 | |
350 | Methods created via an attribute can now fulfill a C<requires> |
0f13f53c |
351 | declaration for a role. Honestly we don't know why Stevan didn't make |
352 | this work originally, he was just insane or something. |
600f7f85 |
353 | |
0f13f53c |
354 | Stack traces from inlined code will now report the line and file as |
355 | being in your class, as opposed to in Moose guts. |
600f7f85 |
356 | |
357 | =head1 Version 0.62_02 |
358 | |
0f13f53c |
359 | When a class does not provide all of a role's required methods, the |
360 | error thrown now mentions all of the missing methods, as opposed to |
361 | just the first missing method. |
600f7f85 |
362 | |
0f13f53c |
363 | Moose will no longer inline a constructor for your class unless it |
5e26e3f2 |
364 | inherits its constructor from Moose::Object, and will warn when it |
365 | doesn't inline. If you want to force inlining anyway, pass |
b84f64da |
366 | C<< replace_constructor => 1 >> to C<make_immutable>. |
0f13f53c |
367 | |
368 | If you want to get rid of the warning, pass C<< inline_constructor => |
fbf7ba85 |
369 | 0 >>. |
600f7f85 |
370 | |
371 | =head1 Version 0.62 |
372 | |
0f13f53c |
373 | Removed the (deprecated) C<make_immutable> keyword. |
600f7f85 |
374 | |
375 | Removing an attribute from a class now also removes delegation |
0f13f53c |
376 | (C<handles>) methods installed for that attribute. This is correct |
600f7f85 |
377 | behavior, but if you were wrongly relying on it you might get bit. |
378 | |
379 | =head1 Version 0.58 |
380 | |
0f13f53c |
381 | Roles now add methods by calling C<add_method>, not |
382 | C<alias_method>. They make sure to always provide a method object, |
383 | which will be cloned internally. This means that it is now possible to |
384 | track the source of a method provided by a role, and even follow its |
385 | history through intermediate roles. This means that methods added by |
386 | a role now show up when looking at a class's method list/map. |
387 | |
388 | Parameter and Union args are now sorted, this makes Int|Str the same |
389 | constraint as Str|Int. Also, incoming type constraint strings are |
390 | normalized to remove all whitespace differences. This is mostly for |
391 | internals and should not affect outside code. |
392 | |
393 | L<Moose::Exporter> will no longer remove a subroutine that the |
394 | exporting package re-exports. Moose re-exports the Carp::confess |
395 | function, among others. The reasoning is that we cannot know whether |
396 | you have also explicitly imported those functions for your own use, so |
397 | we err on the safe side and always keep them. |
600f7f85 |
398 | |
399 | =head1 Version 0.56 |
400 | |
0f13f53c |
401 | C<Moose::init_meta> should now be called as a method. |
600f7f85 |
402 | |
0f13f53c |
403 | New modules for extension writers, L<Moose::Exporter> and |
404 | L<Moose::Util::MetaRole>. |
600f7f85 |
405 | |
406 | =head1 Version 0.55_01 |
407 | |
408 | Implemented metaclass traits (and wrote a recipe for it): |
409 | |
410 | use Moose -traits => 'Foo' |
411 | |
412 | This should make writing small Moose extensions a little |
413 | easier. |
414 | |
415 | =head1 Version 0.55 |
416 | |
417 | Fixed C<coerce> to accept anon types just like C<subtype> can. |
418 | So that you can do: |
419 | |
420 | coerce $some_anon_type => from 'Str' => via { ... }; |
421 | |
422 | =head1 Version 0.51 |
423 | |
52da380a |
424 | Added C<BUILDARGS>, a new step in C<< Moose::Object->new() >>. |
600f7f85 |
425 | |
426 | =head1 Version 0.49 |
427 | |
0f13f53c |
428 | Fixed how the C<< is => (ro|rw) >> works with custom defined |
429 | C<reader>, C<writer> and C<accessor> options. See the below table for |
600f7f85 |
430 | details: |
431 | |
432 | is => ro, writer => _foo # turns into (reader => foo, writer => _foo) |
433 | is => rw, writer => _foo # turns into (reader => foo, writer => _foo) |
434 | is => rw, accessor => _foo # turns into (accessor => _foo) |
435 | is => ro, accessor => _foo # error, accesor is rw |
436 | |
437 | =head1 Version 0.45 |
438 | |
0f13f53c |
439 | The C<before/around/after> method modifiers now support regexp |
440 | matching of method names. NOTE: this only works for classes, it is |
441 | currently not supported in roles, but, ... patches welcome. |
600f7f85 |
442 | |
0f13f53c |
443 | The C<has> keyword for roles now accepts the same array ref form that |
444 | L<Moose>.pm does for classes. |
600f7f85 |
445 | |
0f13f53c |
446 | A trigger on a read-only attribute is no longer an error, as it's |
447 | useful to trigger off of the constructor. |
600f7f85 |
448 | |
0f13f53c |
449 | Subtypes of parameterizable types now are parameterizable types |
450 | themselves. |
600f7f85 |
451 | |
452 | =head1 Version 0.44 |
453 | |
0f13f53c |
454 | Fixed issue where C<DEMOLISHALL> was eating the value in C<$@>, and so |
455 | not working correctly. It still kind of eats them, but so does vanilla |
456 | perl. |
600f7f85 |
457 | |
458 | =head1 Version 0.41 |
459 | |
0f13f53c |
460 | Inherited attributes may now be extended without restriction on the |
600f7f85 |
461 | type ('isa', 'does'). |
462 | |
0f13f53c |
463 | The entire set of Moose::Meta::TypeConstraint::* classes were |
464 | refactored in this release. If you were relying on their internals you |
465 | should test your code carefully. |
600f7f85 |
466 | |
467 | =head1 Version 0.40 |
468 | |
0f13f53c |
469 | Documenting the use of '+name' with attributes that come from recently |
470 | composed roles. It makes sense, people are using it, and so why not |
471 | just officially support it. |
600f7f85 |
472 | |
0f13f53c |
473 | The C<< Moose::Meta::Class->create >> method now supports roles. |
600f7f85 |
474 | |
86b96832 |
475 | It is now possible to make anonymous enum types by passing C<enum> an |
476 | array reference instead of the C<< enum $name => @values >>. |
600f7f85 |
477 | |
478 | =head1 Version 0.37 |
479 | |
0f13f53c |
480 | Added the C<make_immutable> keyword as a shortcut to calling |
481 | C<make_immutable> on the meta object. This eventually got removed! |
600f7f85 |
482 | |
0f13f53c |
483 | Made C<< init_arg => undef >> work in Moose. This means "do not accept |
600f7f85 |
484 | a constructor parameter for this attribute". |
485 | |
0f13f53c |
486 | Type errors now use the provided message. Prior to this release they |
487 | didn't. |
600f7f85 |
488 | |
489 | =head1 Version 0.34 |
490 | |
491 | Moose is now a postmodern object system :) |
492 | |
0f13f53c |
493 | The Role system was completely refactored. It is 100% backwards |
494 | compat, but the internals were totally changed. If you relied on the |
495 | internals then you are advised to test carefully. |
600f7f85 |
496 | |
497 | Added method exclusion and aliasing for Roles in this release. |
498 | |
0f13f53c |
499 | Added the L<Moose::Util::TypeConstraints::OptimizedConstraints> |
500 | module. |
600f7f85 |
501 | |
0f13f53c |
502 | Passing a list of values to an accessor (which is only expecting one |
503 | value) used to be silently ignored, now it throws an error. |
600f7f85 |
504 | |
505 | =head1 Version 0.26 |
506 | |
0f13f53c |
507 | Added parameterized types and did a pretty heavy refactoring of the |
508 | type constraint system. |
600f7f85 |
509 | |
0f13f53c |
510 | Better framework extendability and better support for "making your own |
511 | Moose". |
600f7f85 |
512 | |
513 | =head1 Version 0.25 or before |
514 | |
0f13f53c |
515 | Honestly, you shouldn't be using versions of Moose that are this old, |
516 | so many bug fixes and speed improvements have been made you would be |
517 | crazy to not upgrade. |
600f7f85 |
518 | |
0f13f53c |
519 | Also, I am tired of going through the Changelog so I am stopping here, |
520 | if anyone would like to continue this please feel free. |
600f7f85 |
521 | |
522 | =head1 AUTHOR |
523 | |
524 | Stevan Little E<lt>stevan@iinteractive.comE<gt> |
525 | |
526 | =head1 COPYRIGHT AND LICENSE |
527 | |
528 | Copyright 2009 by Infinity Interactive, Inc. |
529 | |
530 | L<http://www.iinteractive.com> |
531 | |
532 | This library is free software; you can redistribute it and/or modify |
533 | it under the same terms as Perl itself. |
534 | |
0f13f53c |
535 | =cut |