763e748dff91aff568ddebe14171faf0141afb65
[gitmo/Moose.git] / lib / Moose / Manual / Delta.pod
1 package Moose::Manual::Delta;
2
3 # ABSTRACT: Important Changes in Moose
4
5 __END__
6
7 =pod
8
9 =head1 DESCRIPTION
10
11 This documents any important or noteworthy changes in Moose, with a
12 focus on things that affect backwards compatibility. This does duplicate data
13 from the F<Changes> file, but aims to provide more details and when possible
14 workarounds.
15
16 Besides helping keep up with changes, you can also use this document
17 for finding the lowest version of Moose that supported a given
18 feature.  If you encounter a problem and have a solution but don't see
19 it documented here, or think we missed an important feature, please
20 send us a patch.
21
22 =head1 2.0300
23
24 =over 4
25
26 =item The parent of a union type is its components' nearest common ancestor
27
28 Previously, union types considered all of their component types their parent
29 types. This was incorrect because parent types are defined as types that must
30 be satisfied in order for the child type to be satisfied, but in a union,
31 validating as any parent type will validate against the entire union. This has
32 been changed to find the nearest common ancestor for all of its components. For
33 example, a union of "Int|ArrayRef[Int]" now has a parent of "Defined".
34
35 =item Union types consider all members in the C<is_subtype_of> and C<is_a_type_of> methods
36
37 Previously, a union type would report itself as being of a subtype of a type if
38 I<any> of its member types were subtypes of that type. This was incorrect
39 because any value that passes a subtype constraint must also pass a parent
40 constraint. This has changed so that I<all> of its member types must be a
41 subtype of the specified type.
42
43 =item Methods defined in UNIVERSAL now appear in the MOP
44
45 Any method introspection methods that look at methods from parent classes now
46 find methods defined in UNIVERSAL. This includes methods like C<<
47 $class->get_all_methods >> and C<< $class->find_method_by_name >>.
48
49 This also means that you can now apply method modifiers to these methods.
50
51 =item Hand-optimized type constraint code causes a deprecation warning
52
53 If you provide an optimized sub ref for a type constraint, this now causes a
54 deprecation warning. Typically, this comes from passing an C<optimize_as>
55 parameter to C<subtype>, but it could also happen if you create a
56 L<Moose::Meta::TypeConstraint> object directly.
57
58 Use the inlining feature (C<inline_as>) added in 2.0100 instead.
59
60 =back
61
62 =head1 2.0205
63
64 =over 4
65
66 =item Array and Hash native traits provide a C<shallow_clone> method
67
68 The Array and Hash native traits now provide a "shallow_clone" method, which
69 will return a reference to a new container with the same contents as the
70 attribute's reference.
71
72 =back
73
74 =head1 2.0100
75
76 =over 4
77
78 =item Hand-optimized type constraint code is deprecated in favor of inlining
79
80 Moose allows you to provide a hand-optimized version of a type constraint's
81 subroutine reference. This version allows type constraints to generate inline
82 code, and you should use this inlining instead of providing a hand-optimized
83 subroutine reference.
84
85 This affects the C<optimize_as> sub exported by
86 L<Moose::Util::TypeConstraints>. Use C<inline_as> instead.
87
88 This will start warning in the 2.0300 release.
89
90 =back
91
92 =head1 2.0002
93
94 =over 4
95
96 =item More useful type constraint error messages
97
98 If you have L<Devel::PartialDump> version 0.14 or higher installed, Moose's
99 type constraint error messages will use it to display the invalid value, rather
100 than just displaying it directly. This will generally be much more useful. For
101 instance, instead of this:
102
103   Attribute (foo) does not pass the type constraint because: Validation failed for 'ArrayRef[Int]' with value ARRAY(0x275eed8)
104
105 the error message will instead look like
106
107   Attribute (foo) does not pass the type constraint because: Validation failed for 'ArrayRef[Int]' with value [ "a" ]
108
109 Note that L<Devel::PartialDump> can't be made a direct dependency at the
110 moment, because it uses Moose itself, but we're considering options to make
111 this easier.
112
113 =back
114
115 =head1 2.0000
116
117 =over 4
118
119 =item Roles have their own default attribute metaclass
120
121 Previously, when a role was applied to a class, it would use the attribute
122 metaclass defined in the class when copying over the attributes in the role.
123 This was wrong, because for instance, using L<MooseX::FollowPBP> in the class
124 would end up renaming all of the accessors generated by the role, some of which
125 may be being called in the role, causing it to break. Roles now keep track of
126 their own attribute metaclass to use by default when being applied to a class
127 (defaulting to Moose::Meta::Attribute). This is modifiable using
128 L<Moose::Util::MetaRole> by passing the C<applied_attribute> key to the
129 C<role_metaroles> option, as in:
130
131     Moose::Util::MetaRole::apply_metaroles(
132         for => __PACKAGE__,
133         class_metaroles => {
134             attribute => ['My::Meta::Role::Attribute'],
135         },
136         role_metaroles => {
137             applied_attribute => ['My::Meta::Role::Attribute'],
138         },
139     );
140
141 =item Class::MOP has been folded into the Moose dist
142
143 Moose and Class::MOP are tightly related enough that they have always had to be
144 kept pretty closely in step in terms of versions. Making them into a single
145 dist should simplify the upgrade process for users, as it should no longer be
146 possible to upgrade one without the other and potentially cause issues. No
147 functionality has changed, and this should be entirely transparent.
148
149 =item Moose's conflict checking is more robust and useful
150
151 There are two parts to this. The most useful one right now is that Moose will
152 ship with a C<moose-outdated> script, which can be run at any point to list the
153 modules which are installed that conflict with the installed version of Moose.
154 After upgrading Moose, running C<moose-outdated | cpanm> should be sufficient
155 to ensure that all of the Moose extensions you use will continue to work.
156
157 The other part is that Moose's C<META.json> file will also specify the
158 conflicts under the C<x_conflicts> key. We are working with the Perl tool chain
159 developers to try to get conflicts support added to CPAN clients, and if/when
160 that happens, the metadata already exists, and so the conflict checking will
161 become automatic.
162
163 =item Most deprecated APIs/features are slated for removal in Moose 2.0200
164
165 Most of the deprecated APIs and features in Moose will start throwing an error
166 in Moose 2.0200. Some of the features will go away entirely, and some will
167 simply throw an error.
168
169 The things on the chopping block are:
170
171 =over 8
172
173 =item * Old public methods in Class::MOP and Moose
174
175 This includes things like C<< Class::MOP::Class->get_attribute_map >>, C<<
176 Class::MOP::Class->construct_instance >>, and many others. These were
177 deprecated in L<Class::MOP> 0.80_01, released on April 5, 2009.
178
179 These methods will be removed entirely in Moose 2.0200.
180
181 =item * Old public functions in Class::MOP
182
183 This include C<Class::MOP::subname>, C<Class::MOP::in_global_destruction>, and
184 the C<Class::MOP::HAS_ISAREV> constant. The first two were deprecated in 0.84,
185 and the last in 0.80. Class::MOP 0.84 was released on May 12, 2009.
186
187 These functions will be removed entirely in Moose 2.0200.
188
189 =item * The C<alias> and C<excludes> option for role composition
190
191 These were renamed to C<-alias> and C<-excludes> in Moose 0.89, released on
192 August 13, 2009.
193
194 Passing these will throw an error in Moose 2.0200.
195
196 =item * The old L<Moose::Util::MetaRole> API
197
198 This include the C<apply_metaclass_roles()> function, as well as passing the
199 C<for_class> or any key ending in C<_roles> to C<apply_metaroles()>. This was
200 deprecated in Moose 0.93_01, released on January 4, 2010.
201
202 These will all throw an error in Moose 2.0200.
203
204 =item * Passing plain lists to C<type()> or C<subtype()>
205
206 The old API for these functions allowed you to pass a plain list of parameter,
207 rather than a list of hash references (which is what C<as()>, C<where>,
208 etc. return). This was deprecated in Moose 0.71_01, released on February 22,
209 2009.
210
211 This will throw an error in Moose 2.0200.
212
213 =item * The Role subtype
214
215 This subtype was deprecated in Moose 0.84, released on June 26, 2009.
216
217 This will be removed entirely in Moose 2.0200.
218
219 =back
220
221 =back
222
223 =head1 1.21
224
225 =over 4
226
227 =item * New release policy
228
229 As of the 2.0 release, Moose now has an official release and support policy,
230 documented in L<Moose::Manual::Support>. All API changes will now go through a
231 deprecation cycle of at least one year, after which the deprecated API can be
232 removed. Deprecations and removals will only happen in major releases.
233
234 In between major releases, we will still make minor releases to add new
235 features, fix bugs, update documentation, etc.
236
237 =back
238
239 =head1 1.16
240
241 =over 4
242
243 =item Configurable stacktraces
244
245 Classes which use the L<Moose::Error::Default> error class can now have
246 stacktraces disabled by setting the C<MOOSE_ERROR_STYLE> env var to C<croak>.
247 This is experimental, fairly incomplete, and won't work in all cases (because
248 Moose's error system in general is all of these things), but this should allow
249 for reducing at least some of the verbosity in most cases.
250
251 =back
252
253 =head1 1.15
254
255 =over 4
256
257 =item Native Delegations
258
259 In previous versions of Moose, the Native delegations were created as
260 closures. The generated code was often quite slow compared to doing the same
261 thing by hand. For example, the Array's push delegation ended up doing
262 something like this:
263
264   push @{ $self->$reader() }, @_;
265
266 If the attribute was created without a reader, the C<$reader> sub reference
267 followed a very slow code path. Even with a reader, this is still slower than
268 it needs to be.
269
270 Native delegations are now generated as inline code, just like other
271 accessors, so we can access the slot directly.
272
273 In addition, native traits now do proper constraint checking in all cases. In
274 particular, constraint checking has been improved for array and hash
275 references. Previously, only the I<contained> type (the C<Str> in
276 C<HashRef[Str]>) would be checked when a new value was added to the
277 collection. However, if there was a constraint that applied to the whole
278 value, this was never checked.
279
280 In addition, coercions are now called on the whole value.
281
282 The delegation methods now do more argument checking. All of the methods check
283 that a valid number of arguments were passed to the method. In addition, the
284 delegation methods check that the arguments are sane (array indexes, hash
285 keys, numbers, etc.) when applicable. We have tried to emulate the behavior of
286 Perl builtins as much as possible.
287
288 Finally, triggers are called whenever the value of the attribute is changed by
289 a Native delegation.
290
291 These changes are only likely to break code in a few cases.
292
293 The inlining code may or may not preserve the original reference when changes
294 are made. In some cases, methods which change the value may replace it
295 entirely. This will break tied values.
296
297 If you have a typed arrayref or hashref attribute where the type enforces a
298 constraint on the whole collection, this constraint will now be checked. It's
299 possible that code which previously ran without errors will now cause the
300 constraint to fail. However, presumably this is a good thing ;)
301
302 If you are passing invalid arguments to a delegation which were previously
303 being ignored, these calls will now fail.
304
305 If your code relied on the trigger only being called for a regular writer,
306 that may cause problems.
307
308 As always, you are encouraged to test before deploying the latest version of
309 Moose to production.
310
311 =item Defaults is and default for String, Counter, and Bool
312
313 A few native traits (String, Counter, Bool) provide default values of "is" and
314 "default" when you created an attribute. Allowing them to provide these values
315 is now deprecated. Supply the value yourself when creating the attribute.
316
317 =item The C<meta> method
318
319 Moose and Class::MOP have been cleaned up internally enough to make the
320 C<meta> method that you get by default optional. C<use Moose> and
321 C<use Moose::Role> now can take an additional C<-meta_name> option, which
322 tells Moose what name to use when installing the C<meta> method. Passing
323 C<undef> to this option suppresses generation of the C<meta> method
324 entirely. This should be useful for users of modules which also use a C<meta>
325 method or function, such as L<Curses> or L<Rose::DB::Object>.
326
327 =back
328
329 =head1 1.09
330
331 =over 4
332
333 =item All deprecated features now warn
334
335 Previously, deprecation mostly consisted of simply saying "X is deprecated" in
336 the Changes file. We were not very consistent about actually warning. Now, all
337 deprecated features still present in Moose actually give a warning. The
338 warning is issued once per calling package. See L<Moose::Deprecated> for more
339 details.
340
341 =item You cannot pass C<< coerce => 1 >> unless the attribute's type constraint has a coercion
342
343 Previously, this was accepted, and it sort of worked, except that if you
344 attempted to set the attribute after the object was created, you would get a
345 runtime error.
346
347 Now you will get a warning when you attempt to define the attribute.
348
349 =item C<no Moose>, C<no Moose::Role>, and C<no Moose::Exporter> no longer unimport strict and warnings
350
351 This change was made in 1.05, and has now been reverted. We don't know if the
352 user has explicitly loaded strict or warnings on their own, and unimporting
353 them is just broken in that case.
354
355 =item Reversed logic when defining which options can be changed
356
357 L<Moose::Meta::Attribute> now allows all options to be changed in an
358 overridden attribute. The previous behaviour required each option to be
359 whitelisted using the C<legal_options_for_inheritance> method. This method has
360 been removed, and there is a new method, C<illegal_options_for_inheritance>,
361 which can now be used to prevent certain options from being changeable.
362
363 In addition, we only throw an error if the illegal option is actually
364 changed. If the superclass didn't specify this option at all when defining the
365 attribute, the subclass version can still add it as an option.
366
367 Example of overriding this in an attribute trait:
368
369   package Bar::Meta::Attribute;
370   use Moose::Role;
371
372   has 'my_illegal_option' => (
373       isa => 'CodeRef',
374       is  => 'rw',
375   );
376
377   around illegal_options_for_inheritance => sub {
378       return ( shift->(@_), qw/my_illegal_option/ );
379   };
380
381 =back
382
383 =head1 1.05
384
385 =over 4
386
387 =item L<Moose::Object/BUILD> methods are now called when calling C<new_object>
388
389 Previously, C<BUILD> methods would only be called from C<Moose::Object::new>,
390 but now they are also called when constructing an object via
391 C<Moose::Meta::Class::new_object>. C<BUILD> methods are an inherent part of the
392 object construction process, and this should make C<< $meta->new_object >>
393 actually usable without forcing people to use C<< $meta->name->new >>.
394
395 =item C<no Moose>, C<no Moose::Role>, and C<no Moose::Exporter> now unimport strict and warnings
396
397 In the interest of having C<no Moose> clean up everything that C<use Moose>
398 does in the calling scope, C<no Moose> (as well as all other
399 L<Moose::Exporter>-using modules) now unimports strict and warnings.
400
401 =item Metaclass compatibility checking and fixing should be much more robust
402
403 The L<metaclass compatibility|Moose/METACLASS COMPATIBILITY AND MOOSE> checking
404 and fixing algorithms have been completely rewritten, in both Class::MOP and
405 Moose. This should resolve many confusing errors when dealing with non-Moose
406 inheritance and with custom metaclasses for things like attributes,
407 constructors, etc. For correct code, the only thing that should require a
408 change is that custom error metaclasses must now inherit from
409 L<Moose::Error::Default>.
410
411 =back
412
413 =head1 1.02
414
415 =over 4
416
417 =item Moose::Meta::TypeConstraint::Class is_subtype_of behavior
418
419 Earlier versions of L<is_subtype_of|Moose::Meta::TypeConstraint::Class/is_subtype_of>
420 would incorrectly return true when called with itself, its own TC name or
421 its class name as an argument. (i.e. $foo_tc->is_subtype_of('Foo') == 1) This
422 behavior was a caused by C<isa> being checked before the class name. The old
423 behavior can be accessed with L<is_type_of|Moose::Meta::TypeConstraint::Class/is_type_of>
424
425 =back
426
427 =head1 1.00
428
429 =over 4
430
431 =item Moose::Meta::Attribute::Native::Trait::Code no longer creates reader methods by default
432
433 Earlier versions of L<Moose::Meta::Attribute::Native::Trait::Code> created
434 read-only accessors for the attributes it's been applied to, even if you didn't
435 ask for it with C<< is => 'ro' >>. This incorrect behaviour has now been fixed.
436
437 =back
438
439 =head1 0.95
440
441 =over 4
442
443 =item Moose::Util add_method_modifier behavior
444
445 add_method_modifier (and subsequently the sugar functions Moose::before,
446 Moose::after, and Moose::around) can now accept arrayrefs, with the same
447 behavior as lists. Types other than arrayref and regexp result in an error.
448
449 =back
450
451 =head1 0.93_01 and 0.94
452
453 =over 4
454
455 =item Moose::Util::MetaRole API has changed
456
457 The C<apply_metaclass_roles> function is now called C<apply_metaroles>. The
458 way arguments are supplied has been changed to force you to distinguish
459 between metaroles applied to L<Moose::Meta::Class> (and helpers) versus
460 L<Moose::Meta::Role>.
461
462 The old API still works, but will warn in a future release, and eventually be
463 removed.
464
465 =item Moose::Meta::Role has real attributes
466
467 The attributes returned by L<Moose::Meta::Role> are now instances of the
468 L<Moose::Meta::Role::Attribute> class, instead of bare hash references.
469
470 =item "no Moose" now removes C<blessed> and C<confess>
471
472 Moose is now smart enough to know exactly what it exported, even when it
473 re-exports functions from other packages. When you unimport Moose, it will
474 remove these functions from your namespace unless you I<also> imported them
475 directly from their respective packages.
476
477 If you have a C<no Moose> in your code I<before> you call C<blessed> or
478 C<confess>, your code will break. You can either move the C<no Moose> call
479 later in your code, or explicitly import the relevant functions from the
480 packages that provide them.
481
482 =item L<Moose::Exporter> is smarter about unimporting re-exports
483
484 The change above comes from a general improvement to L<Moose::Exporter>. It
485 will now unimport any function it exports, even if that function is a
486 re-export from another package.
487
488 =item Attributes in roles can no longer override class attributes with "+foo"
489
490 Previously, this worked more or less accidentally, because role attributes
491 weren't objects. This was never documented, but a few MooseX modules took
492 advantage of this.
493
494 =item The composition_class_roles attribute in L<Moose::Meta::Role> is now a method
495
496 This was done to make it possible for roles to alter the the list of
497 composition class roles by applying a method modifiers. Previously, this was
498 an attribute and MooseX modules override it. Since that no longer works, this
499 was made a method.
500
501 This I<should> be an attribute, so this may switch back to being an attribute
502 in the future if we can figure out how to make this work.
503
504 =back
505
506 =head1 0.93
507
508 =over 4
509
510 =item Calling $object->new() is no longer deprecated
511
512 We decided to undeprecate this. Now it just works.
513
514 =item Both C<get_method_map> and C<get_attribute_map> is deprecated
515
516 These metaclass methods were never meant to be public, and they are both now
517 deprecated. The work around if you still need the functionality they provided
518 is to iterate over the list of names manually.
519
520     my %fields = map { $_ => $meta->get_attribute($_) } $meta->get_attribute_list;
521
522 This was actually a change in L<Class::MOP>, but this version of Moose
523 requires a version of L<Class::MOP> that includes said change.
524
525 =back
526
527 =head1 0.90
528
529 =over 4
530
531 =item Added Native delegation for Code refs
532
533 See L<Moose::Meta::Attribute::Native::Trait::Code> for details.
534
535 =item Calling $object->new() is deprecated
536
537 Moose has long supported this, but it's never really been documented, and we
538 don't think this is a good practice. If you want to construct an object from
539 an existing object, you should provide some sort of alternate constructor like
540 C<< $object->clone >>.
541
542 Calling C<< $object->new >> now issues a warning, and will be an error in a
543 future release.
544
545 =item Moose no longer warns if you call C<make_immutable> for a class with mutable ancestors
546
547 While in theory this is a good thing to warn about, we found so many
548 exceptions to this that doing this properly became quite problematic.
549
550 =back
551
552 =head1 0.89_02
553
554 =over 4
555
556 =item New Native delegation methods from L<List::Util> and L<List::MoreUtils>
557
558 In particular, we now have C<reduce>, C<shuffle>, C<uniq>, and C<natatime>.
559
560 =item The Moose::Exporter with_caller feature is now deprecated
561
562 Use C<with_meta> instead. The C<with_caller> option will start warning in a
563 future release.
564
565 =item Moose now warns if you call C<make_immutable> for a class with mutable ancestors
566
567 This is dangerous because modifying a class after a subclass has been
568 immutabilized will lead to incorrect results in the subclass, due to inlining,
569 caching, etc. This occasionally happens accidentally, when a class loads one
570 of its subclasses in the middle of its class definition, so pointing out that
571 this may cause issues should be helpful. Metaclasses (classes that inherit
572 from L<Class::MOP::Object>) are currently exempt from this check, since at the
573 moment we aren't very consistent about which metaclasses we immutabilize.
574
575 =item C<enum> and C<duck_type> now take arrayrefs for all forms
576
577 Previously, calling these functions with a list would take the first element of
578 the list as the type constraint name, and use the remainder as the enum values
579 or method names. This makes the interface inconsistent with the anon-type forms
580 of these functions (which must take an arrayref), and a free-form list where
581 the first value is sometimes special is hard to validate (and harder to give
582 reasonable error messages for). These functions have been changed to take
583 arrayrefs in all their forms - so, C<< enum 'My::Type' => [qw(foo bar)] >> is
584 now the preferred way to create an enum type constraint. The old syntax still
585 works for now, but it will hopefully be deprecated and removed in a future
586 release.
587
588 =back
589
590 =head1 0.89_01
591
592 L<Moose::Meta::Attribute::Native> has been moved into the Moose core from
593 L<MooseX::AttributeHelpers>.  Major changes include:
594
595 =over 4
596
597 =item C<traits>, not C<metaclass>
598
599 Method providers are only available via traits.
600
601 =item C<handles>, not C<provides> or C<curries>
602
603 The C<provides> syntax was like core Moose C<< handles => HASHREF >>
604 syntax, but with the keys and values reversed.  This was confusing,
605 and AttributeHelpers now uses C<< handles => HASHREF >> in a way that
606 should be intuitive to anyone already familiar with how it is used for
607 other attributes.
608
609 The C<curries> functionality provided by AttributeHelpers has been
610 generalized to apply to all cases of C<< handles => HASHREF >>, though
611 not every piece of functionality has been ported (currying with a
612 CODEREF is not supported).
613
614 =item C<empty> is now C<is_empty>, and means empty, not non-empty
615
616 Previously, the C<empty> method provided by Arrays and Hashes returned true if
617 the attribute was B<not> empty (no elements).  Now it returns true if the
618 attribute B<is> empty. It was also renamed to C<is_empty>, to reflect this.
619
620 =item C<find> was renamed to C<first>, and C<first> and C<last> were removed
621
622 L<List::Util> refers to the functionality that we used to provide under C<find>
623 as L<first|List::Util/first>, so that will likely be more familiar (and will
624 fit in better if we decide to add more List::Util functions). C<first> and
625 C<last> were removed, since their functionality is easily duplicated with
626 curries of C<get>.
627
628 =item Helpers that take a coderef of one argument now use C<$_>
629
630 Subroutines passed as the first argument to C<first>, C<map>, and C<grep> now
631 receive their argument in C<$_> rather than as a parameter to the subroutine.
632 Helpers that take a coderef of two or more arguments remain using the argument
633 list (there are technical limitations to using C<$a> and C<$b> like C<sort>
634 does).
635
636 See L<Moose::Meta::Attribute::Native> for the new documentation.
637
638 =back
639
640 The C<alias> and C<excludes> role parameters have been renamed to C<-alias>
641 and C<-excludes>. The old names still work, but new code should use the new
642 names, and eventually the old ones will be deprecated and removed.
643
644 =head1 0.89
645
646 C<< use Moose -metaclass => 'Foo' >> now does alias resolution, just like
647 C<-traits> (and the C<metaclass> and C<traits> options to C<has>).
648
649 Added two functions C<meta_class_alias> and C<meta_attribute_alias> to
650 L<Moose::Util>, to simplify aliasing metaclasses and metatraits. This is
651 a wrapper around the old
652
653   package Moose::Meta::Class::Custom::Trait::FooTrait;
654   sub register_implementation { 'My::Meta::Trait' }
655
656 way of doing this.
657
658 =head1 0.84
659
660 When an attribute generates I<no> accessors, we now warn. This is to help
661 users who forget the C<is> option. If you really do not want any accessors,
662 you can use C<< is => 'bare' >>. You can maintain back compat with older
663 versions of Moose by using something like:
664
665     ($Moose::VERSION >= 0.84 ? is => 'bare' : ())
666
667 When an accessor overwrites an existing method, we now warn. To work around
668 this warning (if you really must have this behavior), you can explicitly
669 remove the method before creating it as an accessor:
670
671     sub foo {}
672
673     __PACKAGE__->meta->remove_method('foo');
674
675     has foo => (
676         is => 'ro',
677     );
678
679 When an unknown option is passed to C<has>, we now warn. You can silence
680 the warning by fixing your code. :)
681
682 The C<Role> type has been deprecated. On its own, it was useless,
683 since it just checked C<< $object->can('does') >>. If you were using
684 it as a parent type, just call C<role_type('Role::Name')> to create an
685 appropriate type instead.
686
687 =head1 0.78
688
689 C<use Moose::Exporter;> now imports C<strict> and C<warnings> into packages
690 that use it.
691
692 =head1 0.77
693
694 C<DEMOLISHALL> and C<DEMOLISH> now receive an argument indicating whether or
695 not we are in global destruction.
696
697 =head1 0.76
698
699 Type constraints no longer run coercions for a value that already matches the
700 constraint.  This may affect some (arguably buggy) edge case coercions that
701 rely on side effects in the C<via> clause.
702
703 =head1 0.75
704
705 L<Moose::Exporter> now accepts the C<-metaclass> option for easily
706 overriding the metaclass (without L<metaclass>). This works for classes
707 and roles.
708
709 =head1 0.74
710
711 Added a C<duck_type> sugar function to L<Moose::Util::TypeConstraints>
712 to make integration with non-Moose classes easier. It simply checks if
713 C<< $obj->can() >> a list of methods.
714
715 A number of methods (mostly inherited from L<Class::MOP>) have been
716 renamed with a leading underscore to indicate their internal-ness. The
717 old method names will still work for a while, but will warn that the
718 method has been renamed. In a few cases, the method will be removed
719 entirely in the future. This may affect MooseX authors who were using
720 these methods.
721
722 =head1 0.73
723
724 Calling C<subtype> with a name as the only argument now throws an
725 exception. If you want an anonymous subtype do:
726
727     my $subtype = subtype as 'Foo';
728
729 This is related to the changes in version 0.71_01.
730
731 The C<is_needed> method in L<Moose::Meta::Method::Destructor> is now
732 only usable as a class method. Previously, it worked as a class or
733 object method, with a different internal implementation for each
734 version.
735
736 The internals of making a class immutable changed a lot in Class::MOP
737 0.78_02, and Moose's internals have changed along with it. The
738 external C<< $metaclass->make_immutable >> method still works the same
739 way.
740
741 =head1 0.72
742
743 A mutable class accepted C<< Foo->new(undef) >> without complaint,
744 while an immutable class would blow up with an unhelpful error. Now,
745 in both cases we throw a helpful error instead.
746
747 This "feature" was originally added to allow for cases such as this:
748
749   my $args;
750
751   if ( something() ) {
752       $args = {...};
753   }
754
755   return My::Class->new($args);
756
757 But we decided this is a bad idea and a little too magical, because it
758 can easily mask real errors.
759
760 =head1 0.71_01
761
762 Calling C<type> or C<subtype> without the sugar helpers (C<as>,
763 C<where>, C<message>) is now deprecated.
764
765 As a side effect, this meant we ended up using Perl prototypes on
766 C<as>, and code like this will no longer work:
767
768   use Moose::Util::TypeConstraints;
769   use Declare::Constraints::Simple -All;
770
771   subtype 'ArrayOfInts'
772       => as 'ArrayRef'
773       => IsArrayRef(IsInt);
774
775 Instead it must be changed to this:
776
777   subtype(
778       'ArrayOfInts' => {
779           as    => 'ArrayRef',
780           where => IsArrayRef(IsInt)
781       }
782   );
783
784 If you want to maintain backwards compat with older versions of Moose,
785 you must explicitly test Moose's C<VERSION>:
786
787   if ( Moose->VERSION < 0.71_01 ) {
788       subtype 'ArrayOfInts'
789           => as 'ArrayRef'
790           => IsArrayRef(IsInt);
791   }
792   else {
793       subtype(
794           'ArrayOfInts' => {
795               as    => 'ArrayRef',
796               where => IsArrayRef(IsInt)
797           }
798       );
799   }
800
801 =head1 0.70
802
803 We no longer pass the meta-attribute object as a final argument to
804 triggers. This actually changed for inlined code a while back, but the
805 non-inlined version and the docs were still out of date.
806
807 If by some chance you actually used this feature, the workaround is
808 simple. You fetch the attribute object from out of the C<$self>
809 that is passed as the first argument to trigger, like so:
810
811   has 'foo' => (
812       is      => 'ro',
813       isa     => 'Any',
814       trigger => sub {
815           my ( $self, $value ) = @_;
816           my $attr = $self->meta->find_attribute_by_name('foo');
817
818           # ...
819       }
820   );
821
822 =head1 0.66
823
824 If you created a subtype and passed a parent that Moose didn't know
825 about, it simply ignored the parent. Now it automatically creates the
826 parent as a class type. This may not be what you want, but is less
827 broken than before.
828
829 You could declare a name with subtype such as "Foo!Bar". Moose would
830 accept this allowed, but if you used it in a parameterized type such
831 as "ArrayRef[Foo!Bar]" it wouldn't work. We now do some vetting on
832 names created via the sugar functions, so that they can only contain
833 alphanumerics, ":", and ".".
834
835 =head1 0.65
836
837 Methods created via an attribute can now fulfill a C<requires>
838 declaration for a role. Honestly we don't know why Stevan didn't make
839 this work originally, he was just insane or something.
840
841 Stack traces from inlined code will now report the line and file as
842 being in your class, as opposed to in Moose guts.
843
844 =head1 0.62_02
845
846 When a class does not provide all of a role's required methods, the
847 error thrown now mentions all of the missing methods, as opposed to
848 just the first missing method.
849
850 Moose will no longer inline a constructor for your class unless it
851 inherits its constructor from Moose::Object, and will warn when it
852 doesn't inline. If you want to force inlining anyway, pass
853 C<< replace_constructor => 1 >> to C<make_immutable>.
854
855 If you want to get rid of the warning, pass C<< inline_constructor =>
856 0 >>.
857
858 =head1 0.62
859
860 Removed the (deprecated) C<make_immutable> keyword.
861
862 Removing an attribute from a class now also removes delegation
863 (C<handles>) methods installed for that attribute. This is correct
864 behavior, but if you were wrongly relying on it you might get bit.
865
866 =head1 0.58
867
868 Roles now add methods by calling C<add_method>, not
869 C<alias_method>. They make sure to always provide a method object,
870 which will be cloned internally. This means that it is now possible to
871 track the source of a method provided by a role, and even follow its
872 history through intermediate roles.  This means that methods added by
873 a role now show up when looking at a class's method list/map.
874
875 Parameter and Union args are now sorted, this makes Int|Str the same
876 constraint as Str|Int. Also, incoming type constraint strings are
877 normalized to remove all whitespace differences. This is mostly for
878 internals and should not affect outside code.
879
880 L<Moose::Exporter> will no longer remove a subroutine that the
881 exporting package re-exports. Moose re-exports the Carp::confess
882 function, among others. The reasoning is that we cannot know whether
883 you have also explicitly imported those functions for your own use, so
884 we err on the safe side and always keep them.
885
886 =head1 0.56
887
888 C<Moose::init_meta> should now be called as a method.
889
890 New modules for extension writers, L<Moose::Exporter> and
891 L<Moose::Util::MetaRole>.
892
893 =head1 0.55_01
894
895 Implemented metaclass traits (and wrote a recipe for it):
896
897   use Moose -traits => 'Foo'
898
899 This should make writing small Moose extensions a little
900 easier.
901
902 =head1 0.55
903
904 Fixed C<coerce> to accept anon types just like C<subtype> can.
905 So that you can do:
906
907   coerce $some_anon_type => from 'Str' => via { ... };
908
909 =head1 0.51
910
911 Added C<BUILDARGS>, a new step in C<< Moose::Object->new() >>.
912
913 =head1 0.49
914
915 Fixed how the C<< is => (ro|rw) >> works with custom defined
916 C<reader>, C<writer> and C<accessor> options. See the below table for
917 details:
918
919   is => ro, writer => _foo    # turns into (reader => foo, writer => _foo)
920   is => rw, writer => _foo    # turns into (reader => foo, writer => _foo)
921   is => rw, accessor => _foo  # turns into (accessor => _foo)
922   is => ro, accessor => _foo  # error, accesor is rw
923
924 =head1 0.45
925
926 The C<before/around/after> method modifiers now support regexp
927 matching of method names. NOTE: this only works for classes, it is
928 currently not supported in roles, but, ... patches welcome.
929
930 The C<has> keyword for roles now accepts the same array ref form that
931 L<Moose>.pm does for classes.
932
933 A trigger on a read-only attribute is no longer an error, as it's
934 useful to trigger off of the constructor.
935
936 Subtypes of parameterizable types now are parameterizable types
937 themselves.
938
939 =head1 0.44
940
941 Fixed issue where C<DEMOLISHALL> was eating the value in C<$@>, and so
942 not working correctly. It still kind of eats them, but so does vanilla
943 perl.
944
945 =head1 0.41
946
947 Inherited attributes may now be extended without restriction on the
948 type ('isa', 'does').
949
950 The entire set of Moose::Meta::TypeConstraint::* classes were
951 refactored in this release. If you were relying on their internals you
952 should test your code carefully.
953
954 =head1 0.40
955
956 Documenting the use of '+name' with attributes that come from recently
957 composed roles. It makes sense, people are using it, and so why not
958 just officially support it.
959
960 The C<< Moose::Meta::Class->create >> method now supports roles.
961
962 It is now possible to make anonymous enum types by passing C<enum> an
963 array reference instead of the C<< enum $name => @values >>.
964
965 =head1 0.37
966
967 Added the C<make_immutable> keyword as a shortcut to calling
968 C<make_immutable> on the meta object. This eventually got removed!
969
970 Made C<< init_arg => undef >> work in Moose. This means "do not accept
971 a constructor parameter for this attribute".
972
973 Type errors now use the provided message. Prior to this release they
974 didn't.
975
976 =head1 0.34
977
978 Moose is now a postmodern object system :)
979
980 The Role system was completely refactored. It is 100% backwards
981 compat, but the internals were totally changed. If you relied on the
982 internals then you are advised to test carefully.
983
984 Added method exclusion and aliasing for Roles in this release.
985
986 Added the L<Moose::Util::TypeConstraints::OptimizedConstraints>
987 module.
988
989 Passing a list of values to an accessor (which is only expecting one
990 value) used to be silently ignored, now it throws an error.
991
992 =head1 0.26
993
994 Added parameterized types and did a pretty heavy refactoring of the
995 type constraint system.
996
997 Better framework extensibility and better support for "making your own
998 Moose".
999
1000 =head1 0.25 or before
1001
1002 Honestly, you shouldn't be using versions of Moose that are this old,
1003 so many bug fixes and speed improvements have been made you would be
1004 crazy to not upgrade.
1005
1006 Also, I am tired of going through the Changelog so I am stopping here,
1007 if anyone would like to continue this please feel free.
1008
1009 =cut