file-obj-queue 2.0.4 → 3.0.0

package/lib/appenders/sync.js

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

package/lib/appenders/sync_all.js

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

package/lib/appenders/top_one.js

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

package/lib/appenders/version.js

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

package/package.json

@@ -2,24 +2,45 @@
   "author": {
     "name": "Jim Manton"
   },
-  "version": "2.0.4",
+  "version": "3.0.0",
   "bundleDependencies": [],
   "dependencies": {
     "@types/node": "^18.11.19",
+    "base-queue": "^1.0.0",
     "chai": "^4.3.7",
     "colors": "^1.4.0",
     "diffler": "^2.0.4",
     "fs": "^0.0.1-security",
+    "log-queue": "^1.0.0",
     "mocha": "^10.2.0",
     "queuejson": "^9.0.11",
-    "typescript": "^4.9.5",
     "valid-path": "^2.1.0"
   },
   "scripts": {
     "start": "node app.ts",
     "test": "mocha",
     "ditched": "ditched -a",
-    "test_files": "node ./tests/files"
+    "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",

package/test/app.js

@@ -24,7 +24,7 @@ describe('require', function () {
     })
 
     it('base_queue', function () {
-        assert(require('../base_queue/app'))
+        assert(require('base-queue'))
     })
 
     it('fs', function () {
@@ -34,4 +34,8 @@ describe('require', function () {
     it('valid-path', function () {
         assert(require('valid-path'))
     })
+        
+    it('valid-path', function () {
+        assert(require('log-queue'))
+    })
 })

package/test/package.js

@@ -6,24 +6,45 @@ const packageMock = {
   "author": {
     "name": "Jim Manton"
   },
-  "version": "2.0.4",
+  "version": "3.0.0",
   "bundleDependencies": [],
   "dependencies": {
     "@types/node": "^18.11.19",
+    "base-queue": "^1.0.0",
     "chai": "^4.3.7",
     "colors": "^1.4.0",
     "diffler": "^2.0.4",
     "fs": "^0.0.1-security",
+    "log-queue": "^1.0.0",
     "mocha": "^10.2.0",
     "queuejson": "^9.0.11",
-    "typescript": "^4.9.5",
     "valid-path": "^2.1.0"
   },
   "scripts": {
     "start": "node app.ts",
     "test": "mocha",
     "ditched": "ditched -a",
-    "test_files": "node ./tests/files"
+    "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",
@@ -49,6 +70,7 @@ 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

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

package/tests/appenders/base.js

@@ -73,7 +73,7 @@ class process_object {
                         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
                     }
                 })

package/tests/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/tests/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/tests/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/tests/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/tests/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/tests/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/tests/bottom_one.js

@@ -0,0 +1,86 @@
+var queue = require("../app.js")
+
+var tst1 = class test1 {
+  constructor(props) {
+    let t = this, fname = "test_bottom_one.test1.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_bottom_one.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_bottom_one.test2.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_bottom_one.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_bottom_one.test3.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+  }
+
+  process(callback) {
+    let t = this, fname = "test_bottom_one.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_bottom_one.test4.constructor"
+    t.log = props.log
+    t.id = props.id
+
+    t.process = t.process.bind(t)
+
+  }
+
+  process(callback) {
+    let t = this, fname = "test_bottom_one.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: "bottom_one",
+  exclude_logMsg: ["debug"],   /* example ["debug", "info"] */
+  process_objects: [tst1, tst2, tst3, tst4]
+}).then((success) => {
+  qObj.logMsg({ msg: `test success: {msg: "bottom_one object 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/files.js

@@ -1,37 +1,45 @@
-var colors = require('colors'),
-    file_queue = require("../app.js"),
+var file_queue = require("../app.js"),
     fs = require('fs'),
     validPath = require('valid-path')
 
 var file_data = [
-    { props: { id: 100, name: "all", path: "./appenders/all.js", absolute_path: __filename, check: true } },
-    { props: { id: 101, name: "func_all", path: "./appenders/func_all.js", absolute_path: __filename, check: true } },
-    { props: { id: 102, name: "top_one", path: "./appenders/top_one.js", absolute_path: __filename, check: true } },
-    { props: { id: 103, name: "bottom_one", path: "./appenders/bottom_one.js", absolute_path: __filename, check: true } },
-    { props: { id: 104, name: "sync_all", path: "./appenders/sync_all.js", absolute_path: __filename, check: true } },
-    { props: { id: 105, name: "status", path: "./appenders/status.js", absolute_path: __filename, check: true } },
-    { props: { id: 106, name: "name", path: "./appenders/name.js", absolute_path: __filename, check: true } },
-    { props: { id: 107, name: "version", path: "./appenders/version.js", absolute_path: __filename, check: true } }
+    { props: { id: 100, name: "all.js", absolute_path: __filename, check: true } },
+    { props: { id: 101, name: "func_all.js", absolute_path: __filename, check: true } },
+    { props: { id: 102, name: "top_one.js", absolute_path: __filename, check: true } },
+    { props: { id: 103, name: "bottom_one.js", absolute_path: __filename, check: true } },
+    { props: { id: 104, name: "sync_all.js", absolute_path: __filename, check: true } },
+    { props: { id: 105, name: "status.js", absolute_path: __filename, check: true } },
+    { props: { id: 106, name: "name.js", absolute_path: __filename, check: true } },
+    { props: { id: 107, name: "version.js", absolute_path: __filename, check: true } }
 ]
 
-
 var file_object = class file_obj {
     constructor(props) {
-        let t = this
-        t.id = props.id
-        t.log = props.log
-        t.name = props.name
-        t.path = props.path
-        t.absolute_path = props.absolute_path
-        t.status = 'init'
-        t.errors = false
-        t.error_msg = 'none'
+        let t = this, fname = "file_obj.constructor"
+        try {
+            t.id = props.id
+            t.log = props.log
+            t.name = props.name
+            t.path = props.relative_path
+            t.absolute_path = props.absolute_path
+            t.status = 'init'
+            t.errors = false
+            t.error_msg = 'none'
+
+            // if (t.id == 104) {
+            //     t.errors = true
+            //     t.error_msg = `some sort of error here`    
+            // }
 
-        t.process = t.process.bind(t)
-        t.do_checks = t.do_checks.bind(t)
+            t.process = t.process.bind(t)
+            t.do_checks = t.do_checks.bind(t)
 
-        if (props.check) {
-            t.do_checks()
+            if (props.check) {
+                t.do_checks()
+            }
+        } catch (e) {
+            e.message = `${fname} error: ${e.message}`
+            throw e
         }
 
         return t
@@ -40,6 +48,7 @@ var file_object = class file_obj {
     do_checks() {
         let t = this, path_to_check,
             last_item = t.absolute_path.split("\\").pop(),
+            fname = `file_obj.do_checks`,
             check_file = t.absolute_path.split(last_item)[0], check_path = t.path.split('/')
 
         check_file = check_file.replace(/\\/g, "/");
@@ -56,11 +65,12 @@ var file_object = class file_obj {
                     check_file += dat + '/'
             }
         })
-        check_file = check_file.slice(0, -1)
+        check_file += `${t.name}`
         try {
             if (!fs.existsSync(check_file)) {
                 t.errors = true
                 t.error_msg = `id = ${t.id} name(${t.name}) file (${check_file} does not exist)`
+                t.log({ msg: t.error_msg.error, type: "error" })
             }
         } catch (e) {
             e.message = "file_obj do_checks error: " + e.message
@@ -70,6 +80,7 @@ var file_object = class file_obj {
 
     process(callback) {
         let t = this
+        t.log({ msg: `processing object id ${t.id}. Do a bunch of stuff here.`.silly, type: "silly" })
         if (t.errors)
             callback({ error: { msg: t.error_msg } })
         else
@@ -79,12 +90,19 @@ var file_object = class file_obj {
 
 var qRequire = new file_queue()
 
-qRequire.process({ appender: "json_all", 
-                    process_objects: [file_object], 
-                    data_to_process_array: file_data }).then((success)=>{
-    qRequire.logMsg(`test success: all file objects processed with no errors`.success)
-},(error)=>{
-    let add_s = (error.error_count > 1) ? 's' : ''
-    qRequire.logMsg(`${error.error_count} error${add_s} detected`.error)
+qRequire.init().process({
+    appender: "json_all",
+    exclude_logMsg: ["debug", "silly", "info"],   /* default [] */
+    process_objects: [file_object],
+    data_to_process_array: file_data
+}).then((success) => {
+    qRequire.logMsg({ msg: `test success: file objects processed with no errors`.success.italic.bold, type: "success" })
+}, (error) => {
+    if (typeof error == "string") {
+        qRequire.logMsg({msg: `error: ${error}`.error.italic.bold, type: "error"})
+    } else {
+        let add_s = (error.error_count > 1) ? 's' : ''
+        qRequire.logMsg({ msg: `${error.error_count} error${add_s} detected`.error.italic.bold, type: "error" })
+    }
 })
 

package/tests/func_all.js

@@ -0,0 +1,94 @@
+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.base_queue_process_function = t.custom_function
+
+    t.custom_function = t.custom_function.bind(t)
+    t.base_queue_process_function = t.base_queue_process_function.bind(t)
+  }
+
+  custom_function(callback) {
+    let t = this, fname = "test_all.test1.custom_function"
+    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.base_queue_process_function = t.another_function
+
+    t.another_function = t.another_function.bind(t)
+    t.base_queue_process_function = t.base_queue_process_function.bind(t)
+  }
+
+  another_function(callback) {
+    let t = this, fname = "test_all.test2.another_function"
+    t.log({ msg: `This object (${fname}) is id (${t.id}). Do stuff here`.bgBrightGreen, type: "info" })
+    // callback({ success: { msg: `processing all test2` } })
+    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.base_queue_process_function = t.third_test
+
+    t.third_test = t.third_test.bind(t)
+    t.base_queue_process_function = t.base_queue_process_function.bind(t)
+  }
+
+  third_test(callback) {
+    let t = this, fname = "test_all.test3.third_test"
+    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.base_queue_process_function = t.last_shot
+
+    t.last_shot = t.last_shot.bind(t)
+    t.base_queue_process_function = t.base_queue_process_function.bind(t)
+  }
+
+  last_shot(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: "func_all",
+  exclude_logMsg: ["debug"],   /* example ["debug", "info"] */
+  process_objects: [tst1, tst2, tst3, tst4],
+}).then((success) => {
+  qObj.logMsg({ msg: `test success: {msg: "func_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" })
+  }
+})