chore: add unit tests for cli options.

aorinevo · aorinevo · commit 5e6a25541fc7 · 2020-03-30T19:50:59.000-04:00
diff --git a/bin/handlebars b/bin/handlebars
@@ -111,6 +111,7 @@ delete argv._;
 
 const Precompiler = require('../dist/cjs/precompiler');
 Precompiler.loadTemplates(argv, function(err, opts) {
+
   if (err) {
     throw err;
   }
diff --git a/spec/artifacts/known.helpers.handlebars b/spec/artifacts/known.helpers.handlebars
@@ -0,0 +1,6 @@
+{{#someHelper true}}
+ <div>Some known helper</div>
+    {{#anotherHelper true}}
+    <div>Another known helper</div>
+    {{/anotherHelper}}
+{{/someHelper}}
diff --git a/spec/artifacts/non.default.extension.hbs b/spec/artifacts/non.default.extension.hbs
@@ -0,0 +1 @@
+<div>This is a test</div>
diff --git a/spec/artifacts/partial.template.handlebars b/spec/artifacts/partial.template.handlebars
@@ -0,0 +1 @@
+<div>Test Partial</div>
diff --git a/spec/artifacts/source.map.amd.txt b/spec/artifacts/source.map.amd.txt
@@ -0,0 +1 @@
+{"version":3,"sources":["test"],"names":["compiler","main","container","depth0","helpers","partials","data","useData"],"mappings":"kHAAA,CAAAA,SAAA,CAAA,EAAA,YAAAC,KAAA,SAAAC,EAAAC,EAAAC,EAAAC,EAAAC,GAAA,MAAA,gBAAAC,SAAA"}
diff --git a/spec/expected/compiled.string.txt b/spec/expected/compiled.string.txt
@@ -0,0 +1,3 @@
+{"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "<div>Test String</div>";
+},"useData":true}
diff --git a/spec/expected/empty.amd.min.js b/spec/expected/empty.amd.min.js
diff --git a/spec/expected/empty.amd.namespace.js b/spec/expected/empty.amd.namespace.js
@@ -0,0 +1,6 @@
+define(['handlebars.runtime'], function(Handlebars) {
+  Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = CustomNamespace.templates = CustomNamespace.templates || {};
+return templates['empty'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "";
+},"useData":true});
+});
diff --git a/spec/expected/empty.amd.simple.js b/spec/expected/empty.amd.simple.js
@@ -0,0 +1,3 @@
+{"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+  return "";
+},"useData":true}
diff --git a/spec/expected/empty.common.js b/spec/expected/empty.common.js
@@ -0,0 +1,6 @@
+(function() {
+  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+templates['empty'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "";
+},"useData":true});
+})();
diff --git a/spec/expected/empty.name.amd.js b/spec/expected/empty.name.amd.js
@@ -0,0 +1,10 @@
+define(['handlebars.runtime'], function(Handlebars) {
+  Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+templates['firstTemplate'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "<div>1</div>";
+},"useData":true});
+templates['secondTemplate'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "<div>2</div>";
+},"useData":true});
+return templates;
+});
diff --git a/spec/expected/empty.root.amd.js b/spec/expected/empty.root.amd.js
@@ -0,0 +1,6 @@
+define(['handlebars.runtime'], function(Handlebars) {
+  Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+return templates['artifacts/partial.template'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+    return "<div>Test Partial</div>";
+},"useData":true});
+});
diff --git a/spec/expected/handlebar.path.amd.js b/spec/expected/handlebar.path.amd.js
@@ -0,0 +1,6 @@
+define(['some-path/handlebars.runtime'], function(Handlebars) {
+    Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+  return templates['empty'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+      return "";
+  },"useData":true});
+  });
diff --git a/spec/expected/help.menu.txt b/spec/expected/help.menu.txt
@@ -0,0 +1,25 @@
+Precompile handlebar templates.
+Usage: handlebars [template|directory]...
+
+Options:
+  --help               Outputs this message                                                                    [boolean]
+  -f, --output         Output File                                                                              [string]
+  --map                Source Map File                                                                          [string]
+  -a, --amd            Exports amd style (require.js)                                                          [boolean]
+  -c, --commonjs       Exports CommonJS style, path to Handlebars module                        [string] [default: null]
+  -h, --handlebarPath  Path to handlebar.js (only valid for amd-style)                            [string] [default: ""]
+  -k, --known          Known helpers                                                                            [string]
+  -o, --knownOnly      Known helpers only                                                                      [boolean]
+  -m, --min            Minimize output                                                                         [boolean]
+  -n, --namespace      Template namespace                                     [string] [default: "Handlebars.templates"]
+  -s, --simple         Output template function only.                                                          [boolean]
+  -N, --name           Name of passed string templates. Optional if running in a simple mode. Required when operating on
+                       multiple templates.                                                                      [string]
+  -i, --string         Generates a template from the passed CLI argument.
+                       "-" is treated as a special value and causes stdin to be read for the template value.    [string]
+  -r, --root           Template root. Base value that will be stripped from template names.                     [string]
+  -p, --partial        Compiling a partial template                                                            [boolean]
+  -d, --data           Include data when compiling                                                             [boolean]
+  -e, --extension      Template extension.                                              [string] [default: "handlebars"]
+  -b, --bom            Removes the BOM (Byte Order Mark) from the beginning of the templates.                  [boolean]
+  -v, --version        Show version number                                                                     [boolean]
diff --git a/spec/expected/namespace.amd.js b/spec/expected/namespace.amd.js
@@ -0,0 +1,10 @@
+define(['handlebars.runtime'], function(Handlebars) {
+    Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = someNameSpace = someNameSpace || {};
+  templates['empty'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+      return "";
+  },"useData":true});
+  templates['empty'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+      return "";
+  },"useData":true});
+  return templates;
+  });
diff --git a/spec/expected/non.default.extension.amd.js b/spec/expected/non.default.extension.amd.js
@@ -0,0 +1,6 @@
+define(['handlebars.runtime'], function(Handlebars) {
+    Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+  return templates['non.default.extension'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+      return "<div>This is a test</div>";
+  },"useData":true});
+  });
diff --git a/spec/expected/non.empty.amd.known.helper.js b/spec/expected/non.empty.amd.known.helper.js
@@ -0,0 +1,24 @@
+define(['handlebars.runtime'], function(Handlebars) {
+Handlebars = Handlebars["default"]; var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+return templates['known.helpers'] = template({"1":function(container,depth0,helpers,partials,data) {
+var stack1, lookupProperty = container.lookupProperty || function(parent, propertyName) {
+if (Object.prototype.hasOwnProperty.call(parent, propertyName)) {
+return parent[propertyName];
+}
+return undefined
+};
+return " <div>Some known helper</div>\n" 
++ ((stack1 = lookupProperty(helpers,"anotherHelper").call(depth0 != null ? depth0 : (container.nullContext || {}),true,{"name":"anotherHelper","hash":{},"fn":container.program(2, data, 0),"inverse":container.noop,"data":data,"loc":{"start":{"line":3,"column":4},"end":{"line":5,"column":22}}})) != null ? stack1 : "");
+},"2":function(container,depth0,helpers,partials,data) {
+return " <div>Another known helper</div>\n";
+},"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+var stack1, lookupProperty = container.lookupProperty || function(parent, propertyName) {
+if (Object.prototype.hasOwnProperty.call(parent, propertyName)) {
+return parent[propertyName];
+}
+return undefined
+};
+return ((stack1 = lookupProperty(helpers,"someHelper").call(depth0 != null ? depth0 : (container.nullContext || {}),true,{"name":"someHelper","hash":{},"fn":container.program(1, data, 0),"inverse":container.noop,"data":data,"loc":{"start":{"line":1,"column":0},"end":{"line":6,"column":15}}})) != null ? stack1 : "");
+},"useData":true});
+});
+    
diff --git a/spec/expected/partial.template.js b/spec/expected/partial.template.js
@@ -0,0 +1,6 @@
+define(['handlebars.runtime'], function(Handlebars) {
+    Handlebars = Handlebars["default"];  var template = Handlebars.template, templates = Handlebars.templates = Handlebars.templates || {};
+  return Handlebars.partials['partial.template'] = template({"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {
+      return "<div>Test Partial</div>";
+  },"useData":true});
+  });
diff --git a/spec/expected/source.map.amd.js b/spec/expected/source.map.amd.js
diff --git a/spec/expected/version.txt b/spec/expected/version.txt
@@ -0,0 +1 @@
+4.7.3
diff --git a/spec/precompiler.js b/spec/precompiler.js
@@ -307,8 +307,9 @@ describe('precompiler', function() {
       Precompiler.loadTemplates(
         { files: [__dirname + '/artifacts'], extension: 'hbs' },
         function(err, opts) {
-          equal(opts.templates.length, 1);
+          equal(opts.templates.length, 2);
           equal(opts.templates[0].name, 'example_2');
+
           done(err);
         }
       );
@@ -317,7 +318,7 @@ describe('precompiler', function() {
       Precompiler.loadTemplates(
         { files: [__dirname + '/artifacts'], extension: 'handlebars' },
         function(err, opts) {
-          equal(opts.templates.length, 3);
+          equal(opts.templates.length, 5);
           equal(opts.templates[0].name, 'bom');
           equal(opts.templates[1].name, 'empty');
           equal(opts.templates[2].name, 'example_1');
diff --git a/tasks/test-bin.js b/tasks/test-bin.js
@@ -7,22 +7,194 @@ const chai = require('chai');
 chai.use(require('chai-diff'));
 const expect = chai.expect;
 
-module.exports = function(grunt) {
-  grunt.registerTask('test:bin', function() {
-    const stdout = executeBinHandlebars(
+const testCases = [
+  {
+    binInputParameters: ['-a', 'spec/artifacts/empty.handlebars'],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.amd.js'
+  },
+  {
+    binInputParameters: [
       '-a',
+      '-f',
+      'TEST_OUTPUT',
       'spec/artifacts/empty.handlebars'
-    );
+    ],
+    outputLocation: 'TEST_OUTPUT',
+    expectedOutputSpec: './spec/expected/empty.amd.js'
+  },
+  {
+    binInputParameters: [
+      '-a',
+      '-n',
+      'CustomNamespace.templates',
+      'spec/artifacts/empty.handlebars'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.amd.namespace.js'
+  },
+  {
+    binInputParameters: [
+      '-a',
+      '--namespace',
+      'CustomNamespace.templates',
+      'spec/artifacts/empty.handlebars'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.amd.namespace.js'
+  },
+  {
+    binInputParameters: ['-a', '-s', 'spec/artifacts/empty.handlebars'],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.amd.simple.js'
+  },
+  {
+    binInputParameters: ['-a', '-m', 'spec/artifacts/empty.handlebars'],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.amd.min.js'
+  },
+  {
+    binInputParameters: [
+      'spec/artifacts/known.helpers.handlebars',
+      '-a',
+      '-k',
+      'someHelper',
+      '-k',
+      'anotherHelper',
+      '-o'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/non.empty.amd.known.helper.js'
+  },
+  {
+    binInputParameters: ['--help'],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/help.menu.txt'
+  },
+  {
+    binInputParameters: ['-v'],
+    outputLocation: 'stdout',
+    expectedOutput: require('../package.json').version
+  },
+  {
+    binInputParameters: [
+      '-a',
+      '-e',
+      'hbs',
+      './spec/artifacts/non.default.extension.hbs'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/non.default.extension.amd.js'
+  },
+  {
+    binInputParameters: [
+      '-a',
+      '-p',
+      './spec/artifacts/partial.template.handlebars'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/partial.template.js'
+  },
+  {
+    binInputParameters: ['spec/artifacts/empty.handlebars', '-c'],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.common.js'
+  },
+  {
+    binInputParameters: [
+      'spec/artifacts/empty.handlebars',
+      'spec/artifacts/empty.handlebars',
+      '-a',
+      '-n',
+      'someNameSpace'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/namespace.amd.js'
+  },
+  {
+    binInputParameters: [
+      'spec/artifacts/empty.handlebars',
+      '-h',
+      'some-path/',
+      '-a'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/handlebar.path.amd.js'
+  },
+  {
+    binInputParameters: [
+      'spec/artifacts/partial.template.handlebars',
+      '-r',
+      'spec',
+      '-a'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.root.amd.js'
+  },
+  {
+    binInputParameters: [
+      '-i',
+      '<div>1</div>',
+      '-i',
+      '<div>2</div>',
+      '-N',
+      'firstTemplate',
+      '-N',
+      'secondTemplate',
+      '-a'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/empty.name.amd.js'
+  },
+  {
+    binInputParameters: [
+      '-i',
+      '<div>1</div>',
+      '-a',
+      '-m',
+      '-N',
+      'test',
+      '--map',
+      './spec/artifacts/source.map.amd.txt'
+    ],
+    outputLocation: 'stdout',
+    expectedOutputSpec: './spec/expected/source.map.amd.js'
+  }
+];
 
-    const expectedOutput = fs.readFileSync(
-      './spec/expected/empty.amd.js',
-      'utf-8'
-    );
+module.exports = function(grunt) {
+  grunt.registerTask('test:bin', function() {
+    testCases.forEach(
+      ({
+        binInputParameters,
+        outputLocation,
+        expectedOutputSpec,
+        expectedOutput
+      }) => {
+        const stdout = executeBinHandlebars(...binInputParameters);
+
+        if (!expectedOutput && expectedOutputSpec) {
+          expectedOutput = fs.readFileSync(expectedOutputSpec, 'utf-8');
+        }
 
-    const normalizedOutput = normalizeCrlf(stdout);
-    const normalizedExpectedOutput = normalizeCrlf(expectedOutput);
+        const useStdout = outputLocation === 'stdout';
+        const normalizedOutput = normalizeCrlf(
+          useStdout ? stdout : fs.readFileSync(outputLocation, 'utf-8')
+        );
+        const normalizedExpectedOutput = normalizeCrlf(expectedOutput);
 
-    expect(normalizedOutput).not.to.be.differentFrom(normalizedExpectedOutput);
+        if (!useStdout) {
+          fs.unlinkSync(outputLocation);
+        }
+
+        expect(normalizedOutput).not.to.be.differentFrom(
+          normalizedExpectedOutput,
+          {
+            relaxedSpace: true
+          }
+        );
+      }
+    );
   });
 };
 

Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,7 @@ delete argv._;`
`111`	`111`
`112`	`112`	`const Precompiler = require('../dist/cjs/precompiler');`
`113`	`113`	`Precompiler.loadTemplates(argv, function(err, opts) {`
	`114`	`+`
`114`	`115`	`if (err) {`
`115`	`116`	`throw err;`
`116`	`117`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"version":3,"sources":["test"],"names":["compiler","main","container","depth0","helpers","partials","data","useData"],"mappings":"kHAAA,CAAAA,SAAA,CAAA,EAAA,YAAAC,KAAA,SAAAC,EAAAC,EAAAC,EAAAC,EAAAC,GAAA,MAAA,gBAAAC,SAAA"}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {`
	`2`	`+ return "<div>Test String</div>";`
	`3`	`+},"useData":true}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{"compiler":[8,">= 4.3.0"],"main":function(container,depth0,helpers,partials,data) {`
	`2`	`+ return "";`
	`3`	`+},"useData":true}`