From 423ab6d25195f78406fe7481ff49eb5c880460b3 Mon Sep 17 00:00:00 2001 From: Tyrone Johnston Date: Thu, 5 Aug 2021 15:04:06 +1000 Subject: [PATCH] Initial commit Version 2.0.1 --- .gitignore | 1 + changelog.md | 4 ++ index.js | 151 ++++++++++++++++++++++++++++++++++++++++++++++ input.json | 1 + license.txt | 121 +++++++++++++++++++++++++++++++++++++ output.json | 1 + package-lock.json | 13 ++++ package.json | 14 +++++ readme.md | 30 +++++++++ 9 files changed, 336 insertions(+) create mode 100644 .gitignore create mode 100644 changelog.md create mode 100644 index.js create mode 100644 input.json create mode 100644 license.txt create mode 100644 output.json create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 readme.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..096746c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/node_modules/ \ No newline at end of file diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..5d4de3b --- /dev/null +++ b/changelog.md @@ -0,0 +1,4 @@ +# Changelog + +* Initial commit +* Supports version 2.0.1 \ No newline at end of file diff --git a/index.js b/index.js new file mode 100644 index 0000000..a195bd9 --- /dev/null +++ b/index.js @@ -0,0 +1,151 @@ +const fs = require("fs"); +const yieldableJson = require("yieldable-json"); + +console.log("Running Demo . . ."); +runAsyncJsonDemo(); + +// Main function. +function runAsyncJsonDemo() +{ + coordinateDemo(function (overallErr) + { + if (overallErr !== null) + { + displayResult(overallErr.message); + } + else + { + displayResult("Complete"); + } + }); +} + + +// Read input JSON file. +function coordinateDemo(coordCallback) +{ + console.log("Reading"); + + fs.readFile("./input.json", "utf8", function (readErr, rawInputText) + { + if (readErr !== null) + { + // Error reading file. + return coordCallback(readErr); + } + else + { + // Successful - Parse raw text. + callJsonParse(rawInputText, coordCallback); + } + }); +} + +// Parse input JSON. +function callJsonParse(rawTxt, parseCallback) +{ + var parseMsg = ""; + + yieldableJson.parseAsync(rawTxt, function (parseErr, parsedJsonObject) + { + if (parseErr !== null) + { + // JSON parse error. + parseMsg = writeJsonErrorText("parsing", parseErr.message); + return parseCallback(new Error(parseMsg)); + } + else + { + // Successful - Process object. + handleProcessing(parsedJsonObject, parseCallback); + } + }); +} + + +function handleProcessing(parsedObject, processCallback) +{ + console.log("Processing"); + + // JSON processing goes here. + + var waitMs = chooseDelayLength(); + + // Random delay. + setTimeout(function() + { + // Processing complete. + callJsonStringify(parsedObject, processCallback); + }, waitMs); +} + + +// Stringify JSON object. +function callJsonStringify(parsedObj, stringCallback) +{ + var stringifyMsg = ""; + + console.log("Saving"); + + yieldableJson.stringifyAsync(parsedObj, null, 4, 1, + function (stringErr, definitionText) + { + if (stringErr !== null) + { + // JSON stringify error. + stringifyMsg = writeJsonErrorText("stringifying", stringErr.message); + return stringCallback(new Error(stringifyMsg)); + } + else + { + // Successful - Save output file. + callOutputSave(definitionText, stringCallback); + } + }); +} + + +// Write output JSON file. +function callOutputSave(defTxt, saveCallback) +{ + fs.writeFile("./output.json", defTxt, function (saveErr) + { + // Finished. + return saveCallback(saveErr); + }); +} + + +// Displays result message. +function displayResult(resMsg) +{ + console.log(""); + console.log(resMsg); +} + + +// Random processing delay length in milliseconds. +function chooseDelayLength() +{ + var minDelay = 1000; + var maxDelay = 5000; + var diffAmount = maxDelay - minDelay; + var randSeed = Math.random() * diffAmount; + var delayRes = Math.round(minDelay + diffAmount); + + return delayRes; +} + + +// Yieldable JSON error text. +function writeJsonErrorText(vAction, vMsg) +{ + var writeRes = ""; + + writeRes += "Error "; + writeRes += vAction; + writeRes += " JSON - "; + writeRes += vMsg; + + return writeRes; +} \ No newline at end of file diff --git a/input.json b/input.json new file mode 100644 index 0000000..af097ea --- /dev/null +++ b/input.json @@ -0,0 +1 @@ +{"stringProp": "Hello World!", "intProp": 123, "decProp": 456.789, "boolProp": true, "emptyProp": null} \ No newline at end of file diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/license.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/output.json b/output.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/output.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..82a1c46 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,13 @@ +{ + "name": "async-json-demo", + "version": "1.0.0", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "yieldable-json": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/yieldable-json/-/yieldable-json-2.0.1.tgz", + "integrity": "sha512-kFDzXrWlXXt21MQPCul6gAMwwiLoz6XgCbQF+2qNChqdiZnc1SW3l/b/x/XzlZchG2iaVjDIDW5Fnz+sL+FbCw==" + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..b927516 --- /dev/null +++ b/package.json @@ -0,0 +1,14 @@ +{ + "name": "async-json-demo", + "version": "1.0.0", + "description": "Demo project for 'yieldable-json' package", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "Tyrone Johnston", + "license": "CC0-1.0", + "dependencies": { + "yieldable-json": "^2.0.1" + } +} diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..2410030 --- /dev/null +++ b/readme.md @@ -0,0 +1,30 @@ +# Async JSON Demo + +This is a demo project for the [yieldable-json](https://www.npmjs.com/package/yieldable-json) Node JS library. It opens an input JSON file, simulates processing, and saves the formatted definition as a separate output file. + +While Node JS has [native functions](https://nodejs.org/en/knowledge/javascript-conventions/what-is-json/) for parsing and stringifying JSON files, they are linear and code-blocking, as opposed to the async nature of many Node scripts. This might be a non-issue for some projects but there are times when you want to process a JSON file in async for one reason or another. For example, reading large files using the native functions may cause the terminal to freeze. By using this library, you can read a large JSON file without the terminal freezing. You can even display a [loading spinner](https://www.npmjs.com/package/ora) if you want to. + +The `input.json` file contains the JSON object that will be read by the script. The output file will be saved as `output.json`. As this is a simulation, no actual changes are made to the object in processing. However, the output definition will be formatted automatically in order to be readable. + +The 'yieldable-json' library is relatively underground with an approximate several thousand downloads per week, and the latest major version released in December 2020. Don't let these figures discourage you. The library is very much reliable, and is lightweight at only ~71.2 kilobytes. + +--- + +## Usage + +1. Open a terminal in the project folder. +2. Run `npm install` to download the 'yieldable-json' package. +3. Run `node index` to execute the demo. + +--- + +## Credits + +- [@tjohnston-softdev](https://github.com/tjohnston-softdev) - Demo project. +- [@gireeshpunathil](https://github.com/gireeshpunathil) - Lead developer of 'yieldable-json' library, on behalf of [IBM Runtime Technologies](https://github.com/ibmruntimes) + +--- + +## Disclaimer + +This demo project is licensed under CC0 1.0 Universal. I only wrote this as a reference for using the 'yieldable-json' library to parse and stringify JSON objects in an async manner. This is not an official demo and I am in no way affiliated with [@gireeshpunathil](https://github.com/gireeshpunathil) or anybody else who has worked on the 'yieldable-json' library. Furthermore, I also have no affiliation with [IBM Runtime Technologies](https://github.com/ibmruntimes), or any part of IBM as a company. While I will make an effort to maintain this repository where applicable, I do not accept any responsibility for how you use this code or 'yieldable-json' as a whole.