From 6b23b03a822c47e8424c076935e012bb6f944dd2 Mon Sep 17 00:00:00 2001
From: Klaas van Schelven <klaas@vanschelven.com>
Date: Mon, 15 Apr 2024 13:44:14 +0200
Subject: [PATCH] History: edit (and fixes)

---
 issues/forms.py                      | 11 ++++++++
 issues/templates/issues/history.html | 38 ++++++++++++++++++----------
 issues/urls.py                       |  2 +-
 issues/views.py                      | 30 ++++++++++------------
 static/js/issue_history.js           |  7 +++++
 theme/static/css/dist/styles.css     | 25 ++++++++++++++++++
 6 files changed, 82 insertions(+), 31 deletions(-)
 create mode 100644 issues/forms.py
 create mode 100644 static/js/issue_history.js

diff --git a/issues/forms.py b/issues/forms.py
new file mode 100644
index 0000000..2eca153
--- /dev/null
+++ b/issues/forms.py
@@ -0,0 +1,11 @@
+from django.forms import ModelForm
+
+from .models import TurningPoint
+
+
+class CommentForm(ModelForm):
+    # note that we use about 5% of ModelForm functionality here... but "if it ain't broke don't fix it" :-)
+
+    class Meta:
+        model = TurningPoint
+        fields = ['comment']
diff --git a/issues/templates/issues/history.html b/issues/templates/issues/history.html
index e5cf724..fb2e21e 100644
--- a/issues/templates/issues/history.html
+++ b/issues/templates/issues/history.html
@@ -28,14 +28,14 @@
             </div>
 
             <div class="border-t-2 pl-4 pr-4 pb-4 border-slate-300">{# 'body' part of the balloon (separated by a line) #}
-                <form action="{% url "history_comment_new" issue_pk=issue.id %}" method="post">
                 {% csrf_token %}
                     <div class="mt-4">
-                    <textarea name="comment" placeholder="comments..." class="focus:border-cyan-500 focus:ring-cyan-200 rounded-md w-full"></textarea>
-                    </div>
+                    <form action="{% url "history_comment_new" issue_pk=issue.id %}" method="post">
+                    <textarea name="comment" placeholder="comments..." class="focus:border-cyan-500 focus:ring-cyan-200 rounded-md w-full h-32"></textarea>
                     <button class="font-bold text-slate-800 border-slate-500 pl-4 pr-4 pb-2 pt-2 mt-2 border-2 rounded-md hover:bg-slate-200 active:ring">Post comment</button>
+                    </form>
+                    </div>
                 </div>{# 'body' part of the balloon #}
-                </form>
         </div><!-- the "balloon" -->
     </div><!-- single turningpoint -->
 
@@ -52,7 +52,7 @@
             </div>
         </div>
 
-        <div class="border-slate-300 border-2 rounded-md mt-6 flex-auto"><!-- the "balloon" -->
+        <div class="border-slate-300 border-2 rounded-md mt-6 flex-auto js-balloon"><!-- the "balloon" -->
             <div class="pl-4 flex triangle-left"><!-- 'header' row -->
                 <div class="mt-4 mb-4">
                     <span class="font-bold text-slate-800">{{ turningpoint.get_kind_display }}</span> by
@@ -61,7 +61,7 @@
             
                 <div class="ml-auto flex"> <!-- 'header' row right side -->
                     {% if turningpoint.user == request.user %}
-                    <div class="border-l-2 p-4 text-slate-800">
+                    <div class="border-l-2 p-4 text-slate-800" onclick="makeCommentEditable(this)">
                         <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6">
   <path stroke-linecap="round" stroke-linejoin="round" d="m16.862 4.487 1.687-1.688a1.875 1.875 0 1 1 2.652 2.652L10.582 16.07a4.5 4.5 0 0 1-1.897 1.13L6 18l.8-2.685a4.5 4.5 0 0 1 1.13-1.897l8.932-8.931Zm0 0L19.5 7.125M18 14v4.75A2.25 2.25 0 0 1 15.75 21H5.25A2.25 2.25 0 0 1 3 18.75V8.25A2.25 2.25 0 0 1 5.25 6H10" />
 </svg>
@@ -74,17 +74,23 @@
                 </div>
             </div>
 
-            {% if turningpoint.comment or turningpoint.parsed_metadata or turningpoint.triggering_event %}
+            {% if turningpoint.parsed_metadata or turningpoint.triggering_event or turningpoint.comment or turningpoint.user == request.user %}  {# the last clause means: editable, hence space must be reserved #}
             <div class="border-t-2 pl-4 pr-4 pb-4 border-slate-300">{# 'body' part of the balloon (separated by a line) #}
-                {% if turningpoint.comment %}
                     <div class="mt-4">
-                    {{ turningpoint.comment|linebreaksbr }}
-                    {% comment %}
-                    <textarea name="search" placeholder="comments..." class="focus:border-cyan-500 focus:ring-cyan-200 rounded-md w-full"></textarea>
-                    <button class="font-bold text-slate-800 border-slate-500 pl-4 pr-4 pb-2 pt-2 mt-2 border-2 rounded-md hover:bg-slate-200 active:ring">Post comment</button>
-                    {% endcomment %}
+                        <div class="js-comment-plain">
+                        {{ turningpoint.comment|linebreaksbr }}
+                        </div>
+
+                        {% if turningpoint.user == request.user %}
+                        <div class="js-comment-editable hidden">
+                            <form action="{% url "history_comment_edit" issue_pk=issue.id comment_pk=turningpoint.pk %}" method="post">
+                            {% csrf_token %}
+                            <textarea name="comment" placeholder="comments..." class="focus:border-cyan-500 focus:ring-cyan-200 rounded-md w-full h-32">{{ turningpoint.comment }}</textarea>{# note: we don't actually use {{ form.comments }} here; this means the show-red-on-invalid loop won't work but since everything is valid and we haven't implemented the other parts of that loop that's fine #}
+                            <button class="font-bold text-slate-800 border-slate-500 pl-4 pr-4 pb-2 pt-2 mt-2 border-2 rounded-md hover:bg-slate-200 active:ring">Update comment</button>
+                            </form>
+                        </div>
+                        {% endif %}
                     </div>
-                {% endif %}
 
                 {% if turningpoint.parsed_metadata %}
                 <div class="mt-4">
@@ -143,3 +149,7 @@
 
 
 {% endblock %}
+
+{% block extra_js %}
+    <script src="{% static 'js/issue_history.js' %}"></script>
+{% endblock %}
diff --git a/issues/urls.py b/issues/urls.py
index d3c25d3..8294f8d 100644
--- a/issues/urls.py
+++ b/issues/urls.py
@@ -28,5 +28,5 @@ urlpatterns = [
 
     path('event/<uuid:event_pk>/', event_by_internal_id, name="event_by_internal_id"),
     path('issue/<uuid:issue_pk>/history/comment/', history_comment_new, name="history_comment_new"),
-    path('event/<uuid:event_pk>/history/comment/<int:comment_id>/', history_comment_edit, name="history_comment_edit"),
+    path('issue/<uuid:issue_pk>/history/comment/<int:comment_pk>/', history_comment_edit, name="history_comment_edit"),
 ]
diff --git a/issues/views.py b/issues/views.py
index 5ff0cba..5195088 100644
--- a/issues/views.py
+++ b/issues/views.py
@@ -415,31 +415,29 @@ def issue_event_list(request, issue):
 
 @issue_membership_required
 def history_comment_new(request, issue):
-    # TODO something with auth
 
     if request.method == "POST":
         form = CommentForm(request.POST)
-        if form.is_valid():
-            TurningPoint.objects.create(
-                issue=issue, kind=TurningPointKind.MANUAL_ANNOTATION, user=request.user,
-                comment=form.cleaned_data["comment"],
-                timestamp=timezone.now())
+        assert form.is_valid()  # we have only a textfield with no validation properties; also: no html-side handling
+
+        TurningPoint.objects.create(
+            issue=issue, kind=TurningPointKind.MANUAL_ANNOTATION, user=request.user,
+            comment=form.cleaned_data["comment"],
+            timestamp=timezone.now())
+
         return redirect(issue_history, issue_pk=issue.pk)
 
     raise HttpResponseNotAllowed()
 
 
-def history_comment_edit(request, issue_pk):
-    # TODO something with auth
+@issue_membership_required
+def history_comment_edit(request, issue, comment_pk):
+    comment = get_object_or_404(TurningPoint, pk=comment_pk, issue_id=issue.pk)
 
-    event = get_object_or_404(Event, id=event_pk)
     if request.method == "POST":
-        form = CommentForm(request.POST)
-        if form.is_valid():
-            TurningPoint.objects.create(
-                issue=event.issue, kind=TurningPointKind.COMMENT, user=request.user,
-                comment=form.cleaned_data["comment"],
-                timestamp=timezone.now())
-        return redirect(issue_event_stacktrace, issue_pk=event.issue.pk)
+        form = CommentForm(request.POST, instance=comment)
+        assert form.is_valid()
+        form.save()
+        return redirect(issue_history, issue_pk=issue.pk)
 
     raise HttpResponseNotAllowed()
diff --git a/static/js/issue_history.js b/static/js/issue_history.js
new file mode 100644
index 0000000..6a96b91
--- /dev/null
+++ b/static/js/issue_history.js
@@ -0,0 +1,7 @@
+"use strict";
+
+function makeCommentEditable(element) {
+    const balloon = element.closest(".js-balloon");
+    balloon.querySelector(".js-comment-editable").classList.remove("hidden");
+    balloon.querySelector(".js-comment-plain").classList.add("hidden");
+}
diff --git a/theme/static/css/dist/styles.css b/theme/static/css/dist/styles.css
index 6d23f47..aced45e 100644
--- a/theme/static/css/dist/styles.css
+++ b/theme/static/css/dist/styles.css
@@ -938,6 +938,31 @@ select {
   height: 1rem;
 }
 
+.h-16 {
+  height: 4rem;
+}
+
+.h-24 {
+  height: 6rem;
+}
+
+.h-fit {
+  height: -moz-fit-content;
+  height: fit-content;
+}
+
+.h-32 {
+  height: 8rem;
+}
+
+.h-64 {
+  height: 16rem;
+}
+
+.h-48 {
+  height: 12rem;
+}
+
 .w-1\/4 {
   width: 25%;
 }