Pyramid

==================

Bug Fixes
---------

- "Hybrid mode" applications (applications which explicitly used
traversal *after* url dispatch via ``<route>`` paths containing the
``*traverse`` element) were broken in 1.1-final and all 1.1 alpha
and beta releases. Views registered without a ``route_name`` route
shadowed views registered with a ``route_name`` inappropriately.

================

Internals
---------

- Remove dead IRouteRequirement interface from ``repoze.bfg.zcml``
module.

Documentation
-------------

- Improve the "Extending an Existing Application" narrative chapter.

- Add more sections to the "Defending Design" chapter.

==================

Bug Fixes
---------

- Use ``alsoProvides`` in the urldispatch module to attach an
interface to the request rather than ``directlyProvides`` to avoid
disturbing interfaces set in a NewRequest event handler.

Documentation
-------------

- Move 1.0.1 and previous changelog to HISTORY.txt.

- Add examples to ``repoze.bfg.url.model_url`` docstring.

- Add "Defending BFG Design" chapter to frontpage docs.

Templates
---------

- Remove ``ez_setup.py`` and its import from all paster templates,
samples, and tutorials for ``distribute`` compatibility. The
documentation already explains how to install virtualenv (which will
include some ``setuptools`` package), so these files, imports and
usages were superfluous.

Deprecations
------------

- The ``options`` kw arg to the ``repoze.bfg.router.make_app``
function is deprecated. In its place is the keyword argument
``settings``. The ``options`` keyword continues to work, and a
deprecation warning is not emitted when it is detected. However,
the paster templates, code samples, and documentation now make
reference to ``settings`` rather than ``options``. This
change/deprecation was mainly made for purposes of clarity and
symmetry with the ``get_settings()`` API and discussions of
"settings" in various places in the docs: we want to use the same
name to refer to the same thing everywhere.

==================

Features
--------

- ``repoze.bfg.testing.registerRoutesMapper`` testing facility added.
This testing function registers a routes "mapper" object in the
registry, for tests which require its presence. This function is
documented in the ``repoze.bfg.testing`` API documentation.

Bug Fixes
---------

- Compound statements that used an assignment entered into in an
interactive IPython session invoked via ``paster bfgshell`` no
longer fail to mutate the shell namespace correctly. For example,
this set of statements used to fail::

In [2]: def bar(x): return x
...:
In [3]: list(bar(x) for x in 'abc')
Out[3]: NameError: 'bar'

In this release, the ``bar`` function is found and the correct
output is now sent to the console. Thanks to Daniel Holth for the
patch.

- The ``bfgshell`` command did not function properly; it was still
expecting to be able to call the root factory with a bare
``environ`` rather than a request object.

Backwards Incompatibilities
---------------------------

- The ``repoze.bfg.scripting.get_root`` function now expects a
``request`` object as its second argument rather than an
``environ``.

==================

Bug Fixes
---------

- Prevent PyPI installation failure due to ``easy_install`` trying way
too hard to guess the best version of Paste. When ``easy_install``
pulls from PyPI it reads links off various pages to determine "more
up to date" versions. It incorrectly picks up a link for an ancient
version of a package named "Paste-Deploy-0.1" (note the dash) when
trying to find the "Paste" distribution and somehow believes it's
the latest version of "Paste". It also somehow "helpfully" decides
to check out a version of this package from SVN. We pin the Paste
dependency version to a version greater than 1.7 to work around
this ``easy_install`` bug.

Documentation
-------------

- Fix "Hybrid" narrative chapter: stop claiming that ``<view>``
statements that mention a route_name need to come afer (in XML
order) the ``<route>`` statement which creates the route. This
hasn't been true since 1.1a1.

- "What's New in ``repoze.bfg`` 1.1" document added to narrative
documentation.

Features
--------

- Add a new event type: ``repoze.bfg.events.AfterTraversal``. Events
of this type will be sent after traversal is completed, but before
any view code is invoked. Like ``repoze.bfg.events.NewRequest``,
This event will have a single attribute: ``request`` representing
the current request. Unlike the request attribute of
``repoze.bfg.events.NewRequest`` however, during an AfterTraversal
event, the request object will possess attributes set by the
traverser, most notably ``context``, which will be the context used
when a view is found and invoked. The interface
``repoze.bfg.events.IAfterTraversal`` can be used to subscribe to
the event. For example::

<subscriber for="repoze.bfg.interfaces.IAfterTraversal"
handler="my.app.handle_after_traverse"/>

Like any framework event, a subscriber function should expect one
parameter: ``event``.

Dependencies
------------

- Rather than depending on ``chameleon.core`` and ``chameleon.zpt``
distributions individually, depend on Malthe's repackaged
``Chameleon`` distribution (which includes both ``chameleon.core``
and ``chameleon.zpt``).

==================

Bug Fixes
---------

- The routes root factory called route factories and the default route
factory with an environ rather than a request. One of the symptoms
of this bug: applications generated using the ``bfg_zodb`` paster
template in 1.1a9 did not work properly.

- Reinstate ``renderer`` alias for ``view_renderer`` in the
``<route>`` ZCML directive (in-the-wild 1.1a bw compat).

- ``bfg_routesalchemy`` paster template: change ``<route>``
declarations: rename ``renderer`` attribute to ``view_renderer``.

- Header values returned by the ``authtktauthenticationpolicy``
``remember`` and ``forget`` methods would be of type ``unicode``.
This violated the WSGI spec, causing a ``TypeError`` to be raised
when these headers were used under ``mod_wsgi``.

- If a BFG app that had a route matching the root URL was mounted
under a path in modwsgi, ala ``WSGIScriptAlias /myapp
/Users/chrism/projects/modwsgi/env/bfg.wsgi``, the home route (a
route with the path of ``'/'`` or ``''``) would not match when the
path ``/myapp`` was visited (only when the path ``/myapp/`` was
visited). This is now fixed: if the urldispatch root factory notes
that the PATH_INFO is empty, it converts it to a single slash before
trying to do matching.

Documentation
-------------

- In ``<route>`` declarations in tutorial ZCML, rename ``renderer``
attribute to ``view_renderer`` (fwd compat).

- Fix various tutorials broken by 1.1a9 ``<route>`` directive changes.

Internal
--------

- Deal with a potential circref in the traversal module.