From 8be44ccf5faa3dea112e85a5005db800324ea353 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E4=BE=9D=E7=91=AA=E8=B2=93?= <imacat@mail.imacat.idv.tw>
Date: Sat, 4 Feb 2023 10:26:28 +0800
Subject: [PATCH] Renamed the is_needed property to is_paged in the Pagination
 utility.

---
 .../accounting/include/pagination.html        |  2 +-
 src/accounting/utils/pagination.py            |  2 +-
 tests/test_utils.py                           | 20 +++++++++----------
 3 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/src/accounting/templates/accounting/include/pagination.html b/src/accounting/templates/accounting/include/pagination.html
index b73a5fd..48389e1 100644
--- a/src/accounting/templates/accounting/include/pagination.html
+++ b/src/accounting/templates/accounting/include/pagination.html
@@ -19,7 +19,7 @@ pagination.html: The pagination navigation bar.
 Author: imacat@mail.imacat.idv.tw (imacat)
 First written: 2023/1/26
 #}
-{% if pagination.is_needed %}
+{% if pagination.is_paged %}
   <nav aria-label="Page navigation">
     <ul class="pagination">
       {% for link in pagination.page_links %}
diff --git a/src/accounting/utils/pagination.py b/src/accounting/utils/pagination.py
index 89b7240..ef769fb 100644
--- a/src/accounting/utils/pagination.py
+++ b/src/accounting/utils/pagination.py
@@ -88,7 +88,7 @@ class Pagination(t.Generic[T]):
         self.__total_pages: int = 0 if len(items) == 0 \
             else int((len(items) - 1) / self.page_size) + 1
         """The total number of pages."""
-        self.is_needed: bool = self.__total_pages > 1
+        self.is_paged: bool = self.__total_pages > 1
         """Whether there should be pagination."""
         self.__default_page_no: int = 0
         """The default page number."""
diff --git a/tests/test_utils.py b/tests/test_utils.py
index 691d843..69c431e 100644
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@@ -127,18 +127,18 @@ class PaginationTestCase(unittest.TestCase):
         """The testing parameters."""
 
         def __init__(self, items: list[int], is_reversed: bool | None,
-                     result: list[int], is_needed: bool):
+                     result: list[int], is_paged: bool):
             """Constructs the expected pagination.
 
             :param items: All the items in the list.
             :param is_reversed: Whether the default page is the last page.
             :param result: The expected items on the page.
-            :param is_needed: Whether the pagination is needed.
+            :param is_paged: Whether the pagination is needed.
             """
             self.items: list[int] = items
             self.is_reversed: bool | None = is_reversed
             self.result: list[int] = result
-            self.is_needed: bool = is_needed
+            self.is_paged: bool = is_paged
 
     def setUp(self) -> None:
         """Sets up the test.
@@ -158,7 +158,7 @@ class PaginationTestCase(unittest.TestCase):
                                         is_reversed=self.params.is_reversed)
             else:
                 pagination = Pagination(self.params.items)
-            self.assertEqual(pagination.is_needed, self.params.is_needed)
+            self.assertEqual(pagination.is_paged, self.params.is_paged)
             self.assertEqual(pagination.list, self.params.result)
             return ""
 
@@ -166,14 +166,14 @@ class PaginationTestCase(unittest.TestCase):
         self.client.headers["Referer"] = "https://testserver"
 
     def __test_success(self, query: str, items: range,
-                       result: range, is_needed: bool = True,
+                       result: range, is_paged: bool = True,
                        is_reversed: bool | None = None) -> None:
         """Tests the pagination.
 
         :param query: The query string.
         :param items: The original items.
         :param result: The expected page content.
-        :param is_needed: Whether the pagination is needed.
+        :param is_paged: Whether the pagination is needed.
         :param is_reversed: Whether the list is reversed.
         :return: None.
         """
@@ -181,7 +181,7 @@ class PaginationTestCase(unittest.TestCase):
         if query != "":
             target = f"{target}?{query}"
         self.params = self.Params(list(items), is_reversed,
-                                  list(result), is_needed)
+                                  list(result), is_paged)
         response: httpx.Response = self.client.get(target)
         self.assertEqual(response.status_code, 200)
 
@@ -234,12 +234,12 @@ class PaginationTestCase(unittest.TestCase):
         :return: None.
         """
         # Empty list
-        self.__test_success("", range(0, 0), range(0, 0), is_needed=False)
+        self.__test_success("", range(0, 0), range(0, 0), is_paged=False)
         # A list that fits in one page
-        self.__test_success("", range(1, 4), range(1, 4), is_needed=False)
+        self.__test_success("", range(1, 4), range(1, 4), is_paged=False)
         # A large page size that fits in everything
         self.__test_success("page-size=1000", range(1, 687), range(1, 687),
-                            is_needed=False)
+                            is_paged=False)
 
     def test_reversed(self) -> None:
         """Tests the default page on a reversed list.