@kaspernj/api-maker 1.0.267 → 1.0.269

package/package.json

@@ -16,7 +16,7 @@
     ]
   },
   "name": "@kaspernj/api-maker",
-  "version": "1.0.267",
+  "version": "1.0.269",
   "type": "module",
   "description": "",
   "main": "index.js",
@@ -52,6 +52,7 @@
     "on-location-changed": ">= 1.0.7",
     "qs": ">= 6.9.3",
     "replaceall": ">= 0.1.6",
+    "spark-md5": "^3.0.2",
     "strftime": ">= 0.10.0",
     "uniqunize": "^1.0.1",
     "wake-event": ">= 0.0.1"

package/src/base-model.mjs

@@ -1,5 +1,6 @@
 import Attribute from "./base-model/attribute.mjs"
 import AttributeNotLoadedError from "./attribute-not-loaded-error.mjs"
+import CacheKeyGenerator from "./cache-key-generator.mjs"
 import Collection from "./collection.mjs"
 import CommandsPool from "./commands-pool.mjs"
 import Config from "./config.mjs"
@@ -146,6 +147,7 @@ export default class BaseModel {
     this.changes = {}
     this.newRecord = args.isNewRecord
     this.relationshipsCache = {}
+    this.relationships = {}
 
     if (args && args.data && args.data.a) {
       this._readModelDataFromArgs(args)
@@ -207,6 +209,7 @@ export default class BaseModel {
 
     clone.abilities = {...this.abilities}
     clone.modelData = {...this.modelData}
+    clone.relationships = {...this.relationships}
     clone.relationshipsCache = {...this.relationshipsCache}
 
     return clone
@@ -237,6 +240,12 @@ export default class BaseModel {
     }
   }
 
+  fullCacheKey() {
+    const cacheKeyGenerator = new CacheKeyGenerator(this)
+
+    return cacheKeyGenerator.cacheKey()
+  }
+
   static all () {
     return this.ransack()
   }
@@ -385,6 +394,12 @@ export default class BaseModel {
     return false
   }
 
+  isAssociationPresent (associationName) {
+    if (this.isAssociationLoaded(associationName)) return true
+    if (associationName in this.relationships) return true
+    return false
+  }
+
   static parseValidationErrors ({error, model, options}) {
     if (!(error instanceof ValidationError)) return
     if (!error.args.response.validation_errors) return
@@ -489,6 +504,7 @@ export default class BaseModel {
 
   setNewModel (model) {
     this.setNewModelData(model)
+    this.relationships = digg(model, "relationships")
     this.relationshipsCache = digg(model, "relationshipsCache")
   }
 
@@ -643,7 +659,8 @@ export default class BaseModel {
         {
           args: {
             query_params: this.collection && this.collection.params(),
-            save: objectData
+            save: objectData,
+            simple_model_errors: options?.simpleModelErrors
           },
           command: `${this.modelClassData().collectionName}-update`,
           collectionName: this.modelClassData().collectionName,
@@ -697,6 +714,7 @@ export default class BaseModel {
 
   preloadRelationship (relationshipName, model) {
     this.relationshipsCache[BaseModel.snakeCase(relationshipName)] = model
+    this.relationships[BaseModel.snakeCase(relationshipName)] = model
   }
 
   uniqueKey () {
@@ -792,7 +810,9 @@ export default class BaseModel {
   }
 
   async _loadBelongsToReflection (args, queryArgs = {}) {
-    if (args.reflectionName in this.relationshipsCache) {
+    if (args.reflectionName in this.relationships) {
+      return this.relationships[args.reflectionName]
+    } else if (args.reflectionName in this.relationshipsCache) {
       return this.relationshipsCache[args.reflectionName]
     } else {
       const collection = new Collection(args, queryArgs)
@@ -803,21 +823,24 @@ export default class BaseModel {
   }
 
   _readBelongsToReflection ({reflectionName}) {
-    if (!(reflectionName in this.relationshipsCache)) {
-      if (this.isNewRecord())
-        return null
+    if (reflectionName in this.relationships) {
+      return this.relationships[reflectionName]
+    } else if (reflectionName in this.relationshipsCache) {
+      return this.relationshipsCache[reflectionName]
+    }
 
-      const loadedRelationships = Object.keys(this.relationshipsCache)
-      const modelClassName = digg(this.modelClassData(), "name")
+    if (this.isNewRecord()) return null
 
-      throw new NotLoadedError(`${modelClassName}#${reflectionName} hasn't been loaded yet. Only these were loaded: ${loadedRelationships.join(", ")}`)
-    }
+    const loadedRelationships = Object.keys(this.relationshipsCache)
+    const modelClassName = digg(this.modelClassData(), "name")
 
-    return this.relationshipsCache[reflectionName]
+    throw new NotLoadedError(`${modelClassName}#${reflectionName} hasn't been loaded yet. Only these were loaded: ${loadedRelationships.join(", ")}`)
   }
 
   async _loadHasManyReflection (args, queryArgs = {}) {
-    if (args.reflectionName in this.relationshipsCache) {
+    if (args.reflectionName in this.relationships) {
+      return this.relationships[args.reflectionName]
+    } else if (args.reflectionName in this.relationshipsCache) {
       return this.relationshipsCache[args.reflectionName]
     }
 
@@ -830,7 +853,9 @@ export default class BaseModel {
   }
 
   async _loadHasOneReflection (args, queryArgs = {}) {
-    if (args.reflectionName in this.relationshipsCache) {
+    if (args.reflectionName in this.relationships) {
+      return this.relationships[args.reflectionName]
+    } else if (args.reflectionName in this.relationshipsCache) {
       return this.relationshipsCache[args.reflectionName]
     } else {
       const collection = new Collection(args, queryArgs)
@@ -843,17 +868,20 @@ export default class BaseModel {
   }
 
   _readHasOneReflection ({reflectionName}) {
-    if (!(reflectionName in this.relationshipsCache)) {
-      if (this.isNewRecord())
-        return null
-
-      const loadedRelationships = Object.keys(this.relationshipsCache)
-      const modelClassName = digg(this.modelClassData(), "name")
+    if (reflectionName in this.relationships) {
+      return this.relationships[reflectionName]
+    } else if (reflectionName in this.relationshipsCache) {
+      return this.relationshipsCache[reflectionName]
+    }
 
-      throw new NotLoadedError(`${modelClassName}#${reflectionName} hasn't been loaded yet. Only these were loaded: ${loadedRelationships.join(", ")}`)
+    if (this.isNewRecord()) {
+      return null
     }
 
-    return this.relationshipsCache[reflectionName]
+    const loadedRelationships = Object.keys(this.relationshipsCache)
+    const modelClassName = digg(this.modelClassData(), "name")
+
+    throw new NotLoadedError(`${modelClassName}#${reflectionName} hasn't been loaded yet. Only these were loaded: ${loadedRelationships.join(", ")}`)
   }
 
   _readModelDataFromArgs (args) {
@@ -893,19 +921,22 @@ export default class BaseModel {
 
       if (!relationshipData) {
         this.relationshipsCache[relationshipName] = null
+        this.relationships[relationshipName] = null
       } else if (Array.isArray(relationshipData)) {
-        const result = []
+        this.relationshipsCache[relationshipName] = []
+        this.relationships[relationshipName] = []
 
         for (const relationshipId of relationshipData) {
           const model = preloaded.getModel(relationshipType, relationshipId)
 
-          result.push(model)
+          this.relationshipsCache[relationshipName].push(model)
+          this.relationships[relationshipName].push(model)
         }
-
-        this.relationshipsCache[relationshipName] = result
       } else {
         const model = preloaded.getModel(relationshipType, relationshipData)
+
         this.relationshipsCache[relationshipName] = model
+        this.relationships[relationshipName] = model
       }
     }
   }

package/src/cache-key-generator.mjs

@@ -0,0 +1,65 @@
+import SparkMD5 from "spark-md5"
+
+export default class CacheKeyGenerator {
+  constructor(model) {
+    this.allModels = [model]
+    this.readModels = {}
+    this.recordModelType(model.modelClassData().name)
+    this.recordModel(model.modelClassData().name, model)
+    this.fillModels(model)
+  }
+
+  recordModelType(relationshipType) {
+    if (!(relationshipType in this.readModels)) {
+      this.readModels[relationshipType] = {}
+    }
+  }
+
+  recordModel(relationshipType, model) {
+    this.allModels.push(model)
+    this.readModels[relationshipType][model.id() || model.uniqueKey()] = true
+  }
+
+  isModelRecorded(relationshipType, model) {
+    if (model.id() in this.readModels[relationshipType]) {
+      return true
+    }
+  }
+
+  fillModels(model) {
+    for (const relationshipType in model.relationships) {
+      this.recordModelType(relationshipType)
+
+      for (const anotherModel of model.relationships[relationshipType]) {
+        if (this.isModelRecorded(relationshipType, anotherModel)) {
+          continue
+        }
+
+        this.recordModel(relationshipType, anotherModel)
+        this.fillModels(anotherModel)
+      }
+    }
+  }
+
+  cacheKey() {
+    const md5 = new SparkMD5()
+
+    for (const model of this.allModels) {
+      md5.append("-model-")
+      md5.append(model.modelClassData().name)
+      md5.append("-unique-key-")
+      md5.append(model.id() || model.uniqueKey())
+      md5.append("-attributes-")
+
+      const attributes = model.attributes()
+
+      for (const attributeName in attributes) {
+        md5.append(attributeName)
+        md5.append("-attribute-")
+        md5.append(`${model.readAttributeUnderscore(attributeName)}`)
+      }
+    }
+
+    return md5.end()
+  }
+}

package/src/collection.mjs

@@ -87,7 +87,7 @@ export default class ApiMakerCollection {
     return this._merge({limit: amount})
   }
 
-  loaded () {
+  preloaded () {
     if (!(this.args.reflectionName in this.args.model.relationshipsCache)) {
       throw new Error(`${this.args.reflectionName} hasnt been loaded yet`)
     }
@@ -95,6 +95,35 @@ export default class ApiMakerCollection {
     return this.args.model.relationshipsCache[this.args.reflectionName]
   }
 
+  loaded () {
+    if (this.args.reflectionName in this.args.model.relationships) {
+      return this.args.model.relationships[this.args.reflectionName]
+    } else if (this.args.reflectionName in this.args.model.relationshipsCache) {
+      return this.args.model.relationshipsCache[this.args.reflectionName]
+    } else {
+      throw new Error(`${this.args.reflectionName} hasnt been loaded yet`)
+    }
+  }
+
+  // Replaces the relationships with the given new collection.
+  set(newCollection) {
+    this.args.model.relationships[this.args.reflectionName] = newCollection
+  }
+
+  // Pushes another model onto the given collection.
+  push(newModel) {
+    if (!(this.args.reflectionName in this.args.model.relationships)) {
+      this.args.model.relationships[this.args.reflectionName] = []
+    }
+
+    this.args.model.relationships[this.args.reflectionName].push(newModel)
+  }
+
+  // Array shortcuts
+  find = (...args) => this.loaded().find(...args)
+  forEach = (...args) => this.loaded().forEach(...args)
+  map = (...args) => this.loaded().map(...args)
+
   preload (preloadValue) {
     return this._merge({preload: preloadValue})
   }

package/src/table/filters/filter-form.jsx

@@ -60,7 +60,6 @@ class ReflectionElement extends React.PureComponent {
         className="reflection-element"
         data-model-class={currentModelClass.modelClassData().name}
         data-reflection-name={reflection.name()}
-        key={reflection.name()}
         onClick={digg(this, "onReflectionClicked")}
       >
         {currentModelClass.humanAttributeName(reflection.name())}
@@ -75,6 +74,42 @@ class ReflectionElement extends React.PureComponent {
   }
 }
 
+class ScopeElement extends React.PureComponent {
+  static defaultProps = {
+    active: false
+  }
+
+  static propTypes = {
+    active: PropTypes.bool.isRequired,
+    scope: PropTypes.object.isRequired
+  }
+
+  render() {
+    const {active, scope} = this.props
+    const style = {}
+
+    if (active) style.fontWeight = "bold"
+
+    return (
+      <div
+        className="scope-element"
+        key={scope.name()}
+        onClick={digg(this, "onScopeClicked")}
+        style={style}
+      >
+        {scope.name()}
+      </div>
+    )
+  }
+
+  onScopeClicked = (e) => {
+    e.preventDefault()
+
+    this.props.onScopeClicked({scope: this.props.scope})
+  }
+}
+
+
 export default class ApiMakerTableFiltersFilterForm extends React.PureComponent {
   static propTypes = PropTypesExact({
     filter: PropTypes.object,
@@ -88,6 +123,7 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
     path: this.props.filter.p || [],
     predicate: undefined,
     predicates: undefined,
+    scope: this.props.filter.sc,
     value: this.props.filter.v
   })
   valueInputRef = React.createRef()
@@ -114,7 +150,14 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
   render() {
     const {valueInputRef} = digs(this, "valueInputRef")
     const currentModelClass = this.currentModelClass()
-    const {attribute, predicate, predicates, value} = digs(this.shape, "attribute", "predicate", "predicates", "value")
+    const {attribute, predicate, predicates, scope, value} = digs(this.shape, "attribute", "predicate", "scope", "predicates", "value")
+    let submitEnabled = false
+
+    if (attribute && predicate) {
+      submitEnabled = true
+    } else if (scope) {
+      submitEnabled = true
+    }
 
     return (
       <div className="api-maker--table--filters--filter-form">
@@ -153,13 +196,16 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
                 />
               )}
               {currentModelClass.ransackableScopes().map((scope) =>
-                <div key={scope.name()}>
-                  {scope.name()}
-                </div>
+                <ScopeElement
+                  active={scope.name() == this.shape.scope?.name()}
+                  key={scope.name()}
+                  scope={scope}
+                  onScopeClicked={digg(this, "onScopeClicked")}
+                />
               )}
             </div>
             <div>
-              {predicates &&
+              {predicates && !this.shape.scope &&
                 <Select
                   className="predicate-select"
                   defaultValue={predicate?.name}
@@ -170,13 +216,13 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
               }
             </div>
             <div>
-              {attribute && predicate &&
+              {((attribute && predicate) || scope) &&
                 <Input className="value-input" defaultValue={value} inputRef={valueInputRef} />
               }
             </div>
           </div>
           <div>
-            <button className="apply-filter-button" disabled={!attribute || !predicate}>
+            <button className="apply-filter-button" disabled={!submitEnabled}>
               {I18n.t("js.api_maker.table.filters.relationship_select.apply", {defaultValue: "Apply"})}
             </button>
           </div>
@@ -238,7 +284,11 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
   }
 
   onAttributeClicked = ({attribute}) => {
-    this.shape.set({attribute})
+    this.shape.set({
+      attribute,
+      predicate: undefined,
+      scope: undefined
+    })
   }
 
   onPredicateChanged = (e) => {
@@ -253,27 +303,45 @@ export default class ApiMakerTableFiltersFilterForm extends React.PureComponent
 
     this.shape.set({
       attribute: undefined,
-      path: newPath
+      path: newPath,
+      predicate: undefined
     })
 
     this.props.onPathChanged
   }
 
+  onScopeClicked = ({scope}) => {
+    this.shape.set({
+      attribute: undefined,
+      scope
+    })
+  }
+
   onSubmit = (e) => {
     e.preventDefault()
 
     const {filter, querySearchName} = digs(this.props, "filter", "querySearchName")
-    const {attribute, path, predicate} = digs(this.shape, "attribute", "path", "predicate")
+    const {attribute, path, predicate, scope} = digs(this.shape, "attribute", "path", "predicate", "scope")
     const {filterIndex} = digs(filter, "filterIndex")
     const searchParams = Params.parse()[querySearchName] || {}
     const value = digg(this, "valueInputRef", "current", "value")
-
-    searchParams[filterIndex] = JSON.stringify({
-      a: attribute.name(),
+    const newSearchParams = {
       p: path,
-      pre: digg(predicate, "name"),
       v: value
-    })
+    }
+
+    if (attribute) {
+      newSearchParams.a = attribute.name()
+      newSearchParams.pre = digg(predicate, "name")
+    } else if (scope) {
+      newSearchParams.sc = inflection.underscore(scope.name())
+    } else {
+      throw new Error("Dont know if should search for attribute or scope?")
+    }
+
+    console.log({newSearchParams})
+
+    searchParams[filterIndex] = JSON.stringify(newSearchParams)
 
     const newParams = {}
 

package/src/table/filters/index.jsx

@@ -17,7 +17,8 @@ class ApiMakerTableFilter extends React.PureComponent {
   }
 
   render() {
-    const {a, p, pre, v} = digs(this.props, "a", "p", "pre", "v")
+    const {p, v} = digs(this.props, "p", "v")
+    const {a, pre, sc} = this.props
 
     return (
       <div style={{display: "inline-block", backgroundColor: "grey", padding: "10px 6px"}}>
@@ -25,7 +26,7 @@ class ApiMakerTableFilter extends React.PureComponent {
           {p.length > 0 &&
             `${p.join(".")}.`
           }
-          {a} {pre} {v}
+          {a} {sc} {pre} {v}
         </span>
         <span>
           <a className="remove-filter-button" href="#" onClick={digg(this, "onRemoveFilterClicked")}>