added sort function and pushed to version 2.0

Author: Lucas Reppe Welander

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes on this project will be documented in this file.
+
+## 2.0.0 - 2017-11-17
+### Added
+* Gave `add` function a `sort()` on object keys so it always returns the same URL even if the keys are shuffled, this is a must have for SEO:ers, before you had to manage the object passed in to add by youself, now qsm handles this for you.
+* Fixed so that `add` updates values for keys that already exists instead of appending them, there was issues when you could get multiple occurrences of the same key in your url.
+* Added a warning for users using the soon to be deprecated technique with arrays instead of pure objects. **Arrays will be deprecated in next major release.**
+
+## 1.3.0 - 2017-04-28
+
+### Changed
+* Changed how `encode` and `decode` works, they now both support of specifiying key that should get the encoded result or what key to decode. Instead of always using the `q` key for this.

README.md

@@ -15,8 +15,6 @@ var qsm = require('qsm');
 Appends querystring to the url.
 ```javascript
 var url = 'http://mywebsite.com';
-var newUrl = qsm.add(url, [{ query: 'userId', value: 1337 }]);
-> OR
 var newUrl = qsm.add(url, { userId: 1337 });
 
 // newUrl outputs: http://mywebsite.com?userId=1337
@@ -42,8 +40,6 @@ var newurl = qsm.clear(url);
 Replaces current querystrings with new ones.
 ```javascript
 var url = 'http://mywebsite.com?userId=1337&sort=type';
-var newurl = qsm.replace(url, [{ query: 'hasObject', value: true }]);
-> OR
 var newurl = qsm.replace(url, { hasObject: true });
 
 // newurl outputs: http://mywebsite.com?hasObject=true

TODO.md

@@ -4,44 +4,42 @@ var add = function add(_url, _params) {
     var retUrl = _url;
     var urlparts = _url.split('?');
     if (_params.constructor === Object) {
-        for (var item in _params) {
-            if (_params.hasOwnProperty(item)) {
-                if (retUrl.indexOf('?') >= 0) {
-                    retUrl += _add(_url, _params[item], item, true);
+        var __params = sort(_params);
+        for (var item in __params) {
+            if (__params.hasOwnProperty(item)) {
+                if (exist(retUrl, item)) {
+                    retUrl = replaceSpecific(_url, __params, item);
                 } else {
-                    retUrl += _add(_url, _params[item], item, false);
+                    retUrl += _add(_url, __params[item], item, retUrl.indexOf('?') <= 0);
                 }
             }
         }
     } else {
+        console.warn('You are using a feature of QSM 2.0 that will get deprecated in next major release. Please use the object variant instead. More info at https://npmjs.com/package/qsm');
         if (urlparts.length >= 2) {
             for (var i = 0; i < _params.length; i++) {
-                retUrl += _add(_url, _params[i], null, true);
+                retUrl += _add(_url, _params[i], null, false);
             }
         } else {
             for (var i = 0; i < _params.length; i++) {
-                if (i === 0) {
-                    retUrl += _add(_url, _params[i], null, false);
-                } else {
-                    retUrl += _add(_url, _params[i], null, true);
-                }
+                retUrl += _add(_url, _params[i], null, i < 1);
             }
         }
     }
 
     return retUrl;
 };
 
-var _add = function _add(url, param, key, gotQueryStrings) {
+var _add = function _add(url, param, key, isFirst) {
     if (key) {
-        if (!gotQueryStrings) {
+        if (isFirst) {
             return '?' + key + '=' + param;
         }
 
         return '&' + key + '=' + param;
     }
 
-    if (!gotQueryStrings) {
+    if (isFirst) {
         return '?' + param.query + '=' + param.value;
     }
 
@@ -79,8 +77,6 @@ var encode = function encode(url, obj, key) {
         return add(url, _temp);
     }
 
-    console.log(':KEY', key);
-
     return add(url, { q: encoded });
 };
 var exist = function exist(url, param) {
@@ -225,6 +221,23 @@ var replaceSpecific = function replaceSpecific(url, parameter, replacer) {
     var _url = add(url, parameter);
     return _url;
 };
+var sort = function sort(obj) {
+    var newObj = {};
+    var keys = Object.keys(obj);
+
+    var sortedKeys = keys.sort(function (a, b) {
+        if (a > b) return 1;
+        if (a < b) return -1;
+        return 0;
+    });
+
+    sortedKeys.forEach(function (key) {
+        newObj[key] = obj[key];
+    });
+
+    return newObj;
+};
+
 module.exports = {
     remove: remove,
     add: add,

build/build.js

@@ -2,44 +2,42 @@ const add = (_url, _params) => {
     var retUrl = _url;
     var urlparts= _url.split('?');
     if (_params.constructor === Object) {
-        for (var item in _params) {
-            if (_params.hasOwnProperty(item)) {
-                if (retUrl.indexOf('?') >= 0) {
-                    retUrl += _add(_url, _params[item], item, true);
-                } else {
-                    retUrl += _add(_url, _params[item], item, false);
-                }
+		var __params = sort(_params);
+        for (var item in __params) {
+            if (__params.hasOwnProperty(item)) {
+				if (exist(retUrl, item)) {
+					retUrl = replaceSpecific(_url, __params, item);
+				} else {
+					retUrl += _add(_url, __params[item], item, retUrl.indexOf('?') <= 0);
+				}
             }
         }
     } else {
+		console.warn('You are using a feature of QSM 2.0 that will get deprecated in next major release. Please use the object variant instead. More info at https://npmjs.com/package/qsm');
         if (urlparts.length>=2) {
             for (var i = 0; i < _params.length; i++) {
-                retUrl += _add(_url, _params[i], null, true);
+                retUrl += _add(_url, _params[i], null, false);
             }
         } else {
             for (var i = 0; i < _params.length; i++) {
-                if (i === 0) {
-                    retUrl += _add(_url, _params[i], null, false);
-                } else {
-                    retUrl += _add(_url, _params[i], null, true);
-                }
+				retUrl += _add(_url, _params[i], null, i < 1);
             }
         }
     }
 
     return retUrl;
 }
 
-const _add = (url, param, key, gotQueryStrings) => {
+const _add = (url, param, key, isFirst) => {
     if (key) {
-        if (!gotQueryStrings) {
+        if (isFirst) {
             return '?' + key + '=' + param;
         }
 
         return '&' + key + '=' + param;
     }
 
-    if (!gotQueryStrings) {
+    if (isFirst) {
         return '?' + param.query + '=' + param.value;
     }
 

lib/add.js

@@ -1,4 +1,22 @@
 
+const sort = (obj) => {
+	const newObj = {};
+	const keys = Object.keys(obj);
+
+	const sortedKeys = keys.sort((a, b) => {
+		if (a > b) return 1;
+		if (a < b) return -1;
+		return 0;
+	});
+
+	sortedKeys.forEach(key => {
+		newObj[key] = obj[key];
+	});
+
+	return newObj;
+}
+
+
 module.exports = {
     remove,
     add,

lib/helper/module_exports.js

@@ -1,6 +1,6 @@
 {
   "name": "qsm",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "a simple tool that allows you to remove any querystring from the url",
   "main": "qsm.js",
   "scripts": {

package.json

@@ -5,7 +5,8 @@ var test = {
     clean: 'www.url.com',
     case1: 'www.url.com?userId=1337',
     case2: 'www.url.com?gender=female&userId=1337',
-    case3: 'www.url.com?gender=female'
+	case3: 'www.url.com?gender=female',
+	case4: 'www.url.com?gender=male&userId=007'
 }
 
 describe('Add methods', function() {
@@ -19,7 +20,7 @@ describe('Add methods', function() {
         var url = qsm.add(test.case3, [{ query: 'userId', value: '1337' }]);
         assert.equal(test.case2, url);
         done();
-    });
+	});
 
     it('Should add a querystring with comma separated values', function(done) {
         var url = qsm.add(test.clean, [{ query: 'userId', value: ['1337', '666', '11'] }]);
@@ -37,6 +38,18 @@ describe('Add methods', function() {
         var url = qsm.add(test.clean, { gender: 'female', userId: 1337 });
         assert.equal(test.case2, url);
         done();
+	});
+	
+	it('Add same object but different index of keys should return the same URL', function(done) {
+        var url = qsm.add(test.clean, { userId: 1337, gender: 'female' });
+        assert.equal(test.case2, url);
+        done();
+	});
+	
+	it('Same keys but different values should update the URL', function(done) {
+        var url = qsm.add(test.case1, { userId: '007', gender: 'male' });
+        assert.equal(test.case4, url);
+        done();
     });
 
     it('Add method used with pure object 2', function(done) {