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