Debian Codegraph @

django_mailman3/tests/test_paginator.py

raw
1 # -*- coding: utf-8 -*-
2 #
3 # Copyright (C) 2016-2023 by the Free Software Foundation, Inc.
4 #
5 # This file is part of Django-Mailman.
6 #
7 # Django-Mailman is free software: you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by the Free
9 # Software Foundation, either version 3 of the License, or (at your option)
10 # any later version.
11 #
12 # Django-Mailman is distributed in the hope that it will be useful, but WITHOUT
13 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 # more details.
16 #
17 # You should have received a copy of the GNU General Public License along with
18 # Django-Mailman. If not, see <http://www.gnu.org/licenses/>.
19 #
20 # Author: Aurelien Bompard <[email protected]>
21 #
22
23
24 from django.template import Context
25 from django.test import RequestFactory, SimpleTestCase
26
27 from django_mailman3.lib.paginator import MailmanPaginator, paginate
28 from django_mailman3.templatetags.pagination import (
29 add_to_query_string, paginator)
30 from django_mailman3.tests.utils import FakeMMPage, TestCase
31
32
33 class TestMailmanPaginator(TestCase):
34
35 def setUp(self):
36 super(TestMailmanPaginator, self)._pre_setup()
37 # Create a user pagination based on just list of numbers instead of
38 # list of users. This is a mocked page and thus doesn't really care.
39 self.mailman_client.get_user_page.return_value = FakeMMPage(
40 count=5, entries=list(range(100)))
41 self.user_pages = MailmanPaginator(
42 function=self.mailman_client.get_user_page, per_page=5)
43
44 def test_get_page_one(self):
45 user_page_1 = self.user_pages.page(1)
46 self.assertIsNotNone(user_page_1)
47 # The number of entries in this list should be 5.
48 self.assertEqual(len(list(user_page_1)), 5)
49
50 def test_get_count(self):
51 # Total number of elements in this paginator class should be 100
52 self.assertEqual(self.user_pages.count, 100)
53
54
55 class PaginateTestCase(SimpleTestCase):
56
57 def test_page_range_ellipsis(self):
58 objects = list(range(1000))
59 self.assertEqual(
60 paginate(objects, 1, 20).paginator.page_range_ellipsis,
61 [1, 2, 3, 4, '...', 50])
62 self.assertEqual(
63 paginate(objects, 2, 20).paginator.page_range_ellipsis,
64 [1, 2, 3, 4, 5, '...', 50])
65 self.assertEqual(
66 paginate(objects, 3, 20).paginator.page_range_ellipsis,
67 [1, 2, 3, 4, 5, 6, '...', 50])
68 self.assertEqual(
69 paginate(objects, 4, 20).paginator.page_range_ellipsis,
70 [1, 2, 3, 4, 5, 6, 7, '...', 50])
71 self.assertEqual(
72 paginate(objects, 5, 20).paginator.page_range_ellipsis,
73 [1, 2, 3, 4, 5, 6, 7, 8, '...', 50])
74 self.assertEqual(
75 paginate(objects, 6, 20).paginator.page_range_ellipsis,
76 [1, 2, 3, 4, 5, 6, 7, 8, 9, '...', 50])
77 self.assertEqual(
78 paginate(objects, 7, 20).paginator.page_range_ellipsis,
79 [1, '...', 4, 5, 6, 7, 8, 9, 10, '...', 50])
80 self.assertEqual(
81 paginate(objects, 8, 20).paginator.page_range_ellipsis,
82 [1, '...', 5, 6, 7, 8, 9, 10, 11, '...', 50])
83 self.assertEqual(
84 paginate(objects, 9, 20).paginator.page_range_ellipsis,
85 [1, '...', 6, 7, 8, 9, 10, 11, 12, '...', 50])
86 self.assertEqual(
87 paginate(objects, 10, 20).paginator.page_range_ellipsis,
88 [1, '...', 7, 8, 9, 10, 11, 12, 13, '...', 50])
89 self.assertEqual(
90 paginate(objects, 30, 20).paginator.page_range_ellipsis,
91 [1, '...', 27, 28, 29, 30, 31, 32, 33, '...', 50])
92 self.assertEqual(
93 paginate(objects, 40, 20).paginator.page_range_ellipsis,
94 [1, '...', 37, 38, 39, 40, 41, 42, 43, '...', 50])
95 self.assertEqual(
96 paginate(objects, 41, 20).paginator.page_range_ellipsis,
97 [1, '...', 38, 39, 40, 41, 42, 43, 44, '...', 50])
98 self.assertEqual(
99 paginate(objects, 42, 20).paginator.page_range_ellipsis,
100 [1, '...', 39, 40, 41, 42, 43, 44, 45, '...', 50])
101 self.assertEqual(
102 paginate(objects, 43, 20).paginator.page_range_ellipsis,
103 [1, '...', 40, 41, 42, 43, 44, 45, 46, '...', 50])
104 self.assertEqual(
105 paginate(objects, 44, 20).paginator.page_range_ellipsis,
106 [1, '...', 41, 42, 43, 44, 45, 46, 47, '...', 50])
107 self.assertEqual(
108 paginate(objects, 45, 20).paginator.page_range_ellipsis,
109 [1, '...', 42, 43, 44, 45, 46, 47, 48, 49, 50])
110 self.assertEqual(
111 paginate(objects, 46, 20).paginator.page_range_ellipsis,
112 [1, '...', 43, 44, 45, 46, 47, 48, 49, 50])
113 self.assertEqual(
114 paginate(objects, 47, 20).paginator.page_range_ellipsis,
115 [1, '...', 44, 45, 46, 47, 48, 49, 50])
116 self.assertEqual(
117 paginate(objects, 48, 20).paginator.page_range_ellipsis,
118 [1, '...', 45, 46, 47, 48, 49, 50])
119 self.assertEqual(
120 paginate(objects, 49, 20).paginator.page_range_ellipsis,
121 [1, '...', 46, 47, 48, 49, 50])
122 self.assertEqual(
123 paginate(objects, 50, 20).paginator.page_range_ellipsis,
124 [1, '...', 47, 48, 49, 50])
125
126 def test_default_page(self):
127 self.assertEqual(paginate(list(range(100)), None).number, 1)
128
129 def test_last_page(self):
130 self.assertEqual(paginate(list(range(100)), 1000).number, 10)
131
132 def test_page_str(self):
133 try:
134 self.assertEqual(paginate(list(range(1000)), "2").number, 2)
135 except TypeError as e:
136 self.fail(e)
137
138 def test_page_not_an_int(self):
139 self.assertEqual(paginate(list(range(100)), "dummy").number, 1)
140
141 def test_add_to_query_string(self):
142 request = RequestFactory().get("/url", {"key1": "value1"})
143 result = add_to_query_string(
144 {"request": request}, "key2", "value2", key3="value3")
145 self.assertEqual(
146 set(result.split("&amp;")),
147 set(["key1=value1", "key2=value2", "key3=value3"]))
148
149 def test_paginator_tag(self):
150 objects = paginate(list(range(100)), 1, 20)
151 context = Context({'title': 'My Title'})
152 updated_context = paginator(context, objects)
153 self.assertEqual(updated_context['label_previous'], 'Previous')
154 self.assertEqual(updated_context['label_next'], 'Next')
155 self.assertEqual(updated_context['page'], objects)
156 self.assertEqual(updated_context['per_page_options'],
157 [10, 25, 50, 100, 200])
158 dated_pages_ctxt = paginator(context, objects, bydate=True)
159 self.assertEqual(dated_pages_ctxt['label_previous'], 'Newer')
160 self.assertEqual(dated_pages_ctxt['label_next'], 'Older')