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