Merge branch 'master' into australorp
[catagits/Catalyst-Runtime.git] / Changes
diff --git a/Changes b/Changes
index bc44660..8fd50ce 100644 (file)
--- a/Changes
+++ b/Changes
 # This file documents the revision history for Perl extension Catalyst.
 
-  - Announcing the repo is not open for development of Perl Catalyst 'Runner'
-  - http://questhub.io/realm/perl/explore/latest/tag/runner
-
-5.90059_003 - TBA
+5.90089_001 - TBA
+
+5.90084 - 2015-02-23
+  - Small change to the way body parameters are created in order to prevent
+    trying to create parameters twice.
+  - Use new HTTP::Body and code updates to fix issue when POSTed params have
+    non UTF-8 charset encodings or otherwise complex upload parts that are not
+    file uploads. In these cases when Catalyst can't determine what the value of
+    a form upload is, will return an instance of Catalyst::Request::PartData with
+    all the information need to figure it out.  Documentation about this corner
+    case. For RT https://rt.cpan.org/Ticket/Display.html?id=101556
+  - Two new application configuration parameters 'skip_body_param_unicode_decoding'
+    and 'skip_complex_post_part_handling' to assist you with any backward
+    compatibility issues with all the new UTF8 work in the most recent stable
+    Catalyst.  You may use these settings to TEMPORARILY disable certain new
+    features while you are seeking a long term fix.
+
+5.90083 - 2015-02-16
+  - Fixed typo in support for OPTIONS method matching (andre++)
+  - Stop using $env->{'plack.request.query'} as a query parsing optimization
+    since 1) it doesn't belong to us and 2) there's subtle differences in the
+    way plack parses parameters and catalyst does.  This fixes a bug when you
+    are using middleware that uses Plack::Request to do its thing.  This change
+    might have subtle impact on query parsing.  Please test this change!
+
+5.90082 - 2015-01-10
+  - Fixed a regression created in $response->from_psgi_response and test case
+    to prevent it happening again.
+
+5.90081 - 2015-01-10
+  - created class attribute 'finalized_default_middleware' which determines
+    if the default middleware has been added to the stack yet or not.  This
+    removes a horrible hack that polluted the configuration hash.  Added
+    test case to prevent regressions.
+
+5.90080 - 2015-01-09
+>>>>>>> master
+  - Minor documentation corrections
+  - Make the '79 development series stable
+
+5.90079_008  - 2015-01-07
+  - If we get a response set from $res->from_psgi_response and that response
+    has a charset for the content type, we clear encoding for the rest of the
+    response (avoid double encoding).  Added more documentation around this.
+  - Documentation updates and typo fixes across various UTF8 docs (Mark Ellis++)
+
+5.90079_007  - 2015-01-07
+  - Merged from Stable (5.90079)
+  - reviewed and cleaned up UTF8 related docs
+  - replace missing utf8 pragma in Catalyst::Engine
+  - Cleaned up spelling errors in various docs (abbraxxa++)
+  - New document Catalyst::UTF8 which attempts to summarize UTF8 and encoding
+    changes introduced in v5.90080.
+
+5.90079_006  - 2015-01-02
+  - Removed unneeded dependency on RenderView in new test case that was causing fails
+    on CPAN testers that did not just happen to have that dependency already installed
+  - Updated copyright notices to 2015
+  - Documentation patches around the setup methods and clarification on on security
+    note posted a few months ago.
+  - Added my name to the contributors list
+
+5.90079_005 - 2014-12-31
+  - Merged changes from 5.90078
+  - If configuration 'using_frontend_proxy' is set, we add the correct middleware
+    to the default middleware list.  This way you get the correct and expected
+    behavior if you are starting your application via one of the generated scripts
+    or if you are calling MyApp->psgi_app.  Previously if you started the application
+    with ->psgi_app (or to_app) we ignored this configuration option
+  - New configuration option 'using_frontend_proxy_path' which enables
+    Plack::Middleware::ReverseProxyPath on your application easily.  Please note that
+    Plack::Middleware::ReverseProxyPath is not an automatic dependency of Catalyst at
+    this time, so if you want this feature you should add it to your project dependency
+    list.  This is done to avoid continued growth of Catalyst dependencies.
+  - Tweaks encoding docs a bit to get closer to final.
+
+5.90079_004 - 2014-12-26
+  - Starting adding some docs around the new encoding stuff
+  - Exposed the reqexp we use to match content types that need encoding via a
+    global variable.
+  - Added some test cases for JSON utf8 and tested file uploads with utf8.
+  - Fixes to decoding on file upload filenames and related methods
+  - new methods on upload object that tries to do the right thing if we find
+    a character set on the upload and its UTF8.
+  - new additional helper methods on the file upload object.
+  - new helper methods has_encoding and clear_encoding on context.
+  - Method on Catalyst::Response to determine if the response should be encoded.
+  - Warn if changing headers only if headers are finalized AND the response callback
+    has already been called (and headers already sent).
+  - Centralized rules about detecting if we need to automatically encode or not and
+    added tests around cases when you choose to skip auto encoding.
+
+5.90079_003 - 2014-12-03
+  - Make sure all tests run even if debug mode is enabled.
+  - Fixed issue with middleware stash test case that failed on older Perls
+
+5.90079_002 - 2014-12-02
+  - Fixed typo in Makefile.PL which borked the previous distribution. No other
+    changes.
+
+5.90079_001 - 2014-12-02
+  - MyApp->to_app is now an alias for MyApp->psgi_app in order to better support
+    existing Plack conventions.
+  - Modify Catalyst::Response->from_psgi_response to allow the first argument to
+    be an object that does ->as_psgi.
+  - Modified Catalyst::Middleware::Stash to be a shallow copy in $env.  Added some
+    docs.  Added a test case to make sure stash keys added in a child application
+    don't bubble back up to the main application.
+  - We no longer use Encode::is_utf8 since it doesn't work the way we think it
+    does... This required some UTF-8 changes.  If your application is UTF-8 aware
+    I highly suggest you test this release.
+  - We always do utf8 decoding on incoming URLs (before we only did so if the server
+    encoding was utf8.  I believe this is correct as per the w3c spec, but please
+    correct if incorrect :)
+  - Debug output now shows utf8 characters if those are incoming via Args or as
+    path or pathparts in your actions.  query and body parameter keys are now also
+    subject to utf8 decoding (or as specified via the encoding configuration value).
+  - lots of UTF8 changes.  Again we think this is now more correct but please test.
+  - Allow $c->res->redirect($url) to accept $url as an object that does ->as_string
+    which I think will ease a common case (and common bug) and added documentation.
+  - !!! UTF-8 is now the default encoding (there used to be none...).  You can disable
+    this if you need to with MyApp->config(encoding => undef) if it causes you trouble.
+  - Calling $c->res->write($data) now encodes $data based on the configured encoding
+    (UTF-8 is default).
+  - $c->res->writer_fh now returns Catalyst::Response::Writer which is a decorator
+    over the PSGI writer and provides an additional method 'write_encoded' that just
+    does the right thing for encoding your responses.  This is probably the method
+    you want to use.
+  - New dispatch matching attribute: Scheme.  This lets you match a route based on
+    the incoming URI scheme (http, https, ws, wss).
+  - If $c->uri_for targets an action or action chain that defines Scheme, use that
+    scheme for the generated URI object instead of just using whatever the incoming
+    request uses.
+
+5.90079 - 2015-01-02
+  - Removed dependency from test case that we don't install for testing (
+    rt #101243)
+  - updated year in copyright notices
+
+5.90078 - 2014-12-30
+  - POD corrections (sergey++)
+  - New configuration option to disable the HTTP Exception passthrough feature
+    introduced in 5.90060.  You can use this if that feature is causing you
+    trouble. (davewood++);
+  - Some additional helper methods for dealing with errors.
+  - More clear exception when $request->body_data tries to parse malformed POSTed
+    data.  Added documentation and tests around this.
+
+5.90077 - 2014-11-18
+  - We store the PSGI $env in Catalyst::Engine for backcompat reasons.  Changed
+    this so that the storage is a weak reference, so that it goes out of scope
+    with the request.  This solves an issue where items in the stash (now in the
+    PSGI env) would not get closed at the end of the request.  This caused some
+    regression, primarily in custom testing classes.
+
+5.90076 - 2014-11-13
+  - If throwing an exception object that does the code method, make sure that
+    method returns an expected HTTP status code before passing it on to the
+    HTTP Exception middleware.
+
+5.90075 - 2014-10-06
+  - Documentation patch for $c->req->param to point out the recently discovered
+    potential security issues: http://blog.gerv.net/2014/10/new-class-of-vulnerability-in-perl-web-applications/
+  - You don't need to install this update, but you should read about the exploit
+    and review if your code is vulnerable.  If you use the $c->req->param interface
+    you really need to review this exploit.
+
+5.90074 - 2014-10-01
+  - Specify Carp minimum version to avoid pointless test fails (valy++)
+
+5.90073 - 2014-09-23
+  - Fixed a regression caused by the last release where we broke what happened
+    when you tried to set request parameters via $c->req->param('foo', 'bar').
+    You shouldn't do this, but I guess I shouldn't have busted it either :)
+  - Allow the term_width to be regenerated (see Catalyst::Utils::term_width,
+    Frew Schmidt)
+  - More aggressive skipping of value decoding if the value is undefined.
+
+5.90072 - 2014-09-15
+  - In the case where you call $c->req->param(undef), warn with a more useful
+    warning (now gives the line of your code that called param with the undef,
+    so you can go to hunt it out.
+
+5.90071 - 2014-08-10
+  - Travis config now performs basic reverse dependency testing.
+  - Restored deprecated 'env' code in Engine.pm b/c it is still being used out
+    in the wild (Catalyst-Plugin-Authentication-0.10023) - (removed in 5.90070)
+  - Reverted changes to debug log/handling (5.90069_003) to fix
+    rev dep Catalyst-Plugin-Static-Simple-0.32 test suite.
+  - Added Italian translation of default error.
+
+5.90070 - 2014-08-07
+  - Retagged previous release as stable; no changes
+
+5.90069_004
+  - Fixed typo in middleware stash that was causing older Perls to fail
+    certain tests.  No other changes.
+
+5.90069_003
+  - The default log level is now 'info', not 'debug'.
+  - Finished merging all the encoding plugin code to core code.  The encoding
+    plugin is now just an empty package.  Also tried to improve encoding docs
+    a bit.
+  - Some additional changes to the stash middleware that should not break
+    anything new.
+  - Documentation around using Sendfile type http headers with a filehandle
+    type response.
+  - Merged from master branch to pick up some additional fixes and documentation
+    improvements.
+
+5.90069_002
+  - Catalyst stash functionality has been moved to Middleware.  It should
+    work entirely the same when used as a context method, please report
+    questions or problems!
+  - Removed code related to supporting the long deprecated stand alone
+    PSGI Engine.  If you are still using this you code is now broken.
+    Luckily you can just stop using it and likely everything will work
+    under the new PSGI support built into Catalyst for several years.
+  - 'abort_chain_on_error_fix' now defaults to true.  If this behavior
+    causes you issues, you can explicitly turn it off by setting it to a 
+    non true defined value (0 is a good option here).
+  - When throwing an http style exception, make sure we properly flush the
+    existing log and report other errors in the error stack.
+
+5.90069_001
+  - Set encoding on STDERR when encoding is set in config
+  - documentation and test fixes
+
+5.90065 - 2014-06-04
+  - The Catalyst::Log object now has 'autoflush' (which defaults to true) and
+    causes log messages to be written out in real-time. This is helpful for the
+    test/dev server to be able to see messages during startup as well as before
+    the end of the request when the log is flushed.
+  - Fix spelling, grammar and structural errors in POD
+  - Remove redundant ->setup call in t/head_middleware.t RT#95361
+  - Fix test failures when running under CATALYST_DEBUG. RT#95358
+
+5.90064 - 2014-05-05
+  - Fix for mindless broken tests on Win32 (Haarg++).
+  - Happy Cinco de Mayo!
+
+5.90063 - 2014-05-01
+  - 'end' and other special actions won't catch HTTP style exceptions anymore.
+  - Fix bug where Catalyst did not properly detect the terminal width when in
+    debug mode and thus making the debug output narrow and hard to read.
+  - Documentation corrections for Util methods around localized PSGI $env.
+  - Improvements to auto detection of terminal width.
+  - Updating deprecation list to include Class::Load and ensure_class_loaded
+  - Added a few docs around middleware and corrected the order that middleware
+    is loaded when registering it via ->setup_middleware instead of via
+    configuration.
+  - Added a test case to make sure default middleware order is correct.
+s
+5.90062 - 2014-04-14
+  - HTTP::Exception objects were not properly bubbled up to middleware since
+    there was some code in Catalyst that was triggering stringification.
+
+5.90061 - 2014-03-10
+  - Reverted a change related to how plugins get initialized that was
+    introduced by a change in December.
+
+5.90060 - 2014-02-07
+  - Same as 5.90059_006, just marking it as stable, no functional changes.
+
+
+5.90059_006 - 2014-02-06
+  - MyApp->setup now returns $app to allow class method chaining.
+  - New Util helper functional localize $env to make it easier to mount PSGI
+    applications under controllers and actions.  See Catalyst::Utils/PSGI Helpers.
+  - NOTICE: Final Development release for Runner, unless significant issues are
+    raised.  Please test.
+
+5.90059_005 - 2014-01-28
+  - Specify newest versions of some middleware in attempt to solve test errors
+    reported while installing.  
+5.90059_004 - 2014-01-27
+  - Make sure IO handle objects do 'getline' before sending them to the
+    response callback, to properly support the PSGI specification.
+  - Added some backcompat code when setting a response body to an object
+    that does 'read' but not 'getline'.  Added deprecation notice for this
+    case.  Added docs to Catalyst::Delta.
+  - Catalyst::Delta contains a list of behaviors which will be considered
+    deprecated immediately.  Most items have workarounds and tweaks you can
+    make to avoid issues.  These deprecations are targeted for removal/enforcement
+    in the Catalyst 6 release.  Please review and give your feedback.
+  - More middleware to replace inline code (upasana++)
+  - Documentation around Exceptions and how we handle them.
+  - update copyright notices.
+
+5.90059_003 - 2013-12-24
   - More documentation about alternative ways to setup middleware.
+  - removed unneeded use of Devel::Dwarn in test case that was causing
+    fails to install (sorry).
+  - When finalizing caught errors, if the error conforms to the interface as
+    described by Plack::Middleware::HTTPExceptions, rethrow it and let the
+    middleware deal with it.
 
 5.90059_002 - 2013-12-21
   - We now pass a scalar or filehandle directly to you Plack handler, rather
   - Give a more descriptive error message when trying to load middleware that
     does not exist.
   - Change the way we initialize plugins to fix a bug where when using the 
-    populare ConfigLoader plugin, configs merged are not available for setting
+    popular ConfigLoader plugin, configs merged are not available for setting
     up middleware and data handlers (and probably other things as well).
 
     NOTE: This change might cause issues if you had code that was relying on the
 
   - You may now also call 'setup_middleware' as a package method if you think
     that loading middleware via configuration is a weird or broken idea.
-  - Various POD formating fixed.
+  - Various POD formatting fixed.
   - Improved some documentation about what type of filehandles that ->body can
     accept and issues that might arise.
 
 5.90051 - 2013-11-06
-  - Be more skeptical of the existance of $request->env to fix a regression
+  - Be more skeptical of the existence of $request->env to fix a regression
     introduced in Catalyst::Action::REST by the previous release
 
 5.90050 - 2013-11-05
 
 5.90049_004 - 2013-10-18
   - JSON Data handler looks for both JSON::MaybeXS and JSON, and uses
-    whichever is first (prefering to find JSON::MaybeXS).  This should
+    whichever is first (preferring to find JSON::MaybeXS).  This should
     improve compatibility as you likely already have one installed.
   - Fixed a warning in the server script (bokutin++)
   - We now populate various Plack $env keys in order to play nice with
 
 5.90049_003 - 2013-09-20
   - Documented the new body_data method added in the previous release
-  - Merged from master many important bugfixes and forward compatiblity
+  - Merged from master many important bugfixes and forward compatibility
     updates, including:
     - Use modern preferred method for Moose metaclass access and many other
       small changes to how we use Moose for better forward compat (ether++)
     1) Only allow one of either :CaptureArgs or :Args
     2) :CaptureArgs() argument must be numeric
     3) :CaptureArgs() and :Args() arguments cannot be negative
-  - Add Devel::InnerPackage to dependencies, fixing tests on perl 5.17.11
+  - Add Devel::InnerPackage to dependencies, fixing tests on Perl 5.17.11
     as it's been removed from core. RT#84787
   - New support for closing over the PSGI $writer object, useful for working
     with event loops.
   - Added cpanfile as a way to notice we are a dev checkout.
   - Added 'x-tunneled-method' HTTP Header method override to match features in
     Catalyst::Action::REST and in other similar systems on CPAN.
-  - smarter valiation around action attributes.
+  - smarter validation around action attributes.
 
 5.90020 - 2013-02-22
   ! Catalyst::Action now defines 'match_captures' so it is no long considered
   - Some test and documentation improvements
 
 5.90019 - 2012-12-04 21:31:00
-  - Fix for perl 5.17.6 (commit g7dc8663). RT#81601
-  - Fix for perl 5.8. RT#61122
-  - Remove use of MooseX::Types as MooseX::Types is broken on perl5.8
+  - Fix for Perl 5.17.6 (commit g7dc8663). RT#81601
+  - Fix for Perl 5.8. RT#61122
+  - Remove use of MooseX::Types as MooseX::Types is broken on Perl 5.8
     RT#77100 & RT#81121
 
 5.90018 - 2012-10-23 20:55:00
 5.90016 - 2012-08-16 15:35:00
   - prepare_parameters is no longer an attribute builder.  It is now a method
     that calls the correct underlying functionality (Bill Moseley++)
-  - Updated Makefile.PL to handle MacOXS tar
+  - Updated Makefile.PL to handle MacOSX tar
   - Fix uri_for to handle a stringifiable object
   - Fix model/view/controller methods to handle stringifiable objects
   - Fix RT#78377 - IIS7 ignores response body for 3xx requests, which
     refactoring.
 
   - The Catalyst::Utils::home function is used to find if the application
-    is a checkout in Catalyst::ScriptRunner. This means that a non-existant
+    is a checkout in Catalyst::ScriptRunner. This means that a non-existent
     lib directory that is relative to the script install location is not
     included when not running from a checkout.
 
      application authors to add custom options to their scripts then
      get them passed through to the application.
 
-  Doumentation:
+  Documentation:
    - Clarify that if you manually write your own .psgi file, then optional
      proxy support (via the using_frontend_proxy config value) will not be
      enabled unless you explicitly apply the default middlewares from
    - Fix issue due to perl internals bugs in 5.8 and 5.10 (not present in
      other perl versions) require can pass the context inappropriately,
      meaning that some methods of loading classes can fail due to void
-     context being passed throuh to make_immutable, causing it to not return
+     context being passed through to make_immutable, causing it to not return
      a value.
      This bug caused loading Catalyst::Script::XXX to fail and is fixed
      both by bumping the Class::Load dependency, and also adding an explicit
 
    - Document how to get the vhost of the request in $c->req->hostname
      to avoid confusion
-   - Remove documentation showing Global / Regex / Private actionsi
+   - Remove documentation showing Global / Regex / Private actions
      as whilst these still exist (and work), they are not recommended.
    - Remove references to the -Engine flag.
    - Remove references to the deprecated Catalyst->plugin method
 5.90003 - 2011-10-05 08:32:00
   Bug fixes:
 
-   - Make default body reponses for 302s W3C compliant. RT#71237
+   - Make default body responses for 302s W3C compliant. RT#71237
 
    - Fix issue where groups of attributes to override controller actions
      in config would be (incorrectly) overwritten, if the parser for that
   Backward compatibility fixes:
 
    - Restore (an almost empty) Catalyst::Engine::HTTP to the dist for old
-     scripts which explictly require Catalyst::Engine::HTTP
+     scripts which explicitly require Catalyst::Engine::HTTP
 
   Documentation fixes:
 
 
     - nginx specific behaviour is removed as it is not needed with any
       web server configuration I can come up with (recommended config is
-      documented in Catalst::Manual::Deployment::nginx::FastCGI)
+      documented in Catalyst::Manual::Deployment::nginx::FastCGI)
 
 5.89003 2011-07-28 20:11:50 (TRIAL release)
 
   - Added a Catalyst::PSGI manual page with information about writing a .psgi
     file for your application.
 
-   - Catalyst::Uprading has been improved, and the status of old Catalyst
+   - Catalyst::Upgrading has been improved, and the status of old Catalyst
      engines clarified.
 
  Deprecations:
 
   Bug fixed:
    - $c->uri_for will now escape unsafe characters in captures
-     ($c->request->captures) and correctly encode utf8 charracters.
+     ($c->request->captures) and correctly encode utf8 characters.
 
 5.80020 2010-02-04 06:51:18
 
    - Restore -p option for pid file in the FastCGI server script.
    - Fix the script environment variables MYAPP_PORT and MYAPP_RELOAD RT#52604
    - Fix aliasing applications under non-root paths with mod_rewrite in
-     some apache versions where %ENV{SCRIPT_NAME} is set to the real name of
+     some Apache versions where %ENV{SCRIPT_NAME} is set to the real name of
      the script, by using $ENV{REDIRECT_URL} which contains the non-rewritten
      URI.
    - Fix usage display when myapp_create.pl is run with no arguments. RT#52630
     - Stop warnings when actions are forwarded to during dispatch.
     - Remove warnings for using Catalyst::Dispatcher->dispatch_types as this is a
       valid method to publicly call on the dispatcher.
-    - Args ($c->request->args) and CaptureArgs ($c->request->captrues)
+    - Args ($c->request->args) and CaptureArgs ($c->request->captures)
       passed to $c->uri_for with an action object ($c->action) will now
       correctly round-trip when args or captures contain / as it is now
       correctly uri encoded to %2F.
        - Fix POD to refer to ->config(key => $val), rather than
          ->config->{key} = $val, as the latter form is deprecated.
        - Clearer docs for the 'uri_for' method.
-       - Fix POD refering to CGI::Cookie. We're using CGI::Simple::Cookie.
+       - Fix POD referring to CGI::Cookie. We're using CGI::Simple::Cookie.
          (Forrest Cahoon)
 
 5.80007 2009-06-30 23:54:34
           in Catalyst::Engine (kmx)
 
 5.80004 2009-05-18 17:03:23
-        - Rename the actions attribute in Catalyt::Controller to
+        - Rename the actions attribute in Catalyst::Controller to
           _controller_actions to avoid name clashes with application
           controller naming. (random)
         - Test for using Moose in components which have a non-Moose base class
         - Fix RT#43375 by sorting results before testing them
         - Fixes for uri_for_action when using Catalyst::DispatchType::Regex
           + tests from RT#39369 (norbi)
-        - Partial rewrite and reoganisation of the C3 docs in
+        - Partial rewrite and reorganization of the C3 docs in
           Catalyst::Upgrading based on feedback from kiffin
         - If you make your application class immutable and turn off
           constructor inlining, Catalyst will die and tell you pass
 
 5.80002 2009-04-22 01:28:36
         - Fix CATALYST_DEBUG and MYAPP_DEBUG environment variables
-          turning debuging on if defined, rather than if set.
+          turning debugging on if defined, rather than if set.
           They now force debugging on or off, taking precedence over
           configuration in your application.
           - Tests for this
           allowing method modifiers on actions to work as expected.
         - Provide a reasonable API in Catalyst::Controller for working with
           and registering actions, allowing a controller sub-class to replace
-          subroutine attributes for action declerations with an alternate
+          subroutine attributes for action declarations with an alternate
           syntax.
         - Instantiate correct sub-class of Moose::Meta::Class for non-Moose
           components where Catalyst forces the creation of a metaclass instance.
           parameter used to be ignored, but started breaking if the parameter
           was not a hash in 5.8000_04. Extra parameter is now ignored if
           it isn't a hashref
-        - Fix request argumentss getting corrupted if you override the
+        - Fix request arguments getting corrupted if you override the
           dispatcher and call an action which detaches (for
           Catalyst::Plugin::Authorization::ACL)
         - Fix calling use Catalyst::Test 'MyApp' 'foo' which used to work,
           was introduced when attempting to allow "0" as a Path.
 
 5.7013  2008-05-16 18:20:00
-        - Provide backwards compatability methods in Catalyst::Stats
+        - Provide backwards compatibility methods in Catalyst::Stats
         - Fix subdirs for scripts that run in subdirs more than one level deep.
         - Added test and updated docs for handling the Authorization header
           under mod_fastcgi/mod_cgi.