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