- The ``repoze.bfg.urldispatch.Route`` constructor (not an API) now

  accepts a different ordering of arguments.  Previously it was
  ``(pattern, name, factory=None, predicates=())``.  It is now
  ``(name, pattern, factory=None, predicates=())``.  This is in
  support of consistency with ``configurator.add_route``.

- The ``repoze.bfg.urldispatch.RoutesMapper.connect`` method (not an
  API) now accepts a different ordering of arguments.  Previously it
  was ``(pattern, name, factory=None, predicates=())``.  It is now
  ``(name, pattern, factory=None, predicates=())``.  This is in
  support of consistency with ``configurator.add_route``.

- The ``repoze.bfg.urldispatch.RoutesMapper`` object now has a
  ``get_route`` method which returns a single Route object or
  ``None``.

- A new interface ``repoze.bfg.interfaces.IRoute`` was added.  The
  ``repoze.bfg.urldispatch.Route`` object implements this interface.

- The canonical attribute for accessing the routing pattern from a
  route object is now ``pattern`` rather than ``path``.

- The argument to ``repoze.bfg.configuration.Configurator.add_route``
  which was previously called ``path`` is now called ``pattern`` for
  better explicability.  For backwards compatibility purposes, passing
  a keyword argument named ``path`` to ``add_route`` will still work
  indefinitely.

- The ``path`` attribute to the ZCML ``route`` directive is now named
  ``pattern`` for better explicability.  The older ``path`` attribute
  will continue to work indefinitely.

- All narrative, API, and tutorial docs which referred to a route
  pattern as a ``path`` have now been updated to refer to them as a
  ``pattern``.

- The routesalchemy template has been updated to use ``pattern`` in
  its route declarations rather than ``path``.

1 files changed, 16 insertions, 5 deletions

diff --git a/repoze/bfg/urldispatch.py b/repoze/bfg/urldispatch.py
index a07f902f6..f9def62df 100644
--- a/repoze/bfg/urldispatch.py
+++ b/repoze/bfg/urldispatch.py
@@ -1,5 +1,9 @@
 import re
 from urllib import unquote
+from zope.interface import implements
+
+from repoze.bfg.interfaces import IRoutesMapper
+from repoze.bfg.interfaces import IRoute
 
 from repoze.bfg.compat import all
 from repoze.bfg.encode import url_quote
@@ -7,17 +11,21 @@ from repoze.bfg.exceptions import URLDecodeError
 from repoze.bfg.traversal import traversal_path
 from repoze.bfg.traversal import quote_path_segment
 
+
 _marker = object()
 
 class Route(object):
-    def __init__(self, path, name=None, factory=None, predicates=()):
-        self.path = path
-        self.match, self.generate = _compile_route(path)
+    implements(IRoute)
+    def __init__(self, name, pattern, factory=None, predicates=()):
+        self.pattern = pattern
+        self.path = pattern # indefinite b/w compat, not in interface
+        self.match, self.generate = _compile_route(pattern)
         self.name = name
         self.factory = factory
         self.predicates = predicates
 
 class RoutesMapper(object):
+    implements(IRoutesMapper)
     def __init__(self):
         self.routelist = []
         self.routes = {}
@@ -28,11 +36,14 @@ class RoutesMapper(object):
     def get_routes(self):
         return self.routelist
 
-    def connect(self, path, name, factory=None, predicates=()):
+    def get_route(self, name):
+        return self.routes.get(name)
+
+    def connect(self, name, pattern, factory=None, predicates=()):
         if name in self.routes:
             oldroute = self.routes[name]
             self.routelist.remove(oldroute)
-        route = Route(path, name, factory, predicates)
+        route = Route(name, pattern, factory, predicates)
         self.routelist.append(route)
         self.routes[name] = route
         return route