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