From: Tomas Doran Date: Mon, 12 Jan 2009 03:53:22 +0000 (+0000) Subject: Finish a first pass of all the text in Catalyst/Upgrading.pod. Add Plugin::Cache... X-Git-Tag: 5.8000_05~24 X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=commitdiff_plain;h=5687c7f983df10f5402d274a5e4d828415a227c3 Finish a first pass of all the text in Catalyst/Upgrading.pod. Add Plugin::Cache back to the TODO --- diff --git a/Changes b/Changes index 266cb92..647cda5 100644 --- a/Changes +++ b/Changes @@ -1,5 +1,6 @@ # This file documents the revision history for Perl extension Catalyst. +5.8000_05 - Fix request argumentss getting corrupted if you override the dispatcher and call an action which detaches (for Catalyst::Plugin::Authorization::ACL) (t0m) diff --git a/TODO b/TODO index c8c6b5d..3a54010 100644 --- a/TODO +++ b/TODO @@ -12,6 +12,8 @@ Known issues: - CatalystX-CRUD and CatalystX-CRUD-ModelAdapter-DBIC fail tests against 5.80 (karpet) + + - Catalyst-Plugin-Cache dies due to mk_accessors('meta') - work round. - Waiting on new releases: - Catalyst::Plugin::Authentication - 0.100092 diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 4d37007..0460754 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -1,12 +1,21 @@ =head1 Upgrading to Catalyst 5.80 -Work in progress +Most applications and plugins should run unaltered on Catalyst 5.80. -=head1 Known backwards compatibility breakages. +However as a lot of refactoring work has taken place, several changes +have been made which could cause incompatibilties, 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. -=head2 Catalyst::Plugin::Authentication +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. -You need at least version FIXME of Catalyst::Plugin::Authentication. +=head1 Known backwards compatibility breakages. =head2 Moose applications @@ -41,43 +50,60 @@ 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 Components whos new method returns false -FIXME +Previously if your new method returned a false value, -=head2 Components without COMPONENT methods +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 __PACKAGE__->mk_accessor('meta'); -Won't work due to a limitation of L +Won't work due to a limitation of L -FIXME +This is currently being fixed inside core Moose. =head2 Class::Data::Inheritable side effects -FIXME +Previously, writing to a class data accessor would copy the accessor method down into your package. -=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessor +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. -FIXME +Therefore anything relying on the side-effect of the accessor being copied down will be broken. -=head2 require $class was successful but the package is not defined. +=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors -FIXME Warning +Previously, it was possible to add additional accessors to Catalyst::Request (or other classes) +by calling the mk_accessors class method. -=head2 $c->plugin method +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. -Deprecated +=head2 Confused multiple inheritence with Catalyst::Component::COMPONENT -=head2 Components which inherit Catalyst::Component's COMPONENT method, who's new method does not return a true value. +Warning message: -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. + There is a COMPONENT method resolving after Catalyst::Component + in ${next_package}. + +This means that one of the packages on the right hand side of +Catalyst::Component in your Class' inheritance hierarchy defines +a COMPONENT method. +Previously, Catalyst's COMPONENT method would delegate to the +method on the right hand side, which could then delegate back again +with NEXT. This (as it is insane), is no longer supported, as it +makes no sense with C3 method dispatch order. + +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 @@ -114,25 +140,20 @@ 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 Confused multiple inheritence with Catalyst::Component::COMPONENT +=head2 require $class was successful but the package is not defined. -Warning message: +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. - There is a COMPONENT method resolving after Catalyst::Component - in ${next_package}. - -This means that one of the packages on the right hand side of -Catalyst::Component in your Class' inheritance hierarchy defines -a COMPONENT method. +This is to pretect against confusing bugs caused by mis-typing package names. -Previously, Catalyst's COMPONENT method would delegate to the -method on the right hand side, which could then delegate back again -with NEXT. This (as it is insane), is no longer supported, as it -makes no sense with C3 method dispatch order. +This will become a fatal error in a future version. -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. +=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