Merge branch 'master' of github.com:Pylons/pyramid

1 files changed, 141 insertions, 27 deletions

diff --git a/CHANGES.txt b/CHANGES.txt
index 5cfd5e70d..cb28d880b 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,5 +1,30 @@
-Next Release
-============
+Unreleased
+==========
+
+Bug Fixes
+---------
+
+- Fix the ``pcreate`` script so that when the target directory name ends with a 
+  slash it does not produce a non-working project directory structure.  
+  Previously saying ``pcreate -s starter /foo/bar/`` produced different output 
+  than  saying ``pcreate -s starter /foo/bar``.  The former did not work
+  properly.
+
+- Fix the ``principals_allowed_by_permission`` method of 
+  ``ACLAuthorizationPolicy`` so it anticipates a callable ``__acl__`` 
+  on resources.  Previously it did not try to call the ``__acl__``
+  if it was callable.
+
+Documentation
+-------------
+
+- Added a "Quick Tutorial" to go with the Quick Tour
+
+- Removed mention of ``pyramid_beaker`` from docs.  Beaker is no longer 
+  maintained.  Point people at ``pyramid_redis_sessions`` instead.
+
+1.5a2 (2013-09-22)
+==================
 
 Features
 --------
@@ -18,38 +43,126 @@ Bug Fixes
 Backwards Incompatibilities
 ---------------------------
 
-- Pyramid has dropped native support for the Mako and Chameleon renderers. To
-  re-add support for these renderers into existing projects there are 3 steps:
+- Pyramid no longer depends on or configures the Mako and Chameleon templating
+  system renderers by default.  Disincluding these templating systems by
+  default means that the Pyramid core has fewer dependencies and can run on
+  future platforms without immediate concern for the compatibility of its
+  templating add-ons.  It also makes maintenance slightly more effective, as
+  different people can maintain the templating system add-ons that they
+  understand and care about without needing commit access to the Pyramid core,
+  and it allows users who just don't want to see any packages they don't use
+  come along for the ride when they install Pyramid.
+
+  This means that upon upgrading to Pyramid 1.5a2+, projects that use either
+  of these templating systems will see a traceback that ends something like
+  this when their application attempts to render a Chameleon or Mako template::
+
+     ValueError: No such renderer factory .pt
+
+  Or::
+
+     ValueError: No such renderer factory .mako
+
+  Or::
+
+     ValueError: No such renderer factory .mak
+
+  Support for Mako templating has been moved into an add-on package named 
+  ``pyramid_mako``, and support for Chameleon templating has been moved into 
+  an add-on package named ``pyramid_chameleon``.  These packages are drop-in 
+  replacements for the old built-in support for these templating langauges. 
+  All you have to do is install them and make them active in your configuration
+  to register renderer factories for ``.pt`` and/or ``.mako`` (or ``.mak``) to
+  make your application work again.
+
+  To re-add support for Chameleon and/or Mako template renderers into your
+  existing projects, follow the below steps.
 
-  - Add `pyramid_mako` and/or `pyramid_chameleon` as dependencies by
-    adding them to the `install_requires` section of the package's `setup.py`::
+  If you depend on Mako templates:
+
+  * Make sure the ``pyramid_mako`` package is installed.  One way to do this
+    is by adding ``pyramid_mako`` to the ``install_requires`` section of your
+    package's ``setup.py`` file and afterwards rerunning ``setup.py develop``::
 
         setup(
             #...
             install_requires=[
                 'pyramid_mako',         # new dependency
-                'pyramid_chameleon',    # new dependency
                 'pyramid',
                 #...
             ],
         )
 
-  - Update instances of the ``pyramid.config.Configurator`` to include the
-    required addons::
+  * Within the portion of your application which instantiates a Pyramid 
+    ``pyramid.config.Configurator`` (often the ``main()`` function in 
+    your project's ``__init__.py`` file), tell Pyramid to include the 
+    ``pyramid_mako`` includeme::
 
-        config.include('pyramid_chameleon')
+        config = Configurator(.....)
         config.include('pyramid_mako')
 
-  - If any unit tests are invoking either ``pyramid.renderers.render()`` or
-    ``pyramid.renderers.render_to_response()`` with either Mako or Chameleon
-    templates then the ``pyramid.config.Configurator`` instance at the root of
-    the unit test should be also be updated to include the addons, as shown
-    above. For example::
+  If you depend on Chameleon templates:
 
-        config = pyramid.testing.setUp()
-        config.include('pyramid_mako')
+  * Make sure the ``pyramid_chameleon`` package is installed.  One way to do
+    this is by adding ``pyramid_chameleon`` to the ``install_requires`` section
+    of your package's ``setup.py`` file and afterwards rerunning 
+    ``setup.py develop``::
+
+        setup(
+            #...
+            install_requires=[
+                'pyramid_chameleon',         # new dependency
+                'pyramid',
+                #...
+            ],
+        )
+
+  * Within the portion of your application which instantiates a Pyramid 
+    ``~pyramid.config.Configurator`` (often the ``main()`` function in 
+    your project's ``__init__.py`` file), tell Pyramid to include the 
+    ``pyramid_chameleon`` includeme::
+
+        config = Configurator(.....)
+        config.include('pyramid_chameleon')
 
-        result = pyramid.renderers.render('mypkg:templates/home.mako', {})
+  Note that it's also fine to install these packages into *older* Pyramids for
+  forward compatibility purposes.  Even if you don't upgrade to Pyramid 1.5
+  immediately, performing the above steps in a Pyramid 1.4 installation is
+  perfectly fine, won't cause any difference, and will give you forward
+  compatibility when you eventually do upgrade to Pyramid 1.5.
+
+  With the removal of Mako and Chameleon support from the core, some
+  unit tests that use the ``pyramid.renderers.render*`` methods may begin to 
+  fail.  If any of your unit tests are invoking either 
+  ``pyramid.renderers.render()``  or ``pyramid.renderers.render_to_response()``
+  with either Mako or Chameleon templates then the 
+  ``pyramid.config.Configurator`` instance in effect during
+  the unit test should be also be updated to include the addons, as shown
+  above. For example::
+
+        class ATest(unittest.TestCase):
+            def setUp(self):
+                self.config = pyramid.testing.setUp()
+                self.config.include('pyramid_mako')
+
+            def test_it(self):
+                result = pyramid.renderers.render('mypkg:templates/home.mako', {})
+
+  Or::
+
+        class ATest(unittest.TestCase):
+            def setUp(self):
+                self.config = pyramid.testing.setUp()
+                self.config.include('pyramid_chameleon')
+
+            def test_it(self):
+                result = pyramid.renderers.render('mypkg:templates/home.pt', {})
+
+- If you're using the Pyramid debug toolbar, when you upgrade Pyramid to
+  1.5a2+, you'll also need to upgrade the ``pyramid_debugtoolbar`` package to 
+  at least version 1.0.8, as older toolbar versions are not compatible with 
+  Pyramid 1.5a2+ due to the removal of Mako support from the core.  It's 
+  fine to use this newer version of the toolbar code with older Pyramids too.
 
 - Removed the ``request.response_*`` varying attributes. These attributes
   have been deprecated since Pyramid 1.1, and as per the deprecation policy,
@@ -62,10 +175,6 @@ Backwards Incompatibilities
   only necessary when the renderer is generating a response; it was a bug
   when it was done as a side effect of calling ``pyramid.renderers.render()``.
 
-- The Mako and Chameleon renderers have been removed from Pyramid.  Their 
-  functionality has been moved to  the ``pyramid_mako`` and 
-  ``pyramid_chameleon`` distributions respectively.
-
 - Removed the ``bfg2pyramid`` fixer script.
 
 - The ``pyramid.events.NewResponse`` event is now sent **after** response 
@@ -82,7 +191,7 @@ Backwards Incompatibilities
   instead.
 
 - Removed the ability to pass the following arguments to
-  ``pyramid.config.Configurator.add_route``: `view``, ``view_context``.
+  ``pyramid.config.Configurator.add_route``: ``view``, ``view_context``.
   ``view_for``, ``view_permission``, ``view_renderer``, and ``view_attr``.
   Using these arguments had been deprecated since Pyramid 1.1.  Instead of
   passing view-related arguments to ``add_route``, use a separate call to
@@ -112,6 +221,13 @@ Backwards Incompatibilities
   Pyramid narrative documentation instead of providing renderer globals values
   to the configurator.
 
+Deprecations
+------------
+
+- The ``pyramid.config.Configurator.set_request_property`` method now issues
+  a deprecation warning when used.  It had been docs-deprecated in 1.4
+  but did not issue a deprecation warning when used.
+
 1.5a1 (2013-08-30)
 ==================
 
@@ -156,7 +272,7 @@ Features
   The above example will ensure that the view is called if the request method
   is not POST (at least if no other view is more specific).
 
-  The :class:`pyramid.config.not_` class can be used against any value that is
+  The ``pyramid.config.not_`` class can be used against any value that is
   a predicate value passed in any of these contexts:
 
   - ``pyramid.config.Configurator.add_view``
@@ -225,9 +341,7 @@ Features
   In the past, only the most specific type containing views would be checked
   and if no matching view could be found then a PredicateMismatch would be
   raised. Now predicate mismatches don't hide valid views registered on
-  super-types. Here's an example that now works:
-
-  .. code-block:: python
+  super-types. Here's an example that now works::
 
      class IResource(Interface):