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