Next release - The component registration handler for views (functions or class instances) now observes component adaptation annotations (see ``zope.component.adaptedBy``) and uses them before the fallback values for ``for_`` and ``request_type``. This change does not affect existing code insomuch as the code does not rely on these defaults when an annotation is set on the view (unlikely). - Strip all slashes from end and beginning of path in clean_path within traversal machinery. 0.5.1 (11/25/2008) - Add ``keys``, ``items``, and ``values`` methods to ``testing.DummyModel``. - Add __delitem__ method to ``testing.DummyModel``. 0.5.0 (11/18/2008) - Fix ModelGraphTraverser; don't try to change the ``__name__`` or ``__parent__`` of an object that claims it implements ILocation during traversal even if the ``__name__`` or ``__parent__`` of the object traversed does not match the name used in the traversal step or the or the traversal parent . Rationale: it was insane to do so. This bug was only found due to a misconfiguration in an application that mistakenly had intermediate persistent non-ILocation objects; traversal was causing a persistent write on every request under this setup. - ``repoze.bfg.location.locate`` now unconditionally sets ``__name__`` and ``__parent__`` on objects which provide ILocation (it previously only set them conditionally if they didn't match attributes already present on the object via equality). 0.4.9 (11/17/2008) - Add chameleon text template API (chameleon ${name} renderings where the template does not need to be wrapped in any containing XML). - Change docs to explain install in terms of a virtualenv (unconditionally). - Make pushpage decorator compatible with repoze.bfg.convention's ``bfg_view`` decorator when they're stacked. - Add content_length attribute to testing.DummyRequest. - Change paster template ``tests.py`` to include a true unit test. Retain old test as an integration test. Update documentation. - Document view registrations against classes and ``repoze.bfg.convention`` in context. - Change the default paster template to register its single view against a class rather than an interface. - Document adding a request type interface to the request via a subscriber function in the events narrative documentation. 0.4.8 (11/12/2008) Backwards Incompatibilities - ``repoze.bfg.traversal.model_url`` now always appends a slash to all generated URLs unless further elements are passed in as the third and following arguments. Rationale: views often use ``model_url`` without the third-and-following arguments in order to generate a URL for a model in order to point at the default view of a model. The URL that points to the default view of the *root* model is technically ``http://mysite/`` as opposed to ``http://mysite`` (browsers happen to ask for '/' implicitly in the GET request). Because URLs are never automatically generated for anything *except* models by ``model_url``, and because the root model is not really special, we continue this pattern. The impact of this change is minimal (at most you will have too many slashes in your URL, which BFG deals with gracefully anyway). 0.4.7 (11/11/2008) Features - Allow ``testing.registerEventListener`` to be used with Zope 3 style "object events" (subscribers accept more than a single event argument). We extend the list with the arguments, rather than append. 0.4.6 (11/10/2008) Bug Fixes - The ``model_path`` and ``model_url`` traversal APIs returned the wrong value for the root object (e.g. ``model_path`` returned ``''`` for the root object, while it should have been returning ``'/'``). 0.4.5 (11/9/2008) Features - Added a ``clone`` method and a ``__contains__`` method to the DummyModel testing object. - Allow DummyModel objects to receive extra keyword arguments, which will be attached as attributes. - The DummyTemplateRenderer now returns ``self`` as its implementation. 0.4.4 (11/8/2008) Features - Added a ``repoze.bfg.testing`` module to attempt to make it slightly easier to write unittest-based automated tests of BFG applications. Information about this module is in the documentation. - The default template renderer now supports testing better by looking for ``ITestingTemplateRenderer`` using a relative pathname. This is exposed indirectly through the API named ``registerTemplateRenderer`` in ``repoze.bfg.testing``. Deprecations - The names ``repoze.bfg.interfaces.ITemplate`` , ``repoze.bfg.interfaces.ITemplateFactory`` and ``repoze.bfg.interfaces.INodeTemplate`` have been deprecated. These should now be imported as ``repoze.bfg.interfaces.ITemplateRenderer`` and ``repoze.bfg.interfaces.ITemplateRendererFactory``, and ``INodeTemplateRenderer`` respectively. - The name ``repoze.bfg.chameleon_zpt.ZPTTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_zpt.ZPTTemplateRenderer``. - The name ``repoze.bfg.chameleon_genshi.GenshiTemplateFactory`` is deprecated. Use ``repoze.bfg.chameleon_genshi.GenshiTemplateRenderer``. - The name ``repoze.bfg.xslt.XSLTemplateFactory`` is deprecated. Use ``repoze.bfg.xslt.XSLTemplateRenderer``. 0.4.3 (11/2/2008) Bug Fixes - Not passing the result of "get_options" as the second argument of make_app could cause attribute errors when attempting to look up settings against the ISettings object (internal). Fixed by giving the Settings objects defaults for ``debug_authorization`` and ``debug_notfound``. - Return an instance of ``Allowed`` (rather than ``True``) from ``has_permission`` when no security policy is in use. - Fix bug where default deny in authorization check would throw a TypeError (use ``ACLDenied`` instead of ``Denied``). 0.4.2 (11/2/2008) Features - Expose a single ILogger named "repoze.bfg.debug" as a utility; this logger is registered unconditionally and is used by the authorization debug machinery. Applications may also make use of it as necessary rather than inventing their own logger, for convenience. - The ``BFG_DEBUG_AUTHORIZATION`` envvar and the ``debug_authorization`` config file value now only imply debugging of view-invoked security checks. Previously, information was printed for every call to ``has_permission`` as well, which made output confusing. To debug ``has_permission`` checks and other manual permission checks, use the debugger and print statements in your own code. - Authorization debugging info is now only present in the HTTP response body oif ``debug_authorization`` is true. - The format of authorization debug messages was improved. - A new ``BFG_DEBUG_NOTFOUND`` envvar was added and a symmetric ``debug_notfound`` config file value was added. When either is true, and a NotFound response is returned by the BFG router (because a view could not be found), debugging information is printed to stderr. When this value is set true, the body of HTTPNotFound responses will also contain the same debugging information. - ``Allowed`` and ``Denied`` responses from the security machinery are now specialized into two types: ACL types, and non-ACL types. The ACL-related responses are instances of ``repoze.bfg.security.ACLAllowed`` and ``repoze.bfg.security.ACLDenied``. The non-ACL-related responses are ``repoze.bfg.security.Allowed`` and ``repoze.bfg.security.Denied``. The allowed-type responses continue to evaluate equal to things that themselves evaluate equal to the ``True`` boolean, while the denied-type responses continue to evaluate equal to things that themselves evaluate equal to the ``False`` boolean. The only difference between the two types is the information attached to them for debugging purposes. - Added a new ``BFG_DEBUG_ALL`` envvar and a symmetric ``debug_all`` config file value. When either is true, all other debug-related flags are set true unconditionally (e.g. ``debug_notfound`` and ``debug_authorization``). Documentation - Added info about debug flag changes. - Added a section to the security chapter named "Debugging Imperative Authorization Failures" (for e.g. ``has_permssion``). Bug Fixes - Change default paster template generator to use ``Paste#http`` server rather than ``PasteScript#cherrpy`` server. The cherrypy server has a security risk in it when ``REMOTE_USER`` is trusted by the downstream application. 0.4.1 (10/28/2008) Bug Fixes - If the ``render_view_to_response`` function was called, if the view was found and called, but it returned something that did not implement IResponse, the error would pass by unflagged. This was noticed when I created a view function that essentially returned None, but received a NotFound error rather than a ValueError when the view was rendered. This was fixed. 0.4.0 (10/03/2008) Docs - An "Environment and Configuration" chapter was added to the narrative portion of the documentation. Features - Ensure bfg doesn't generate warnings when running under Python 2.6. - The environment variable ``BFG_RELOAD_TEMPLATES`` is now available (serves the same purpose as ``reload_templates`` in the config file). - A new configuration file option ``debug_authorization`` was added. This turns on printing of security authorization debug statements to ``sys.stderr``. The ``BFG_DEBUG_AUTHORIZATION`` environment variable was also added; this performs the same duty. Bug Fixes - The environment variable ``BFG_SECURITY_DEBUG`` did not always work. It has been renamed to ``BFG_DEBUG_AUTHORIZATION`` and fixed. Deprecations - A deprecation warning is now issued when old API names from the ``repoze.bfg.templates`` module are imported. Backwards incompatibilities - The ``BFG_SECURITY_DEBUG`` environment variable was renamed to ``BFG_DEBUG_AUTHORIZATION``. 0.3.9 (08/27/2008) Features - A ``repoze.bfg.location`` API module was added. Backwards incompatibilities - Applications must now use the ``repoze.bfg.interfaces.ILocation`` interface rather than ``zope.location.interfaces.ILocation`` to represent that a model object is "location-aware". We've removed a dependency on ``zope.location`` for cleanliness purposes: as new versions of zope libraries are released which have improved dependency information, getting rid of our dependence on ``zope.location`` will prevent a newly installed repoze.bfg application from requiring the ``zope.security``, egg, which not truly used at all in a "stock" repoze.bfg setup. These dependencies are still required by the stack at this time; this is purely a futureproofing move. The security and model documentation for previous versions of ``repoze.bfg`` recommended using the ``zope.location.interfaces.ILocation`` interface to represent that a model object is "location-aware". This documentation has been changed to reflect that this interface should now be imported from ``repoze.bfg.interfaces.ILocation`` instead. 0.3.8 (08/26/2008) Docs - Documented URL dispatch better in narrative form. Bug fixes - Routes URL dispatch did not have access to the WSGI environment, so conditions such as method=GET did not work. Features - Add ``principals_allowed_by_permission`` API to security module. - Replace ``z3c.pt`` support with support for ``chameleon.zpt``. Chameleon is the new name for the package that used to be named ``z3c.pt``. NOTE: If you update a ``repoze.bfg`` SVN checkout that you're using for development, you will need to run "setup.py install" or "setup.py develop" again in order to obtain the proper Chameleon packages. ``z3c.pt`` is no longer supported by ``repoze.bfg``. All API functions that used to render ``z3c.pt`` templates will work fine with the new packages, and your templates should render almost identically. - Add a ``repoze.bfg.chameleon_zpt`` module. This module provides Chameleon ZPT support. - Add a ``repoze.bfg.xslt`` module. This module provides XSLT support. - Add a ``repoze.bfg.chameleon_genshi`` module. This provides direct Genshi support, which did not exist previously. Deprecations - Importing API functions directly from ``repoze.bfg.template`` is now deprecated. The ``get_template``, ``render_template``, ``render_template_to_response`` functions should now be imported from ``repoze.chameleon_zpt``. The ``render_transform``, and ``render_transform_to_response`` functions should now be imported from ``repoze.bfg.xslt``. The ``repoze.bfg.template`` module will remain around "forever" to support backwards compatibility. 0.3.7 (09/09/2008) Features - Add compatibility with z3c.pt 1.0a7+ (z3c.pt became a namespace package). Bug fixes - ``repoze.bfg.traversal.find_model`` function did not function properly. 0.3.6 (09/04/2008) Features - Add startup process docs. - Allow configuration cache to be bypassed by actions which include special "uncacheable" discriminators (for actions that have variable results). Bug Fixes - Move core repoze.bfg ZCML into a ``repoze.bfg.includes`` package so we can use repoze.bfg better as a namespace package. Adjust the code generator to use it. We've left around the ``configure.zcml`` in the repoze.bfg package directly so as not to break older apps. - When a zcml application registry cache was unpickled, and it contained a reference to an object that no longer existed (such as a view), bfg would not start properly. 0.3.5 (09/01/2008) Features - Event notification is issued after application is created and configured (``IWSGIApplicationCreatedEvent``). - New API module: ``repoze.bfg.view``. This module contains the functions named ``render_view_to_response``, ``render_view_to_iterable``, ``render_view`` and ``is_response``, which are documented in the API docs. These features aid programmatic (non-server-driven) view execution. 0.3.4 (08/28/2008) Backwards incompatibilities - Make ``repoze.bfg`` a namespace package so we can allow folks to create subpackages (e.g. ``repoze.bfg.otherthing``) within separate eggs. This is a backwards incompatible change which makes it impossible to import "make_app" and "get_options" from the ``repoze.bfg`` module directly. This change will break all existing apps generated by the paster code generator. Instead, you need to import these functions as ``repoze.bfg.router:make_app`` and ``repoze.bfg.registry:get_options``, respectively. Sorry folks, it has to be done now or never, and definitely better now. Features - Add ``model_path`` API function to traversal module. Bugfixes - Normalize path returned by repoze.bfg.caller_path. 0.3.3 (8/23/2008) - Fix generated test.py module to use project name rather than package name. 0.3.2 (8/23/2008) - Remove ``sampleapp`` sample application from bfg package itself. - Remove dependency on FormEncode (only needed by sampleapp). - Fix paster template generation so that case-sensitivity is preserved for project vs. package name. - Depend on ``z3c.pt`` version 1.0a1 (which requires the ``[lxml]`` extra currently). - Read and write a pickled ZCML actions list, stored as ``configure.zcml.cache`` next to the applications's "normal" configuration file. A given bfg app will usually start faster if it's able to read the pickle data. It fails gracefully to reading the real ZCML file if it cannot read the pickle. 0.3.1 (8/20/2008) - Generated application differences: ``make_app`` entry point renamed to ``app`` in order to have a different name than the bfg function of the same name, to prevent confusion. - Add "options" processing to bfg's ``make_app`` to support runtime options. A new API function named ``get_options`` was added to the registry module. This function is typically used in an application's ``app`` entry point. The Paste config file section for the app can now supply the ``reload_templates`` option, which, if true, will prevent the need to restart the appserver in order for ``z3c.pt`` or XSLT template changes to be detected. - Use only the module name in generated project's "test_suite" (run all tests found in the package). - Default port for generated apps changed from 5432 to 6543 (Postgres default port is 6543). 0.3.0 - Add ``get_template`` API to template module. 0.2.9 - 0.2.8 was "brown bag" release. It didn't work at all. Symptom: ComponentLookupError when trying to render a page. 0.2.8 - Add ``find_model`` and ``find_root`` traversal APIs. In the process, make ITraverser a uni-adapter (on context) rather than a multiadapter (on context and request). 0.2.7 - Add a ``request_type`` attribute to the available attributes of a ``bfg:view`` configure.zcml element. This attribute will have a value which is a dotted Python path, pointing at an interface. If the request object implements this interface when the view lookup is performed, the appropriate view will be called. This is meant to allow for simple "skinning" of sites based on request type. An event subscriber should attach the interface to the request on ingress to support skins. - Remove "template only" views. These were just confusing and were never documented. - Small url dispatch overhaul: the ``connect`` method of the ``urldispatch.RoutesMapper`` object now accepts a keyword parameter named ``context_factory``. If this parameter is supplied, it must be a callable which returns an instance. This instance is used as the context for the request when a route is matched. - The registration of a RoutesModelTraverser no longer needs to be performed by the application; it's in the bfg ZCML now. 0.2.6 - Add event sends for INewRequest and INewResponse. See the events.rst chapter in the documentation's ``api`` directory. 0.2.5 - Add ``model_url`` API. 0.2.4 - Added url-based dispatch. 0.2.3 - Add API functions for authenticated_userid and effective_principals. 0.2.2 - Add authenticated_userid and effective_principals API to security policy. 0.2.1 - Add find_interface API. 0.2 - Add wsgiapp decorator. - The concept of "view factories" was removed in favor of always calling a view, which is a callable that returns a response directly (as opposed to returning a view). As a result, the ``factory`` attribute in the bfg:view ZCML statement has been renamed to ``view``. Various interface names were changed also. - ``render_template`` and ``render_transform`` no longer return a Response object. Instead, these return strings. The old behavior can be obtained by using ``render_template_to_response`` and ``render_transform_to_response``. - Added 'repoze.bfg.push:pushpage' decorator, which creates BFG views from callables which take (context, request) and return a mapping of top-level names. - Added ACL-based security. - Support for XSLT templates via a render_transform method 0.1 - Initial release.