From 500f05266a3fb46308838169936d60debaa7c0a7 Mon Sep 17 00:00:00 2001
From: Joel Bradshaw <cincodenada@gmail.com>
Date: Sat, 28 Nov 2020 00:07:04 -0800
Subject: [PATCH] Add option for progress percentage

And rework display on book page as well
---
 bookwyrm/models/status.py                     | 20 +++++--
 bookwyrm/templates/book.html                  | 54 ++++++++++++++-----
 .../templates/snippets/progress_update.html   | 23 ++++++--
 bookwyrm/tests/actions/test_readthrough.py    |  8 +--
 bookwyrm/view_actions.py                      | 27 +++++-----
 bookwyrm/views.py                             |  2 +-
 6 files changed, 95 insertions(+), 39 deletions(-)

diff --git a/bookwyrm/models/status.py b/bookwyrm/models/status.py
index b92685da4..2a9a4be14 100644
--- a/bookwyrm/models/status.py
+++ b/bookwyrm/models/status.py
@@ -292,13 +292,21 @@ class Boost(Status):
     #     unique_together = ('user', 'boosted_status')
 
 
+class ProgressMode(models.TextChoices):
+    PAGE = 'PG', 'page'
+    PERCENT = 'PCT', 'percent'
+
 class ReadThrough(BookWyrmModel):
     ''' Store a read through a book in the database. '''
     user = models.ForeignKey('User', on_delete=models.PROTECT)
     book = models.ForeignKey('Book', on_delete=models.PROTECT)
-    pages_read = models.IntegerField(
+    progress = models.IntegerField(
         null=True,
         blank=True)
+    progress_mode = models.CharField(
+        max_length=3,
+        choices=ProgressMode.choices,
+        default=ProgressMode.PAGE)
     start_date = models.DateTimeField(
         blank=True,
         null=True)
@@ -312,9 +320,13 @@ class ReadThrough(BookWyrmModel):
         self.user.save()
         super().save(*args, **kwargs)
 
-class ProgressMode(models.TextChoices):
-    PAGE = 'PG', 'page'
-    PERCENT = 'PCT', 'percent'
+    def create_update(self):
+        if self.progress:
+            return self.progressupdate_set.create(
+                user=self.user,
+                progress=self.progress,
+                mode=self.progress_mode)
+
 
 class ProgressUpdate(BookWyrmModel):
     ''' Store progress through a book in the database. '''
diff --git a/bookwyrm/templates/book.html b/bookwyrm/templates/book.html
index 2bd9fc778..aeafaafb7 100644
--- a/bookwyrm/templates/book.html
+++ b/bookwyrm/templates/book.html
@@ -74,9 +74,13 @@
                         {% if readthrough.finish_date %}
                         <dt>Finished reading:</dt>
                         <dd>{{ readthrough.finish_date | naturalday }}</dd>
-                        {% elif readthrough.pages_read %}
-                        <dt>On page:</dt>
-                        <dd>{{ readthrough.pages_read }} of {{ book.pages }}</dd>
+                        {% elif readthrough.progress %}
+                        <dt>Progress:</dt>
+                        {% if readthrough.progress_mode == 'PG' %}
+                        <dd>on page {{ readthrough.progress }} of {{ book.pages }}</dd>
+                        {% else %}
+                        <dd>{{ readthrough.progress }}%</dd>
+                        {% endif %}
                         {% endif %}
                     </dl>
                     <div class="field is-grouped">
@@ -93,12 +97,22 @@
                     </div>
                     {% if show_progress %}
                     Progress Updates:
-                    <dl class="progress-updates">
+                    <ul>
+                        {% if readthrough.finish_date %}
+                        <li>{{ readthrough.start_date | naturalday }}: finished</li>
+                        {% endif %}
                         {% for progress_update in readthrough.progress_updates %}
-                        <dt>{{ progress_update.created_date | naturalday }}:</dt>
-                        <dd>{{ progress_update.progress }} of {{ book.pages }}</dd>
+                        <li>
+                            {{ progress_update.created_date | naturalday }}:
+                            {% if progress_update.mode == 'PG' %}
+                            page {{ progress_update.progress }} of {{ book.pages }}
+                            {% else %}
+                            {{ progress_update.progress }}%
+                            {% endif %}
+                        </li>
                         {% endfor %}
-                    </dl>
+                        <li>{{ readthrough.start_date | naturalday }}: started</li>
+                    </ul>
                     {% elif readthrough.progress_updates|length %}
                     <a href="?showprogress">Show {{ readthrough.progress_updates|length }} Progress Updates</a>
                     {% endif %}
@@ -118,11 +132,27 @@
                                     <input type="date" name="start_date" class="input" id="id_start_date-{{ readthrough.id }}" value="{{ readthrough.start_date | date:"Y-m-d" }}">
                                 </label>
                             </div>
-                            <div class="field">
-                                <label class="label">
-                                    On page
-                                    <input type="number" name="pages_read" class="input" id="id_pages_read-{{ readthrough.id }}" value="{{ readthrough.pages_read }}">
-                                </label>
+                            <div class="columns">
+                                <div class="column">
+                                    <div class="field">
+                                        <label class="label">
+                                            Progress
+                                            <input type="number" name="progress" class="input" id="id_progress-{{ readthrough.id }}" value="{{ readthrough.progress }}">
+                                        </label>
+                                    </div>
+                                </div>
+                                <div class="column">
+                                    <div class="control mt-5">
+                                        <label class="radio">
+                                            <input type="radio" name="progress_mode" id="id_progress_mode-{{ readthrough.id }}" value="PG" {% if readthrough.progress_mode == 'PG' %}checked{% endif %}>
+                                            pages
+                                        </label>
+                                        <label class="radio">
+                                            <input type="radio" name="progress_mode" id="id_progress_mode-{{ readthrough.id }}" value="PCT" {% if readthrough.progress_mode == 'PCT' %}checked{% endif %}>
+                                            percent
+                                        </label>
+                                    </div>
+                                </div>
                             </div>
                             <div class="field">
                                 <label class="label">
diff --git a/bookwyrm/templates/snippets/progress_update.html b/bookwyrm/templates/snippets/progress_update.html
index 51385b973..9de51b07b 100644
--- a/bookwyrm/templates/snippets/progress_update.html
+++ b/bookwyrm/templates/snippets/progress_update.html
@@ -1,13 +1,26 @@
 <form class="field is-grouped is-small pl-2" action="/edit-readthrough" method="POST">
     {% csrf_token %}
     <input type="hidden" name="id" value="{{ readthrough.id }}"/>
-    <div class="control">on page</div>
     <div class="control">
-        <input aria-label="Current page" class="input is-small" type="text" name="pages_read" size="3" value="{{ readthrough.pages_read }}">
+        {% if readthrough.progress_mode == 'PG' %}
+        on page
+        {% else %}
+        currently at
+        {% endif %}
+    </div>
+    <div class="control">
+        <input
+         aria-label="{% if readthrough.progress_mode == 'PG' %}Current page{% else %}Perent read{% endif%}"
+         class="input is-small" type="text"
+         name="progress" size="3" value="{{ readthrough.progress }}">
+    </div>
+    <div class="control">
+        {% if readthrough.progress_mode == 'PG' and book.pages %}
+        of {{ book.pages }}
+        {% else %}
+        %
+        {% endif %}
     </div>
-    {% if book.pages %}
-    <div class="control">of {{ book.pages }}</div>
-    {% endif %}
     <div class="control">
         <button class="button is-small px-2" type="submit">Go</button>
     </div>
diff --git a/bookwyrm/tests/actions/test_readthrough.py b/bookwyrm/tests/actions/test_readthrough.py
index ba8c2f007..c764fac36 100644
--- a/bookwyrm/tests/actions/test_readthrough.py
+++ b/bookwyrm/tests/actions/test_readthrough.py
@@ -36,7 +36,7 @@ class ReadThrough(TestCase):
         self.assertEqual(readthroughs[0].progressupdate_set.count(), 0)
         self.assertEqual(readthroughs[0].start_date,
             datetime(2020, 11, 27, tzinfo=timezone.utc))
-        self.assertEqual(readthroughs[0].pages_read, None)
+        self.assertEqual(readthroughs[0].progress, None)
         self.assertEqual(readthroughs[0].finish_date, None)
 
     def test_create_progress_readthrough(self):
@@ -44,14 +44,14 @@ class ReadThrough(TestCase):
 
         self.client.post('/start-reading/{}'.format(self.edition.id), {
             'start_date': '2020-11-27',
-            'pages_read': 50,
+            'progress': 50,
         })
 
         readthroughs = self.edition.readthrough_set.all()
         self.assertEqual(len(readthroughs), 1)
         self.assertEqual(readthroughs[0].start_date,
             datetime(2020, 11, 27, tzinfo=timezone.utc))
-        self.assertEqual(readthroughs[0].pages_read, 50)
+        self.assertEqual(readthroughs[0].progress, 50)
         self.assertEqual(readthroughs[0].finish_date, None)
 
         progress_updates = readthroughs[0].progressupdate_set.all()
@@ -62,7 +62,7 @@ class ReadThrough(TestCase):
         # Update progress
         self.client.post('/edit-readthrough', {
             'id': readthroughs[0].id,
-            'pages_read': 100,
+            'progress': 100,
         })
 
         progress_updates = readthroughs[0].progressupdate_set\
diff --git a/bookwyrm/view_actions.py b/bookwyrm/view_actions.py
index f5aee7a42..f794df5ad 100644
--- a/bookwyrm/view_actions.py
+++ b/bookwyrm/view_actions.py
@@ -364,11 +364,7 @@ def start_reading(request, book_id):
         readthrough.save()
 
     # create a progress update if we have a page
-    if readthrough.pages_read:
-        readthrough.progressupdate_set.create(
-            user=request.user,
-            progress=readthrough.pages_read,
-            mode=models.ProgressMode.PAGE)
+    readthrough.create_update()
 
     # shelve the book
     if request.POST.get('reshelve', True):
@@ -440,10 +436,7 @@ def edit_readthrough(request):
 
     # record the progress update individually
     # use default now for date field
-    readthrough.progressupdate_set.create(
-        user=request.user,
-        progress=readthrough.pages_read,
-        mode=models.ProgressMode.PAGE)
+    readthrough.create_update()
 
     return redirect(request.headers.get('Referer', '/'))
 
@@ -750,11 +743,19 @@ def update_readthrough(request, book=None, create=True):
         except ParserError:
             pass
 
-    pages_read = request.POST.get('pages_read')
-    if pages_read:
+    progress = request.POST.get('progress')
+    if progress:
         try:
-            pages_read = int(pages_read)
-            readthrough.pages_read = pages_read
+            progress = int(progress)
+            readthrough.progress = progress
+        except ValueError:
+            pass
+
+    progress_mode = request.POST.get('progress_mode')
+    if progress_mode:
+        try:
+            progress_mode = models.ProgressMode(progress_mode)
+            readthrough.progress_mode = progress_mode
         except ValueError:
             pass
 
diff --git a/bookwyrm/views.py b/bookwyrm/views.py
index 5ccc343e1..0d05e12ca 100644
--- a/bookwyrm/views.py
+++ b/bookwyrm/views.py
@@ -564,7 +564,7 @@ def book_page(request, book_id):
 
         for readthrough in readthroughs:
             readthrough.progress_updates = \
-                readthrough.progressupdate_set.all().order_by('updated_date')
+                readthrough.progressupdate_set.all().order_by('-updated_date')
 
     rating = reviews.aggregate(Avg('rating'))
     tags = models.Tag.objects.filter(