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