Merge branch '49-adaptations-for-spa-operation' into 'master'

Resolve "Adaptations for SPA operation"

Closes #49

See merge request !121

CHANGELOG.rst

@@ -6,9 +6,22 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog`_,
 and this project adheres to `Semantic Versioning`_.
 
+Breaking changes
+----------------
+
+Removed
+~~~~~~~
+
+* Remove legacy menu entries.
+
 Unreleased
 ----------
 
+Added
+~~~~~
+
+* Add SPA support.
+
 
 `2.1`_ - 2022-06-25
 -------------------

aleksis/apps/hjelp/frontend/index.js

+export default
+  {
+    meta: {
+      inMenu: true,
+      titleKey: "hjelp.menu_title",
+      icon: "mdi-help-circle-outline",
+    },
+    props: {
+      byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+    },
+    children: [
+      {
+        path: "issues/report/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.reportIssue",
+        meta: {
+          inMenu: true,
+          titleKey: "hjelp.issues.menu_title",
+          icon: "mdi-bug-outline",
+          permission: "hjelp.report_issue_rule",
+        },
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "feedback/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.feedback",
+        meta: {
+          inMenu: true,
+          titleKey: "hjelp.feedback.menu_title",
+          icon: "mdi-message-text-outline",
+          permission: "hjelp.send_feedback_rule",
+        },
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.faq",
+        meta: {
+          inMenu: true,
+          titleKey: "hjelp.faq.menu_title_list",
+          icon: "mdi-forum-outline",
+          permission: "hjelp.view_faq_rule",
+        },
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/ask/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.askFaq",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/order/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.orderFaq",
+        meta: {
+          inMenu: true,
+          titleKey: "hjelp.faq.menu_title_manage",
+          icon: "mdi-priority-low",
+          permission: "hjelp.change_faq_rule",
+        },
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/section/create/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.createFaqSection",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/section/:pk/delete/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.deleteFaqSection",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/question/create/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.createFaqQuestion",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/question/:pk/update/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.updateFaqQuestion",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+      {
+        path: "faq/question/:pk/delete/",
+        component: () => import("aleksis.core/components/LegacyBaseTemplate.vue"),
+        name: "hjelp.deleteFaqQuestion",
+        props: {
+          byTheGreatnessOfTheAlmightyAleksolotlISwearIAmWorthyOfUsingTheLegacyBaseTemplate: true,
+        },
+      },
+    ],
+  }

aleksis/apps/hjelp/frontend/messages/de.json

+{
+  "hjelp": {
+    "menu_title": "Support"
+  }
+}

aleksis/apps/hjelp/frontend/messages/en.json

+{
+  "hjelp": {
+    "menu_title": "Support",
+    "issues": {
+      "menu_title": "Report an issue"
+    },
+    "feedback": {
+      "menu_title": "Give feedback"
+    },
+    "faq": {
+      "menu_title_list": "FAQ",
+      "menu_title_manage": "Manage FAQ"
+    }
+  }
+}

aleksis/apps/hjelp/menus.py

-from django.utils.translation import gettext_lazy as _
-
-MENUS = {
-    "NAV_MENU_CORE": [
-        {
-            "name": _("Support"),
-            "url": "#",
-            "icon": "help",
-            "root": True,
-            "validators": [
-                (
-                    "aleksis.core.util.predicates.permission_validator",
-                    "hjelp.show_menu_rule",
-                ),
-            ],
-            "submenu": [
-                {
-                    "name": _("Report an issue"),
-                    "url": "report_issue",
-                    "icon": "bug_report",
-                    "validators": [
-                        (
-                            "aleksis.core.util.predicates.permission_validator",
-                            "hjelp.report_issue_rule",
-                        ),
-                    ],
-                },
-                {
-                    "name": _("Give feedback"),
-                    "url": "feedback",
-                    "icon": "message_alert",
-                    "validators": [
-                        (
-                            "aleksis.core.util.predicates.permission_validator",
-                            "hjelp.send_feedback_rule",
-                        ),
-                    ],
-                },
-                {
-                    "name": _("FAQ"),
-                    "url": "faq",
-                    "icon": "question_answer",
-                    "validators": [
-                        (
-                            "aleksis.core.util.predicates.permission_validator",
-                            "hjelp.view_faq_rule",
-                        ),
-                    ],
-                },
-                {
-                    "name": _("Manage FAQ"),
-                    "url": "order_faq",
-                    "icon": "low_priority",
-                    "validators": [
-                        (
-                            "aleksis.core.util.predicates.permission_validator",
-                            "hjelp.change_faq_rule",
-                        ),
-                    ],
-                },
-            ],
-        }
-    ]
-}

aleksis/apps/hjelp/views.py

@@ -14,6 +14,7 @@ from material import Layout, Row
 from rules.contrib.views import permission_required
 from templated_email import send_templated_mail
 
+from aleksis.core.decorators import pwa_cache
 from aleksis.core.mixins import AdvancedCreateView, AdvancedDeleteView, AdvancedEditView
 from aleksis.core.models import Activity
 from aleksis.core.util.core_helpers import get_site_preferences
@@ -22,6 +23,7 @@ from .forms import FAQForm, FAQOrderFormSet, FAQQuestionForm, FeedbackForm, Issu
 from .models import FAQQuestion, FAQSection, IssueCategory
 
 
+@pwa_cache
 @permission_required("hjelp.view_faq_rule")
 def faq(request):
     """Show the FAQ page."""

docs/conf.py

@@ -29,9 +29,9 @@ copyright = "2018-2022 The AlekSIS team"
 author = "The AlekSIS Team"
 
 # The short X.Y version
-version = "2.1"
+version = "3.0"
 # The full version, including alpha/beta/rc tags
-release = "2.1.1.dev0"
+release = "3.0.0.dev0"
 
 
 # -- General configuration ---------------------------------------------------

pyproject.toml

 [tool.poetry]
 name = "AlekSIS-App-Hjelp"
-version = "2.1.1.dev0"
+version = "3.0.0.dev0"
 packages = [
     { include = "aleksis" }
 ]
@@ -38,7 +38,7 @@ secondary = true
 
 [tool.poetry.dependencies]
 python = "^3.9"
-aleksis-core = "^2.10"
+aleksis-core = "^3.0.dev3"
 
 [tool.poetry.dev-dependencies]
 aleksis-builddeps = "*"