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