Merge pull request #194 from bookernath/update-encodehtml

Update encodeHtmlEntities helper to match paper-handlebars

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Unreleased
 
+## 2.0.23 (2020-02-21)
+- Support more `he` arguments on encodeHtmlEntities helper
+
 ## 2.0.22 (2020-01-28)
 - Add encodeHtmlEntities helper
 

helpers/encodeHtmlEntities.js

@@ -11,7 +11,29 @@ function helper(paper) {
             throw new TypeError("Non-string passed to encodeHtmlEntities");
         }
 
-        return new SafeString(he.encode(string));
+        const options = arguments[arguments.length - 1];
+
+        let args = {};
+
+        if (utils.isOptions(options)) {
+            args = options.hash;
+
+            // Whitelist of allowed named arguments into `he` function
+            const allowedArguments = [
+                'useNamedReferences',
+                'decimal',
+                'encodeEverything',
+                'allowUnsafeSymbols'
+            ];
+
+            // Make sure all named arguments from options hash are in the whitelist and have boolean (string) values
+            if (Object.keys(args).some(key => !allowedArguments.includes(key))
+                || !Object.keys(args).map(key => args[key]).every(val => ['true', 'false'].includes(val))) {
+                throw new TypeError("Invalid named argument passed to encodeHtmlEntities");
+            }
+        }
+
+        return new SafeString(he.encode(string, args));
     });
 }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/stencil-paper",
-  "version": "2.0.22",
+  "version": "2.0.23",
   "description": "A stencil plugin to register partials and helpers from handlebars and returns the compiled version for the stencil platform.",
   "main": "index.js",
   "author": "Bigcommerce",

test/helpers/encodeHtmlEntities.js

@@ -17,6 +17,8 @@ describe('encodeHtmlEntities helper', function() {
         quotes: '"some" \'quotes\'',
     };
 
+    // Some test cases lifted from https://github.com/mathiasbynens/he
+
     it('should return a string with HTML entities encoded', function(done) {
         expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux"}}', context))
             .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
@@ -30,4 +32,60 @@ describe('encodeHtmlEntities helper', function() {
             .to.be.equal('an ampersand: &');
         done();
     });
+
+    it('should return a string with HTML entities encoded with named references', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" useNamedReferences="true"}}', context))
+            .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
+        done();
+    });
+
+    it('should return a string with HTML entities encoded with decimal option', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" decimal="true"}}', context))
+            .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
+        done();
+    });
+
+    it('should return a string with HTML entities encoded with named references and decimal option', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" useNamedReferences="true" decimal="true"}}', context))
+            .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
+        done();
+    });
+
+    it('should return a string with HTML entities encoded with encodeEverything option', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" encodeEverything="true"}}', context))
+            .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
+        done();
+    });
+
+    it('should return a string with HTML entities encoded with encodeEverything and useNamedReferences option', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" encodeEverything="true" useNamedReferences="true"}}', context))
+            .to.be.equal(`foo © bar ≠ baz 𝌆 qux`);
+        done();
+    });
+
+    it('should return a string with HTML entities encoded with allowUnsafeSymbols option', function(done) {
+        expect(c('{{encodeHtmlEntities "foo © and & ampersand" allowUnsafeSymbols="true"}}', context))
+            .to.be.equal(`foo © and & ampersand`);
+        done();
+    });
+
+    it('should throw an exception if an invalid named argument is passed', function (done) {
+        try {
+            c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" useNamedReferences="blah"}}');
+        } catch(e) {
+        }
+        try {
+            c('{{encodeHtmlEntities "foo © bar ≠ baz 𝌆 qux" blah="true"}}');
+        } catch(e) {
+        }
+        done();
+    });
+
+    it('should throw an exception if a non-string argument is passed', function (done) {
+        try {
+            c('{{encodeHtmlEntities 123}}');
+        } catch(e) {
+        }
+        done();
+    });
 });