feat: Add optional automatic file numbering

prantlf · prantlf · commit e9461981effa · 2018-03-01T11:13:10.000+01:00
diff --git a/README.md b/README.md
@@ -79,6 +79,9 @@ Default options support the most usual usage scenario:
     doctype: '<!DOCTYPE html>',
     snapshots: 'snapshots',
     screenshots: null,
+    fileNumbering: false,
+    fileNumberDigits: 3,
+    fileNumberSeparator: '.',
     force: false
   },
   'google': {
@@ -163,6 +166,24 @@ Default value: null
 
 Destination directory to write the viewport screenshots to. It will be created if it does not exist. Default value is `null`, which means, that no screenshots will be written out.
 
+#### fileNumbering
+Type: `Booolean`
+Default value: `false`
+
+Enables prefixing names of snapshot and screenshot files with their index number, for example: "002.google-input.html".
+
+#### fileNumberDigits
+Type: `Number`
+Default value: `3`
+
+Ensures, that file numbers will have always at least the specified count of digits. If the number is smaller, than its power of 10, the number will be padded by zeros (0) from the left.
+
+#### fileNumberSeparator
+Type: `String`
+Default value: '.'
+
+The character to put between the file number and the file name.
+
 #### force
 Type: `Boolean`
 Default value: false
@@ -475,6 +496,8 @@ your code using Grunt.
 
 ## Release History
 
+ * 2018-03-01  [v0.7.0]  Add optional automatic file numbering
+ * 2018-02-28  [v0.6.0]  Add the allRequired option to the hasClass instruction
  * 2018-02-26  [v0.5.0]  Allow checking and setting various properties
  * 2018-02-22  [v0.4.0]  Allow sending key strokes to the browser
  * 2018-01-30  [v0.3.0]  Allow specifying test commands in separate modules
diff --git a/package.json b/package.json
@@ -35,6 +35,7 @@
   },
   "dependencies": {
     "mkdirp": "^0.5.1",
+    "pad-left": "^2.1.0",
     "webdriverio": "^4.11.0"
   },
   "devDependencies": {
diff --git a/tasks/html-dom-snapshot.js b/tasks/html-dom-snapshot.js
@@ -10,6 +10,7 @@
 'use strict';
 
 const fs = require('fs'),
+      pad = require('pad-left'),
       path = require('path'),
       mkdirp = require('mkdirp'),
       instructions = [
@@ -24,6 +25,7 @@ const fs = require('fs'),
       ].map(function (instruction) {
         return require('./instructions/' + instruction);
       });
+var fileCount = 0;
 
 module.exports = function (grunt) {
   grunt.registerMultiTask('html-dom-snapshot',
@@ -45,6 +47,9 @@ module.exports = function (grunt) {
             selectorTimeout: 10000,
             doctype: '<!DOCTYPE html>',
             snapshots: 'snapshots',
+            fileNumbering: false,
+            fileNumberDigits: 3,
+            fileNumberSeparator: '.',
             force: false
           }),
           target = this.target,
@@ -159,6 +164,9 @@ module.exports = function (grunt) {
               lastViewport: lastViewport
             }, options, command.options || {}),
             file = command.file,
+            fileNumbering = commandOptions.fileNumbering,
+            fileNumberDigits = commandOptions.fileNumberDigits,
+            fileNumberSeparator = commandOptions.fileNumberSeparator,
             viewport = commandOptions.viewport,
             screenshots = commandOptions.screenshots,
             commandInstructions = instructions.map(function (instruction) {
@@ -204,12 +212,15 @@ module.exports = function (grunt) {
         }, viewportSet)
         .then(function () {
           if (snapshots && screenshots) {
+            ++fileCount;
             return Promise.all([makeSnapshot(), makeScreenshot()]);
           }
           if (snapshots) {
+            ++fileCount;
             return makeSnapshot();
           }
           if (screenshots) {
+            ++fileCount;
             return makeScreenshot();
           }
         });
@@ -226,51 +237,64 @@ module.exports = function (grunt) {
 
       function saveContent(html) {
         if (file) {
-          const testFile = file.toLowerCase(),
-                htmlFile = testFile.endsWith('.html') ||
-                           testFile.endsWith('.htm') ? file : file + '.html',
-                target = path.join(snapshots, htmlFile);
-          grunt.log.ok('Write snapshot to "' + target + '".');
+          var fileName = file.toLowerCase();
+          fileName = fileName.endsWith('.html') ||
+                     fileName.endsWith('.htm') ? file : file + '.html';
+          if (fileNumbering) {
+            fileName = numberFileName(fileName);
+          }
+          fileName = path.join(snapshots, fileName);
+          grunt.log.ok('Write snapshot to "' + fileName + '".');
           return ensureDirectory(snapshots)
             .then(function () {
               return new Promise(function (resolve, reject) {
-                fs.writeFile(target, commandOptions.doctype + html, function (error) {
-                  if (error) {
-                    reject(error);
-                  } else {
-                    ++snapshotCount;
-                    resolve();
-                  }
-                });
+                fs.writeFile(fileName, commandOptions.doctype + html,
+                  function (error) {
+                    if (error) {
+                      reject(error);
+                    } else {
+                      ++snapshotCount;
+                      resolve();
+                    }
+                  });
               });
             });
         }
       }
 
       function saveImage(png) {
         if (file) {
-          const testFile = file.toLowerCase(),
-                baseFile = testFile.endsWith('.html') ?
-                           file.substr(0, file.length - 5) :
-                           testFile.endsWith('.htm') ?
-                           file.substr(0, file.length - 4) : file,
-                target = path.join(screenshots, baseFile + '.png');
-          grunt.log.ok('Write screenshot to "' + target + '".');
+          var fileName = file.toLowerCase();
+          fileName = fileName.endsWith('.html') ?
+                     file.substr(0, file.length - 5) :
+                     fileName.endsWith('.htm') ?
+                     file.substr(0, file.length - 4) : file;
+          if (fileNumbering) {
+            fileName = numberFileName(fileName);
+          }
+          fileName = path.join(screenshots, fileName + '.png');
+          grunt.log.ok('Write screenshot to "' + fileName + '".');
           return ensureDirectory(screenshots)
             .then(function () {
               return new Promise(function (resolve, reject) {
-                fs.writeFile(target, new Buffer(png.value, 'base64'), function (error) {
-                  if (error) {
-                    reject(error);
-                  } else {
-                    ++screenshotCount;
-                    resolve();
-                  }
-                });
+                fs.writeFile(fileName, new Buffer(png.value, 'base64'),
+                  function (error) {
+                    if (error) {
+                      reject(error);
+                    } else {
+                      ++screenshotCount;
+                      resolve();
+                    }
+                  });
               });
             });
         }
       }
+
+      function numberFileName(fileName) {
+        return pad(fileCount.toString(), fileNumberDigits, '0') +
+               fileNumberSeparator + fileName;
+      }
     }
   });
 };
diff --git a/test/test.js b/test/test.js
@@ -25,7 +25,7 @@ exports['html-dom-snapshot'] = {
 
   'static': function (test) {
     const snapshot = fs.existsSync('test/snapshots/static.html'),
-          screenshot = fs.statSync('test/screenshots/static.png');
+          screenshot = fs.statSync('test/screenshots/002.static.png');
     test.ok(!snapshot, 'static.html');
     test.ok(screenshot.size > 1024, 'static.png');
     test.done();
