Merge lp:~james-w/python-timeline-django/timeline-factory into lp:python-timeline-django

[James Westby]

Add a timeline_factory function.

[lp:~james-w/python-timeline-django/timeline-factory]

28. By James Westby on 2014-10-23

Fix typo, thanks Michael.

[Michael Nelson (michael.nelson)]

review: Approve

Unmerged revisions

28. By James Westby on 2014-10-23

Fix typo, thanks Michael.

27. By James Westby on 2014-10-22

Add a timeline_factory function.

=== modified file 'timeline_django/setup.py'
--- timeline_django/setup.py	2012-09-22 09:00:56 +0000
+++ timeline_django/setup.py	2014-10-23 13:49:02 +0000
@@ -13,8 +13,6 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # GNU Lesser General Public License version 3 (see the file LICENSE).
 
-from functools import partial
-
 from . import hooks, timeline_cursor, wsgi
 
 
@@ -37,11 +35,7 @@
     factory.
     """
     if timeline_factory is None:
-        def timeline_factory():
-            environ = wsgi.get_environ()
-            if not environ:
-                return None
-            return environ.get('timeline.timeline')
+        timeline_factory = wsgi.timeline_factory
     timeline_cursor.setup_timeline_cursor_hooks(timeline_factory, prefix=prefix)
     receiver = hooks.TimelineReceiver(timeline_factory)
     receiver.connect_to_signals()
 
=== modified file 'timeline_django/tests/test_wsgi.py'
--- timeline_django/tests/test_wsgi.py	2014-08-29 14:45:51 +0000
+++ timeline_django/tests/test_wsgi.py	2014-10-23 13:49:02 +0000
@@ -35,6 +35,9 @@
     def test_get_environ_is_None_first_call(self):
         self.assertEqual(None, wsgi.get_environ())
 
+    def test_timeline_factory_is_None_first_call(self):
+        self.assertEqual(None, wsgi.timeline_factory())
+
     def test_wsgi_sets_timeline(self):
         environ = {}
         start_response = lambda status, headers: None
@@ -45,6 +48,22 @@
         out = app(environ, start_response)
         self.assertEqual(["foo"], list(out))
 
+    def test_timeline_factory_with_no_timeline(self):
+        environ = {}
+        start_response = lambda status, headers: None
+        def do_check(environ, start_response):
+            self.assertEqual(None, wsgi.timeline_factory())
+        app = wsgi.make_app(do_check)
+        out = app(environ, start_response)
+
+    def test_timeline_factory_with_timeline(self):
+        environ = {'timeline.timeline': 'a'}
+        start_response = lambda status, headers: None
+        def do_check(environ, start_response):
+            self.assertEqual('a', wsgi.timeline_factory())
+        app = wsgi.make_app(do_check)
+        out = app(environ, start_response)
+
     def test_wsgi_unsets_timeline(self):
         environ = {}
         start_response = lambda status, headers: None
 
=== modified file 'timeline_django/wsgi.py'
--- timeline_django/wsgi.py	2014-08-29 13:02:39 +0000
+++ timeline_django/wsgi.py	2014-10-23 13:49:02 +0000
@@ -33,6 +33,18 @@
     return getattr(_thread_local, 'environ', None)
 
 
+def timeline_factory():
+    """Get a timeline for the currently active request.
+
+    Calling this factory will get you a timeline for the currently
+    active request, if there is one. If there is no active request,
+    or if the request environ has no timeline then it returns None.
+    """
+    environ = get_environ()
+    if environ:
+        return environ.get('timeline.timeline')
+
+
 def make_app(application):
     """Create a WSGI application that stores the environ in a thread-local.