[Catalyst-commits] r9066 - in Catalyst-Runtime/5.80/trunk: . lib/Catalyst

[t0m at dev.catalyst.perl.org]

Author: t0m
Date: 2009-01-12 03:53:22 +0000 (Mon, 12 Jan 2009)
New Revision: 9066

Modified:
   Catalyst-Runtime/5.80/trunk/Changes
   Catalyst-Runtime/5.80/trunk/TODO
   Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod
Log:
Finish a first pass of all the text in Catalyst/Upgrading.pod. Add Plugin::Cache back to the TODO

Modified: Catalyst-Runtime/5.80/trunk/Changes
===================================================================
--- Catalyst-Runtime/5.80/trunk/Changes	2009-01-12 03:53:15 UTC (rev 9065)
+++ Catalyst-Runtime/5.80/trunk/Changes	2009-01-12 03:53:22 UTC (rev 9066)
@@ -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)

Modified: Catalyst-Runtime/5.80/trunk/TODO
===================================================================
--- Catalyst-Runtime/5.80/trunk/TODO	2009-01-12 03:53:15 UTC (rev 9065)
+++ Catalyst-Runtime/5.80/trunk/TODO	2009-01-12 03:53:22 UTC (rev 9066)
@@ -12,6 +12,8 @@
 
      - 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

Modified: Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod
===================================================================
--- Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod	2009-01-12 03:53:15 UTC (rev 9065)
+++ Catalyst-Runtime/5.80/trunk/lib/Catalyst/Upgrading.pod	2009-01-12 03:53:22 UTC (rev 9066)
@@ -1,13 +1,22 @@
 =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.
 
-=head2 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.
 
-You need at least version FIXME of 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.
 
+=head1 Known backwards compatibility breakages.
+
 =head2 Moose applications
 
 Moose components for Catalyst 5.70 needed to do
@@ -41,44 +50,61 @@
     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<MooseX::Emulate::Class::Accessor::Fast>
+Won't work due to a limitation of L<Moose>
 
-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
 
 =head2 Methods in Catalyst::Dispatcher
@@ -114,25 +140,20 @@
 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<highly deprecated>.
 
+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