html-proofer 5.0.9 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9ed4a509a2d120a3aff5ad4809f6b91feff3842dceb371015aca5fd08e69bb2
-  data.tar.gz: 0db88e877a8fc19022d4fd1f382e4d38bfeead1540c42817e33799ccf2527bc7
+  metadata.gz: fd5f97da4b4c9537822e31a821d41bcb04ea8eff97a5331d297ecb898ccd0630
+  data.tar.gz: 8d3df0b4bb5812e5aaa20907314bceef819134f56f55ad081776edc96e5406a7
 SHA512:
-  metadata.gz: 6c888e7975c91eb41124057eba57fb3bdd9f8d82f38be6958c82649458526d7a41cb9aac8d4221678c273db419708cb2abfce2ce0be7396acd2b97295e938844
-  data.tar.gz: 61acc2e9c73ba8ca51abca84e21524e145a3f98f8d0d8db4c9683d13407610ea13dfe04342cc861ca0109cd8f9ac1fa24300bb0df684a198787ee5a2d40c8cde
+  metadata.gz: 8c65b869c013635c247c7235b3680d6c2ab99cc99c39eff43140a6ff8884f63bf70f3c625042d0a2124cf0e7b7bd36053c240cd1101ca768089657bb8b4fc17d
+  data.tar.gz: 239211f870b13baeb8c3f337005158c055c1dd53f5513092243c2d8548b5105e974a0472db85fc93e97bf91a83ad10c36d505ad778a5395030651a6e8a5d9199

data/lib/html_proofer/attribute/url.rb

@@ -133,8 +133,9 @@ module HTMLProofer
           path_with_extension # existence checked implicitly by File.file?
         # implicit index support
         elsif File.directory?(path_to_resolve) && !unslashed_directory?(path_to_resolve)
-          path_with_index = File.join(path_to_resolve, @runner.options[:directory_index_file])
-          path_with_index if File.file?(path_with_index)
+          @runner.options[:directory_index_files]
+            .map { |dif| File.join(path_to_resolve, dif) }
+            .find { |path_with_index| File.file?(path_with_index) }
         # explicit file or directory
         elsif File.exist?(path_to_resolve)
           path_to_resolve
@@ -238,7 +239,7 @@ module HTMLProofer
         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!

data/lib/html_proofer/cache.rb

@@ -34,9 +34,9 @@ module HTMLProofer
         setup_cache!(options)
 
         @external_timeframe = parsed_timeframe(options[:timeframe][:external])
-        define_singleton_method(:external_enabled?) { !@external_timeframe.nil? }
+        define_singleton_method(:external_enabled?) { !@external_timeframe.nil? } # rubocop:disable ThreadSafety/ClassInstanceVariable
         @internal_timeframe = parsed_timeframe(options[:timeframe][:internal])
-        define_singleton_method(:internal_enabled?) { !@internal_timeframe.nil? }
+        define_singleton_method(:internal_enabled?) { !@internal_timeframe.nil? } # rubocop:disable ThreadSafety/ClassInstanceVariable
       end
     end
 

data/lib/html_proofer/check/images.rb

@@ -20,18 +20,6 @@ module HTMLProofer
           # 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 @@ module HTMLProofer
                 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

data/lib/html_proofer/configuration.rb

@@ -13,7 +13,7 @@ module HTMLProofer
       check_external_hash: true,
       check_internal_hash: true,
       checks: DEFAULT_TESTS,
-      directory_index_file: "index.html",
+      directory_index_files: ["index.html"],
       disable_external: false,
       ignore_empty_alt: true,
       ignore_empty_mailto: false,
@@ -47,6 +47,12 @@ module HTMLProofer
 
     class << self
       def generate_defaults(opts)
+        # If `:directory_index_file` (singular) is given, convert it into an
+        # array for `:directory_index_files` (plural) instead.
+        if opts.key?(:directory_index_file)
+          opts[:directory_index_files] = [opts.delete(:directory_index_file)]
+        end
+
         options = PROOFER_DEFAULTS.merge(opts)
 
         options[:typhoeus] = HTMLProofer::Configuration::TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
@@ -89,6 +95,10 @@ module HTMLProofer
             @options[long_opt_symbol] = arg
           end
 
+          set_option(opts, "--directory-index-files [FILENAME1,FILENAME2,...]") do |long_opt_symbol, list|
+            @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
+          end
+
           set_option(opts, "--extensions [EXT1,EXT2,...]") do |long_opt_symbol, list|
             @options[long_opt_symbol] = list.nil? ? [] : list.split(",")
           end
@@ -285,6 +295,7 @@ module HTMLProofer
           "to allow extensionless URLs (as supported by most servers) (default: `.html`).",
         ],
         directory_index_file: ["Sets the file to look for when a link refers to a directory. (default: `index.html`)."],
+        directory_index_files: ["Sets the files to look for when a link refers to a directory. (default: `[\"index.html\"]`)."],
         extensions: [
           "A comma-separated list of Strings indicating the file extensions you",
           "would like to check (default: `.html`)",

data/lib/html_proofer/log.rb

@@ -13,7 +13,7 @@ module HTMLProofer
     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")

data/lib/html_proofer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 5.0.9
+  version: 5.1.0
 platform: ruby
 authors:
 - Garen Torikian
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -212,7 +212,7 @@ licenses:
 metadata:
   funding_uri: https://github.com/sponsors/gjtorikian/
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,7 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image
   references are legitimate, if they have alt tags, if your internal links are working,