html-proofer 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5f97da4b4c9537822e31a821d41bcb04ea8eff97a5331d297ecb898ccd0630
-  data.tar.gz: 8d3df0b4bb5812e5aaa20907314bceef819134f56f55ad081776edc96e5406a7
+  metadata.gz: 03f01340b8aebd3ccad6d82ab5aef056991f91bae04498df5091b3c7e9e6641f
+  data.tar.gz: 3dda407dc70dc4d6d65ac88f6b3474e091832c3b37bc70d3bc74e8fdc4d136db
 SHA512:
-  metadata.gz: 8c65b869c013635c247c7235b3680d6c2ab99cc99c39eff43140a6ff8884f63bf70f3c625042d0a2124cf0e7b7bd36053c240cd1101ca768089657bb8b4fc17d
-  data.tar.gz: 239211f870b13baeb8c3f337005158c055c1dd53f5513092243c2d8548b5105e974a0472db85fc93e97bf91a83ad10c36d505ad778a5395030651a6e8a5d9199
+  metadata.gz: f652269525122a2199b373be5f19a3a93541f14e14539621f207605f5e346cf2cd34fe68cea4ed6e86236f37e69e5f1db709c68fab71816847b20248acb487a3
+  data.tar.gz: 487828db630f2916ab417d8d9d3cecbd8aa96a5140ee3695d2c49b589f3d8f286bcb9fef964bf517f08286e35500dfc6c0a1119f2f83d22d9f0a6653ad3a3c8d

data/lib/html_proofer/cache.rb

@@ -71,8 +71,10 @@ module HTMLProofer
       return unless external_enabled?
 
       clean_url = cleaned_url(url)
+      # Filter out non-serializable element from metadata
+      cleaned_filenames = filenames.map { |f| f.except(:element) }
       @cache_log[:external][clean_url] =
-        { time: @cache_time.to_s, found: found, status_code: status_code, message: msg, metadata: filenames }
+        { time: @cache_time.to_s, found: found, status_code: status_code, message: msg, metadata: cleaned_filenames }
     end
 
     def detect_url_changes(urls_detected, type)
@@ -186,7 +188,9 @@ module HTMLProofer
         hsh[url] = metadata_additions
         # remove from the cache the detected metadata additions as they correspond to failures to be rechecked
         # (this works assuming the detected url metadata have "found" set to false)
-        @cache_log[:internal][url][:metadata] = cache_metadata.difference(metadata_additions)
+        # Compare without the :element key since cached metadata doesn't have it
+        metadata_additions_for_diff = metadata_additions.map { |m| m.except(:element) }
+        @cache_log[:internal][url][:metadata] = cache_metadata.difference(metadata_additions_for_diff)
       end
     end
 

data/lib/html_proofer/check/favicon.rb

@@ -22,7 +22,7 @@ module HTMLProofer
               element: @favicon,
             )
           elsif @favicon.url.remote?
-            add_to_external_urls(@favicon.url, @favicon.line)
+            add_to_external_urls(@favicon.url, @favicon)
           elsif !@favicon.url.exists?
             add_failure(
               "internal favicon #{@favicon.url.raw_attribute} does not exist",

data/lib/html_proofer/check/images.rb

@@ -30,7 +30,7 @@ module HTMLProofer
                   element: @img,
                 )
               elsif srcset_url.remote?
-                add_to_external_urls(srcset_url.url, @img.line)
+                add_to_external_urls(srcset_url.url, @img)
               elsif !srcset_url.exists?
                 add_failure("internal image #{srcset} does not exist", element: @img)
               end
@@ -41,7 +41,7 @@ module HTMLProofer
               element: @img,
             )
           elsif @img.url.remote?
-            add_to_external_urls(@img.url, @img.line)
+            add_to_external_urls(@img.url, @img)
           elsif !@img.url.exists? && !@img.multiple_srcsets? && !@img.multiple_sizes?
             add_failure(
               "internal image #{@img.url.raw_attribute} does not exist",

data/lib/html_proofer/check/links.rb

@@ -53,7 +53,7 @@ module HTMLProofer
               next
             end
 
-            add_to_external_urls(@link.url, @link.line)
+            add_to_external_urls(@link.url, @link)
           elsif @link.url.internal?
             # does the local directory have a trailing slash?
             if @link.url.unslashed_directory?(@link.url.absolute_path)
@@ -64,7 +64,7 @@ module HTMLProofer
               next
             end
 
-            add_to_internal_urls(@link.url, @link.line)
+            add_to_internal_urls(@link.url, @link)
           end
         end
       end

data/lib/html_proofer/check/open_graph.rb

@@ -22,7 +22,7 @@ module HTMLProofer
               element: @open_graph,
             )
           elsif @open_graph.url.remote?
-            add_to_external_urls(@open_graph.url, @open_graph.line)
+            add_to_external_urls(@open_graph.url, @open_graph)
           else
             add_failure(
               "internal open graph #{@open_graph.url.raw_attribute} does not exist",

data/lib/html_proofer/check/scripts.rb

@@ -19,7 +19,7 @@ module HTMLProofer
               element: @script,
             )
           elsif @script.url.remote?
-            add_to_external_urls(@script.url, @script.line)
+            add_to_external_urls(@script.url, @script)
             check_sri if @runner.check_sri?
           elsif !@script.url.exists?
             add_failure(

data/lib/html_proofer/check.rb

@@ -32,6 +32,7 @@ module HTMLProofer
         line: element.nil? ? line : element.line,
         status: status,
         content: element.nil? ? content : element.content,
+        element: element,
       )
     end
 
@@ -39,7 +40,7 @@ module HTMLProofer
       self.class.name.split("::").last
     end
 
-    def add_to_internal_urls(url, line)
+    def add_to_internal_urls(url, element)
       url_string = url.raw_attribute
 
       @internal_urls[url_string] = [] if @internal_urls[url_string].nil?
@@ -47,19 +48,20 @@ module HTMLProofer
       metadata = {
         source: url.source,
         filename: url.filename,
-        line: line,
+        line: element.line,
         base_url: base_url,
         found: false,
+        element: element,
       }
       @internal_urls[url_string] << metadata
     end
 
-    def add_to_external_urls(url, line)
+    def add_to_external_urls(url, element)
       url_string = url.to_s
 
       @external_urls[url_string] = [] if @external_urls[url_string].nil?
 
-      @external_urls[url_string] << { filename: url.filename, line: line }
+      @external_urls[url_string] << { filename: url.filename, line: element.line, element: element }
     end
 
     class << self

data/lib/html_proofer/failure.rb

@@ -2,9 +2,9 @@
 
 module HTMLProofer
   class Failure
-    attr_reader :path, :check_name, :description, :status, :line, :content
+    attr_reader :path, :check_name, :description, :status, :line, :content, :element
 
-    def initialize(path, check_name, description, line: nil, status: nil, content: nil)
+    def initialize(path, check_name, description, line: nil, status: nil, content: nil, element: nil)
       @path = path
       @check_name = check_name
       @description = description
@@ -12,6 +12,7 @@ module HTMLProofer
       @line = line
       @status = status
       @content = content
+      @element = element
     end
   end
 end

data/lib/html_proofer/url_validator/external.rb

@@ -195,7 +195,15 @@ module HTMLProofer
           @failed_checks << Failure.new("", "Links > External", description, status: status)
         else
           metadata.each do |m|
-            @failed_checks << Failure.new(m[:filename], "Links > External", description, line: m[:line], status: status)
+            @failed_checks << Failure.new(
+              m[:filename],
+              "Links > External",
+              description,
+              line: m[:line],
+              status: status,
+              content: m[:element]&.content,
+              element: m[:element],
+            )
           end
         end
       end

data/lib/html_proofer/url_validator/internal.rb

@@ -38,7 +38,8 @@ module HTMLProofer
                 "internally linking to #{url}, which does not exist",
                 line: metadata[:line],
                 status: nil,
-                content: nil,
+                content: metadata[:element]&.content,
+                element: metadata[:element],
               )
               to_add << [url, metadata, false]
               next
@@ -64,7 +65,8 @@ module HTMLProofer
                 "internally linking to #{url}; the file exists, but the hash '#{url.hash}' does not",
                 line: metadata[:line],
                 status: nil,
-                content: nil,
+                content: metadata[:element]&.content,
+                element: metadata[:element],
               )
               to_add << [url, metadata, false]
               next
@@ -90,7 +92,8 @@ module HTMLProofer
                   "internally linking to #{url}; the file exists, but the hash '#{href_hash}' does not",
                   line: metadata[:line],
                   status: nil,
-                  content: nil,
+                  content: metadata[:element]&.content,
+                  element: metadata[:element],
                 )
               end
               to_add << [url, metadata, exists]

data/lib/html_proofer/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Garen Torikian
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-11-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-  force_ruby_platform: false
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +65,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
@@ -69,7 +79,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.11'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +93,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +107,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: yell
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +121,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-  force_ruby_platform: false
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,14 +169,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '6.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '6.4'
 description: Test your rendered HTML files to make sure they're accurate.
 email:
 - gjtorikian@gmail.com
@@ -212,7 +217,6 @@ licenses:
 metadata:
   funding_uri: https://github.com/sponsors/gjtorikian/
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -223,15 +227,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '4.0'
+      version: '5.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.3
 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,