html-proofer 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65952ba4e5dea5147b84fb88dfae41a49d432340
-  data.tar.gz: a127df0cb3040eba53860c640255678baf4df3d3
+  metadata.gz: 0e7b88c5fd839aa05b97b85399326a9db187a340
+  data.tar.gz: e0a0c34a2602aca002797185b7ee488b1a94314d
 SHA512:
-  metadata.gz: 878ed21acbf0ed474580c29bd438dd32e645750480f88e16f675bd579ae3c8fc7b8c216c357caecbfd34944c3cbef3c9b5932fef57ba2f6ce09abbbcc03f23cf
-  data.tar.gz: 740b6aaaa8df3bed83b6194ff27ba85810dbd035e30cb45410fabb2050bcb94ba485e67531cec6c790ad7194523da23c2291796e6797ca192b66dfc805c2123d
+  metadata.gz: 904bc7984ee9ddba79e06833a9e235e26c5d388c7581493f79f210053248d4d7916dfe849c8eac7e5fc75815f5be2dbf9d88b3f043eb1181e95f11241cae698b
+  data.tar.gz: 509fe2ee57606ea93e1c175bafc8bf8ff39891a93c0bfa8c7ea3242f731f184e4a884bb1deea9d2433074f3b816d25542873deed24e7df4a3f421e64d2f106ba

data/README.md

@@ -124,6 +124,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `ext` | The extension of your HTML files including the dot. | `.html` |
 | `favicon` | Enables the favicon checker. | `false` |
 | `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Certain URIs, like `mailto` and `tel`, are always ignored. | `[]` |
+| `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
 | `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. | `{}` |
 | `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
 

data/bin/htmlproof

@@ -17,7 +17,8 @@ Mercenary.program(:htmlproof) do |p|
   p.option 'ext', '--ext EXT', 'The extension of your HTML files (default: `.html`)'
   p.option 'favicon', '--favicon', 'Enables the favicon checker (default: `false`).'
   p.option 'swap', '--swap regex:string,[regex:string,...]', Array, 'Array containing key-value pairs of `RegExp:String`. It transforms links that match `RegExp` into `String`'
-  p.option 'ignore', '--ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore (default: `mailto`)'
+  p.option 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore. Certain URIs, like `mailto` and `tel`, 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 'verbose', '--verbose', 'Enables more verbose logging.'
 
@@ -34,7 +35,8 @@ Mercenary.program(:htmlproof) do |p|
         options[:href_swap][%r{#{pair[0]}}] = pair[1]
       end
     end
-    options[:href_ignore] = opts["ignore"] unless opts["ignore"].nil?
+    options[:href_ignore] = opts["ignore"] unless opts["href_ignore"].nil?
+    options[:alt_ignore] = opts["ignore"] unless opts["alt_ignore"].nil?
     options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
     options[:favicon] = opts["favicon"] unless opts["favicon"].nil?
     options[:verbose] = opts["verbose"] unless opts["verbose"].nil?

data/html-proofer.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "html-proofer"
-  gem.version       = "0.9.0"
+  gem.version       = "1.0.0"
   gem.authors       = ["Garen Torikian"]
   gem.email         = ["gjtorikian@gmail.com"]
   gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}

data/lib/html/proofer.rb

@@ -18,6 +18,7 @@ module HTML
         :favicon => false,
         :href_swap => [],
         :href_ignore => [],
+        :alt_ignore => [],
         :disable_external => false,
         :verbose => false
       }

data/lib/html/proofer/check.rb

@@ -10,7 +10,7 @@ class HTML::Proofer::Checks
 
   class Check
 
-    attr_reader :issues, :src, :path, :options, :external_urls, :additional_href_ignores
+    attr_reader :issues, :src, :path, :options, :external_urls, :additional_href_ignores, :additional_alt_ignores
 
     def initialize(src, path, html, opts={})
       @src    = src
@@ -19,6 +19,7 @@ class HTML::Proofer::Checks
       @options = opts
       @issues = []
       @additional_href_ignores = @options[:href_ignore]
+      @additional_alt_ignores = @options[:alt_ignore]
       @external_urls = {}
     end
 

data/lib/html/proofer/checkable.rb

@@ -62,14 +62,15 @@ module HTML
       end
 
       def ignore?
-        return true if @data_ignore_proofer || @check.additional_href_ignores.include?(url)
-        return true if @type == "image" and url.match(/^data:image/)
-        unless @check.additional_href_ignores.empty?
-          @check.additional_href_ignores.each do |href_ignore|
-            if href_ignore.is_a? String
-              return true if href_ignore == url
-            elsif href_ignore.is_a? Regexp
-              return true if href_ignore =~ url
+        return true if @data_ignore_proofer || @check.additional_href_ignores.include?(url) || @check.additional_alt_ignores.include?(url)
+        return true if (@type == "image" || @type == "favicon") && url.match(/^data:image/)
+
+        [@check.additional_href_ignores, @check.additional_alt_ignores].each do |additional_ignore|
+          additional_ignore.each do |ignore|
+            if ignore.is_a? String
+              return true if ignore == url
+            elsif ignore.is_a? Regexp
+              return true if ignore =~ url
             end
           end
         end

data/spec/html/proofer/fixtures/images/ignorableAltViaOptions.html

@@ -0,0 +1,13 @@
+<html>
+
+<body>
+
+
+<img src="gpl.png"/>Relative to self
+
+
+<p>Blah blah blah. <img src="//upload.wikimedia.org/wikipedia/en/thumb/2/22/Heckert_GNU_white.svg/256px-Heckert_GNU_white.svg.png" /> </p>
+
+</body>
+
+</html>

data/spec/html/proofer/images_spec.rb

@@ -82,4 +82,10 @@ describe "Images test" do
     output = capture_stderr { HTML::Proofer.new(relativeLinks).run }
     output.should == ""
   end
+
+  it 'properly ignores missing alt tags when asked' do
+    ignorableLinks = "#{FIXTURES_DIR}/images/ignorableAltViaOptions.html"
+    output = capture_stderr { HTML::Proofer.new(ignorableLinks, {:alt_ignore => [/wikimedia/, "gpl.png"]}).run }
+    output.should == ""
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Garen Torikian
@@ -169,6 +169,7 @@ files:
 - spec/html/proofer/fixtures/favicon/favicon_present_shortcut.html
 - spec/html/proofer/fixtures/images/existingImageExternal.html
 - spec/html/proofer/fixtures/images/gpl.png
+- spec/html/proofer/fixtures/images/ignorableAltViaOptions.html
 - spec/html/proofer/fixtures/images/ignorableImages.html
 - spec/html/proofer/fixtures/images/image_missing_protocol_invalid.html
 - spec/html/proofer/fixtures/images/image_missing_protocol_valid.html
@@ -268,6 +269,7 @@ test_files:
 - spec/html/proofer/fixtures/favicon/favicon_present_shortcut.html
 - spec/html/proofer/fixtures/images/existingImageExternal.html
 - spec/html/proofer/fixtures/images/gpl.png
+- spec/html/proofer/fixtures/images/ignorableAltViaOptions.html
 - spec/html/proofer/fixtures/images/ignorableImages.html
 - spec/html/proofer/fixtures/images/image_missing_protocol_invalid.html
 - spec/html/proofer/fixtures/images/image_missing_protocol_valid.html