flex-json 0.0.3 → 0.0.5

package/FlexJsonClass.js

@@ -3,7 +3,7 @@ const FlexJsonPosition = require("./FlexJsonPosition.js");
 const FlexJsonMeta = require("./FlexJsonMeta.js");
 const fs = require("fs");
 const StringBuilder = require("string-builder");
-const { trackingStats } = require( "./get/index.js");
+
 
 class FlexJson {
   _status = 0;
@@ -36,28 +36,22 @@ class FlexJson {
     if (this._NoStatsOrMsgs && !force) {
       return;
     } // Do not track stats/message/meta-data
-    if (this._meta == null) {
-      this._meta = new FlexJsonMeta();
+    if (!this._meta) {
+      this._meta = {};
     }
   }
 
-  // get trackingStats() {
-  //   if (this._meta == null) return false;
-  //   if (this._meta.stats == null) return false;
-  //   return true;
-  // }
-  // use the imported trackingStats function instead
 
   get trackingStats() {
-    return trackingStats(this._meta);
+    if (this._meta == null || this._meta.status == null) {
+      return false;
+    }
+    return true;
   }
 
-
   get statusMsg() {
-    if (this._meta != null) {
-      if (this._meta.statusMsg != null) {
-        return this._meta.statusMsg;
-      }
+    if (this._meta != null && this._meta.statusMsg != null) {
+      return meta.statusMsg;
     }
     return "";
   }
@@ -77,17 +71,15 @@ class FlexJson {
   }
 
   get tmpStatusMsg() {
-    if (this._meta != null) {
-      if (this._meta.tmpStatusMsg != null) {
-        return this._meta.tmpStatusMsg;
-      }
+    if (this._meta && this._meta.tmpStatusMsg) {
+      return this._meta.tmpStatusMsg;
     }
     return "";
   }
   set tmpStatusMsg(value) {
     this.createMetaIfNeeded();
-    if (_meta != null) {
-      _meta.tmpStatusMsg = value;
+    if (this._meta) {
+      this._meta.tmpStatusMsg = value;
     }
   }
 
@@ -96,16 +88,16 @@ class FlexJson {
   }
 
   set key(value) {
-    this._key = value + "";
+    this._key = "" + value; // convert to string (future: allow numeric key?)
   }
 
   get preSpace() {
-    if (this._meta != null) {
-      if (this._meta.preSpace != null) {
-        return this._meta.preSpace;
-      }
-    }
-    return null;
+    //if (this._meta != null) {
+    //  if (this._meta.preSpace != null) {
+    //    return this._meta.preSpace;
+    //  }
+    //}
+    return this._meta && this._meta.preSpace ? this._meta.preSpace : null;
   }
 
   set preSpace(value) {
@@ -116,12 +108,12 @@ class FlexJson {
   }
 
   get postSpace() {
-    if (this._meta != null) {
-      if (this._meta.postSpace != null) {
-        return this._meta.postSpace;
-      }
-    }
-    return null;
+    //if (this._meta != null) {
+    //  if (this._meta.postSpace != null) {
+    //    return this._meta.postSpace;
+    //  }
+    //}
+    return this._meta && this._meta.postSpace ? this._meta.postSpace : null;
   }
 
   set postSpace(value) {
@@ -181,7 +173,7 @@ class FlexJson {
 
   get keepSpacing() {
     if (this._meta != null) {
-      return this._meta.keepSpacing;
+      return this._meta.keepSpacing || false;
     }
     return false;
   }
@@ -194,7 +186,7 @@ class FlexJson {
 
   get keepComments() {
     if (this._meta != null) {
-      return this._meta.keepComments;
+      return this._meta.keepComments || false;
     }
     return false;
   }
@@ -484,7 +476,6 @@ class FlexJson {
   forEach(callback) {
     if (this.jsonType == "object" || this.jsonType == "array") {
       for (let i = 0; i < this.length; i++) {
-        let jj = this.i(i); // debugger
         callback(this.i(i));
       } // end for
     } else {
@@ -500,11 +491,6 @@ class FlexJson {
 
   add(value, idx = "", dotNotation = true) {
     var newV;
-    var debugType = typeof value; /// debug debug debug
-    if (value === null) {
-      /// debug debug debug
-      console.log("is null");
-    }
     if (
       value !== null &&
       typeof value === "object" &&
@@ -711,9 +697,6 @@ class FlexJson {
             if (i > 0) {
               s.append(",");
             }
-            if (o.key == "data") {
-              console.log("debug here111"); // debug debug debug
-            }
             let k = o.SerializeMe();
 
             // Here we ignore keepSpacing/keepComments - these flags are only used during the deserialize process
@@ -1005,7 +988,7 @@ class FlexJson {
           // if we are no longer in pre-space territory, the we need to store the whitespace/comments
           if (meStatus >= FlexJsonConstants.ST_STRING) {
             if (keepCM || keepSP) {
-              preSpace = getSpace;
+              this.preSpace = getSpace;
               getSpace = ""; // clear
             }
           }
@@ -1371,7 +1354,15 @@ class FlexJson {
 
   CreatePartClone(keepSP = false, keepCM = false) {
     let jClone = new FlexJson();
-    jClone.UseFlexJson = this.UseFlexJson;
+    if (this.UseFlexJson) {
+      jClone.UseFlexJson = true;
+    }
+    if (keepSP) {
+      jClone.keepSpacing = true;
+    }
+    if (keepCM) {
+      jClone.keepComments = true;
+    }
     jClone.ALLOW_SINGLE_QUOTE_STRINGS = this.ALLOW_SINGLE_QUOTE_STRINGS;
     return jClone;
   }
@@ -1380,6 +1371,8 @@ class FlexJson {
     var j2;
     var jNew;
     let Key = "";
+    let preKey = "";
+    let postKey = "";
     var c;
 
     let v = [];
@@ -1446,8 +1439,8 @@ class FlexJson {
       } else {
         // capture the white space/comments here
         if (keepCM || keepSP) {
-          this.preKey = j2.preSpace;
-          this.postKey = j2.finalSpace;
+          preKey = j2.preSpace;
+          postKey = j2.finalSpace;
         }
         Key = j2._value; // already verified that this is type "string"
         this._keyQuote = j2._stringQuote;
@@ -1514,6 +1507,12 @@ class FlexJson {
           // *** For all cases: object, array, string, number, boolean, or null
           jNew.Parent = this;
           jNew._key = Key;
+          if (preKey) {
+            jNew.preKey = preKey;
+          }
+          if (postKey) {
+            jNew.postKey = postKey;
+          }
           v.push(jNew); // FUTURE: IS THIS WRONG? SHOULD WE CHECK TO SEE IF THE KEY ALREADY EXISTS? AS IS, THE FIRST VALUE WILL "overshadow" ANY SUBSEQUENT VALUE. MAYBE THIS IS OK.
           mePos = finalPos;
         }
@@ -1694,8 +1693,8 @@ class FlexJson {
   DeserializeFlexFile(
     FilePath,
     OkToClip = false,
-    spacing_flag = -1,
-    comments_flag = -1
+    spacing_flag = 1, // default = keep spacing & comments
+    comments_flag = 1
   ) {
     this.UseFlexJson = true;
     if (spacing_flag >= 0 || comments_flag >= 0) {
@@ -1704,6 +1703,23 @@ class FlexJson {
     return this.DeserializeFile(FilePath, OkToClip);
   }
 
+  // WriteToFile()
+  // If object is setup as FlexJSON and with KeepSpacing/KeepComments, then file will be written accordingly
+  // Return: 0=ok, -1=error, -2=could not write because of invalid FlexJson object
+  WriteToFile(FilePath) {
+    try {
+      let outString = this.jsonString;
+      if (this._status == 0) {
+        fs.writeFileSync(FilePath, outString, { encoding: "utf8" });
+      } else {
+        return -2;
+      }
+    } catch {
+      return -1;
+    }
+    return 0;
+  }
+
   StatusErr(nErr, strErr) {
     this._status = nErr;
     this.AddStatusMessage(strErr);

package/README.md

@@ -1,13 +1,85 @@
 # flex-json
 
-## Flexible JSON manipulation library for JavaScript.
+## Flexible JSON manipulation library for JavaScript
+
+## Maintainers
+
+| Maintainer      | GitHub                                      | LinkedIn                                               |
+| --------------- | ------------------------------------------- | ------------------------------------------------------ |
+| Ted Tyree       | [GitHub](https://github.com/tedtyree)       |[LinkedIn](https://www.linkedin.com/in/tedtyree/)       |  
+| Michael Njuguna | [GitHub](https://github.com/michaelnjuguna) |[LinkedIn](https://www.linkedin.com/in/michael-njuguna/)|
 
 ## Table of Contents
 
-- [Install](#install)
-- [Usage](#usage)
 - [Why flex-json](#why-flex-json)
 - [How the library works](#how-the-library-works)
+- [Install](#install)
+- [Usage](#usage)
+
+## Why flex-json
+
+It is simply Json with comments! FlexJson was written to make JSON config files easy to manage and allow for comments. The library also makes it super easy to read a json file (often a config file), modify a single value, and save the file back to the file system without messing up the comments.
+
+- Easy config file formatting
+- Includes comments in both /* */ and // notation
+- Simple to edit Json files
+- Allows for other JavaScript like features such as using either single quotes or double quotes.
+- Can also be used within Node.js apps for other uses such as reading/writing JSON to/from database records and parsing loosely formatted Json in web page content.
+
+## How the library works
+
+### Flex-json syntax
+
+BTW flex-json as a standard of syntax is not really all that new - it is very much in existence within JavaScript and other syntax standards. Here we just make it available in a library and to facilitate config file parsing and editing.
+
+### Strict Mode
+
+When in strict mode, the flex-json library reads JSON files in standard JSON format. Comments are not valid and double quotes are required around strings.
+
+Note: If the library is flagged to preserve spacing, Json that has been read in from a file will be written with the same formatting. In other words, the carriage returns and white space are captured during the parsing process and used to re-format the output during the write process.
+
+### Flex Mode
+
+When in flex mode, the flex-json library has the following features:
+
+- Like JavaScript, comments can be surrounded by  /* (start of comment) and */ (end of comment)
+
+- Like JavaScript, when a  "//" is encountered, the remainder of the line is considered to be a comment
+
+- Strings do not require quotes unless they contain special characters
+
+- Strings can be quoted using double quotes or single quotes
+  
+When in flex mode, all of the following examples of Json are valid:
+
+__example 1:__
+
+```javascript
+{apple: red, banana: yellow, 'sky': 'blue'}
+```
+
+__example 2:__
+
+```javascript
+{"apple": "red"
+ ,'banana': 'yellow'
+ // ,'sky': 'blue'  - this line is commented out
+}
+```
+
+__example 3:__
+
+```javascript
+[ "one, is first"
+  ,'two, is next'
+  /* comment out remainder of array
+  ,"three, is third"
+  ,'four', is last"
+  */
+]
+```
+
+__Note__ that {number:"2"} is not the same as {number:2} because flex-json will see that the 2 without quotes is a valid number and load it as a numeric.
 
 ## Install
 
@@ -89,70 +161,46 @@ const serializedJson = flexJson.SerializeMe();
 console.log(serializedJson);
 ```
 
-## Why flex-json
-
-It is simply Json with comments! FlexJson was written to make JSON config files easy to manage and allow for comments. The library also makes it super easy to read a json file (often a config file), modify a single value, and save the file back to the file system without messing up the comments.
-
-- Easy config file formatting
-- Includes comments in both /* */ and // notation
-- Simple to edit Json files
-- Allows for other JavaScript like features such as using either single quotes or double quotes.
-- Can also be used within Node.js apps for other uses such as reading/writing JSON to/from database records and parsing loosely formatted Json in web page content.
-
-## How the library works
-
-### Flex-json syntax
-
-BTW flex-json as a standard of syntax is not really all that new - it is very much in existence within JavaScript and other syntax standards. Here we just make it available in a library and to facilitate config file parsing and editing.
-
-### Strict Mode
-
-When in strict mode, the flex-json library reads JSON files in standard JSON format. Comments are not valid and double quotes are required around strings.
-
-Note: If the library is flagged to preserve spacing, Json that has been read in from a file will be written with the same formatting. In other words, the carriage returns and white space are captured during the parsing process and used to re-format the output during the write process.
-
-### Flex Mode
-
-When in flex mode, the flex-json library has the following features:
-
-- Like JavaScript, comments can be surrounded by  /* (start of comment) and */ (end of comment)
-
-- Like JavaScript, when a  "//" is encountered, the remainder of the line is considered to be a comment
-
-- Strings do not require quotes unless they contain special characters
-
-- Strings can be quoted using double quotes or single quotes
-  
-When in flex mode, all of the following examples of Json are valid:
-
-__example 1:__
+Config file example (this is the best part!)
 
+First create a json config file for example a text file c:/temp/my-config.json containing the following text…
 ```javascript
-{apple: red, banana: yellow, 'sky': 'blue'}
-```
-
-__example 2:__
-
-```javascript
-{"apple": "red"
- ,'banana': 'yellow'
- // ,'sky': 'blue'  - this line is commented out
+/* my-config
+** this is an example of parsing
+** and updating a json config file
+*/
+{
+ParameterA: 'Apple',
+ParameterB:'Banana'
 }
 ```
 
-__example 3:__
+In your node.js app run these commands…
 
 ```javascript
-[ "one, is first"
-  ,'two, is next'
-  /* comment out remainder of array
-  ,"three, is third"
-  ,'four', is last"
-  */
-]
+// setup parameters
+let defaultCounter = 0;
+let myConfigPath = "c:/temp/my-config.json";
+
+// read json config file
+let myConfig = new FlexJson();
+myConfig.DeserializeFlexFile(myConfigPath);
+
+// read CounterA and increment it by 1
+// use default value to create CounterA if it does not exist
+let counter = myConfig.getNum("CounterA",defaultCounter);
+counter = counter + 1;
+myConfig.add(counter,"CounterA");
+
+// write config file back to file system
+myConfig.WriteToFile(myConfigPath);
 ```
 
-__Note__ that {number:"2"} is not the same as {number:2} because flex-json will see that the 2 without quotes is a valid number and load it as a numeric.
+The first time this is run the output my-config.json will have a new parameter…
+CounterA:1
+
+And each new time this is run the counter will increase…
+CounterA:2
 
 ### Contributing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flex-json",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "This is a library that makes each 'Node' in the JSON Object/Array a JSON Object with a Key/Value pair.",
   "main": "FlexJsonClass.js",
   "authors": "[michael njuguna michaelnjuguna184@gmail.com, ted tyree tedtyree@gmail.com]",

package/get/index.js

@@ -1,11 +0,0 @@
-function trackingStats(meta) {
-  if (meta == null || meta.status == null) {
-    return false;
-  }
-  return true;
-}
-
-// exports
-module.exports = {
-  trackingStats: trackingStats
-};