html-proofer 1.6.0 → 2.0.0

data/spec/html/proofer/html_spec.rb

@@ -1,51 +1,51 @@
-require "spec_helper"
+require 'spec_helper'
 
-describe "Html test" do
-  it "ignores an invalid tag by default" do
+describe 'Html test' do
+  it 'ignores an invalid tag by default' do
     html = "#{FIXTURES_DIR}/html/invalid_tag.html"
-    output = capture_stderr { HTML::Proofer.new(html).run }
-    expect(output).to eq ""
+    proofer = run_proofer(html)
+    expect(proofer.failed_tests).to eq []
   end
 
   it "doesn't fail for html5 tags" do
     html = "#{FIXTURES_DIR}/html/html5_tags.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to eq ""
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests).to eq []
   end
 
-  it "fails for an invalid tag" do
+  it 'fails for an invalid tag' do
     html = "#{FIXTURES_DIR}/html/invalid_tag.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /Tag myfancytag invalid/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.first).to match(/Tag myfancytag invalid/)
   end
 
-  it "fails for an unmatched end tag" do
+  it 'fails for an unmatched end tag' do
     html = "#{FIXTURES_DIR}/html/unmatched_end_tag.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /Unexpected end tag : div/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.first).to match(/Unexpected end tag : div/)
   end
 
-  it "fails for an unescaped ampersand in attribute" do
+  it 'fails for an unescaped ampersand in attribute' do
     html = "#{FIXTURES_DIR}/html/unescaped_ampersand_in_attribute.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /htmlParseEntityRef: expecting ';'/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.first).to match(/htmlParseEntityRef: expecting ';'/)
   end
 
-  it "fails for mismatch between opening and ending tag" do
+  it 'fails for mismatch between opening and ending tag' do
     html = "#{FIXTURES_DIR}/html/opening_and_ending_tag_mismatch.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /Opening and ending tag mismatch: p and strong/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.first).to match(/Opening and ending tag mismatch: p and strong/)
   end
 
-  it "fails for div inside head" do
+  it 'fails for div inside head' do
     html = "#{FIXTURES_DIR}/html/div_inside_head.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /Unexpected end tag : head/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.first).to match(/Unexpected end tag : head/)
   end
 
-  it "fails for missing closing quotation mark in href" do
+  it 'fails for missing closing quotation mark in href' do
     html = "#{FIXTURES_DIR}/html/missing_closing_quotes.html"
-    output = capture_stderr { HTML::Proofer.new(html, {:validate_html => true}).run }
-    expect(output).to match /Couldn't find end of Start Tag a/
+    proofer = run_proofer(html, { :check_html => true })
+    expect(proofer.failed_tests.to_s).to match(/Couldn't find end of Start Tag a/)
   end
 end

data/spec/html/proofer/images_spec.rb

@@ -1,98 +1,122 @@
-require "spec_helper"
+require 'spec_helper'
 
-describe "Images test" do
-  it "passes for existing external images" do
+describe 'Images test' do
+  it 'passes for existing external images' do
     externalImageFilepath = "#{FIXTURES_DIR}/images/existingImageExternal.html"
-    proofer = make_proofer(externalImageFilepath)
+    proofer = run_proofer(externalImageFilepath)
     expect(proofer.failed_tests).to eq []
   end
 
-  it "fails for image without alt attribute" do
+  it 'fails for image without alt attribute' do
     missingAltFilepath = "#{FIXTURES_DIR}/images/missingImageAlt.html"
-    proofer = make_proofer(missingAltFilepath)
-    expect(proofer.failed_tests.first).to match /gpl.png does not have an alt attribute/
+    proofer = run_proofer(missingAltFilepath)
+    expect(proofer.failed_tests.first).to match(/gpl.png does not have an alt attribute/)
   end
 
-  it "fails for image with an empty alt attribute" do
+  it 'fails for image with an empty alt attribute' do
     missingAltFilepath = "#{FIXTURES_DIR}/images/missingImageAltText.html"
-    proofer = make_proofer(missingAltFilepath)
-    expect(proofer.failed_tests.first).to match /gpl.png does not have an alt attribute/
+    proofer = run_proofer(missingAltFilepath)
+    expect(proofer.failed_tests.first).to match(/gpl.png does not have an alt attribute/)
   end
 
-  it "fails for missing external images" do
+  it 'fails for missing external images' do
     externalImageFilepath = "#{FIXTURES_DIR}/images/missingImageExternal.html"
-    proofer = make_proofer(externalImageFilepath)
-    expect(proofer.failed_tests.first).to match /External link http:\/\/www.whatthehell\/? failed: 0 Couldn't resolve host/
+    proofer = run_proofer(externalImageFilepath)
+    expect(proofer.failed_tests.first).to match(/failed: 0 Couldn't resolve host/)
   end
 
-  it "fails for missing internal images" do
+  it 'fails for missing internal images' do
     internalImageFilepath = "#{FIXTURES_DIR}/images/missingImageInternal.html"
-    proofer = make_proofer(internalImageFilepath)
-    expect(proofer.failed_tests.first).to match /doesnotexist.png does not exist/
+    proofer = run_proofer(internalImageFilepath)
+    expect(proofer.failed_tests.first).to match(/doesnotexist.png does not exist/)
   end
 
-  it "fails for image with no src" do
+  it 'fails for image with no src' do
     imageSrcFilepath = "#{FIXTURES_DIR}/images/missingImageSrc.html"
-    proofer = make_proofer(imageSrcFilepath)
-    expect(proofer.failed_tests.first).to match /image has no src attribute/
+    proofer = run_proofer(imageSrcFilepath)
+    expect(proofer.failed_tests.first).to match(/image has no src or srcset attribute/)
   end
 
-  it "fails for image with default mac filename" do
+  it 'fails for image with default mac filename' do
     terribleImageName = "#{FIXTURES_DIR}/images/terribleImageName.html"
-    proofer = make_proofer(terribleImageName)
-    expect(proofer.failed_tests.first).to match /image has a terrible filename/
+    proofer = run_proofer(terribleImageName)
+    expect(proofer.failed_tests.first).to match(/image has a terrible filename/)
   end
 
   it 'ignores images marked as ignore data-proofer-ignore' do
     ignorableImages = "#{FIXTURES_DIR}/images/ignorableImages.html"
-    proofer = make_proofer(ignorableImages)
+    proofer = run_proofer(ignorableImages)
     expect(proofer.failed_tests).to eq []
   end
 
   it 'properly checks relative images' do
     relativeImages = "#{FIXTURES_DIR}/images/rootRelativeImages.html"
-    proofer = make_proofer(relativeImages)
+    proofer = run_proofer(relativeImages)
     expect(proofer.failed_tests).to eq []
 
     relativeImages = "#{FIXTURES_DIR}/resources/books/nestedRelativeImages.html"
-    proofer = make_proofer(relativeImages)
+    proofer = run_proofer(relativeImages)
     expect(proofer.failed_tests).to eq []
   end
 
   it 'properly ignores data URI images' do
     dataURIImage = "#{FIXTURES_DIR}/images/workingDataURIImage.html"
-    proofer = make_proofer(dataURIImage)
+    proofer = run_proofer(dataURIImage)
     expect(proofer.failed_tests).to eq []
   end
 
-  it "works for valid images missing the protocol" do
+  it 'works for valid images missing the protocol' do
     missingProtocolLink = "#{FIXTURES_DIR}/images/image_missing_protocol_valid.html"
-    proofer = make_proofer(missingProtocolLink)
+    proofer = run_proofer(missingProtocolLink)
     expect(proofer.failed_tests).to eq []
   end
 
-  it "fails for invalid images missing the protocol" do
+  it 'fails for invalid images missing the protocol' do
     missingProtocolLink = "#{FIXTURES_DIR}/images/image_missing_protocol_invalid.html"
-    proofer = make_proofer(missingProtocolLink)
-    expect(proofer.failed_tests.first).to match /404 No error/
+    proofer = run_proofer(missingProtocolLink)
+    expect(proofer.failed_tests.first).to match(/404 No error/)
   end
 
   it 'properly checks relative links' do
     relativeLinks = "#{FIXTURES_DIR}/images/relativeToSelf.html"
-    proofer = make_proofer(relativeLinks)
+    proofer = run_proofer(relativeLinks)
     expect(proofer.failed_tests).to eq []
   end
 
   it 'properly ignores missing alt tags when asked' do
     ignorableLinks = "#{FIXTURES_DIR}/images/ignorableAltViaOptions.html"
-    proofer = make_proofer(ignorableLinks, {:alt_ignore => [/wikimedia/, "gpl.png"]})
+    proofer = run_proofer(ignorableLinks, {:alt_ignore => [/wikimedia/, "gpl.png"]})
     expect(proofer.failed_tests).to eq []
   end
 
   it 'properly ignores missing alt tags, but not all URLs, when asked' do
     ignorableLinks = "#{FIXTURES_DIR}/images/ignoreAltButNotLink.html"
-    proofer = make_proofer(ignorableLinks, {:alt_ignore => [/.*/]})
-    expect(proofer.failed_tests.first).to match /Couldn't resolve host name/
+    proofer = run_proofer(ignorableLinks, {:alt_ignore => [/.*/]})
+    expect(proofer.failed_tests.first).to match(/Couldn't resolve host name/)
     expect(proofer.failed_tests.first).to_not match /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)
+    expect(proofer.failed_tests).to eq []
+  end
+
+  it 'fails for images with a srcset but missing alt' do
+    srcSetMissingAlt = "#{FIXTURES_DIR}/images/srcSetMissingAlt.html"
+    proofer = run_proofer(srcSetMissingAlt)
+    expect(proofer.failed_tests.first).to match(/image gpl.png does not have an alt attribute/)
+  end
+
+  it 'fails for images with an alt but missing src or srcset' do
+    srcSetMissingAlt = "#{FIXTURES_DIR}/images/srcSetMissingImage.html"
+    proofer = run_proofer(srcSetMissingAlt)
+    expect(proofer.failed_tests.first).to match(/internal image notreal.png does not exist/)
+  end
+
+  it 'properly ignores missing alt tags when asked for srcset' do
+    ignorableLinks = "#{FIXTURES_DIR}/images/srcSetIgnorable.html"
+    proofer = run_proofer(ignorableLinks, {:alt_ignore => [/wikimedia/, "gpl.png"]})
+    expect(proofer.failed_tests).to eq []
+  end
 end