html-proofer 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edf96e9bdedd63b9b700d52bae4dd93d0b17c393
-  data.tar.gz: bcfcc2e0cf7563cebc1fbd0a7f991e10a83f63ad
+  metadata.gz: 97c22a8fe51597e114e14ddbba652ae985fc5f57
+  data.tar.gz: 1ddb7a315216b45543e7c9c213cb12ba5bfd51c2
 SHA512:
-  metadata.gz: 608cc7ce5c9612b126510d17338b7cd36cc8aa70bcc26c7c4d460ebb5b0ca9c1c2bc6c80e6401dfd2371478bf4149cdcd2d0b40da6348a9853e00f652335bafc
-  data.tar.gz: e592af9119c26b3d9ea83e4fa7ab2d96c49456fbabe4e0e78acc221b135bb997397862ce86d428a3a0c0b07ee7d4f9e53f95d5063155b03f893bb051aa0fa964
+  metadata.gz: 878e34703034b6f5da4ff253966f49c3c0da8b069114ef5884b5f1204c887e80811c7da36153f78ce08a1c6a15fdeb702aa288d7ea3313ee805942479d49e4d8
+  data.tar.gz: 437465770c2958c1e225808afad54758a95d3e962c5d06d22397d8815eadb313d5dc42f04b5ec6329a0a5178f3844029a4918f841203b687c8601cf238d00830

data/README.md

@@ -144,6 +144,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
 | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
 | `validate_html` | Enables HTML validation errors from Nokogiri | `false` |
+| `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` |
 
 ### Configuring Typhoeus
 

data/bin/htmlproof

@@ -21,10 +21,11 @@ Mercenary.program(:htmlproof) do |p|
   p.option 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored.'
   p.option 'alt_ignore', '--alt_ignore image1,[image2,...]', Array, 'Array of Strings containing `img`s whose missing `alt` tags are safe to ignore'
   p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
-  p.option 'only-4xx', '--only-4xx', 'Only reports errors for links that fall within the 4x status code range.'
+  p.option 'only_4xx', '--only_4xx', 'Only reports errors for links that fall within the 4x status code range.'
   p.option 'verbose', '--verbose', 'Enables more verbose logging.'
   p.option 'directory_index_file', '--directory_index_file', 'Sets the file to look for when a link refers to a directory.'
   p.option 'validate_html', '--validate_html', 'Enables HTML validation errors from Nokogiri (default: `false`).'
+  p.option 'check_external_hash', '--check_external_hash', 'Checks whether external hashes exist (even if the website exists). This slows the checker down (default: `false`).'
 
   p.action do |args, opts|
     args = ["."] if args.empty?
@@ -43,10 +44,12 @@ Mercenary.program(:htmlproof) do |p|
     options[:href_ignore] = opts["href_ignore"] unless opts["href_ignore"].nil?
     options[:alt_ignore] = opts["alt_ignore"] unless opts["alt_ignore"].nil?
     options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
+    options[:only_4xx] = opts["only_4xx"] unless opts["only_4xx"].nil?
     options[:favicon] = opts["favicon"] unless opts["favicon"].nil?
     options[:verbose] = opts["verbose"] unless opts["verbose"].nil?
     options[:directory_index_file] = opts["directory_index_file"] unless opts["directory_index_file"].nil?
     options[:validate_html] = opts["validate_html"] unless opts["validate_html"].nil?
+    options[:check_external_hash] = opts["check_external_hash"] unless opts["check_external_hash"].nil?
 
     path = path.delete(' ').split(",") if opts["as-links"]
 

data/lib/html/proofer.rb

@@ -37,6 +37,7 @@ module HTML
         :favicon => false,
         :href_swap => [],
         :href_ignore => [],
+        :check_external_hash => false,
         :alt_ignore => [],
         :disable_external => false,
         :verbose => false,
@@ -184,6 +185,7 @@ module HTML
 
       if response_code.between?(200, 299)
         return if @options[:only_4xx]
+        return unless @options[:check_external_hash]
         if hash = has_hash?(href)
           body_doc = Nokogiri::HTML(response.body)
           # user-content is a special addition by GitHub.

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = "1.5.2"
+    VERSION = "1.5.3"
   end
 end

data/spec/html/proofer/links_spec.rb

@@ -2,19 +2,25 @@ require "spec_helper"
 
 describe "Links test" do
 
-  it "fails for broken external hash (even if the file exists)" do
+  it "fails for broken internal hash (even if the file exists)" do
     brokenHashExternalFilepath = "#{FIXTURES_DIR}/links/brokenHashExternal.html"
     proofer = make_proofer(brokenHashExternalFilepath)
     expect(proofer.failed_tests.last).to match /linking to ..\/images\/missingImageAlt.html#asdfasfdkafl, but asdfasfdkafl does not exist/
   end
 
-  it "fails for broken hashes on the web (even if the file exists)" do
+  it "fails for broken hashes on the web when asked (even if the file exists)" do
     brokenHashOnTheWeb = "#{FIXTURES_DIR}/links/brokenHashOnTheWeb.html"
-    proofer = make_proofer(brokenHashOnTheWeb)
+    proofer = make_proofer(brokenHashOnTheWeb, { :check_external_hash => true} )
     expect(proofer.failed_tests.first).to match /but the hash 'no' does not/
   end
 
-  it "passes for GitHub hashes on the web" do
+  it "passes for broken hashes on the web when ignored (even if the file exists)" do
+    brokenHashOnTheWeb = "#{FIXTURES_DIR}/links/brokenHashOnTheWeb.html"
+    proofer = make_proofer(brokenHashOnTheWeb)
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it "passes for GitHub hashes on the web when asked" do
     githubHash = "#{FIXTURES_DIR}/links/githubHash.html"
     proofer = make_proofer(githubHash)
     expect(proofer.failed_tests).to eq []
@@ -291,7 +297,7 @@ describe "Links test" do
 
   it "does not dupe errors" do
     fixture = "#{FIXTURES_DIR}/links/nodupe.html"
-    proofer = make_proofer(fixture)
+    proofer = make_proofer(fixture, { :check_external_hash => true} )
     expect(proofer.failed_tests.length).to eq 1
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -320,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image