X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FUpgrading.pod;h=b37033472c8005502eaabd4fa33e71700f0fafa8;hb=3df8be3a51ac163e99d2ee87f7a819f02787e592;hp=4c8a28d40930fd099a075d2fff0a996ca2992fea;hpb=04a48104b87288a52abbaee32bfd7396925fb5d9;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 4c8a28d..b370334 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -1,23 +1,59 @@ =head1 Upgrading to Catalyst 5.80 -Work in progress +Most applications and plugins should run unaltered on Catalyst 5.80. + +However as a lot of refactoring work has taken place, several changes +have been made which could cause incompatibilities, if your application +or plugin is using deprecated code, or relying on side-effects then +there could be incompatibility. + +Most issues found with pre-existing components have been easy to solve, +and a complete description of behavior changes which may cause compatibility +issues, or warnings to be emitted is included below to help if you have +problems. + +If you think you have found an upgrade related issue which is not covered in +this document, then please email the Catalyst list to discuss the problem. =head1 Known backwards compatibility breakages. -=head2 Catalyst::Plugin::Authentication +=head2 Components which inherit from Moose::Object before Catalyst::Component + +Moose components which say: + + package TestApp::Controller::Example; + use Moose; + extends qw/Moose::Object Catalyst::Component/; + +to use the constructor provided by Moose, whilst working if you do some hacks +with the C< BUILDARGS > method, will not work with Catalyst 5.80 as +C inherits from C, and so C< @ISA > fails +to linearise. -You need at least version FIXME of Catalyst::Plugin::Authentication. +The fix for this, is to not inherit directly from C +yourself. Having components which do not inherit their constructor from +C is B, and has never been recommended, +therefore you're on your own if you're using this technique. You'll need +to detect the version of Catalyst your application is running with and deal +with it appropriately. -=head2 Moose applications +You will also see this issue if you do the following: -Applications made by early adopters, which say: + package TestApp::Controller::Example; + use Moose; + use base 'Catalyst::Controller'; - extends qw/Moose::Object Catalyst::Component/ +as C< use base > appends to @ISA. -need the C removing to run with Catalyst 5.80, otherwise -your Class' @ISA will not linearise with C3. +The correct way to use Moose in a component in a both forward and backwards +compatible way is: -rafl to fix this bit :) + package TestApp::Controller::Root; + use Moose; + BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever + +Note that the C< extends > decleration needs to occur in a begin block for +L to operate correctly. =head2 Anonymous closures installed directly into the symbol table @@ -41,52 +77,68 @@ install the closure using the appropriate metaclass. Example: my $metaclass = Moose::Meta::Class->initialize($package_name); $metaclass->add_method($method_name => sub { ... }); -=head2 Components without new methods +=head2 Hooking into application setup -FIXME +To execute code during application startup the following snippet in MyApp.pm +used to work: -=head2 Components without COMPONENT methods + sub setup { + my ($class, @args) = @_; + $class->NEXT::setup(@args); + ... # things to do after the actual setup + } -FIXME +With Catalyst 5.80 this won't work anymore. Because instead of using NEXT.pm it +relies on Class::C3::Adopt::NEXT, which doesn't remember what methods it +already called, like NEXT does and therefore goes into a deep recursion between +MyApp::setup and Catalyst::setup. -=head2 __PACKAGE__->mk_accessor('meta'); +Moose method modifiers line C<< before|after|around 'setup => sub { ... }; >> +won't work either because of backward compatibility issues related to plugin +setup methods. -Won't work due to a limitation of L +The right way to do it is this: -FIXME + after setup_finalize => sub { + ... # things to do after the actual setup + }; -=head2 Class::Data::Inheritable side effects +=head2 Components whos new method returns false -FIXME +Previously if your new method returned a false value, -=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessor +Previously, if you had a component which inherited from Catalyst::COMPONENT, but +overrode the new method, to return false, then your class' configuration would be blessed into a hash on your behalf, +and this would be returned from the COMPONENT method. T -FIXME +This behaviour makes no sense, and so has been removed.. You are recommended to implement your own new method +in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality +to perform any construction work necessary for your sub-class. -=head2 require $class was successful but the package is not defined. +=head2 __PACKAGE__->mk_accessor('meta'); -FIXME Warning +Won't work due to a limitation of L -=head2 $c->plugin method +This is currently being fixed inside core Moose. -Deprecated +=head2 Class::Data::Inheritable side effects -=head2 Components which inherit Catalyst::Component's COMPONENT method, who's new method does not return a true value. +Previously, writing to a class data accessor would copy the accessor method down into your package. -Previously if your new method returned a false value, then your class' configuration would be blessed into a hash on your behalf, -and this would be returned from the COMPONENT method. This is no longer supported. You are not recommended to implement your own new method -in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality -to perform any construction work necessary for your sub-class. +This behavior has been removed. Whilst the class data is still stored per-class, it is stored on +the metaclass of the class defining the accessor. +Therefore anything relying on the side-effect of the accessor being copied down will be broken. -=head Methods in Catalyst::Dispatcher +=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors - Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n" - . "this will be removed in Catalyst 5.9X" +Previously, it was possible to add additional accessors to Catalyst::Request (or other classes) +by calling the mk_accessors class method. -FIXME +This is no longer supported - users should make a sub-class of the class who's behavior they would +like to change, rather than globally polluting the Catalyst objects. -=head2 Confused multiple inheritence with Catalyst::Component::COMPONENT +=head2 Confused multiple inheritance with Catalyst::Component::COMPONENT Warning message: @@ -106,5 +158,55 @@ Therefore the correct fix is to re-arrange your class' inheritance hierarchy so that the COMPONENT method you would like to inherit is the first COMPONENT method in your @ISA. +=head1 WARNINGS + +=head2 Methods in Catalyst::Dispatcher + +The following methods in Catalyst::Dispatcher are likely to change +significantly in the 5.8X release series, and therefore their use is highly +deprecated. + +=over + +=item tree + +=item dispatch_types + +=item registered_dispatch_types + +=item method_action_class + +=item action_hash + +=item container_hash + +=back + +The first time one of these methods is called, a warning will be emitted: + + Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n" + . "this will be removed in Catalyst 5.9X" + +You should B be calling any of these methods from application code. + +Plugins authors and maintainers whos plugins need to call these methods +should email the development list to discuss your use-case, and what a +better API should look like. + +=head2 require $class was successful but the package is not defined. + +In this version of Catalyst, if a component is loaded from disk, but no symbols are defined in that component's namespace +after it is loaded, this warning will be issued. + +This is to protect against confusing bugs caused by mis-typing package names. + +This will become a fatal error in a future version. + +=head2 $c->plugin method + +Calling the plugin method is deprecated, and calling it at runtime is B. + +Instead you are recommended to use L< Catalyst::Model::Adaptor > or similar to compose the functionality +you need outside of the main application namespace. =cut