Rename to YieldStructure to avoid certain overzealous transpilers

TotalTechGeek · TotalTechGeek · commit 7bb4f832f260 · 2022-12-19T20:01:32.000-06:00
diff --git a/async.test.js b/async.test.js
@@ -1,5 +1,5 @@
 import { AsyncLogicEngine } from './index.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 
 const modes = [
@@ -780,7 +780,7 @@ modes.forEach((logic) => {
 
             if (engine.allowFunctions || typeof context[key] !== 'function') {
               if (!(key in context)) {
-                return new Yield({
+                return new YieldStructure({
                   message: 'Data does not exist in context.'
                 })
               }
diff --git a/asyncLogic.js b/asyncLogic.js
@@ -3,7 +3,7 @@
 
 import checkYield from './utilities/checkYield.js'
 import defaultMethods from './defaultMethods.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 import LogicEngine from './logic.js'
 import asyncPool from './asyncPool.js'
@@ -152,7 +152,7 @@ class AsyncLogicEngine {
       const result = await this._parse(func, logic[func], data, above)
 
       if (this.options.yieldSupported && (await checkYield(result))) {
-        if (result instanceof Yield) {
+        if (result instanceof YieldStructure) {
           if (result._input) {
             result._logic = { [func]: result._input }
           }
diff --git a/compiler.js b/compiler.js
@@ -6,7 +6,7 @@ import {
   // Override is required for the compiler to operate as intended.
   Override
 } from './constants.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import declareSync from './utilities/declareSync.js'
 
 // asyncIterators is required for the compiler to operate as intended.
@@ -115,7 +115,7 @@ function r (func, input, name, resumable) {
     ? func(resumable[name + '_input'])
     : func(typeof input === 'function' ? input() : input)
 
-  if (result instanceof Yield) {
+  if (result instanceof YieldStructure) {
     if (result._input) {
       resumable[name + '_input'] = result._input
     }
@@ -145,7 +145,7 @@ async function rAsync (func, input, name, resumable) {
     ? await func(resumable[name + '_input'])
     : await func(typeof input === 'function' ? await input() : input)
 
-  if (result instanceof Yield) {
+  if (result instanceof YieldStructure) {
     if (result._input) {
       resumable[name + '_input'] = result._input
     }
diff --git a/index.js b/index.js
@@ -4,7 +4,7 @@
 import LogicEngine from './logic.js'
 import AsyncLogicEngine from './asyncLogic.js'
 import Compiler from './compiler.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 import Constants from './constants.js'
 import defaultMethods from './defaultMethods.js'
@@ -13,11 +13,11 @@ import { asLogicSync, asLogicAsync } from './asLogic.js'
 export { LogicEngine }
 export { AsyncLogicEngine }
 export { Compiler }
-export { Yield }
+export { YieldStructure }
 export { EngineObject }
 export { Constants }
 export { defaultMethods }
 export { asLogicSync }
 export { asLogicAsync }
 
-export default { LogicEngine, AsyncLogicEngine, Compiler, Yield, EngineObject, Constants, defaultMethods, asLogicSync, asLogicAsync }
+export default { LogicEngine, AsyncLogicEngine, Compiler, YieldStructure, EngineObject, Constants, defaultMethods, asLogicSync, asLogicAsync }
diff --git a/logic.js b/logic.js
@@ -3,7 +3,7 @@
 
 import checkYield from './utilities/checkYield.js'
 import defaultMethods from './defaultMethods.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 import { build } from './compiler.js'
 import declareSync from './utilities/declareSync.js'
@@ -114,7 +114,7 @@ class LogicEngine {
       const [func] = Object.keys(logic)
       const result = this._parse(func, logic[func], data, above)
       if (this.options.yieldSupported && checkYield(result)) {
-        if (result instanceof Yield) {
+        if (result instanceof YieldStructure) {
           if (result._input) {
             result._logic = { [func]: result._input }
           }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "json-logic-engine",
-  "version": "1.1.22",
+  "version": "1.2.0",
   "description": "Construct complex rules with JSON & process them.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
diff --git a/structures/EngineObject.js b/structures/EngineObject.js
@@ -2,10 +2,10 @@
 'use strict'
 
 import traverseCopy from '../utilities/traverseCopy.js'
-import Yield from './Yield.js'
+import YieldStructure from './Yield.js'
 
 function fetchYields (obj, arr = []) {
-  if (obj instanceof Yield) {
+  if (obj instanceof YieldStructure) {
     arr.push(obj)
     return arr
   }
@@ -33,12 +33,12 @@ class EngineObject {
       {},
       {
         mutateValue: (i) => {
-          if (i instanceof Yield) {
+          if (i instanceof YieldStructure) {
             return i.logic()
           }
           return i
         },
-        skipCopy: (i) => i instanceof Yield
+        skipCopy: (i) => i instanceof YieldStructure
       }
     )
   }
diff --git a/structures/ReduceIterator.js b/structures/ReduceIterator.js
@@ -1,7 +1,7 @@
 // @ts-check
 'use strict'
 
-import Yield from './Yield.js'
+import YieldStructure from './Yield.js'
 import EngineObject from './EngineObject.js'
 
 // works fine for arrays, may need to create a more general version though
@@ -19,7 +19,7 @@ class ReduceIterator {
     const item = this.arr[this.position]
     this._position = this.position
     const cur = this.nextCall(this.cur, item, this.arr, this)
-    if (cur instanceof Yield || cur instanceof EngineObject) {
+    if (cur instanceof YieldStructure || cur instanceof EngineObject) {
       return cur
     }
     // commit
@@ -54,7 +54,7 @@ class AsyncReduceIterator extends ReduceIterator {
     const item = this.arr[this.position]
     this._position = this.position
     const cur = await this.nextCall(this.cur, item, this.arr, this)
-    if (cur instanceof Yield || cur instanceof EngineObject) {
+    if (cur instanceof YieldStructure || cur instanceof EngineObject) {
       return cur
     }
     // commit
diff --git a/structures/Yield.js b/structures/Yield.js
@@ -3,7 +3,7 @@
 /**
  * A class that handles the Yielding logic & helps generate replacement logic.
  */
-class Yield {
+class YieldStructure {
   constructor (data) {
     this._logic = null
     this.resumable = null
@@ -18,4 +18,4 @@ class Yield {
     return this._logic
   }
 }
-export default Yield
+export default YieldStructure
diff --git a/test.js b/test.js
@@ -1,5 +1,5 @@
 import { LogicEngine } from './index.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 
 const modes = [
@@ -856,7 +856,7 @@ modes.forEach((logic) => {
           }
           if (engine.allowFunctions || typeof context[key] !== 'function') {
             if (!(key in context)) {
-              return new Yield({
+              return new YieldStructure({
                 message: 'Data does not exist in context.'
               })
             }
diff --git a/utilities/checkYield.js b/utilities/checkYield.js
@@ -1,18 +1,18 @@
 // @ts-check
 'use strict'
 
-import Yield from '../structures/Yield.js'
+import YieldStructure from '../structures/Yield.js'
 import EngineObject from '../structures/EngineObject.js'
 
 /**
- * Checks if the item that's passed in is or contains a Yield / EngineObject (signifying a Yield)
+ * Checks if the item that's passed in is or contains a YieldStructure / EngineObject (signifying a YieldStructure)
  * @param {*} item
  * @returns {Boolean}
  */
 function checkYield (item) {
   if (Array.isArray(item)) {
-    return item.some((i) => i instanceof Yield || i instanceof EngineObject)
+    return item.some((i) => i instanceof YieldStructure || i instanceof EngineObject)
   }
-  return item instanceof Yield || item instanceof EngineObject
+  return item instanceof YieldStructure || item instanceof EngineObject
 }
 export default checkYield
diff --git a/yieldingIterators.js b/yieldingIterators.js
@@ -5,7 +5,7 @@ import {
   ReduceIterator,
   AsyncReduceIterator
 } from './structures/ReduceIterator.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import checkYield from './utilities/checkYield.js'
 import { isSync } from './constants.js'
 import declareSync from './utilities/declareSync.js'
@@ -47,7 +47,7 @@ function createYieldingControl (name, method, asyncMethod) {
       while (!iter.done()) {
         const cur = iter.next()
         if (checkYield(cur)) {
-          return new Yield({
+          return new YieldStructure({
             yield: cur,
             _name: name,
             _input: iter.state()
@@ -68,7 +68,7 @@ function createYieldingControl (name, method, asyncMethod) {
       while (!iter.done()) {
         const cur = await iter.next()
         if (checkYield(cur)) {
-          return new Yield({
+          return new YieldStructure({
             yield: cur,
             _name: name,
             _input: iter.state()
@@ -302,7 +302,7 @@ function createArrayIterativeMethod (
           }) || []
         if (checkYield(selected)) {
           // todo: add extraction of the existing yields.
-          return new Yield({
+          return new YieldStructure({
             _input: [selector, mapper, defaultValue],
             _name: name,
             yields: selected.yields()
@@ -322,7 +322,7 @@ function createArrayIterativeMethod (
       while (!iter.done()) {
         const cur = iter.next()
         if (checkYield(cur)) {
-          return new Yield({
+          return new YieldStructure({
             yields: cur.yields(),
             _name: name,
             _input: {
@@ -350,7 +350,7 @@ function createArrayIterativeMethod (
           })) || []
         if (checkYield(selected)) {
           // todo: add extraction of the existing yields.
-          return new Yield({
+          return new YieldStructure({
             _name: name,
             _input: [selector, mapper, defaultValue],
             yields: selected.yields()
@@ -370,7 +370,7 @@ function createArrayIterativeMethod (
       while (!iter.done()) {
         const cur = await iter.next()
         if (checkYield(cur)) {
-          return new Yield({
+          return new YieldStructure({
             yields: cur.yields(),
             _name: name,
             _input: {
diff --git a/yieldingIterators.test.js b/yieldingIterators.test.js
@@ -1,5 +1,5 @@
 import { LogicEngine, AsyncLogicEngine } from './index.js'
-import Yield from './structures/Yield.js'
+import YieldStructure from './structures/Yield.js'
 import EngineObject from './structures/EngineObject.js'
 import { Override } from './constants.js'
 
@@ -25,12 +25,12 @@ const yieldVar = (key, context, above, engine) => {
   const subProps = String(key).split('.')
   for (let i = 0; i < subProps.length; i++) {
     if (context === null || context === undefined) {
-      return new Yield({ message: 'Data is not found.' })
+      return new YieldStructure({ message: 'Data is not found.' })
     }
     // Descending into context
     context = context[subProps[i]]
     if (context === undefined) {
-      return new Yield({ message: 'Data is not found.' })
+      return new YieldStructure({ message: 'Data is not found.' })
     }
   }
   if (engine.allowFunctions || typeof context[key] !== 'function') {
@@ -57,7 +57,7 @@ describe('Sync Yielding Iterator Test', () => {
       someYield: [[{ yieldVar: 'a' }, false, false], { var: '' }]
     }
     const instance = sync.run(script2)
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(sync.run(instance.logic(), { a: 10 })).toBe(10)
@@ -91,7 +91,7 @@ describe('Sync Yielding Iterator Test', () => {
       everyYield: [[true, true, { yieldVar: 'a' }], { var: '' }]
     }
     const instance = sync.run(script2)
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(sync.run(instance.logic(), { a: false })).toBe(false)
@@ -271,7 +271,7 @@ describe('iterators', () => {
         data: 1
       }
     )
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(sync.run(instance.logic(), { data: 1, x: 4 })).toStrictEqual([
@@ -303,7 +303,7 @@ describe('iterators', () => {
         data: 1
       }
     )
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(sync.run(instance.logic(), { data: 0.5, x: 0.5 })).toStrictEqual([
@@ -322,7 +322,7 @@ describe('Async Yielding Iterator Test', () => {
       someYield: [[{ yieldVar: 'a' }, false, false], { var: '' }]
     }
     const instance = await nosync.run(script2)
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(await nosync.run(instance.logic(), { a: 10 })).toBe(10)
@@ -356,7 +356,7 @@ describe('Async Yielding Iterator Test', () => {
       everyYield: [[true, true, { yieldVar: 'a' }], { var: '' }]
     }
     const instance = await nosync.run(script2)
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(await nosync.run(instance.logic(), { a: false })).toBe(false)
@@ -536,7 +536,7 @@ describe('iterators', () => {
         data: 1
       }
     )
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(await nosync.run(instance.logic(), { data: 1, x: 4 })).toStrictEqual(
@@ -568,7 +568,7 @@ describe('iterators', () => {
         data: 1
       }
     )
-    expect(instance instanceof EngineObject || instance instanceof Yield).toBe(
+    expect(instance instanceof EngineObject || instance instanceof YieldStructure).toBe(
       true
     )
     expect(
@@ -578,7 +578,7 @@ describe('iterators', () => {
 })
 
 describe('Test of multi-step yield', () => {
-  test('multi-step yield array', () => {
+  test('multi-step YieldStructure array', () => {
     const testFunction = sync.build([{ yieldVar: 'a' }, { yieldVar: 'b' }])
     try {
       testFunction({})

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "json-logic-engine",`
`3`		`- "version": "1.1.22",`
	`3`	`+ "version": "1.2.0",`
`4`	`4`	`"description": "Construct complex rules with JSON & process them.",`
`5`	`5`	`"main": "./dist/cjs/index.js",`
`6`	`6`	`"module": "./dist/esm/index.js",`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,10 @@`
`2`	`2`	`'use strict'`
`3`	`3`
`4`	`4`	`import traverseCopy from '../utilities/traverseCopy.js'`
`5`		`-import Yield from './Yield.js'`
	`5`	`+import YieldStructure from './Yield.js'`
`6`	`6`
`7`	`7`	`function fetchYields (obj, arr = []) {`
`8`		`- if (obj instanceof Yield) {`
	`8`	`+ if (obj instanceof YieldStructure) {`
`9`	`9`	`arr.push(obj)`
`10`	`10`	`return arr`
`11`	`11`	`}`
`@@ -33,12 +33,12 @@ class EngineObject {`
`33`	`33`	`{},`
`34`	`34`	`{`
`35`	`35`	`mutateValue: (i) => {`
`36`		`- if (i instanceof Yield) {`
	`36`	`+ if (i instanceof YieldStructure) {`
`37`	`37`	`return i.logic()`
`38`	`38`	`}`
`39`	`39`	`return i`
`40`	`40`	`},`
`41`		`- skipCopy: (i) => i instanceof Yield`
	`41`	`+ skipCopy: (i) => i instanceof YieldStructure`
`42`	`42`	`}`
`43`	`43`	`)`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* A class that handles the Yielding logic & helps generate replacement logic.`
`5`	`5`	`*/`
`6`		`-class Yield {`
	`6`	`+class YieldStructure {`
`7`	`7`	`constructor (data) {`
`8`	`8`	`this._logic = null`
`9`	`9`	`this.resumable = null`
`@@ -18,4 +18,4 @@ class Yield {`
`18`	`18`	`return this._logic`
`19`	`19`	`}`
`20`	`20`	`}`
`21`		`-export default Yield`
	`21`	`+export default YieldStructure`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import { LogicEngine } from './index.js'`
`2`		`-import Yield from './structures/Yield.js'`
	`2`	`+import YieldStructure from './structures/Yield.js'`
`3`	`3`	`import EngineObject from './structures/EngineObject.js'`
`4`	`4`
`5`	`5`	`const modes = [`
`@@ -856,7 +856,7 @@ modes.forEach((logic) => {`
`856`	`856`	`}`
`857`	`857`	`if (engine.allowFunctions \|\| typeof context[key] !== 'function') {`
`858`	`858`	`if (!(key in context)) {`
`859`		`- return new Yield({`
	`859`	`+ return new YieldStructure({`
`860`	`860`	`message: 'Data does not exist in context.'`
`861`	`861`	`})`
`862`	`862`	`}`