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