Merge pull request #1301 from bookwyrm-social/refactor-modals

Prompt user to add commentary on reading status updates

bookwyrm/activitypub/note.py

@@ -59,6 +59,9 @@ class Comment(Note):
     """like a note but with a book"""
 
     inReplyToBook: str
+    readingStatus: str = None
+    progress: int = None
+    progressMode: str = None
     type: str = "Comment"
 
 

bookwyrm/forms.py

@@ -86,6 +86,7 @@ class CommentForm(CustomForm):
             "privacy",
             "progress",
             "progress_mode",
+            "reading_status",
         ]
 
 

bookwyrm/migrations/0083_auto_20210816_2022.py

@@ -0,0 +1,56 @@
+# Generated by Django 3.2.4 on 2021-08-16 20:22
+
+import bookwyrm.models.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookwyrm", "0082_auto_20210806_2324"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="comment",
+            name="reading_status",
+            field=bookwyrm.models.fields.CharField(
+                blank=True,
+                choices=[
+                    ("to-read", "Toread"),
+                    ("reading", "Reading"),
+                    ("read", "Read"),
+                ],
+                max_length=255,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="quotation",
+            name="reading_status",
+            field=bookwyrm.models.fields.CharField(
+                blank=True,
+                choices=[
+                    ("to-read", "Toread"),
+                    ("reading", "Reading"),
+                    ("read", "Read"),
+                ],
+                max_length=255,
+                null=True,
+            ),
+        ),
+        migrations.AddField(
+            model_name="review",
+            name="reading_status",
+            field=bookwyrm.models.fields.CharField(
+                blank=True,
+                choices=[
+                    ("to-read", "Toread"),
+                    ("reading", "Reading"),
+                    ("read", "Read"),
+                ],
+                max_length=255,
+                null=True,
+            ),
+        ),
+    ]

bookwyrm/models/status.py

@@ -235,12 +235,31 @@ class GeneratedNote(Status):
     pure_type = "Note"
 
 
-class Comment(Status):
-    """like a review but without a rating and transient"""
+ReadingStatusChoices = models.TextChoices(
+    "ReadingStatusChoices", ["to-read", "reading", "read"]
+)
+
+
+class BookStatus(Status):
+    """Shared fields for comments, quotes, reviews"""
 
     book = fields.ForeignKey(
         "Edition", on_delete=models.PROTECT, activitypub_field="inReplyToBook"
     )
+    pure_type = "Note"
+
+    reading_status = fields.CharField(
+        max_length=255, choices=ReadingStatusChoices.choices, null=True, blank=True
+    )
+
+    class Meta:
+        """not a real model, sorry"""
+
+        abstract = True
+
+
+class Comment(BookStatus):
+    """like a review but without a rating and transient"""
 
     # this is it's own field instead of a foreign key to the progress update
     # so that the update can be deleted without impacting the status
@@ -265,16 +284,12 @@ class Comment(Status):
         )
 
     activity_serializer = activitypub.Comment
-    pure_type = "Note"
 
 
-class Quotation(Status):
+class Quotation(BookStatus):
     """like a review but without a rating and transient"""
 
     quote = fields.HtmlField()
-    book = fields.ForeignKey(
-        "Edition", on_delete=models.PROTECT, activitypub_field="inReplyToBook"
-    )
 
     @property
     def pure_content(self):
@@ -289,16 +304,12 @@ class Quotation(Status):
         )
 
     activity_serializer = activitypub.Quotation
-    pure_type = "Note"
 
 
-class Review(Status):
+class Review(BookStatus):
     """a book review"""
 
     name = fields.CharField(max_length=255, null=True)
-    book = fields.ForeignKey(
-        "Edition", on_delete=models.PROTECT, activitypub_field="inReplyToBook"
-    )
     rating = fields.DecimalField(
         default=None,
         null=True,

bookwyrm/static/js/bookwyrm.js

@@ -138,8 +138,11 @@ let BookWyrm = new class {
      * @return {undefined}
      */
     toggleAction(event) {
-        event.preventDefault();
         let trigger = event.currentTarget;
+
+        if (!trigger.dataset.allowDefault || event.currentTarget == event.target) {
+            event.preventDefault();
+        }
         let pressed = trigger.getAttribute('aria-pressed') === 'false';
         let targetId = trigger.dataset.controls;
 
@@ -177,6 +180,13 @@ let BookWyrm = new class {
             this.toggleCheckbox(checkbox, pressed);
         }
 
+        // Toggle form disabled, if appropriate
+        let disable = trigger.dataset.disables;
+
+        if (disable) {
+            this.toggleDisabled(disable, !pressed);
+        }
+
         // Set focus, if appropriate.
         let focus = trigger.dataset.focusTarget;
 
@@ -227,6 +237,17 @@ let BookWyrm = new class {
         document.getElementById(checkbox).checked = !!pressed;
     }
 
+    /**
+     * Enable or disable a form element or fieldset
+     *
+     * @param  {string}  form_element - id of the element
+     * @param  {boolean} pressed  - Is the trigger pressed?
+     * @return {undefined}
+     */
+    toggleDisabled(form_element, pressed) {
+        document.getElementById(form_element).disabled = !!pressed;
+    }
+
     /**
      * Give the focus to an element.
      * Only move the focus based on user interactions.

bookwyrm/templates/reading_progress/finish.html

@@ -9,6 +9,6 @@ Finish "{{ book_title }}"
 
 {% block content %}
 
-{% include "snippets/shelve_button/finish_reading_modal.html" with book=book active=True %}
+{% include "snippets/reading_modals/finish_reading_modal.html" with book=book active=True %}
 
 {% endblock %}

bookwyrm/templates/reading_progress/start.html

@@ -9,6 +9,6 @@ Start "{{ book_title }}"
 
 {% block content %}
 
-{% include "snippets/shelve_button/start_reading_modal.html" with book=book active=True %}
+{% include "snippets/reading_modals/start_reading_modal.html" with book=book active=True %}
 
 {% endblock %}

bookwyrm/templates/reading_progress/want.html

@@ -9,6 +9,6 @@ Want to Read "{{ book_title }}"
 
 {% block content %}
 
-{% include "snippets/shelve_button/want_to_read_modal.html" with book=book active=True %}
+{% include "snippets/reading_modals/want_to_read_modal.html" with book=book active=True %}
 
 {% endblock %}

bookwyrm/templates/snippets/create_status/content_field.html

@@ -14,6 +14,6 @@ draft: an existing Status object that is providing default values for input fiel
     id="id_content_{{ type }}_{{ book.id }}{{ reply_parent.id }}"
     placeholder="{{ placeholder }}"
     aria-label="{% if reply_parent %}{% trans 'Reply' %}{% else %}{% trans 'Content' %}{% endif %}"
-    {% if type != "quotation" %}required{% endif %}
+    {% if not optional and type != "quotation" %}required{% endif %}
 >{% if reply_parent %}{{ reply_parent|mentions:request.user }}{% endif %}{% if mention %}@{{ mention|username }} {% endif %}{{ draft.content|default:'' }}</textarea>
 

bookwyrm/templates/snippets/reading_modals/finish_reading_modal.html

@@ -0,0 +1,36 @@
+{% extends 'snippets/reading_modals/layout.html' %}
+{% load i18n %}
+{% load utilities %}
+
+{% block modal-title %}
+{% blocktrans trimmed with book_title=book|book_title %}
+Finish "<em>{{ book_title }}</em>"
+{% endblocktrans %}
+{% endblock %}
+
+{% block modal-form-open %}
+<form name="finish-reading" action="{% url 'reading-status' 'finish' book.id %}" method="post">
+{% csrf_token %}
+<input type="hidden" name="reading_status" value="read">
+{% endblock %}
+
+{% block reading-dates %}
+<div class="columns">
+    <div class="column is-half">
+        <div class="field">
+            <label class="label" for="finish_id_start_date_{{ uuid }}">
+                {% trans "Started reading" %}
+            </label>
+            <input type="date" name="start_date" class="input" id="finish_id_start_date_{{ uuid }}" value="{{ readthrough.start_date | date:"Y-m-d" }}">
+        </div>
+    </div>
+    <div class="column is-half">
+        <div class="field">
+            <label class="label" for="id_finish_date_{{ uuid }}">
+                {% trans "Finished reading" %}
+            </label>
+            <input type="date" name="finish_date" class="input" id="id_finish_date_{{ uuid }}" value="{% now "Y-m-d" %}">
+        </div>
+    </div>
+</div>
+{% endblock %}

bookwyrm/templates/snippets/reading_modals/form.html

@@ -0,0 +1,15 @@
+{% extends "snippets/create_status/layout.html" %}
+{% load i18n %}
+
+{% block form_open %}{% endblock %}
+
+{% block content_label %}
+{% trans "Comment:" %}
+<span class="help mt-0 has-text-weight-normal">{% trans "(Optional)" %}</span>
+{% endblock %}
+
+{% block initial_fields %}
+<input type="hidden" name="user" value="{{ request.user.id }}">
+<input type="hidden" name="mention_books" value="{{ book.id }}">
+<input type="hidden" name="book" value="{{ book.id }}">
+{% endblock %}

bookwyrm/templates/snippets/reading_modals/layout.html

@@ -0,0 +1,28 @@
+{% extends 'components/modal.html' %}
+{% load i18n %}
+{% load utilities %}
+
+{% block modal-body %}
+
+{% block reading-dates %}{% endblock %}
+
+{% with 0|uuid as local_uuid %}
+<div class="is-flex is-justify-content-space-between">
+    <label for="post_status_{{ local_uuid }}_{{ uuid }}" data-controls="reading_content_{{ local_uuid }}_{{ uuid }}" data-controls-checkbox="post_status_{{ local_uuid }}_{{ uuid }}" data-disables="reading_content_fieldset_{{ local_uuid }}_{{ uuid }}" aria-pressed="true" data-allow-default="true">
+        <input type="checkbox" name="post-status" class="checkbox" id="post_status_{{ local_uuid }}_{{ uuid }}" checked>
+        {% trans "Post to feed" %}
+    </label>
+    <div class="is-hidden" id="hide_reading_content_{{ local_uuid }}_{{ uuid }}">
+        <button class="button is-link" type="submit">{% trans "Save" %}</button>
+    </div>
+</div>
+
+<div id="reading_content_{{ local_uuid }}_{{ uuid }}">
+    <hr aria-hidden="true">
+    <fieldset id="reading_content_fieldset_{{ local_uuid }}_{{ uuid }}">
+        {% include "snippets/reading_modals/form.html" with optional=True %}
+    </fieldset>
+</div>
+{% endwith %}
+
+{% endblock %}

bookwyrm/templates/snippets/reading_modals/start_reading_modal.html

@@ -0,0 +1,24 @@
+{% extends 'snippets/reading_modals/layout.html' %}
+{% load i18n %}
+{% load utilities %}
+
+{% block modal-title %}
+{% blocktrans trimmed with book_title=book|book_title %}
+Start "<em>{{ book_title }}</em>"
+{% endblocktrans %}
+{% endblock %}
+
+{% block modal-form-open %}
+<form name="start-reading" action="{% url 'reading-status' 'start' book.id %}" method="post">
+<input type="hidden" name="reading_status" value="reading">
+{% csrf_token %}
+{% endblock %}
+
+{% block reading-dates %}
+<div class="field">
+    <label class="label" for="start_id_start_date_{{ uuid }}">
+        {% trans "Started reading" %}
+    </label>
+    <input type="date" name="start_date" class="input" id="start_id_start_date_{{ uuid }}" value="{% now "Y-m-d" %}">
+</div>
+{% endblock %}

bookwyrm/templates/snippets/reading_modals/want_to_read_modal.html

@@ -0,0 +1,15 @@
+{% extends 'snippets/reading_modals/layout.html' %}
+{% load i18n %}
+{% load utilities %}
+
+{% block modal-title %}
+{% blocktrans trimmed with book_title=book|book_title %}
+Want to Read "<em>{{ book_title }}</em>"
+{% endblocktrans %}
+{% endblock %}
+
+{% block modal-form-open %}
+<form name="shelve" action="{% url 'reading-status' 'want' book.id %}" method="post">
+<input type="hidden" name="reading_status" value="to-read">
+{% csrf_token %}
+{% endblock %}

bookwyrm/templates/snippets/shelve_button/finish_reading_modal.html

@@ -1,48 +0,0 @@
-{% extends 'components/modal.html' %}
-{% load i18n %}
-
-{% block modal-title %}
-{% blocktrans with book_title=book.title %}Finish "<em>{{ book_title }}</em>"{% endblocktrans %}
-{% endblock %}
-
-
-{% block modal-form-open %}
-<form name="finish-reading" action="{% url 'reading-status' 'finish' book.id %}" method="post">
-{% endblock %}
-
-{% block modal-body %}
-<section class="modal-card-body">
-    {% csrf_token %}
-    <input type="hidden" name="id" value="{{ readthrough.id }}">
-    <div class="field">
-        <label class="label" for="finish_id_start_date-{{ uuid }}">
-            {% trans "Started reading" %}
-        </label>
-        <input type="date" name="start_date" class="input" id="finish_id_start_date-{{ uuid }}" value="{{ readthrough.start_date | date:"Y-m-d" }}">
-    </div>
-    <div class="field">
-        <label class="label" for="id_finish_date-{{ uuid }}">
-            {% trans "Finished reading" %}
-        </label>
-        <input type="date" name="finish_date" class="input" id="id_finish_date-{{ uuid }}" value="{% now "Y-m-d" %}">
-    </div>
-</section>
-{% endblock %}
-
-{% block modal-footer %}
-<div class="columns">
-    <div class="column field">
-        <label for="post_status-{{ uuid }}">
-            <input type="checkbox" name="post-status" class="checkbox" id="post_status-{{ uuid }}" checked>
-            {% trans "Post to feed" %}
-        </label>
-        {% include 'snippets/privacy_select.html' %}
-    </div>
-    <div class="column has-text-right">
-        <button type="submit" class="button is-success">{% trans "Save" %}</button>
-        {% trans "Cancel" as button_text %}
-        {% include 'snippets/toggle/close_button.html' with text=button_text controls_text="finish-reading" controls_uid=uuid %}
-    </div>
-</div>
-{% endblock %}
-{% block modal-form-close %}</form>{% endblock %}

bookwyrm/templates/snippets/shelve_button/shelve_button.html

@@ -19,13 +19,13 @@
     {% endif %}
 </div>
 
-{% include 'snippets/shelve_button/want_to_read_modal.html' with book=active_shelf.book controls_text="want_to_read" controls_uid=uuid %}
+{% include 'snippets/reading_modals/want_to_read_modal.html' with book=active_shelf.book controls_text="want_to_read" controls_uid=uuid %}
 
-{% include 'snippets/shelve_button/start_reading_modal.html' with book=active_shelf.book controls_text="start_reading" controls_uid=uuid %}
+{% include 'snippets/reading_modals/start_reading_modal.html' with book=active_shelf.book controls_text="start_reading" controls_uid=uuid %}
 
-{% include 'snippets/shelve_button/finish_reading_modal.html' with book=active_shelf.book controls_text="finish_reading" controls_uid=uuid readthrough=readthrough %}
+{% include 'snippets/reading_modals/finish_reading_modal.html' with book=active_shelf.book controls_text="finish_reading" controls_uid=uuid readthrough=readthrough %}
 
-{% include 'snippets/shelve_button/progress_update_modal.html' with book=active_shelf_book.book controls_text="progress_update" controls_uid=uuid readthrough=readthrough %}
+{% include 'snippets/reading_modals/progress_update_modal.html' with book=active_shelf_book.book controls_text="progress_update" controls_uid=uuid readthrough=readthrough %}
 
 {% endwith %}
 {% endif %}

bookwyrm/templates/snippets/shelve_button/start_reading_modal.html

@@ -1,42 +0,0 @@
-{% extends 'components/modal.html' %}
-{% load i18n %}
-
-{% block modal-title %}
-{% blocktrans trimmed with book_title=book.title %}
-Start "<em>{{ book_title }}</em>"
-{% endblocktrans %}
-{% endblock %}
-
-{% block modal-form-open %}
-<form name="start-reading" action="{% url 'reading-status' 'start' book.id %}" method="post">
-{% endblock %}
-
-{% block modal-body %}
-<section class="modal-card-body">
-    {% csrf_token %}
-    <div class="field">
-        <label class="label" for="start_id_start_date-{{ uuid }}">
-            {% trans "Started reading" %}
-        </label>
-        <input type="date" name="start_date" class="input" id="start_id_start_date-{{ uuid }}" value="{% now "Y-m-d" %}">
-    </div>
-</section>
-{% endblock %}
-
-{% block modal-footer %}
-<div class="columns">
-    <div class="column field">
-        <label for="post_status_start-{{ uuid }}">
-            <input type="checkbox" name="post-status" class="checkbox" id="post_status_start-{{ uuid }}" checked>
-            {% trans "Post to feed" %}
-        </label>
-        {% include 'snippets/privacy_select.html' %}
-    </div>
-    <div class="column has-text-right">
-        <button class="button is-success" type="submit">{% trans "Save" %}</button>
-        {% trans "Cancel" as button_text %}
-        {% include 'snippets/toggle/toggle_button.html' with text=button_text controls_text="start-reading" controls_uid=uuid %}
-    </div>
-</div>
-{% endblock %}
-{% block modal-form-close %}</form>{% endblock %}

bookwyrm/templates/snippets/shelve_button/want_to_read_modal.html

@@ -1,33 +0,0 @@
-{% extends 'components/modal.html' %}
-{% load i18n %}
-
-{% block modal-title %}
-{% blocktrans with book_title=book.title %}Want to Read "<em>{{ book_title }}</em>"{% endblocktrans %}
-{% endblock %}
-
-{% block modal-form-open %}
-<form name="shelve" action="{% url 'reading-status' 'want' book.id %}" method="post">
-    {% csrf_token %}
-    <input type="hidden" name="book" value="{{ active_shelf.book.id }}">
-    <input type="hidden" name="shelf" value="to-read">
-{% endblock %}
-
-{% block modal-footer %}
-<div class="columns">
-    <div class="column field">
-        <label for="post_status_want-{{ uuid }}">
-            <input type="checkbox" name="post-status" class="checkbox" id="post_status_want-{{ uuid }}" checked>
-            {% trans "Post to feed" %}
-        </label>
-        {% include 'snippets/privacy_select.html' %}
-    </div>
-    <div class="column">
-        <button class="button is-success" type="submit">
-            <span>{% trans "Want to read" %}</span>
-        </button>
-        {% trans "Cancel" as button_text %}
-        {% include 'snippets/toggle/toggle_button.html' with text=button_text controls_text="want-to-read" controls_uid=uuid %}
-    </div>
-</div>
-{% endblock %}
-{% block modal-form-close %}</form>{% endblock %}

bookwyrm/templates/snippets/status/headers/read.html

@@ -1,7 +1,8 @@
 {% spaceless %}
-{% load i18n %}{% load utilities %}
+{% load i18n %}
+{% load utilities %}
+{% load status_display %}
 
-{% with book=status.mention_books.first %}
+{% load_book status as book %}
 {% blocktrans with book_path=book.remote_id book=book|book_title %}finished reading <a href="{{ book_path }}">{{ book }}</a>{% endblocktrans %}
-{% endwith %}
 {% endspaceless %}

bookwyrm/templates/snippets/status/headers/reading.html

@@ -1,9 +1,8 @@
 {% spaceless %}
 {% load i18n %}
 {% load utilities %}
+{% load status_display %}
 
-{% with book=status.mention_books.first %}
+{% load_book status as book %}
 {% blocktrans with book_path=book.remote_id book=book|book_title %}started reading <a href="{{ book_path }}">{{ book }}</a>{% endblocktrans %}
-{% endwith %}
-
 {% endspaceless %}

bookwyrm/templates/snippets/status/headers/to_read.html

@@ -1,8 +1,8 @@
 {% spaceless %}
 {% load i18n %}
 {% load utilities %}
+{% load status_display %}
 
-{% with book=status.mention_books.first %}
+{% load_book status as book %}
 {% blocktrans with book_path=book.remote_id book=book|book_title %}<a href="{{ user_path }}">{{ username }}</a> wants to read <a href="{{ book_path }}">{{ book }}</a>{% endblocktrans %}
-{% endwith %}
 {% endspaceless %}

bookwyrm/templatetags/status_display.py

@@ -70,7 +70,13 @@ def get_header_template(status):
     """get the path for the status template"""
     if isinstance(status, models.Boost):
         status = status.boosted_status
-    filename = "snippets/status/headers/{:s}.html".format(status.status_type.lower())
+    try:
+        header_type = status.reading_status
+        if not header_type:
+            raise AttributeError()
+    except AttributeError:
+        header_type = status.status_type.lower()
+    filename = f"snippets/status/headers/{header_type}.html"
     header_template = select_template([filename, "snippets/status/headers/note.html"])
     return header_template.render({"status": status})
 

bookwyrm/tests/views/inbox/test_inbox_create.py

@@ -77,6 +77,33 @@ class InboxCreate(TestCase):
         views.inbox.activity_task(activity)
         self.assertEqual(models.Status.objects.count(), 1)
 
+    @patch("bookwyrm.activitystreams.ActivityStream.add_status")
+    def test_create_comment_with_reading_status(self, *_):
+        """the "it justs works" mode"""
+        datafile = pathlib.Path(__file__).parent.joinpath("../../data/ap_comment.json")
+        status_data = json.loads(datafile.read_bytes())
+        status_data["readingStatus"] = "to-read"
+
+        models.Edition.objects.create(
+            title="Test Book", remote_id="https://example.com/book/1"
+        )
+        activity = self.create_json
+        activity["object"] = status_data
+
+        with patch("bookwyrm.activitystreams.ActivityStream.add_status") as redis_mock:
+            views.inbox.activity_task(activity)
+            self.assertTrue(redis_mock.called)
+
+        status = models.Comment.objects.get()
+        self.assertEqual(status.remote_id, "https://example.com/user/mouse/comment/6")
+        self.assertEqual(status.content, "commentary")
+        self.assertEqual(status.reading_status, "to-read")
+        self.assertEqual(status.user, self.local_user)
+
+        # while we're here, lets ensure we avoid dupes
+        views.inbox.activity_task(activity)
+        self.assertEqual(models.Status.objects.count(), 1)
+
     def test_create_status_remote_note_with_mention(self, _):
         """should only create it under the right circumstances"""
         self.assertFalse(

bookwyrm/views/reading.py

@@ -12,7 +12,7 @@ from django.utils.decorators import method_decorator
 from django.views import View
 from django.views.decorators.http import require_POST
 
-from bookwyrm import models
+from bookwyrm import forms, models
 from .helpers import get_edition, handle_reading_status
 
 
@@ -76,8 +76,17 @@ class ReadingStatus(View):
 
         # post about it (if you want)
         if request.POST.get("post-status"):
-            privacy = request.POST.get("privacy")
-            handle_reading_status(request.user, desired_shelf, book, privacy)
+            # is it a comment?
+            if request.POST.get("content"):
+                form = forms.CommentForm(request.POST)
+                if form.is_valid():
+                    form.save()
+                else:
+                    # uh oh
+                    raise Exception(form.errors)
+            else:
+                privacy = request.POST.get("privacy")
+                handle_reading_status(request.user, desired_shelf, book, privacy)
 
         return redirect(request.headers.get("Referer", "/"))