lib/Moose/Manual/Delta.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Moose::Manual::Delta - Important Changes in Moose
   6
   7 =head1 DESCRIPTION
   8
   9 This documents any important or noteworthy changes in Moose, with a
  10 focus on backwards. This does duplicate data from the F<Changes> file,
  11 but aims to provide more details and when possible workarounds.
  12
  13 Besides helping keep up with changes, you can also use this document
  14 for finding the lowest version of Moose that supported a given
  15 feature.  If you encounter a problem and have a solution but don't see
  16 it documented here, or think we missed an important feature, please
  17 send us a patch.
  18
  19 =head1 Next
  20
  21 =over 4
  22
  23 =item Added Native delegation for Code refs
  24
  25 See L<Moose::Meta::Attribute::Native::Trait::Code> for details.
  26
  27 =back
  28
  29 =head1 Version 0.89_02
  30
  31 =over 4
  32
  33 =item New Native delegation methods from L<List::Util> and L<List::MoreUtils>
  34
  35 In particular, we now have C<reduce>, C<shuffle>, C<uniq>, and C<natatime>.
  36
  37 =item The Moose::Exporter with_caller feature is now deprecated
  38
  39 Use C<with_meta> instead. The C<with_caller> option will start warning in a
  40 future release.
  41
  42 =item Moose now warns if you call C<make_immutable> for a class with mutable ancestors
  43
  44 This is dangerous because modifying a class after a subclass has been
  45 immutabilized will lead to incorrect results in the subclass, due to inlining,
  46 caching, etc. This occasionally happens accidentally, when a class loads one
  47 of its subclasses in the middle of its class definition, so pointing out that
  48 this may cause issues should be helpful. Metaclasses (classes that inherit
  49 from L<Class::MOP::Object>) are currently exempt from this check, since at the
  50 moment we aren't very consistent about which metaclasses we immutabilize.
  51 Anonymous classes are also exempt, since they are often created automatically,
  52 and the user is never given a choice about whether or not to make them
  53 immutable. If you're sure you know what you're doing, you also can pass the
  54 C<allow_mutable_ancestors> option to make_immutable to silence the warning
  55 (but be aware that modifying those mutable ancestors can still lead to
  56 incorrect behavior in your subclass).
  57
  58 =back
  59
  60 =head1 Version 0.89_01
  61
  62 L<Moose::Meta::Attribute::Native> has been moved into the Moose core from
  63 L<MooseX::AttributeHelpers>.  Major changes include:
  64
  65 =over 4
  66
  67 =item C<traits>, not C<metaclass>
  68
  69 Method providers are only available via traits.
  70
  71 =item C<handles>, not C<provides> or C<curries>
  72
  73 The C<provides> syntax was like core Moose C<< handles => HASHREF >>
  74 syntax, but with the keys and values reversed.  This was confusing,
  75 and AttributeHelpers now uses C<< handles => HASHREF >> in a way that
  76 should be intuitive to anyone already familiar with how it is used for
  77 other attributes.
  78
  79 The C<curries> functionality provided by AttributeHelpers has been
  80 generalized to apply to all cases of C<< handles => HASHREF >>, though
  81 not every piece of functionality has been ported (currying with a
  82 CODEREF is not supported).
  83
  84 =item C<empty> is now C<is_empty>, and means empty, not non-empty
  85
  86 Previously, the C<empty> method provided by Arrays and Hashes returned true if
  87 the attribute was B<not> empty (no elements).  Now it returns true if the
  88 attribute B<is> empty. It was also renamed to C<is_empty>, to reflect this.
  89
  90 =item C<find> was renamed to C<first>, and C<first> and C<last> were removed
  91
  92 L<List::Util> refers to the functionality that we used to provide under C<find>
  93 as L<first|List::Util/first>, so that will likely be more familiar (and will
  94 fit in better if we decide to add more List::Util functions). C<first> and
  95 C<last> were removed, since their functionality is easily duplicated with
  96 curries of C<get>.
  97
  98 =item Helpers that take a coderef of one argument now use C<$_>
  99
 100 Subroutines passed as the first argument to C<first>, C<map>, and C<grep> now
 101 receive their argument in C<$_> rather than as a parameter to the subroutine.
 102 Helpers that take a coderef of two or more arguments remain using the argument
 103 list (there are technical limitations to using C<$a> and C<$b> like C<sort>
 104 does).
 105
 106 See L<Moose::Meta::Attribute::Native> for the new documentation.
 107
 108 =back
 109
 110 The C<alias> and C<excludes> role parameters have been renamed to C<-alias>
 111 and C<-excludes>. The old names still work, but new code should use the new
 112 names, and eventually the old ones will be deprecated and removed.
 113
 114 =head1 Version 0.89
 115
 116 C<< use Moose -metaclass => 'Foo' >> now does alias resolution, just like
 117 C<-traits> (and the C<metaclass> and C<traits> options to C<has>).
 118
 119 Added two functions C<meta_class_alias> and C<meta_attribute_alias> to
 120 L<Moose::Util>, to simplify aliasing metaclasses and metatraits. This is
 121 a wrapper around the old
 122
 123   package Moose::Meta::Class::Custom::Trait::FooTrait;
 124   sub register_implementation { 'My::Meta::Trait' }
 125
 126 way of doing this.
 127
 128 =head1 Version 0.84
 129
 130 When an attribute generates I<no> accessors, we now warn. This is to help
 131 users who forget the C<is> option. If you really do not want any accessors,
 132 you can use C<< is => 'bare' >>. You can maintain back compat with older
 133 versions of Moose by using something like:
 134
 135     ($Moose::VERSION >= 0.84 ? is => 'bare' : ())
 136
 137 When an accessor overwrites an existing method, we now warn. To work around
 138 this warning (if you really must have this behavior), you can explicitly
 139 remove the method before creating it as an accessor:
 140
 141     sub foo {}
 142
 143     __PACKAGE__->meta->remove_method('foo');
 144
 145     has foo => (
 146         is => 'ro',
 147     );
 148
 149 When an unknown option is passed to C<has>, we now warn. You can silence
 150 the warning by fixing your code. :)
 151
 152 The C<Role> type has been deprecated. On its own, it was useless,
 153 since it just checked C<< $object->can('does') >>. If you were using
 154 it as a parent type, just call C<role_type('Role::Name')> to create an
 155 appropriate type instead.
 156
 157 =head1 Version 0.78
 158
 159 C<use Moose::Exporter;> now imports C<strict> and C<warnings> into packages
 160 that use it.
 161
 162 =head1 Version 0.77
 163
 164 C<DEMOLISHALL> and C<DEMOLISH> now receive an argument indicating whether or
 165 not we are in global destruction.
 166
 167 =head1 Version 0.76
 168
 169 Type constraints no longer run coercions for a value that already matches the
 170 constraint.  This may affect some (arguably buggy) edge case coercions that
 171 rely on side effects in the C<via> clause.
 172
 173 =head1 Version 0.75
 174
 175 L<Moose::Exporter> now accepts the C<-metaclass> option for easily
 176 overriding the metaclass (without L<metaclass>). This works for classes
 177 and roles.
 178
 179 =head1 Version 0.74
 180
 181 Added a C<duck_type> sugar function to L<Moose::Util::TypeConstraints>
 182 to make integration with non-Moose classes easier. It simply checks if
 183 C<< $obj->can() >> a list of methods.
 184
 185 A number of methods (mostly inherited from L<Class::MOP>) have been
 186 renamed with a leading underscore to indicate their internal-ness. The
 187 old method names will still work for a while, but will warn that the
 188 method has been renamed. In a few cases, the method will be removed
 189 entirely in the future. This may affect MooseX authors who were using
 190 these methods.
 191
 192 =head1 Version 0.73
 193
 194 Calling C<subtype> with a name as the only argument now throws an
 195 exception. If you want an anonymous subtype do:
 196
 197     my $subtype = subtype as 'Foo';
 198
 199 This is related to the changes in version 0.71_01.
 200
 201 The C<is_needed> method in L<Moose::Meta::Method::Destructor> is now
 202 only usable as a class method. Previously, it worked as a class or
 203 object method, with a different internal implementation for each
 204 version.
 205
 206 The internals of making a class immutable changed a lot in Class::MOP
 207 0.78_02, and Moose's internals have changed along with it. The
 208 external C<< $metaclass->make_immutable >> method still works the same
 209 way.
 210
 211 =head1 Version 0.72
 212
 213 A mutable class accepted C<< Foo->new(undef) >> without complaint,
 214 while an immutable class would blow up with an unhelpful error. Now,
 215 in both cases we throw a helpful error instead.
 216
 217 This "feature" was originally added to allow for cases such as this:
 218
 219   my $args;
 220
 221   if ( something() ) {
 222       $args = {...};
 223   }
 224
 225   return My::Class->new($args);
 226
 227 But we decided this is a bad idea and a little too magical, because it
 228 can easily mask real errors.
 229
 230 =head1 Version 0.71_01
 231
 232 Calling C<type> or C<subtype> without the sugar helpers (C<as>,
 233 C<where>, C<message>) is now deprecated.
 234
 235 As a side effect, this meant we ended up using Perl prototypes on
 236 C<as>, and code like this will no longer work:
 237
 238   use Moose::Util::TypeConstraints;
 239   use Declare::Constraints::Simple -All;
 240
 241   subtype 'ArrayOfInts'
 242       => as 'ArrayRef'
 243       => IsArrayRef(IsInt);
 244
 245 Instead it must be changed to this:
 246
 247   subtype(
 248       'ArrayOfInts' => {
 249           as    => 'ArrayRef',
 250           where => IsArrayRef(IsInt)
 251       }
 252   );
 253
 254 If you want to maintain backwards compat with older versions of Moose,
 255 you must explicitly test Moose's C<VERSION>:
 256
 257   if ( Moose->VERSION < 0.71_01 ) {
 258       subtype 'ArrayOfInts'
 259           => as 'ArrayRef'
 260           => IsArrayRef(IsInt);
 261   }
 262   else {
 263       subtype(
 264           'ArrayOfInts' => {
 265               as    => 'ArrayRef',
 266               where => IsArrayRef(IsInt)
 267           }
 268       );
 269   }
 270
 271 =head1 Version 0.70
 272
 273 We no longer pass the meta-attribute object as a final argument to
 274 triggers. This actually changed for inlined code a while back, but the
 275 non-inlined version and the docs were still out of date.
 276
 277 If by some chance you actually used this feature, the workaround is
 278 simple. You fetch the attribute object from out of the C<$self>
 279 that is passed as the first argument to trigger, like so:
 280
 281   has 'foo' => (
 282       is      => 'ro',
 283       isa     => 'Any',
 284       trigger => sub {
 285           my ( $self, $value ) = @_;
 286           my $attr = $self->meta->find_attribute_by_name('foo');
 287
 288           # ...
 289       }
 290   );
 291
 292 =head1 Version 0.66
 293
 294 If you created a subtype and passed a parent that Moose didn't know
 295 about, it simply ignored the parent. Now it automatically creates the
 296 parent as a class type. This may not be what you want, but is less
 297 broken than before.
 298
 299 You could declare a name with subtype such as "Foo!Bar". Moose would
 300 accept this allowed, but if you used it in a parameterized type such
 301 as "ArrayRef[Foo!Bar]" it wouldn't work. We now do some vetting on
 302 names created via the sugar functions, so that they can only contain
 303 alphanumerics, ":", and ".".
 304
 305 =head1 Version 0.65
 306
 307 Methods created via an attribute can now fulfill a C<requires>
 308 declaration for a role. Honestly we don't know why Stevan didn't make
 309 this work originally, he was just insane or something.
 310
 311 Stack traces from inlined code will now report the line and file as
 312 being in your class, as opposed to in Moose guts.
 313
 314 =head1 Version 0.62_02
 315
 316 When a class does not provide all of a role's required methods, the
 317 error thrown now mentions all of the missing methods, as opposed to
 318 just the first missing method.
 319
 320 Moose will no longer inline a constructor for your class unless it
 321 inherits its constructor from Moose::Object, and will warn when it
 322 doesn't inline. If you want to force inlining anyway, pass
 323 C<< replace_constructor => 1 >> to C<make_immutable>.
 324
 325 If you want to get rid of the warning, pass C<< inline_constructor =>
 326 0 >>.
 327
 328 =head1 Version 0.62
 329
 330 Removed the (deprecated) C<make_immutable> keyword.
 331
 332 Removing an attribute from a class now also removes delegation
 333 (C<handles>) methods installed for that attribute. This is correct
 334 behavior, but if you were wrongly relying on it you might get bit.
 335
 336 =head1 Version 0.58
 337
 338 Roles now add methods by calling C<add_method>, not
 339 C<alias_method>. They make sure to always provide a method object,
 340 which will be cloned internally. This means that it is now possible to
 341 track the source of a method provided by a role, and even follow its
 342 history through intermediate roles.  This means that methods added by
 343 a role now show up when looking at a class's method list/map.
 344
 345 Parameter and Union args are now sorted, this makes Int|Str the same
 346 constraint as Str|Int. Also, incoming type constraint strings are
 347 normalized to remove all whitespace differences. This is mostly for
 348 internals and should not affect outside code.
 349
 350 L<Moose::Exporter> will no longer remove a subroutine that the
 351 exporting package re-exports. Moose re-exports the Carp::confess
 352 function, among others. The reasoning is that we cannot know whether
 353 you have also explicitly imported those functions for your own use, so
 354 we err on the safe side and always keep them.
 355
 356 =head1 Version 0.56
 357
 358 C<Moose::init_meta> should now be called as a method.
 359
 360 New modules for extension writers, L<Moose::Exporter> and
 361 L<Moose::Util::MetaRole>.
 362
 363 =head1 Version 0.55_01
 364
 365 Implemented metaclass traits (and wrote a recipe for it):
 366
 367   use Moose -traits => 'Foo'
 368
 369 This should make writing small Moose extensions a little
 370 easier.
 371
 372 =head1 Version 0.55
 373
 374 Fixed C<coerce> to accept anon types just like C<subtype> can.
 375 So that you can do:
 376
 377   coerce $some_anon_type => from 'Str' => via { ... };
 378
 379 =head1 Version 0.51
 380
 381 Added C<BUILDARGS>, a new step in C<< Moose::Object->new() >>.
 382
 383 =head1 Version 0.49
 384
 385 Fixed how the C<< is => (ro|rw) >> works with custom defined
 386 C<reader>, C<writer> and C<accessor> options. See the below table for
 387 details:
 388
 389   is => ro, writer => _foo    # turns into (reader => foo, writer => _foo)
 390   is => rw, writer => _foo    # turns into (reader => foo, writer => _foo)
 391   is => rw, accessor => _foo  # turns into (accessor => _foo)
 392   is => ro, accessor => _foo  # error, accesor is rw
 393
 394 =head1 Version 0.45
 395
 396 The C<before/around/after> method modifiers now support regexp
 397 matching of method names. NOTE: this only works for classes, it is
 398 currently not supported in roles, but, ... patches welcome.
 399
 400 The C<has> keyword for roles now accepts the same array ref form that
 401 L<Moose>.pm does for classes.
 402
 403 A trigger on a read-only attribute is no longer an error, as it's
 404 useful to trigger off of the constructor.
 405
 406 Subtypes of parameterizable types now are parameterizable types
 407 themselves.
 408
 409 =head1 Version 0.44
 410
 411 Fixed issue where C<DEMOLISHALL> was eating the value in C<$@>, and so
 412 not working correctly. It still kind of eats them, but so does vanilla
 413 perl.
 414
 415 =head1 Version 0.41
 416
 417 Inherited attributes may now be extended without restriction on the
 418 type ('isa', 'does').
 419
 420 The entire set of Moose::Meta::TypeConstraint::* classes were
 421 refactored in this release. If you were relying on their internals you
 422 should test your code carefully.
 423
 424 =head1 Version 0.40
 425
 426 Documenting the use of '+name' with attributes that come from recently
 427 composed roles. It makes sense, people are using it, and so why not
 428 just officially support it.
 429
 430 The C<< Moose::Meta::Class->create >> method now supports roles.
 431
 432 It is now possible to make anonymous enum types by passing C<enum> an
 433 array reference instead of the C<< enum $name => @values >>.
 434
 435 =head1 Version 0.37
 436
 437 Added the C<make_immutable> keyword as a shortcut to calling
 438 C<make_immutable> on the meta object. This eventually got removed!
 439
 440 Made C<< init_arg => undef >> work in Moose. This means "do not accept
 441 a constructor parameter for this attribute".
 442
 443 Type errors now use the provided message. Prior to this release they
 444 didn't.
 445
 446 =head1 Version 0.34
 447
 448 Moose is now a postmodern object system :)
 449
 450 The Role system was completely refactored. It is 100% backwards
 451 compat, but the internals were totally changed. If you relied on the
 452 internals then you are advised to test carefully.
 453
 454 Added method exclusion and aliasing for Roles in this release.
 455
 456 Added the L<Moose::Util::TypeConstraints::OptimizedConstraints>
 457 module.
 458
 459 Passing a list of values to an accessor (which is only expecting one
 460 value) used to be silently ignored, now it throws an error.
 461
 462 =head1 Version 0.26
 463
 464 Added parameterized types and did a pretty heavy refactoring of the
 465 type constraint system.
 466
 467 Better framework extendability and better support for "making your own
 468 Moose".
 469
 470 =head1 Version 0.25 or before
 471
 472 Honestly, you shouldn't be using versions of Moose that are this old,
 473 so many bug fixes and speed improvements have been made you would be
 474 crazy to not upgrade.
 475
 476 Also, I am tired of going through the Changelog so I am stopping here,
 477 if anyone would like to continue this please feel free.
 478
 479 =head1 AUTHOR
 480
 481 Stevan Little E<lt>stevan@iinteractive.comE<gt>
 482
 483 =head1 COPYRIGHT AND LICENSE
 484
 485 Copyright 2009 by Infinity Interactive, Inc.
 486
 487 L<http://www.iinteractive.com>
 488
 489 This library is free software; you can redistribute it and/or modify
 490 it under the same terms as Perl itself.
 491
 492 =cut