html-proofer 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8afbf9c7f55055c38b77971166e852d6f7180481d1e9fb27f84e071c582d1a7
-  data.tar.gz: 88db5f8e0bb8059ff3f6c50c8fcb4320bf0f6a4e1ef6fc053671591ff44a529f
+  metadata.gz: 98bde6dd5e32f42e5983fd1aaa7bf02d3359b40f2b4a8b5360a5826abf2cc674
+  data.tar.gz: 9b7d57fd18e625ab7cc91c46faceac510b05ba5290f665fb5dd333b92446b00b
 SHA512:
-  metadata.gz: 3f765689616f7884c1a33685dceb08a0786c851839d4ec612023d3ed746ed7c7b7e9087bd91d8360d795fd54a2077fdbf9af9df2c0b25d246a9cc0a064579501
-  data.tar.gz: 441a4f2b13e237505f9402a53fee5713a68d680824e6a976da42f26bfe1f57a0bdf661f6c3cafc45cb0fa28623c56d679c75044b10dd69db64ac824b7d911885
+  metadata.gz: a666be806bbb70028488b3ef89f1325d7b5faaec9f48e105220db2d2f7dd022c12dabac828949ffd2100bdc2b4e3bd4c1f9ce9df48bab17b9106d9453eb49f01
+  data.tar.gz: 8a58bb5b120ab3cf3eb0e692f3f52f4385bd5923d3a7c91e95dddd17d8b0e25d20dd207872099665ac37737afb6b4ed86d04d39bc7793c6af2abcd35390d2051

data/lib/html_proofer/attribute/url.rb

@@ -20,12 +20,13 @@ module HTMLProofer
 
           swap_urls!
           clean_url!
-
-          # convert "//" links to "https://"
-          @url.start_with?("//") ? @url = "https:#{@url}" : @url
         end
       end
 
+      def protocol_relative?
+        url.start_with?("//")
+      end
+
       def to_s
         @url
       end

data/lib/html_proofer/check/favicon.rb

@@ -16,7 +16,10 @@ module HTMLProofer
         return if immediate_redirect?
 
         if found
-          if @favicon.url.remote?
+          if @favicon.url.protocol_relative?
+            add_failure("favicon link #{@favicon.url} is a protocol-relative URL, use explicit https:// instead",
+              line: @favicon.line, content: @favicon.content)
+          elsif @favicon.url.remote?
             add_to_external_urls(@favicon.url, @favicon.line)
           elsif !@favicon.url.exists?
             add_failure("internal favicon #{@favicon.url.raw_attribute} does not exist", line: @favicon.line,

data/lib/html_proofer/check/images.rb

@@ -6,7 +6,7 @@ module HTMLProofer
       SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/.freeze
 
       def run
-        @html.css("img").each do |node|
+        @html.css("img, source").each do |node|
           @img = create_element(node)
 
           next if @img.ignore?
@@ -18,26 +18,22 @@ module HTMLProofer
           # does the image exist?
           if missing_src?
             add_failure("image has no src or srcset attribute", line: @img.line, content: @img.content)
+          elsif @img.url.protocol_relative?
+            add_failure("image link #{@img.url} is a protocol-relative URL, use explicit https:// instead",
+              line: @img.line, content: @img.content)
           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", line: @img.line,
               content: @img.content)
-          elsif @img.multiple_srcsets?
-            @img.srcsets.each do |srcset|
-              srcset_url = HTMLProofer::Attribute::Url.new(@runner, srcset, base_url: @img.base_url, extract_size: true)
-
-              if srcset_url.remote?
-                add_to_external_urls(srcset_url.url, @img.line)
-              elsif !srcset_url.exists?
-                add_failure("internal image #{srcset} does not exist", line: @img.line, content: @img.content)
-              end
-            end
-          elsif @img.multiple_sizes?
+          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, extract_size: true)
 
-              if srcset_url.remote?
+              if srcset_url.protocol_relative?
+                add_failure("image link #{srcset_url.url} is a protocol-relative URL, use explicit https:// instead",
+                  line: @img.line, content: @img.content)
+              elsif srcset_url.remote?
                 add_to_external_urls(srcset_url.url, @img.line)
               elsif !srcset_url.exists?
                 add_failure("internal image #{srcset} does not exist", line: @img.line, content: @img.content)
@@ -45,7 +41,8 @@ module HTMLProofer
             end
           end
 
-          unless ignore_element?
+          # if this is an img element, check that the alt attribute is present
+          if @img.img_tag? && !ignore_element?
             if missing_alt_tag? && !ignore_missing_alt?
               add_failure("image #{@img.url.raw_attribute} does not have an alt attribute", line: @img.line,
                 content: @img.content)

data/lib/html_proofer/check/links.rb

@@ -4,7 +4,7 @@ module HTMLProofer
   class Check
     class Links < HTMLProofer::Check
       def run
-        @html.css("a, link, source").each do |node|
+        @html.css("a, link").each do |node|
           @link = create_element(node)
 
           next if @link.ignore?
@@ -28,6 +28,12 @@ module HTMLProofer
             next
           end
 
+          if @link.url.protocol_relative?
+            add_failure("#{@link.url} is a protocol-relative URL, use explicit https:// instead",
+              line: @link.line, content: @link.content)
+            next
+          end
+
           check_schemes
 
           # intentionally down here because we still want valid? & missing_href? to execute

data/lib/html_proofer/check/open_graph.rb

@@ -16,6 +16,9 @@ module HTMLProofer
             add_failure("open graph content attribute is empty", line: @open_graph.line, content: @open_graph.content)
           elsif !@open_graph.url.valid?
             add_failure("#{@open_graph.src} is an invalid URL", line: @open_graph.line)
+          elsif @open_graph.url.protocol_relative?
+            add_failure("open graph link #{@open_graph.url} is a protocol-relative URL, use explicit https:// instead",
+              line: @open_graph.line, content: @open_graph.content)
           elsif @open_graph.url.remote?
             add_to_external_urls(@open_graph.url, @open_graph.line)
           else

data/lib/html_proofer/check/scripts.rb

@@ -13,8 +13,11 @@ module HTMLProofer
           # does the script exist?
           if missing_src?
             add_failure("script is empty and has no src attribute", line: @script.line, content: @script.content)
+          elsif @script.url.protocol_relative?
+            add_failure("script link #{@script.url} is a protocol-relative URL, use explicit https:// instead",
+              line: @script.line, content: @script.content)
           elsif @script.url.remote?
-            add_to_external_urls(@script.src, @script.line)
+            add_to_external_urls(@script.url, @script.line)
             check_sri if @runner.check_sri?
           elsif !@script.url.exists?
             add_failure("internal script reference #{@script.src} does not exist", line: @script.line,

data/lib/html_proofer/check.rb

@@ -29,28 +29,10 @@ module HTMLProofer
         content: content)
     end
 
-    def self.subchecks(runner_options)
-      # grab all known checks
-      checks = ObjectSpace.each_object(Class).select do |klass|
-        klass < self
-      end
-
-      # remove any checks not explicitly included
-      checks.each_with_object([]) do |check, arr|
-        next unless runner_options[:checks].include?(check.short_name)
-
-        arr << check
-      end
-    end
-
     def short_name
       self.class.name.split("::").last
     end
 
-    def self.short_name
-      name.split("::").last
-    end
-
     def add_to_internal_urls(url, line)
       url_string = url.raw_attribute
 
@@ -74,6 +56,26 @@ module HTMLProofer
       @external_urls[url_string] << { filename: @runner.current_filename, line: line }
     end
 
+    class << self
+      def subchecks(runner_options)
+        # grab all known checks
+        checks = ObjectSpace.each_object(Class).select do |klass|
+          klass < self
+        end
+
+        # remove any checks not explicitly included
+        checks.each_with_object([]) do |check, arr|
+          next unless runner_options[:checks].include?(check.short_name)
+
+          arr << check
+        end
+      end
+
+      def short_name
+        name.split("::").last
+      end
+    end
+
     private def base_url
       return @base_url if defined?(@base_url)
 

data/lib/html_proofer/configuration.rb

@@ -47,42 +47,44 @@ module HTMLProofer
 
     CACHE_DEFAULTS = {}.freeze
 
-    def self.generate_defaults(opts)
-      options = PROOFER_DEFAULTS.merge(opts)
+    class << self
+      def generate_defaults(opts)
+        options = PROOFER_DEFAULTS.merge(opts)
 
-      options[:typhoeus] = HTMLProofer::Configuration::TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
-      options[:hydra] = HTMLProofer::Configuration::HYDRA_DEFAULTS.merge(opts[:hydra] || {})
+        options[:typhoeus] = HTMLProofer::Configuration::TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
+        options[:hydra] = HTMLProofer::Configuration::HYDRA_DEFAULTS.merge(opts[:hydra] || {})
 
-      options[:parallel] = HTMLProofer::Configuration::PARALLEL_DEFAULTS.merge(opts[:parallel] || {})
-      options[:cache] = HTMLProofer::Configuration::CACHE_DEFAULTS.merge(opts[:cache] || {})
+        options[:parallel] = HTMLProofer::Configuration::PARALLEL_DEFAULTS.merge(opts[:parallel] || {})
+        options[:cache] = HTMLProofer::Configuration::CACHE_DEFAULTS.merge(opts[:cache] || {})
 
-      options.delete(:src)
+        options.delete(:src)
 
-      options
-    end
+        options
+      end
 
-    def self.to_regex?(item)
-      if item.start_with?("/") && item.end_with?("/")
-        Regexp.new(item[1...-1])
-      else
-        item
+      def to_regex?(item)
+        if item.start_with?("/") && item.end_with?("/")
+          Regexp.new(item[1...-1])
+        else
+          item
+        end
       end
-    end
 
-    def self.parse_json_option(option_name, config, symbolize_names: true)
-      raise ArgumentError, "Must provide an option name in string format." unless option_name.is_a?(String)
-      raise ArgumentError, "Must provide an option name in string format." if option_name.strip.empty?
+      def parse_json_option(option_name, config, symbolize_names: true)
+        raise ArgumentError, "Must provide an option name in string format." unless option_name.is_a?(String)
+        raise ArgumentError, "Must provide an option name in string format." if option_name.strip.empty?
 
-      return {} if config.nil?
+        return {} if config.nil?
 
-      raise ArgumentError, "Must provide a JSON configuration in string format." unless config.is_a?(String)
+        raise ArgumentError, "Must provide a JSON configuration in string format." unless config.is_a?(String)
 
-      return {} if config.strip.empty?
+        return {} if config.strip.empty?
 
-      begin
-        JSON.parse(config, { symbolize_names: symbolize_names })
-      rescue StandardError
-        raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
+        begin
+          JSON.parse(config, { symbolize_names: symbolize_names })
+        rescue StandardError
+          raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
+        end
       end
     end
   end

data/lib/html_proofer/version.rb

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

data/lib/html_proofer.rb

@@ -20,37 +20,39 @@ if ENV.fetch("DEBUG", false)
 end
 
 module HTMLProofer
-  def self.check_file(file, options = {})
-    raise ArgumentError unless file.is_a?(String)
-    raise ArgumentError, "#{file} does not exist" unless File.exist?(file)
+  class << self
+    def check_file(file, options = {})
+      raise ArgumentError unless file.is_a?(String)
+      raise ArgumentError, "#{file} does not exist" unless File.exist?(file)
 
-    options[:type] = :file
-    HTMLProofer::Runner.new(file, options)
-  end
+      options[:type] = :file
+      HTMLProofer::Runner.new(file, options)
+    end
 
-  def self.check_directory(directory, options = {})
-    raise ArgumentError unless directory.is_a?(String)
-    raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
+    def check_directory(directory, options = {})
+      raise ArgumentError unless directory.is_a?(String)
+      raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
 
-    options[:type] = :directory
-    HTMLProofer::Runner.new([directory], options)
-  end
+      options[:type] = :directory
+      HTMLProofer::Runner.new([directory], options)
+    end
 
-  def self.check_directories(directories, options = {})
-    raise ArgumentError unless directories.is_a?(Array)
+    def check_directories(directories, options = {})
+      raise ArgumentError unless directories.is_a?(Array)
 
-    options[:type] = :directory
-    directories.each do |directory|
-      raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
+      options[:type] = :directory
+      directories.each do |directory|
+        raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
+      end
+      HTMLProofer::Runner.new(directories, options)
     end
-    HTMLProofer::Runner.new(directories, options)
-  end
 
-  def self.check_links(links, options = {})
-    raise ArgumentError unless links.is_a?(Array)
+    def check_links(links, options = {})
+      raise ArgumentError unless links.is_a?(Array)
 
-    options[:type] = :links
-    HTMLProofer::Runner.new(links, options)
+      options[:type] = :links
+      HTMLProofer::Runner.new(links, options)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable