validate-website 1.9.1 → 1.11.1

data/lib/validate_website/validator_class_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tidy_ffi'
 
 # Validator Class Methods
@@ -9,6 +11,7 @@ module ValidatorClassMethods
 
   def tidy
     return @tidy if defined?(@tidy)
+
     @lib_tidy = TidyFFI::LibTidy
     @tidy = TidyFFI::Tidy
   rescue TidyFFI::LibTidyNotInstalled

data/lib/validate_website/version.rb

@@ -2,5 +2,9 @@
 
 # Version file for ValidateWebsite
 module ValidateWebsite
-  VERSION = '1.9.1'.freeze
+  VERSION = '1.11.1'
+
+  def self.jruby? # :nodoc:
+    defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
+  end
 end

data/man/man1/validate-website-static.1

@@ -2,12 +2,12 @@
 .\"     Title: validate-website-static
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 1.5.8
-.\"      Date: 2019-01-09
+.\"      Date: 2021-01-10
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "VALIDATE\-WEBSITE\-STATIC" "1" "2019-01-09" "\ \&" "\ \&"
+.TH "VALIDATE\-WEBSITE\-STATIC" "1" "2021-01-10" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -82,7 +82,7 @@ Show colored output (Default: true)
 .sp
 \fB\-x\fP, \fB\-\-html5\-validator\fP \fIVALIDATOR\fP
 .RS 4
-Change default html5 validator engine (ex: tidy or nu)
+Change default html5 validator engine (tidy/nu/nokogumbo)
 .RE
 .sp
 \fB\-5\fP, \fB\-\-html5\-validator\-service\-url\fP \fIURL\fP

data/man/man1/validate-website.1

@@ -2,12 +2,12 @@
 .\"     Title: validate-website
 .\"    Author: [see the "AUTHOR(S)" section]
 .\" Generator: Asciidoctor 1.5.8
-.\"      Date: 2019-01-09
+.\"      Date: 2021-01-10
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "VALIDATE\-WEBSITE" "1" "2019-01-09" "\ \&" "\ \&"
+.TH "VALIDATE\-WEBSITE" "1" "2021-01-10" "\ \&" "\ \&"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -87,7 +87,7 @@ Show colored output (Default: true)
 .sp
 \fB\-x\fP, \fB\-\-html5\-validator\fP \fIVALIDATOR\fP
 .RS 4
-Change default html5 validator engine (ex: tidy or nu)
+Change default html5 validator engine (tidy/nu/nokogumbo)
 .RE
 .sp
 \fB\-5\fP, \fB\-\-html5\-validator\-service\-url\fP \fIURL\fP

data/test/core_test.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require File.expand_path('test_helper', __dir__)
 
 describe ValidateWebsite::Core do
   describe 'invalid options' do
     it 'raise ArgumentError on wrong validation_type' do
-      proc { ValidateWebsite::Core.new({ color: false }, :fail) }
+      _(proc { ValidateWebsite::Core.new({ color: false }, :fail) })
         .must_raise ArgumentError
     end
   end

data/test/crawler_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path('test_helper', __dir__)
 
 # rubocop:disable Metrics/BlockLength
@@ -21,7 +23,7 @@ describe ValidateWebsite::Crawl do
       _out, _err = capture_io do
         v = ValidateWebsite::Crawl.new(site: TEST_DOMAIN, user_agent: ua)
         v.crawl
-        v.crawler.user_agent.must_equal ua
+        _(v.crawler.user_agent).must_equal ua
       end
     end
 
@@ -31,7 +33,7 @@ describe ValidateWebsite::Crawl do
       _out, _err = capture_io do
         ValidateWebsite::Crawl.new(site: TEST_DOMAIN,
                                    html5_validator_service_url: new)
-        validator.html5_validator_service_url.must_equal new
+        _(validator.html5_validator_service_url).must_equal new
         validator.html5_validator_service_url = original
       end
     end
@@ -43,7 +45,8 @@ describe ValidateWebsite::Crawl do
       _out, _err = capture_io do
         v = ValidateWebsite::Crawl.new(site: TEST_DOMAIN, cookies: cookies)
         v.crawl
-        v.crawler.cookies.cookies_for_host(v.host).must_equal v.default_cookies
+        _(v.crawler.cookies.cookies_for_host(v.host))
+          .must_equal v.default_cookies
       end
     end
   end
@@ -53,37 +56,53 @@ describe ValidateWebsite::Crawl do
       name = 'xhtml1-strict'
       file = File.join('test', 'data', "#{name}.html")
       page = FakePage.new(name,
-                          body: open(file).read,
+                          body: File.open(file).read,
                           content_type: 'text/html')
       @validate_website.site = page.url
       _out, _err = capture_io do
         @validate_website.crawl
       end
-      @validate_website.history_count.must_equal 5
+      _(@validate_website.history_count).must_equal 5
     end
 
     it 'extract link' do
       name = 'html4-strict'
       file = File.join('test', 'data', "#{name}.html")
       page = FakePage.new(name,
-                          body: open(file).read,
+                          body: File.open(file).read,
                           content_type: 'text/html')
       @validate_website.site = page.url
       _out, _err = capture_io do
         @validate_website.crawl
       end
-      @validate_website.history_count.must_equal 98
+      _(@validate_website.history_count).must_equal 98
+    end
+
+    it 'can change validator' do
+      name = 'html5-fail'
+      file = File.join('test', 'data', "#{name}.html")
+      page = FakePage.new(name,
+                          body: File.open(file).read,
+                          content_type: 'text/html')
+      validator_res = File.join('test', 'data', 'validator.nu-failure.json')
+      stub_request(:any, /#{validator.html5_validator_service_url}/)
+        .to_return(body: File.open(validator_res).read)
+      @validate_website.site = page.url
+      _out, _err = capture_io do
+        @validate_website.crawl(html5_validator: :nu, ignore: /Warning/)
+      end
+      _(@validate_website.errors_count).must_equal 1
     end
 
     it 'crawl when URLs are not ascii only' do
       name = 'cozy-community'
       file = File.join('test', 'data', "#{name}.html")
       page = FakePage.new(name,
-                          body: open(file).read,
+                          body: File.open(file).read,
                           content_type: 'text/html')
       validator_res = File.join('test', 'data', 'validator.nu-failure.json')
       stub_request(:any, /#{validator.html5_validator_service_url}/)
-        .to_return(body: open(validator_res).read)
+        .to_return(body: File.open(validator_res).read)
       @validate_website.site = page.url
       _out, _err = capture_io do
         @validate_website.crawl
@@ -119,7 +138,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.history_count.must_equal 5
+        _(@validate_website.history_count).must_equal 5
       end
 
       it 'should extract url with single quote' do
@@ -130,7 +149,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.history_count.must_equal 2
+        _(@validate_website.history_count).must_equal 2
       end
 
       it 'should extract url with double quote' do
@@ -141,7 +160,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.history_count.must_equal 2
+        _(@validate_website.history_count).must_equal 2
       end
 
       it 'should extract url with params' do
@@ -152,7 +171,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.history_count.must_equal 2
+        _(@validate_website.history_count).must_equal 2
       end
 
       it 'should not extract invalid urls' do
@@ -163,7 +182,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.history_count.must_equal 1
+        _(@validate_website.history_count).must_equal 1
       end
     end
 
@@ -182,7 +201,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.errors_count.must_equal 1
+        _(@validate_website.errors_count).must_equal 1
       end
 
       it 'should be invalid with syntax error' do
@@ -193,7 +212,7 @@ describe ValidateWebsite::Crawl do
         _out, _err = capture_io do
           @validate_website.crawl
         end
-        @validate_website.errors_count.must_equal 1
+        _(@validate_website.errors_count).must_equal 1
       end
     end
   end

data/test/data/html5-fail.html

@@ -118,333 +118,6 @@
       </div>
     </div>
 
-  <script type="text/javascript">
-    include = function() {
-
-  // save references to save a few bytes
-  var args = arguments;
-  var doc = document;
-
-  var toLoad = args.length; // load this many scripts
-  var lastArgument = args[toLoad - 1];
-  var hasCallback = lastArgument.call; // is the last arg a callback?
-  if (hasCallback) {
-    toLoad--;
-  }
-
-  function onScriptLoaded() {
-    var readyState = this.readyState; // we test for "complete" or "loaded" if on IE
-    if (!readyState || /ded|te/.test(readyState)) {
-      toLoad--;
-      if (!toLoad && hasCallback) {
-        lastArgument();
-      }
-    }
-  }
-
-  for (var i = 0; i < toLoad; i++) {
-
-    var script = doc.createElement('script');
-    script.src = arguments[i];
-    script.async = true;
-    script.onload = script.onerror = script.onreadystatechange = onScriptLoaded;
-    (
-     doc.head ||
-     doc.getElementsByTagName('head')[0]
-    ).appendChild(script);
-
-  }
-
-};
-
-
-    include("https://cdn.jsdelivr.net/ace/1.1.3/noconflict/ace.js", function () {
-      include("https://cdn.jsdelivr.net/ace/1.1.3/noconflict/mode-rust.js", function () {
-        (function () {
-  "use strict";
-  // ECMAScript 6 Backwards compatability
-  if (typeof String.prototype.startsWith !== 'function') {
-    String.prototype.startsWith = function(str) {
-      return this.slice(0, str.length) === str;
-    };
-  }
-
-  // Regex for finding new lines
-  var newLineRegex = /(?:\r\n|\r|\n)/g;
-
-  // Fetching DOM items
-  var activeCode = document.getElementById("active-code");
-  var editorDiv = document.getElementById("editor");
-  var staticCode = document.getElementById("static-code");
-  var runButton = document.getElementById("run-code");
-  var resultDiv = document.getElementById("result");
-  var playLink = document.getElementById("playlink");
-
-  // Background colors for program result on success/error
-  var successColor = "#E2EEF6";
-  var errorColor = "#F6E2E2";
-  var warningColor = "#FFFBCB";
-
-  // Message to show when the program is running
-  var runningMsg = resultDiv.getAttribute("data-msg-running") || "Running...";
-
-  // Error message to return when there's a server failure
-  var errMsg = "The server encountered an error while running the program.";
-
-  // Stores ACE editor markers (highights) for errors
-  var markers = [];
-
-  // Status codes, because there are no enums in Javascript
-  var SUCCESS = 0;
-  var ERROR = 1;
-  var WARNING = 2;
-
-  // JS exists, display ACE editor
-  staticCode.style.display = "none";
-  activeCode.style.display = "block";
-
-  // Setting up ace editor
-  var editor = ace.edit("editor");
-  var Range = ace.require('ace/range').Range;
-  editor.setTheme("ace/theme/chrome");
-  editor.getSession().setMode("ace/mode/rust");
-  editor.setShowPrintMargin(false);
-  editor.renderer.setShowGutter(false);
-  editor.setHighlightActiveLine(false);
-
-  // Changes the height of the editor to match its contents
-  function updateEditorHeight() {
-    // https://stackoverflow.com/questions/11584061/
-    var newHeight = editor.getSession().getScreenLength()
-      * editor.renderer.lineHeight
-      + editor.renderer.scrollBar.getWidth();
-
-    editorDiv.style.height = Math.ceil(newHeight).toString() + "px";
-    editor.resize();
-  }
-
-  // Set initial size to match initial content
-  updateEditorHeight();
-
-  // Safely remove all content from the result div
-  function clearResultDiv() {
-    // Clearing the result div will break our reference to
-    // the playlink icon, so let's save it if it exists
-    var newPlayLink = document.getElementById("playlink");
-    if (newPlayLink) {
-      playLink = resultDiv.removeChild(newPlayLink);
-    }
-    resultDiv.innerHTML = "";
-  }
-
-  function escapeHTML(unsafe) {
-    return unsafe
-      .replace(/&/g, "&amp;")
-      .replace(/</g, "&lt;")
-      .replace(/>/g, "&gt;")
-      .replace(/"/g, "&quot;")
-      .replace(/'/g, "&#039;")
-      .replace(newLineRegex, '<br />');
-  }
-
-  // Dispatches a XMLHttpRequest to the Rust playpen, running the program, and
-  // issues a callback to `callback` with the result (or null on error)
-  function runProgram(program, callback) {
-    var req = new XMLHttpRequest();
-    var data = JSON.stringify({
-      version: "beta",
-      optimize: "0",
-      code: program
-    });
-
-    req.timeout = 6000;
-
-    // console.log("Sending", data);
-    req.open('POST', "https://play.rust-lang.org/evaluate.json", true);
-    req.onload = function(e) {
-      var statusCode = false;
-      var result = null;
-
-      if (req.readyState === 4 && req.status === 200) {
-        result = JSON.parse(req.response);
-
-        // handle application errors from playpen
-        if (typeof result['error'] === 'string') {
-          statusCode = ERROR;
-          result = 'Playpen Error: ' + result['error'];
-        } else if (typeof result['result'] === 'string') {
-          statusCode = SUCCESS;
-          result = result['result'];
-
-          // handle rustc errors/warnings
-          // Need server support to get an accurate version of this.
-          if (result.indexOf("error:") !== -1) {
-            statusCode = ERROR;
-          } else if (result.indexOf("warning:") !== -1) {
-            statusCode = WARNING;
-          }
-        }
-      }
-
-      callback(statusCode, result);
-    };
-
-    req.onerror = function(e) {
-      callback(false, null);
-    };
-
-    req.ontimeout = function(e) {
-      var statusCode = ERROR;
-      var result = "play.rust-lang.org not responding, please check back later";
-
-      callback(statusCode, result);
-    }
-
-    req.setRequestHeader("Content-Type", "application/json");
-    req.send(data);
-  }
-
-  // The callback to runProgram
-  function handleResult(statusCode, message) {
-    // Dispatch depending on result type
-    if (result == null) {
-      clearResultDiv();
-      resultDiv.style.backgroundColor = errorColor;
-      resultDiv.innerHTML = errMsg;
-    } else if (statusCode === SUCCESS) {
-      handleSuccess(message);
-    } else if (statusCode === WARNING) {
-      handleWarning(message);
-    } else {
-      handleError(message);
-    }
-  }
-
-  // Called on successful program run: display output and playground icon
-  function handleSuccess(message) {
-    resultDiv.style.backgroundColor = successColor;
-    displayOutput(escapeHTML(message), editor.getValue());
-  }
-
-  // Called when program run results in warning(s)
-  function handleWarning(message) {
-    resultDiv.style.backgroundColor = warningColor;
-    handleProblem(message, "warning");
-  }
-
-  // Called when program run results in error(s)
-  function handleError(message) {
-    resultDiv.style.backgroundColor = errorColor;
-    handleProblem(message, "error");
-  }
-
-  // Called on unsuccessful program run. Detects and prints problems (either
-  // warnings or errors) in program output and highlights relevant lines and text
-  // in the code.
-  function handleProblem(message, problem) {
-    // Getting list of ranges with problems
-    var lines = message.split(newLineRegex);
-
-    // Cleaning up the message: keeps only relevant problem output.
-    var cleanMessage = lines.filter(function(line) {
-      return !line.trim().startsWith("--> <anon>")
-        && !line.startsWith("playpen:")
-        && !line.trim().startsWith("error: aborting");
-    }).map(function(line) {
-      return escapeHTML(line);
-    }).filter(function(line) {
-      return line != "";
-    }).map(function(line) {
-      return line.replace(/  /g, '\u00a0\u00a0');
-    }).join("<br />");
-
-    // Get all of the row:col in the message.
-    var errorLines = lines.filter(function(line) {
-      return line.indexOf("--> <anon>") !== -1;
-    }).map(function(line) {
-      var lineIndex = line.indexOf(":");
-      if (lineIndex !== -1) {
-        return line.slice(lineIndex);
-      }
-
-      return "";
-    }).filter(function(line) {
-      return line != "";
-    });
-
-    // Setting message
-    displayOutput(cleanMessage, editor.getValue());
-
-    // Highlighting the lines
-    var ranges = parseProblems(errorLines);
-    markers = ranges.map(function(range) {
-      return editor.getSession().addMarker(range, "ace-" + problem + "-line",
-        "fullLine", false);
-    });
-
-    // Highlighting the specific text
-    markers = markers.concat(ranges.map(function(range) {
-      return editor.getSession().addMarker(range, "ace-" + problem + "-text",
-        "text", false);
-    }));
-  }
-
-  // Parses a problem message returning a list of ranges (row:col, row:col) where
-  // problems in the code have occured.
-  function parseProblems(lines) {
-    var ranges = [];
-    for (var i in lines) {
-      var line = lines[i];
-      var parts = line.split(/:\s?|\s+/, 5).slice(1, 5);
-      var ip = parts.map(function(p) { return parseInt(p, 10) - 1; });
-      console.log("line:", line, parts, ip);
-      ranges.push(new Range(ip[0], ip[1], ip[2], ip[3]));
-    }
-
-    return ranges;
-  }
-
-  // Registering handler for run button click
-  runButton.addEventListener("click", function(ev) {
-    resultDiv.style.display = "block";
-    clearResultDiv();
-    resultDiv.innerHTML = runningMsg;
-
-    // clear previous markers, if any
-    markers.map(function(id) { editor.getSession().removeMarker(id); });
-
-    // Get the code, run the program
-    var program = editor.getValue();
-    runProgram(program, handleResult);
-  });
-
-  // Display an output message and a link to the Rust playground
-  function displayOutput(message, program) {
-    var programUrl = "https://play.rust-lang.org/?code=" +
-        encodeURIComponent(program) + "&run=1";
-    playLink.href = programUrl;
-
-    clearResultDiv();                // clear resultDiv, then add
-    resultDiv.appendChild(playLink); // playLink icon and message
-    resultDiv.innerHTML += message;
-  }
-
-  // Highlight active line when focused
-  editor.on('focus', function() {
-    editor.setHighlightActiveLine(true);
-  });
-
-  // Don't when not
-  editor.on('blur', function() {
-    editor.setHighlightActiveLine(false);
-  });
-}());
-
-      });
-    });
-  </script>
-
-
     <footer>
       <p>Our site in other languages:
         <a href="/en-US/">English</a>,
@@ -462,15 +135,5 @@
       </p>
     </footer>
 
-    <script>
-      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
-      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
-      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
-      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
-      ga('create', 'UA-58390457-1', 'auto');
-      ga('send', 'pageview');
-
-    </script>
   </body>
 </html>