X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FUpgrading.pod;h=a2d30bac1ce9a634abe059f08a497a6078ef1ddd;hb=cb092ef3a99b53b22c590fe9c0f96986909849b3;hp=781b821a48a18791c2902375fc21eb135d1ec95c;hpb=8be895a7aa1d89a8004cc0cd37962025bc5c3b3d;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 781b821..a2d30ba 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -1,68 +1,89 @@ =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. - -=head2 Catalyst::Plugin::Authentication +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. -You need at least version FIXME of Catalyst::Plugin::Authentication. +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 Moose applications +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. -Applications made by early adopters, which say: +=head1 Known backwards compatibility breakages. - extends qw/Moose::Object Catalyst::Component/ +=head2 Moose applications -need the C removing to run with Catalyst 5.80, otherwise -your Class' @ISA will not linearise with C3. +Moose components for Catalyst 5.70 needed to do -rafl to fix this bit :) + extends qw/Moose::Object Catalyst::Component/; -=head2 Components without new methods +to be able to use the constructor provided by Moose. In 5.80 +C already inherits from C. Therefor you +shouldn't directly inherit from C yourself, otherwise your +Class' @ISA will not linearise with C3. -FIXME +=head2 Anonymous closures installed directly into the symbol table -=head2 Components without COMPONENT methods +If you have any code which installs anonymous subroutine references directly +into the symbol table, you may encounter breakages. The simplest solution is +to use L to name the subroutine. Example: -FIXME + #Originalcode, likely to break: + my $full_method_name = join('::',$package_name, $method_name); + *$full_method_name = sub { ... }; -=head2 __PACKAGE__->mk_accessor('meta'); + #Fixed Code + use Sub::Name 'subname'; + my $full_method_name = join('::',$package_name, $method_name); + *$full_method_name = subname $full_method_name, sub { ... }; -Won't work due to a limitation of L +Additionally, you can take advantage of Catalyst's use of L and +install the closure using the appropriate metaclass. Example: -FIXME + use Class::MOP; + my $metaclass = Moose::Meta::Class->initialize($package_name); + $metaclass->add_method($method_name => sub { ... }); -=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 @@ -84,5 +105,66 @@ 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 Assigning lists to accessors + +Accessors generated by Class::Accessor::Fast will, when multiple values +are assigned to them, store a reference to a list automatically for you. + +This is not currently supported by MooseX::Emulate::Class::Accessor::Fast, +and only the first value in the list will be stored. + +If you are relying on this behavior, and inheriting mk_accessors from a +Catalyst component, then your code will fail. + +=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 pretect 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