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