file-obj-queue 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 jman717
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+An array of objects containing file path information. One use is for dynamically import require modules.
+
+Installation
+---------
+
+[![NPM](https://nodei.co/npm/file-queue.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/file-queue/)
+
+Mocha Test
+---------
+```
+npm test
+```
+
+General Setup Test
+---------
+```
+npm run test_files
+
+```

package/app.js

@@ -0,0 +1,107 @@
+/* @author Jim Manton: jrman@risebroadband.net
+* @since 2023-01-15
+* Main processing app
+*/
+
+var colors = require('colors'),
+    queue = require("queuejson"),
+    fs = require('fs');
+
+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'
+
+        t.process = t.process.bind(t)
+        t.do_checks = t.do_checks.bind(t)
+
+        if (props.check) {
+            t.do_checks()
+        }
+    }
+
+    do_checks() {
+        let t = this,
+            last_item = t.absolute_path.split("\\").pop(),
+            check_file = t.absolute_path.split(last_item)[0], check_path = t.path.split('/')
+
+        check_file = check_file.replace(/\\/g, "/");
+        check_path.map((dat, i) => {
+            if (/^[a-zA-Z._]+$/.test(dat)) {
+                if (dat != '.')
+                    check_file += dat + '/'
+            }
+        })
+        check_file = check_file.slice(0, -1)
+        try {
+            if (!fs.existsSync(check_file)) {
+                t.errors = true
+                t.error_msg = `id = ${t.id} name(${t.name}) file (${check_file} does not exist)`
+            }
+        } catch (e) {
+            e.message = "file_obj do_checks error: " + e.message
+            throw (e)
+        }
+    }
+
+    process(callback) {
+        let t = this
+        if (t.errors)
+            callback({ error: { msg: t.error_msg } })
+        else
+            callback({ success: { msg: `id = ${t.id} name(${t.name})` } })
+    }
+}
+
+exports = module.exports = class FilesQueue {
+    constructor() {
+        try {
+            var t = this
+            // t.id = 0
+            // t.appenders_dir = './lib/appenders/'
+            // t.props = {}
+            t.logMsg = t.logMsg.bind(t)
+            t.init = t.init.bind(t)
+            t.getFileObject = t.getFileObject.bind(t)
+            return t
+        } catch (e) {
+            e.message = "FilesQueue app.js constructor error: " + e.message
+            throw (e)
+        }
+    }
+
+    init(props = {}) {
+        let t = this
+        try {
+            if (typeof props.input_data == 'undefined')
+                throw new Error('props.input_data is not defined')
+            t.qJson = new queue({
+                class_obj: file_obj,
+                appender: 'all',
+                stats: true,
+                debug: true
+            })
+            t.qJson.init({ input_data: props.input_data }).process()
+            return t
+        } catch (e) {
+            e.message = "FilesQueue app.js init error: " + e.message
+            t.logMsg(e.message)
+            throw (e)
+        }
+    }
+
+    getFileObject() {
+        return this.qJson.get_class_obj_array()
+    }
+
+    logMsg(msg, props = {}) {
+        console.log(msg)
+    }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "0.0.3",
+  "bundleDependencies": false,
+  "dependencies": {
+    "chai": "^4.3.7",
+    "node-console-colors": "^1.1.4",
+    "queuejson": "^8.3.1",
+    "diffler": "^2.0.4",
+    "fs": "^0.0.1-security",
+    "mocha": "^10.2.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_files": "node ./tests/files"
+  },
+  "keywords": [
+    "queue",
+    "processing",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/file-obj-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/file-obj-queue.git"
+  },
+  "deprecated": false,
+  "description": "Queue File Objects",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "file-obj-queue",
+  "start": "node app.js"
+}

package/test/app.js

@@ -0,0 +1,38 @@
+var assert = require('assert');
+
+describe('app', function () {
+    let app, application
+
+    it('app.constructor should pass', function () {
+        application = require('../app.js')
+        assert(app = new application())
+    })
+
+    it('app.init is a function', function () {
+        assert(typeof app.init == '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('colors app', function () {
+        assert(require('colors'))
+    })
+
+    it('queuejson', function () {
+        assert(require('queuejson'))
+    })
+
+    it('fs', function () {
+        assert(require('fs'))
+    })
+})

package/test/package.js

@@ -0,0 +1,59 @@
+const assert = require('assert'),
+    jsonHasDifferences = require('diffler'),
+    packagejson = require('../package.json')
+
+const packageMock = {
+  "author": {
+    "name": "Jim Manton"
+  },
+  "version": "0.0.3",
+  "bundleDependencies": false,
+  "dependencies": {
+    "chai": "^4.3.7",
+    "node-console-colors": "^1.1.4",
+    "queuejson": "^8.3.1",
+    "diffler": "^2.0.4",
+    "fs": "^0.0.1-security",
+    "mocha": "^10.2.0"
+  },
+  "scripts": {
+    "start": "node app.ts",
+    "test": "mocha",
+    "ditched": "ditched -a",
+    "test_files": "node ./tests/files"
+  },
+  "keywords": [
+    "queue",
+    "processing",
+    "appenders",
+    "javascript",
+    "synchronous",
+    "objects",
+    "promises",
+    "mocha"
+  ],
+  "homepage": "https://github.com/jman717/file-obj-queue",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jman717/file-obj-queue.git"
+  },
+  "deprecated": false,
+  "description": "Queue File Objects",
+  "email": "jrman@risebroadband.net",
+  "license": "MIT",
+  "main": "app.js",
+  "name": "file-obj-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/appenders/all.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2021-03-22l
+* 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_all_obj {
+    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(`pro obj error: (${e.message})`.red)
+                        throw e
+                    }
+                })
+            } catch (e) {
+                e.message = `error: ${e.message} `
+                throw e
+            }
+        } catch (e) {
+            e.message = `process_all_obj 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_all_obj = 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_all_obj == null) {
+            t.process_all_obj = new process_all_obj({ parent: t })
+        }
+
+        _continue = false
+        try {
+            switch (t.process_all_obj.getStatus()) {
+                case 'process':
+                    t.process_all_obj.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_all_obj.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 2021-03-22
+* 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 2021-03-22
+* 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
+    }
+}

package/tests/appenders/status.js

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

package/tests/appenders/sync.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2021-03-22
+* 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/tests/appenders/sync_all.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2021-03-22
+* 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/tests/appenders/top_one.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2021-03-22
+* 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/tests/appenders/version.js

@@ -0,0 +1,17 @@
+/*
+* @author Jim Manton: jrman@risebroadband.net
+* @since 2021-03-22
+* 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/tests/files.js

@@ -0,0 +1,18 @@
+var colors = require('colors'),
+    file_queue = require("../app.js")
+
+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 } }
+]
+
+var qRequire = new file_queue().init({ input_data: file_data })  
+
+console.log(`test complete`.blue)
+