converted release and test tasks to new format, ensured BDD-like descriptions

Author: benholloway

test/helpers/angularity-test.js

@@ -2,6 +2,7 @@
 'use strict';
 
 var Q          = require('q'),
+    fs         = require('fs'),
     path       = require('path'),
     isArray    = require('lodash.isarray'),
     gulp       = require('gulp'),
@@ -202,6 +203,44 @@ function getConcatenation() {
   };
 }
 
+/**
+ * A utility equivalent to performing <code>String.replace()</code> using the contents of each <code>add()</code>
+ * statement
+ * @returns {{add: function, commit: function}}
+ */
+function replacer() {
+  var list = [];
+  var self = {
+    add: function(before, after) {
+      list.push({
+        before: before,
+        after : after
+      });
+      return self;
+    },
+    commit: function() {
+      return function(pathElements) {
+        var filePath = path.resolve.apply(path, [].concat(pathElements));
+        var text     = fs.existsSync(filePath) && fs.readFileSync(filePath).toString();
+        function replaceSingle(item) {
+          if (text) {
+            if (typeof item.before === 'string') {
+              while (text.indexOf(item.before) >= 0) {
+                text = text.replace(item.before, item.after);
+              }
+            } else if ((typeof item.before === 'object') && ('test' in item.before)) {
+              text = text.replace(item.before, item.after);
+            }
+          }
+          return text;
+        }
+        list.forEach(replaceSingle);
+        return text;
+      };
+    }
+  };
+  return self;
+}
 
 module.exports = {
   runner          : runner,
@@ -211,5 +250,6 @@ module.exports = {
   getFileDelete   : getFileDelete,
   randomFlags     : randomFlags,
   getTimeoutSwitch: getTimeoutSwitch,
-  getConcatenation: getConcatenation
+  getConcatenation: getConcatenation,
+  replacer        : replacer
 };

test/specs/cli.spec.js

@@ -17,7 +17,7 @@ describe('The Angularity cli interface', function () {
 
   afterEach(helper.cleanUp);
 
-  describe('with no other arguments', function (done) {
+  describe('should exit cleanly where there are no other arguments', function (done) {
     helper.runner.create()
       .addInvocation()
       .forEach(fastIt(expectations))
@@ -30,31 +30,31 @@ describe('The Angularity cli interface', function () {
     }
   });
 
-  describe('with version switch', function (done) {
+  describe('should display help where requested', function (done) {
     helper.runner.create()
-      .addInvocation('--version')
-      .addInvocation('-v')
+      .addInvocation('--help')
+      .addInvocation('-h')
+//    .addInvocation('-?')  // TODO @bholloway process cannot be spawned on windows when it has -? flag
       .forEach(fastIt(expectations))
       .finally(done);
 
     function expectations(testCase) {
-      var version = require(path.resolve('package.json')).version;
-      expect(testCase.stdout).toMatch(new RegExp('^angularity\\:\\s*' + version));
+      // test the help message begins with the description from the package.json
+      var description = require(path.resolve('package.json')).description;
+      expect(testCase.stderr).toMatch(new RegExp('^\\s*' + description));
     }
   });
 
-  describe('with help switch', function (done) {
+  describe('should display version where requested', function (done) {
     helper.runner.create()
-      .addInvocation('--help')
-      .addInvocation('-h')
-//    .addInvocation('-?')  // TODO @bholloway process cannot be spawned on windows when it has -? flag
+      .addInvocation('--version')
+      .addInvocation('-v')
       .forEach(fastIt(expectations))
       .finally(done);
 
     function expectations(testCase) {
-      // test the help message begins with the description from the package.json
-      var description = require(path.resolve('package.json')).description;
-      expect(testCase.stderr).toMatch(new RegExp('^\\s*' + description));
+      var version = require(path.resolve('package.json')).version;
+      expect(testCase.stdout).toMatch(new RegExp('^angularity\\:\\s*' + version));
     }
   });
 });

test/specs/tasks/build.spec.js

@@ -1,9 +1,6 @@
 'use strict';
 
-var fs   = require('fs'),
-    path = require('path');
-
-var jasmineDiffMatchers = require('jasmine-diff-matchers');
+var diffMatchers = require('jasmine-diff-matchers');
 
 var helper   = require('../../helpers/angularity-test'),
     matchers = require('../../helpers/jasmine-matchers');
@@ -33,7 +30,7 @@ describe('The Angularity build task', function () {
 
   afterEach(helper.cleanUp);
 
-  describe('with help switch', function (done) {
+  describe('should display help when requested', function (done) {
     helper.runner.create()
       .addInvocation('build --help')
       .addInvocation('build -h')
@@ -47,7 +44,7 @@ describe('The Angularity build task', function () {
     }
   });
 
-  describe('with the minimal-es5 project', function(done) {
+  describe('should operate minified (by default)', function(done) {
     helper.runner.create()
       .addSource('minimal-es5')
       .addInvocation('build')
@@ -57,7 +54,7 @@ describe('The Angularity build task', function () {
       .finally(done);
   });
 
-  describe('with the minimal-es5 project unminified', function(done) {
+  describe('should operate unminified', function(done) {
     helper.runner.create()
       .addSource('minimal-es5-unminified')
       .addInvocation('build --unminified')
@@ -80,13 +77,14 @@ function expectations(testCase) {
   expect(testCase.cwd).toHaveExpectedItemsExcept();
 
   // build output
+  expect(workingBuildFile('index.html')).diffFilePatch(sourceBuildFile('index.html'));
   expect(workingBuildFile('index.js')).diffFilePatch(sourceBuildFile('index.js'));
   expect(workingBuildFile('index.css')).diffFilePatch(sourceBuildFile('index.css'));
 //  expect(workingBuildFile('index.js.map' )).diffFilePatch(sourceBuildFile('index.js.map'));   // TODO @bholloway solve repeatability of .map files
 //  expect(workingBuildFile('index.css.map')).diffFilePatch(sourceBuildFile('index.css.map'));  // TODO @bholloway solve repeatability of .map files
 
-  // must remove basePath to allow karam.conf.js to be correctly diff'd
-  var replace = replacer()
+  // must remove basePath to allow karma.conf.js to be correctly diff'd
+  var replace = helper.replacer()
     .add(/^\s*basePath:.*$/gm, '')
     .add(/\\{2}/g, '/')
     .commit();
@@ -95,11 +93,10 @@ function expectations(testCase) {
   expect(replace(workingTestFile('karma.conf.js'))).diffPatch(replace(sourceTestFile('karma.conf.js')));
   expect(workingTestFile('index.js')).diffFilePatch(sourceTestFile('index.js'));
 //  expect(workingTestFile('index.js.map')).diffFilePatch(sourceTestFile('index.js.map'));    // TODO @bholloway solve repeatability of .map files
-
 }
 
 function customMatchers() {
-  jasmine.addMatchers(jasmineDiffMatchers.diffPatch);
+  jasmine.addMatchers(diffMatchers.diffPatch);
   jasmine.addMatchers({
     toBeHelpWithError        : matchers
       .getHelpMatcher(/^\s*The "build" task/),
@@ -114,36 +111,6 @@ function customMatchers() {
   });
 }
 
-function replacer() {
-  var list = [];
-  var self = {
-    add: function(before, after) {
-      list.push({
-        before: before,
-        after : after
-      });
-      return self;
-    },
-    commit: function() {
-      return function(pathElements) {
-        var filePath = path.resolve.apply(path, [].concat(pathElements));
-        var text     = fs.existsSync(filePath) && fs.readFileSync(filePath).toString();
-        function replaceSingle(item) {
-          if (text) {
-            if (typeof item.before === 'string') {
-              while (text.indexOf(item.before) >= 0) {
-                text = text.replace(item.before, item.after);
-              }
-            } else if ((typeof item.before === 'object') && ('test' in item.before)) {
-              text = text.replace(item.before, item.after);
-            }
-          }
-          return text;
-        }
-        list.forEach(replaceSingle);
-        return text;
-      };
-    }
-  };
-  return self;
-}
+module.exports = {
+  expectations: expectations
+};

test/specs/tasks/init.spec.js

@@ -40,7 +40,7 @@ describe('The Angularity init task', function () {
 
   afterEach(helper.cleanUp);
 
-  describe('with help switch', function (done) {
+  describe('should display help when requested', function (done) {
     helper.runner.create()
       .addInvocation('init --help')
       .addInvocation('init -h')
@@ -54,8 +54,8 @@ describe('The Angularity init task', function () {
     }
   });
 
-  describe('directory creation', function () {
-    it('should rerun in any directory with package.json', function(done) {
+  describe('should rerun in any directory with package.json', function () {
+    it('init', function(done) {
       helper.runner.create()
         .addInvocation('init')
         .run()