Add limit/offset and cursor pagination to PaginationKeyBit (chibisov#204)

fdemmer · auvipy · commit 60ef2eef5ee3 · 2019-10-29T10:23:01.000+06:00
* Add limit/offset and cursor pagination to PaginationKeyBit

* Add tests for key bits of LimitOffsetPagination and CursorPagination
diff --git a/rest_framework_extensions/key_constructor/bits.py b/rest_framework_extensions/key_constructor/bits.py
@@ -170,16 +170,22 @@ class PaginationKeyBit(QueryParamsKeyBit):
         {'page_size': 100, 'page': '1'}
 
     """
+    paginator_attrs = [
+        'page_query_param', 'page_size_query_param',
+        'limit_query_param', 'offset_query_param',
+        'cursor_query_param',
+    ]
+
     def get_data(self, **kwargs):
         kwargs['params'] = []
-        if hasattr(kwargs['view_instance'], 'paginator'):
-            if hasattr(kwargs['view_instance'].paginator, 'page_query_param'):
-                kwargs['params'].append(
-                    kwargs['view_instance'].paginator.page_query_param)
-            if hasattr(kwargs['view_instance'].paginator,
-                       'page_size_query_param'):
-                kwargs['params'].append(
-                    kwargs['view_instance'].paginator.page_size_query_param)
+        paginator = getattr(kwargs['view_instance'], 'paginator', None)
+
+        if paginator:
+            for attr in self.paginator_attrs:
+                param = getattr(paginator, attr, None)
+                if param:
+                    kwargs['params'].append(param)
+
         return super(PaginationKeyBit, self).get_data(**kwargs)
 
 
diff --git a/tests_app/tests/unit/key_constructor/bits/tests.py b/tests_app/tests/unit/key_constructor/bits/tests.py
@@ -340,7 +340,7 @@ def setUp(self):
             'params': None,
             'view_instance': Mock(spec_set=['paginator']),
             'view_method': None,
-            'request': factory.get('?page_size=10&page=1'),
+            'request': factory.get('?page_size=10&page=1&limit=5&offset=15&cursor=foo'),
             'args': None,
             'kwargs': None
         }
@@ -357,24 +357,33 @@ def test_view_with_empty_pagination_arguments(self):
     def test_view_with_page_kwarg(self):
         self.kwargs['view_instance'].paginator.page_query_param = 'page'
         self.kwargs['view_instance'].paginator.page_size_query_param = None
-        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page': u'1'})
+        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page': '1'})
 
     def test_view_with_paginate_by_param(self):
         self.kwargs['view_instance'].paginator.page_query_param = None
         self.kwargs['view_instance'].paginator.page_size_query_param = 'page_size'
-        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page_size': u'10'})
+        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page_size': '10'})
 
     def test_view_with_all_pagination_attrs(self):
         self.kwargs['view_instance'].paginator.page_query_param = 'page'
         self.kwargs['view_instance'].paginator.page_size_query_param = 'page_size'
-        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page_size': u'10', 'page': u'1'})
+        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'page_size': '10', 'page': '1'})
 
     def test_view_with_all_pagination_attrs__without_query_params(self):
         self.kwargs['view_instance'].paginator.page_query_param = 'page'
         self.kwargs['view_instance'].paginator.page_size_query_param = 'page_size'
         self.kwargs['request'] = factory.get('')
         self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {})
 
+    def test_view_with_offset_pagination_attrs(self):
+        self.kwargs['view_instance'].paginator.limit_query_param = 'limit'
+        self.kwargs['view_instance'].paginator.offset_query_param = 'offset'
+        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'limit': '5', 'offset': '15'})
+
+    def test_view_with_cursor_pagination_attrs(self):
+        self.kwargs['view_instance'].paginator.cursor_query_param = 'cursor'
+        self.assertEqual(PaginationKeyBit().get_data(**self.kwargs), {'cursor': 'foo'})
+
 
 class ListSqlQueryKeyBitTest(TestCase):
     def setUp(self):
