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