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