[catagits/Catalyst-Runtime.git] / lib / Catalyst / Upgrading.pod

=head1 Upgrading to Catalyst 5.80

Work in progress

=head1 Known backwards compatibility breakages.

=head2 Catalyst::Plugin::Authentication

You need at least version FIXME of Catalyst::Plugin::Authentication.

=head2 Moose applications

Applications made by early adopters, which say:

    extends qw/Moose::Object Catalyst::Component/

need the C<Moose::Object> removing to run with Catalyst 5.80, otherwise
your Class' @ISA will not linearise with C3.

rafl to fix this bit :)

=head2 Components without new methods

FIXME

=head2 Components without COMPONENT methods

FIXME

=head2 __PACKAGE__->mk_accessor('meta');

Won't work due to a limitation of L<MooseX::Emulate::Class::Accessor::Fast>

FIXME

=head2 Class::Data::Inheritable side effects

FIXME

=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessor

FIXME

=head2 require $class was successful but the package is not defined.

FIXME Warning

=head2 Components which inherit Catalyst::Component's COMPONENT method, who's new method does not return a true value.

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.


=head Methods in Catalyst::Dispatcher

    Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
    . "this will be removed in Catalyst 5.9X"

FIXME

=head2 Confused multiple inheritence with Catalyst::Component::COMPONENT

Warning message:

    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. 


=cut
Commit	Line	Data
7e2ec16e	1	=head1 Upgrading to Catalyst 5.80
	2
	3	Work in progress
	4
	5	=head1 Known backwards compatibility breakages.
	6
	7	=head2 Catalyst::Plugin::Authentication
	8
	9	You need at least version FIXME of Catalyst::Plugin::Authentication.
	10
	11	=head2 Moose applications
	12
	13	Applications made by early adopters, which say:
	14
	15	extends qw/Moose::Object Catalyst::Component/
	16
	17	need the C<Moose::Object> removing to run with Catalyst 5.80, otherwise
	18	your Class' @ISA will not linearise with C3.
	19
	20	rafl to fix this bit :)
	21
	22	=head2 Components without new methods
	23
	24	FIXME
	25
	26	=head2 Components without COMPONENT methods
	27
	28	FIXME
	29
	30	=head2 __PACKAGE__->mk_accessor('meta');
	31
	32	Won't work due to a limitation of L<MooseX::Emulate::Class::Accessor::Fast>
	33
	34	FIXME
	35
	36	=head2 Class::Data::Inheritable side effects
	37
	38	FIXME
	39
	40	=head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessor
	41
	42	FIXME
	43
	44	=head2 require $class was successful but the package is not defined.
	45
	46	FIXME Warning
	47
	48	=head2 Components which inherit Catalyst::Component's COMPONENT method, who's new method does not return a true value.
	49
	50	Previously if your new method returned a false value, then your class' configuration would be blessed into a hash on your behalf,
	51	and this would be returned from the COMPONENT method. This is no longer supported. You are not recommended to implement your own new method
	52	in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality
	53	to perform any construction work necessary for your sub-class.
	54
	55
	56	=head Methods in Catalyst::Dispatcher
	57
	58	Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
	59	. "this will be removed in Catalyst 5.9X"
	60
	61	FIXME
	62
	63	=head2 Confused multiple inheritence with Catalyst::Component::COMPONENT
	64
65	Warning message:
66
67	There is a COMPONENT method resolving after Catalyst::Component
68	in ${next_package}.
69
70	This means that one of the packages on the right hand side of
71	Catalyst::Component in your Class' inheritance hierarchy defines
72	a COMPONENT method.
73
74	Previously, Catalyst's COMPONENT method would delegate to the
75	method on the right hand side, which could then delegate back again
76	with NEXT. This (as it is insane), is no longer supported, as it
77	makes no sense with C3 method dispatch order.
78
79	Therefore the correct fix is to re-arrange your class' inheritance
80	hierarchy so that the COMPONENT method you would like to inherit is
81	the first COMPONENT method in your @ISA.
82
83
84	=cut