fileconfig - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

lib/fileconfig.js

@@ -9,81 +9,68 @@ /**
 
-var util      = require('util');
 var fs        = require('fs');
-var useme     = require('useme');
+var path      = require('path');
 var jsonfile  = require('jsonfile');
 var YAML      = require('yamljs');
 
-function initnode(path) {
-  var jsonpath  = path + '.json';
-  var ymlpath   = path + '.yml';
-  var stats; 
-  if (fs.existsSync(path)) {
-    stats = fs.lstatSync(path);
-    if (stats.isDirectory()) {
-      return new FileConfig(path);
-    }
-  } else if (fs.existsSync(jsonpath)) {
-    stats = fs.lstatSync(jsonpath);
-    if (stats.isFile()){
-      // expects valid json string
-      // no curve balls please
-      return jsonfile.readFileSync(jsonpath);
-    }
-  } else if (fs.existsSync(ymlpath)) {
-    stats = fs.lstatSync(ymlpath);
-    if (stats.isFile()) {
-      // expects valid yml string
-      // no curve balls please
-      return YAML.load(ymlpath);
-    }
-  }
-}
+var getter    = require('./getter');
 
-function resolveData (data, queue) {
-  if (data instanceof FileConfig) {
-    return resolveComponent(data, queue);
-  } else {
-    return resolveObject(data, queue);
-  }
+function Component(path, value, leaf, format) {
+  this.path   = path;
+  this.value  = value;
+  this.leaf   = leaf;
+  this.format = format;
 }
 
-function resolveComponent (component, queue) {
-  if (queue.length === 0) {
-    return component;
-  }
-  var property  = queue.shift();
-  var refresh   = property.indexOf('#') === 0;
-  var name      = refresh === true ? property.substring(1) : property;
-
-  var data
-  // self
-  if (name.match(/^@(value|path)$/)) {
-    data = component[name.substring(1)];
-  } else {
-    if (refresh === true || !(name in component.value)) {
-      component.value[name] = initnode(util.format('%s/%s', component.path, name));
+Component.prototype.$persist = function () {
+  // for now only persist leaves (files)
+  // later handle non leaves ... depth ? anyone 
+  if (this['@leaf']) {
+    switch (this['@format']) {
+      case 'json':
+        jsonfile.writeFileSync(this['@path'], this['@value']);
+        break;
+      case 'yml' :
+        fs.writeFileSync(this['@path'], YAML.stringify(this['@value'], 2));
+        break;
+      default :
+        break;
     }
-    data = component.value[name];
   }
-  return resolveData(data, queue);
 }
 
-function resolveObject (object, queue) {
-  if (queue.length === 0) {
-    return object;
+function makeComponent(location) {
+  var jsonpath = location + '.json';
+  var ymlpath = location + '.yml';
+  var stats;
+  if (fs.existsSync(location)) {
+    stats = fs.lstatSync(location);
+    if (stats.isDirectory()) {
+      var component = makeComponent(path.resolve(location, 'this'));
+      var value = component === undefined ? {} : component.value;
+      var format = component === undefined ? 'json' : component.format;
+      return new Component(location, value, false, format);
+    }
+  } else if (fs.existsSync(jsonpath)) {
+    return new Component(jsonpath, jsonfile.readFileSync(jsonpath), true, 'json');
+  } else if (fs.existsSync(ymlpath)) {
+    return new Component(ymlpath, YAML.load(ymlpath), true, 'yml');
   }
-  return resolveData(object[queue.shift()], queue);
 }
 
 function lookup (component, property) {
-  return resolveComponent(component, property.split('/'))
+  return getter.get(component, property, FileConfig);
 }
 
-function FileConfig (path) {
-  var component = {
-    path  : path,
-    value : useme.val(initnode(path + '/this'), {})
-  };
+function replace (component, property, value) {
+  var queue           = property.split('/');
+  var targetProperty  = queue.pop();
+  var target          = getter.resolveComponent(component, queue, FileConfig);
+  target.value[targetProperty] = value;
+}
+
+function FileConfig (location) {
+  var component = makeComponent(path.resolve(location));
   return Proxy(component, {
-    get : lookup
+    get : lookup,
+    set : replace
   });
@@ -90,0 +77,0 @@ }

package.json

 {
   "name": "fileconfig",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "json, yml file configuration loader",
@@ -10,2 +10,5 @@ "main": "lib/fileconfig.js",
   },
+  "bin": {
+    "fileconfig": "node lib/serve.js"
+  },
   "repository": {
@@ -27,10 +30,13 @@ "type": "git",
   "dependencies": {
+    "express": "^4.12.3",
     "harmony-reflect": "^1.1.2",
     "jsonfile": "^2.0.0",
-    "useme": "^1.0.0",
+    "serve-index": "^1.6.3",
+    "serve-static": "^1.9.2",
     "yamljs": "^0.2.1"
   },
   "devDependencies": {
-    "nodeunit": "^0.9.1"
+    "nodeunit": "^0.9.1",
+    "nodeunit-express": "0.0.5"
   }
 }

README.md

@@ -7,7 +7,6 @@ # fileconfig
 
-Exprimenting with json configuration file loading
+Exprimenting with configuration file loading
 
+## Install it
 
-## Installation
-
 ```
@@ -19,4 +18,12 @@ npm install fileconfig -g
 
-## Usage
+## Use it
 
+### binaries
+
+#### fileconfig
+
+fires up a directory listing of *NODE_FILECONFIG_DIR* directory
+
+### JS library
+
 assuming you have a configuration folder as follow :
@@ -26,7 +33,2 @@
 + /path/to/config/folder
-  + apps
-    + demo
-      this.json
-      + users
-        hasnaer.json
   + servers
@@ -41,18 +43,2 @@ + share
 
-- apps/demo/this.json
-
-```json
-{
-  "name" : "Demo Application"
-}
-```
-
-- apps/demo/users/hasnaer.json
-
-```json
-{
-  "fullname" : "Hasnae Rehioui"  
-}
-```
-
 - servers/share/rnd/alpha.yml
@@ -75,12 +61,20 @@ ```yaml
 
-var demoApp = config.apps.demo;
-console.log(demoApp.name);
+var defaultServer = config.servers.share.default;
+console.log(defaultServer.name);
 
-// if at some point name property was edited in apps/demo/this.json
-// refresh using # prefix
-demoApp = config.apps['#demo']
+// if at some point name property was edited in servers/share/default.yml
+// or edited at runtime as follow
+defaultServer.port = 8080;
+// refresh from file using # prefix
+defaultServer = config.servers.share['#default'];
+
+// you can persist/store config objects to file
+defaultServer.name = "Share Aplha Server R&D";
+defaultServer.$persist();
 ```
 
-I also use it in my scripts, for instance :
+**Example use case**
 
+a command line program to serve a directory listing, the directories are configured
+
 - ~/bin/nodeHarmony
@@ -92,2 +86,3 @@
 ```
+*fileconfig relies on node harmony features, hence it requires script to be run with harmony flag on*
 
@@ -108,3 +103,3 @@ - ~/bin/serve
   .action(function () {
-    var serverConfig = config.servers[program.client];
+    var serverConfig = config.servers.share[program.client];
     var share = express();
@@ -111,0 +106,0 @@ share.use(serveIndex(serverConfig.dir, { icons : true, view : 'details' }));

test/config/server/share.json

 {
   "name": "Data share",
-  "port": 9090
+  "port": 9090,
+  "owner": {
+    "org": "labset"
+  }
 }

test/fileconfig_test.js

@@ -11,4 +11,6 @@ /**
 var jsonfile      = require('jsonfile');
+var request       = require('nodeunit-express');
 var config        = FileConfig.global();
 
+
 exports['fileconfig.basic'] = function (test) {
@@ -42,9 +44,63 @@ test.equal(config.server.share.port, 9090);
 
-exports['fileconfig.pathparam'] = function (test) {
+exports['fileconfig.#1.pathparam'] = function (test) {
   test.equals(config['server/share/port'],8080);
   test.equals(config['server/#share/port'], 9090);
   test.equals(config.server['ftp/port'], 7070);
-  var ftp = config['server/@value/ftp']
+  var ftp = config['server/@value/ftp'];
   test.equals(ftp.port, 7070);
   test.done();
 };
+
+exports['fileconfig.#5.FCInstance'] = function (test) {
+  var share = config.server.share;
+  test.equals(share['@value'].port, share.port);
+  test.done();
+};
+
+exports['fileconfig.#7.inspect'] = function (test) {
+  var server = config.server;
+  test.equals(server.inspect, server.inspect);
+  test.done();
+};
+
+
+exports['fileconfig.#3.ReadWrite.json'] = function (test) {
+  var share = config.server.share;
+  test.equals(share.port, 9090);
+  share.port = 10001;
+  test.equals(share.port, 10001);
+  share.$persist();
+  share = config.server['#share'];
+  test.equals(share.port, 10001);
+  share.port = 9090;
+  share.$persist();
+  test.done();
+};
+
+exports['fileconfig.#3.ReadWrite.yml'] = function (test) {
+  var ftp = config.server.ftp;
+  test.equals(ftp.port, 7070);
+  ftp.port = 20002;
+  test.equals(ftp.port, 20002);
+  ftp.$persist();
+  ftp = config.server['#ftp'];
+  test.equals(ftp.port, 20002);
+  ftp.port = 7070;
+  ftp.$persist();
+  test.done();
+};
+
+var app = require('../lib/serve');
+
+exports['fileconfig.#10.serve'] = function (test) {
+  var express = request(app);
+  express
+    .get('/server/share.json')
+    .expect(function (response) {
+      test.equal(response.statusCode, 200);
+      test.equal(response.headers['content-type'], 'application/json');
+      test.done();
+      express.close();
+    });
+};
+

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11087

increased by55.98%

Number of package files

10

increased by25%

Lines of code

236

increased by85.83%

Worsened metrics

Dependency count

6

increased by50%

Dev dependency count

2

increased by100%

Number of lines in readme file

117

decreased by-4.1%

Number of low supply chain risk alerts

4

increased by33.33%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedexpress@^4.12.3

• + Addedserve-index@^1.6.3

• + Addedserve-static@^1.9.2

• + Addedaccepts@1.3.8(transitive)

• + Addedarray-flatten@1.1.1(transitive)

• + Addedbatch@0.6.1(transitive)

• + Addedbody-parser@1.20.3(transitive)

• + Addedbytes@3.1.2(transitive)

• + Addedcall-bind-apply-helpers@1.0.2(transitive)

• + Addedcall-bound@1.0.3(transitive)

• + Addedcontent-disposition@0.5.4(transitive)

• + Addedcontent-type@1.0.5(transitive)

• + Addedcookie@0.7.1(transitive)

• + Addedcookie-signature@1.0.6(transitive)

• + Addeddebug@2.6.9(transitive)

• + Addeddepd@1.1.22.0.0(transitive)

• + Addeddestroy@1.2.0(transitive)

• + Addeddunder-proto@1.0.1(transitive)

• + Addedee-first@1.1.1(transitive)

• + Addedencodeurl@1.0.22.0.0(transitive)

• + Addedes-define-property@1.0.1(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes-object-atoms@1.1.1(transitive)

• + Addedescape-html@1.0.3(transitive)

• + Addedetag@1.8.1(transitive)

• + Addedexpress@4.21.2(transitive)

• + Addedfinalhandler@1.3.1(transitive)

• + Addedforwarded@0.2.0(transitive)

• + Addedfresh@0.5.2(transitive)

• + Addedfunction-bind@1.1.2(transitive)

• + Addedget-intrinsic@1.3.0(transitive)

• + Addedget-proto@1.0.1(transitive)

• + Addedgopd@1.2.0(transitive)

• + Addedhas-symbols@1.1.0(transitive)

• + Addedhasown@2.0.2(transitive)

• + Addedhttp-errors@1.6.32.0.0(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedinherits@2.0.3(transitive)

• + Addedipaddr.js@1.9.1(transitive)

• + Addedmath-intrinsics@1.1.0(transitive)

• + Addedmedia-typer@0.3.0(transitive)

• + Addedmerge-descriptors@1.0.3(transitive)

• + Addedmethods@1.1.2(transitive)

• + Addedmime@1.6.0(transitive)

• + Addedms@2.0.02.1.3(transitive)

• + Addednegotiator@0.6.3(transitive)

• + Addedobject-inspect@1.13.4(transitive)

• + Addedon-finished@2.4.1(transitive)

• + Addedparseurl@1.3.3(transitive)

• + Addedpath-to-regexp@0.1.12(transitive)

• + Addedproxy-addr@2.0.7(transitive)

• + Addedqs@6.13.0(transitive)

• + Addedrange-parser@1.2.1(transitive)

• + Addedraw-body@2.5.2(transitive)

• + Addedsend@0.19.0(transitive)

• + Addedserve-index@1.9.1(transitive)

• + Addedserve-static@1.16.2(transitive)

• + Addedsetprototypeof@1.1.01.2.0(transitive)

• + Addedside-channel@1.1.0(transitive)

• + Addedside-channel-list@1.0.0(transitive)

• + Addedside-channel-map@1.0.1(transitive)

• + Addedside-channel-weakmap@1.0.2(transitive)

• + Addedstatuses@1.5.02.0.1(transitive)

• + Addedtoidentifier@1.0.1(transitive)

• + Addedtype-is@1.6.18(transitive)

• + Addedunpipe@1.0.0(transitive)

• + Addedutils-merge@1.0.1(transitive)

• + Addedvary@1.1.2(transitive)

• - Removeduseme@^1.0.0

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedkingdomjs@1.4.0(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.15.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedq@1.5.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removedunderscore@1.13.7(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduseme@1.0.0(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)

• - Removedxmldom@0.1.31(transitive)