html-snapshots 1.4.0 → 1.5.0

package/lib/common/index.js

@@ -27,7 +27,8 @@ function ensure (options, must) {
 }
 
 /**
- * simple test for url
+ * Simple test for url
+ * 
  * If you can think of a more approriate test for this use case,
  *   please let me know in the issues...
  *
@@ -41,6 +42,55 @@ function isUrl (obj) {
   return false;
 }
 
+/**
+ * Simple test for a function
+ * 
+ * @param {Any} value - Some object to test.
+ * @returns {Boolean} True if is a function, false otherwise.
+ */
+function isFunction (value) {
+  return typeof value === "function";
+}
+
+/**
+ * Simple test for an object
+ * 
+ * @param {Any} value - Some object to test.
+ * @returns {Boolean} True if is an object, false otherwise.
+ */
+function isObject (value) {
+  const type = typeof value;
+  return value != null && type === "object";
+}
+
+/**
+ * Wrap a function so it runs one time only.
+ * 
+ * @param {Function} fn - The function to run once only.
+ * @param  {...any} args - The arguments.
+ * @returns {Function} To run the given function once only. 
+ */
+function once (fn, ...args) {
+  function onceWrapper () {
+    if (!this.ran) {
+      this.ran = true;
+      return fn(...args);
+    }
+  }
+  onceWrapper.ran = false;
+  return onceWrapper.bind(onceWrapper);
+}
+
+/**
+ * Get the first element of an array.
+ *
+ * @param {Array} array 
+ * @returns {Any} The first value of an array or undefined.
+ */
+function head (array) {
+  return (array && array.length) ? array[0] : undefined;
+}
+
 /**
  * Prepend a message to an Error message.
  *
@@ -103,8 +153,12 @@ function checkResponse (res, mediaTypes) {
 }
 
 module.exports = {
+  checkResponse,
   ensure,
+  head,
   isUrl,
-  prependMsgToErr,
-  checkResponse
+  isFunction,
+  isObject,
+  once,
+  prependMsgToErr
 };

package/lib/common/sitemap/sitemap-collection.js

@@ -6,7 +6,6 @@
  */
 const fs = require("fs");
 const pathLib = require("path");
-const mkdirp = require("mkdirp");
 const common = require("../index");
 const base = require("../../input-generators/_base");
 
@@ -19,7 +18,9 @@ const base = require("../../input-generators/_base");
  function prepareWrite (outputPath, callback) {
   const path = pathLib.parse(outputPath);
   const dir = pathLib.join(path.root, path.dir);
-  mkdirp(dir).then(() => callback()).catch(callback);
+  fs.mkdir(dir, { recursive: true }, err => {
+    callback(err);
+  });
 }
 
 /**

package/lib/common/sitemap/sitemap-index.js

@@ -6,7 +6,6 @@
  * Copyright (c) 2013 - 2022 Alex Grant, LocalNerve, contributors
  * Licensed under the MIT license.
  */
-const _ = require("lodash");
 const smc = require("./sitemap-collection");
 
 /**
@@ -26,9 +25,7 @@ function sitemapIndexUrls (smLib, options, parseResult) {
   };
 
   // Check if we should process each sitemap in the index.
-  _.forEach(
-    // if the sitemap index is malformed, just blow up
-    parseResult.sitemapindex.sitemap,
+  parseResult.sitemapindex?.sitemap?.forEach(
     sitemapNode => {
       // optionally ignore current sitemaps by sitemap policy
       const shouldProcess = !options.sitemapPolicy ||

package/lib/common/sitemap/sitemap.js

@@ -13,7 +13,6 @@ const util = require("util");
 const path = require("path");
 const urlm = require("url");
 const zlib = require("zlib");
-const _ = require("lodash");
 const xml2js = require("xml2js");
 const smi = require("./sitemap-index");
 const common = require("../index");
@@ -47,8 +46,9 @@ function stillCurrent (urlNode, options) {
   let lesser, greater, oPath;
   const statOpts = {throwIfNoEntry: false};
   const now = Date.now();
-  const lMod = _.first(urlNode.lastmod);
-  const cFreq = _.first(urlNode.changefreq) ? _.first(urlNode.changefreq).toLowerCase() : null;
+  const lMod = common.head(urlNode.lastmod);
+  const cFreq = common.head(urlNode.changefreq) ?
+    common.head(urlNode.changefreq).toLowerCase() : null;
 
   // only lastmod specified
   if (lMod && !cFreq) {
@@ -101,12 +101,11 @@ function parse (options, document, callback) {
           .catch(callback);
       } else {
         // Process the url input, but break if base.input returns false.
-        //   In other words, _.find is looking for a non-falsy err.
+        //   In other words, result.urlset.url.find is looking for a non-falsy err.
         // For now, this can only happen if no outputDir is defined,
         //   which is a fatal bad option problem and will happen immediately.
-        _.find(
-          // if the sitemap is malformed, just blow up
-          result.urlset.url,
+        // if sitemap malformed (result.urlset.url is not array), just blow up...
+        result.urlset.url.find(
           urlNode => {
             // optionally ignore current urls by sitemap policy
             let url;
@@ -116,12 +115,15 @@ function parse (options, document, callback) {
             if (process) {
               // if sitemap is malformed, just blow up
               url = urlm.parse(urlNode.loc[0]);
-              if (!base.input(_.extend({}, options, {
-                  protocol: url.protocol,
-                  auth: url.auth,
-                  hostname: url.hostname,
-                  port: url.port
-                }),
+              if (!base.input(
+                { ...options,
+                  ...{
+                    protocol: url.protocol,
+                    auth: url.auth,
+                    hostname: url.hostname,
+                    port: url.port
+                  }
+                },
                 urlNode.loc[0])
               ) {
                 source = urlNode.loc[0];

package/lib/html-snapshots.js

@@ -15,7 +15,6 @@ const path = require("path");
 const EventEmitter = require("events").EventEmitter;
 const rimraf = require("rimraf").sync;
 const asyncLib = require("async");
-const _ = require("lodash");
 
 const common = require("./common");
 const inputFactory = require("./input-generators");
@@ -108,7 +107,7 @@ function phantomjsWorker (input, options, notifier, qcb) {
   if (!notifier.known(input.outputFile)) {
 
     // map snapshotScript object script to a real path
-    if (_.isObject(options.snapshotScript)) {
+    if (common.isObject(options.snapshotScript)) {
       snapshotScript = `${path.join(__dirname, phantomDir, options.snapshotScript.script)}.js`;
       customModule = options.snapshotScript.module;
     }
@@ -176,7 +175,7 @@ function puppeteerWorker (input, options, notifier, qcb) {
   if (!notifier.known(input.outputFile)) {
 
     // map snapshotScript object script
-    if (_.isObject(options.snapshotScript)) {
+    if (common.isObject(options.snapshotScript)) {
       snapshotScript = options.puppeteer;
       if (options.snapshotScript.script === "removeScripts") {
         filter = "./removeScripts";
@@ -280,7 +279,7 @@ module.exports = {
       const completion = new Promise((resolve, reject) => {
         function completionResolver (err, completed) {
           try {
-            _.isFunction(listener) && listener(err, completed);
+            common.isFunction(listener) && listener(err, completed);
           } catch (e) {
             console.error("User supplied listener exception", e);
           }
@@ -297,7 +296,7 @@ module.exports = {
 
       // create a worker queue with a parallel process limit.
       const q = asyncLib.queue(
-        (task, callback) => { task(_.once(callback)); },
+        (task, callback) => { task(common.once(callback)); },
         options.processLimit
       );
 
@@ -313,7 +312,7 @@ module.exports = {
 
       // generate input for the snapshots.
       return inputGenerator.run(options, input => {
-        q.push(_.partial(worker, input, options, notifier));
+        q.push(worker.bind(worker, input, options, notifier));
       }).then(() => completion)
     }
     

package/lib/input-generators/_base.js

@@ -10,7 +10,6 @@
 const EventEmitter = require("events").EventEmitter;
 const path = require("path");
 const urlm = require("url");
-const _ = require("lodash");
 const common = require("../common");
 
 // Defaults for this module
@@ -80,10 +79,11 @@ function normalize (obj) {
  */
 function supplyMissingDefault (options, name) {
   if (options[name]() === void 0) {
-    options[name] = _.wrap(options[name], (func, key) => {
-      const res = func(key);
+    const originalFn = options[name].bind(options[name]);
+    options[name] = key => {
+      const res = originalFn(key);
       return res === void 0 ? defaults[name] : res;
-    });
+    };
   }
 }
 
@@ -184,7 +184,7 @@ function getOutputPath (options, page, parse) {
  * @returns {String|Boolean} The full path to the output file or false on failure.
  */
 function mapOutputFile (options, page, parse) {
-  if (!_.isFunction(options.outputPath)) {
+  if (!common.isFunction(options.outputPath)) {
     options.outputPath = normalize(options.outputPath);
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-snapshots",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "author": {
     "name": "Alex Grant",
     "email": "alex@localnerve.com",
@@ -22,6 +22,7 @@
     "test": "mocha test/mocha/**/*.js --exit --recursive --reporter spec",
     "test:async": "mocha test/mocha/async/test.js --exit --reporter spec",
     "test:common": "mocha test/mocha/common/*.js --exit --reporter spec",
+    "test:common:debug": "mocha --inspect-brk test/mocha/common/*.js --exit --reporter spec",
     "test:browsers": "mocha test/mocha/browsers/test.js --exit --reporter spec",
     "test:browsers:cover": "c8 -- npm run test:browsers",
     "test:input-generators": "mocha test/mocha/input-generators/*.js --exit --reporter spec",
@@ -56,15 +57,13 @@
     "async-lock": "1.4.0",
     "combine-errors": "3.0.3",
     "got": "12.5.3",
-    "lodash": "4.17.21",
-    "mkdirp": "1.0.4",
     "phantomjs-prebuilt": "2.1.16",
-    "puppeteer": "^19.2.2",
+    "puppeteer": "^19.3.0",
     "rimraf": "3.0.2",
     "xml2js": "0.4.23"
   },
   "devDependencies": {
-    "eslint": "8.27.0",
+    "eslint": "8.28.0",
     "express": "4.18.2",
     "mocha": "10.1.0",
     "c8": "7.12.0",