qs 0.4.0 → 0.5.1

package/.travis.yml

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

package/History.md

@@ -1,4 +1,24 @@
 
+0.5.1 / 2012-09-18 
+==================
+
+  * fix encoded `=`. Closes #43
+
+0.5.0 / 2012-05-04 
+==================
+
+  * Added component support
+
+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 
 ==================
 

package/Makefile

@@ -1,5 +1,12 @@
 
+test/browser/qs.js: querystring.js
+	component build package.json test/browser/qs
+
+querystring.js: lib/head.js lib/querystring.js lib/tail.js
+	cat $^ > $@ 
+
 test:
-	@./node_modules/.bin/mocha
+	@./node_modules/.bin/mocha \
+		--ui bdd
 
 .PHONY: test

package/Readme.md

@@ -1,6 +1,6 @@
 # node-querystring
 
-  query string parser for node supporting nesting, as it was removed from `0.3.x`, so this library provides the previous and commonly desired behaviour (and twice as fast). Used by [express](http://expressjs.com), [connect](http://senchalabs.github.com/connect) and others.
+  query string parser for node and the browser supporting nesting, as it was removed from `0.3.x`, so this library provides the previous and commonly desired behaviour (and twice as fast). Used by [express](http://expressjs.com), [connect](http://senchalabs.github.com/connect) and others.
 
 ## Installation
 
@@ -8,8 +8,15 @@
 
 ## 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
 
@@ -21,6 +28,10 @@ and execute:
 
     $ make test
 
+browser:
+
+    $ open test/browser/index.html
+
 ## License 
 
 (The MIT License)

package/component.json

@@ -0,0 +1,6 @@
+{
+  "name": "querystring",
+  "description": "Querystring parser / stringifier with nesting support",
+  "keywords": ["querystring", "query", "parser"],
+  "main": "lib/querystring.js"
+}

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/head.js

@@ -0,0 +1 @@
+;(function(){

package/lib/querystring.js

@@ -1,16 +1,4 @@
 
-/*!
- * querystring
- * Copyright(c) 2010 TJ Holowaychuk <tj@vision-media.ca>
- * MIT Licensed
- */
-
-/**
- * Library version.
- */
-
-exports.version = '0.4.0';
-
 /**
  * Object#toString() ref for stringify().
  */
@@ -21,7 +9,7 @@ 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] = {};
@@ -58,11 +46,11 @@ function parse(parts, 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);
+      if (!isint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
       parse(parts, obj, part, val);
       // key
     } else {
-      if(notint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
+      if (!isint.test(part) && Array.isArray(obj)) obj = promote(parent, key);
       parse(parts, obj, part, val);
     }
   }
@@ -80,7 +68,7 @@ function merge(parent, key, val){
     parse(parts, parent, 'base', val);
     // optimize
   } else {
-    if (notint.test(key) && Array.isArray(parent.base)) {
+    if (!isint.test(key) && Array.isArray(parent.base)) {
       var t = {};
       for (var k in parent.base) t[k] = parent.base[k];
       parent.base = t;
@@ -111,12 +99,6 @@ function parseString(str){
   return String(str)
     .split('&')
     .reduce(function(ret, pair){
-      try{
-        pair = decodeURIComponent(pair.replace(/\+/g, ' '));
-      } catch(e) {
-        // ignore
-      }
-
       var eql = pair.indexOf('=')
         , brace = lastBraceInKey(pair)
         , key = pair.substr(0, brace || eql)
@@ -126,7 +108,7 @@ function parseString(str){
       // ?foo
       if ('' == key) key = pair, val = '';
 
-      return merge(ret, key, val);
+      return merge(ret, decode(key), decode(val));
     }, { base: {} }).base;
 }
 
@@ -161,7 +143,7 @@ var stringify = exports.stringify = function(obj, prefix) {
   } else if ('string' == typeof obj) {
     return stringifyString(obj, prefix);
   } else {
-    return prefix;
+    return prefix + '=' + obj;
   }
 };
 
@@ -192,7 +174,7 @@ function stringifyArray(arr, prefix) {
   var ret = [];
   if (!prefix) throw new TypeError('stringify expects an object');
   for (var i = 0; i < arr.length; i++) {
-    ret.push(stringify(arr[i], prefix + '[]'));
+    ret.push(stringify(arr[i], prefix + '['+i+']'));
   }
   return ret.join('&');
 }
@@ -210,12 +192,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('&');
 }
 
@@ -260,3 +244,19 @@ function lastBraceInKey(str) {
     if ('=' == c && !brace) return i;
   }
 }
+
+/**
+ * Decode `str`.
+ *
+ * @param {String} str
+ * @return {String}
+ * @api private
+ */
+
+function decode(str) {
+  try {
+    return decodeURIComponent(str.replace(/\+/g, ' '));
+  } catch (err) {
+    return str;
+  }
+}

package/lib/tail.js

@@ -0,0 +1 @@
+})();

package/package.json

@@ -1,14 +1,20 @@
 {
   "name": "qs",
   "description": "querystring parser",
-  "version": "0.4.0",
+  "version": "0.5.1",
+  "keywords": ["query string", "parser", "component"],
   "repository": {
     "type" : "git",
     "url" : "git://github.com/visionmedia/node-querystring.git"
   },
   "devDependencies": {
       "mocha": "*"
-    , "should": "*"
+    , "expect.js": "*"
+  },
+  "component": {
+    "scripts": {
+      "querystring": "querystring.js"
+    }
   },
   "author": "TJ Holowaychuk <tj@vision-media.ca> (http://tjholowaychuk.com)",
   "main": "index",

package/querystring.js

@@ -0,0 +1,254 @@
+;(function(){
+
+/**
+ * Object#toString() ref for stringify().
+ */
+
+var toString = Object.prototype.toString;
+
+/**
+ * Cache non-integer test regexp.
+ */
+
+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);
+    }
+  }
+}
+
+/**
+ * Merge parent key/val pair.
+ */
+
+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{
+        pair = decodeURIComponent(pair.replace(/\+/g, ' '));
+      } catch(e) {
+        // ignore
+      }
+
+      var eql = pair.indexOf('=')
+        , brace = lastBraceInKey(pair)
+        , key = pair.substr(0, brace || eql)
+        , val = pair.substr(brace || eql, pair.length)
+        , val = val.substr(val.indexOf('=') + 1, val.length);
+
+      // ?foo
+      if ('' == key) key = pair, val = '';
+
+      return merge(ret, key, val);
+    }, { 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);
+};
+
+/**
+ * Turn the given `obj` into a query string
+ *
+ * @param {Object} obj
+ * @return {String}
+ * @api public
+ */
+
+var stringify = exports.stringify = function(obj, prefix) {
+  if (Array.isArray(obj)) {
+    return stringifyArray(obj, prefix);
+  } else if ('[object Object]' == toString.call(obj)) {
+    return stringifyObject(obj, prefix);
+  } else if ('string' == typeof obj) {
+    return stringifyString(obj, prefix);
+  } else {
+    return prefix + '=' + obj;
+  }
+};
+
+/**
+ * Stringify the given `str`.
+ *
+ * @param {String} str
+ * @param {String} prefix
+ * @return {String}
+ * @api private
+ */
+
+function stringifyString(str, prefix) {
+  if (!prefix) throw new TypeError('stringify expects an object');
+  return prefix + '=' + encodeURIComponent(str);
+}
+
+/**
+ * Stringify the given `arr`.
+ *
+ * @param {Array} arr
+ * @param {String} prefix
+ * @return {String}
+ * @api private
+ */
+
+function stringifyArray(arr, prefix) {
+  var ret = [];
+  if (!prefix) throw new TypeError('stringify expects an object');
+  for (var i = 0; i < arr.length; i++) {
+    ret.push(stringify(arr[i], prefix + '['+i+']'));
+  }
+  return ret.join('&');
+}
+
+/**
+ * Stringify the given `obj`.
+ *
+ * @param {Object} obj
+ * @param {String} prefix
+ * @return {String}
+ * @api private
+ */
+
+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('&');
+}
+
+/**
+ * Set `obj`'s `key` to `val` respecting
+ * the weird and wonderful syntax of a qs,
+ * where "foo=bar&foo=baz" becomes an array.
+ *
+ * @param {Object} obj
+ * @param {String} key
+ * @param {String} val
+ * @api private
+ */
+
+function set(obj, key, val) {
+  var v = obj[key];
+  if (undefined === v) {
+    obj[key] = val;
+  } else if (Array.isArray(v)) {
+    v.push(val);
+  } else {
+    obj[key] = [v, val];
+  }
+}
+
+/**
+ * Locate last brace in `str` within the key.
+ *
+ * @param {String} str
+ * @return {Number}
+ * @api private
+ */
+
+function lastBraceInKey(str) {
+  var len = str.length
+    , brace
+    , c;
+  for (var i = 0; i < len; ++i) {
+    c = str[i];
+    if (']' == c) brace = false;
+    if ('[' == c) brace = true;
+    if ('=' == c && !brace) return i;
+  }
+}
+})();