Merge pull request #851 from paulroub/srcset-sizes-fail

Handle multiple srcsets when first is remote (fixes #850)

Author: gjtorikian

.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   rubocop-standard:
     - config/default.yml
 
-require:
+plugins:
   - rubocop-rspec
 
 Naming/FileName:
@@ -14,8 +14,11 @@ RSpec/AnyInstance:
 RSpec/ExampleLength:
   Enabled: false
 
-RSpec/FilePath:
-  Enabled: false
+# RSpec/SpecFilePathFormat:
+#   Enabled: false
+
+# RSpec/SpecFilePathSuffix:
+#   Enabled: false
 
 RSpec/MultipleExpectations:
   Enabled: false

lib/html_proofer/attribute/url.rb

@@ -238,7 +238,7 @@ def without_hash
         else
           url
         end
-      rescue Addressable::URI::InvalidURIError # rubocop:disable Lint/SuppressedException; error will be reported at check time
+      rescue Addressable::URI::InvalidURIError # rubocop:disable Lint/SuppressedException -- error will be reported at check time
       end
 
       private def swap_urls!

lib/html_proofer/check/images.rb

@@ -20,18 +20,6 @@ def run
           # does the image exist?
           if missing_src?
             add_failure("image has no src or srcset attribute", element: @img)
-          elsif @img.url.protocol_relative?
-            add_failure(
-              "image link #{@img.url} is a protocol-relative URL, use explicit https:// instead",
-              element: @img,
-            )
-          elsif @img.url.remote?
-            add_to_external_urls(@img.url, @img.line)
-          elsif !@img.url.exists? && !@img.multiple_srcsets? && !@img.multiple_sizes?
-            add_failure(
-              "internal image #{@img.url.raw_attribute} does not exist",
-              element: @img,
-            )
           elsif @img.multiple_srcsets? || @img.multiple_sizes?
             @img.srcsets_wo_sizes.each do |srcset|
               srcset_url = HTMLProofer::Attribute::Url.new(@runner, srcset, base_url: @img.base_url, source: @img.url.source, filename: @img.url.filename, extract_size: true)
@@ -47,6 +35,18 @@ def run
                 add_failure("internal image #{srcset} does not exist", element: @img)
               end
             end
+          elsif @img.url.protocol_relative?
+            add_failure(
+              "image link #{@img.url} is a protocol-relative URL, use explicit https:// instead",
+              element: @img,
+            )
+          elsif @img.url.remote?
+            add_to_external_urls(@img.url, @img.line)
+          elsif !@img.url.exists? && !@img.multiple_srcsets? && !@img.multiple_sizes?
+            add_failure(
+              "internal image #{@img.url.raw_attribute} does not exist",
+              element: @img,
+            )
           end
 
           # if this is an img element, check that the alt attribute is present

lib/html_proofer/log.rb

@@ -13,7 +13,7 @@ class Log
     def initialize(log_level)
       @logger = Yell.new(
         format: false,
-        name: "HTMLProofer", \
+        name: "HTMLProofer",
         level: "gte.#{log_level}",
       ) do |l|
         l.adapter(:stdout, level: "lte.warn")

lib/html_proofer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  VERSION = "5.0.9"
+  VERSION = "5.0.10"
 end

spec/html-proofer/cache_spec.rb

@@ -526,7 +526,7 @@ def read_cache(cache_filename)
           external_link = cache["external"]["https://github.com/gjtorikian/html-proofer"]
           expect(external_link["found"]).to(equal(true))
           expect(external_link["status_code"]).to(equal(200))
-          expect(external_link["message"]).equal?("OK")
+          expect(external_link["message"]).to(match("OK"))
 
           File.delete(cache_filepath)
         end

spec/html-proofer/check/images_spec.rb

@@ -278,6 +278,12 @@
     expect(proofer.failed_checks).to(eq([]))
   end
 
+  it "works for picture elements with multiple remote sizes" do
+    custom_data_src_check = "#{FIXTURES_DIR}/images/srcset_picture_remote_sizes.html"
+    proofer = run_proofer(custom_data_src_check, :file)
+    expect(proofer.failed_checks).to(eq([]))
+  end
+
   it "breaks for picture elements with multiple srcsets and pixel densities" do
     custom_data_src_check = "#{FIXTURES_DIR}/images/srcset_picture_pixel-density_broken.html"
     proofer = run_proofer(custom_data_src_check, :file)

spec/html-proofer/cli_spec.rb

@@ -216,7 +216,7 @@
     it "has only one UA" do
       http = make_bin(%|--typhoeus='{"verbose":true,"headers":{"User-Agent":"Mozilla/5.0 (Macintosh; My New User-Agent)"}}' --as-links https://linkedin.com|)
       expect(http.scan("User-Agent: Typhoeus").count).to(eq(0))
-      expect(http.scan(%r{User-Agent: Mozilla/5.0 \(Macintosh; My New User-Agent\)}i).count).to(eq(2))
+      expect(http.match(%r{User-Agent: Mozilla/5.0 \(Macintosh; My New User-Agent\)}i)).not_to(be_nil)
     end
 
     it "supports hydra" do

spec/html-proofer/fixtures/cache/version_2/.internal_and_external.json

@@ -1 +1 @@
-{"version":2,"internal":{"/somewhere.html":{"time":"2022-01-06 12:00:00 -0700","metadata":[{"source":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","filename":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","line":11,"base_url":"","found":false}]}},"external":{"https://github.com/gjtorikian/html-proofer":{"time":"2022-01-06 12:00:00 -0700","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","line":7}]}}}
+{"version":2,"internal":{"/somewhere.html":{"time":"2022-01-06 12:00:00 -0500","metadata":[{"source":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","filename":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","line":11,"base_url":"","found":false}]}},"external":{"https://github.com/gjtorikian/html-proofer":{"time":"2022-01-06 12:00:00 -0500","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/internal_and_external_example.html","line":7}]}}}

spec/html-proofer/fixtures/cache/version_2/.recheck_external_failure.json

@@ -1 +1 @@
-{"version":2,"internal":{},"external":{"https://github.com/gjtorikian/html-proofer":{"time":"2022-01-06 12:00:00 -0700","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/external_example.html","line":7}]}}}
+{"version":2,"internal":{},"external":{"https://github.com/gjtorikian/html-proofer":{"time":"2022-01-06 12:00:00 -0500","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/external_example.html","line":7}]}}}

spec/html-proofer/fixtures/cache/version_2/.removed_link.json

@@ -1 +1 @@
-{"version":2,"internal":{},"external":{"https://github.com/gjtorikian":{"time":"2022-01-06 12:00:00 -0700","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/some_link.html","line":7}]}}}
+{"version":2,"internal":{},"external":{"https://github.com/gjtorikian":{"time":"2022-01-06 12:00:00 -0500","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/cache/some_link.html","line":7}]}}}

spec/html-proofer/fixtures/cache/version_2/.runner.json

@@ -1 +1 @@
-{"version":2,"internal":{},"external":{"https://www.github.com":{"time":"2022-02-17 12:00:00 -0700","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/links/_site/folder.html/index.html","line":4}]}}}
+{"version":2,"internal":{},"external":{"https://www.github.com":{"time":"2022-02-17 12:00:00 -0500","found":true,"status_code":200,"message":"OK","metadata":[{"filename":"spec/html-proofer/fixtures/links/_site/folder.html/index.html","line":4}]}}}

spec/html-proofer/fixtures/images/srcset_picture_remote_sizes.html

@@ -0,0 +1,12 @@
+<picture>
+    <!--[if IE 9]><video style="display: none;"><![endif]-->
+    <source
+        srcset="
+            https://upload.wikimedia.org/wikipedia/en/thumb/2/22/Heckert_GNU_white.svg/256px-Heckert_GNU_white.svg.png 2x,
+            https://upload.wikimedia.org/wikipedia/en/2/22/Heckert_GNU_white.svg                                       1x
+        "
+        type="image/webp"
+    />
+    <!--[if IE 9]></video><![endif]-->
+    <img srcset="gpl.png" alt="test" />
+</picture>