diff options
author | Forrest L Norvell <forrest@npmjs.com> | 2014-10-16 04:11:59 +0400 |
---|---|---|
committer | Forrest L Norvell <forrest@npmjs.com> | 2014-10-16 20:19:09 +0400 |
commit | 6a14b232a0e34158bd95bb25c607167be995c204 (patch) | |
tree | ffaa0dcbec04c002f246dbeb3aeb458e27757826 /node_modules/config-chain | |
parent | 344fa1a219ac8867022df3dc58a47636dde8a242 (diff) |
defactored npmconf back into npm
Diffstat (limited to 'node_modules/config-chain')
19 files changed, 1066 insertions, 0 deletions
diff --git a/node_modules/config-chain/.npmignore b/node_modules/config-chain/.npmignore new file mode 100644 index 000000000..13abef4f5 --- /dev/null +++ b/node_modules/config-chain/.npmignore @@ -0,0 +1,3 @@ +node_modules +node_modules/* +npm_debug.log diff --git a/node_modules/config-chain/LICENCE b/node_modules/config-chain/LICENCE new file mode 100644 index 000000000..171dd9700 --- /dev/null +++ b/node_modules/config-chain/LICENCE @@ -0,0 +1,22 @@ +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.
\ No newline at end of file diff --git a/node_modules/config-chain/index.js b/node_modules/config-chain/index.js new file mode 100755 index 000000000..0ef3a91f7 --- /dev/null +++ b/node_modules/config-chain/index.js @@ -0,0 +1,282 @@ +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) +} diff --git a/node_modules/config-chain/node_modules/proto-list/LICENSE b/node_modules/config-chain/node_modules/proto-list/LICENSE new file mode 100644 index 000000000..05a401094 --- /dev/null +++ b/node_modules/config-chain/node_modules/proto-list/LICENSE @@ -0,0 +1,23 @@ +Copyright 2009, 2010, 2011 Isaac Z. Schlueter. +All rights reserved. + +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. diff --git a/node_modules/config-chain/node_modules/proto-list/README.md b/node_modules/config-chain/node_modules/proto-list/README.md new file mode 100644 index 000000000..43cfa3589 --- /dev/null +++ b/node_modules/config-chain/node_modules/proto-list/README.md @@ -0,0 +1,3 @@ +A list of objects, bound by their prototype chain. + +Used in npm's config stuff. diff --git a/node_modules/config-chain/node_modules/proto-list/package.json b/node_modules/config-chain/node_modules/proto-list/package.json new file mode 100644 index 000000000..2dff2917c --- /dev/null +++ b/node_modules/config-chain/node_modules/proto-list/package.json @@ -0,0 +1,51 @@ +{ + "name": "proto-list", + "version": "1.2.3", + "description": "A utility for managing a prototype chain", + "main": "./proto-list.js", + "author": { + "name": "Isaac Z. Schlueter", + "email": "i@izs.me", + "url": "http://blog.izs.me/" + }, + "scripts": { + "test": "tap test/*.js" + }, + "repository": { + "type": "git", + "url": "https://github.com/isaacs/proto-list" + }, + "license": { + "type": "MIT", + "url": "https://github.com/isaacs/proto-list/blob/master/LICENSE" + }, + "devDependencies": { + "tap": "0" + }, + "gitHead": "44d76897176861d176a53ed3f3fc5e05cdee7643", + "bugs": { + "url": "https://github.com/isaacs/proto-list/issues" + }, + "homepage": "https://github.com/isaacs/proto-list", + "_id": "proto-list@1.2.3", + "_shasum": "6235554a1bca1f0d15e3ca12ca7329d5def42bd9", + "_from": "proto-list@~1.2.1", + "_npmVersion": "1.4.14", + "_npmUser": { + "name": "isaacs", + "email": "i@izs.me" + }, + "maintainers": [ + { + "name": "isaacs", + "email": "i@izs.me" + } + ], + "dist": { + "shasum": "6235554a1bca1f0d15e3ca12ca7329d5def42bd9", + "tarball": "http://registry.npmjs.org/proto-list/-/proto-list-1.2.3.tgz" + }, + "directories": {}, + "_resolved": "https://registry.npmjs.org/proto-list/-/proto-list-1.2.3.tgz", + "readme": "ERROR: No README data found!" +} diff --git a/node_modules/config-chain/node_modules/proto-list/proto-list.js b/node_modules/config-chain/node_modules/proto-list/proto-list.js new file mode 100644 index 000000000..b55c25c05 --- /dev/null +++ b/node_modules/config-chain/node_modules/proto-list/proto-list.js @@ -0,0 +1,88 @@ + +module.exports = ProtoList + +function setProto(obj, proto) { + if (typeof Object.setPrototypeOf === "function") + return Object.setPrototypeOf(obj, proto) + else + obj.__proto__ = proto +} + +function ProtoList () { + this.list = [] + var root = null + Object.defineProperty(this, 'root', { + get: function () { return root }, + set: function (r) { + root = r + if (this.list.length) { + setProto(this.list[this.list.length - 1], r) + } + }, + enumerable: true, + configurable: true + }) +} + +ProtoList.prototype = + { get length () { return this.list.length } + , get keys () { + var k = [] + for (var i in this.list[0]) k.push(i) + return k + } + , get snapshot () { + var o = {} + this.keys.forEach(function (k) { o[k] = this.get(k) }, this) + return o + } + , get store () { + return this.list[0] + } + , push : function (obj) { + if (typeof obj !== "object") obj = {valueOf:obj} + if (this.list.length >= 1) { + setProto(this.list[this.list.length - 1], obj) + } + setProto(obj, this.root) + return this.list.push(obj) + } + , pop : function () { + if (this.list.length >= 2) { + setProto(this.list[this.list.length - 2], this.root) + } + return this.list.pop() + } + , unshift : function (obj) { + setProto(obj, this.list[0] || this.root) + return this.list.unshift(obj) + } + , shift : function () { + if (this.list.length === 1) { + setProto(this.list[0], this.root) + } + return this.list.shift() + } + , get : function (key) { + return this.list[0][key] + } + , set : function (key, val, save) { + if (!this.length) this.push({}) + if (save && this.list[0].hasOwnProperty(key)) this.push({}) + return this.list[0][key] = val + } + , forEach : function (fn, thisp) { + for (var key in this.list[0]) fn.call(thisp, key, this.list[0][key]) + } + , slice : function () { + return this.list.slice.apply(this.list, arguments) + } + , splice : function () { + // handle injections + var ret = this.list.splice.apply(this.list, arguments) + for (var i = 0, l = this.list.length; i < l; i++) { + setProto(this.list[i], this.list[i + 1] || this.root) + } + return ret + } + } diff --git a/node_modules/config-chain/node_modules/proto-list/test/basic.js b/node_modules/config-chain/node_modules/proto-list/test/basic.js new file mode 100644 index 000000000..5cd66bef1 --- /dev/null +++ b/node_modules/config-chain/node_modules/proto-list/test/basic.js @@ -0,0 +1,61 @@ +var tap = require("tap") + , test = tap.test + , ProtoList = require("../proto-list.js") + +tap.plan(1) + +tap.test("protoList tests", function (t) { + var p = new ProtoList + p.push({foo:"bar"}) + p.push({}) + p.set("foo", "baz") + t.equal(p.get("foo"), "baz") + + var p = new ProtoList + p.push({foo:"bar"}) + p.set("foo", "baz") + t.equal(p.get("foo"), "baz") + t.equal(p.length, 1) + p.pop() + t.equal(p.length, 0) + p.set("foo", "asdf") + t.equal(p.length, 1) + t.equal(p.get("foo"), "asdf") + p.push({bar:"baz"}) + t.equal(p.length, 2) + t.equal(p.get("foo"), "asdf") + p.shift() + t.equal(p.length, 1) + t.equal(p.get("foo"), undefined) + + + p.unshift({foo:"blo", bar:"rab"}) + p.unshift({foo:"boo"}) + t.equal(p.length, 3) + t.equal(p.get("foo"), "boo") + t.equal(p.get("bar"), "rab") + + var ret = p.splice(1, 1, {bar:"bar"}) + t.same(ret, [{foo:"blo", bar:"rab"}]) + t.equal(p.get("bar"), "bar") + + // should not inherit default object properties + t.equal(p.get('hasOwnProperty'), undefined) + + // unless we give it those. + p.root = {} + t.equal(p.get('hasOwnProperty'), {}.hasOwnProperty) + + p.root = {default:'monkey'} + t.equal(p.get('default'), 'monkey') + + p.push({red:'blue'}) + p.push({red:'blue'}) + p.push({red:'blue'}) + while (p.length) { + t.equal(p.get('default'), 'monkey') + p.shift() + } + + t.end() +}) diff --git a/node_modules/config-chain/package.json b/node_modules/config-chain/package.json new file mode 100644 index 000000000..a07f2f414 --- /dev/null +++ b/node_modules/config-chain/package.json @@ -0,0 +1,54 @@ +{ + "name": "config-chain", + "version": "1.1.8", + "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" + }, + "devDependencies": { + "tap": "0.3.0" + }, + "author": { + "name": "Dominic Tarr", + "email": "dominic.tarr@gmail.com", + "url": "http://dominictarr.com" + }, + "scripts": { + "test": "tap test/" + }, + "readme": "#config-chain\n\nUSE THIS MODULE TO LOAD ALL YOUR CONFIGURATIONS\n\n``` js\n\n //npm install config-chain\n\n var cc = require('config-chain')\n , opts = require('optimist').argv //ALWAYS USE OPTIMIST FOR COMMAND LINE OPTIONS.\n , env = opts.env || process.env.YOUR_APP_ENV || 'dev' //SET YOUR ENV LIKE THIS.\n\n // EACH ARG TO CONFIGURATOR IS LOADED INTO CONFIGURATION CHAIN\n // EARLIER ITEMS OVERIDE LATER ITEMS\n // PUTS COMMAND LINE OPTS FIRST, AND DEFAULTS LAST!\n\n //strings are interpereted as filenames.\n //will be loaded synchronously\n\n var conf =\n cc(\n //OVERRIDE SETTINGS WITH COMMAND LINE OPTS\n opts,\n\n //ENV VARS IF PREFIXED WITH 'myApp_'\n\n cc.env('myApp_'), //myApp_foo = 'like this'\n\n //FILE NAMED BY ENV\n path.join(__dirname, 'config.' + env + '.json'),\n\n //IF `env` is PRODUCTION\n env === 'prod'\n ? path.join(__dirname, 'special.json') //load a special file\n : null //NULL IS IGNORED!\n\n //SUBDIR FOR ENV CONFIG\n path.join(__dirname, 'config', env, 'config.json'),\n\n //SEARCH PARENT DIRECTORIES FROM CURRENT DIR FOR FILE\n cc.find('config.json'),\n\n //PUT DEFAULTS LAST\n {\n host: 'localhost'\n port: 8000\n })\n\n var host = conf.get('host')\n\n // or\n\n var host = conf.store.host\n\n```\n\nFINALLY, EASY FLEXIBLE CONFIGURATIONS!\n\n##see also: [proto-list](https://github.com/isaacs/proto-list/)\n\nWHATS THAT YOU SAY?\n\nYOU WANT A \"CLASS\" SO THAT YOU CAN DO CRAYCRAY JQUERY CRAPS?\n\nEXTEND WITH YOUR OWN FUNCTIONALTY!?\n\n## CONFIGCHAIN LIVES TO SERVE ONLY YOU!\n\n```javascript\nvar cc = require('config-chain')\n\n// all the stuff you did before\nvar config = cc({\n some: 'object'\n },\n cc.find('config.json'),\n cc.env('myApp_')\n )\n // CONFIGS AS A SERVICE, aka \"CaaS\", aka EVERY DEVOPS DREAM OMG!\n .addUrl('http://configurator:1234/my-configs')\n // ASYNC FTW!\n .addFile('/path/to/file.json')\n\n // OBJECTS ARE OK TOO, they're SYNC but they still ORDER RIGHT\n // BECAUSE PROMISES ARE USED BUT NO, NOT *THOSE* PROMISES, JUST\n // ACTUAL PROMISES LIKE YOU MAKE TO YOUR MOM, KEPT OUT OF LOVE\n .add({ another: 'object' })\n\n // DIE A THOUSAND DEATHS IF THIS EVER HAPPENS!!\n .on('error', function (er) {\n // IF ONLY THERE WAS SOMETHIGN HARDER THAN THROW\n // MY SORROW COULD BE ADEQUATELY EXPRESSED. /o\\\n throw er\n })\n\n // THROW A PARTY IN YOUR FACE WHEN ITS ALL LOADED!!\n .on('load', function (config) {\n console.awesome('HOLY SHIT!')\n })\n```\n\n# BORING API DOCS\n\n## cc(...args)\n\nMAKE A CHAIN AND ADD ALL THE ARGS.\n\nIf the arg is a STRING, then it shall be a JSON FILENAME.\n\nSYNC I/O!\n\nRETURN THE CHAIN!\n\n## cc.json(...args)\n\nJoin the args INTO A JSON FILENAME!\n\nSYNC I/O!\n\n## cc.find(relativePath)\n\nSEEK the RELATIVE PATH by climbing the TREE OF DIRECTORIES.\n\nRETURN THE FOUND PATH!\n\nSYNC I/O!\n\n## cc.parse(content, file, type)\n\nParse the content string, and guess the type from either the\nspecified type or the filename.\n\nRETURN THE RESULTING OBJECT!\n\nNO I/O!\n\n## cc.env(prefix, env=process.env)\n\nGet all the keys on the provided env object (or process.env) which are\nprefixed by the specified prefix, and put the values on a new object.\n\nRETURN THE RESULTING OBJECT!\n\nNO I/O!\n\n## cc.ConfigChain()\n\nThe ConfigChain class for CRAY CRAY JQUERY STYLE METHOD CHAINING!\n\nOne of these is returned by the main exported function, as well.\n\nIt inherits (prototypically) from\n[ProtoList](https://github.com/isaacs/proto-list/), and also inherits\n(parasitically) from\n[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)\n\nIt has all the methods from both, and except where noted, they are\nunchanged.\n\n### LET IT BE KNOWN THAT chain IS AN INSTANCE OF ConfigChain.\n\n## chain.sources\n\nA list of all the places where it got stuff. The keys are the names\npassed to addFile or addUrl etc, and the value is an object with some\ninfo about the data source.\n\n## chain.addFile(filename, type, [name=filename])\n\nFilename is the name of the file. Name is an arbitrary string to be\nused later if you desire. Type is either 'ini' or 'json', and will\ntry to guess intelligently if omitted.\n\nLoaded files can be saved later.\n\n## chain.addUrl(url, type, [name=url])\n\nSame as the filename thing, but with a url.\n\nCan't be saved later.\n\n## chain.addEnv(prefix, env, [name='env'])\n\nAdd all the keys from the env object that start with the prefix.\n\n## chain.addString(data, file, type, [name])\n\nParse the string and add it to the set. (Mainly used internally.)\n\n## chain.add(object, [name])\n\nAdd the object to the set.\n\n## chain.root {Object}\n\nThe root from which all the other config objects in the set descend\nprototypically.\n\nPut your defaults here.\n\n## chain.set(key, value, name)\n\nSet the key to the value on the named config object. If name is\nunset, then set it on the first config object in the set. (That is,\nthe one with the highest priority, which was added first.)\n\n## chain.get(key, [name])\n\nGet the key from the named config object explicitly, or from the\nresolved configs if not specified.\n\n## chain.save(name, type)\n\nWrite the named config object back to its origin.\n\nCurrently only supported for env and file config types.\n\nFor files, encode the data according to the type.\n\n## chain.on('save', function () {})\n\nWhen one or more files are saved, emits `save` event when they're all\nsaved.\n\n## chain.on('load', function (chain) {})\n\nWhen the config chain has loaded all the specified files and urls and\nsuch, the 'load' event fires.\n", + "readmeFilename": "readme.markdown", + "bugs": { + "url": "https://github.com/dominictarr/config-chain/issues" + }, + "_id": "config-chain@1.1.8", + "dist": { + "shasum": "0943d0b7227213a20d4eaff4434f4a1c0a052cad", + "tarball": "http://registry.npmjs.org/config-chain/-/config-chain-1.1.8.tgz" + }, + "_from": "config-chain@^1.1.8", + "_npmVersion": "1.3.6", + "_npmUser": { + "name": "dominictarr", + "email": "dominic.tarr@gmail.com" + }, + "maintainers": [ + { + "name": "dominictarr", + "email": "dominic.tarr@gmail.com" + }, + { + "name": "isaacs", + "email": "i@izs.me" + } + ], + "directories": {}, + "_shasum": "0943d0b7227213a20d4eaff4434f4a1c0a052cad", + "_resolved": "https://registry.npmjs.org/config-chain/-/config-chain-1.1.8.tgz" +} diff --git a/node_modules/config-chain/readme.markdown b/node_modules/config-chain/readme.markdown new file mode 100644 index 000000000..c83a43067 --- /dev/null +++ b/node_modules/config-chain/readme.markdown @@ -0,0 +1,228 @@ +#config-chain + +USE THIS MODULE TO LOAD ALL YOUR CONFIGURATIONS + +``` 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. diff --git a/node_modules/config-chain/test/broken.js b/node_modules/config-chain/test/broken.js new file mode 100644 index 000000000..101a3e4f5 --- /dev/null +++ b/node_modules/config-chain/test/broken.js @@ -0,0 +1,10 @@ + + +var cc = require('..') +var assert = require('assert') + + +//throw on invalid json +assert.throws(function () { + cc(__dirname + '/broken.json') +}) diff --git a/node_modules/config-chain/test/broken.json b/node_modules/config-chain/test/broken.json new file mode 100644 index 000000000..2107ac18d --- /dev/null +++ b/node_modules/config-chain/test/broken.json @@ -0,0 +1,21 @@ +{ + "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 <dominic.tarr@gmail.com> (http://dominictarr.com)", + "scripts": { + "test": "node test/find-file.js && node test/ini.js && node test/env.js" + } +} diff --git a/node_modules/config-chain/test/chain-class.js b/node_modules/config-chain/test/chain-class.js new file mode 100644 index 000000000..bbc0d4cb2 --- /dev/null +++ b/node_modules/config-chain/test/chain-class.js @@ -0,0 +1,100 @@ +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() + }) +}) diff --git a/node_modules/config-chain/test/env.js b/node_modules/config-chain/test/env.js new file mode 100644 index 000000000..fb718f32b --- /dev/null +++ b/node_modules/config-chain/test/env.js @@ -0,0 +1,10 @@ +var cc = require('..') +var assert = require('assert') + +assert.deepEqual({ + hello: true +}, cc.env('test_', { + 'test_hello': true, + 'ignore_this': 4, + 'ignore_test_this_too': [] +})) diff --git a/node_modules/config-chain/test/find-file.js b/node_modules/config-chain/test/find-file.js new file mode 100644 index 000000000..23cde52ea --- /dev/null +++ b/node_modules/config-chain/test/find-file.js @@ -0,0 +1,13 @@ + +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')
\ No newline at end of file diff --git a/node_modules/config-chain/test/get.js b/node_modules/config-chain/test/get.js new file mode 100644 index 000000000..d6fd79f74 --- /dev/null +++ b/node_modules/config-chain/test/get.js @@ -0,0 +1,15 @@ +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")); + }); diff --git a/node_modules/config-chain/test/ignore-unfound-file.js b/node_modules/config-chain/test/ignore-unfound-file.js new file mode 100644 index 000000000..d742b82ba --- /dev/null +++ b/node_modules/config-chain/test/ignore-unfound-file.js @@ -0,0 +1,5 @@ + +var cc = require('..') + +//should not throw +cc(__dirname, 'non_existing_file') diff --git a/node_modules/config-chain/test/ini.js b/node_modules/config-chain/test/ini.js new file mode 100644 index 000000000..5572a6ed6 --- /dev/null +++ b/node_modules/config-chain/test/ini.js @@ -0,0 +1,18 @@ + + +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}) + diff --git a/node_modules/config-chain/test/save.js b/node_modules/config-chain/test/save.js new file mode 100644 index 000000000..783461317 --- /dev/null +++ b/node_modules/config-chain/test/save.js @@ -0,0 +1,59 @@ +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() + }) + }) +}) |