qs 0.3.1 → 0.4.2

package/.travis.yml

@@ -0,0 +1,4 @@
+language: node_js
+node_js:
+  - 0.6
+  - 0.4

package/History.md

@@ -1,4 +1,25 @@
 
+0.4.2 / 2012-02-08 
+==================
+
+  * Fixed: ensure objects are created when appropriate not arrays [aheckmann]
+
+0.4.1 / 2012-01-26 
+==================
+
+  * Fixed stringify()ing numbers. Closes #23
+
+0.4.0 / 2011-11-21 
+==================
+
+  * Allow parsing of an existing object (for `bodyParser()`) [jackyz]
+  * Replaced expresso with mocha
+
+0.3.2 / 2011-11-08 
+==================
+
+  * Fixed global variable leak
+
 0.3.1 / 2011-08-17 
 ==================
 

package/Makefile

@@ -1,7 +1,5 @@
 
 test:
-	@./node_modules/.bin/expresso \
-		-I support \
-		-I lib
+	@./node_modules/.bin/mocha
 
 .PHONY: test

package/Readme.md

@@ -6,18 +6,23 @@
 
     $ npm install qs
 
-
 ## Examples
 
-    require('qs').parse('user[name][first]=tj&user[email]=tj');
-    // => { user: { name: { first: 'tj' }, email: 'tj' } }
+```js
+var qs = require('qs');
+
+qs.parse('user[name][first]=Tobi&user[email]=tobi@learnboost.com');
+// => { user: { name: { first: 'Tobi' }, email: 'tobi@learnboost.com' } }
+
+qs.stringify({ user: { name: 'Tobi', email: 'tobi@learnboost.com' }})
+// => user[name]=Tobi&user[email]=tobi%40learnboost.com
+```
 
 ## Testing
 
-Update git submodules:
+Install dev dependencies:
 
-    $ git submodule init
-    $ git submodule update
+    $ npm install -d
 
 and execute:
 

package/examples.js

@@ -46,3 +46,6 @@ console.log(obj)
 
 var obj = qs.parse('user[0]=tj&user[foo]=TJ');
 console.log(obj)
+
+var str = qs.stringify({ user: { name: 'Tobi', email: 'tobi@learnboost.com' }});
+console.log(str);

package/lib/querystring.js

@@ -1,3 +1,4 @@
+
 /*!
  * querystring
  * Copyright(c) 2010 TJ Holowaychuk <tj@vision-media.ca>
@@ -8,7 +9,7 @@
  * Library version.
  */
 
-exports.version = '0.3.1';
+exports.version = '0.4.2';
 
 /**
  * Object#toString() ref for stringify().
@@ -20,31 +21,97 @@ var toString = Object.prototype.toString;
  * Cache non-integer test regexp.
  */
 
-var notint = /[^0-9]/;
+var isint = /^[0-9]+$/;
+
+function promote(parent, key) {
+  if (parent[key].length == 0) return parent[key] = {};
+  var t = {};
+  for (var i in parent[key]) t[i] = parent[key][i];
+  parent[key] = t;
+  return t;
+}
+
+function parse(parts, parent, key, val) {
+  var part = parts.shift();
+  // end
+  if (!part) {
+    if (Array.isArray(parent[key])) {
+      parent[key].push(val);
+    } else if ('object' == typeof parent[key]) {
+      parent[key] = val;
+    } else if ('undefined' == typeof parent[key]) {
+      parent[key] = val;
+    } else {
+      parent[key] = [parent[key], val];
+    }
+    // array
+  } else {
+    var obj = parent[key] = parent[key] || [];
+    if (']' == part) {
+      if (Array.isArray(obj)) {
+        if ('' != val) obj.push(val);
+      } else if ('object' == typeof obj) {
+        obj[Object.keys(obj).length] = val;
+      } else {
+        obj = parent[key] = [parent[key], val];
+      }
+      // prop
+    } else if (~part.indexOf(']')) {
+      part = part.substr(0, part.length - 1);
+      if (!isint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
+      parse(parts, obj, part, val);
+      // key
+    } else {
+      if (!isint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
+      parse(parts, obj, part, val);
+    }
+  }
+}
 
 /**
- * Parse the given query `str`, returning an object.
- *
- * @param {String} str
- * @return {Object}
- * @api public
+ * Merge parent key/val pair.
  */
 
-exports.parse = function(str){
-  if (null == str || '' == str) return {};
-
-  function promote(parent, key) {
-    if (parent[key].length == 0) return parent[key] = {};
-    var t = {};
-    for (var i in parent[key]) t[i] = parent[key][i];
-    parent[key] = t;
-    return t;
+function merge(parent, key, val){
+  if (~key.indexOf(']')) {
+    var parts = key.split('[')
+      , len = parts.length
+      , last = len - 1;
+    parse(parts, parent, 'base', val);
+    // optimize
+  } else {
+    if (!isint.test(key) && Array.isArray(parent.base)) {
+      var t = {};
+      for (var k in parent.base) t[k] = parent.base[k];
+      parent.base = t;
+    }
+    set(parent.base, key, val);
   }
 
+  return parent;
+}
+
+/**
+ * Parse the given obj.
+ */
+
+function parseObject(obj){
+  var ret = { base: {} };
+  Object.keys(obj).forEach(function(name){
+    merge(ret, name, obj[name]);
+  });
+  return ret.base;
+}
+
+/**
+ * Parse the given str.
+ */
+
+function parseString(str){
   return String(str)
     .split('&')
     .reduce(function(ret, pair){
-      try{ 
+      try{
         pair = decodeURIComponent(pair.replace(/\+/g, ' '));
       } catch(e) {
         // ignore
@@ -54,69 +121,28 @@ exports.parse = function(str){
         , brace = lastBraceInKey(pair)
         , key = pair.substr(0, brace || eql)
         , val = pair.substr(brace || eql, pair.length)
-        , val = val.substr(val.indexOf('=') + 1, val.length)
-        , parent = ret;
+        , val = val.substr(val.indexOf('=') + 1, val.length);
 
       // ?foo
       if ('' == key) key = pair, val = '';
 
-      // nested
-      if (~key.indexOf(']')) {
-        var parts = key.split('[')
-          , len = parts.length
-          , last = len - 1;
-
-        function parse(parts, parent, key) {
-          var part = parts.shift();
-
-          // end
-          if (!part) {
-            if (Array.isArray(parent[key])) {
-              parent[key].push(val);
-            } else if ('object' == typeof parent[key]) {
-              parent[key] = val;
-            } else if ('undefined' == typeof parent[key]) {
-              parent[key] = val;
-            } else {
-              parent[key] = [parent[key], val];
-            }
-          // array
-          } else {
-            obj = parent[key] = parent[key] || [];
-            if (']' == part) {
-              if (Array.isArray(obj)) {
-                if ('' != val) obj.push(val);
-              } else if ('object' == typeof obj) {
-                obj[Object.keys(obj).length] = val;
-              } else {
-                obj = parent[key] = [parent[key], val];
-              }
-            // prop
-            } else if (~part.indexOf(']')) {
-              part = part.substr(0, part.length - 1);
-              if(notint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
-              parse(parts, obj, part);
-            // key
-            } else {
-              if(notint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
-              parse(parts, obj, part);
-            }
-          }
-        }
-
-        parse(parts, parent, 'base');
-      // optimize
-      } else {
-        if (notint.test(key) && Array.isArray(parent.base)) {
-          var t = {};
-          for(var k in parent.base) t[k] = parent.base[k];
-          parent.base = t;
-        }
-        set(parent.base, key, val);
-      }
+      return merge(ret, key, val);
+    }, { base: {} }).base;
+}
 
-      return ret;
-    }, {base: {}}).base;
+/**
+ * Parse the given query `str` or `obj`, returning an object.
+ *
+ * @param {String} str | {Object} obj
+ * @return {Object}
+ * @api public
+ */
+
+exports.parse = function(str){
+  if (null == str || '' == str) return {};
+  return 'object' == typeof str
+    ? parseObject(str)
+    : parseString(str);
 };
 
 /**
@@ -135,7 +161,7 @@ var stringify = exports.stringify = function(obj, prefix) {
   } else if ('string' == typeof obj) {
     return stringifyString(obj, prefix);
   } else {
-    return prefix;
+    return prefix + '=' + obj;
   }
 };
 
@@ -184,12 +210,14 @@ function stringifyObject(obj, prefix) {
   var ret = []
     , keys = Object.keys(obj)
     , key;
+
   for (var i = 0, len = keys.length; i < len; ++i) {
     key = keys[i];
     ret.push(stringify(obj[key], prefix
       ? prefix + '[' + encodeURIComponent(key) + ']'
       : encodeURIComponent(key)));
   }
+
   return ret.join('&');
 }
 

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "qs",
   "description": "querystring parser",
-  "version": "0.3.1",
+  "version": "0.4.2",
   "repository": {
     "type" : "git",
     "url" : "git://github.com/visionmedia/node-querystring.git"
   },
   "devDependencies": {
-      "expresso": "0.9.2"
+      "mocha": "*"
     , "should": "*"
   },
   "author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",

package/test/mocha.opts

@@ -0,0 +1,2 @@
+--require should
+--ui exports

package/test/{parse.test.js → parse.js}

@@ -3,8 +3,7 @@
  * Module dependencies.
  */
 
-var qs = require('../')
-  , should = require('should');
+var qs = require('../');
 
 module.exports = {
   'test basics': function(){
@@ -92,8 +91,12 @@ module.exports = {
 
     qs.parse('user[name][first]=tj&user[name][first]=TJ')
       .should.eql({ user: { name: { first: ['tj', 'TJ'] }}});
+
+    var o = qs.parse('existing[fcbaebfecc][name][last]=tj')
+    o.should.eql({ existing: { 'fcbaebfecc': { name: { last: 'tj' }}}})
+    Array.isArray(o.existing).should.be.false;
   },
-  
+
   'test right-hand brackets': function(){
     qs.parse('pets=["tobi"]')
       .should.eql({ pets: '["tobi"]' });
@@ -140,6 +143,14 @@ module.exports = {
   'test malformed uri': function(){
     qs.parse('{%:%}').should.eql({ '{%:%}': '' });
     qs.parse('foo=%:%}').should.eql({ 'foo': '%:%}' });
+  },
+
+  'test semi-parsed': function(){
+    qs.parse({ 'user[name]': 'tobi' })
+      .should.eql({ user: { name: 'tobi' }});
+
+    qs.parse({ 'user[name]': 'tobi', 'user[email][main]': 'tobi@lb.com' })
+      .should.eql({ user: { name: 'tobi', email: { main: 'tobi@lb.com' } }});
   }
   
   // 'test complex': function(){

package/test/stringify.js

@@ -0,0 +1,103 @@
+
+/**
+ * Module dependencies.
+ */
+
+var qs = require('../')
+  , should = require('should')
+  , str_identities = {
+    'basics': [
+      { str: 'foo=bar', obj: {'foo' : 'bar'}},
+      { str: 'foo=%22bar%22', obj: {'foo' : '\"bar\"'}},
+      { str: 'foo=', obj: {'foo': ''}},
+      { str: 'foo=1&bar=2', obj: {'foo' : '1', 'bar' : '2'}},
+      { str: 'my%20weird%20field=q1!2%22\'w%245%267%2Fz8)%3F', obj: {'my weird field': "q1!2\"'w$5&7/z8)?"}},
+      { str: 'foo%3Dbaz=bar', obj: {'foo=baz': 'bar'}},
+      { str: 'foo=bar&bar=baz', obj: {foo: 'bar', bar: 'baz'}}
+    ],
+    'escaping': [
+      { str: 'foo=foo%20bar', obj: {foo: 'foo bar'}},
+      { str: 'cht=p3&chd=t%3A60%2C40&chs=250x100&chl=Hello%7CWorld', obj: {
+          cht: 'p3'
+        , chd: 't:60,40'
+        , chs: '250x100'
+        , chl: 'Hello|World'
+      }}
+    ],
+    'nested': [
+      { str: 'foo[]=bar&foo[]=quux', obj: {'foo' : ['bar', 'quux']}},
+      { str: 'foo[]=bar', obj: {foo: ['bar']}},
+      { str: 'foo[]=1&foo[]=2', obj: {'foo' : ['1', '2']}},
+      { str: 'foo=bar&baz[]=1&baz[]=2&baz[]=3', obj: {'foo' : 'bar', 'baz' : ['1', '2', '3']}},
+      { str: 'foo[]=bar&baz[]=1&baz[]=2&baz[]=3', obj: {'foo' : ['bar'], 'baz' : ['1', '2', '3']}},
+      { str: 'x[y][z]=1', obj: {'x' : {'y' : {'z' : '1'}}}},
+      { str: 'x[y][z][]=1', obj: {'x' : {'y' : {'z' : ['1']}}}},
+      { str: 'x[y][z]=2', obj: {'x' : {'y' : {'z' : '2'}}}},
+      { str: 'x[y][z][]=1&x[y][z][]=2', obj: {'x' : {'y' : {'z' : ['1', '2']}}}},
+      { str: 'x[y][][z]=1', obj: {'x' : {'y' : [{'z' : '1'}]}}},
+      { str: 'x[y][][z][]=1', obj: {'x' : {'y' : [{'z' : ['1']}]}}},
+      { str: 'x[y][][z]=1&x[y][][w]=2', obj: {'x' : {'y' : [{'z' : '1', 'w' : '2'}]}}},
+      { str: 'x[y][][v][w]=1', obj: {'x' : {'y' : [{'v' : {'w' : '1'}}]}}},
+      { str: 'x[y][][z]=1&x[y][][v][w]=2', obj: {'x' : {'y' : [{'z' : '1', 'v' : {'w' : '2'}}]}}},
+      { str: 'x[y][][z]=1&x[y][][z]=2', obj: {'x' : {'y' : [{'z' : '1'}, {'z' : '2'}]}}},
+      { str: 'x[y][][z]=1&x[y][][w]=a&x[y][][z]=2&x[y][][w]=3', obj: {'x' : {'y' : [{'z' : '1', 'w' : 'a'}, {'z' : '2', 'w' : '3'}]}}},
+      { str: 'user[name][first]=tj&user[name][last]=holowaychuk', obj: { user: { name: { first: 'tj', last: 'holowaychuk' }}}}
+    ],
+    'errors': [
+      { obj: 'foo=bar',     message: 'stringify expects an object' },
+      { obj: ['foo', 'bar'], message: 'stringify expects an object' }
+    ],
+    'numbers': [
+      { str: 'limit[]=1&limit[]=2&limit[]=3', obj: { limit: [1, 2, '3'] }},
+      { str: 'limit=1', obj: { limit: 1 }}
+    ]
+  };
+  
+
+// Assert error
+function err(fn, msg){
+  var err;
+  try {
+    fn();
+  } catch (e) {
+    should.equal(e.message, msg);
+    return;
+  }
+  throw new Error('no exception thrown, expected "' + msg + '"');
+}
+
+function test(type) {
+  var str, obj;
+  for (var i = 0; i < str_identities[type].length; i++) {
+    str = str_identities[type][i].str;
+    obj = str_identities[type][i].obj;
+    qs.stringify(obj).should.eql(str);
+  }
+}
+
+module.exports = {
+  'test basics': function() {
+    test('basics');
+  },
+
+  'test escaping': function() {
+    test('escaping');
+  },
+
+  'test nested': function() {
+    test('nested');
+  },
+  
+  'test numbers': function(){
+    test('numbers');
+  },
+
+  'test errors': function() {
+    var obj, message;
+    for (var i = 0; i < str_identities['errors'].length; i++) {
+      message = str_identities['errors'][i].message;
+      obj = str_identities['errors'][i].obj;
+      err(function(){ qs.stringify(obj) }, message);
+    }
+  }
+};

package/test/stringify.test.js

@@ -1,95 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var qs = require('../')
-  , should = require('should')
-  , query_string_identities = {
-    'basics': [
-      {query_string: 'foo=bar', parsed: {'foo' : 'bar'}},
-      {query_string: 'foo=%22bar%22', parsed: {'foo' : '\"bar\"'}},
-      {query_string: 'foo=', parsed: {'foo': ''}},
-      {query_string: 'foo=1&bar=2', parsed: {'foo' : '1', 'bar' : '2'}},
-      {query_string: 'my%20weird%20field=q1!2%22\'w%245%267%2Fz8)%3F', parsed: {'my weird field': "q1!2\"'w$5&7/z8)?"}},
-      {query_string: 'foo%3Dbaz=bar', parsed: {'foo=baz': 'bar'}},
-      {query_string: 'foo=bar&bar=baz', parsed: {foo: 'bar', bar: 'baz'}}
-    ],
-    'escaping': [
-      {query_string: 'foo=foo%20bar', parsed: {foo: 'foo bar'}},
-      {query_string: 'cht=p3&chd=t%3A60%2C40&chs=250x100&chl=Hello%7CWorld', parsed: {
-          cht: 'p3'
-        , chd: 't:60,40'
-        , chs: '250x100'
-        , chl: 'Hello|World'
-      }}
-    ],
-    'nested': [
-      {query_string: 'foo[]=bar&foo[]=quux', parsed: {'foo' : ['bar', 'quux']}},
-      {query_string: 'foo[]=bar', parsed: {foo: ['bar']}},
-      {query_string: 'foo[]=1&foo[]=2', parsed: {'foo' : ['1', '2']}},
-      {query_string: 'foo=bar&baz[]=1&baz[]=2&baz[]=3', parsed: {'foo' : 'bar', 'baz' : ['1', '2', '3']}},
-      {query_string: 'foo[]=bar&baz[]=1&baz[]=2&baz[]=3', parsed: {'foo' : ['bar'], 'baz' : ['1', '2', '3']}},
-      {query_string: 'x[y][z]=1', parsed: {'x' : {'y' : {'z' : '1'}}}},
-      {query_string: 'x[y][z][]=1', parsed: {'x' : {'y' : {'z' : ['1']}}}},
-      {query_string: 'x[y][z]=2', parsed: {'x' : {'y' : {'z' : '2'}}}},
-      {query_string: 'x[y][z][]=1&x[y][z][]=2', parsed: {'x' : {'y' : {'z' : ['1', '2']}}}},
-      {query_string: 'x[y][][z]=1', parsed: {'x' : {'y' : [{'z' : '1'}]}}},
-      {query_string: 'x[y][][z][]=1', parsed: {'x' : {'y' : [{'z' : ['1']}]}}},
-      {query_string: 'x[y][][z]=1&x[y][][w]=2', parsed: {'x' : {'y' : [{'z' : '1', 'w' : '2'}]}}},
-      {query_string: 'x[y][][v][w]=1', parsed: {'x' : {'y' : [{'v' : {'w' : '1'}}]}}},
-      {query_string: 'x[y][][z]=1&x[y][][v][w]=2', parsed: {'x' : {'y' : [{'z' : '1', 'v' : {'w' : '2'}}]}}},
-      {query_string: 'x[y][][z]=1&x[y][][z]=2', parsed: {'x' : {'y' : [{'z' : '1'}, {'z' : '2'}]}}},
-      {query_string: 'x[y][][z]=1&x[y][][w]=a&x[y][][z]=2&x[y][][w]=3', parsed: {'x' : {'y' : [{'z' : '1', 'w' : 'a'}, {'z' : '2', 'w' : '3'}]}}},
-      {query_string: 'user[name][first]=tj&user[name][last]=holowaychuk', parsed: { user: { name: { first: 'tj', last: 'holowaychuk' }}}}
-    ],
-    'errors': [
-      { parsed: 'foo=bar',     message: 'stringify expects an object' },
-      { parsed: ['foo', 'bar'], message: 'stringify expects an object' }
-    ]
-  };
-  
-
-// Assert error
-function err(fn, msg){
-  var err;
-  try {
-    fn();
-  } catch (e) {
-    should.equal(e.message, msg);
-    return;
-  }
-  throw new Error('no exception thrown, expected "' + msg + '"');
-}
-
-function test(type) {
-  var str, obj;
-  for (var i = 0; i < query_string_identities[type].length; i++) {
-    str = query_string_identities[type][i].query_string;
-    obj = query_string_identities[type][i].parsed;
-    qs.stringify(obj).should.eql(str);
-  }
-}
-
-module.exports = {
-  'test basics': function() {
-    test('basics');
-  },
-
-  'test escaping': function() {
-    test('escaping');
-  },
-
-  'test nested': function() {
-    test('nested');
-  },
-
-  'test errors': function() {
-    var parsed, message;
-    for (var i = 0; i < query_string_identities['errors'].length; i++) {
-      message      = query_string_identities['errors'][i].message;
-      parsed       = query_string_identities['errors'][i].parsed;
-      err(function(){ qs.stringify(parsed) }, message);
-    }
-  }
-};