Remove the legacy db model implementation.

Author: adamghill

django_unicorn/decorators.py

@@ -1,56 +1,11 @@
 import logging
 import time
-import warnings
 
 from django.conf import settings
 
 from decorator import decorator
 
 
-@decorator
-def db_model(func, *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)`
-    """
-
-    warnings.warn(
-        "db_model is deprecated and will be removed in 0.28.0", stacklevel=2,
-    )
-
-    instance = args[0]
-    model_dictionary = args[1]
-
-    if hasattr(instance, "Meta") and hasattr(instance.Meta, "db_models"):
-        db_model_name = model_dictionary.get("name")
-        assert db_model_name, "Missing db model name"
-        db_model_pk = model_dictionary.get("pk")
-        assert db_model_pk, "Missing db model 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 = (instance, model,) + args[2:]
-                db_model_found = True
-                break
-
-        assert db_model_found, f"No db_model found that matches '{db_model_name}'"
-    else:
-        raise AssertionError("No db_models defined")
-
-    result = func(*args, **kwargs)
-
-    return result
-
-
 @decorator
 def timed(func, *args, **kwargs):
     """

django_unicorn/static/unicorn/js/attribute.js

@@ -10,14 +10,12 @@ export class Attribute {
     this.value = this.attribute.value;
     this.isUnicorn = false;
     this.isModel = false;
-    this.isField = false;
     this.isPoll = false;
     this.isLoading = false;
     this.isTarget = false;
     this.isPartial = false;
     this.isDirty = false;
     this.isKey = false;
-    this.isPK = false;
     this.isError = false;
     this.modifiers = {};
     this.eventType = null;
@@ -35,10 +33,6 @@ export class Attribute {
       // Use `contains` when there could be modifiers
       if (contains(this.name, ":model")) {
         this.isModel = true;
-      } else if (contains(this.name, ":field")) {
-        this.isField = true;
-      } else if (contains(this.name, ":db")) {
-        this.isDb = true;
       } else if (contains(this.name, ":poll.disable")) {
         this.isPollDisable = true;
       } else if (contains(this.name, ":poll")) {
@@ -53,8 +47,6 @@ export class Attribute {
         this.isDirty = true;
       } else if (this.name === "unicorn:key" || this.name === "u:key") {
         this.isKey = true;
-      } else if (this.name === "unicorn:pk" || this.name === "u:pk") {
-        this.isPK = true;
       } else if (contains(this.name, ":error:")) {
         this.isError = true;
       } else {

django_unicorn/static/unicorn/js/component.js

@@ -2,7 +2,6 @@ import { debounce } from "./delayers.js";
 import { Element } from "./element.js";
 import {
   addActionEventListener,
-  addDbEventListener,
   addModelEventListener,
 } from "./eventListeners.js";
 import { components, lifecycleEvents } from "./store.js";
@@ -38,7 +37,6 @@ export class Component {
 
     this.root = undefined;
     this.modelEls = [];
-    this.dbEls = [];
     this.loadingEls = [];
     this.keyEls = [];
     this.errors = {};
@@ -52,7 +50,6 @@ export class Component {
     this.actionEvents = {};
     this.attachedEventTypes = [];
     this.attachedModelEvents = [];
-    this.attachedDbEvents = [];
 
     this.init();
     this.refreshEventListeners();
@@ -168,7 +165,6 @@ export class Component {
   refreshEventListeners() {
     this.actionEvents = {};
     this.modelEls = [];
-    this.dbEls = [];
 
     try {
       this.walker(
@@ -182,26 +178,7 @@ export class Component {
           const element = new Element(el);
 
           if (element.isUnicorn) {
-            if (hasValue(element.field) && hasValue(element.db)) {
-              if (!this.attachedDbEvents.some((e) => e.isSame(element))) {
-                this.attachedDbEvents.push(element);
-                addDbEventListener(this, element);
-
-                // If a field is lazy, also add an event listener for input for dirty states
-                if (element.field.isLazy) {
-                  // This input event for isLazy will be stopped after dirty is checked when the event fires
-                  addDbEventListener(this, element, "input");
-                }
-              }
-
-              if (!this.dbEls.some((e) => e.isSame(element))) {
-                this.dbEls.push(element);
-              }
-            } else if (
-              hasValue(element.model) &&
-              isEmpty(element.db) &&
-              isEmpty(element.field)
-            ) {
+            if (hasValue(element.model)) {
               if (!this.attachedModelEvents.some((e) => e.isSame(element))) {
                 this.attachedModelEvents.push(element);
                 addModelEventListener(this, element);
@@ -274,7 +251,6 @@ export class Component {
         // Can hard-code `forceModelUpdate` to `true` since it is always required for
         // `callMethod` actions
         this.setModelValues(triggeringElements, true);
-        this.setDbModelValues();
       }
     });
   }
@@ -423,42 +399,6 @@ export class Component {
     }
   }
 
-  /**
-   * Sets all db model values.
-   */
-  setDbModelValues() {
-    this.dbEls.forEach((element) => {
-      if (isEmpty(element.db.pk)) {
-        // Empty string for the PK implies that the model is not associated to an actual model instance
-        element.setValue("");
-      } else {
-        const dbName = element.db.name || element.model.name;
-
-        if (isEmpty(dbName)) {
-          throw Error(
-            "Setting a field value requires a db or model name to be set"
-          );
-        }
-
-        let datas = this.data[dbName];
-
-        // Force the data to be an array if it isn't already for the next step
-        if (!Array.isArray(datas)) {
-          datas = [datas];
-        }
-
-        datas.forEach((model) => {
-          // Convert the model's pk to a string because it will always be a string on the element
-          if (hasValue(model) && hasValue(model.pk)) {
-            if (model.pk.toString() === element.db.pk) {
-              element.setValue(model[element.field.name]);
-            }
-          }
-        });
-      }
-    });
-  }
-
   /**
    * Sets all model values.
    * @param {[Element]} triggeringElements The elements that triggered the event.

django_unicorn/static/unicorn/js/element.js

@@ -1,5 +1,5 @@
 import { Attribute } from "./attribute.js";
-import { isEmpty, generateDbKey, hasValue } from "./utils.js";
+import { isEmpty, hasValue } from "./utils.js";
 
 /**
  * Encapsulate DOM element for Unicorn-related information.
@@ -29,8 +29,6 @@ export class Element {
     this.loading = {};
     this.dirty = {};
     this.actions = [];
-    this.db = {};
-    this.field = {};
     this.partials = [];
     this.target = null;
     this.key = null;
@@ -49,11 +47,8 @@ export class Element {
         this.isUnicorn = true;
       }
 
-      if (attribute.isModel || attribute.isField) {
-        let key = "model";
-        if (attribute.isField) {
-          key = "field";
-        }
+      if (attribute.isModel) {
+        const key = "model";
 
         this[key].name = attribute.value;
         this[key].eventType = attribute.modifiers.lazy ? "blur" : "input";
@@ -62,10 +57,6 @@ export class Element {
         this[key].debounceTime = attribute.modifiers.debounce
           ? parseInt(attribute.modifiers.debounce, 10) || -1
           : -1;
-      } else if (attribute.isDb) {
-        this.db.name = attribute.value;
-      } else if (attribute.isPK) {
-        this.db.pk = attribute.value;
       } else if (attribute.isPoll) {
         this.poll.method = attribute.value ? attribute.value : "refresh";
         this.poll.timing = 2000;
@@ -146,51 +137,6 @@ export class Element {
         this.errors.push({ code, message: attribute.value });
       }
     }
-
-    // Look in parent elements if the db.pk or db.name is missing
-    if (this.isUnicorn && hasValue(this.field)) {
-      const dbAttrs = ["pk", "name"];
-      let elToCheck = this;
-
-      // Look for `db.pk` and `db.name`
-      dbAttrs.forEach((attr) => {
-        elToCheck = this;
-
-        while (isEmpty(this.db[attr])) {
-          if (elToCheck.isUnicorn && hasValue(elToCheck.db[attr])) {
-            this.db[attr] = elToCheck.db[attr];
-          }
-
-          if (elToCheck.isRoot()) {
-            break;
-          }
-
-          elToCheck = elToCheck.parent;
-        }
-      });
-
-      // Look for model.name
-      elToCheck = this;
-
-      while (isEmpty(this.model.name)) {
-        if (elToCheck.isUnicorn && hasValue(elToCheck.model.name)) {
-          if (hasValue(this.field) && isEmpty(this.db)) {
-            // Handle a model + field that is not a db
-            this.model = this.field; // Make sure to keep all modifiers from the field for the model
-            this.model.name = `${elToCheck.model.name}.${this.field.name}`;
-            this.field = {};
-          } else {
-            this.model.name = elToCheck.model.name;
-          }
-        }
-
-        if (elToCheck.isRoot()) {
-          break;
-        }
-
-        elToCheck = elToCheck.parent;
-      }
-    }
   }
 
   /**
@@ -214,13 +160,6 @@ export class Element {
     this.el.hidden = null;
   }
 
-  /**
-   * A key that takes into consideration the db name and pk.
-   */
-  dbKey() {
-    return generateDbKey(this);
-  }
-
   /**
    * Get the element's next parent that is a unicorn element.
    *