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