Move main synopsis of changes from changelog to Catalyst::Delta
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Delta.pod
1 =head1 NAME
2
3 Catalyst::Delta - Overview of changes between versions of Catalyst
4
5 =head1 DESCRIPTION
6
7 This is an overview of the user-visible changes to Catalyst between major Catalyst releases.
8
9 =head2 VERSION 5.9XXX 'cataplack'
10
11 The Catalyst::Engine sub-classes have all been removed and deprecated,
12 to be replaced with Plack handlers.
13
14 Plack is an implementation of the L<PSGI> specification, which is
15 a standard interface between web servers and application frameworks.
16
17 This should be no different for developers, and you should not have to
18 migrate your applications unless you are using a custom engine already.
19
20 This change benefits Catalyst significantly by reducing the amount of
21 code inside the framework, and means that the framework gets upstream
22 bug fixes in L<Plack>, and automatically gains support for any web server
23 which a L<PSGI> compliant handler is written for.
24
25 It also allows you more flexibility with your application, and allows
26 the use of cross web framework 'middleware'.
27
28 Developers are recommended to read L<Catalyst::Upgrading> for notes about
29 upgrading, especially if you are using an unusual deployment method.
30
31 Documentation for how to take advantage of L<PSGI> can be found in
32 L<Catalyst::PSGI>, and information about deploying your application
33 has been moved to L<Catalyst::Manual::Deployment>.
34
35 =head3 Updated modules:
36
37 A number of modules have been updated to pass their tests or not
38 produce deprecation warnings with the latest version of Catalyst.
39 It is recommended that you upgrade any of these that you are using
40 after installing this version of Catalyst.
41
42 These extensions are:
43
44 =over
45
46 =item L<Catalyst::Engine::HTTP::Prefork>
47
48 This is now deprecated, see L<Catalyst::Upgrading>.
49
50 =item L<Test::WWW::Mechanize::Catalyst>
51
52 Has been updated to not produce deprecation warnings, upgrade recommended.
53
54 =item Catalyst::ActionRole::ACL
55
56 Has been updated to fix failing tests (although older versions still
57 function perfectly with this version of Catalyst).
58
59 =item Catalyst::Plugin::Session::Store::DBIC
60
61 Has been updated to fix failing tests (although older versions still
62 function perfectly with this version of Catalyst).
63
64 =back
65
66 =head1 PREVIOUS VERSIONS
67
68 =head2 VERSION 5.8XXX 'catamoose'
69
70 =head3 Deprecations
71
72 Please see L<Catalyst::Upgrading> for a full description of how changes in the
73 framework may affect your application.
74
75 Below is a brief list of features which have been deprecated in this release:
76
77 =over
78
79 =item ::[MVC]:: style naming scheme has been deprecated and will warn
80
81 =item NEXT is deprecated for all applications and components, use MRO::Compat
82
83 =item Dispatcher methods which are an implementation detail made private, public versions now warn.
84
85 =item MyApp->plugin method is deprecated, use L<Catalyst::Model::Adaptor> instead.
86
87 =item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code.
88
89 =item Use of Catalyst::Base now warns
90
91 =back
92
93 =head3 New features
94
95 =head3 Dispatcher
96
97 =over
98
99 =item Fix forwarding to Catalyst::Action objects.
100
101 =item Add the dispatch_type method
102
103 =back
104
105 =head3 Restarter
106
107 The development server restarter has been improved to be compatible with
108 immutable Moose classes, and also to optionally use 
109 L<B::Hooks::OP::Check::StashChange> to handle more complex application layouts
110 correctly.
111
112 =head3 $c->uri_for_action method.
113
114 Give a private path to the Catalyst action you want to create a URI for.
115
116 =head3 Logging
117
118 Log levels have been made additive.
119
120 =head3 L<Catalyst::Test>
121
122 =over
123
124 =item Change to use L<Sub::Exporter>.
125
126 =item Support mocking multiple virtual hosts
127
128 =item New methods like action_ok and action_redirect to write more compact tests
129
130 =back
131
132 =head3 Catalyst::Response
133
134 =over
135
136 =item *
137
138 New print method which prints @data to the output stream, separated by $,.  
139 This lets you pass the response object to functions that want to write to an 
140 L<IO::Handle>.
141
142 =item *
143
144 Added code method as an alias for C<< $res->status >>
145
146 =back
147
148 =head3 Consequences of the Moose back end
149
150 =over
151
152 =item *
153
154 Components are fully compatible with Moose, and all Moose features, such as
155 method modifiers, attributes, roles, BUILD and BUILDARGS methods are fully
156 supported and may be used in components and applications.
157
158 =item *
159
160 Many reusable extensions which would previously have been plugins or base 
161 classes are better implemented as Moose roles.
162
163 =item *
164
165 L<MooseX::MethodAttributes::Inheritable> is used to contain action
166 attributes. This means that attributes are represented in the MOP, and
167 decouples action creation from attributes.
168
169 =item *
170
171 There is a reasonable API in Catalyst::Controller for working with
172 and registering actions, allowing a controller sub-class to replace
173 subroutine attributes for action declarations with an alternate
174 syntax.
175
176 =item *
177
178 Refactored capturing of $app from L<Catalyst::Controller> into
179 L<Catalyst::Component::ApplicationAttribute> for easier reuse in other
180 components.
181
182 =item *
183
184 Your application class is forced to become immutable at the end of compilation.
185
186 =back
187
188 =head3 Bug fixes
189
190 =over
191
192 =item *
193
194 Don't ignore SIGCHLD while handling requests with the development server, so that
195 system() and other ways of creating child processes work as expected.
196
197 =item *
198
199 Fixes for FastCGI when used with IIS 6.0
200
201 =item *
202
203 Fix a bug in uri_for which could cause it to generate paths with multiple 
204 slashes in them.
205
206 =item *
207
208 Fix a bug in Catalyst::Stats, stopping garbage being inserted into
209 the stats if a user calls begin => but no end
210
211 =back
212