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