lib/Catalyst/Upgrading.pod

   1 =head1 Upgrading to Catalyst 5.80
   2
   3 Most applications and plugins should run unaltered on Catalyst 5.80.
   4
   5 However as a lot of refactoring work has taken place, several changes
   6 have been made which could cause incompatibilities, if your application
   7 or plugin is using deprecated code, or relying on side-effects then
   8 there could be incompatibility.
   9
  10 Most issues found with pre-existing components have been easy to solve,
  11 and a complete description of behavior changes which may cause compatibility
  12 issues, or warnings to be emitted is included below to help if you have
  13 problems.
  14
  15 If you think you have found an upgrade related issue which is not covered in
  16 this document, then please email the Catalyst list to discuss the problem.
  17
  18 =head1 Known backwards compatibility breakages.
  19
  20 =head2 Moose applications
  21
  22 Moose components for Catalyst 5.70 needed to do
  23
  24     extends qw/Moose::Object Catalyst::Component/;
  25
  26 to be able to use the constructor provided by Moose. In 5.80
  27 C<Catalyst::Component> already inherits from C<Moose::Object>. Therefor you
  28 shouldn't directly inherit from C<Moose::Object> yourself, otherwise your
  29 Class' @ISA will not linearize with C3.
  30
  31 =head2 Anonymous closures installed directly into the symbol table
  32
  33 If you have any code which installs anonymous subroutine references directly
  34 into the symbol table, you may encounter breakages. The simplest solution is
  35 to use L<Sub::Name> to name the subroutine. Example:
  36
  37     #Originalcode, likely to break:
  38     my $full_method_name = join('::',$package_name, $method_name);
  39     *$full_method_name = sub { ... };
  40
  41     #Fixed Code
  42     use Sub::Name 'subname';
  43     my $full_method_name = join('::',$package_name, $method_name);
  44     *$full_method_name = subname $full_method_name, sub { ... };
  45
  46 Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and
  47 install the closure using the appropriate metaclass. Example:
  48
  49     use Class::MOP;
  50     my $metaclass = Moose::Meta::Class->initialize($package_name);
  51     $metaclass->add_method($method_name => sub { ... });
  52
  53 =head2 Components whos new method returns false
  54
  55 Previously if your new method returned a false value,
  56
  57 Previously, if you had a component which inherited from Catalyst::COMPONENT, but
  58 overrode the new method, to return false, then your class' configuration would be blessed into a hash on your behalf,
  59 and this would be returned from the COMPONENT method. T
  60
  61 This behaviour makes no sense, and so has been removed.. You are recommended to implement your own new method
  62 in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality
  63 to perform any construction work necessary for your sub-class.
  64
  65 =head2 __PACKAGE__->mk_accessor('meta');
  66
  67 Won't work due to a limitation of L<Moose>
  68
  69 This is currently being fixed inside core Moose.
  70
  71 =head2 Class::Data::Inheritable side effects
  72
  73 Previously, writing to a class data accessor would copy the accessor method down into your package.
  74
  75 This behavior has been removed. Whilst the class data is still stored per-class, it is stored on
  76 the metaclass of the class defining the accessor.
  77
  78 Therefore anything relying on the side-effect of the accessor being copied down will be broken.
  79
  80 =head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors
  81
  82 Previously, it was possible to add additional accessors to Catalyst::Request (or other classes)
  83 by calling the mk_accessors class method.
  84
  85 This is no longer supported - users should make a sub-class of the class who's behavior they would
  86 like to change, rather than globally polluting the Catalyst objects.
  87
  88 =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
  89
  90 Warning message:
  91
  92     There is a COMPONENT method resolving after Catalyst::Component
  93     in ${next_package}.
  94
  95 This means that one of the packages on the right hand side of
  96 Catalyst::Component in your Class' inheritance hierarchy defines
  97 a COMPONENT method.
  98
  99 Previously, Catalyst's COMPONENT method would delegate to the
 100 method on the right hand side, which could then delegate back again
 101 with NEXT. This (as it is insane), is no longer supported, as it
 102 makes no sense with C3 method dispatch order.
 103
 104 Therefore the correct fix is to re-arrange your class' inheritance
 105 hierarchy so that the COMPONENT method you would like to inherit is
 106 the first COMPONENT method in your @ISA.
 107
 108 =head2 Assigning lists to accessors
 109
 110 Accessors generated by Class::Accessor::Fast will, when multiple values
 111 are assigned to them, store a reference to a list automatically for you.
 112
 113 This is not currently supported by MooseX::Emulate::Class::Accessor::Fast,
 114 and only the first value in the list will be stored.
 115
 116 If you are relying on this behavior, and inheriting mk_accessors from a
 117 Catalyst component, then your code will fail.
 118
 119 =head1 WARNINGS
 120
 121 =head2 Methods in Catalyst::Dispatcher
 122
 123 The following methods in Catalyst::Dispatcher are likely to change
 124 significantly in the 5.8X release series, and therefore their use is highly
 125 deprecated.
 126
 127 =over
 128
 129 =item tree
 130
 131 =item dispatch_types
 132
 133 =item registered_dispatch_types
 134
 135 =item method_action_class
 136
 137 =item action_hash
 138
 139 =item container_hash
 140
 141 =back
 142
 143 The first time one of these methods is called, a warning will be emitted:
 144
 145     Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
 146     . "this will be removed in Catalyst 5.9X"
 147
 148 You should B<NEVER> be calling any of these methods from application code.
 149
 150 Plugins authors and maintainers whos plugins need to call these methods
 151 should email the development list to discuss your use-case, and what a
 152 better API should look like.
 153
 154 =head2 require $class was successful but the package is not defined.
 155
 156 In this version of Catalyst, if a component is loaded from disk, but no symbols are defined in that component's namespace
 157 after it is loaded, this warning will be issued.
 158
 159 This is to protect against confusing bugs caused by mis-typing package names.
 160
 161 This will become a fatal error in a future version.
 162
 163 =head2 $c->plugin method
 164
 165 Calling the plugin method is deprecated, and calling it at runtime is B<highly deprecated>.
 166
 167 Instead you are recommended to use L< Catalyst::Model::Adaptor > or similar to compose the functionality
 168 you need outside of the main application namespace.
 169
 170 =cut