Add $model special argument.

Author: adamghill

django_unicorn/decorators.py

@@ -6,6 +6,42 @@
 import wrapt
 
 
+@wrapt.decorator()
+def db_model(wrapped, instance, args, kwargs):
+    """
+    Converts a JSON representation of a Django model into an actual model.
+
+    For example:
+        @db_model
+        def delete(self, model):
+            ...
+    
+    Will get converted to:
+        `component.delete({ 'name': 'modelName', pk: 1})` -> `component.delete(modelInstance)`
+    """
+
+    if hasattr(instance, "Meta") and hasattr(instance.Meta, "db_models"):
+        db_model_name = args[0].get("name")
+        db_model_pk = args[0].get("pk")
+        db_model_found = False
+
+        for db_model in instance.Meta.db_models:
+            if db_model.name == db_model_name:
+                model = db_model.model_class.objects.get(pk=db_model_pk)
+                args = (model,) + args[1:]
+                db_model_found = True
+                break
+
+        if not db_model_found:
+            raise Exception(f"No db_model found that matches '{db_model_name}'")
+    else:
+        raise Exception("No db_models defined")
+
+    result = wrapped(*args, **kwargs)
+
+    return result
+
+
 def _timed_enabled():
     return settings.DEBUG
 

django_unicorn/static/js/eventListeners.js

@@ -129,7 +129,6 @@ export function addActionEventListener(component, eventType) {
           args(action.name).forEach((eventArg) => {
             if (eventArg.startsWith("$event")) {
               // Remove any extra whitespace, everything before and including "$event", and the ending paren
-              // let eventArg = action.name.trim();
               eventArg = eventArg
                 .trim()
                 .slice(eventArg.indexOf("$event") + 6)
@@ -172,6 +171,35 @@ export function addActionEventListener(component, eventType) {
                   data
                 );
               }
+            } else if (eventArg === "$model") {
+              const db = {};
+              let elToCheck = targetElement;
+
+              while (elToCheck.parent && (isEmpty(db.name) || isEmpty(db.pk))) {
+                if (elToCheck.el.getAttribute("unicorn:checksum")) {
+                  break;
+                }
+
+                if (elToCheck.db.name) {
+                  db.name = elToCheck.db.name;
+                }
+
+                if (elToCheck.db.pk) {
+                  db.pk = elToCheck.db.pk;
+                }
+
+                elToCheck = elToCheck.parent;
+              }
+
+              if (db.name && db.pk) {
+                action.name = action.name.replace(
+                  "$model",
+                  JSON.stringify({
+                    pk: db.pk,
+                    name: db.name,
+                  })
+                );
+              }
             }
           });
 

example/unicorn/components/models.py

@@ -4,6 +4,7 @@
 
 from django_unicorn.components import UnicornView
 from django_unicorn.db import DbModel
+from django_unicorn.decorators import db_model
 
 
 class ModelsView(UnicornView):
@@ -34,6 +35,10 @@ def add_class_flavor(self):
         self.class_flavor.save()
         self.reset()
 
+    @db_model
+    def delete(self, model):
+        model.delete()
+
     @cached_property
     def available_flavors(self):
         flavors = Flavor.objects.all()

example/unicorn/templates/unicorn/models.html

@@ -88,6 +88,9 @@ <h4>PK: {{ flavor.pk }}</h4>
                 <strong>Decimal value</strong> {{ flavor.decimal_value }}
             </div>
 
+            <button unicorn:click="delete($model)">delete($model)</button>
+            <br/>
+
             <!-- todo: get updating parent working correctly -->
             <label>Parent</label>
             <select>