html-snapshots 0.17.2 → 0.18.0

package/examples/verbose/package.json

@@ -7,6 +7,6 @@
     "start": "node ./snapshot.js"
   },
   "dependencies": {
-    "html-snapshots": ">= 0.14.0"
-   }
+    "html-snapshots": "^0.17.8"
+  }
 }

package/examples/verbose/snapshot.js

@@ -1,6 +1,6 @@
 /*
  * Snapshot an example website.
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  *
  * Use sitemap.xml to snapshot an entire site.
  * Use the verbose option to debug the loading of one of the pages.

package/lib/async/exists.js

@@ -5,12 +5,11 @@
  * Empirically, I found that either one of these NodeJS checks can fail,
  * but both don't. This is a workaround.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 
-const fs = require("fs");
-const nodeCall = require("../common/node");
+const fs = require("fs").promises;
 
 /**
  * Check if a path exists.
@@ -21,22 +20,10 @@ const nodeCall = require("../common/node");
  * success. Otherwise, resolve to boolean. Defaults to false (boolean).
  * @returns {Promise} Resolves to true (or file) if exists, false otherwise.
  */
-function pathExists (path, options) {
-  options = options || {
-    returnFile: false
-  };
-
-  // Defaults to F_OK
-  return nodeCall(fs.access, path)
-    .then(() => {
-      return options.returnFile ? path : true;
-    })
-    .catch(() => {
-      if (fs.existsSync(path)) {
-        return options.returnFile ? path : true;
-      }
-      return false;
-    });
+function pathExists (path, { returnFile=false }={ returnFile: false }) {
+  return fs.access(path)
+    .then(() => returnFile ? path : true)
+    .catch(() => false);
 }
 
 module.exports = pathExists;

package/lib/async/index.js

@@ -4,7 +4,7 @@
  * Async stuff for html-snapshots
  *   Notifier class
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global Promise */

package/lib/common/index.js

@@ -1,7 +1,7 @@
 /**
  * common code
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/common/node.js

@@ -1,7 +1,7 @@
 /***
  * nodeCall
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global Promise */

package/lib/common/sitemap.js

@@ -4,7 +4,7 @@
  * An input generator for html-snapshots that uses a sitemap.xml file.
  * Creates the snapshot arguments driven from sitemap.xml urls.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/html-snapshots.js

@@ -6,7 +6,7 @@
  * By default, uses a selector to search content to determine if
  *   a page is "ready" for its html snapshot.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global Promise */

package/lib/input-generators/_base.js

@@ -3,7 +3,7 @@
  *
  * The common, base functionality of an input generator.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/input-generators/array.js

@@ -4,7 +4,7 @@
  * An input generator for html-snapshots that uses a javascript array
  *   to generate snapshot input from the host relative page urls.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global Promise */

package/lib/input-generators/index.js

@@ -4,7 +4,7 @@
  * Input generator factory
  * Create an input generator that produces snapshots arguments
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/input-generators/robots.js

@@ -6,7 +6,7 @@
  * Does not support wildcards.
  * If you need wildcards, use the sitemap input generator.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/input-generators/sitemap-index.js

@@ -4,7 +4,7 @@
  * An input generator for html-snapshots that uses a sitemap index xml file.
  * Creates the snapshot arguments driven from multiple sitemap.xml urls.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global Promise */

package/lib/input-generators/sitemap.js

@@ -4,7 +4,7 @@
  * An input generator for html-snapshots that uses a sitemap.xml file.
  * Creates the snapshot arguments driven from sitemap.xml urls.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/input-generators/textfile.js

@@ -4,7 +4,7 @@
  * An input generator for html-snapshots that uses a simple text file
  *   with the host relative page urls, one per line.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/phantom/customFilter.js

@@ -7,7 +7,7 @@
  *
  * This is a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 var selectorDetect = require("./modules/selectorDetect");

package/lib/phantom/default.js

@@ -6,7 +6,7 @@
  *
  * This is a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 var selectorDetect = require("./modules/selectorDetect");

package/lib/phantom/modules/cli.js

@@ -6,7 +6,7 @@
  *
  * This is a module for a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/phantom/modules/detectors.js

@@ -11,7 +11,7 @@
  *
  * This is a module for a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global document, $ */

package/lib/phantom/modules/globals.js

@@ -5,7 +5,7 @@
  *
  * This is a module for a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global phantom */

package/lib/phantom/modules/selectorDetect.js

@@ -5,7 +5,7 @@
  *
  * This is a module for a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 

package/lib/phantom/modules/verbose.js

@@ -5,7 +5,7 @@
  *
  * This is a module for a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 /* global window */

package/lib/phantom/removeScripts.js

@@ -7,7 +7,7 @@
  *
  * This is a phantomJS script that runs in phantomjs.
  *
- * Copyright (c) 2013 - 2020 Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
 var selectorDetect = require("./modules/selectorDetect");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-snapshots",
-  "version": "0.17.2",
+  "version": "0.18.0",
   "author": {
     "name": "Alex Grant",
     "email": "alex@localnerve.com",
@@ -24,7 +24,7 @@
     "test:common": "mocha test/mocha/common/*.js --exit --reporter spec",
     "test:input-generators": "mocha test/mocha/input-generators/*.js --exit --reporter spec",
     "test:html-snapshots": "mocha test/mocha/html-snapshots/*.js --exit --reporter spec",
-    "coverage": "istanbul cover -- _mocha test/mocha/**/*.js --exit --recursive --reporter spec",
+    "test:cover": "istanbul cover -- _mocha test/mocha/**/*.js --exit --recursive --reporter spec",
     "validate": "npm ls"
   },
   "pre-commit": [
@@ -46,28 +46,29 @@
     "sitemap.xml"
   ],
   "dependencies": {
-    "async": "3.2.0",
-    "async-lock": "1.2.4",
+    "async": "3.2.3",
+    "async-lock": "1.3.1",
     "combine-errors": "3.0.3",
-    "lodash": "^4.17.15",
-    "mkdirp": "^1.0.3",
+    "lodash": "4.17.21",
+    "mkdirp": "1.0.4",
     "phantomjs-prebuilt": "2.1.16",
-    "request": "^2.88.0",
-    "rimraf": "^3.0.0",
-    "xml2js": "~0.4.23"
+    "request": "2.88.2",
+    "rimraf": "3.0.2",
+    "xml2js": "0.4.23"
   },
   "devDependencies": {
-    "coveralls": "^3.0.9",
-    "eslint": "^6.8.0",
-    "express": "^4.17.1",
-    "mocha": "^7.0.1",
-    "istanbul": "^0.4.2",
-    "precommit-hook": "^3.0.0",
-    "server-destroy": "^1.0.1",
-    "sitemap-xml": "~0.1.0"
+    "coveralls": "3.1.1",
+    "eslint": "8.12.0",
+    "express": "4.17.3",
+    "mocha": "9.2.2",
+    "istanbul": "0.4.5",
+    "precommit-hook": "3.0.0",
+    "server-destroy": "1.0.1",
+    "sitemap-xml": "0.1.0",
+    "handlebars": "4.7.7"
   },
   "license": "MIT",
   "engines": {
-    "node": ">= 10"
+    "node": ">= 14"
   }
 }

package/test/helpers/options.js

@@ -1,7 +1,7 @@
 /*
  * options.js
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  * 
  * A test helper to decorate html-snapshots options
  *

package/test/helpers/result.js

@@ -1,7 +1,7 @@
 /**
  * Asserts error is error.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 var assert = require("assert");
 

package/test/helpers/sitemap.js

@@ -1,7 +1,7 @@
 /*
  * Helper to add dynamic url nodes to a test sitemap.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 var smLib = require("sitemap-xml");
 var urlLib = require("url");

package/test/mocha/async/test.js

@@ -1,7 +1,7 @@
 /**
  * Async module tests.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, beforeEach, it */
 var assert = require("assert");
@@ -97,7 +97,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function (file) {
         notifier.add(file, timeout);
@@ -139,7 +139,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function(file) {
         notifier.add(file, timeout);
@@ -188,7 +188,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function (file) {
         notifier.add(file, timeout);
@@ -229,7 +229,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function (file) {
         notifier.add(file, timeout);
@@ -301,7 +301,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function (file) {
         notifier.add(file, timeout);
@@ -337,7 +337,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       files.forEach(function (file) {
         notifier.add(file, timeout);
@@ -381,7 +381,7 @@ describe("async", function () {
       });
 
       mkdirp.sync(dir);
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       // create a worker queue, attach qEmpty
       var q = asyncLib.queue(function (task, callback) {

package/test/mocha/common/helpers.js

@@ -1,7 +1,7 @@
 /**
  * Helpers tests.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, it */
 var assert = require("assert");

package/test/mocha/common/node.js

@@ -1,7 +1,7 @@
 /**
  * Common node tests.
  * 
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, it */
 var assert = require("assert");

package/test/mocha/common/test.js

@@ -1,7 +1,7 @@
 /**
  * Common module tests.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global describe, it */
 var assert = require("assert");

package/test/mocha/html-snapshots/basics.js

@@ -1,7 +1,7 @@
 /**
  * Basic library tests.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
 var assert = require("assert");
@@ -40,11 +40,9 @@ function basicTests () {
       var file = path.join(dir, "somefile.txt");
       var twice = _.after(2, cleanupError.bind(null, done, 0));
 
-      if (!fs.existsSync(dir)) {
-       fs.mkdirSync(dir);
-      }
+      fs.mkdirSync(dir);
       fs.writeFileSync(file, "some data");
-      assert.equal(true, fs.existsSync(dir));
+      assert.doesNotThrow(fs.accessSync.bind(null, dir));
 
       ss.run(optHelp.decorate({
        source: bogusFile,
@@ -54,7 +52,7 @@ function basicTests () {
        .then(unexpectedSuccess.bind(null, done))
        .catch(twice);
 
-      assert.equal(false, (fs.existsSync(dir) || fs.existsSync(file)));
+      assert.throws(fs.accessSync.bind(null, dir));
     });
 
     it("default snapshot script should exist", function (done) {
@@ -63,7 +61,7 @@ function basicTests () {
 
       var result = ss.run(optHelp.decorate(options), twice);
 
-      assert.equal(true, fs.existsSync(options.snapshotScript));
+      assert.doesNotThrow(fs.accessSync.bind(null, options.snapshotScript));
 
       result
        .then(unexpectedSuccess.bind(null, done))

package/test/mocha/html-snapshots/myFilter.js

@@ -2,7 +2,7 @@
  * In-test, custom filter script.
  * Adds a custom tag onto the body.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 module.exports = function(content) {
   console.log("IN THE CUSTOMFILTER");

package/test/mocha/html-snapshots/phantomjs-options.js

@@ -1,10 +1,9 @@
 /**
  * Library tests focused on the phantomjsOptions option.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
-var assert = require("assert");
 var path = require("path");
 var fs = require("fs");
 var rimraf = require("rimraf").sync;
@@ -28,6 +27,30 @@ function phantomjsOptionsTests (options) {
   var port = options.port;
 
   return function () {
+    it ("should work on first vanilla full invocation, no checks", function (done) {
+      var options = {
+        input: "array",
+        source: [ "http://localhost:"+port+"/pjsopts" ],
+        outputDir: outputDir,
+        outputDirClean: false,
+        selector: ".content-complete",
+        timeout: timeout,
+        phantomjsOptions: "--cookies-file="+cookiesFile
+      };
+
+      rimraf(outputBase);
+
+      ss.run(optHelp.decorate(options))
+        .then(() => {
+          cleanup(done);
+        }).catch(e => {
+          checkActualFiles(e.notCompleted)
+            .then(() => {
+              cleanup(done, e || unexpectedError);
+            });
+        });
+    });
+
     it("should work with one string option", function (done) {
       var options = {
         input: "array",
@@ -46,16 +69,16 @@ function phantomjsOptionsTests (options) {
           console.log('@@@ error = '+err+", completed="+completed.join(','));
         }
       })
-        .then(function () {
+        .then(() => {
           var assertionError;
           try {
-            assert.equal(true, fs.existsSync(cookiesFile), "cookie file in phantomjsOptions not found");
+            fs.accessSync(cookiesFile);
           } catch (e) {
             assertionError = e;
           }
           cleanup(done, assertionError);
         })
-        .catch(function (e) {
+        .catch(e => {
           checkActualFiles(e.notCompleted)
             .then(function () {
               cleanup(done, e || unexpectedError);
@@ -84,18 +107,18 @@ function phantomjsOptionsTests (options) {
           console.log('@@@ error = '+err+", completed="+completed.join(','));
         }
       })
-        .then(function () {
+        .then(() => {
           var assertionError;
           try {
-            assert.equal(true, fs.existsSync(cookiesFile), "cookie file in phantomjsOptions not found");
+            fs.accessSync(cookiesFile);
           } catch (e) {
             assertionError = e;
           }
           cleanup(done, assertionError);
         })
-        .catch(function (e) {
+        .catch(e => {
           checkActualFiles(e.notCompleted)
-            .then(function () {
+            .then(() => {
               cleanup(done, e || unexpectedError);
             });
         });
@@ -119,7 +142,7 @@ function phantomjsOptionsTests (options) {
 
       ss.run(optHelp.decorate(options))
         .then(unexpectedSuccess.bind(null, done))
-        .catch(function (err) {
+        .catch(err => {
           var assertionError;
           try {
             resHelp.mustBeError(err);

package/test/mocha/html-snapshots/process-limit.js

@@ -1,7 +1,7 @@
 /**
  * Library tests focused on the processLimit option.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
 var assert = require("assert");

package/test/mocha/html-snapshots/robots.js

@@ -1,7 +1,7 @@
 /**
  * Library tests that use robots.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
 var path = require("path");

package/test/mocha/html-snapshots/sitemap-index.js

@@ -1,7 +1,7 @@
 /**
  * Library tests that use sitemap-index.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
 var assert = require("assert");

package/test/mocha/html-snapshots/sitemap.js

@@ -1,7 +1,7 @@
 /**
  * Library tests that use sitemap.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global it */
 var assert = require("assert");

package/test/mocha/html-snapshots/snapshot-scripts.js

@@ -1,7 +1,7 @@
 /**
  * Library tests focused on the phantomjsOptions option.
  *
- * Copyright (c) 2013 - 2020, Alex Grant, LocalNerve, contributors
+ * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
  */
 /* global beforeEach, describe, it */
 // var assert = require("assert");