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