Add global prototype functions

What's new?
Call `.definePrototypes()` to create globally available String prototypes for `.urlencode()` and `.urldecode()`

Author: luke3butler

README.md

@@ -15,9 +15,14 @@ $ yarn add phpurlencode
 
 ## Usage
 
-### phpurlencode(string)
+### Include it in your Node.js file
+
 ```js
 var phpurlencode = require('phpurlencode');
+```
+
+### phpurlencode(string)
+```js
 var encodedString = phpurlencode("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.67 Safari/537.36");
 console.log(encodedString);
 // => Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F56.0.2924.67+Safari%2F537.36
@@ -36,3 +41,19 @@ var decodedString = phpurlencode.decode('%21%40%23%24%25%5E%26%2A%28%29-%2B%3D%2
 console.log(decodedString);
 // => !@#$%^&*()-+='"
 ```
+
+### phpurlencode.definePrototypes()
+#### Globally defines `.urlencode` and `.urldecode` String prototypes 
+```js
+// Register String prototypes. 
+// Once this function is called, the String prototypes will be available across your entire project
+phpurlencode.definePrototypes();
+
+var decodedString = '%21%40%23%24%25%5E%26%2A%28%29-%2B%3D%27%22'.urldecode();
+console.log(decodedString);
+// => !@#$%^&*()-+='"
+
+var encodedString = decodedString.urlencode();
+console.log(encodedString);
+// => %21%40%23%24%25%5E%26%2A%28%29-%2B%3D%27%22
+```

index.js

@@ -15,6 +15,20 @@ const decode = function(str) {
   );
 };
 
+const definePrototypes = function () {
+  if (!String.prototype.urlencode) {
+    global.String.prototype.urlencode = function () {
+      return encode(this);
+    };
+  }
+  if (!String.prototype.urldecode) {
+    global.String.prototype.urldecode = function () {
+      return decode(this);
+    };
+  }
+};
+
 module.exports = encode;
 module.exports.encode = encode;
 module.exports.decode = decode;
+module.exports.definePrototypes = definePrototypes;

package.json

@@ -1,7 +1,7 @@
 {
   "name": "phpurlencode",
   "description": "Functionally similar to PHP urlencode and urldecode functions",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "main": "index.js",
   "license": "MIT",
   "devDependencies": {

test/test.js

@@ -2,23 +2,32 @@
 const urlencode = require("../index.js");
 const assert = require("assert");
 
+const strings = {
+  userAgent: {
+    encoded: "Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F56.0.2924.67+Safari%2F537.36",
+    decoded: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.67 Safari/537.36"
+  },
+  specialChars: {
+    encoded: "%21%40%23%24%25%5E%26%2A%28%29%2B%27%7E%22%3C%3E%2C.",
+    decoded: "!@#$%^&*()+'~\"<>,."
+  }
+};
+
 describe("urlencode", function() {
   describe("#encode()", function() {
     it(
       "should encode special characters similar to php's urlencode",
       function() {
         assert.equal(
-          "%21%40%23%24%25%5E%26%2A%28%29%2B%27%7E%22%3C%3E%2C.",
-          urlencode("!@#$%^&*()+'~\"<>,.")
+          strings.specialChars.encoded,
+          urlencode(strings.specialChars.decoded)
         );
       }
     );
     it("should encode a string similar to php's urlencode", function() {
       assert.equal(
-        "Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F56.0.2924.67+Safari%2F537.36",
-        urlencode.encode(
-          "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.67 Safari/537.36"
-        )
+        strings.userAgent.encoded,
+        urlencode.encode(strings.userAgent.decoded)
       );
     });
   });
@@ -28,18 +37,50 @@ describe("urlencode", function() {
       "should decode special characters similar to php's urldecode",
       function() {
         assert.equal(
-          "!@#$%^&*()+'~\"<>,.",
-          urlencode.decode("%21%40%23%24%25%5E%26%2A%28%29%2B%27%7E%22%3C%3E%2C.")
+          strings.specialChars.decoded,
+          urlencode.decode(strings.specialChars.encoded)
         );
       }
     );
     it("should decode a string similar to php's urldecode", function() {
       assert.equal(
-        "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.67 Safari/537.36",
-        urlencode.decode(
-          "Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_2%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F56.0.2924.67+Safari%2F537.36"
-        )
+        strings.userAgent.decoded,
+        urlencode.decode(strings.userAgent.encoded)
       );
     });
   });
 });
+
+describe("#definePrototypes()", function () {
+  it("should register global String prototypes", function () {
+    urlencode.definePrototypes();
+    assert.equal(false, !String.prototype.urldecode, 'String.prototype.urldecode exists');
+    assert.equal(false, !String.prototype.urlencode, 'String.prototype.urlencode exists');
+  });
+
+  it("should correctly encode with String prototype", function () {
+    assert.equal(
+      strings.specialChars.decoded.urlencode(),
+      strings.specialChars.encoded,
+      'correctly encodes special character test string'
+    );
+    assert.equal(
+      strings.userAgent.decoded.urlencode(),
+      strings.userAgent.encoded,
+      'correctly encodes user-agent test string'
+    );
+  });
+
+  it("should correctly decode with String prototype", function () {
+    assert.equal(
+      strings.specialChars.encoded.urldecode(),
+      strings.specialChars.decoded,
+      'correctly decodes special character test string'
+    );
+    assert.equal(
+      strings.userAgent.encoded.urldecode(),
+      strings.userAgent.decoded,
+      'correctly decodes user-agent test string'
+    );
+  });
+});