Updated new pagination feature.

Author: Antoliny0919

cab/exceptions.py

@@ -0,0 +1,6 @@
+class IncorectLookupParameter(Exception):
+    """
+    Raised when a query parameter contains an incorrect value.
+    """
+
+    pass

cab/pagination.py

@@ -0,0 +1,68 @@
+from django.core.paginator import InvalidPage, Paginator
+from django.utils.http import urlencode
+
+from .exceptions import IncorectLookupParameter
+
+PAGE_VAR = "page"
+
+
+class Pagination:
+    def __init__(
+        self,
+        request,
+        model,
+        queryset,
+        list_per_page,
+    ):
+        self.model = model
+        self.opts = model._meta
+        self.queryset = queryset
+        self.list_per_page = list_per_page
+        try:
+            # Get the current page from the query string.
+            self.page_num = int(request.GET.get(PAGE_VAR, 1))
+        except ValueError:
+            self.page_num = 1
+        self.params = dict(request.GET.lists())
+        self.setup()
+
+    @property
+    def page_range(self):
+        return (
+            self.paginator.get_elided_page_range(self.page_num)
+            if self.multi_page
+            else []
+        )
+
+    def get_query_string(self, new_params=None):
+        if new_params is None:
+            new_params = {}
+        params = self.params.copy()
+        for param, value in new_params.items():
+            if value is None:
+                if param in params:
+                    del params[param]
+            else:
+                params[param] = value
+        return "?%s" % urlencode(sorted(params.items()), doseq=True)
+
+    def setup(self):
+        paginator = Paginator(self.queryset, self.list_per_page)
+        result_count = paginator.count
+        # Determine use pagination.
+        multi_page = result_count > self.list_per_page
+
+        self.result_count = result_count
+        self.multi_page = multi_page
+        self.paginator = paginator
+        self.page = paginator.get_page(self.page_num)
+
+    def get_objects(self):
+        if not self.multi_page:
+            result_list = self.queryset._clone()
+        else:
+            try:
+                result_list = self.paginator.page(self.page_num).object_list
+            except InvalidPage:
+                raise IncorectLookupParameter
+        return result_list

cab/templates/components/pagination.html

@@ -0,0 +1,21 @@
+{% load components %}
+
+{% if pagination.multi_page %}
+<nav class="pagination" aria-labelledby="pagination">
+    {% if pagination.page.has_previous %}
+    <a class="previous-page" href="{{ previous_page_link }}" rel="prev" aria-label="Previous page">Previous</a>
+    {% else %}
+    <span class="previous-page disabled" rel="prev" aria-label="Previous page">Previous</span>
+    {% endif %}
+    <ul>
+    {% for i in pagination.page_range %}
+        <li>{% pagination_number pagination i %}</li>
+    {% endfor %}
+    </ul>
+    {% if pagination.page.has_next %}
+    <a class="next-page" href="{{ next_page_link }}" rel="next" aria-label="Next page">Next</a>
+    {% else %}
+    <span class="next-page disabled" rel="next" aria-label="Next page">Next</span>
+    {% endif %}
+</nav>
+{% endif %}

cab/templatetags/components.py

@@ -0,0 +1,39 @@
+from django import template
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
+
+from cab.pagination import PAGE_VAR
+
+register = template.Library()
+
+
+@register.simple_tag
+def pagination_number(pagination, i):
+    """
+    Generate an individual page index link in a paginated list.
+    """
+    if i == pagination.paginator.ELLIPSIS:
+        return format_html("{} ", pagination.paginator.ELLIPSIS)
+    elif i == pagination.page_num:
+        return format_html('<em class="current-page" aria-current="page">{}</em> ', i)
+    else:
+        link = pagination.get_query_string({PAGE_VAR: i})
+        return format_html(
+            '<a href="{}" aria-label="page {}" {}>{}</a> ',
+            link,
+            i,
+            mark_safe(' class="end"' if i == pagination.paginator.num_pages else ""),
+            i,
+        )
+
+
+@register.inclusion_tag("components/pagination.html", name="pagination")
+def pagination_tag(pagination):
+    previous_page_link = f"?{PAGE_VAR}={pagination.page_num - 1}"
+    next_page_link = f"?{PAGE_VAR}={pagination.page_num + 1}"
+
+    return {
+        "pagination": pagination,
+        "previous_page_link": previous_page_link,
+        "next_page_link": next_page_link,
+    }

cab/utils.py

@@ -2,12 +2,13 @@
 
 import bleach
 from django.core.exceptions import ObjectDoesNotExist
-from django.core.paginator import InvalidPage, Paginator
 from django.http import Http404, HttpResponse
 from django.template import loader
 from django.utils.safestring import mark_safe
 from markdown import markdown as markdown_func
 
+from cab.pagination import Pagination
+
 
 def object_list(
     request,
@@ -58,71 +59,32 @@ def object_list(
     if extra_context is None:
         extra_context = {}
     queryset = queryset._clone()
+    model = queryset.model
     if paginate_by:
-        paginator = Paginator(queryset, paginate_by, allow_empty_first_page=allow_empty)
-        if not page:
-            page = request.GET.get("page", 1)
+        pagination = Pagination(request, model, queryset, paginate_by)
+        object_list = pagination.get_objects()
 
-        if page == "last":
-            page_number = paginator.num_pages
-        else:
-            try:
-                page_number = int(page)
-            except ValueError:
-                # Page is not 'last', nor can it be converted to an int.
-                raise Http404
-        try:
-            page_obj = paginator.page(page_number)
-        except InvalidPage:
-            raise Http404
-        try:
-            next_page = page_obj.next_page_number()
-        except InvalidPage:
-            next_page = None
-        try:
-            previous_page = page_obj.previous_page_number()
-        except InvalidPage:
-            previous_page = None
-
-        c = {
-            "%s_list" % template_object_name: page_obj.object_list,
-            "paginator": paginator,
-            "page_obj": page_obj,
-            "is_paginated": page_obj.has_other_pages(),
-            # Legacy template context stuff. New templates should use page_obj
-            # to access this instead.
-            "results_per_page": paginator.per_page,
-            "has_next": page_obj.has_next(),
-            "has_previous": page_obj.has_previous(),
-            "page": page_obj.number,
-            "next": next_page,
-            "previous": previous_page,
-            "first_on_page": page_obj.start_index(),
-            "last_on_page": page_obj.end_index(),
-            "pages": paginator.num_pages,
-            "hits": paginator.count,
-            "page_range": paginator.page_range,
+        context = {
+            "%s_list" % template_object_name: object_list,
+            "pagination": pagination,
+            "hits": pagination.result_count,
         }
     else:
-        c = {
-            "%s_list" % template_object_name: queryset,
-            "paginator": None,
-            "page_obj": None,
-            "is_paginated": False,
+        context = {
+            "%s_list" % template_object_name: object_list,
         }
         if not allow_empty and len(queryset) == 0:
             raise Http404
 
     for key, value in extra_context.items():
         if callable(value):
-            c[key] = value()
+            context[key] = value()
         else:
-            c[key] = value
+            context[key] = value
     if not template_name:
-        model = queryset.model
         template_name = "%s/%s_list.html" % (model._meta.app_label, model._meta.object_name.lower())
-    t = template_loader.get_template(template_name)
-    return HttpResponse(t.render(c, request=request), content_type=content_type)
+    template = template_loader.get_template(template_name)
+    return HttpResponse(template.render(context, request=request), content_type=content_type)
 
 
 def object_detail(

djangosnippets/static/scss/main.scss

@@ -317,7 +317,7 @@ body.with-sidebar {
             @include grid-column(4);
         }
     }
-    .pagination, .count {
+    .count {
         text-align: center;
     }
 }
@@ -358,6 +358,66 @@ body.simple {
     }
 }
 
+nav.pagination {
+    display: flex;
+    justify-content: center;
+    text-align: center;
+    ul {
+        margin-left: 1rem;
+        margin-right: 1rem;
+    }
+
+    li {
+        display: inline-block;
+        a, em, span {
+            padding: 5px 10px;
+            min-width: 32px;
+            line-height: 20px;
+            border: 1px solid transparent;
+            border-radius: 6px;
+            transition: border-color .2s cubic-bezier(0.3, 0, 0.5, 1);
+            cursor: pointer;
+        }
+        a:hover {
+            border-color: $secondary-color;
+            text-decoration: none;
+        }
+        em {
+            font-style: normal;
+            cursor: default;
+        }
+        .current-page {
+            font-weight: bold;
+            color: white;
+            background-color: $secondary-color;
+        }
+        .disabled {
+            color: gray;
+            cursor: default;
+            border-color: transparent;
+        }
+    }
+
+    .previous-page::before, .next-page::after {
+        display: inline-block;
+        width: 1rem;
+        height: 1rem;
+        vertical-align: text-bottom;
+        content: "";
+        background-color: currentColor;
+    }
+
+    .previous-page::before {
+        clip-path: polygon(9.8px 12.8px, 8.7px 12.8px, 4.5px 8.5px, 4.5px 7.5px, 8.7px 3.2px, 9.8px 4.3px, 6.1px 8px, 9.8px 11.7px, 9.8px 12.8px);
+        margin-right: 4px;
+    }
+
+    .next-page::after {
+        clip-path: polygon(6.2px 3.2px, 7.3px 3.2px, 11.5px 7.5px, 11.5px 8.5px, 7.3px 12.8px, 6.2px 11.7px, 9.9px 8px, 6.2px 4.3px, 6.2px 3.2px);
+        margin-left: 4px;
+    }
+}
+
 footer {
     padding: 30px 0 30px 0;
     clear: both;

djangosnippets/templates/base.html

@@ -39,11 +39,11 @@
     {% block secondary_nav %}
     <nav id="subnav">
       <ul>
-        <li><a hx-get="{% url 'cab_top_authors' %}" hx-target="#base-container" hx-swap="innerHTML" hx-trigger="click">By author</a></li>
-        <li><a hx-get="{% url 'cab_language_list' %}" hx-target="#base-container" hx-swap="innerHTML" hx-trigger="click" >By language</a></li>
-        <li><a hx-get="{% url 'cab_top_tags' %}" hx-target="#base-container" hx-swap="innerHTML" hx-trigger="click">By tag</a></li>
-        <li><a hx-get="{% url 'cab_top_rated' %}" hx-target="#base-container" hx-swap="innerHTML" hx-trigger="click">Highest rated</a></li>
-        <li><a hx-get="{% url 'cab_top_bookmarked' %}" hx-target="#base-container" hx-swap="innerHTML" hx-trigger="click">Most bookmarked</a></li>
+        <li><a href="{% url 'cab_top_authors' %}">By author</a></li>
+        <li><a href="{% url 'cab_language_list' %}">By language</a></li>
+        <li><a href="{% url 'cab_top_tags' %}">By tag</a></li>
+        <li><a href="{% url 'cab_top_rated' %}">Highest rated</a></li>
+        <li><a href="{% url 'cab_top_bookmarked' %}">Most bookmarked</a></li>
       </ul>
     </nav>
     {% endblock %}

djangosnippets/templates/cab/language_list.html

@@ -1,5 +1,5 @@
 {% extends "base.html" %}
-{% load core_tags %}
+{% load core_tags components %}
 
 {% block head_title %}All languages{% endblock %}
 
@@ -12,6 +12,6 @@
   {% endfor %}
   </ul>
 
-  <p class="pagination">{% if has_previous %}<a href="?page={{ previous }}">&lt; Previous {{ results_per_page }}</a>{% endif %}&nbsp;&nbsp;{% if has_next %}<a href="?page={{ next }}">Next {{ results_per_page }} &gt;</a>{% endif %}</p>
+  {% pagination pagination %}
 
 {% endblock %}

djangosnippets/templates/cab/partials/language_list.html

@@ -1,4 +1,4 @@
-{% load static %}
+{% load static components %}
 
 
 <img class="bars" src="{% static 'img/bars.svg' %}"/> 
@@ -10,6 +10,5 @@ <h1>All languages</h1>
   {% endfor %}
   </ul>
 
-  <p class="pagination">{% if has_previous %}<a href="{% url 'cab_language_list' %}?page={{ previous }}">&lt; Previous {{ results_per_page }}</a>{% endif %}&nbsp;&nbsp;{% if has_next %}<a href="{% url 'cab_language_list' %}?page={{ next }}">Next {{ results_per_page }} &gt;</a>{% endif %}</p>
-
+  {% pagination pagination %}
 </div>

djangosnippets/templates/cab/partials/most_bookmarked.html

@@ -1,5 +1,5 @@
 
-{% load core_tags %}
+{% load core_tags components %}
 {% load static %}
 
 <h1>Most bookmarked snippets{% if months %} last {{ months }} months{% endif %}</h1>
@@ -30,15 +30,7 @@ <h1>Most bookmarked snippets{% if months %} last {{ months }} months{% endif %}<
     {% endfor %}
       </tbody>
     </table>
-    <p class="pagination">
-      {% if has_previous %}
-        <a href="{% url 'cab_top_bookmarked' %}?page={{ previous }}{% if months %}&amp;months={{ months }}{% endif %}">&lt; Previous {{ results_per_page }}</a>
-      {% endif %}
-      &nbsp;&nbsp;
-      {% if has_next %}
-        <a href="{% url 'cab_top_bookmarked' %}?page={{ next }}{% if months %}&amp;months={{ months }}{% endif %}">Next {{ results_per_page }} &gt;</a>
-      {% endif %}
-    </p>
+    {% pagination pagination %}
     <p class="count">{{ hits }} snippet{{ hits|pluralize }} posted so far.</p>
   {% else %}
     <p class="empty">No snippets posted yet.</p>

djangosnippets/templates/cab/partials/tag_list.html

@@ -1,5 +1,5 @@
 
-{% load core_tags %}
+{% load core_tags components %}
 <h1>All tags</h1>
 <div id="content">
   {% if object_list %}
@@ -9,7 +9,7 @@ <h1>All tags</h1>
     {% endfor %}
     </ul>
 
-    <p class="pagination">{% if has_previous %}<a href="{% url 'cab_top_tags' %}?page={{ previous }}">&lt; Previous {{ results_per_page }}</a>{% endif %}&nbsp;&nbsp;{% if has_next %}<a href="{% url 'cab_top_tags' %}?page={{ next }}">Next {{ results_per_page }} &gt;</a>{% endif %}</p>
+    {% pagination pagination %}
   {% else %}
     <p>No tags have been used yet.</p>
   {% endif %}