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