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