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