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