grunt-html-snapshots 4.0.2 → 4.1.0

package/.github/workflows/verify.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3.0.0
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm ci

package/Gruntfile.js

@@ -27,6 +27,12 @@ module.exports = function (grunt) {
       }
     },
 
+    test_server3: {
+      options: {
+        port: 8051
+      }
+    },
+
     // Configuration to be run (and then tested).
     html_snapshots: {
       options: grunt.file.readJSON("test/input/default_options"),
@@ -45,6 +51,14 @@ module.exports = function (grunt) {
           port: "<%= test_server2.options.port %>",
           force: true
         }
+      },
+
+      target3: {
+        options: {
+          source: "test/fixtures/test_robots_sitemap.txt",
+          outputDir: "tmp/target3/snapshots",
+          port: "<%= test_server3.options.port %>"
+        }
       }
     },
     

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "grunt-html-snapshots",
   "description": "The grunt task for html-snapshots",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "homepage": "https://github.com/localnerve/grunt-html-snapshots",
   "author": {
     "name": "Alex Grant",
@@ -25,10 +25,10 @@
     "lint": "eslint ."
   },
   "dependencies": {
-    "html-snapshots": "^0.18.2"
+    "html-snapshots": "^0.19.0"
   },
   "devDependencies": {
-    "eslint": "^8.12.0",
+    "eslint": "^8.24.0",
     "grunt-contrib-clean": "^2.0.1",
     "grunt-contrib-nodeunit": "^4.0.0",
     "grunt": ">=1.5.3"

package/test/expected/target3

@@ -0,0 +1,3 @@
+tmp/target3/snapshots/index.html
+tmp/target3/snapshots/contact/index.html
+tmp/target3/snapshots/services/carpets/index.html

package/test/fixtures/test_robots.txt

@@ -9,7 +9,5 @@ Disallow: /vendor/
 Disallow: /fonts/
 Disallow: /images/
 
-Sitemap: http://somehost/sitemap.xml
-
 User-agent: ia_archiver
 Disallow: /

package/test/fixtures/test_robots_sitemap.txt

@@ -0,0 +1,15 @@
+User-agent: *
+
+Allow: /
+Allow: /contact
+Allow: /services/carpets
+
+Disallow: /api/
+Disallow: /vendor/
+Disallow: /fonts/
+Disallow: /images/
+
+Sitemap: http://localhost:8051/sitemap.xml
+
+User-agent: ia_archiver
+Disallow: /

package/test/html_snapshots_target3.js

@@ -0,0 +1,29 @@
+/**
+ * tests, target1
+ */
+/* global Promise */
+const grunt = require('grunt');
+const { pathExists } = require('./utils');
+
+exports.html_snapshots = {
+  setUp: done => {
+    // setup here if necessary
+    done();
+  },
+
+  target1: test => {
+    test.expect(3);
+
+    const results = [];
+
+    grunt.file.read('test/expected/target3').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(true, exists, `${line} should exist`);
+      }));
+    });
+
+    Promise.all(results).finally(()=> {
+      test.done();
+    })
+  }
+};

package/test/html_snapshots_test.js

@@ -39,6 +39,22 @@ exports.html_snapshots = {
       }));
     });
 
+    Promise.all(results).finally(() => {
+      test.done();
+    });
+  },
+
+  target3: function(test) {
+    test.expect(3);
+
+    const results = [];
+
+    grunt.file.read('test/expected/target3').split('\n').forEach(line => {
+      results.push(pathExists(line).then(exists => {
+        test.equal(true, exists, `${line} should exist`);
+      }));      
+    });
+
     Promise.all(results).finally(() => {
       test.done();
     });

package/test/server/index.js

@@ -1,18 +1,18 @@
 /**
  * Create a local web server for tests
  */
-var http = require("http"),
-    url = require("url"),
-    path = require("path"),
-    fs = require("fs");
+const http = require("http"),
+      url  = require("url"),
+      path = require("path"),
+      fs   = require("fs");
 
 module.exports = {
 
   start: function(rootDir, port, end) {
     http.createServer(function(request, response) {
 
-      var uri = url.parse(request.url).pathname,
-          filename = path.join(rootDir, uri);
+      const uri = url.parse(request.url).pathname;
+      let filename = path.join(rootDir, uri);
 
       fs.exists(filename, function(exists) {
         if(!exists) {
@@ -34,8 +34,13 @@ module.exports = {
             return;
           }
 
-          response.writeHead(200);
-          response.write(file, "binary");
+          if (path.extname(filename) === '.xml') {
+            response.writeHead(200, {"Content-Type": "text/xml"});
+            response.write(file);
+          } else {
+            response.writeHead(200);
+            response.write(file, "binary");
+          }
           response.end();
           if (typeof end === "function")
             setTimeout(end, 1000);

package/test/server/sitemap.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>http://localhost:8051/</loc>
+    <lastmod>2012-08-11T12:16:09+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>1.0</priority>
+  </url>
+  <url>
+    <loc>http://localhost:8051/contact</loc>
+    <lastmod>2012-11-02T02:53:40+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.6</priority>
+  </url>
+  <url>
+    <loc>http://localhost:8051/services/carpets</loc>
+    <lastmod>2012-10-19T10:45:23+00:00</lastmod>
+    <changefreq>weekly</changefreq>
+    <priority>0.6</priority>
+  </url>
+</urlset>