queueobj 12.0.18 → 13.0.0

package/lib/appenders/base.js

@@ -1,8 +1,7 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2017-10-01
+* @since 2023-02-06
 * lib/appenders/base.js
-* jrm debug 8/4 https://www.npmjs.com/package/temporary-stamp
 */
 
 var colors = require('colors')
@@ -74,7 +73,7 @@ class process_all_obj {
                         t.parent.results_array.push(obj_props)
                         t.continueProcessing()
                     } catch (e) {
-                        t.parent.getParent().logMsg(`pro obj error: (${e.message})`.red)
+                        t.parent.getParent().logMsg({msg: `pro obj error: (${e.message})`.error, type: "error"})
                         throw e
                     }
                 })
@@ -151,7 +150,7 @@ exports = module.exports = class base {
         if (t.getParent().getStats()) {
             ret_str += `start (${st}) end(${ed}) milliseconds(${ml})`
         }
-        return ret_str   //jrm debug 
+        return ret_str   
     }
 
     process_all () {

package/lib/appenders/bottom_one.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/bottom_one.js
 */
 

package/lib/appenders/func_all.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/func_all.js
 */
 

package/lib/appenders/sync.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/sync.js
 */
 

package/lib/appenders/sync_all.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/sync_all.js
 */
 

package/lib/appenders/top_one.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/top_one.js
 */
 

package/lib/appenders/version.js

@@ -1,6 +1,6 @@
 /*
 * @author Jim Manton: jrman@risebroadband.net
-* @since 2021-03-22
+* @since 2023-2-5
 * lib/appenders/status.js
 */
 

package/package.json

@@ -2,26 +2,45 @@
   "author": {
     "name": "Jim Manton"
   },
-  "version": "12.0.18",
-  "bundleDependencies": false,
+  "version": "13.0.0",
+  "bundleDependencies": [],
   "dependencies": {
+    "@types/node": "^18.11.19",
+    "base-queue": "^1.0.0",
     "chai": "^4.3.7",
-    "colors": "^1.1.4",
+    "colors": "^1.4.0",
     "diffler": "^2.0.4",
-    "mocha": "^10.2.0"
+    "fs": "^0.0.1-security",
+    "log-queue": "^1.0.0",
+    "mocha": "^10.2.0",
+    "queuejson": "^9.0.11",
+    "valid-path": "^2.1.0"
   },
   "scripts": {
     "start": "node app.ts",
     "test": "mocha",
     "ditched": "ditched -a",
-    "test_all": "node ./tests/test_all",
-    "test_bottom_one": "node ./tests/test_bottom_one",
-    "test_func_all": "node ./tests/test_func_all",
-    "test_sync_all": "node ./tests/test_sync_all",
-    "test_status": "node ./tests/test_status",
-    "test_name": "node ./tests/test_name",
-    "test_top_one": "node ./tests/test_top_one",
-    "test_version": "node ./tests/test_version"
+    "test_files": "node ./tests/files",
+    "test_all": "node ./tests/all",
+    "test_top_one": "node ./tests/top_one",
+    "test_bottom_one": "node ./tests/bottom_one",
+    "test_func_all": "node ./tests/func_all",
+    "test_status_matching": "node ./tests/status_matching",
+    "test_status_non_matching": "node ./tests/status_non_matching",
+    "test_name_matching": "node ./tests/name_matching",
+    "test_name_non_matching": "node ./tests/name_non_matching",
+    "test_version_matching": "node ./tests/version_matching",
+    "test_version_non_matching": "node ./tests/version_non_matching",
+    "test_json_all": "node ./tests/json_all",
+    "test_json_top_one": "node ./tests/json_top_one",
+    "test_json_bottom_one": "node ./tests/json_bottom_one",
+    "test_json_func_all": "node ./tests/json_func_all",
+    "test_json_status_matching": "node ./tests/json_status_matching",
+    "test_json_status_non_matching": "node ./tests/json_status_non_matching",
+    "test_json_version_matching": "node ./tests/json_version_matching",
+    "test_json_version_non_matching": "node ./tests/json_version_non_matching",
+    "test_json_name_matching": "node ./tests/json_name_matching",
+    "test_json_name_non_matching": "node ./tests/json_name_non_matching"
   },
   "keywords": [
     "queue",
@@ -33,13 +52,13 @@
     "promises",
     "mocha"
   ],
-  "homepage": "https://github.com/jman717/QueueObj",
+  "homepage": "https://github.com/jman717/queueobj",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jman717/QueueObj.git"
+    "url": "git+https://github.com/jman717/queueobj"
   },
   "deprecated": false,
-  "description": "Queue Objects For Processing",
+  "description": "Queue File Objects",
   "email": "jrman@risebroadband.net",
   "license": "MIT",
   "main": "app.js",

package/test/app.js

@@ -7,71 +7,35 @@ describe('app', function () {
         application = require('../app.js')
         assert(app = new application())
     })
-
-    it('app.process is a function', function () {
-        assert(typeof app.process == 'function')
-    })
-    
-    it('app.getParent is a function', function () {
-        assert(typeof app.getParent == 'function')
-    })
     
-    it('app.getObjectToProcess is a function', function () {
-        assert(typeof app.getObjectToProcess == 'function')
-    })
-        
-    it('app.getObjectById is a function', function () {
-        assert(typeof app.getObjectById == 'function')
-    })
-            
-    it('app.getObjs is a function', function () {
-        assert(typeof app.getObjs == 'function')
-    })
-                
     it('app.logMsg is a function', function () {
         assert(typeof app.logMsg == 'function')
     })
+        
+    it('app.getFileObject is a function', function () {
+        assert(typeof app.getFileObject == 'function')
+    })
 })
 
 describe('require', function () {
-    
-    it('base', function () {
-        assert(require('../lib/appenders/base'))
-    })
 
-    it('colors app', function () {
+    it('colors', function () {
         assert(require('colors'))
     })
 
-    it('all appender', function () {
-        assert(require('../lib/appenders/all'))
+    it('base_queue', function () {
+        assert(require('base-queue'))
     })
 
-    it('func_all appender', function () {
-        assert(require('../lib/appenders/func_all'))
+    it('fs', function () {
+        assert(require('fs'))
     })
-
-    it('top_one appender', function () {
-        assert(require('../lib/appenders/top_one'))
-    })
-
-    it('bottom_one appender', function () {
-        assert(require('../lib/appenders/bottom_one'))
-    })
-
-    it('sync_all appender', function () {
-        assert(require('../lib/appenders/sync_all'))
-    })
-
-    it('name appender', function () {
-        assert(require('../lib/appenders/name'))
-    })
-
-    it('status appender', function () {
-        assert(require('../lib/appenders/status'))
+    
+    it('valid-path', function () {
+        assert(require('valid-path'))
     })
-
-    it('version appender', function () {
-        assert(require('../lib/appenders/version'))
+        
+    it('valid-path', function () {
+        assert(require('log-queue'))
     })
 })

package/test/package.js

@@ -6,26 +6,45 @@ const packageMock = {
   "author": {
     "name": "Jim Manton"
   },
-  "version": "12.0.18",
-  "bundleDependencies": false,
+  "version": "13.0.0",
+  "bundleDependencies": [],
   "dependencies": {
+    "@types/node": "^18.11.19",
+    "base-queue": "^1.0.0",
     "chai": "^4.3.7",
-    "colors": "^1.1.4",
+    "colors": "^1.4.0",
     "diffler": "^2.0.4",
-    "mocha": "^10.2.0"
+    "fs": "^0.0.1-security",
+    "log-queue": "^1.0.0",
+    "mocha": "^10.2.0",
+    "queuejson": "^9.0.11",
+    "valid-path": "^2.1.0"
   },
   "scripts": {
     "start": "node app.ts",
     "test": "mocha",
     "ditched": "ditched -a",
-    "test_all": "node ./tests/test_all",
-    "test_bottom_one": "node ./tests/test_bottom_one",
-    "test_func_all": "node ./tests/test_func_all",
-    "test_sync_all": "node ./tests/test_sync_all",
-    "test_status": "node ./tests/test_status",
-    "test_name": "node ./tests/test_name",
-    "test_top_one": "node ./tests/test_top_one",
-    "test_version": "node ./tests/test_version"
+    "test_files": "node ./tests/files",
+    "test_all": "node ./tests/all",
+    "test_top_one": "node ./tests/top_one",
+    "test_bottom_one": "node ./tests/bottom_one",
+    "test_func_all": "node ./tests/func_all",
+    "test_status_matching": "node ./tests/status_matching",
+    "test_status_non_matching": "node ./tests/status_non_matching",
+    "test_name_matching": "node ./tests/name_matching",
+    "test_name_non_matching": "node ./tests/name_non_matching",
+    "test_version_matching": "node ./tests/version_matching",
+    "test_version_non_matching": "node ./tests/version_non_matching",
+    "test_json_all": "node ./tests/json_all",
+    "test_json_top_one": "node ./tests/json_top_one",
+    "test_json_bottom_one": "node ./tests/json_bottom_one",
+    "test_json_func_all": "node ./tests/json_func_all",
+    "test_json_status_matching": "node ./tests/json_status_matching",
+    "test_json_status_non_matching": "node ./tests/json_status_non_matching",
+    "test_json_version_matching": "node ./tests/json_version_matching",
+    "test_json_version_non_matching": "node ./tests/json_version_non_matching",
+    "test_json_name_matching": "node ./tests/json_name_matching",
+    "test_json_name_non_matching": "node ./tests/json_name_non_matching"
   },
   "keywords": [
     "queue",
@@ -37,13 +56,13 @@ const packageMock = {
     "promises",
     "mocha"
   ],
-  "homepage": "https://github.com/jman717/QueueObj",
+  "homepage": "https://github.com/jman717/queueobj",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/jman717/QueueObj.git"
+    "url": "git+https://github.com/jman717/queueobj"
   },
   "deprecated": false,
-  "description": "Queue Objects For Processing",
+  "description": "Queue File Objects",
   "email": "jrman@risebroadband.net",
   "license": "MIT",
   "main": "app.js",
@@ -51,6 +70,8 @@ const packageMock = {
   "start": "node app.js"
 }
 
+
+
 describe('package.json', function () {
     it('should pass', function () {
       const difference = jsonHasDifferences(packagejson, packageMock)

package/tests/all.js

@@ -0,0 +1,85 @@
+var queue = require("../app.js")
+
+var tst1 = class test1 {
+  constructor(props) {
+    let t = this, fname = "test_all.test1.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_all.test1.process"
+    t.log({ msg: `This object (${fname}) is id (${t.id}). Do stuff here`.bgBrightGreen, type: "info" })
+    callback({ success: { msg: `processing all test1` } })
+  }
+}
+
+var tst2 = class test2 {
+  constructor(props) {
+    let t = this, fname = "test_all.test2.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_all.test2.process"
+    t.log({ msg: `This object (${fname}) is id (${t.id}). Do stuff here`.bgBrightGreen, type: "info" })
+    setTimeout(() => {
+      callback({ success: { msg: `processing all test2` } })
+    }, 4000)
+  }
+}
+
+var tst3 = class test3 {
+  constructor(props) {
+    let t = this, fname = "test_all.test3.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_all.test3.process"
+    t.log({ msg: `This object (${fname}) is id (${t.id}). Do stuff here`.bgBrightGreen, type: "info" })
+    // callback({success: { msg: `processing all test3` }})
+    callback({ error: { msg: `there is some problem thrown here on test3` } })
+  }
+}
+
+var tst4 = class test4 {
+  constructor(props) {
+    let t = this, fname = "test_all.test4.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_all.test4.process"
+    t.log({ msg: `This object (${fname}) is id (${t.id}). Do stuff here`.bgBrightGreen, type: "info" })
+    callback({ success: { msg: `processing all test4` } })
+  }
+}
+
+var qObj = new queue()
+
+qObj.init().process({
+  appender: "all",
+  exclude_logMsg: ["debug"],   /* example ["debug", "info"] */
+  process_objects: [tst1, tst2, tst3, tst4]
+}).then((success) => {
+  qObj.logMsg({ msg: `test success: {msg: "all objects processed with no errors"}`.success.italic.bold, type: "success" })
+}, (error) => {
+  if (typeof error == "string") {
+    qObj.logMsg({ msg: `error: ${error}`.error.italic.bold, type: "error" })
+  } else {
+    let add_s = (error.error_count > 1) ? 's' : ''
+    qObj.logMsg({ msg: `${error.error_count} error${add_s} detected`.error.italic.bold, type: "error" })
+  }
+})

package/tests/appenders/all.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5l
+* lib/appenders/all.js
+*/
+
+var base = require('./base.js')
+
+exports = module.exports = class all extends base{
+	constructor(props) {
+		super(props)
+        var t = this
+		t.aname = 'all'
+		t.pro_types = ['items']
+		return t
+    }
+}

package/tests/appenders/base.js

@@ -0,0 +1,189 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2017-10-01
+* lib/appenders/base.js
+*/
+
+var colors = require('colors')
+
+class process_object {
+    constructor(props) {
+        let t = this
+        t.parent = props.parent
+        t.objs = t.parent.getParent().getObjs()
+        t.status = 'process'
+        t.process_objs_item = 0
+        t.process_props_item = 0
+        t.await_item = 0
+        t.any_errors = false
+
+        t.continueProcessing = t.continueProcessing.bind(t)
+    }
+
+    process = () => {
+        let t = this
+        try {
+            if (t.process_objs_item >= t.objs.length) {
+                if (t.any_errors)
+                    t.setStatus('finish with errors')
+                else
+                    t.setStatus('finish')
+                return
+            }
+            try {
+                let obj, pro, itm
+                try {
+                    obj = t.parent.getParent().getItemToProcess(t.process_objs_item)
+                } catch (e) {
+                    e.message = `base error: (${e.message})`
+                    throw e
+                }
+                try {
+                    pro = (typeof obj == 'function') ? obj : obj.process;
+                } catch (e) {
+                    t.parent.getParent()(`pro error: (${e.message})`.red)
+                    throw e
+                }
+                if (typeof t.parent.pro_props != 'undefined' &&
+                    typeof t.parent.pro_props.property != 'undefined' &&
+                    typeof t.parent.pro_props.items != 'undefined' &&
+                    typeof obj._getProperty == 'function') {
+                    let skip = true
+                    for (let q = 0; q < t.parent.pro_props.items.length; q++) {
+                        itm = t.parent.pro_props.items[q]
+                        if (itm == obj._getProperty(obj)) {
+                            skip = false
+                            break
+                        }
+                    }
+                    if (skip) {
+                        t.continueProcessing()
+                        return
+                    }
+                }
+                t.setStatus('wait')
+                pro((obj_props) => {
+                    try {
+                        if (typeof obj_props != 'undefined' && typeof obj_props.error != 'undefined') {
+                            t.any_errors = true
+                            t.parent.getParent().logMsg(obj_props)
+                        } else {
+                            t.parent.getParent().logMsg(obj_props)
+                        }
+                        t.parent.results_array.push(obj_props)
+                        t.continueProcessing()
+                    } catch (e) {
+                        t.parent.getParent().logMsg({msg: `pro obj error: (${e.message})`.error, type: "error"})
+                        throw e
+                    }
+                })
+            } catch (e) {
+                e.message = `error: ${e.message} `
+                throw e
+            }
+        } catch (e) {
+            e.message = `process_object error: ${e.message} `
+            throw e
+        }
+    }
+
+    continueProcessing = () => {
+        let t = this
+        t.process_objs_item++
+        t.setStatus('process')
+        t.parent.process_all()
+    }
+
+    getStatus = () => {
+        return this.status
+    }
+
+    setStatus = (v) => {
+        this.status = v
+    }
+}
+
+exports = module.exports = class base {
+    constructor(props) {
+        let t = this
+        t.await_array = []
+        t.resolve_array = []
+        t.reject_array = []
+        t.results_array = []
+        t.getParent = props.getParent
+        t.dt_start = null
+        t.dt_end = null
+        t.process_object = null
+        t.pro_props = []
+
+        t.process = t.process.bind(this)
+        t.process_all = t.process_all.bind(this)
+    }
+
+    // await(props) {
+    //     let t = this
+    //     t.await_array.push(props)
+    //     return new Promise((resolve, reject) => {
+    //         t.resolve_array.push(resolve)
+    //         t.reject_array.push(reject)
+    //     });
+    // }
+
+    process(props) {
+        let t = this
+        t.dt_start = new Date(); // start measuring time
+
+        t.pro_props = props
+
+        return new Promise((resolve, reject) => {
+            t.resolve_array.push(resolve)
+            t.reject_array.push(reject)
+            t.process_all()
+        });
+    }
+
+    getStats() {
+        let t = this
+        t.dt_end = new Date();
+        let ret_str = '', st = t.dt_start, ed = t.dt_end, ml = t.dt_end - t.dt_start
+        // ret_str += JSON.stringify(t.results_array)
+        if (t.getParent().getStats()) {
+            ret_str += `start (${st}) end(${ed}) milliseconds(${ml})`
+        }
+        return ret_str   
+    }
+
+    process_all = () => {
+        let t = this, _continue
+        if (t.process_object == null) {
+            t.process_object = new process_object({ parent: t })
+        }
+
+        _continue = false
+        try {
+            switch (t.process_object.getStatus()) {
+                case 'process':
+                    t.process_object.process()
+                    _continue = true
+                    break
+                case 'finish with errors':
+                    t.reject_array[t.reject_array.length - 1](t.getStats())
+                    break
+                case 'finish':
+                    t.resolve_array[t.resolve_array.length - 1](t.getStats())
+                    break
+                case 'wait':
+                    return
+                default:
+                    throw new Error(`status(${t.process_object.getStatus()}) does not exist`)
+            }
+
+            if (_continue)
+                t.process_all()
+        } catch (e) {
+            e.message = `process_all error: ${e.message} `
+            throw e
+        }
+    }
+}
+

package/tests/appenders/bottom_one.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* lib/appenders/bottom_one.js
+*/
+
+var base = require('./base.js')
+
+exports = module.exports = class bottom_one extends base{
+	constructor(props) {
+		super(props)
+        var t = this
+		t.aname = 'bottom_one'
+		t.pro_types = ['items']
+		return t
+    }
+}

package/tests/appenders/func_all.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* lib/appenders/func_all.js
+*/
+
+var base = require('./base.js')
+
+exports = module.exports = class func_all extends base {
+    constructor(props) {
+        super(props)
+        var t = this
+        t.aname = 'func_all'
+		t.pro_types = ['items']
+        return t
+    }
+}

package/tests/appenders/name.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-01-16
+* lib/appenders/name.js
+*/
+
+var base = require('./base.js')
+
+exports = module.exports = class name extends base {
+    constructor(props) {
+        super(props)
+        var t = this
+        t.aname = 'name'
+		t.pro_types = ['name']
+        return t
+    }
+}