Add --ignore-empty-alt

README.md

@@ -138,6 +138,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | Option | Description | Default |
 | :----- | :---------- | :------ |
 | `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
+| `empty_alt_ignore` | If `true`, ignores images with empty alt tags. | `false` |
 | `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` |
 |`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]`
 | `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |

bin/htmlproof

@@ -24,6 +24,7 @@ Mercenary.program(:htmlproof) do |p|
 
   p.option 'as_links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
   p.option 'alt_ignore', '--alt-ignore image1,[image2,...]', Array, 'Comma-separated list of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore'
+  p.option 'empty_alt_ignore', '--empty-alt-ignore', 'Ignores images with empty alt tags.'
   p.option 'checks_to_ignore', '--checks-to-ignore check1,[check2,...]', Array, ' An array of Strings indicating which checks you\'d like to not perform.'
   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.option 'directory_index_file', '--directory-index-file', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)'

lib/html/proofer.rb

@@ -41,6 +41,7 @@ def initialize(src, opts = {})
         :file_ignore => [],
         :check_external_hash => false,
         :alt_ignore => [],
+        :empty_alt_ignore => false,
         :disable_external => false,
         :verbose => false,
         :only_4xx => false,

lib/html/proofer/check_runner.rb

@@ -6,7 +6,7 @@ class Proofer
     class CheckRunner
 
       attr_reader :issues, :src, :path, :options, :typhoeus_opts, :hydra_opts, :parallel_opts, \
-                  :external_urls, :href_ignores, :alt_ignores
+                  :external_urls, :href_ignores, :alt_ignores, :empty_alt_ignore
 
       def initialize(src, path, html, options, typhoeus_opts, hydra_opts, parallel_opts)
         @src    = src
@@ -19,6 +19,7 @@ def initialize(src, path, html, options, typhoeus_opts, hydra_opts, parallel_opt
         @issues = []
         @href_ignores = @options[:href_ignore]
         @alt_ignores = @options[:alt_ignore]
+        @empty_alt_ignore = @options[:empty_alt_ignore]
         @external_urls = {}
       end
 

lib/html/proofer/checkable.rb

@@ -77,6 +77,10 @@ def ignore?
         end
       end
 
+      def ignore_empty_alt?
+        @check.empty_alt_ignore
+      end
+
       # path is external to the file
       def external?
         !internal?

lib/html/proofer/checks/images.rb

@@ -4,8 +4,12 @@ class ImageCheckable < ::HTML::Proofer::Checkable
 
   SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/
 
-  def valid_alt_tag?
-    @alt && !@alt.strip.empty?
+  def alt
+    @alt
+  end
+
+  def empty_alt_tag?
+    alt.strip.empty?
   end
 
   def terrible_filename?
@@ -43,8 +47,9 @@ def run
         end
       end
 
-      # check alt tag
-      add_issue("image #{img.src} does not have an alt attribute", i.line) unless img.valid_alt_tag?
+      if img.alt.nil? || (img.empty_alt_tag? && !img.ignore_empty_alt?)
+        add_issue("image #{img.src} does not have an alt attribute", i.line)
+      end
     end
 
     external_urls

spec/html/proofer/command_spec.rb

@@ -79,4 +79,10 @@
     output = make_bin('--check-html', broken)
     expect(output).to match('1 failure')
   end
+
+  it 'works with empty-alt-ignore' do
+    broken = "#{FIXTURES_DIR}/html/emptyImageAltText.html"
+    output = make_bin('--empty-alt-ignore', broken)
+    expect(output).to match('successfully')
+  end
 end

spec/html/proofer/fixtures/images/emptyImageAltText.html

@@ -3,7 +3,8 @@
 <body>
 
 	<p>Blah blah blah. <img src="./gpl.png" alt=""/> </p>
-  	<p>Blah blah blah. <img src="./gpl.png" alt="   "/> </p>
+	<p>Blah blah blah. <img src="./gpl.png" alt="   "/> </p>
+	<p>Blah blah blah. <img src="./gpl.png" alt/> </p>
 </body>
 
 </html>

spec/html/proofer/images_spec.rb

@@ -23,7 +23,7 @@
     emptyAltFilepath = "#{FIXTURES_DIR}/images/emptyImageAltText.html"
     proofer = run_proofer(emptyAltFilepath)
     expect(proofer.failed_tests.first).to match(/gpl.png does not have an alt attribute/)
-    expect(proofer.failed_tests.length).to equal(2)
+    expect(proofer.failed_tests.length).to equal(3)
   end
 
   it 'passes when ignoring image with nothing but spaces in alt attribute' do
@@ -109,6 +109,18 @@
     expect(proofer.failed_tests.first).to_not match /does not have an alt attribute/
   end
 
+  it 'properly ignores empty alt attribute when empty_alt_ignore set' do
+    missingAltFilepath = "#{FIXTURES_DIR}/images/emptyImageAltText.html"
+    proofer = run_proofer(missingAltFilepath, {:empty_alt_ignore => true})
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it 'properly ignores empty alt attributes, but not missing alt attributes, when empty_alt_ignore set' do
+    missingAltFilepath = "#{FIXTURES_DIR}/images/missingImageAlt.html"
+    proofer = run_proofer(missingAltFilepath, {:empty_alt_ignore => true})
+    expect(proofer.failed_tests.first).to match(/gpl.png does not have an alt attribute/)
+  end
+
   it 'works for images with a srcset' do
     srcSetCheck = "#{FIXTURES_DIR}/images/srcSetCheck.html"
     proofer = run_proofer(srcSetCheck)