package/package.json000644 001750 001750 0000001222 12774605475013035 0ustar00000000 000000 { "name": "config-chain", "version": "1.1.11", "licenses": [ { "type": "MIT", "url": "https://raw.githubusercontent.com/dominictarr/config-chain/master/LICENCE" } ], "description": "HANDLE CONFIGURATION ONCE AND FOR ALL", "homepage": "http://github.com/dominictarr/config-chain", "repository": { "type": "git", "url": "https://github.com/dominictarr/config-chain.git" }, "dependencies": { "proto-list": "~1.2.1", "ini": "^1.3.4" }, "devDependencies": { "tap": "0.3.0" }, "author": "Dominic Tarr (http://dominictarr.com)", "scripts": { "test": "tap test/" } } package/.npmignore000644 001750 001750 0000000052 12647060742012535 0ustar00000000 000000 node_modules node_modules/* npm_debug.log package/LICENCE000644 001750 001750 0000002056 12647060742011531 0ustar00000000 000000 Copyright (c) 2011 Dominic Tarr 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/index.js000755 001750 001750 0000016050 12647060742012213 0ustar00000000 000000 var ProtoList = require('proto-list') , path = require('path') , fs = require('fs') , ini = require('ini') , EE = require('events').EventEmitter , url = require('url') , http = require('http') var exports = module.exports = function () { var args = [].slice.call(arguments) , conf = new ConfigChain() while(args.length) { var a = args.shift() if(a) conf.push ( 'string' === typeof a ? json(a) : a ) } return conf } //recursively find a file... var find = exports.find = function () { var rel = path.join.apply(null, [].slice.call(arguments)) function find(start, rel) { var file = path.join(start, rel) try { fs.statSync(file) return file } catch (err) { if(path.dirname(start) !== start) // root return find(path.dirname(start), rel) } } return find(__dirname, rel) } var parse = exports.parse = function (content, file, type) { content = '' + content // if we don't know what it is, try json and fall back to ini // if we know what it is, then it must be that. if (!type) { try { return JSON.parse(content) } catch (er) { return ini.parse(content) } } else if (type === 'json') { if (this.emit) { try { return JSON.parse(content) } catch (er) { this.emit('error', er) } } else { return JSON.parse(content) } } else { return ini.parse(content) } } var json = exports.json = function () { var args = [].slice.call(arguments).filter(function (arg) { return arg != null }) var file = path.join.apply(null, args) var content try { content = fs.readFileSync(file,'utf-8') } catch (err) { return } return parse(content, file, 'json') } var env = exports.env = function (prefix, env) { env = env || process.env var obj = {} var l = prefix.length for(var k in env) { if(k.indexOf(prefix) === 0) obj[k.substring(l)] = env[k] } return obj } exports.ConfigChain = ConfigChain function ConfigChain () { EE.apply(this) ProtoList.apply(this, arguments) this._awaiting = 0 this._saving = 0 this.sources = {} } // multi-inheritance-ish var extras = { constructor: { value: ConfigChain } } Object.keys(EE.prototype).forEach(function (k) { extras[k] = Object.getOwnPropertyDescriptor(EE.prototype, k) }) ConfigChain.prototype = Object.create(ProtoList.prototype, extras) ConfigChain.prototype.del = function (key, where) { // if not specified where, then delete from the whole chain, scorched // earth style if (where) { var target = this.sources[where] target = target && target.data if (!target) { return this.emit('error', new Error('not found '+where)) } delete target[key] } else { for (var i = 0, l = this.list.length; i < l; i ++) { delete this.list[i][key] } } return this } ConfigChain.prototype.set = function (key, value, where) { var target if (where) { target = this.sources[where] target = target && target.data if (!target) { return this.emit('error', new Error('not found '+where)) } } else { target = this.list[0] if (!target) { return this.emit('error', new Error('cannot set, no confs!')) } } target[key] = value return this } ConfigChain.prototype.get = function (key, where) { if (where) { where = this.sources[where] if (where) where = where.data if (where && Object.hasOwnProperty.call(where, key)) return where[key] return undefined } return this.list[0][key] } ConfigChain.prototype.save = function (where, type, cb) { if (typeof type === 'function') cb = type, type = null var target = this.sources[where] if (!target || !(target.path || target.source) || !target.data) { // TODO: maybe save() to a url target could be a PUT or something? // would be easy to swap out with a reddis type thing, too return this.emit('error', new Error('bad save target: '+where)) } if (target.source) { var pref = target.prefix || '' Object.keys(target.data).forEach(function (k) { target.source[pref + k] = target.data[k] }) return this } var type = type || target.type var data = target.data if (target.type === 'json') { data = JSON.stringify(data) } else { data = ini.stringify(data) } this._saving ++ fs.writeFile(target.path, data, 'utf8', function (er) { this._saving -- if (er) { if (cb) return cb(er) else return this.emit('error', er) } if (this._saving === 0) { if (cb) cb() this.emit('save') } }.bind(this)) return this } ConfigChain.prototype.addFile = function (file, type, name) { name = name || file var marker = {__source__:name} this.sources[name] = { path: file, type: type } this.push(marker) this._await() fs.readFile(file, 'utf8', function (er, data) { if (er) this.emit('error', er) this.addString(data, file, type, marker) }.bind(this)) return this } ConfigChain.prototype.addEnv = function (prefix, env, name) { name = name || 'env' var data = exports.env(prefix, env) this.sources[name] = { data: data, source: env, prefix: prefix } return this.add(data, name) } ConfigChain.prototype.addUrl = function (req, type, name) { this._await() var href = url.format(req) name = name || href var marker = {__source__:name} this.sources[name] = { href: href, type: type } this.push(marker) http.request(req, function (res) { var c = [] var ct = res.headers['content-type'] if (!type) { type = ct.indexOf('json') !== -1 ? 'json' : ct.indexOf('ini') !== -1 ? 'ini' : href.match(/\.json$/) ? 'json' : href.match(/\.ini$/) ? 'ini' : null marker.type = type } res.on('data', c.push.bind(c)) .on('end', function () { this.addString(Buffer.concat(c), href, type, marker) }.bind(this)) .on('error', this.emit.bind(this, 'error')) }.bind(this)) .on('error', this.emit.bind(this, 'error')) .end() return this } ConfigChain.prototype.addString = function (data, file, type, marker) { data = this.parse(data, file, type) this.add(data, marker) return this } ConfigChain.prototype.add = function (data, marker) { if (marker && typeof marker === 'object') { var i = this.list.indexOf(marker) if (i === -1) { return this.emit('error', new Error('bad marker')) } this.splice(i, 1, data) marker = marker.__source__ this.sources[marker] = this.sources[marker] || {} this.sources[marker].data = data // we were waiting for this. maybe emit 'load' this._resolve() } else { if (typeof marker === 'string') { this.sources[marker] = this.sources[marker] || {} this.sources[marker].data = data } // trigger the load event if nothing was already going to do so. this._await() this.push(data) process.nextTick(this._resolve.bind(this)) } return this } ConfigChain.prototype.parse = exports.parse ConfigChain.prototype._await = function () { this._awaiting++ } ConfigChain.prototype._resolve = function () { this._awaiting-- if (this._awaiting === 0) this.emit('load', this) } package/readme.markdown000644 001750 001750 0000013222 12774605427013550 0ustar00000000 000000 #config-chain USE THIS MODULE TO LOAD ALL YOUR CONFIGURATIONS ## NOTE: Feature Freeze [![locked](http://badges.github.io/stability-badges/dist/locked.svg)](http://github.com/badges/stability-badges) This module is frozen. In general, I'd recommend using [rc](https://github.com/dominictarr/rc) instead, but as [npm](https://github.com/npmjs/npm) depends on this, it cannot be changed. ``` js //npm install config-chain var cc = require('config-chain') , opts = require('optimist').argv //ALWAYS USE OPTIMIST FOR COMMAND LINE OPTIONS. , env = opts.env || process.env.YOUR_APP_ENV || 'dev' //SET YOUR ENV LIKE THIS. // EACH ARG TO CONFIGURATOR IS LOADED INTO CONFIGURATION CHAIN // EARLIER ITEMS OVERIDE LATER ITEMS // PUTS COMMAND LINE OPTS FIRST, AND DEFAULTS LAST! //strings are interpereted as filenames. //will be loaded synchronously var conf = cc( //OVERRIDE SETTINGS WITH COMMAND LINE OPTS opts, //ENV VARS IF PREFIXED WITH 'myApp_' cc.env('myApp_'), //myApp_foo = 'like this' //FILE NAMED BY ENV path.join(__dirname, 'config.' + env + '.json'), //IF `env` is PRODUCTION env === 'prod' ? path.join(__dirname, 'special.json') //load a special file : null //NULL IS IGNORED! //SUBDIR FOR ENV CONFIG path.join(__dirname, 'config', env, 'config.json'), //SEARCH PARENT DIRECTORIES FROM CURRENT DIR FOR FILE cc.find('config.json'), //PUT DEFAULTS LAST { host: 'localhost' port: 8000 }) var host = conf.get('host') // or var host = conf.store.host ``` FINALLY, EASY FLEXIBLE CONFIGURATIONS! ##see also: [proto-list](https://github.com/isaacs/proto-list/) WHATS THAT YOU SAY? YOU WANT A "CLASS" SO THAT YOU CAN DO CRAYCRAY JQUERY CRAPS? EXTEND WITH YOUR OWN FUNCTIONALTY!? ## CONFIGCHAIN LIVES TO SERVE ONLY YOU! ```javascript var cc = require('config-chain') // all the stuff you did before var config = cc({ some: 'object' }, cc.find('config.json'), cc.env('myApp_') ) // CONFIGS AS A SERVICE, aka "CaaS", aka EVERY DEVOPS DREAM OMG! .addUrl('http://configurator:1234/my-configs') // ASYNC FTW! .addFile('/path/to/file.json') // OBJECTS ARE OK TOO, they're SYNC but they still ORDER RIGHT // BECAUSE PROMISES ARE USED BUT NO, NOT *THOSE* PROMISES, JUST // ACTUAL PROMISES LIKE YOU MAKE TO YOUR MOM, KEPT OUT OF LOVE .add({ another: 'object' }) // DIE A THOUSAND DEATHS IF THIS EVER HAPPENS!! .on('error', function (er) { // IF ONLY THERE WAS SOMETHIGN HARDER THAN THROW // MY SORROW COULD BE ADEQUATELY EXPRESSED. /o\ throw er }) // THROW A PARTY IN YOUR FACE WHEN ITS ALL LOADED!! .on('load', function (config) { console.awesome('HOLY SHIT!') }) ``` # BORING API DOCS ## cc(...args) MAKE A CHAIN AND ADD ALL THE ARGS. If the arg is a STRING, then it shall be a JSON FILENAME. SYNC I/O! RETURN THE CHAIN! ## cc.json(...args) Join the args INTO A JSON FILENAME! SYNC I/O! ## cc.find(relativePath) SEEK the RELATIVE PATH by climbing the TREE OF DIRECTORIES. RETURN THE FOUND PATH! SYNC I/O! ## cc.parse(content, file, type) Parse the content string, and guess the type from either the specified type or the filename. RETURN THE RESULTING OBJECT! NO I/O! ## cc.env(prefix, env=process.env) Get all the keys on the provided env object (or process.env) which are prefixed by the specified prefix, and put the values on a new object. RETURN THE RESULTING OBJECT! NO I/O! ## cc.ConfigChain() The ConfigChain class for CRAY CRAY JQUERY STYLE METHOD CHAINING! One of these is returned by the main exported function, as well. It inherits (prototypically) from [ProtoList](https://github.com/isaacs/proto-list/), and also inherits (parasitically) from [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter) It has all the methods from both, and except where noted, they are unchanged. ### LET IT BE KNOWN THAT chain IS AN INSTANCE OF ConfigChain. ## chain.sources A list of all the places where it got stuff. The keys are the names passed to addFile or addUrl etc, and the value is an object with some info about the data source. ## chain.addFile(filename, type, [name=filename]) Filename is the name of the file. Name is an arbitrary string to be used later if you desire. Type is either 'ini' or 'json', and will try to guess intelligently if omitted. Loaded files can be saved later. ## chain.addUrl(url, type, [name=url]) Same as the filename thing, but with a url. Can't be saved later. ## chain.addEnv(prefix, env, [name='env']) Add all the keys from the env object that start with the prefix. ## chain.addString(data, file, type, [name]) Parse the string and add it to the set. (Mainly used internally.) ## chain.add(object, [name]) Add the object to the set. ## chain.root {Object} The root from which all the other config objects in the set descend prototypically. Put your defaults here. ## chain.set(key, value, name) Set the key to the value on the named config object. If name is unset, then set it on the first config object in the set. (That is, the one with the highest priority, which was added first.) ## chain.get(key, [name]) Get the key from the named config object explicitly, or from the resolved configs if not specified. ## chain.save(name, type) Write the named config object back to its origin. Currently only supported for env and file config types. For files, encode the data according to the type. ## chain.on('save', function () {}) When one or more files are saved, emits `save` event when they're all saved. ## chain.on('load', function (chain) {}) When the config chain has loaded all the specified files and urls and such, the 'load' event fires. package/test/broken.js000644 001750 001750 0000000222 12647060742013332 0ustar00000000 000000 var cc = require('..') var assert = require('assert') //throw on invalid json assert.throws(function () { cc(__dirname + '/broken.json') }) package/test/chain-class.js000644 001750 001750 0000006202 12647060742014243 0ustar00000000 000000 var test = require('tap').test var CC = require('../index.js').ConfigChain var env = { foo_blaz : 'blzaa', foo_env : 'myenv' } var jsonObj = { blaz: 'json', json: true } var iniObj = { 'x.y.z': 'xyz', blaz: 'ini' } var fs = require('fs') var ini = require('ini') fs.writeFileSync('/tmp/config-chain-class.json', JSON.stringify(jsonObj)) fs.writeFileSync('/tmp/config-chain-class.ini', ini.stringify(iniObj)) var http = require('http') var reqs = 0 http.createServer(function (q, s) { if (++reqs === 2) this.close() if (q.url === '/json') { // make sure that the requests come back from the server // out of order. they should still be ordered properly // in the resulting config object set. setTimeout(function () { s.setHeader('content-type', 'application/json') s.end(JSON.stringify({ blaz: 'http', http: true, json: true })) }, 200) } else { s.setHeader('content-type', 'application/ini') s.end(ini.stringify({ blaz: 'http', http: true, ini: true, json: false })) } }).listen(1337) test('basic class test', function (t) { var cc = new CC() var expectlist = [ { blaz: 'json', json: true }, { 'x.y.z': 'xyz', blaz: 'ini' }, { blaz: 'blzaa', env: 'myenv' }, { blaz: 'http', http: true, json: true }, { blaz: 'http', http: true, ini: true, json: false } ] cc.addFile('/tmp/config-chain-class.json') .addFile('/tmp/config-chain-class.ini') .addEnv('foo_', env) .addUrl('http://localhost:1337/json') .addUrl('http://localhost:1337/ini') .on('load', function () { t.same(cc.list, expectlist) t.same(cc.snapshot, { blaz: 'json', json: true, 'x.y.z': 'xyz', env: 'myenv', http: true, ini: true }) cc.del('blaz', '/tmp/config-chain-class.json') t.same(cc.snapshot, { blaz: 'ini', json: true, 'x.y.z': 'xyz', env: 'myenv', http: true, ini: true }) cc.del('blaz') t.same(cc.snapshot, { json: true, 'x.y.z': 'xyz', env: 'myenv', http: true, ini: true }) cc.shift() t.same(cc.snapshot, { 'x.y.z': 'xyz', env: 'myenv', http: true, json: true, ini: true }) cc.shift() t.same(cc.snapshot, { env: 'myenv', http: true, json: true, ini: true }) cc.shift() t.same(cc.snapshot, { http: true, json: true, ini: true }) cc.shift() t.same(cc.snapshot, { http: true, ini: true, json: false }) cc.shift() t.same(cc.snapshot, {}) t.end() }) }) package/test/env.js000644 001750 001750 0000000270 12647060742012645 0ustar00000000 000000 var cc = require('..') var assert = require('assert') assert.deepEqual({ hello: true }, cc.env('test_', { 'test_hello': true, 'ignore_this': 4, 'ignore_test_this_too': [] })) package/test/find-file.js000644 001750 001750 0000000446 12647060742013717 0ustar00000000 000000 var fs = require('fs') , assert = require('assert') , objx = { rand: Math.random() } fs.writeFileSync('/tmp/random-test-config.json', JSON.stringify(objx)) var cc = require('../') var path = cc.find('tmp/random-test-config.json') assert.equal(path, '/tmp/random-test-config.json')package/test/get.js000644 001750 001750 0000000607 12647060742012640 0ustar00000000 000000 var cc = require("../"); var chain = cc() , name = "forFun"; chain .add({ __sample:"for fun only" }, name) .on("load", function() { //It throw exception here console.log(chain.get("__sample", name)); //But if I drop the name param, it run normally and return as expected: "for fun only" //console.log(chain.get("__sample")); }); package/test/ignore-unfound-file.js000644 001750 001750 0000000117 12647060742015731 0ustar00000000 000000 var cc = require('..') //should not throw cc(__dirname, 'non_existing_file') package/test/ini.js000644 001750 001750 0000000456 12647060742012642 0ustar00000000 000000 var cc =require('..') var INI = require('ini') var assert = require('assert') function test(obj) { var _json, _ini var json = cc.parse (_json = JSON.stringify(obj)) var ini = cc.parse (_ini = INI.stringify(obj)) console.log(_ini, _json) assert.deepEqual(json, ini) } test({hello: true}) package/test/save.js000644 001750 001750 0000003455 12647060742013023 0ustar00000000 000000 var CC = require('../index.js').ConfigChain var test = require('tap').test var f1 = '/tmp/f1.ini' var f2 = '/tmp/f2.json' var ini = require('ini') var f1data = {foo: {bar: 'baz'}, bloo: 'jaus'} var f2data = {oof: {rab: 'zab'}, oolb: 'suaj'} var fs = require('fs') fs.writeFileSync(f1, ini.stringify(f1data), 'utf8') fs.writeFileSync(f2, JSON.stringify(f2data), 'utf8') test('test saving and loading ini files', function (t) { new CC() .add({grelb:'blerg'}, 'opt') .addFile(f1, 'ini', 'inifile') .addFile(f2, 'json', 'jsonfile') .on('load', function (cc) { t.same(cc.snapshot, { grelb: 'blerg', bloo: 'jaus', foo: { bar: 'baz' }, oof: { rab: 'zab' }, oolb: 'suaj' }) t.same(cc.list, [ { grelb: 'blerg' }, { bloo: 'jaus', foo: { bar: 'baz' } }, { oof: { rab: 'zab' }, oolb: 'suaj' } ]) cc.set('grelb', 'brelg', 'opt') .set('foo', 'zoo', 'inifile') .set('oof', 'ooz', 'jsonfile') .save('inifile') .save('jsonfile') .on('save', function () { t.equal(fs.readFileSync(f1, 'utf8'), "bloo=jaus\nfoo=zoo\n") t.equal(fs.readFileSync(f2, 'utf8'), "{\"oof\":\"ooz\",\"oolb\":\"suaj\"}") t.same(cc.snapshot, { grelb: 'brelg', bloo: 'jaus', foo: 'zoo', oof: 'ooz', oolb: 'suaj' }) t.same(cc.list, [ { grelb: 'brelg' }, { bloo: 'jaus', foo: 'zoo' }, { oof: 'ooz', oolb: 'suaj' } ]) t.pass('ok') t.end() }) }) }) package/test/broken.json000644 001750 001750 0000001257 12647060742013700 0ustar00000000 000000 { "name": "config-chain", "version": "0.3.0", "description": "HANDLE CONFIGURATION ONCE AND FOR ALL", "homepage": "http://github.com/dominictarr/config-chain", "repository": { "type": "git", "url": "https://github.com/dominictarr/config-chain.git" } //missing , and then this comment. this json is intensionally invalid "dependencies": { "proto-list": "1", "ini": "~1.0.2" }, "bundleDependencies": ["ini"], "REM": "REMEMBER TO REMOVE BUNDLING WHEN/IF ISAACS MERGES ini#7", "author": "Dominic Tarr (http://dominictarr.com)", "scripts": { "test": "node test/find-file.js && node test/ini.js && node test/env.js" } }