html-proofer 3.18.5 → 3.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e90edda0dcb30f00baa440ec7b231bf73e086e0414fe9a1a56870940e2c15aeb
-  data.tar.gz: 2505df1fb597aaadfa68bf0f7c8b3d9380e27a236c31582d4c91840bf5e65623
+  metadata.gz: 2e18991c07a3b31ae78293fc8dc2a9392211f8609ed494ed5cad87158747cde2
+  data.tar.gz: d9551668e860b1055a640be9ba597cb9fca8822849a7b000d251086e8eadb023
 SHA512:
-  metadata.gz: c5b864da4544723801ade7b906c387f893aed338ca36f9f3ae4a4660fa69f2f60883071cb2030cf526911abe954cf81932691a96c7c8f93e5e6970a18120449a
-  data.tar.gz: b141806119a645c1b974028f4e4ec3ecf60d74d51d1f5575d8b2fab4a3c7e90ddd8a6f8511474bd64825d49f591630ed8e9be83c1d5676b22b0f73b42ce93e3e
+  metadata.gz: 2e9187bcd157c8c69cb8dc7f47e9ef6908e7ccb06b56fd2fd241e8c3cbb245874a9776e5405c9aa5328a01e7038880f173d205efb2c925c7c5787e3c46d3389d
+  data.tar.gz: 76afe0c48983344c1ebfb86075458d71b05163fb051ff0fbcbfa2104b324d520bbf7213ff262ec437d3ddeb6265d4454056d66a50d4c68ab02a3c6626a9633e0

data/bin/htmlproofer

@@ -48,6 +48,7 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'storage_dir', '--storage-dir PATH', String, 'Directory where to store the cache log (default: "tmp/.htmlproofer")'
   p.option 'timeframe', '--timeframe <time>', String, 'A string representing the caching timeframe.'
   p.option 'typhoeus_config', '--typhoeus-config CONFIG', String, 'JSON-formatted string of Typhoeus config. Will override the html-proofer defaults.'
+  p.option 'hydra_config', '--hydra-config CONFIG', String, 'JSON-formatted string of Hydra config. Will override the html-proofer defaults.'
   p.option 'url_ignore', '--url-ignore link1,[link2,...]', Array, 'A comma-separated list of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored'
   p.option 'url_swap', '--url-swap re:string,[re:string,...]', Array, 'A comma-separated list containing key-value pairs of `RegExp => String`. It transforms URLs that match `RegExp` into `String` via `gsub`. The escape sequences `\\:` should be used to produce literal `:`s.'
   p.option 'root_dir', '--root-dir PATH', String, 'The absolute path to the directory serving your html-files.'
@@ -87,7 +88,8 @@ Mercenary.program(:htmlproofer) do |p|
     options[:validation][:report_eof_tags] = opts['report_eof_tags'] unless opts['report_eof_tags'].nil?
     options[:validation][:report_mismatched_tags] = opts['report_mismatched_tags'] unless opts['report_mismatched_tags'].nil?
 
-    options[:typhoeus] = HTMLProofer::Configuration.parse_json_option('typhoeus_config', opts['typhoeus_config']) unless opts['typhoeus_config'].nil?
+    options[:typhoeus] = HTMLProofer::Configuration.parse_json_option('typhoeus_config', opts['typhoeus_config'], symbolize_names: false) unless opts['typhoeus_config'].nil?
+    options[:hydra] = HTMLProofer::Configuration.parse_json_option('hydra_config', opts['hydra_config'], symbolize_names: false) unless opts['hydra_config'].nil?
 
     unless opts['timeframe'].nil?
       options[:cache] ||= {}

data/lib/html-proofer/cache.rb

@@ -3,6 +3,7 @@
 require_relative 'utils'
 require 'date'
 require 'json'
+require 'uri'
 
 module HTMLProofer
   class Cache
@@ -11,6 +12,8 @@ module HTMLProofer
     DEFAULT_STORAGE_DIR = File.join('tmp', '.htmlproofer')
     DEFAULT_CACHE_FILE_NAME = 'cache.log'
 
+    URI_REGEXP = URI::DEFAULT_PARSER.make_regexp
+
     attr_reader :exists, :cache_log, :storage_dir, :cache_file
 
     def initialize(logger, options)
@@ -30,6 +33,8 @@ module HTMLProofer
     end
 
     def within_timeframe?(time)
+      return false if time.nil?
+
       (@parsed_timeframe..@cache_time).cover?(Time.parse(time))
     end
 
@@ -71,10 +76,14 @@ module HTMLProofer
       @cache_log[clean_url(url)] = data
     end
 
-    def detect_url_changes(found)
-      existing_urls = @cache_log.keys.map { |url| clean_url(url) }
+    def detect_url_changes(found, type)
       found_urls = found.keys.map { |url| clean_url(url) }
 
+      # if there were no urls, bail
+      return {} if found_urls.empty?
+
+      existing_urls = @cache_log.keys.map { |url| clean_url(url) }
+
       # prepare to add new URLs detected
       additions = found.reject do |url, _|
         url = clean_url(url)
@@ -91,24 +100,28 @@ module HTMLProofer
       @logger.log :info, "Adding #{new_link_text} to the cache..."
 
       # remove from cache URLs that no longer exist
-      del = 0
+      deletions = 0
       @cache_log.delete_if do |url, _|
         url = clean_url(url)
+
         if found_urls.include?(url)
           false
-        else
+        elsif url_matches_type?(url, type)
           @logger.log :debug, "Removing #{url} from cache check"
-          del += 1
+          deletions += 1
           true
         end
       end
 
-      del_link_text = pluralize(del, 'link', 'links')
+      del_link_text = pluralize(deletions, 'link', 'links')
       @logger.log :info, "Removing #{del_link_text} from the cache..."
 
       additions
     end
 
+    # TODO: Garbage performance--both the external and internal
+    # caches need access to this file. Write a proper versioned
+    # schema in the future
     def write
       File.write(cache_file, @cache_log.to_json)
     end
@@ -117,12 +130,15 @@ module HTMLProofer
       @load.nil?
     end
 
-    def retrieve_urls(urls)
-      urls_to_check = detect_url_changes(urls)
+    def retrieve_urls(urls, type)
+      urls_to_check = detect_url_changes(urls, type)
+
       @cache_log.each_pair do |url, cache|
         next if within_timeframe?(cache['time']) && cache['message'].empty? # these were successes to skip
 
-        urls_to_check[url] = cache['filenames'] # recheck expired links
+        if url_matches_type?(url, type)
+          urls_to_check[url] = cache['filenames'] # recheck expired links
+        end
       end
       urls_to_check
     end
@@ -149,9 +165,9 @@ module HTMLProofer
 
       @cache_file = File.join(storage_dir, cache_file_name)
 
-      return unless File.exist?(cache_file)
+      return unless File.exist?(@cache_file)
 
-      contents = File.read(cache_file)
+      contents = File.read(@cache_file)
       @cache_log = contents.empty? ? {} : JSON.parse(contents)
     end
 
@@ -169,5 +185,10 @@ module HTMLProofer
         @cache_datetime - Rational(measurement / 24.0)
       end.to_time
     end
+
+    def url_matches_type?(url, type)
+      return true if type == :internal && url !~ URI_REGEXP
+      return true if type == :external && url =~ URI_REGEXP
+    end
   end
 end

data/lib/html-proofer/check/links.rb

@@ -59,11 +59,8 @@ class LinkCheck < ::HTMLProofer::Check
         add_to_external_urls(@link.href || @link.src)
         next
       elsif @link.internal?
-        if @link.exists? || @link.hash
-          add_to_internal_urls(@link.href, InternalLink.new(@link, @path, line, content))
-        else
-          add_issue("internally linking to #{@link.href}, which does not exist", line: line, content: content)
-        end
+        add_to_internal_urls(@link.href, InternalLink.new(@link, @path, line, content))
+        add_issue("internally linking to #{@link.href}, which does not exist", line: line, content: content) if !@link.exists? && !@link.hash
       end
     end
 

data/lib/html-proofer/configuration.rb

@@ -67,7 +67,7 @@ module HTMLProofer
       end
     end
 
-    def self.parse_json_option(option_name, config)
+    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?
 
@@ -78,7 +78,7 @@ module HTMLProofer
       return {} if config.strip.empty?
 
       begin
-        JSON.parse(config)
+        JSON.parse(config, { symbolize_names: symbolize_names })
       rescue StandardError
         raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
       end

data/lib/html-proofer/element.rb

@@ -24,7 +24,7 @@ module HTMLProofer
         raise e
       end
 
-      @aria_hidden = defined?(@aria_hidden) && @aria_hidden == 'true' ? true : false
+      @aria_hidden = defined?(@aria_hidden) && @aria_hidden == 'true'
 
       @data_proofer_ignore = defined?(@data_proofer_ignore)
 
@@ -220,6 +220,8 @@ module HTMLProofer
     end
 
     def ignores_pattern_check(links)
+      return false unless links.is_a?(Array)
+
       links.each do |ignore|
         case ignore
         when String

data/lib/html-proofer/middleware.rb

@@ -22,7 +22,7 @@ module HTMLProofer
         allow_hash_href: true,
         check_external_hash: true,
         check_html: true,
-        url_ignore: [/.*/], # Don't try to check if local files exist
+        url_ignore: [%r{^/}], # Don't try to check if local files exist
         validation: { report_eof_tags: true }
       }
     end

data/lib/html-proofer/runner.rb

@@ -63,7 +63,9 @@ module HTMLProofer
           swap(url, @options[:url_swap])
         end
       end
-      @external_urls = Hash[*@src.map { |s| [s, nil] }.flatten]
+      @external_urls = @src.each_with_object({}) do |url, hash|
+        hash[url] = nil
+      end
       validate_external_urls
     end
 
@@ -123,7 +125,7 @@ module HTMLProofer
           end
 
           external_urls = check.external_urls
-          external_urls = Hash[check.external_urls.map { |url, file| [swap(url, @options[:url_swap]), file] }] if @options[:url_swap]
+          external_urls = check.external_urls.map { |url, file| [swap(url, @options[:url_swap]), file] }.to_h if @options[:url_swap]
           result[:external_urls].merge!(external_urls)
           result[:failures].concat(check.issues)
         end
@@ -236,7 +238,7 @@ module HTMLProofer
     end
 
     def load_internal_cache
-      urls_to_check = @cache.retrieve_urls(@internal_urls)
+      urls_to_check = @cache.retrieve_urls(@internal_urls, :internal)
       cache_text = pluralize(urls_to_check.count, 'internal link', 'internal links')
       @logger.log :info, "Found #{cache_text} in the cache..."
 

data/lib/html-proofer/url_validator.rb

@@ -26,7 +26,7 @@ module HTMLProofer
       @external_urls = remove_query_values
 
       if @cache.use_cache?
-        urls_to_check = @cache.retrieve_urls(@external_urls)
+        urls_to_check = @cache.retrieve_urls(@external_urls, :external)
         external_link_checker(urls_to_check)
         @cache.write
       else
@@ -85,7 +85,7 @@ module HTMLProofer
     # for HEAD. If we've decided to check for hashes, we must do a GET--HEAD is
     # not available as an option.
     def external_link_checker(external_urls)
-      external_urls = Hash[external_urls.sort]
+      external_urls = external_urls.sort.to_h
 
       count = external_urls.length
       check_text = pluralize(count, 'external link', 'external links')

data/lib/html-proofer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTMLProofer
-  VERSION = '3.18.5'
+  VERSION = '3.19.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.18.5
+  version: 3.19.1
 platform: ruby
 authors:
 - Garen Torikian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-02 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable