Merge branch '828-move-deletedialog-from-plank-to-core-3' into 'release-3.0'

Resolve "Move DeleteDialog from Plank to Core"

See merge request !1207

CHANGELOG.rst

@@ -14,6 +14,8 @@ Added
 
 * GraphQL schema for Rooms
 * [Dev] UpdateIndicator Vue Component to display the status of interactive pages
+* [Dev] DeleteDialog Vue Component to unify item deletion in the new frontend
+
 
 Changed
 ~~~~~~~

aleksis/core/frontend/components/generic/dialogs/DeleteDialog.vue

+<template>
+  <ApolloMutation
+    v-if="dialogOpen"
+    :mutation="gqlMutation"
+    :variables="{ id: item.id }"
+    :update="update"
+    @done="close(true)"
+  >
+    <template #default="{ mutate, loading, error }">
+      <v-dialog v-model="dialogOpen" max-width="500px">
+        <v-card>
+          <v-card-title class="text-h5">
+            <slot name="title">
+              {{ $t("actions.confirm_deletion") }}
+            </slot>
+          </v-card-title>
+          <v-card-text>
+            <slot name="body">
+              <p class="text-body-1">{{ nameOfObject }}</p>
+            </slot>
+          </v-card-text>
+          <v-card-actions>
+            <v-spacer></v-spacer>
+            <v-btn text @click="close(false)" :disabled="loading">
+              <slot name="cancelContent">
+                {{ $t("actions.cancel") }}
+              </slot>
+            </v-btn>
+            <v-btn
+              color="error"
+              text
+              @click="mutate"
+              :loading="loading"
+              :disabled="loading"
+            >
+              <slot name="deleteContent">
+                {{ $t("actions.delete") }}
+              </slot>
+            </v-btn>
+          </v-card-actions>
+        </v-card>
+      </v-dialog>
+      <v-snackbar :value="error !== null">
+        {{ error }}
+
+        <template #action="{ attrs }">
+          <v-btn color="primary" text v-bind="attrs" @click="error = null" icon>
+            <v-icon>$close</v-icon>
+          </v-btn>
+        </template>
+      </v-snackbar>
+    </template>
+  </ApolloMutation>
+</template>
+
+<script>
+export default {
+  name: "DeleteDialog",
+  computed: {
+    nameOfObject() {
+      return this.itemAttribute in this.item || {}
+        ? this.item[this.itemAttribute]
+        : this.item.toString();
+    },
+    dialogOpen: {
+      get() {
+        return this.value;
+      },
+
+      set(val) {
+        this.$emit("input", val);
+      },
+    },
+  },
+  methods: {
+    update(store) {
+      if (!this.gqlQuery) {
+        // There is no GraphQL query to update
+        return;
+      }
+
+      // Read the data from cache for query
+      const storedData = store.readQuery({ query: this.gqlQuery });
+
+      if (!storedData) {
+        // There are no data in the cache yet
+        return;
+      }
+
+      const storedDataKey = Object.keys(storedData)[0];
+
+      // Remove item from stored data
+      const index = storedData[storedDataKey].findIndex(
+        (m) => m.id === this.item.id
+      );
+      storedData[storedDataKey].splice(index, 1);
+
+      // Write data back to the cache
+      store.writeQuery({ query: this.gqlQuery, data: storedData });
+    },
+    close(success) {
+      this.$emit("input", false);
+      if (success) {
+        this.$emit("success");
+      } else {
+        this.$emit("cancel");
+      }
+    },
+  },
+  props: {
+    value: {
+      type: Boolean,
+      required: true,
+    },
+    item: {
+      type: Object,
+      required: false,
+      default: () => ({}),
+    },
+    itemAttribute: {
+      type: String,
+      required: false,
+      default: "name",
+    },
+    gqlMutation: {
+      type: Object,
+      required: true,
+    },
+    gqlQuery: {
+      type: Object,
+      required: false,
+      default: null,
+    },
+  },
+};
+</script>

aleksis/core/frontend/messages/en.json

@@ -75,7 +75,12 @@
     "back": "Back",
     "search": "Search",
     "edit": "Edit",
-    "close": "Close"
+    "close": "Close",
+    "cancel": "Cancel",
+    "confirm_deletion": "Are you sure you want to delete this item?",
+    "delete": "Delete",
+    "stop_editing": "Stop editing",
+    "save": "Save"
   },
   "administration": {
     "backend_admin": {

aleksis/core/schema/base.py

+from django.db.models import Model
+from django.core.exceptions import PermissionDenied
+
 import graphene
 from graphene_django import DjangoObjectType
 
@@ -24,3 +27,23 @@ class FieldFileType(graphene.ObjectType):
 
     def resolve_absolute_url(root, info, **kwargs):
         return info.context.build_absolute_uri(root.url) if root else ""
+
+
+class DeleteMutation(graphene.Mutation):
+    """Mutation to delete an object."""
+
+    klass: Model = None
+    permission_required: str = ""
+    ok = graphene.Boolean()
+
+    class Arguments:
+        id = graphene.ID()  # noqa
+
+    @classmethod
+    def mutate(cls, root, info, **kwargs):
+        obj = cls.klass.objects.get(pk=kwargs["id"])
+        if info.context.user.has_perm(cls.permission_required, obj):
+            obj.delete()
+            return cls(ok=True)
+        else:
+            raise PermissionDenied()