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