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