pax_global_header00006660000000000000000000000064125346217430014521gustar00rootroot0000000000000052 comment=4a3001abc4c608e51add9f1d2b2cadf02b8e6dea ini-1.3.4/000077500000000000000000000000001253462174300123055ustar00rootroot00000000000000ini-1.3.4/.gitignore000066400000000000000000000000151253462174300142710ustar00rootroot00000000000000node_modules ini-1.3.4/.travis.yml000066400000000000000000000001641253462174300144170ustar00rootroot00000000000000language: node_js node_js: - '0.8' - '0.10' - '0.12' - 'iojs' before_install: - npm install -g npm@latest ini-1.3.4/LICENSE000066400000000000000000000013751253462174300133200ustar00rootroot00000000000000The ISC License Copyright (c) Isaac Z. Schlueter and Contributors Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ini-1.3.4/README.md000066400000000000000000000052361253462174300135720ustar00rootroot00000000000000An ini format parser and serializer for node. Sections are treated as nested objects. Items before the first heading are saved on the object directly. ## Usage Consider an ini-file `config.ini` that looks like this: ; this comment is being ignored scope = global [database] user = dbuser password = dbpassword database = use_this_database [paths.default] datadir = /var/lib/data array[] = first value array[] = second value array[] = third value You can read, manipulate and write the ini-file like so: var fs = require('fs') , ini = require('ini') var config = ini.parse(fs.readFileSync('./config.ini', 'utf-8')) config.scope = 'local' config.database.database = 'use_another_database' config.paths.default.tmpdir = '/tmp' delete config.paths.default.datadir config.paths.default.array.push('fourth value') fs.writeFileSync('./config_modified.ini', ini.stringify(config, { section: 'section' })) This will result in a file called `config_modified.ini` being written to the filesystem with the following content: [section] scope=local [section.database] user=dbuser password=dbpassword database=use_another_database [section.paths.default] tmpdir=/tmp array[]=first value array[]=second value array[]=third value array[]=fourth value ## API ### decode(inistring) Decode the ini-style formatted `inistring` into a nested object. ### parse(inistring) Alias for `decode(inistring)` ### encode(object, [options]) Encode the object `object` into an ini-style formatted string. If the optional parameter `section` is given, then all top-level properties of the object are put into this section and the `section`-string is prepended to all sub-sections, see the usage example above. The `options` object may contain the following: * `section` A string which will be the first `section` in the encoded ini data. Defaults to none. * `whitespace` Boolean to specify whether to put whitespace around the `=` character. By default, whitespace is omitted, to be friendly to some persnickety old parsers that don't tolerate it well. But some find that it's more human-readable and pretty with the whitespace. For backwards compatibility reasons, if a `string` options is passed in, then it is assumed to be the `section` value. ### stringify(object, [options]) Alias for `encode(object, [options])` ### safe(val) Escapes the string `val` such that it is safe to be used as a key or value in an ini-file. Basically escapes quotes. For example ini.safe('"unsafe string"') would result in "\"unsafe string\"" ### unsafe(val) Unescapes the string `val` ini-1.3.4/ini.js000066400000000000000000000113211253462174300134200ustar00rootroot00000000000000 exports.parse = exports.decode = decode exports.stringify = exports.encode = encode exports.safe = safe exports.unsafe = unsafe var eol = process.platform === "win32" ? "\r\n" : "\n" function encode (obj, opt) { var children = [] , out = "" if (typeof opt === "string") { opt = { section: opt, whitespace: false } } else { opt = opt || {} opt.whitespace = opt.whitespace === true } var separator = opt.whitespace ? " = " : "=" Object.keys(obj).forEach(function (k, _, __) { var val = obj[k] if (val && Array.isArray(val)) { val.forEach(function(item) { out += safe(k + "[]") + separator + safe(item) + "\n" }) } else if (val && typeof val === "object") { children.push(k) } else { out += safe(k) + separator + safe(val) + eol } }) if (opt.section && out.length) { out = "[" + safe(opt.section) + "]" + eol + out } children.forEach(function (k, _, __) { var nk = dotSplit(k).join('\\.') var section = (opt.section ? opt.section + "." : "") + nk var child = encode(obj[k], { section: section, whitespace: opt.whitespace }) if (out.length && child.length) { out += eol } out += child }) return out } function dotSplit (str) { return str.replace(/\1/g, '\u0002LITERAL\\1LITERAL\u0002') .replace(/\\\./g, '\u0001') .split(/\./).map(function (part) { return part.replace(/\1/g, '\\.') .replace(/\2LITERAL\\1LITERAL\2/g, '\u0001') }) } function decode (str) { var out = {} , p = out , section = null , state = "START" // section |key = value , re = /^\[([^\]]*)\]$|^([^=]+)(=(.*))?$/i , lines = str.split(/[\r\n]+/g) , section = null lines.forEach(function (line, _, __) { if (!line || line.match(/^\s*[;#]/)) return var match = line.match(re) if (!match) return if (match[1] !== undefined) { section = unsafe(match[1]) p = out[section] = out[section] || {} return } var key = unsafe(match[2]) , value = match[3] ? unsafe((match[4] || "")) : true switch (value) { case 'true': case 'false': case 'null': value = JSON.parse(value) } // Convert keys with '[]' suffix to an array if (key.length > 2 && key.slice(-2) === "[]") { key = key.substring(0, key.length - 2) if (!p[key]) { p[key] = [] } else if (!Array.isArray(p[key])) { p[key] = [p[key]] } } // safeguard against resetting a previously defined // array by accidentally forgetting the brackets if (Array.isArray(p[key])) { p[key].push(value) } else { p[key] = value } }) // {a:{y:1},"a.b":{x:2}} --> {a:{y:1,b:{x:2}}} // use a filter to return the keys that have to be deleted. Object.keys(out).filter(function (k, _, __) { if (!out[k] || typeof out[k] !== "object" || Array.isArray(out[k])) return false // see if the parent section is also an object. // if so, add it to that, and mark this one for deletion var parts = dotSplit(k) , p = out , l = parts.pop() , nl = l.replace(/\\\./g, '.') parts.forEach(function (part, _, __) { if (!p[part] || typeof p[part] !== "object") p[part] = {} p = p[part] }) if (p === out && nl === l) return false p[nl] = out[k] return true }).forEach(function (del, _, __) { delete out[del] }) return out } function isQuoted (val) { return (val.charAt(0) === "\"" && val.slice(-1) === "\"") || (val.charAt(0) === "'" && val.slice(-1) === "'") } function safe (val) { return ( typeof val !== "string" || val.match(/[=\r\n]/) || val.match(/^\[/) || (val.length > 1 && isQuoted(val)) || val !== val.trim() ) ? JSON.stringify(val) : val.replace(/;/g, '\\;').replace(/#/g, "\\#") } function unsafe (val, doUnesc) { val = (val || "").trim() if (isQuoted(val)) { // remove the single quotes before calling JSON.parse if (val.charAt(0) === "'") { val = val.substr(1, val.length - 2); } try { val = JSON.parse(val) } catch (_) {} } else { // walk the val to find the first not-escaped ; character var esc = false var unesc = ""; for (var i = 0, l = val.length; i < l; i++) { var c = val.charAt(i) if (esc) { if ("\\;#".indexOf(c) !== -1) unesc += c else unesc += "\\" + c esc = false } else if (";#".indexOf(c) !== -1) { break } else if (c === "\\") { esc = true } else { unesc += c } } if (esc) unesc += "\\" return unesc } return val } ini-1.3.4/package.json000066400000000000000000000007311253462174300145740ustar00rootroot00000000000000{ "author": "Isaac Z. Schlueter (http://blog.izs.me/)", "name": "ini", "description": "An ini encoder/decoder for node", "version": "1.3.4", "repository": { "type": "git", "url": "git://github.com/isaacs/ini.git" }, "main": "ini.js", "scripts": { "test": "tap test/*.js" }, "engines": { "node": "*" }, "dependencies": {}, "devDependencies": { "tap": "^1.2.0" }, "license": "ISC", "files": [ "ini.js" ] } ini-1.3.4/test/000077500000000000000000000000001253462174300132645ustar00rootroot00000000000000ini-1.3.4/test/bar.js000066400000000000000000000007261253462174300143730ustar00rootroot00000000000000//test that parse(stringify(obj) deepEqu var ini = require('../') var test = require('tap').test var data = { 'number': {count: 10}, 'string': {drink: 'white russian'}, 'boolean': {isTrue: true}, 'nested boolean': {theDude: {abides: true, rugCount: 1}} } test('parse(stringify(x)) deepEqual x', function (t) { for (var k in data) { var s = ini.stringify(data[k]) console.log(s, data[k]) t.deepEqual(ini.parse(s), data[k]) } t.end() }) ini-1.3.4/test/fixtures/000077500000000000000000000000001253462174300151355ustar00rootroot00000000000000ini-1.3.4/test/fixtures/foo.ini000066400000000000000000000024611253462174300164240ustar00rootroot00000000000000o = p a with spaces = b c ; wrap in quotes to JSON-decode and preserve spaces " xa n p " = "\"\r\nyoyoyo\r\r\n" ; wrap in quotes to get a key with a bracket, not a section. "[disturbing]" = hey you never know ; Test single quotes s = 'something' ; Test mixing quotes s1 = "something' ; Test double quotes s2 = "something else" ; Test arrays zr[] = deedee ar[] = one ar[] = three ; This should be included in the array ar = this is included ; Test resetting of a value (and not turn it into an array) br = cold br = warm eq = "eq=eq" ; a section [a] av = a val e = { o: p, a: { av: a val, b: { c: { e: "this [value]" } } } } j = "{ o: "p", a: { av: "a val", b: { c: { e: "this [value]" } } } }" "[]" = a square? ; Nested array cr[] = four cr[] = eight ; nested child without middle parent ; should create otherwise-empty a.b [a.b.c] e = 1 j = 2 ; dots in the section name should be literally interpreted [x\.y\.z] x.y.z = xyz [x\.y\.z.a\.b\.c] a.b.c = abc ; this next one is not a comment! it's escaped! nocomment = this\; this is not a comment # Support the use of the number sign (#) as an alternative to the semicolon for indicating comments. # http://en.wikipedia.org/wiki/INI_file#Comments # this next one is not a comment! it's escaped! noHashComment = this\# this is not a comment ini-1.3.4/test/foo.js000066400000000000000000000063121253462174300144070ustar00rootroot00000000000000var i = require("../") , tap = require("tap") , test = tap.test , fs = require("fs") , path = require("path") , fixture = path.resolve(__dirname, "./fixtures/foo.ini") , data = fs.readFileSync(fixture, "utf8") , d , expectE = 'o=p\n' + 'a with spaces=b c\n' + '" xa n p "="\\"\\r\\nyoyoyo\\r\\r\\n"\n' + '"[disturbing]"=hey you never know\n' + 's=something\n' + 's1=\"something\'\n' + 's2=something else\n' + 'zr[]=deedee\n' + 'ar[]=one\n' + 'ar[]=three\n' + 'ar[]=this is included\n' + 'br=warm\n' + 'eq=\"eq=eq\"\n' + '\n' + '[a]\n' + 'av=a val\n' + 'e={ o: p, a: ' + '{ av: a val, b: { c: { e: "this [value]" ' + '} } } }\nj="\\"{ o: \\"p\\", a: { av:' + ' \\"a val\\", b: { c: { e: \\"this [value]' + '\\" } } } }\\""\n"[]"=a square?\n' + 'cr[]=four\ncr[]=eight\n\n' +'[a.b.c]\ne=1\n' + 'j=2\n\n[x\\.y\\.z]\nx.y.z=xyz\n\n' + '[x\\.y\\.z.a\\.b\\.c]\na.b.c=abc\n' + 'nocomment=this\\; this is not a comment\n' + 'noHashComment=this\\# this is not a comment\n' , expectD = { o: 'p', 'a with spaces': 'b c', " xa n p ":'"\r\nyoyoyo\r\r\n', '[disturbing]': 'hey you never know', 's': 'something', 's1' : '\"something\'', 's2': 'something else', 'zr': ['deedee'], 'ar': ['one', 'three', 'this is included'], 'br': 'warm', 'eq': 'eq=eq', a: { av: 'a val', e: '{ o: p, a: { av: a val, b: { c: { e: "this [value]" } } } }', j: '"{ o: "p", a: { av: "a val", b: { c: { e: "this [value]" } } } }"', "[]": "a square?", cr: ['four', 'eight'], b: { c: { e: '1', j: '2' } } }, 'x.y.z': { 'x.y.z': 'xyz', 'a.b.c': { 'a.b.c': 'abc', 'nocomment': 'this\; this is not a comment', noHashComment: 'this\# this is not a comment' } } } , expectF = '[prefix.log]\n' + 'type=file\n\n' + '[prefix.log.level]\n' + 'label=debug\n' + 'value=10\n' , expectG = '[log]\n' + 'type = file\n\n' + '[log.level]\n' + 'label = debug\n' + 'value = 10\n' test("decode from file", function (t) { var d = i.decode(data) t.deepEqual(d, expectD) t.end() }) test("encode from data", function (t) { var e = i.encode(expectD) t.deepEqual(e, expectE) var obj = {log: { type:'file', level: {label:'debug', value:10} } } e = i.encode(obj) t.notEqual(e.slice(0, 1), '\n', 'Never a blank first line') t.notEqual(e.slice(-2), '\n\n', 'Never a blank final line') t.end() }) test("encode with option", function (t) { var obj = {log: { type:'file', level: {label:'debug', value:10} } } e = i.encode(obj, {section: 'prefix'}) t.equal(e, expectF) t.end() }) test("encode with whitespace", function (t) { var obj = {log: { type:'file', level: {label:'debug', value:10} } } e = i.encode(obj, {whitespace: true}) t.equal(e, expectG) t.end() })