From ec5b964ac3b5c8467e48781b6f4552c5c6003455 Mon Sep 17 00:00:00 2001 From: Sli Date: Fri, 4 Sep 2026 18:31:06 +0200 Subject: [PATCH] Prototype: use partials --- core/static/bundled/base-bundle-index.ts | 24 ++---- core/static/bundled/htmx/error-callback.ts | 74 ------------------- .../pedagogy/fragments/ue_comments.jinja | 17 ----- .../pedagogy/fragments/ue_detail.jinja | 47 ------------ .../fragments/ue_details/comments.jinja | 10 +++ .../pedagogy/fragments/ue_details/form.jinja | 10 +++ .../pedagogy/fragments/ue_details/grade.jinja | 27 +++++++ pedagogy/templates/pedagogy/ue_detail.jinja | 31 +++++++- pedagogy/urls.py | 6 -- pedagogy/views.py | 55 ++++---------- 10 files changed, 96 insertions(+), 205 deletions(-) delete mode 100644 core/static/bundled/htmx/error-callback.ts delete mode 100644 pedagogy/templates/pedagogy/fragments/ue_comments.jinja delete mode 100644 pedagogy/templates/pedagogy/fragments/ue_detail.jinja create mode 100644 pedagogy/templates/pedagogy/fragments/ue_details/comments.jinja create mode 100644 pedagogy/templates/pedagogy/fragments/ue_details/form.jinja create mode 100644 pedagogy/templates/pedagogy/fragments/ue_details/grade.jinja diff --git a/core/static/bundled/base-bundle-index.ts b/core/static/bundled/base-bundle-index.ts index eae4ce75..3c7140e1 100644 --- a/core/static/bundled/base-bundle-index.ts +++ b/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"; @@ -18,7 +18,6 @@ import { polyfillCountryFlagEmojis } from "country-flag-emoji-polyfill"; import { limitedChoices } from "#core:alpine/limited-choices"; import { expireOldStorage } from "#core:core/localstorage"; import { default as navbar } from "#core:core/navbar"; -import { getErrorCallbacksExt } from "#core:htmx/error-callback"; import { type NotificationPlugin, notificationsPlugin as notifications, @@ -49,22 +48,13 @@ polyfillCountryFlagEmojis(); /** * HTMX */ -document.body.addEventListener( - "htmx:before:request" as keyof HTMLElementEventMap, - (event) => { - (event as CustomEvent).detail.ctx.target.ariaBusy = true; - }, -); +document.body.addEventListener("htmx:before:request", (event) => { + event.target.ariaBusy = true; +}); -document.body.addEventListener( - "htmx:before:swap" as keyof HTMLElementEventMap, - (event) => { - (event as CustomEvent).detail.ctx.target.ariaBusy = null; - }, -); - -const errorCallbackExt = getErrorCallbacksExt(); -htmx.registerExtension(errorCallbackExt.name, errorCallbackExt.extension); +document.body.addEventListener("htmx:before:swap", (event) => { + event.target.ariaBusy = null; +}); Object.assign(window, { htmx }); diff --git a/core/static/bundled/htmx/error-callback.ts b/core/static/bundled/htmx/error-callback.ts deleted file mode 100644 index 276181d4..00000000 --- a/core/static/bundled/htmx/error-callback.ts +++ /dev/null @@ -1,74 +0,0 @@ -interface CustomHtmxExtension { - name: string; - extension: any; -} - -export const getErrorCallbacksExt = () => { - const attrPrefix = "hx-callback-"; - let htmxApi: { attributeValue: (arg0: HTMLElement, arg1: string) => string | null }; - - const getCallback = (elt: HTMLElement, responseCode: number) => { - if (!elt || !responseCode) { - return () => {}; - } - - const code = responseCode.toString(); - - // '*' is the original syntax, as the obvious character for a wildcard. - // The 'x' alternative was added for maximum compatibility with HTML - // templating engines, due to ambiguity around which characters are - // supported in HTML attributes. - // - // Start with the most specific possible attribute and generalize from - // there. - const suffixes = [ - code, - - `${code.substring(0, 2)}*`, - `${code.substring(0, 2)}x`, - - `${code.substring(0, 1)}*`, - `${code.substring(0, 1)}x`, - `${code.substring(0, 1)}**`, - `${code.substring(0, 1)}xx`, - - "*", - "x", - "***", - "xxx", - ]; - if (code.startsWith("4") || code.startsWith("5")) { - suffixes.push("error"); - } - - for (const suffix of suffixes) { - const attr = attrPrefix + suffix; - const callback = htmxApi?.attributeValue(elt, attr); - if (callback) { - return Function("src", "target", callback); - } - } - - return () => {}; - }; - - return { - name: "error-callbacks", - extension: { - init: (api: any) => { - htmxApi = api; - }, - // biome-ignore lint/style/useNamingConvention: HTMX naming convention - htmx_response_error: ( - elt: HTMLElement, - event: { ctx: any; cancelled: boolean }, - ) => { - if (event.cancelled) { - return false; - } - getCallback(elt, event.ctx.response.status)(elt, event.ctx.target); - return true; - }, - }, - } as CustomHtmxExtension; -}; diff --git a/pedagogy/templates/pedagogy/fragments/ue_comments.jinja b/pedagogy/templates/pedagogy/fragments/ue_comments.jinja deleted file mode 100644 index 630031d2..00000000 --- a/pedagogy/templates/pedagogy/fragments/ue_comments.jinja +++ /dev/null @@ -1,17 +0,0 @@ -
- {% if comments %} -

{% trans %}Comments{% endtrans %}

-
- {% endif %} - - {% for comment in comments %} - {% include "pedagogy/fragments/ue_comment.jinja" %} - {% endfor %} -
- - diff --git a/pedagogy/templates/pedagogy/fragments/ue_detail.jinja b/pedagogy/templates/pedagogy/fragments/ue_detail.jinja deleted file mode 100644 index 01c91a46..00000000 --- a/pedagogy/templates/pedagogy/fragments/ue_detail.jinja +++ /dev/null @@ -1,47 +0,0 @@ -
-
-
-

{% trans %}Global grade{% endtrans %}

-

{% trans %}Utility{% endtrans %}

-

{% trans %}Interest{% endtrans %}

-

{% trans %}Teaching{% endtrans %}

-

{% trans %}Work load{% endtrans %}

-
-
-

{{ display_star(object.grade_global_average) }}

-

{{ display_star(object.grade_utility_average) }}

-

{{ display_star(object.grade_interest_average) }}

-

{{ display_star(object.grade_teaching_average) }}

-

{{ display_star(object.grade_work_load_average) }}

-
-
-

{% trans %}Objectives{% endtrans %}

-

{{ object.objectives|markdown }}

-

{% trans %}Program{% endtrans %}

-

{{ object.program|markdown }}

-

{% trans %}Earned skills{% endtrans %}

-

{{ object.skills|markdown }}

-

{% trans %}Key concepts{% endtrans %}

-

{{ object.key_concepts|markdown }}

-

{% trans %}UE manager: {% endtrans %}{{ object.manager }}

-
-
- -
- {% if object.has_user_already_commented(user) %} -
-

{% trans %}You already posted a comment on this UE. If you want to comment again, please modify or delete your previous comment.{% endtrans %}

-
-
- {% endif %} - - {% if not object.has_user_already_commented(user) and user.has_perm("pedagogy.add_uecomment") %} - {{ add_comment_form }} - {% endif %} - -
diff --git a/pedagogy/templates/pedagogy/fragments/ue_details/comments.jinja b/pedagogy/templates/pedagogy/fragments/ue_details/comments.jinja new file mode 100644 index 00000000..fdc0e53c --- /dev/null +++ b/pedagogy/templates/pedagogy/fragments/ue_details/comments.jinja @@ -0,0 +1,10 @@ +{% if comments %} +

{% trans %}Comments{% endtrans %}

+
+{% endif %} + +
+ {% for comment in comments %} + {% include "pedagogy/fragments/ue_comment.jinja" %} + {% endfor %} +
diff --git a/pedagogy/templates/pedagogy/fragments/ue_details/form.jinja b/pedagogy/templates/pedagogy/fragments/ue_details/form.jinja new file mode 100644 index 00000000..7414f4b5 --- /dev/null +++ b/pedagogy/templates/pedagogy/fragments/ue_details/form.jinja @@ -0,0 +1,10 @@ +{% if object.has_user_already_commented(user) %} +
+

{% trans %}You already posted a comment on this UE. If you want to comment again, please modify or delete your previous comment.{% endtrans %}

+
+
+{% endif %} + +{% if not object.has_user_already_commented(user) and user.has_perm("pedagogy.add_uecomment") %} + {{ add_comment_form }} +{% endif %} diff --git a/pedagogy/templates/pedagogy/fragments/ue_details/grade.jinja b/pedagogy/templates/pedagogy/fragments/ue_details/grade.jinja new file mode 100644 index 00000000..7f507863 --- /dev/null +++ b/pedagogy/templates/pedagogy/fragments/ue_details/grade.jinja @@ -0,0 +1,27 @@ +
+
+

{% trans %}Global grade{% endtrans %}

+

{% trans %}Utility{% endtrans %}

+

{% trans %}Interest{% endtrans %}

+

{% trans %}Teaching{% endtrans %}

+

{% trans %}Work load{% endtrans %}

+
+
+

{{ display_star(object.grade_global_average) }}

+

{{ display_star(object.grade_utility_average) }}

+

{{ display_star(object.grade_interest_average) }}

+

{{ display_star(object.grade_teaching_average) }}

+

{{ display_star(object.grade_work_load_average) }}

+
+
+

{% trans %}Objectives{% endtrans %}

+

{{ object.objectives|markdown }}

+

{% trans %}Program{% endtrans %}

+

{{ object.program|markdown }}

+

{% trans %}Earned skills{% endtrans %}

+

{{ object.skills|markdown }}

+

{% trans %}Key concepts{% endtrans %}

+

{{ object.key_concepts|markdown }}

+

{% trans %}UE manager: {% endtrans %}{{ object.manager }}

+
+
diff --git a/pedagogy/templates/pedagogy/ue_detail.jinja b/pedagogy/templates/pedagogy/ue_detail.jinja index 7d863960..aaec4bee 100644 --- a/pedagogy/templates/pedagogy/ue_detail.jinja +++ b/pedagogy/templates/pedagogy/ue_detail.jinja @@ -1,7 +1,19 @@ {% from "pedagogy/macros.jinja" import display_star %} {% if is_fragment %} - {% include "pedagogy/fragments/ue_detail.jinja" %} + + + {% include "pedagogy/fragments/ue_details/grade.jinja" %} + + + + {% include "pedagogy/fragments/ue_details/form.jinja" %} + + + + {% include "pedagogy/fragments/ue_details/comments.jinja" %} + + {% else %} {% extends "core/base.jinja" %} @@ -59,12 +71,23 @@
- {% include "pedagogy/fragments/ue_detail.jinja" %} +
+ {% include "pedagogy/fragments/ue_details/grade.jinja" %} +
- {{ comments }} +
+ +
+ {% include "pedagogy/fragments/ue_details/form.jinja" %} +
+ +
+ {% for comment in comments %} + {% include "pedagogy/fragments/ue_comment.jinja" %} + {% endfor %} +
- {% endblock %} {% endif %} diff --git a/pedagogy/urls.py b/pedagogy/urls.py index a9808ea8..cc296f73 100644 --- a/pedagogy/urls.py +++ b/pedagogy/urls.py @@ -31,7 +31,6 @@ from pedagogy.views import ( UECommentUpdateView, UECreateView, UEDeleteView, - UEDetailCommentsView, UEDetailView, UEGuideView, UEModerationFormView, @@ -42,11 +41,6 @@ urlpatterns = [ # Urls displaying the actual application for visitors path("", UEGuideView.as_view(), name="guide"), path("ue//", UEDetailView.as_view(), name="ue_detail"), - path( - "ue//comments", - UEDetailCommentsView.as_view(), - name="ue_comments", - ), path( "ue//comment", UECommentCreateView.as_view(), diff --git a/pedagogy/views.py b/pedagogy/views.py index 0d1350b6..036c47fc 100644 --- a/pedagogy/views.py +++ b/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. # # @@ -24,7 +24,6 @@ from django.conf import settings from django.contrib.auth.mixins import PermissionRequiredMixin from django.db.models import Exists, OuterRef -from django.http import HttpResponse from django.shortcuts import get_object_or_404 from django.urls import reverse, reverse_lazy from django.views.generic import ( @@ -76,39 +75,12 @@ class UECommentCreateView(PermissionRequiredMixin, FragmentMixin, CreateView): def get_context_data(self, **kwargs): return super().get_context_data(**kwargs) | { - "action": reverse("pedagogy:comment_create", kwargs={"ue_id": self.ue.id}) + "action": reverse("pedagogy:comment_create", kwargs={"ue_id": self.ue.id}), + "object": self.ue, } - def form_valid(self, form): - """If the form is valid, save the associated model.""" - self.object = form.save() - response = HttpResponse(status=200) - response.headers["HX-Trigger"] = "NewComment, CommentUpdate" - return response - - -class UEDetailCommentsView( - PermissionRequiredMixin, - FragmentMixin, - DetailView, -): - """Fragment view that display all comments""" - - model = UE - pk_url_kwarg = "ue_id" - template_name = "pedagogy/fragments/ue_comments.jinja" - permission_required = "pedagogy.view_ue" - - def get_context_data(self, **kwargs): - self.object = self.get_object() # Needed if loaded with .as_fragment() - return super().get_context_data(**kwargs) | { - "comments": list( - self.object.comments.viewable_by(self.request.user) - .annotate_is_reported() - .select_related("author") - .order_by("-publish_date") - ), - } + def get_success_url(self): + return reverse("pedagogy:ue_detail", kwargs={"ue_id": self.ue.id}) class UEDetailView( @@ -122,13 +94,21 @@ class UEDetailView( permission_required = "pedagogy.view_ue" fragments = { "add_comment_form": UECommentCreateView, - "comments": UEDetailCommentsView, } def get_fragment_data(self): return { "add_comment_form": {"ue_id": self.object.id}, - "comments": {"ue_id": self.object.id}, + } + + def get_context_data(self, **kwargs): + return super().get_context_data(**kwargs) | { + "comments": list( + self.object.comments.viewable_by(self.request.user) + .annotate_is_reported() + .select_related("author") + .order_by("-publish_date") + ), } @@ -144,11 +124,6 @@ class UECommentDetailView(PermissionRequiredMixin, DetailView): super().get_queryset().viewable_by(self.request.user).annotate_is_reported() ) - def dispatch(self, *args, **kwargs): - res: HttpResponse = super().dispatch(*args, **kwargs) - res.headers["HX-Trigger"] = "CommentUpdate" - return res - def get_context_data(self, **kwargs): return super().get_context_data(**kwargs) | { "ue": getattr(self.object, "ue", None)