Prototype: use partials

core/static/bundled/base-bundle-index.ts

@@ -7,7 +7,7 @@
  */
 
 // Must be loaded before Apline
-import htmx from "htmx.org";
+import htmx, { HtmxResponse } from "htmx.org";
 import "htmx.org/dist/ext/hx-alpine-compat.js";
 import "htmx.org/dist/ext/hx-prompt.js";
 import "htmx.org/dist/ext/hx-download.js";
@@ -48,19 +48,13 @@ polyfillCountryFlagEmojis();
 /**
  * HTMX
  */
-document.body.addEventListener(
+document.body.addEventListener("htmx:before:request", (event) => {
-  "htmx:before:request" as keyof HTMLElementEventMap,
+  event.target.ariaBusy = true;
-  (event) => {
+});
-    (event as CustomEvent).detail.ctx.target.ariaBusy = true;
-  },
-);
 
-document.body.addEventListener(
+document.body.addEventListener("htmx:before:swap", (event) => {
-  "htmx:before:swap" as keyof HTMLElementEventMap,
+  event.target.ariaBusy = null;
-  (event) => {
+});
-    (event as CustomEvent).detail.ctx.target.ariaBusy = null;
-  },
-);
 
 Object.assign(window, { htmx });
 

core/views/user.py

@@ -473,7 +473,7 @@ class UserClubView(UserTabsMixin, CanViewMixin, DetailView):
 class UserVisibilityFormFragment(FragmentMixin, SuccessMessageMixin, UpdateView):
     model = User
     form_class = UserVisibilityForm
-    template_name = "core/fragment/user_visibility.jinja"
+    template_name = "core/fragments/user_visibility.jinja"
     pk_url_kwarg = "user_id"
 
     def get_form_kwargs(self):

pedagogy/models.py

@@ -126,7 +126,11 @@ class UE(models.Model):
         Returns:
             True if the user has already posted a comment on this UE, else False.
         """
-        return self.comments.filter(author=user).exists()
+        self._has_user_commented = getattr(self, "_has_user_commented", {})
+        self._has_user_commented[user] = self._has_user_commented.get(
+            user, self.comments.filter(author=user).exists()
+        )
+        return self._has_user_commented[user]
 
     @cached_property
     def grade_global_average(self):

pedagogy/static/pedagogy/css/pedagogy.scss

@@ -128,14 +128,14 @@ $pedagogy-white-text: #f0f0f0;
       grid-area: hours-the;
     }
 
-    #leave_comment_not_allowed {
+    .leave-comment-not-allowed {
       p {
         text-align: center;
         color: red;
       }
     }
 
-    #leave_comment {
+    .leave-comment {
       .leave-comment-grid-container {
         display: grid;
         grid-template-columns: 270px auto;
@@ -168,10 +168,6 @@ $pedagogy-white-text: #f0f0f0;
       .input-stars {
         margin-top: 20px;
       }
-
-      input[type="submit"] {
-        float: right;
-      }
     }
 
     .ue-details-container {
@@ -333,8 +329,9 @@ $pedagogy-white-text: #f0f0f0;
           padding-left: 10px;
         }
 
-        .actions {
+        .action {
           float: right;
+          margin-top: 0;
         }
       }
 
@@ -443,4 +440,9 @@ details.accordion>.accordion-content {
   background-color: $white-color;
   border-color: $pedagogy-orange;
   border-right: none;
+}
+
+.right {
+  display: flex;
+  justify-content: flex-end;
 }

pedagogy/templates/pedagogy/fragments/comment_report.jinja

@@ -0,0 +1,30 @@
+<form
+  hx-post="{{ request.get_full_path() }}"
+  hx-ext="error-callbacks"
+  hx-target="this"
+  hx-swap="outerHTML"
+  hx-disabled-elt="input[type='submit']"
+  hx-trigger="submit"
+  hx-callback-404="target.remove()"
+>
+  {% csrf_token %}
+  {{ form.non_field_errors() }}
+  {{ form.reason.errors }}
+  {{ form.reason }}
+
+  {# Hidden fields #}
+  {{ form.reporter }}
+  {{ form.comment }}
+
+  <button
+    hx-get="{{ url('pedagogy:comment_detail', comment_id=comment_id) }}"
+    hx-target="closest form"
+    hx-swap="outerHTML"
+  >
+    {% trans %}Cancel{% endtrans %}
+  </button>
+
+  <p class="right" id="nique">
+    <input type="submit" value="{% trans %}Report{% endtrans %}" />
+  </p>
+</form>

pedagogy/templates/pedagogy/fragments/ue_comment.jinja

@@ -0,0 +1,83 @@
+{% from "pedagogy/macros.jinja" import display_star %}
+{% from "core/macros.jinja" import user_profile_link %}
+
+<div id="comment-{{ comment.id }}" class="comment-container">
+
+  <div class="grade-block">
+    <div class="grade-type">
+      <p>{% trans %}Global grade{% endtrans %}</p>
+      <p>{% trans %}Utility{% endtrans %}</p>
+      <p>{% trans %}Interest{% endtrans %}</p>
+      <p>{% trans %}Teaching{% endtrans %}</p>
+      <p>{% trans %}Work load{% endtrans %}</p>
+    </div>
+    <div class="grade-stars">
+      <p>{{ display_star(comment.grade_global) }}</p>
+      <p>{{ display_star(comment.grade_utility) }}</p>
+      <p>{{ display_star(comment.grade_interest) }}</p>
+      <p>{{ display_star(comment.grade_teaching) }}</p>
+      <p>{{ display_star(comment.grade_work_load) }}</p>
+    </div>
+    <div class="grade-extension"></div>
+  </div>
+
+  <div class="comment">
+    <div class="anchor">
+      <a href="{{ url('pedagogy:ue_detail', ue_id=ue.id) }}#comment-{{ comment.id }}"><i class="fa fa-paragraph"></i></a>
+    </div>
+    {{ comment.comment|markdown }}
+  </div>
+
+  <div class="info">
+    {% if comment.is_reported %}
+      <p class="status-reported">
+        {% trans %}This comment has been reported{% endtrans %}
+      </p>
+    {% endif %}
+
+    {% if comment.author_id == user.id or user.has_perm("pedagogy.change_comment") %}
+      <button
+        class="btn btn-orange action"
+        hx-get="{{ url('pedagogy:comment_update', comment_id=comment.id) }}"
+        hx-swap="outerHTML"
+        hx-target="#comment-{{ comment.id }}"
+      >
+        <i class="fa fa-pencil"></i> {% trans %}Edit{% endtrans %}
+      </button>
+    {% endif %}
+    {% if comment.author_id == user.id or user.has_perm("pedagogy.delete_comment") %}
+      <form class="action"
+            hx-ext="error-callbacks"
+            hx-post="{{ url('pedagogy:comment_delete', comment_id=comment.id) }}"
+            hx-confirm='{% trans obj=object %}Are you sure you want to delete "{{ obj }}"?{% endtrans %}'
+            hx-swap="outerHTML"
+            hx-target="#comment-{{ comment.id }}"
+            hx-callback-404="document.getElementsByTagName('body')[0].dispatchEvent(new CustomEvent('CommentUpdate'));target.remove()"
+      >
+        {% csrf_token %}
+        <button class="btn btn-red action">
+          <i class="fa fa-trash-can"></i> {% trans %}Delete{% endtrans %}
+        </button>
+      </form>
+    {% endif %}
+  </div>
+
+  <div class="comment-end-bar">
+    <div class="report">
+      <p>
+        <a
+          hx-get="{{ url('pedagogy:comment_report', comment_id=comment.id) }}"
+          hx-swap="outerHTML"
+          hx-target="#comment-{{ comment.id }}"
+        >
+          {% trans %}Report this comment{% endtrans %}
+        </a>
+      </p>
+    </div>
+
+    <div class="date"><p>{{ comment.publish_date.strftime('%d/%m/%Y') }}</p></div>
+
+    <div class="author"><p>{{ user_profile_link(comment.author) }}</p></div>
+  </div>
+
+</div>

pedagogy/templates/pedagogy/fragments/ue_comment_form.jinja

@@ -0,0 +1,71 @@
+<div class="leave-comment">
+  {% if form.is_creation %}
+    <details class="accordion" id="leave_comment" {% if form.errors %}open{% endif %}>
+      <summary>{% trans %}Leave comment{% endtrans %}</summary>
+      <div class="accordion-content">
+  {% endif %}
+  <form
+    hx-post="{{ action }}"
+    hx-target="closest .leave-comment"
+    hx-swap="outerHTML"
+    hx-disabled-elt="find input[type='submit']"
+  >
+    {% csrf_token %}
+    <div class="leave-comment-grid-container">
+      <div class="form-stars">
+        {{ form.non_field_errors() }}
+        {{ form.author.errors }}
+        {{ form.ue.errors }}
+
+        {{ form.author }}
+        {{ form.ue }}
+
+        <div class="input-stars">
+          <label for="{{ form.grade_global.id_for_label }}">{{ form.grade_global.label }} :</label>
+          {{ form.grade_global.errors }}
+          {{ form.grade_global }}
+        </div>
+
+        <div class="input-stars">
+          <label for="{{ form.grade_utility.id_for_label }}">{{ form.grade_utility.label }} :</label>
+          {{ form.grade_utility.errors }}
+          {{ form.grade_utility }}
+        </div>
+
+        <div class="input-stars">
+          <label for="{{ form.grade_interest.id_for_label }}">{{ form.grade_interest.label }} :</label>
+          {{ form.grade_interest.errors }}
+          {{ form.grade_interest }}
+        </div>
+
+        <div class="input-stars">
+          <label for="{{ form.grade_teaching.id_for_label }}">{{ form.grade_teaching.label }} :</label>
+          {{ form.grade_teaching.errors }}
+          {{ form.grade_teaching }}
+        </div>
+
+        <div class="input-stars">
+          <label for="{{ form.grade_work_load.id_for_label }}">{{ form.grade_work_load.label }} :</label>
+          {{ form.grade_work_load.errors }}
+          {{ form.grade_work_load }}
+        </div>
+      </div>
+      <div class="form-comment">
+        <label for="{{ form.comment.id_for_label }}">{{ form.comment.label }} :</label>
+        {{ form.comment.errors }}
+        {{ form.comment }}
+      </div>
+    </div>
+    <p class="right">
+      <input type="submit" value="{% trans %}Comment{% endtrans %}" />
+    </p>
+  </form>
+
+  {% if form.is_creation %}
+    </div>
+    </details>
+  {% endif %}
+
+  <br>
+
+</div>

pedagogy/templates/pedagogy/fragments/ue_details/comments.jinja

@@ -0,0 +1,10 @@
+{% if comments %}
+  <h2>{% trans %}Comments{% endtrans %}</h2>
+  <br>
+{% endif %}
+
+<section>
+  {% for comment in comments %}
+    {% include "pedagogy/fragments/ue_comment.jinja" %}
+  {% endfor %}
+</section>

pedagogy/templates/pedagogy/fragments/ue_details/form.jinja

@@ -0,0 +1,10 @@
+{% if object.has_user_already_commented(user) %}
+  <div class="leave-comment-not-allowed">
+    <p>{% trans %}You already posted a comment on this UE. If you want to comment again, please modify or delete your previous comment.{% endtrans %}</p>
+  </div>
+  <br>
+{% endif %}
+
+{% if not object.has_user_already_commented(user) and user.has_perm("pedagogy.add_uecomment") %}
+  {{ add_comment_form }}
+{% endif %}

pedagogy/templates/pedagogy/fragments/ue_details/grade.jinja

@@ -0,0 +1,27 @@
+<div class="ue-details-container">
+  <div class="grade">
+    <p>{% trans %}Global grade{% endtrans %}</p>
+    <p>{% trans %}Utility{% endtrans %}</p>
+    <p>{% trans %}Interest{% endtrans %}</p>
+    <p>{% trans %}Teaching{% endtrans %}</p>
+    <p>{% trans %}Work load{% endtrans %}</p>
+  </div>
+  <div class="grade-stars">
+    <p>{{ display_star(object.grade_global_average) }}</p>
+    <p>{{ display_star(object.grade_utility_average) }}</p>
+    <p>{{ display_star(object.grade_interest_average) }}</p>
+    <p>{{ display_star(object.grade_teaching_average) }}</p>
+    <p>{{ display_star(object.grade_work_load_average) }}</p>
+  </div>
+  <div class="ue-infos">
+    <p><b>{% trans %}Objectives{% endtrans %}</b></p>
+    <p>{{ object.objectives|markdown }}</p>
+    <p><b>{% trans %}Program{% endtrans %}</b></p>
+    <p>{{ object.program|markdown }}</p>
+    <p><b>{% trans %}Earned skills{% endtrans %}</b></p>
+    <p>{{ object.skills|markdown }}</p>
+    <p><b>{% trans %}Key concepts{% endtrans %}</b></p>
+    <p>{{ object.key_concepts|markdown }}</p>
+    <p><b>{% trans %}UE manager: {% endtrans %}</b>{{ object.manager }}</p>
+  </div>
+</div>

pedagogy/templates/pedagogy/macros.jinja

@@ -13,4 +13,4 @@
     <span class="grade-text"> {% trans %} not rated {% endtrans %} </span>
   {% endif %}
 
-{%- endmacro %}
+{%- endmacro %}

pedagogy/templates/pedagogy/ue_detail.jinja

@@ -1,220 +1,93 @@
-{% extends "core/base.jinja" %}
-{% from "core/macros.jinja" import user_profile_link %}
 {% from "pedagogy/macros.jinja" import display_star %}
 
-{% block additional_css %}
+{% if is_fragment %}
-  <link rel="stylesheet" href="{{ static('pedagogy/css/pedagogy.scss') }}">
-{% endblock %}
 
-{% block title %}
+  <hx-partial id="ue-grade">
-  {% trans %}UE Details{% endtrans %}
+    {% include "pedagogy/fragments/ue_details/grade.jinja" %}
-{% endblock %}
+  </hx-partial>
 
-{% block content %}
+  <hx-partial id="comment-form">
-  <div class="pedagogy">
+    {% include "pedagogy/fragments/ue_details/form.jinja" %}
-    <div id="ue_detail">
+  </hx-partial>
-      <button onclick='(function(){
-                       // If comes from the guide page, go back with history
-                       if (document.referrer.replace(/\?(.+)/gm,"").endsWith(`{{ url("pedagogy:guide") }}`)){
-                       window.history.back();
-                       return;
-                       }
-                       // Simply goes to the guide page
-                       window.location.href = `{{ url("pedagogy:guide") }}`;
-                       })()' hidden>{% trans %}Back{% endtrans %}</button>
 
-      <h1>{{ object.code }} - {{ object.title }}</h1>
+  <hx-partial id="comments" hx-swap="innerMorph">
-      <br>
+    {% include "pedagogy/fragments/ue_details/comments.jinja" %}
-      <div class="ue-quick-info-container">
+  </hx-partial>
-        <div class="hours-cm">
-          <b>{% trans %}CM: {% endtrans %}</b>{{ object.hours_CM }}
-        </div>
-        <div class="hours-td">
-          <b>{% trans %}TD: {% endtrans %}</b>{{ object.hours_TD }}
-        </div>
-        <div class="hours-tp">
-          <b>{% trans %}TP: {% endtrans %}</b>{{ object.hours_TP }}
-        </div>
-        <div class="hours-te">
-          <b>{% trans %}TE: {% endtrans %}</b>{{ object.hours_TE }}
-        </div>
-        <div class="hours-the">
-          <b>{% trans %}THE: {% endtrans %}</b>{{ object.hours_THE }}
-        </div>
 
-        <div class="department">
+{% else %}
-          {{ object.department }}
+  {% extends "core/base.jinja" %}
-        </div>
-        <div class="credit-type">
-          {{ object.credit_type }}
-        </div>
-        <div class="semester">
-          {{ object.get_semester_display() }}
-        </div>
-      </div>
 
-      <br>
+  {% block additional_css %}
+    <link rel="stylesheet" href="{{ static('pedagogy/css/pedagogy.scss') }}">
+  {% endblock %}
 
-      <div class="ue-details-container">
+  {% block title %}
-        <div class="grade">
+    {% trans %}UE Details{% endtrans %}
-          <p>{% trans %}Global grade{% endtrans %}</p>
+  {% endblock %}
-          <p>{% trans %}Utility{% endtrans %}</p>
-          <p>{% trans %}Interest{% endtrans %}</p>
-          <p>{% trans %}Teaching{% endtrans %}</p>
-          <p>{% trans %}Work load{% endtrans %}</p>
-        </div>
-        <div class="grade-stars">
-          <p>{{ display_star(object.grade_global_average) }}</p>
-          <p>{{ display_star(object.grade_utility_average) }}</p>
-          <p>{{ display_star(object.grade_interest_average) }}</p>
-          <p>{{ display_star(object.grade_teaching_average) }}</p>
-          <p>{{ display_star(object.grade_work_load_average) }}</p>
-        </div>
-        <div class="ue-infos">
-          <p><b>{% trans %}Objectives{% endtrans %}</b></p>
-          <p>{{ object.objectives|markdown }}</p>
-          <p><b>{% trans %}Program{% endtrans %}</b></p>
-          <p>{{ object.program|markdown }}</p>
-          <p><b>{% trans %}Earned skills{% endtrans %}</b></p>
-          <p>{{ object.skills|markdown }}</p>
-          <p><b>{% trans %}Key concepts{% endtrans %}</b></p>
-          <p>{{ object.key_concepts|markdown }}</p>
-          <p><b>{% trans %}UE manager: {% endtrans %}</b>{{ object.manager }}</p>
-        </div>
-      </div>
 
-      <br>
+  {% block content %}
-      {% if object.has_user_already_commented(user) %}
-        <div id="leave_comment_not_allowed">
-          <p>{% trans %}You already posted a comment on this UE. If you want to comment again, please modify or delete your previous comment.{% endtrans %}</p>
-        </div>
-      {% elif user.has_perm("pedagogy.add_uecomment") %}
-        <details class="accordion" id="leave_comment" {% if form.errors %}open{%endif%}>
-          <summary>{% trans %}Leave comment{% endtrans %}</summary>
-          <div class="accordion-content">
-            <form action="{{ url('pedagogy:ue_detail', ue_id=object.id) }}" method="post" enctype="multipart/form-data">
-              {% csrf_token %}
-              <div class="leave-comment-grid-container">
-                <div class="form-stars">
-                  {{ form.non_field_errors() }}
-                  {{ form.author.errors }}
-                  {{ form.ue.errors }}
 
-                  {{ form.author }}
+    <div class="pedagogy">
-                  {{ form.ue }}
+      <div id="ue_detail">
+        <button onclick='(function(){
+                         // If comes from the guide page, go back with history
+                         if (document.referrer.replace(/\?(.+)/gm,"").endsWith(`{{ url("pedagogy:guide") }}`)){
+                         window.history.back();
+                         return;
+                         }
+                         // Simply goes to the guide page
+                         window.location.href = `{{ url("pedagogy:guide") }}`;
+                         })()' hidden>{% trans %}Back{% endtrans %}</button>
 
-                  <div class="input-stars">
+        <h1>{{ object.code }} - {{ object.title }}</h1>
-                    <label for="{{ form.grade_global.id_for_label }}">{{ form.grade_global.label }} :</label>
+        <br>
-                    {{ form.grade_global.errors }}
+        <div class="ue-quick-info-container">
-                    {{ form.grade_global }}
+          <div class="hours-cm">
-                  </div>
+            <b>{% trans %}CM: {% endtrans %}</b>{{ object.hours_CM }}
-
-                  <div class="input-stars">
-                    <label for="{{ form.grade_utility.id_for_label }}">{{ form.grade_utility.label }} :</label>
-                    {{ form.grade_utility.errors }}
-                    {{ form.grade_utility }}
-                  </div>
-
-                  <div class="input-stars">
-                    <label for="{{ form.grade_interest.id_for_label }}">{{ form.grade_interest.label }} :</label>
-                    {{ form.grade_interest.errors }}
-                    {{ form.grade_interest }}
-                  </div>
-
-                  <div class="input-stars">
-                    <label for="{{ form.grade_teaching.id_for_label }}">{{ form.grade_teaching.label }} :</label>
-                    {{ form.grade_teaching.errors }}
-                    {{ form.grade_teaching }}
-                  </div>
-
-                  <div class="input-stars">
-                    <label for="{{ form.grade_work_load.id_for_label }}">{{ form.grade_work_load.label }} :</label>
-                    {{ form.grade_work_load.errors }}
-                    {{ form.grade_work_load }}
-                  </div>
-                </div>
-                <div class="form-comment">
-                  <label for="{{ form.comment.id_for_label }}">{{ form.comment.label }} :</label>
-                  {{ form.comment.errors }}
-                  {{ form.comment }}
-                </div>
-              </div>
-              <p><input type="submit" value="{% trans %}Comment{% endtrans %}" /></p>
-            </form>
           </div>
-        </details>
+          <div class="hours-td">
-      {% endif %}
+            <b>{% trans %}TD: {% endtrans %}</b>{{ object.hours_TD }}
-      <br>
+          </div>
-
+          <div class="hours-tp">
-      {% if comments %}
+            <b>{% trans %}TP: {% endtrans %}</b>{{ object.hours_TP }}
-        <h2>{% trans %}Comments{% endtrans %}</h2>
+          </div>
-        {% for comment in comments %}
+          <div class="hours-te">
-          <div id="{{ comment.id }}" class="comment-container">
+            <b>{% trans %}TE: {% endtrans %}</b>{{ object.hours_TE }}
-
+          </div>
-            <div class="grade-block">
+          <div class="hours-the">
-              <div class="grade-type">
+            <b>{% trans %}THE: {% endtrans %}</b>{{ object.hours_THE }}
-                <p>{% trans %}Global grade{% endtrans %}</p>
-                <p>{% trans %}Utility{% endtrans %}</p>
-                <p>{% trans %}Interest{% endtrans %}</p>
-                <p>{% trans %}Teaching{% endtrans %}</p>
-                <p>{% trans %}Work load{% endtrans %}</p>
-              </div>
-              <div class="grade-stars">
-                <p>{{ display_star(comment.grade_global) }}</p>
-                <p>{{ display_star(comment.grade_utility) }}</p>
-                <p>{{ display_star(comment.grade_interest) }}</p>
-                <p>{{ display_star(comment.grade_teaching) }}</p>
-                <p>{{ display_star(comment.grade_work_load) }}</p>
-              </div>
-              <div class="grade-extension"></div>
-            </div>
-
-            <div class="comment">
-              <div class="anchor">
-                <a href="{{ url('pedagogy:ue_detail', ue_id=ue.id) }}#{{ comment.id }}"><i class="fa fa-paragraph"></i></a>
-              </div>
-              {{ comment.comment|markdown }}
-            </div>
-
-            <div class="info">
-              {% if comment.is_reported %}
-                <p class="status-reported">
-                  {% trans %}This comment has been reported{% endtrans %}
-                </p>
-              {% endif %}
-
-              {% if comment.author_id == user.id or user.has_perm("pedagogy.change_comment") %}
-                <p class="actions">
-                  <a href="{{ url('pedagogy:comment_update', comment_id=comment.id) }}">
-                    {% trans %}Edit{% endtrans %}
-                  </a>
-              {% endif %}
-              {% if comment.author_id == user.id or user.has_perm("pedagogy.delete_comment") %}
-                <a href="{{ url('pedagogy:comment_delete', comment_id=comment.id) }}">
-                  {% trans %}Delete{% endtrans %}
-                </a>
-                </p>
-              {% endif %}
-            </div>
-
-            <div class="comment-end-bar">
-              <div class="report">
-                <p>
-                  <a href="{{ url('pedagogy:comment_report', comment_id=comment.id) }}">
-                    {% trans %}Report this comment{% endtrans %}
-                  </a>
-                </p>
-              </div>
-
-              <div class="date"><p>{{ comment.publish_date.strftime('%d/%m/%Y') }}</p></div>
-
-              <div class="author"><p>{{ user_profile_link(comment.author) }}</p></div>
-            </div>
-
           </div>
-        {% endfor %}
-      {% endif %}
 
+          <div class="department">
+            {{ object.department }}
+          </div>
+          <div class="credit-type">
+            {{ object.credit_type }}
+          </div>
+          <div class="semester">
+            {{ object.get_semester_display() }}
+          </div>
+        </div>
+
+        <br>
+
+        <div id="ue-grade">
+          {% include "pedagogy/fragments/ue_details/grade.jinja" %}
+        </div>
+
+        <br>
+
+        <div id="comment-form">
+          {% include "pedagogy/fragments/ue_details/form.jinja" %}
+        </div>
+
+        <div id="comments">
+          {% for comment in comments %}
+            {% include "pedagogy/fragments/ue_comment.jinja" %}
+          {% endfor %}
+        </div>
+
+      </div>
     </div>
-  </div>
+  {% endblock %}
-{% endblock %}
+{% endif %}

pedagogy/urls.py

@@ -24,12 +24,14 @@
 from django.urls import path
 
 from pedagogy.views import (
+    UECommentCreateView,
     UECommentDeleteView,
+    UECommentDetailView,
     UECommentReportCreateView,
     UECommentUpdateView,
     UECreateView,
     UEDeleteView,
-    UEDetailFormView,
+    UEDetailView,
     UEGuideView,
     UEModerationFormView,
     UEUpdateView,
@@ -38,7 +40,17 @@ from pedagogy.views import (
 urlpatterns = [
     # Urls displaying the actual application for visitors
     path("", UEGuideView.as_view(), name="guide"),
-    path("ue/<int:ue_id>/", UEDetailFormView.as_view(), name="ue_detail"),
+    path("ue/<int:ue_id>/", UEDetailView.as_view(), name="ue_detail"),
+    path(
+        "ue/<int:ue_id>/comment",
+        UECommentCreateView.as_view(),
+        name="comment_create",
+    ),
+    path(
+        "comment/<int:comment_id>/",
+        UECommentDetailView.as_view(),
+        name="comment_detail",
+    ),
     path(
         "comment/<int:comment_id>/edit/",
         UECommentUpdateView.as_view(),

pedagogy/views.py

@@ -16,7 +16,7 @@
 # details.
 #
 # You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
+# this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 # Place - Suite 330, Boston, MA 02111-1307, USA.
 #
 #
@@ -29,6 +29,7 @@ from django.urls import reverse, reverse_lazy
 from django.views.generic import (
     CreateView,
     DeleteView,
+    DetailView,
     FormView,
     TemplateView,
     UpdateView,
@@ -36,7 +37,7 @@ from django.views.generic import (
 
 from core.auth.mixins import PermissionOrAuthorRequiredMixin
 from core.models import Notification, User
-from core.views import DetailFormView
+from core.views.mixins import AllowFragment, FragmentMixin, UseFragmentsMixin
 from pedagogy.forms import (
     UECommentForm,
     UECommentModerationForm,
@@ -46,37 +47,59 @@ from pedagogy.forms import (
 from pedagogy.models import UE, UEComment, UECommentReport
 
 
-class UEDetailFormView(PermissionRequiredMixin, DetailFormView):
+class UECommentCreateView(PermissionRequiredMixin, FragmentMixin, CreateView):
-    """Display every comment of an UE and detailed infos about it.
+    model = UEComment
-
+    template_name = "pedagogy/fragments/ue_comment_form.jinja"
-    Allow to comment the UE.
-    """
-
-    model = UE
-    pk_url_kwarg = "ue_id"
-    template_name = "pedagogy/ue_detail.jinja"
     form_class = UECommentForm
-    permission_required = "pedagogy.view_ue"
+    permission_required = "pedagogy.add_uecomment"
+    object = None  # Avoid initialisation bug with FragmentMixin
+
+    @property
+    def ue(self):
+        if hasattr(self, "_ue"):
+            return self._ue
+        self._ue = get_object_or_404(UE, id=self.kwargs.get("ue_id"))
+        return self._ue
 
     def has_permission(self):
-        if self.request.method == "POST" and not self.request.user.has_perm(
+        if self.ue.has_user_already_commented(self.request.user):
-            "pedagogy.add_uecomment"
-        ):
-            # if it's a POST request, the user is trying to add a new UEComment
-            # thus he also needs the "add_uecomment" permission
             return False
         return super().has_permission()
 
     def get_form_kwargs(self):
         kwargs = super().get_form_kwargs()
         kwargs["author_id"] = self.request.user.id
-        kwargs["ue_id"] = self.object.id
+        kwargs["ue_id"] = self.ue.id
         kwargs["is_creation"] = True
         return kwargs
 
-    def form_valid(self, form):
+    def get_context_data(self, **kwargs):
-        form.save()
+        return super().get_context_data(**kwargs) | {
-        return super().form_valid(form)
+            "action": reverse("pedagogy:comment_create", kwargs={"ue_id": self.ue.id}),
+            "object": self.ue,
+        }
+
+    def get_success_url(self):
+        return reverse("pedagogy:ue_detail", kwargs={"ue_id": self.ue.id})
+
+
+class UEDetailView(
+    PermissionRequiredMixin, UseFragmentsMixin, AllowFragment, DetailView
+):
+    """Display every comment of an UE and detailed infos about it."""
+
+    model = UE
+    pk_url_kwarg = "ue_id"
+    template_name = "pedagogy/ue_detail.jinja"
+    permission_required = "pedagogy.view_ue"
+    fragments = {
+        "add_comment_form": UECommentCreateView,
+    }
+
+    def get_fragment_data(self):
+        return {
+            "add_comment_form": {"ue_id": self.object.id},
+        }
 
     def get_context_data(self, **kwargs):
         return super().get_context_data(**kwargs) | {
@@ -85,22 +108,35 @@ class UEDetailFormView(PermissionRequiredMixin, DetailFormView):
                 .annotate_is_reported()
                 .select_related("author")
                 .order_by("-publish_date")
-            )
+            ),
         }
 
-    def get_success_url(self):
+
-        # once the new ue comment has been saved
+class UECommentDetailView(PermissionRequiredMixin, DetailView):
-        # redirect to the same page we are currently
+    model = UEComment
-        return self.request.path
+    pk_url_kwarg = "comment_id"
+    template_name = "pedagogy/fragments/ue_comment.jinja"
+    permission_required = "pedagogy.view_ue"
+    context_object_name = "comment"
+
+    def get_queryset(self):
+        return (
+            super().get_queryset().viewable_by(self.request.user).annotate_is_reported()
+        )
+
+    def get_context_data(self, **kwargs):
+        return super().get_context_data(**kwargs) | {
+            "ue": getattr(self.object, "ue", None)
+        }
 
 
-class UECommentUpdateView(PermissionOrAuthorRequiredMixin, UpdateView):
+class UECommentUpdateView(PermissionOrAuthorRequiredMixin, AllowFragment, UpdateView):
     """Allow edit of a given comment."""
 
     model = UEComment
     form_class = UECommentForm
     pk_url_kwarg = "comment_id"
-    template_name = "core/edit.jinja"
+    template_name = "pedagogy/fragments/ue_comment_form.jinja"
     permission_required = "pedagogy.change_uecomment"
     author_field = "author"
 
@@ -111,11 +147,18 @@ class UECommentUpdateView(PermissionOrAuthorRequiredMixin, UpdateView):
         kwargs["is_creation"] = False
         return kwargs
 
+    def get_context_data(self, **kwargs):
+        return super().get_context_data(**kwargs) | {
+            "action": reverse(
+                "pedagogy:comment_update", kwargs={"comment_id": self.object.id}
+            )
+        }
+
     def get_success_url(self):
-        return reverse("pedagogy:ue_detail", kwargs={"ue_id": self.object.ue_id})
+        return reverse("pedagogy:comment_detail", kwargs={"comment_id": self.object.id})
 
 
-class UECommentDeleteView(PermissionOrAuthorRequiredMixin, DeleteView):
+class UECommentDeleteView(PermissionOrAuthorRequiredMixin, AllowFragment, DeleteView):
     """Allow to delete a given comment."""
 
     model = UEComment
@@ -124,8 +167,13 @@ class UECommentDeleteView(PermissionOrAuthorRequiredMixin, DeleteView):
     permission_required = "pedagogy.delete_uecomment"
     author_field = "author"
 
+    def form_valid(self, form):
+        response = super().form_valid(form)
+        response.headers["HX-Trigger"] = "CommentUpdate"
+        return response
+
     def get_success_url(self):
-        return reverse("pedagogy:ue_detail", kwargs={"ue_id": self.object.ue_id})
+        return reverse("pedagogy:comment_detail", kwargs={"comment_id": self.object.id})
 
 
 class UEGuideView(PermissionRequiredMixin, TemplateView):
@@ -135,12 +183,12 @@ class UEGuideView(PermissionRequiredMixin, TemplateView):
     permission_required = "pedagogy.view_ue"
 
 
-class UECommentReportCreateView(PermissionRequiredMixin, CreateView):
+class UECommentReportCreateView(PermissionRequiredMixin, AllowFragment, CreateView):
     """Create a new report for an inappropriate comment."""
 
     model = UECommentReport
     form_class = UECommentReportForm
-    template_name = "core/edit.jinja"
+    template_name = "pedagogy/fragments/comment_report.jinja"
     permission_required = "pedagogy.add_uecommentreport"
 
     def dispatch(self, request, *args, **kwargs):
@@ -153,6 +201,11 @@ class UECommentReportCreateView(PermissionRequiredMixin, CreateView):
         kwargs["comment_id"] = self.ue_comment.id
         return kwargs
 
+    def get_context_data(self, **kwargs):
+        return super().get_context_data() | {
+            "comment_id": self.ue_comment.id,
+        }
+
     def form_valid(self, form):
         resp = super().form_valid(form)
         # Send a message to moderation admins
@@ -168,11 +221,12 @@ class UECommentReportCreateView(PermissionRequiredMixin, CreateView):
                 url=reverse("pedagogy:moderation"),
                 type="PEDAGOGY_MODERATION",
             )
-
         return resp
 
     def get_success_url(self):
-        return reverse("pedagogy:ue_detail", kwargs={"ue_id": self.ue_comment.ue_id})
+        return reverse(
+            "pedagogy:comment_detail", kwargs={"comment_id": self.ue_comment.id}
+        )
 
 
 class UEModerationFormView(PermissionRequiredMixin, FormView):