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