html-proofer 4.0.0.rc3 → 4.0.0

data/lib/html_proofer/url_validator/internal.rb

@@ -1,86 +1,96 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  class UrlValidator::Internal < UrlValidator
-    attr_reader :internal_urls
+  class UrlValidator
+    class Internal < UrlValidator
+      attr_reader :internal_urls
 
-    def initialize(runner, internal_urls)
-      super(runner)
+      def initialize(runner, internal_urls)
+        super(runner)
 
-      @internal_urls = internal_urls
-    end
-
-    def validate
-      if @cache.enabled?
-        urls_to_check = @runner.load_internal_cache
-        run_internal_link_checker(urls_to_check)
-      else
-        run_internal_link_checker(@internal_urls)
+        @internal_urls = internal_urls
       end
 
-      @failed_checks
-    end
-
-    def run_internal_link_checker(links)
-      links.each_pair do |link, matched_files|
-        matched_files.each do |metadata|
-          url = HTMLProofer::Attribute::Url.new(@runner, link, base_url: metadata[:base_url])
-
-          @runner.current_source = metadata[:source]
-          @runner.current_path = metadata[:current_path]
+      def validate
+        if @cache.enabled?
+          urls_to_check = @runner.load_internal_cache
+          run_internal_link_checker(urls_to_check)
+        else
+          run_internal_link_checker(@internal_urls)
+        end
 
-          unless file_exists?(url)
-            @failed_checks << Failure.new(@runner.current_path, 'Links > Internal', "internally linking to #{url}, which does not exist", line: metadata[:line], status: nil, content: nil)
-            @cache.add_internal(url.to_s, metadata, false)
-            next
-          end
+        @failed_checks
+      end
 
-          unless hash_exists?(url)
-            @failed_checks << Failure.new(@runner.current_path, 'Links > Internal', "internally linking to #{url}; the file exists, but the hash '#{url.hash}' does not", line: metadata[:line], status: nil, content: nil)
-            @cache.add_internal(url.to_s, metadata, false)
-            next
+      def run_internal_link_checker(links)
+        to_add = []
+        links.each_pair do |link, matched_files|
+          matched_files.each do |metadata|
+            url = HTMLProofer::Attribute::Url.new(@runner, link, base_url: metadata[:base_url])
+
+            @runner.current_source = metadata[:source]
+            @runner.current_filename = metadata[:filename]
+
+            unless file_exists?(url)
+              @failed_checks << Failure.new(@runner.current_filename, "Links > Internal",
+                "internally linking to #{url}, which does not exist", line: metadata[:line], status: nil, content: nil)
+              to_add << [url, metadata, false]
+              next
+            end
+
+            unless hash_exists?(url)
+              @failed_checks << Failure.new(@runner.current_filename, "Links > Internal",
+                "internally linking to #{url}; the file exists, but the hash '#{url.hash}' does not", line: metadata[:line], status: nil, content: nil)
+              to_add << [url, metadata, false]
+              next
+            end
+
+            to_add << [url, metadata, true]
           end
+        end
 
-          @cache.add_internal(url.to_s, metadata, true)
+        # adding directly to the cache above results in an endless loop
+        to_add.each do |(url, metadata, exists)|
+          @cache.add_internal(url.to_s, metadata, exists)
         end
+
+        @failed_checks
       end
 
-      @failed_checks
-    end
+      private def file_exists?(url)
+        absolute_path = url.absolute_path
+        return @runner.checked_paths[url.absolute_path] if @runner.checked_paths.key?(absolute_path)
 
-    private def file_exists?(url)
-      absolute_path = url.absolute_path
-      return @runner.checked_paths[url.absolute_path] if @runner.checked_paths.key?(absolute_path)
+        @runner.checked_paths[url.absolute_path] = File.exist?(absolute_path)
+      end
 
-      @runner.checked_paths[url.absolute_path] = File.exist?(absolute_path)
-    end
+      # verify the target hash
+      private def hash_exists?(url)
+        href_hash = url.hash
+        return true if blank?(href_hash)
 
-    # verify the target hash
-    private def hash_exists?(url)
-      href_hash = url.hash
-      return true if blank?(href_hash)
+        # prevents searching files we didn't ask about
+        return false unless url.known_extension?
 
-      # prevents searching files we didn't ask about
-      return false unless url.known_extension?
+        decoded_href_hash = Addressable::URI.unescape(href_hash)
+        fragment_ids = [href_hash, decoded_href_hash]
+        # https://www.w3.org/TR/html5/single-page.html#scroll-to-fragid
+        fragment_ids.include?("top") || !find_fragments(fragment_ids, url).empty?
+      end
 
-      decoded_href_hash = Addressable::URI.unescape(href_hash)
-      fragment_ids = [href_hash, decoded_href_hash]
-      # https://www.w3.org/TR/html5/single-page.html#scroll-to-fragid
-      fragment_ids.include?('top') || !find_fragments(fragment_ids, url).empty?
-    end
+      private def find_fragments(fragment_ids, url)
+        xpaths = fragment_ids.uniq.flat_map do |frag_id|
+          escaped_frag_id = "'#{frag_id.split("'").join("', \"'\", '")}', ''"
+          [
+            "//*[case_sensitive_equals(@id, concat(#{escaped_frag_id}))]",
+            "//*[case_sensitive_equals(@name, concat(#{escaped_frag_id}))]",
+          ]
+        end
+        xpaths << XpathFunctions.new
 
-    private def find_fragments(fragment_ids, url)
-      xpaths = fragment_ids.uniq.flat_map do |frag_id|
-        escaped_frag_id = "'#{frag_id.split("'").join("', \"'\", '")}', ''"
-        [
-          "//*[case_sensitive_equals(@id, concat(#{escaped_frag_id}))]",
-          "//*[case_sensitive_equals(@name, concat(#{escaped_frag_id}))]"
-        ]
+        html = create_nokogiri(url.absolute_path)
+        html.xpath(*xpaths)
       end
-      xpaths << XpathFunctions.new
-
-      html = create_nokogiri(url.absolute_path)
-      html.xpath(*xpaths)
     end
   end
 end

data/lib/html_proofer/utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'nokogiri'
+require "nokogiri"
 
 module HTMLProofer
   module Utils
@@ -14,10 +14,10 @@ module HTMLProofer
 
     def create_nokogiri(path)
       content = if File.exist?(path) && !File.directory?(path)
-                  File.read(path)
-                else
-                  path
-                end
+        File.read(path)
+      else
+        path
+      end
 
       Nokogiri::HTML5(content, max_errors: -1)
     end

data/lib/html_proofer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  VERSION = '4.0.0.rc3'
+  VERSION = "4.0.0"
 end

data/lib/html_proofer.rb

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
-lib_dir = File.join(File.dirname(__dir__), 'lib')
+require "zeitwerk"
+lib_dir = File.join(File.dirname(__dir__), "lib")
 gem_loader = Zeitwerk::Loader.for_gem
 gem_loader.inflector.inflect(
-  'html_proofer' => 'HTMLProofer'
+  "html_proofer" => "HTMLProofer"
 )
-gem_loader.ignore(File.join(lib_dir, 'html-proofer.rb'))
+gem_loader.ignore(File.join(lib_dir, "html-proofer.rb"))
 gem_loader.setup
 
-require 'html_proofer/version'
+require "html_proofer/version"
 
-require 'parallel'
-require 'fileutils'
+require "parallel"
+require "fileutils"
 
-# require 'awesome_print'
-# require 'debug'
+if ENV.fetch("DEBUG", false)
+  require "awesome_print"
+  require "debug"
+end
 
 module HTMLProofer
   def self.check_file(file, options = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 4.0.0.rc3
+  version: 4.0.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -299,6 +299,7 @@ homepage: https://github.com/gjtorikian/html-proofer
 licenses:
 - MIT
 metadata:
+  funding_uri: https://github.com/sponsors/gjtorikian/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -314,11 +315,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image