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