Merge pull request #6246 from lkcampbell/fix-6008

Fix UrlParams parsing when URL has no parameters.  Add remove() and isEmpty() methods.

src/utils/UrlParams.js

@@ -42,20 +42,30 @@ define(function (require, exports, module) {
      * @param {string} url
      */
     UrlParams.prototype.parse = function (url) {
-        if (url) {
-            url = url.substring(url.indexOf("?") + 1);
-        } else {
-            url = window.document.location.search.substring(1);
-        }
-
-        var urlParams = url.split("&"),
+        var queryString = "",
+            urlParams,
             p,
             self = this;
 
-        urlParams.forEach(function (param) {
-            p = param.split("=");
-            self._store[decodeURIComponent(p[0])] = decodeURIComponent(p[1]);
-        });
+        self._store = {};
+
+        if (!url) {
+            queryString = window.document.location.search.substring(1);
+        } else if (url.indexOf("?") !== -1) {
+            queryString = url.substring(url.indexOf("?") + 1);
+        }
+
+        queryString = queryString.trimRight();
+
+        if (queryString) {
+            urlParams = queryString.split("&");
+
+            urlParams.forEach(function (param) {
+                p = param.split("=");
+                p[1] = p[1] || "";
+                self._store[decodeURIComponent(p[0])] = decodeURIComponent(p[1]);
+            });
+        }
     };
 
     /**
@@ -68,15 +78,33 @@ define(function (require, exports, module) {
     };
 
     /**
-     * Retreive a value by name
+     * Retrieve a value by name
      * @param {!string} name
+     * @return {string}
      */
     UrlParams.prototype.get = function (name) {
         return this._store[name];
     };
 
+    /**
+     * Remove a name/value string pair
+     * @param {!string} name
+     */
+    UrlParams.prototype.remove = function (name) {
+        delete this._store[name];
+    };
+
+    /**
+     * Returns true if the parameter list is empty, else returns false.
+     * @return {boolean}
+     */
+    UrlParams.prototype.isEmpty = function (name) {
+        return _.isEmpty(this._store);
+    };
+
     /**
      * Encode name/value pairs as URI components.
+     * @return {string}
      */
     UrlParams.prototype.toString = function () {
         var strs = [],
@@ -88,7 +116,7 @@ define(function (require, exports, module) {
 
         return strs.join("&");
     };
-
+    
     // Define public API
     exports.UrlParams = UrlParams;
 });

test/UnitTestSuite.js

@@ -68,6 +68,7 @@ define(function (require, exports, module) {
     require("spec/StringUtils-test");
     require("spec/TextRange-test");
     require("spec/UpdateNotification-test");
+    require("spec/UrlParams-test");
     require("spec/ViewCommandHandlers-test");
     require("spec/ViewUtils-test");
     require("spec/WorkingSetView-test");

test/spec/UrlParams-test.js

@@ -0,0 +1,196 @@
+/*
+ * Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
+ *  
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"), 
+ * to deal in the Software without restriction, including without limitation 
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+ * and/or sell copies of the Software, and to permit persons to whom the 
+ * Software is furnished to do so, subject to the following conditions:
+ *  
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *  
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
+ * DEALINGS IN THE SOFTWARE.
+ * 
+ */
+
+
+/*jslint vars: true, plusplus: true, devel: true, browser: true, nomen: true, indent: 4, maxerr: 50 */
+/*global define, describe, it, expect */
+
+define(function (require, exports, module) {
+    'use strict';
+
+    var UrlParams = require("utils/UrlParams").UrlParams;
+
+    describe("UrlParams", function () {
+        describe("Test for Empty parameter list", function () {
+            var params = new UrlParams();
+
+            it("should show that the parameter object is empty", function () {
+                params.parse("http://www.brackets.io");
+
+                expect(params.isEmpty()).toBeTruthy();
+                expect(params.toString()).toEqual("");
+            });
+
+            it("should show that the parameter object is NOT empty", function () {
+                params.parse("http://www.brackets.io?one=1&two=true&three=foobar");
+
+                expect(params.isEmpty()).toBeFalsy();
+                expect(params.toString()).toNotEqual("");
+            });
+        });
+
+        describe("Parse and Get URL parameters", function () {
+            var params = new UrlParams();
+
+            it("should create a parameter object and get three parameters", function () {
+                params.parse("http://www.brackets.io?one=1&two=true&three=foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+            });
+
+            it("should create a parameter object with three parameters with empty string values", function () {
+                params.parse("http://www.brackets.io?one&two&three");
+
+                expect(params.get("one")).toEqual("");
+                expect(params.get("two")).toEqual("");
+                expect(params.get("three")).toEqual("");
+            });
+
+            it("should create a parameter object with no parameters", function () {
+                params.parse("http://www.brackets.io");
+
+                expect(params.get("one")).toBeUndefined();
+                expect(params.get("two")).toBeUndefined();
+                expect(params.get("three")).toBeUndefined();
+            });
+        });
+
+        describe("Put and Remove URL parameters", function () {
+            var params = new UrlParams();
+
+            it("should put a new parameter three in the list", function () {
+                params.parse("http://www.brackets.io?one=1&two=true");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toBeUndefined();
+
+                params.put("three", "foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+            });
+
+            it("should change the value of parameter two", function () {
+                params.parse("http://www.brackets.io?one=1&two=true&three=foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+
+                params.put("two", "false");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("false");
+                expect(params.get("three")).toEqual("foobar");
+            });
+
+            it("should remove parameter one", function () {
+                params.parse("http://www.brackets.io?one=1&two=true&three=foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+
+                params.remove("one");
+
+                expect(params.get("one")).toBeUndefined();
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+            });
+
+            it("should remove three parameters, leaving an empty list", function () {
+                params.parse("http://www.brackets.io?one=1&two=true&three=foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+
+                expect(params.isEmpty()).toBeFalsy();
+                expect(params.toString()).toNotEqual("");
+
+                params.remove("one");
+                params.remove("two");
+                params.remove("three");
+
+                expect(params.get("one")).toBeUndefined();
+                expect(params.get("two")).toBeUndefined();
+                expect(params.get("three")).toBeUndefined();
+
+                expect(params.isEmpty()).toBeTruthy();
+                expect(params.toString()).toEqual("");
+            });
+
+            it("should add three parameters to an empty list", function () {
+                params.parse("http://www.brackets.io");
+
+                expect(params.get("one")).toBeUndefined();
+                expect(params.get("two")).toBeUndefined();
+                expect(params.get("three")).toBeUndefined();
+
+                expect(params.isEmpty()).toBeTruthy();
+                expect(params.toString()).toEqual("");
+
+                params.put("one", "1");
+                params.put("two", "true");
+                params.put("three", "foobar");
+
+                expect(params.get("one")).toEqual("1");
+                expect(params.get("two")).toEqual("true");
+                expect(params.get("three")).toEqual("foobar");
+
+                expect(params.isEmpty()).toBeFalsy();
+                expect(params.toString()).toNotEqual("");
+            });
+        });
+
+        describe("Test for malformed or unusual query strings", function () {
+            var params = new UrlParams();
+
+            it("should parse a missing query string as an empty object", function () {
+                params.parse("http://www.brackets.io?");
+
+                expect(params.isEmpty()).toBeTruthy();
+                expect(params.toString()).toEqual("");
+            });
+
+            it("should parse a query string of whitespace as an empty object", function () {
+                params.parse("http://www.brackets.io?   ");
+
+                expect(params.isEmpty()).toBeTruthy();
+                expect(params.toString()).toEqual("");
+            });
+
+            it("should parse a random number (used to circumvent browser cache)", function () {
+                params.parse("http://www.brackets.io?28945893575608");
+
+                expect(params.get("28945893575608")).toEqual("");
+                expect(params.isEmpty()).toBeFalsy();
+                expect(params.toString()).toEqual("28945893575608=");
+            });
+        });
+    });
+});