Merge pull request #1529 from scientia-ac-labore/add_sort_books

Add sorting to shelf. Use table-sort-header

bookwyrm/settings.py

@@ -7,6 +7,7 @@ from django.utils.translation import gettext_lazy as _
 
 
 env = Env()
+env.read_env()
 DOMAIN = env("DOMAIN")
 VERSION = "0.0.1"
 

bookwyrm/templates/shelf/shelf.html

@@ -124,14 +124,16 @@
         <table class="table is-striped is-fullwidth is-mobile">
             <thead>
                 <tr>
-                    <th>{% trans "Cover" %}</th>
-                    <th>{% trans "Title" %}</th>
-                    <th>{% trans "Author" %}</th>
-                    <th>{% trans "Shelved" %}</th>
-                    <th>{% trans "Started" %}</th>
-                    <th>{% trans "Finished" %}</th>
+                    <th>{% trans "Cover"%}</th>
+                    <th>{% trans "Title"  as text %}{% include 'snippets/table-sort-header.html' with field="title" sort=sort text=text %}</th>
+                    <th>{% trans "Author"  as text %}{% include 'snippets/table-sort-header.html' with field="author" sort=sort text=text %}</th>
                     {% if request.user.is_authenticated %}
-                    <th>{% trans "Rating" %}</th>
+                        {% if is_self %}
+                    <th>{% trans "Shelved"  as text %}{% include 'snippets/table-sort-header.html' with field="shelved_date" sort=sort text=text %}</th>
+                    <th>{% trans "Started"  as text %}{% include 'snippets/table-sort-header.html' with field="start_date" sort=sort text=text %}</th>
+                    <th>{% trans "Finished"  as text %}{% include 'snippets/table-sort-header.html' with field="finish_date" sort=sort text=text %}</th>
+                        {% endif %}
+                    <th>{% trans "Rating" as text %}{% include 'snippets/table-sort-header.html' with field="rating" sort=sort text=text %}</th>
                     {% endif %}
                     {% if shelf.user == request.user %}
                     <th aria-hidden="true"></th>
@@ -151,17 +153,18 @@
                     <td data-title="{% trans "Author" %}">
                         {% include 'snippets/authors.html' %}
                     </td>
+                    {% if request.user.is_authenticated %}
+                        {% if is_self %}
                     <td data-title="{% trans "Shelved" %}">
                         {{ book.shelved_date|naturalday }}
                     </td>
-                    {% latest_read_through book user as read_through %}
                     <td data-title="{% trans "Started" %}">
-                        {{ read_through.start_date|naturalday|default_if_none:""}}
+                        {{ book.start_date|naturalday|default_if_none:""}}
                     </td>
                     <td data-title="{% trans "Finished" %}">
-                        {{ read_through.finish_date|naturalday|default_if_none:""}}
+                        {{ book.finish_date|naturalday|default_if_none:""}}
                     </td>
-                    {% if request.user.is_authenticated %}
+                        {% endif %}
                     <td data-title="{% trans "Rating" %}">
                         {% include 'snippets/stars.html' with rating=book.rating %}
                     </td>

bookwyrm/views/shelf.py

@@ -68,16 +68,30 @@ class Shelf(View):
             deleted=False,
         ).order_by("-published_date")
 
+        reading = models.ReadThrough.objects
+
+        reading = reading.filter(user=user, book__id=OuterRef("id")).order_by(
+            "start_date"
+        )
+
         books = books.annotate(
             rating=Subquery(reviews.values("rating")[:1]),
             shelved_date=F("shelfbook__shelved_date"),
+            start_date=Subquery(reading.values("start_date")[:1]),
+            finish_date=Subquery(reading.values("finish_date")[:1]),
+            author=Subquery(
+                models.Book.objects.filter(id=OuterRef("id")).values("authors__name")[
+                    :1
+                ]
+            ),
         ).prefetch_related("authors")
 
+        books = sort_books(books, request.GET.get("sort"))
+
         paginated = Paginator(
-            books.order_by("-shelfbook__updated_date"),
+            books,
             PAGE_LENGTH,
         )
-
         page = paginated.get_page(request.GET.get("page"))
         data = {
             "user": user,
@@ -87,6 +101,7 @@ class Shelf(View):
             "books": page,
             "edit_form": forms.ShelfForm(instance=shelf if shelf_identifier else None),
             "create_form": forms.ShelfForm(),
+            "sort": request.GET.get("sort"),
             "page_range": paginated.get_elided_page_range(
                 page.number, on_each_side=2, on_ends=1
             ),
@@ -207,3 +222,23 @@ def unshelve(request):
 
     shelf_book.delete()
     return redirect(request.headers.get("Referer", "/"))
+
+
+def sort_books(books, sort):
+    """Books in shelf sorting"""
+    sort_fields = [
+        "title",
+        "author",
+        "shelved_date",
+        "start_date",
+        "finish_date",
+        "rating",
+    ]
+
+    if sort in sort_fields:
+        books = books.order_by(sort)
+    elif sort and sort[1:] in sort_fields:
+        books = books.order_by(F(sort[1:]).desc(nulls_last=True))
+    else:
+        books = books.order_by("-shelved_date")
+    return books

pytest.ini

@@ -7,6 +7,7 @@ markers =
 
 env =
     DEBUG = false
+    USE_HTTPS=true
     DOMAIN = your.domain.here
     BOOKWYRM_DATABASE_BACKEND = postgres
     MEDIA_ROOT = images/