- Reldens - Modifiers

- Merge pull request #19 from damian-pastorini/v0.19.1
damian-pastorini · Jun 15, 2023 · ad828de · ad828de
2 parents a19dbb1 + dd984da
commit ad828de
Show file tree

Hide file tree

Showing 7 changed files with 112 additions and 31 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,3 @@
 /ts-node*
 /v8-compile-cache*
 /dev
-package-lock.json
diff --git a/lib/condition.js b/lib/condition.js
@@ -51,7 +51,7 @@ class Condition
 
     isValidOn(targetObject, overrideVal)
     {
-        if(!sc.isFunction(this, this.conditional)){
+        if(!sc.isObjectFunction(this, this.conditional)){
             ErrorManager.error('Condition operation is not a function.');
         }
         let value = overrideVal || this.value;

diff --git a/lib/constants.js b/lib/constants.js
@@ -28,6 +28,15 @@ module.exports = {
         INT: 'int',
         STRING: 'string'
     },
+    MOD_MISSING_KEY: 'mk',
+    MOD_MISSING_PROPERTY_KEY: 'mpk',
+    MOD_MISSING_OPERATION: 'mo',
+    MOD_MISSING_VALUE: 'mv',
+    MOD_READY: 'mre',
     MOD_APPLIED: 'ma',
-    MOD_REVERTED: 'mr'
+    MOD_REVERTED: 'mr',
+    MOD_UNDEFINED_TARGET: 'mut',
+    MOD_INVALID_CONDITIONS: 'mic',
+    MOD_MISSING_CONDITION_INSTANCE: 'mmci',
+    MOD_MODIFIER_ERROR: 'me',
 };
diff --git a/lib/modifier.js b/lib/modifier.js
@@ -4,28 +4,17 @@
  *
  */
 
-const { ErrorManager, sc } = require('@reldens/utils');
 const Calculator = require('./calculator');
 const Condition = require('./condition');
 const PropertyManager = require('./property-manager');
 const ModifierConst = require('./constants');
+const { Logger, sc } = require('@reldens/utils');
 
 class Modifier
 {
 
     constructor(props)
     {
-        if(
-            !sc.hasOwn(props, 'key')
-            || (!sc.hasOwn(props, 'propertyKey') && !sc.hasOwn(props, 'property_key'))
-            || !sc.hasOwn(props, 'operation')
-            || !sc.hasOwn(props, 'value')
-        ){
-            ErrorManager.error([
-                'Undefined required properties {key, propertyKey (property_key), operation, value} in:',
-                props
-            ]);
-        }
         this.key = props.key;
         this.propertyKey = sc.get(props, 'propertyKey', props.property_key);
         this.basePropertyKey = sc.get(props, 'basePropertyKey', this.propertyKey);
@@ -38,14 +27,30 @@ class Modifier
         this.maxValue = sc.hasOwn(props, 'maxValue') ? this.parseValue(props.maxValue) : false;
         this.minProperty = sc.get(props, 'minProperty', false);
         this.maxProperty = sc.get(props, 'maxProperty', false);
-        // array of conditions objects:
         this.conditions = sc.get(props, 'conditions', []);
         this.conditionsOnRevert = sc.get(props, 'conditionsOnRevert', false);
-        this.state = false;
+        this.state = this.determineState(props);
         this.calculator = new Calculator();
         this.propertyManager = new PropertyManager();
     }
 
+    determineState(props)
+    {
+        if(!sc.hasOwn(props, 'key')){
+            return ModifierConst.MOD_MISSING_KEY;
+        }
+        if(!sc.hasOwn(props, 'propertyKey') && !sc.hasOwn(props, 'property_key')){
+            return ModifierConst.MOD_MISSING_PROPERTY_KEY;
+        }
+        if(!sc.hasOwn(props, 'operation')){
+            return ModifierConst.MOD_MISSING_OPERATION;
+        }
+        if(!sc.hasOwn(props, 'value')){
+            return ModifierConst.MOD_MISSING_VALUE;
+        }
+        return ModifierConst.MOD_READY;
+    }
+
     parseValue(value)
     {
         if(this.type === ModifierConst.TYPES.INT){
@@ -59,12 +64,12 @@ class Modifier
 
     apply(target, useBasePropertyToGetValue, applyOnBaseProperty)
     {
-        this.execute(target, false, useBasePropertyToGetValue, applyOnBaseProperty);
+        return this.execute(target, false, useBasePropertyToGetValue, applyOnBaseProperty);
     }
 
     revert(target, useBasePropertyToGetValue, applyOnBaseProperty)
     {
-        this.execute(target, true, useBasePropertyToGetValue, applyOnBaseProperty);
+        return this.execute(target, true, useBasePropertyToGetValue, applyOnBaseProperty);
     }
 
     /**
@@ -78,16 +83,16 @@ class Modifier
      */
     execute(target, revert = false, useBasePropertyToGetValue = false, applyOnBaseProperty = false)
     {
-        // return error if target is not present at all:
         if(!this.target && !target){
-            ErrorManager.error('Undefined target.');
+            this.state = ModifierConst.MOD_UNDEFINED_TARGET;
+            return false;
         }
         if(
             this.conditions.length
             && !this.validateConditions(target)
             && (!revert || (revert && this.conditionsOnRevert))
         ){
-            // conditions not satisfied:
+            // invalid conditions:
             return false;
         }
         // override target if provided:
@@ -99,15 +104,19 @@ class Modifier
         let applyToProp = applyOnBaseProperty ? this.basePropertyKey : this.propertyKey;
         this.setOwnerProperty(applyToProp, newValue);
         this.state = revert ? ModifierConst.MOD_REVERTED : ModifierConst.MOD_APPLIED;
+        return true;
     }
 
     validateConditions(target)
     {
         for(let condition of this.conditions){
             if(condition instanceof Condition){
-                ErrorManager.error(['Missing Condition instance.', (typeof condition), 'was specified.']);
+                Logger.error(['Missing Condition instance.', (typeof condition), 'was specified.']);
+                this.state = ModifierConst.MOD_MISSING_CONDITION_INSTANCE;
+                return false;
             }
             if(!condition.isValidOn(target)){
+                this.state = ModifierConst.MOD_INVALID_CONDITIONS;
                 return false;
             }
         }
@@ -128,7 +137,9 @@ class Modifier
         if(this.operation === ModifierConst.OPS.METHOD){
             // this allows you to extend a modifier and set your own calculation/application method:
             if(!sc.hasOwn(this, this.value) || typeof this[this.value] !== 'function'){
-                ErrorManager.error(['Modifier error:', this, 'Undefined method:', this.value]);
+                Logger.error(['Modifier error:', this, 'Undefined method:', this.value]);
+                this.state = ModifierConst.MOD_MODIFIER_ERROR;
+                return false;
             }
             propertyValue = this[this.value](this, propertyValue);
         }

diff --git a/lib/property-manager.js b/lib/property-manager.js
@@ -4,7 +4,7 @@
  *
  */
 
-const { ErrorManager, sc } = require('@reldens/utils');
+const { ErrorManager, Logger, sc } = require('@reldens/utils');
 
 class PropertyManager
 {
@@ -35,10 +35,9 @@ class PropertyManager
     {
         let propertyName = propertyPathParts.shift();
         if(!sc.hasOwn(propertyOwner, propertyName)){
-            ErrorManager.error([
-                'Property not found in path:', propertyName,
-                'Property owner:', propertyOwner
-            ]);
+            let message = 'Property "'+propertyName+'" not found in path parts: [' + propertyPathParts.join(',') + ']';
+            Logger.error(message, {'Property owner': propertyOwner});
+            ErrorManager.error(message);
         }
         if(1 < propertyPathParts.length){
             return this.extractDeepProperty(propertyOwner[propertyName], propertyPathParts);

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@reldens/modifiers",
     "scope": "@reldens",
-    "version": "0.17.0",
+    "version": "0.19.1",
     "description": "Reldens - Modifiers",
     "author": "Damian A. Pastorini",
     "license": "MIT",
@@ -33,6 +33,6 @@
         "url": "https://github.com/damian-pastorini/reldens-modifiers/issues"
     },
     "dependencies": {
-        "@reldens/utils": "^0.16.0"
+        "@reldens/utils": "^0.20.0"
     }
 }