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