Merge lp:~ricardokirkner/python-timeline-django/ensure-event-tuple into lp:python-timeline-django

[Ricardo Kirkner]

do not rely on timeline event being a tuple when filtering query

event can be tuple or list, just make sure to cast it to tuple before appending extra bits to filtered event data

[Matt Goodall (matt-goodall)]

lgtm

review: Approve

=== modified file 'timeline_django/filters.py'
--- timeline_django/filters.py	2014-04-29 18:58:42 +0000
+++ timeline_django/filters.py	2015-10-02 14:43:10 +0000
@@ -40,7 +40,7 @@
     for event in timeline:
         start, end, category, detail = event[:4]
         detail = filter_fn(detail)
-        new_timeline.append((start, end, category, detail) + event[4:])
+        new_timeline.append((start, end, category, detail) + tuple(event[4:]))
     report['timeline'] = new_timeline
 
 

=== modified file 'timeline_django/tests/test_filters.py'
--- timeline_django/tests/test_filters.py	2014-04-29 18:58:42 +0000
+++ timeline_django/tests/test_filters.py	2015-10-02 14:43:10 +0000
@@ -64,16 +64,24 @@
         self.assertEqual({}, report)
         self.assertEqual({}, context)
 
+    def _test_filter_session_query(self, query, timeline):
+        report = dict(timeline=timeline)
+        filters.filter_session_query(report, {})
+        new_timeline = report['timeline']
+        self.assertEqual(
+            [(0, 0, 'some-category', filters.filter_session_info(query),
+             'other')],
+            new_timeline)
+
     def test_filter_session_query(self):
         query = 'select * from django_session'
-        test_timeline = [(0, 0, 'some-category', query, 'other')]
-        report = dict(timeline=test_timeline)
-        filters.filter_session_query(report, {})
-        new_timeline = report['timeline']
-        self.assertEqual(
-                [(0, 0, 'some-category', filters.filter_session_info(query),
-                    'other')],
-                new_timeline)
+        timeline = [(0, 0, 'some-category', query, 'other')]
+        self._test_filter_session_query(query, timeline)
+
+    def test_filter_session_query_handle_event_as_list(self):
+        query = 'select * from django_session'
+        timeline = [[0, 0, 'some-category', query, 'other']]
+        self._test_filter_session_query(query, timeline)
 
 
 class FilterUserQueryTests(TestCase):
@@ -85,16 +93,24 @@
         self.assertEqual({}, report)
         self.assertEqual({}, context)
 
+    def _test_filter_user_query(self, query, timeline):
+        report = dict(timeline=timeline)
+        filters.filter_user_query(report, {})
+        new_timeline = report['timeline']
+        self.assertEqual(
+            [(0, 0, 'some-category', filters.filter_user_info(query),
+             'other')],
+            new_timeline)
+
     def test_filter_user_query(self):
         query = 'select * from auth_user'
-        test_timeline = [(0, 0, 'some-category', query, 'other')]
-        report = dict(timeline=test_timeline)
-        filters.filter_user_query(report, {})
-        new_timeline = report['timeline']
-        self.assertEqual(
-                [(0, 0, 'some-category', filters.filter_user_info(query),
-                    'other')],
-                new_timeline)
+        timeline = [(0, 0, 'some-category', query, 'other')]
+        self._test_filter_user_query(query, timeline)
+
+    def test_filter_user_query_handle_event_as_list(self):
+        query = 'select * from auth_user'
+        timeline = [[0, 0, 'some-category', query, 'other']]
+        self._test_filter_user_query(query, timeline)
 
 
 class FakeConfig(object):