base-queue 0.0.1

package/appenders/name.js

@@ -0,0 +1,77 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* name.js
+*/
+
+var base = require('./base.js'),
+	common_code = require('./common_code.js')
+
+exports = module.exports = class name extends base {
+	constructor(props) {
+		super(props)
+		var t = this, fname = 'name.constructor'
+		try {
+			t.aname = 'name'
+			t.main_process_objects = []
+			t.common_code = new common_code({
+				parent: t,
+				log: t.parent.logMsg,
+				include_func: t.get_include_names,
+				exclude_func: t.get_exclude_names,
+				by_what: t.aname
+			})
+
+			if (t.appender != t.aname)
+				throw new Error(`(${t.appender}) does not equal the appender name (${t.aname}))`)
+
+			t.parent.logMsg({ msg: `${fname} objects to process count(${t.get_objects_to_process().length})`.debug, type: "debug" })
+
+			t.init = t.init.bind(t)
+			t.process = t.process.bind(t)
+
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	init(props = {}) {
+		var t = this, fname = `name.init`, obj
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			if (typeof t.get_objects_to_process()[0] == "undefined")
+				throw new Error(`get_objects_to_process[0] has no data`)
+
+			t.get_objects_to_process().map((dat, i) => {
+				dat = { props: { id: (i + 1), log: t.parent.logMsg } }
+				obj = t.get_objects_to_process()[i]
+				t.common_code.init({ obj: obj, dat: dat })
+			})
+
+			super.init(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	process(props = {}) {
+		var t = this, fname = `name.process`
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			super.process(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+}

package/appenders/status.js

@@ -0,0 +1,77 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* status.js
+*/
+
+var base = require('./base.js'),
+	common_code = require('./common_code.js')
+
+exports = module.exports = class status extends base {
+	constructor(props) {
+		super(props)
+		var t = this, fname = 'status.constructor'
+		try {
+			t.aname = 'status'
+			t.main_process_objects = []
+			t.common_code = new common_code({
+				parent: t,
+				log: t.parent.logMsg,
+				include_func: t.get_include_status,
+				exclude_func: t.get_exclude_status,
+				by_what: t.aname
+			})
+
+			if (t.appender != t.aname)
+				throw new Error(`(${t.appender}) does not equal the appender name (${t.aname}))`)
+
+			t.parent.logMsg({ msg: `${fname} objects to process count(${t.get_objects_to_process().length})`.debug, type: "debug" })
+
+			t.init = t.init.bind(t)
+			t.process = t.process.bind(t)
+
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	init(props = {}) {
+		var t = this, fname = `status.init`, obj, obj_a, is
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			if (typeof t.get_objects_to_process()[0] == "undefined")
+				throw new Error(`get_objects_to_process[0] has no data`)
+
+			t.get_objects_to_process().map((dat, i) => {
+				dat = { props: { id: (i + 1), log: t.parent.logMsg } }
+				obj = t.get_objects_to_process()[i]
+				t.common_code.init({ obj: obj, dat: dat })
+			})
+
+			super.init(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	process(props = {}) {
+		var t = this, fname = `status.process`
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			super.process(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+}

package/appenders/top_one.js

@@ -0,0 +1,67 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* top_one.js
+*/
+
+var base = require('./base.js')
+
+exports = module.exports = class top_one extends base {
+	constructor(props) {
+		super(props)
+		var t = this, fname = 'top_one.constructor'
+		try {
+			t.aname = 'top_one'
+			t.main_process_objects = []
+
+			if (t.appender != t.aname)
+				throw new Error(`(${t.appender}) does not equal the appender name (${t.aname}))`)
+
+			t.parent.logMsg({ msg: `${fname} objects to process count(${t.get_objects_to_process().length})`.debug, type: "debug" })
+
+			t.init = t.init.bind(t)
+			t.process = t.process.bind(t)
+
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	init(props = {}) {
+		var t = this, fname = `top_one.init`, obj, dat
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			if (typeof t.get_objects_to_process()[0] == "undefined")
+				throw new Error(`get_objects_to_process[0] has no data`)
+
+			obj = t.get_objects_to_process()[0]
+			dat = { props: { id: 1, log: t.parent.logMsg } }
+			t.main_process_objects.push(new obj(dat.props))
+
+			super.init(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	process(props = {}) {
+		var t = this, fname = `top_one.process`
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			super.process(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+}

package/appenders/version.js

@@ -0,0 +1,85 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-2-5
+* version.js
+*/
+
+var base = require('./base.js'),
+	common_code = require('./common_code.js')
+
+exports = module.exports = class version extends base {
+	constructor(props) {
+		super(props)
+		var t = this, fname = 'version.constructor'
+		try {
+			t.aname = 'version'
+			t.main_process_objects = []
+			t.common_code = new common_code({
+				parent: t,
+				log: t.parent.logMsg,
+				include_func: t.get_include_version,
+				exclude_func: t.get_exclude_version,
+				by_what: t.aname
+			})
+
+			if (t.appender != t.aname)
+				throw new Error(`(${t.appender}) does not equal the appender name (${t.aname}))`)
+
+			t.parent.logMsg({ msg: `${fname} objects to process count(${t.get_objects_to_process().length})`.debug, type: "debug" })
+
+			t.init = t.init.bind(t)
+			t.process = t.process.bind(t)
+
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	init(props = {}) {
+		var t = this, fname = `version.init`, obj, obj_a, is
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			if (typeof t.get_objects_to_process()[0] == "undefined")
+				throw new Error(`get_objects_to_process[0] has no data`)
+
+			t.get_objects_to_process().map((dat, i) => {
+				dat = { props: { id: (i + 1), log: t.parent.logMsg } }
+				obj = t.get_objects_to_process()[i]
+				t.common_code.init({ obj: obj, dat: dat })
+
+				// is = t.get_include_version()   jrm debug 2/23
+				// obj_a = new obj(dat.props)
+				// if (typeof obj_a != "undefined" &&
+				// 	typeof obj_a.version != "undefined" &&
+				// 	is.indexOf(obj_a.version) > -1) {
+				// 	t.main_process_objects.push(new obj(dat.props))
+				// }
+			})
+
+			super.init(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+
+	process(props = {}) {
+		var t = this, fname = `version.process`
+		try {
+			t.parent.logMsg({ msg: `${fname}`.debug, type: "debug" })
+
+			super.process(props)
+			return t
+		} catch (e) {
+			e.message = `${fname} error: ${e.message})`
+			throw e
+			// t.parent.app_reject(`${fname} error: ${e.message})`)
+		}
+	}
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "0.0.1",
+  "bundleDependencies": [],
+  "dependencies": {
+    "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",
+    "valid-path": "^2.1.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_base": "node ./tests/base"
+  },
+  "keywords": [
+    "queue",
+    "processing",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/base-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/base-queue.git"
+  },
+  "deprecated": false,
+  "description": "Logging to console with eventual log4js-tagline support.",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "base-queue",
+  "start": "node app.js"
+}

package/test/app.js

@@ -0,0 +1,29 @@
+var assert = require('assert');
+
+describe('app', function () {
+    let app, application
+
+    it('app.constructor should pass', function () {
+        application = require('../app.js')
+        assert(app = new application({ parent: null }))
+    })
+    
+    it('app.process is a function', function () {
+        assert(typeof app.process == 'function')
+    })
+    
+    it('app.load is a function', function () {
+        assert(typeof app.load == 'function')
+    })
+
+    it('app.init is a function', function () {
+        assert(typeof app.init == 'function')
+    })
+})
+
+describe('require', function () {
+
+    it('colors', function () {
+        assert(require('colors'))
+    })
+})

package/test/package.js

@@ -0,0 +1,60 @@
+const assert = require('assert'),
+    jsonHasDifferences = require('diffler'),
+    packagejson = require('../package.json')
+
+const packageMock = {
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "0.0.1",
+  "bundleDependencies": [],
+  "dependencies": {
+    "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",
+    "valid-path": "^2.1.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_base": "node ./tests/base"
+  },
+  "keywords": [
+    "queue",
+    "processing",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/base-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/base-queue.git"
+  },
+  "deprecated": false,
+  "description": "Logging to console with eventual log4js-tagline support.",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "base-queue",
+  "start": "node app.js"
+}
+
+describe('package.json', function () {
+    it('should pass', function () {
+      const difference = jsonHasDifferences(packagejson, packageMock)
+      assert(JSON.stringify(difference) == "{}")
+    })
+
+    it('should fail', function () {
+        packageMock.version = '0'
+        assert(jsonHasDifferences(packagejson, packageMock))
+    })
+})

package/tests/base.js

@@ -0,0 +1,101 @@
+
+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 lq = require("log-queue"),
+  log = new lq({
+    exclude_logMsg: ["debug"],   /* example ["debug", "info"] */
+  }),
+  a_resolve, a_reject,
+  promise = new Promise((resolve, reject) => {
+    a_resolve = resolve
+    a_reject = reject
+  }),
+  bb = require("../app.js"),
+  base_queue = new bb({
+    parent: null,
+    relative_path: "./appenders/",
+    logMsg: log.logMsg,
+    resolve: a_resolve,
+    reject: a_reject
+  }).load({
+    appender: "all",
+    exclude_logMsg: ["debug"],   /* example ["debug", "info"] */
+    process_objects: [tst1, tst2, tst3, tst4]
+  }).process()
+
+promise.then((success) => {
+  log.logMsg({ msg: `All object processed successfully` })
+}, (error) => {
+  if (typeof error == "string") {
+    log.logMsg({ msg: `error: ${error}`.error.italic.bold, type: "error" })
+  } else {
+    let add_s = (error.error_count > 1) ? 's' : ''
+    log.logMsg({ msg: `${error.error_count} error${add_s} detected`.error.italic.bold, type: "error" })
+  }
+})
+