qs 5.0.0 → 5.1.0

package/.travis.yml

@@ -1,7 +1,7 @@
 language: node_js
-sudo: false
 
 node_js:
-  - "0.10"
-  - 0.12
-  - iojs
+  - 0.10
+  - 4.0
+
+sudo: false

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 
-## [**4.0.1**](https://github.com/hapijs/qs/issues?milestone=27&state=open)
+## [**5.1.0**](https://github.com/hapijs/qs/issues?milestone=29&state=open)
+- [**#117**](https://github.com/hapijs/qs/issues/117) make URI encoding stringified results optional
+- [**#106**](https://github.com/hapijs/qs/issues/106) Add flag `skipNulls` to optionally skip null values in stringify
+
+## [**5.0.0**](https://github.com/hapijs/qs/issues?milestone=28&state=closed)
+- [**#114**](https://github.com/hapijs/qs/issues/114) default allowDots to false
 - [**#100**](https://github.com/hapijs/qs/issues/100) include dist to npm
 
 ## [**4.0.0**](https://github.com/hapijs/qs/issues?milestone=26&state=closed)

package/README.md

@@ -23,7 +23,7 @@ var str = Qs.stringify(obj);  // 'a=c'
 Qs.parse(string, [options]);
 ```
 
-**qs** allows you to create nested objects within your query strings, by surrounding the name of sub-keys with square brackets `[]`, or prefixing the sub-key with a dot `.`.
+**qs** allows you to create nested objects within your query strings, by surrounding the name of sub-keys with square brackets `[]`.
 For example, the string `'foo[bar]=baz'` converts to:
 
 ```javascript
@@ -118,11 +118,11 @@ Qs.parse('a=b;c=d,e=f', { delimiter: /[;,]/ });
 // { a: 'b', c: 'd', e: 'f' }
 ```
 
-Option `allowDots` can be used to disable dot notation:
+Option `allowDots` can be used to enable dot notation:
 
 ```javascript
-Qs.parse('a.b=c', { allowDots: false });
-// { 'a.b': 'c' } }
+Qs.parse('a.b=c', { allowDots: true });
+// { a: { b: 'c' } }
 ```
 
 ### Parsing Arrays
@@ -315,3 +315,10 @@ Qs.parse('a&b=', { strictNullHandling: true });
 // { a: null, b: '' }
 
 ```
+
+To completely skip rendering keys with `null` values, use the `skipNulls` flag:
+
+```javascript
+qs.stringify({ a: 'b', c: null}, { skipNulls: true })
+// 'a=b'
+```

package/bower.json

@@ -1,7 +1,7 @@
 {
   "name": "qs",
   "main": "dist/qs.js",
-  "version": "4.0.0",
+  "version": "5.1.0",
   "homepage": "https://github.com/hapijs/qs",
   "authors": [
     "Nathan LaFreniere <quitlahok@gmail.com>"

package/component.json

@@ -0,0 +1,15 @@
+{
+  "name": "qs",
+  "repository": "hapijs/qs",
+  "description": "query-string parser / stringifier with nesting support",
+  "version": "5.1.0",
+  "keywords": ["querystring", "query", "parser"],
+  "main": "lib/index.js",
+  "scripts": [
+    "lib/index.js",
+    "lib/parse.js",
+    "lib/stringify.js",
+    "lib/utils.js"
+  ],
+  "license": "BSD-3-Clause"
+}

package/dist/qs.js

@@ -30,7 +30,8 @@ var internals = {
     parameterLimit: 1000,
     strictNullHandling: false,
     plainObjects: false,
-    allowPrototypes: false
+    allowPrototypes: false,
+    allowDots: false
 };
 
 
@@ -175,7 +176,7 @@ module.exports = function (str, options) {
     options.depth = typeof options.depth === 'number' ? options.depth : internals.depth;
     options.arrayLimit = typeof options.arrayLimit === 'number' ? options.arrayLimit : internals.arrayLimit;
     options.parseArrays = options.parseArrays !== false;
-    options.allowDots = options.allowDots !== false;
+    options.allowDots = typeof options.allowDots === 'boolean' ? options.allowDots : internals.allowDots;
     options.plainObjects = typeof options.plainObjects === 'boolean' ? options.plainObjects : internals.plainObjects;
     options.allowPrototypes = typeof options.allowPrototypes === 'boolean' ? options.allowPrototypes : internals.allowPrototypes;
     options.parameterLimit = typeof options.parameterLimit === 'number' ? options.parameterLimit : internals.parameterLimit;

package/lib/stringify.js

@@ -21,11 +21,13 @@ var internals = {
             return prefix;
         }
     },
-    strictNullHandling: false
+    strictNullHandling: false,
+    skipNulls: false,
+    encode: true
 };
 
 
-internals.stringify = function (obj, prefix, generateArrayPrefix, strictNullHandling, filter) {
+internals.stringify = function (obj, prefix, generateArrayPrefix, strictNullHandling, skipNulls, encode, filter) {
 
     if (typeof filter === 'function') {
         obj = filter(prefix, obj);
@@ -38,7 +40,7 @@ internals.stringify = function (obj, prefix, generateArrayPrefix, strictNullHand
     }
     else if (obj === null) {
         if (strictNullHandling) {
-            return Utils.encode(prefix);
+            return encode ? Utils.encode(prefix) : prefix;
         }
 
         obj = '';
@@ -48,7 +50,10 @@ internals.stringify = function (obj, prefix, generateArrayPrefix, strictNullHand
         typeof obj === 'number' ||
         typeof obj === 'boolean') {
 
-        return [Utils.encode(prefix) + '=' + Utils.encode(obj)];
+        if (encode) {
+            return [Utils.encode(prefix) + '=' + Utils.encode(obj)];
+        }
+        return [prefix + '=' + obj];
     }
 
     var values = [];
@@ -61,11 +66,17 @@ internals.stringify = function (obj, prefix, generateArrayPrefix, strictNullHand
     for (var i = 0, il = objKeys.length; i < il; ++i) {
         var key = objKeys[i];
 
+        if (skipNulls &&
+            obj[key] === null) {
+
+            continue;
+        }
+
         if (Array.isArray(obj)) {
-            values = values.concat(internals.stringify(obj[key], generateArrayPrefix(prefix, key), generateArrayPrefix, strictNullHandling, filter));
+            values = values.concat(internals.stringify(obj[key], generateArrayPrefix(prefix, key), generateArrayPrefix, strictNullHandling, skipNulls, encode, filter));
         }
         else {
-            values = values.concat(internals.stringify(obj[key], prefix + '[' + key + ']', generateArrayPrefix, strictNullHandling, filter));
+            values = values.concat(internals.stringify(obj[key], prefix + '[' + key + ']', generateArrayPrefix, strictNullHandling, skipNulls, encode, filter));
         }
     }
 
@@ -78,6 +89,8 @@ module.exports = function (obj, options) {
     options = options || {};
     var delimiter = typeof options.delimiter === 'undefined' ? internals.delimiter : options.delimiter;
     var strictNullHandling = typeof options.strictNullHandling === 'boolean' ? options.strictNullHandling : internals.strictNullHandling;
+    var skipNulls = typeof options.skipNulls === 'boolean' ? options.skipNulls : internals.skipNulls;
+    var encode = typeof options.encode === 'boolean' ? options.encode : internals.encode;
     var objKeys;
     var filter;
     if (typeof options.filter === 'function') {
@@ -112,9 +125,17 @@ module.exports = function (obj, options) {
     if (!objKeys) {
         objKeys = Object.keys(obj);
     }
+
     for (var i = 0, il = objKeys.length; i < il; ++i) {
         var key = objKeys[i];
-        keys = keys.concat(internals.stringify(obj[key], key, generateArrayPrefix, strictNullHandling, filter));
+
+        if (skipNulls &&
+            obj[key] === null) {
+
+            continue;
+        }
+
+        keys = keys.concat(internals.stringify(obj[key], key, generateArrayPrefix, strictNullHandling, skipNulls, encode, filter));
     }
 
     return keys.join(delimiter);

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "qs",
-  "version": "5.0.0",
   "description": "A querystring parser that supports nesting and arrays, with a depth limit",
   "homepage": "https://github.com/hapijs/qs",
+  "version": "5.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hapijs/qs.git"
+  },
   "main": "lib/index.js",
+  "keywords": [
+    "querystring",
+    "qs"
+  ],
+  "engines": ">=0.10.40",
   "dependencies": {},
   "devDependencies": {
     "browserify": "^10.2.1",
@@ -12,16 +21,9 @@
   },
   "scripts": {
     "test": "lab -a code -t 100 -L",
+    "test-tap": "lab -a code -r tap -o tests.tap",
     "test-cov-html": "lab -a code -r html -o coverage.html",
     "dist": "browserify --standalone Qs lib/index.js > dist/qs.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/hapijs/qs.git"
-  },
-  "keywords": [
-    "querystring",
-    "qs"
-  ],
   "license": "BSD-3-Clause"
 }

package/test/stringify.js

@@ -47,6 +47,19 @@ describe('stringify()', function () {
         done();
     });
 
+    it('omits nulls when asked', function (done) {
+
+        expect(Qs.stringify({ a: 'b', c: null }, { skipNulls: true })).to.equal('a=b');
+        done();
+    });
+
+
+    it('omits nested nulls when asked', function (done) {
+
+        expect(Qs.stringify({ a: { b: 'c', d: null } }, { skipNulls: true })).to.equal('a%5Bb%5D=c');
+        done();
+    });
+
     it('omits array indices when asked', function (done) {
 
         expect(Qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false })).to.equal('a=b&a=c&a=d');
@@ -257,4 +270,12 @@ describe('stringify()', function () {
         done();
 
     });
+
+    it('can disable uri encoding', function (done) {
+
+        expect(Qs.stringify({ a: 'b' }, { encode: false })).to.equal('a=b');
+        expect(Qs.stringify({ a: { b: 'c' } }, { encode: false })).to.equal('a[b]=c');
+        expect(Qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false })).to.equal('a=b&c');
+        done();
+    });
 });