html-snapshots 1.3.2 → 1.5.0

package/examples/verbose/package.json

@@ -1,12 +0,0 @@
-{
-  "name": "html-snapshots-example",
-  "version": "0.1.0",
-  "author": "Alex Grant <alex@localnerve.com>",
-  "description": "An example using html-snapshots",
-  "scripts": {
-    "start": "node ./snapshot.js"
-  },
-  "dependencies": {
-    "html-snapshots": "^1.0.1"
-  }
-}

package/examples/verbose/snapshot.js

@@ -1,34 +0,0 @@
-/*
- * Snapshot an example website.
- * 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.
- */
-const htmlSnapshots = require("html-snapshots");
-
-const origin = "https://www.sitemaps.org";
-const pageToDebug = `${origin}/en_GB/`;
-
-// Make the verbose option as an object keyed with the page to debug.
-const verboseOption = {
-  __default: false,
-  [pageToDebug]: true
-};
-
-htmlSnapshots.run({
-  input: "sitemap",
-  source: `${origin}/sitemap.xml`,
-  outputDir: require("path").join(__dirname, "./tmp"),
-  outputDirClean: true,
-  selector: "#mainContent",
-  timeout: 10000,
-  browser: "phantomjs",
-  processLimit: 1, // to clarify output
-  verbose: verboseOption
-})
-.then(completed => {
-  console.log("completed snapshots:");
-  console.log(require("util").inspect(completed));
-})
-.catch(console.error);

package/test/helpers/options.js

@@ -1,55 +0,0 @@
-/*
- * options.js
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- * 
- * A test helper to decorate html-snapshots options
- *
- * phantomjs
- * If a global phantomjs is defined, decorates html-snapshots options to specify that global
- * In some test environments (travis), local phantomjs will not install if a global is found.
- */
-const assert = require("assert");
-
-// @0.12.0, on Travis-ci phantomjs2 WILL install local WITH the older global.
-// So reverting back to decorateLocal only.
-// THIS COULD CHANGE... stay on top.
-
-// abort is now required, so if one not supplied, supply a default.
-function fillAbort (options) {
-  if (!options._abort) {
-    options._abort = function (err) {
-      const msg = `[options._abort] called: ${err.toString()}`;
-      console.log(`@@@ ${msg}`);
-      assert.fail(msg);
-    }
-  }
-}
-/*
-var spawn = require("child_process").spawn;
-
-function decorateGlobal (options) {
-    options.phantomjs = "phantomjs";
-    return options;
-}
-*/
-function decorateLocal(options) {
-  // local is the default
-  fillAbort(options);
-  return options;
-}
-
-/*
-var cp = spawn("phantomjs", ["--version"]);
-cp.on("error", function(err) {
-  module.exports.decorate = decorateLocal;
-});
-
-module.exports = {
-  decorate: decorateGlobal
-};
-*/
-
-module.exports = {
-  decorate: decorateLocal
-};

package/test/helpers/result.js

@@ -1,32 +0,0 @@
-/**
- * Asserts error is error.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-var assert = require("assert");
-
-/**
- * NodeJS v8 ifError throws if value is truthy
- * NodeJS v10 ifError throws if value is NOT undefined or null.
- * So to cover both, added falsy check.
- *
- * @param {*} err 
- */
-function notFalsy (err) {
-  return !!err;
-}
-
-function mustBeError (err) {
-  assert.throws(
-    function () {
-      notFalsy(err) && assert.ifError(err);
-    },
-    function (err) {
-      return !!err;
-    }
-  );
-}
-
-module.exports = {
-  mustBeError: mustBeError
-};

package/test/helpers/sitemap.js

@@ -1,130 +0,0 @@
-/*
- * Helper to add dynamic url nodes to a test sitemap.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-var smLib = require("sitemap-xml");
-var urlLib = require("url");
-var fs = require("fs");
-var pathLib = require("path");
-var _ = require("lodash");
-var mkdirp = require("mkdirp").sync;
-var base = require("../../lib/input-generators/_base");
-
-var now = new Date();
-var outofDate = "2013-05-01T00:00:00.000Z";
-
-/**
- * The sitemap element enum
- * Indicates which optional sitemap policy elements are missing.
- *    0 means no policy elements are missing
- *    1 means lastmod policy element is missing
- *    2 means changefreq policy element is missing
- *    3 means all policy elements missing
- */
-var smElement = {
-  none: 0,
-  lastMod: 1,
-  changeFreq: 2,
-  all: 3
-};
-
-/**
- * `current` is a boolean that indicates if the policy should be current
- * `missing` can be smElement value.
- *
- * If lastmod is not missing
- *   if current, it is now, else 1/1/2013
- * If changefreq is not missing
- *   it is always "weekly"
- */
-function lastmodChangeFreq(current, missing) {
-  var nowDate = now.getFullYear()+"-"+(now.getMonth()+1)+"-"+now.getDate();
-  return _.extend({},
-      (missing & smElement.lastMod) ? {} : { lastmod: current ? nowDate : outofDate },
-      (missing & smElement.changeFreq) ? {} : { changefreq: "weekly" }
-  );
-}
-
-/**
- * format a urlset.url.loc from a url path
- */
-function makeLoc(url) {
-  return urlLib.format({
-    protocol: "http",
-    host: "localhost",
-    pathname: url
-  });
-}
-
-/**
- * Builds a sitemap with localhost urls and stores it at `path`.
- * Creates the sitemap with `urls`, `current` of which will be current by policy
- * `missing` can be smElement value. 
- * All urls are given the priority of 0.5
- */
-function buildSitemapWithPolicy(path, urls, current, missing, cb) {
-  var sm = smLib();
-
-  // map given paths to url sitemap nodes
-  var urlNodes = urls.map(function(url, index) {
-    return _.extend({
-        loc: makeLoc(url),
-        priority: "0.5"
-      },
-      lastmodChangeFreq(index < current, missing)
-    );
-  });
-
-  //fs.unlinkSync(path);
-  var writeStream = fs.createWriteStream(path, { encoding: "utf8" });
-  writeStream.on("finish", cb);
-
-  sm.pipe(writeStream);
-  urlNodes.forEach(function(urlNode) {
-    sm.write(urlNode);
-  });
-  sm.end();
-}
-
-/**
- * Make html output files for a given url set.
- * The `urlset` is an array of objects that are: { loc: <url>, lastmod: <Date> }
- * This mocks output from a previous run and sets a,mtimes for the files.
- */
-function makeOutputFiles(options, urlset) {
-  var html = "<!doctype html><html><head><title>test</title></head><body><h1>Hello World</h1><p>This is a test</p</body>";
-  var filePath, outputDir;
-
-  urlset.forEach(function(urlObj) {
-    filePath = base.outputFile(options, urlObj.loc);
-    outputDir = pathLib.dirname(filePath);
-
-    if (!fs.existsSync()) {
-      mkdirp(outputDir);
-    }
-
-    fs.writeFileSync(filePath, html, { encoding: "utf8"});
-    fs.utimesSync(filePath, urlObj.lastmod, urlObj.lastmod);
-  });
-}
-
-/**
- * Mock pre-existing output files for comparisons.
- */
-function buildTestFiles(options, urls, current) {
-
-  makeOutputFiles(options, urls.map(function(url, index) {
-    return {
-      loc: makeLoc(url),
-      // always make the out of date file a little older than the outofDate sitemap
-      lastmod: index < current ? now : new Date(Date.parse(outofDate) - 10000)
-    };
-  }));
-}
-
-module.exports = {
-  smElement: smElement,
-  buildSitemapWithPolicy: buildSitemapWithPolicy,
-  buildTestFiles: buildTestFiles
-};

package/test/mocha/async/test.js

@@ -1,416 +0,0 @@
-/**
- * Async module tests.
- *
- * Copyright (c) 2013 - 2022, Alex Grant, LocalNerve, contributors
- */
-/* global describe, beforeEach, it */
-var assert = require("assert");
-var fs = require("fs");
-var path = require("path");
-var mkdirp = require("mkdirp");
-var rimraf = require("rimraf").sync;
-var asyncLib = require("async");
-var asyncLocal = require("../../../lib/async");
-
-var Notifier = asyncLocal.Notifier;
-
-describe("async", function () {
-
-  describe("Notifier", function () {
-    var notifier;
-
-    function createFiles (files) {
-      var fd;
-      files.forEach(function (file) {
-        fd = fs.openSync(file, 'w');
-        fs.closeSync(fd);
-      });
-    }
-
-    // create a worker for asyncLib.queue
-    function worker(file, timeout) {
-      return function (cb) {
-        setTimeout(function () {
-          fs.close(fs.openSync(file, 'w'), cb);
-        }, timeout);
-      };
-    }
-
-    var mockInput = {
-      EOI: function () { return true; }
-    };
-
-    beforeEach(function () {
-      notifier = new Notifier();
-    });
-
-    it("should throw if started more than once", function (done) {
-      notifier.start(1000, {}, function () {});
-
-      assert.throws(function () {
-        notifier.start(100, {}, function () {});
-      }, function (err) {
-        assert.ok(err instanceof Error);
-        done();
-      });
-    });
-
-    it("should throw if add called before start", function (done) {
-      assert.throws(function () {
-        notifier.add();
-      }, function (err) {
-        assert.ok(err instanceof Error);
-        done();
-      })
-    });
-
-    it("should be able to start and watch files get created", function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          pollCount = 4,
-          timeout = 100,
-          start;
-
-      rimraf(dir);
-
-      // take the worker queue out of the equation
-      notifier.qEmpty();
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        // make sure this wasn't called because of a timeout/failure
-        assert.equal(true, (Date.now() - start) < (timeout+asyncLocal.TIMEOUT_PAD_FLOOR));
-
-        // compare filesDone to input files
-        if (typeof err === "undefined") {
-          files.sort();
-          filesDone.sort();
-          assert.deepEqual(files, filesDone);
-
-          // audit paths
-          //console.log("filesDone paths:");
-          //for (var k=0; k < filesDone.length; k++) {
-          //  console.log(filesDone);
-          //}
-        }
-
-        done(err);
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      start = Date.now();
-      createFiles(files);
-    });
-
-    it("should be able to start and watch files get created, remove one from the list",
-    function (done) {
-      var dir = path.join(__dirname, "./files"),
-          filesToDo = [],
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          pollCount = 4,
-          timeout = 100,
-          start;
-
-      rimraf(dir);
-
-      // take the worker queue out of the equation
-      notifier.qEmpty();
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        // make sure this wasn't called because of a timeout/failure
-        assert.equal(true, (Date.now() - start) < (timeout+asyncLocal.TIMEOUT_PAD_FLOOR));
-
-        // compare filesDone to input files
-        if (typeof err === "undefined") {
-          filesToDo.sort();
-          filesDone.sort();
-          assert.deepEqual(filesToDo, filesDone);
-        }
-
-        done(err);
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function(file) {
-        notifier.add(file, timeout);
-      });
-
-      notifier.remove(files[2]);
-      filesToDo.push(files[0], files[1]);
-
-      assert.equal(files.length-1, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      start = Date.now();
-      createFiles(files);
-    });
-
-    it("should be able to start and watch files get created, one doesn't get created",
-    function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          filesToDo = files.slice(),
-          pollCount = 4,
-          timeout = 100,
-          start;
-
-      rimraf(dir);
-
-      // take the worker queue out of the equation
-      notifier.qEmpty();
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        // make sure this was called because of a failure
-        assert.equal(true, (Date.now() - start) > (timeout+asyncLocal.TIMEOUT_PAD_FLOOR));
-        // make sure this was a failure
-        assert.notStrictEqual(typeof err, "undefined");
-
-        // compare filesDone to intended filesToDo - should be different
-        filesToDo.sort();
-        filesDone.sort();
-        assert.notDeepEqual(filesToDo, filesDone);
-
-        // compare filesDone to files - should be the same
-        files.sort();
-        assert.deepEqual(files, filesDone);
-
-        done();
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      files.splice(1, 1); // remove the second element
-
-      start = Date.now();
-      createFiles(files);
-    });
-
-    it("should be able to start and watch files get created, none get created",
-    function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          pollCount = 4,
-          timeout = 100,
-          start;
-
-      rimraf(dir);
-
-      // take the worker queue out of the equation
-      notifier.qEmpty();
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        var assertionError;
-        try {
-          assert.equal(true, (Date.now() - start) > (timeout+asyncLocal.TIMEOUT_PAD_FLOOR));
-          assert.notStrictEqual(typeof err, "undefined");
-          assert.equal(0, filesDone.length);
-        } catch (e) {
-          assertionError = e;
-        }
-        done(assertionError);
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-      start = Date.now();
-    });
-
-    it("should fail if no callback supplied", function () {
-      var result = notifier.start(1, mockInput);
-
-      assert.equal(result, false);
-      assert.equal(0, notifier._fileCount());
-      assert.equal(false, notifier.isStarted());
-    });
-
-    it("should fail if negative poll interval supplied", function () {
-      var result = notifier.start(-1, mockInput, function (err) {
-        assert.fail(err, "[not undefined]", "should never have been called", "?");
-      });
-
-      assert.equal(result, false);
-      assert.equal(0, notifier._fileCount());
-      assert.equal(false, notifier.isStarted());
-    });
-
-    it("should fail if zero poll interval supplied", function () {
-      var result = notifier.start(0, mockInput, function (err){
-        assert.fail(err, "[not undefined]", "should never have been called", "?");
-      });
-
-      assert.equal(result, false);
-      assert.equal(0, notifier._fileCount());
-      assert.equal(false, notifier.isStarted());
-    });
-
-    it("should fail if no input generator is supplied", function () {
-      var result = notifier.start(250, undefined, function (err) {
-        assert.fail(err, "[not undefined]", "should never have been called", "?");
-      });
-
-      assert.equal(result, false);
-      assert.equal(0, notifier._fileCount());
-      assert.equal(false, notifier.isStarted());
-    });
-
-    it("should abort if requested, no files done yet", function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          pollCount = 4,
-          timeout = 400,
-          abortFailure = new Error("abortFailure");
-
-      rimraf(dir);
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        // make sure this was a failure
-        assert.notStrictEqual(typeof err, "undefined");
-
-        // make sure we got the expected err
-        assert.equal(err, abortFailure);
-
-        // and that no files were done
-        assert.equal(filesDone.length, 0);
-
-        done();
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      notifier.abort({ length: function () { return 0; } }, abortFailure);
-    });
-
-    it("should abort if requested, all but one file processed", function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          filesToDo = files.slice(),
-          pollCount = 8,
-          timeout = 400,
-          abortFailure = new Error("abortFailure");
-
-      rimraf(dir);
-
-      notifier.start(timeout / pollCount, mockInput, function (err, filesDone) {
-        // make sure this was a failure
-        assert.notStrictEqual(typeof err, "undefined");
-
-        // make sure we got the expected err
-        assert.equal(err, abortFailure);
-
-        // and that one file was not done
-        assert.equal(filesToDo.length - 1, filesDone.length);
-
-        done();
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      files.splice(1, 1); // remove the second element
-
-      createFiles(files);
-
-      // fake out async.queue here. In reality, q.length() would be 1 normally,
-      //   but it will never become empty since async.queue doesn't run in this test.
-      setTimeout(function () {
-        notifier.abort({ length: function() { return 0; } }, abortFailure);
-      }, 100);
-    });
-
-    it("should abort if requested, all but one file processed, real async",
-    function (done) {
-      var dir = path.join(__dirname, "./files"),
-          files = [dir+"/one", dir+"/two", dir+"/three"],
-          pollCount = 8,
-          timeout = 400,
-          abortFailure = new Error("abortFailure");
-
-      rimraf(dir);
-
-      notifier.start(timeout / pollCount, mockInput, function(err, filesDone) {
-        // make sure this was a failure
-        assert.notStrictEqual(typeof err, "undefined");
-
-        // make sure we got the expected err
-        assert.equal(err, abortFailure);
-
-        // and that one file was not done
-        assert.equal(files.length - 2, filesDone.length);
-
-        done();
-      });
-
-      mkdirp.sync(dir);
-      assert.doesNotThrow(fs.accessSync.bind(null, dir));
-
-      // create a worker queue, attach qEmpty
-      var q = asyncLib.queue(function (task, callback) {
-        task(callback);
-      }, 1);
-      q.empty(notifier.qEmpty.bind(notifier));
-
-      // simulate input activity
-      files.forEach(function (file) {
-        notifier.add(file, timeout);
-      });
-
-      assert.equal(files.length, notifier._fileCount());
-      assert.equal(true, notifier.isStarted());
-
-      // simulate work - files.length workers taking workerTime to complete.
-      var workerTime = 40;
-
-      files.forEach(function (file) {
-        q.push(worker(file, workerTime));
-      });
-
-      // call abort in the middle of the second to last worker
-      // so files.length - 2 workers should have completed since q.concurrent === 1
-      setTimeout(function () {
-        notifier.abort(q, abortFailure);
-      },
-        (workerTime * (files.length-1)) - (workerTime/2)
-      );
-    });
-  });
-});