view release on metacpan or  search on metacpan

lib/Catalyst/Delta.pod  view on Meta::CPAN

Catalyst::Delta - Overview of changes between versions of Catalyst

=head1 DESCRIPTION

This is an overview of the user-visible changes to Catalyst between major
Catalyst releases.

=head2 VERSION 5.90105

This version primarily fixed a regression in the way we preserved $c->state
which the previous version introduced.  Now in the case when you forward to
an action, should that action throw an exception it sets state to 0 and is
sure that the return value is false.  This is to meet expected behavior based
on the documentation.  If you relied on the last update behavior you may not have
regressions but it was thought that we should make the code behave as documented
for more than 10 years.

We also changed how we compose the request, response and stats base class.  We
now compose the base class with any configured traits once at the end of the
application setup, rather than for each request.  This reduced request overhead
when you are composing lots of traits.  It possible this may break some code that
was adding traits after the application setup was finalized.  Please shout out if
this actually causes you trouble and we'll do the best to accommodate.

=head2 VERSION 5.90102 - 5.90103

A significant change is that we now preserve the value of $c->state from action
to following action.  This gives you a new way to pass a value between actions
in a chain, for example.   However any 'auto' actions always have $c->state
forced to be set to 0, which is the way its been for a long time, this way an
auto action is required to return 1 to pass the match.  It also exists to maintain
compatibility with anyone that exits an auto action with a detach (which is not a
documented way to escape matching, but exists in the wild since it worked as a
side effect of the code for a long time).

Additionally, upon $c->detach we also force set state to 0.

Version 5.90102 contains a version of this change but its considered buggy, so
that is a version to avoid.

=head2 VERSION 5.90100

Support for type constraints in Args and CaptureArgs has been improved.  You may
now inherit from a base controller that declares type constraints and use roles
that declare type constraints.  See L<Catalyst::RouteMatching> for more.

You may now. also use a full type constraint namespace instead of importing type
constraints into your package namespace.

We changed the way the middleware stash works so that it no longer localizes
the PSGI env hashref.  This was done to fix bugs where people set PSGI ENV hash
keys and found them to disappear in certain cases.  It also means that now if
a sub applications sets stash variables, that stash will now bubble up to the
parent application.  This may be a breaking change for you since previous
versions of this code did not allow that.  A workaround is to explicitly delete
stash keys in your sub application before returning control to the parent
application.

=head2 VERSION 5.90097

=head3 Defined how $c->uri_for adds a URI fragment.

We now have a specification for creating URIs with fragments (or HTML anchors).
Previously you could do this as a side effect of how we create URIs but this
side effect behavior was never documented or tested, and was broken when we
introduced default UTF-8 encoding.  When creating URIs with fragments please
follow the new, supported specification:

    $c->uri_for($action_or_path, \@captures_or_args, @args, \$query, \$fragment);

This will be a breaking change for some codebases, we recommend testing if
you are creating URLs with fragments.

B<NOTE> If you are using the alternative:

    $c->uri_for('/foo/bar#baz')

construction, we do not attempt to encode this and it will make a URL with a
fragment of 'baz'.

=head2 VERSION 5.90094

=head3 Multipart form POST with character set headers

When we did the UTF8 work, we punted on Form POSTs when the POST envelope was
multipart and each part had complex headers such as content-types, character
sets and so forth.  In those cases instead of returning a possibly incorrect
value, we returned an object describing the part so that you could figure it
out manually.  This turned out to be a bad workaround as people did not expect
to find that object.  So we changed this to try much harder to get a correct
value.  We still return an object if we fail but we try much harder now.  If
you used to check for the object you might find that code is no longer needed
(although checking for it should not hurt or break anything either).

=head2 VERSION 5.90091

=head3 'case_sensitive' configuration

At one point in time we allowed you to set a 'case_sensitive' configuration value so
that you could find actions by their private names using mixed case.  We highly
discourage that.  If you are using this 'feature' you should be on notice that we
plan to remove the code around it in the near future.

=head2 VERSION 5.90090+

=head3 Type constraints on Args and CaptureArgs.

You may now use a type constraint (using L<Moose>, L<MooseX::Types> or preferably
L<Type::Tiny> in your Args or CaptureArgs action attributes.  This can be used
to restrict the value of the Arg.  For example:

    sub myaction :Local Args(Int) { ... }

Would match '.../myaction/5' but not '.../myaction/string'.

When an action (or action chain) has Args (or CaptureArgs) that declare type constraints
your arguments to $c->uri_for(...) must match those constraints.

See L<Catalyst::RouteMatching> for more.

=head3 Move CatalystX::InjectComponent into core

L<Catalyst::Utils> has a new method 'inject_component' which works the same as the method of
the same name in L<CatalystX::InjectComponent>.

=head3 inject_components

New configuration key allows you to inject components directly into your application without
any subclasses.  For example:

    MyApp->config({
      inject_components => {
        'Controller::Err' => { from_component => 'Local::Controller::Errors' },
        'Model::Zoo' => { from_component => 'Local::Model::Foo' },
        'Model::Foo' => { from_component => 'Local::Model::Foo', roles => ['TestRole'] },
      },
      'Controller::Err' => { a => 100, b=>200, namespace=>'error' },
      'Model::Zoo' => { a => 2 },
      'Model::Foo' => { a => 100 },