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