From 985697f8eebf021059fd3b9fd67bd3799e74d845 Mon Sep 17 00:00:00 2001
From: Nathan Chapman <contact@nathanjchapman.com>
Date: Sun, 29 Jan 2023 15:31:24 -0700
Subject: [PATCH] Add ability to drag-n-drop sort Products, Variants, and
 Photos

---
 dashboard/templates/dashboard/catalog.html    |  2 +-
 .../templates/dashboard/category/list.html    |  2 +-
 .../templates/dashboard/product/_table.html   |  6 +--
 .../templates/dashboard/product/detail.html   | 30 +++++------
 .../templates/dashboard/product/list.html     |  5 ++
 dashboard/urls.py                             |  6 +++
 dashboard/views.py                            | 26 +++++++++-
 static/scripts/sorting.js                     | 51 +++++++++++++++++++
 static/styles/dashboard.css                   |  4 ++
 templates/dashboard.html                      |  5 ++
 10 files changed, 116 insertions(+), 21 deletions(-)
 create mode 100644 static/scripts/sorting.js

diff --git a/dashboard/templates/dashboard/catalog.html b/dashboard/templates/dashboard/catalog.html
index 7a6ac93..b4ac5e1 100644
--- a/dashboard/templates/dashboard/catalog.html
+++ b/dashboard/templates/dashboard/catalog.html
@@ -19,7 +19,7 @@
             <h3>{{ category }}</h3>
             <a href="{% url 'dashboard:category-detail' category.pk %}" class="btn">View category &rarr;</a>
         </header>
-        {% include 'dashboard/product/_table.html' with product_list=category.product_set.all %}
+        {% include 'dashboard/product/_table.html' with product_list=category.product_set.all category=category %}
     </section>
     {% endfor %}
 
diff --git a/dashboard/templates/dashboard/category/list.html b/dashboard/templates/dashboard/category/list.html
index d36b932..5832376 100644
--- a/dashboard/templates/dashboard/category/list.html
+++ b/dashboard/templates/dashboard/category/list.html
@@ -20,7 +20,7 @@
             <h3>{{ category }}</h3>
             <a href="{% url 'dashboard:category-detail' category.pk %}" class="btn">View category &rarr;</a>
         </header>
-        {% include 'dashboard/product/_table.html' with product_list=category.product_set.all %}
+        {% include 'dashboard/product/_table.html' with product_list=category.product_set.all category=category %}
     </section>
     {% endfor %}
 </article>
diff --git a/dashboard/templates/dashboard/product/_table.html b/dashboard/templates/dashboard/product/_table.html
index 841837e..d587362 100644
--- a/dashboard/templates/dashboard/product/_table.html
+++ b/dashboard/templates/dashboard/product/_table.html
@@ -6,10 +6,10 @@
             <th>Visible in listings</th>
         </tr>
     </thead>
-    <tbody>
+    <tbody class="sortable" data-model="product" data-filter="category" data-fid="{{ category.pk }}">
         {% for product in product_list  %}
-        <tr class="is-link" onclick="window.location='{% url 'dashboard:product-detail' product.pk %}'">
-            <td>{{ product.sorting }}</td>
+        <tr class="is-link" data-id="{{ product.pk }}" onclick="window.location='{% url 'dashboard:product-detail' product.pk %}'">
+            <td class="handle">&#9776;</td>
             <td>
                 <figure class="product-figure">
                     <img class="product-image" src="{{ product.get_first_img.image.url }}" alt="{{ product.get_first_img.image }}">
diff --git a/dashboard/templates/dashboard/product/detail.html b/dashboard/templates/dashboard/product/detail.html
index 60a982d..05d68ae 100644
--- a/dashboard/templates/dashboard/product/detail.html
+++ b/dashboard/templates/dashboard/product/detail.html
@@ -80,10 +80,10 @@
                     <th colspan="2">Stock</th>
                 </tr>
             </thead>
-            <tbody>
+            <tbody class="sortable" data-model="productvariant" data-filter="product" data-fid="{{ product.pk }}">
                 {% for variant in product.variants.all %}
-                <tr>
-                    <td>{{ variant.sorting }}</td>
+                <tr data-id="{{ variant.pk }}">
+                    <td class="handle">&#9776;</td>
                     <td>
                         <h3>{{ variant.name }}</h3>
                     </td>
@@ -124,18 +124,18 @@
             <h4>Photos</h4>
             <a href="{% url 'dashboard:prodphoto-create' product.pk %}" class="btn">+ Upload new photo</a>
         </header>
-        <div class="gallery panel-section">
-            {% for photo in product.productphoto_set.all %}
-                <figure class="gallery-item">
-                    <img src="{{ photo.image.url }}">
-                    <figcaption>
-                        <form action="{% url 'dashboard:prodphoto-delete' product.pk photo.pk %}" method="post">
-                            {% csrf_token %}
-                            <input type="submit" class="btn btn-warning" value="Delete photo">
-                        </form>
-                    </figcaption>
-                </figure>
-            {% endfor %}
+        <div class="gallery panel-section sortable" data-model="productphoto" data-filter="product" data-fid="{{ product.pk }}">
+        {% for photo in product.productphoto_set.all %}
+            <figure class="gallery-item handle" data-id="{{ photo.pk }}">
+                <img src="{{ photo.image.url }}">
+                <figcaption>
+                    <form action="{% url 'dashboard:prodphoto-delete' product.pk photo.pk %}" method="post">
+                        {% csrf_token %}
+                        <input type="submit" class="btn btn-warning" value="Delete photo">
+                    </form>
+                </figcaption>
+            </figure>
+        {% endfor %}
         </div>
     </section>
 </article>
diff --git a/dashboard/templates/dashboard/product/list.html b/dashboard/templates/dashboard/product/list.html
index 0f6081b..7f42180 100644
--- a/dashboard/templates/dashboard/product/list.html
+++ b/dashboard/templates/dashboard/product/list.html
@@ -3,6 +3,11 @@
 
 {% block head_title %}Products | {% endblock %}
 
+{% block head %}
+<script src="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>
+<script type="module" src="{% static 'scripts/sorting.js' %}" defer></script>
+{% endblock %}
+
 {% block content %}
 <article>
     <header class="object-header">
diff --git a/dashboard/urls.py b/dashboard/urls.py
index 2b0b180..f2ab9d6 100644
--- a/dashboard/urls.py
+++ b/dashboard/urls.py
@@ -231,6 +231,12 @@ urlpatterns = [
         ])),
     ])),
 
+    path(
+        'update-sorting/',
+        views.update_sorting,
+        name='update-sorting'
+    ),
+
     path(
         'customers/',
         views.CustomerListView.as_view(),
diff --git a/dashboard/views.py b/dashboard/views.py
index 64e0a98..2523604 100644
--- a/dashboard/views.py
+++ b/dashboard/views.py
@@ -1,10 +1,12 @@
 import logging
+import json
 from datetime import datetime
 from django.conf import settings
 from django.utils import timezone
 from django import forms
+from django.apps import apps
 from django.shortcuts import render, reverse, redirect, get_object_or_404
-from django.http import HttpResponseRedirect
+from django.http import JsonResponse, HttpResponseRedirect
 from django.urls import reverse, reverse_lazy
 from django.views.generic.base import RedirectView, TemplateView
 from django.views.generic.edit import (
@@ -13,6 +15,7 @@ from django.views.generic.edit import (
 from django.views.generic.detail import DetailView, SingleObjectMixin
 from django.views.generic.list import ListView
 from django.contrib.auth.decorators import login_required
+from django.views.decorators.http import require_POST
 from django.contrib.auth.mixins import (
     LoginRequiredMixin, PermissionRequiredMixin
 )
@@ -616,6 +619,27 @@ class ProductOptionDeleteView(
     success_url = reverse_lazy('dashboard:catalog')
 
 
+def sort(objs, order):
+    for i, pk in enumerate(order):
+        m = objs.get(pk=pk)
+        m.sorting = i+1
+        yield m
+
+
+@require_POST
+def update_sorting(request):
+    data = json.loads(request.body)
+    model = apps.get_model('core', data['model_name'])
+    objs = model.objects.filter(
+        Q((data['filter'], data['filter_id']))
+    ).order_by('sorting')
+
+    updated_objs = sort(objs, data['order'])
+
+    model.objects.bulk_update(updated_objs, ['sorting'])
+    return JsonResponse({'message': 'Sorting updated'})
+
+
 class CustomerListView(LoginRequiredMixin, ListView):
     model = User
     template_name = 'dashboard/customer/list.html'
diff --git a/static/scripts/sorting.js b/static/scripts/sorting.js
new file mode 100644
index 0000000..2a04a2d
--- /dev/null
+++ b/static/scripts/sorting.js
@@ -0,0 +1,51 @@
+import { getCookie } from './cookie.js'
+const sorting_url = JSON.parse(document.querySelector('#sorting-url').textContent);
+
+document.querySelectorAll('.sortable').forEach(el => {
+  const options = {
+    animation: 150,
+    store: {
+      /**
+       * Save the order of elements. Called onEnd (when the item is dropped).
+       * @param {Sortable}  sortable
+       */
+      set: (sortable) => {
+        const order = sortable.toArray()
+        const csrftoken = getCookie('csrftoken')
+        const data = {
+          model_name: el.dataset.model,
+          filter: el.dataset.filter,
+          filter_id: el.dataset.fid,
+          order: order
+        }
+
+        const options = {
+          method: 'POST',
+          body: JSON.stringify(data),
+          mode: 'same-origin',
+        };
+
+        // construct a new Request passing in the csrftoken
+        const request = new Request(sorting_url, {
+          headers: {
+            'Content-Type': 'application/json',
+            'X-CSRFToken': csrftoken
+          },
+        })
+
+        return fetch(request, options)
+          .then((response) => response.json())
+          .then((data) => {
+            console.log('Success:', data);
+          })
+          .catch((error) => {
+            console.error('Error:', error);
+          })
+      }
+    }
+  }
+  if (el.querySelector('.handle')) {
+    options.handle = '.handle'
+  }
+  new Sortable(el, options)
+})
diff --git a/static/styles/dashboard.css b/static/styles/dashboard.css
index 5b931c5..fec5183 100644
--- a/static/styles/dashboard.css
+++ b/static/styles/dashboard.css
@@ -643,3 +643,7 @@ main > article > header {
 .text-center {
     text-align: center;
 }
+
+.handle {
+    cursor: grab;
+}
diff --git a/templates/dashboard.html b/templates/dashboard.html
index b2cbf62..8aa6d94 100644
--- a/templates/dashboard.html
+++ b/templates/dashboard.html
@@ -22,6 +22,8 @@
     {% endcompress %}
 
     <script type="module" defer src="{% static 'scripts/initializers/timezone.js' %}"></script>
+    <script src="https://cdn.jsdelivr.net/npm/sortablejs@latest/Sortable.min.js"></script>
+    <script type="module" src="{% static 'scripts/sorting.js' %}" defer></script>
 
     {% block head %}
     {% endblock %}
@@ -84,6 +86,9 @@
 </div>
 {% endif %}
 
+{% url 'dashboard:update-sorting' as sorting_url %}
+{{ sorting_url|json_script:"sorting-url" }}
+
 <script>
     document.addEventListener('DOMContentLoaded', () => {
         document.querySelectorAll('.message-dissmiss').forEach(dissmissEl => {