html-proofer 3.17.0 → 3.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b5a47189e872130e01a2080e6e8ddb1f7f22520098deaf941960194d2338b2b
-  data.tar.gz: 3543c42860956427e8c828861f76e1c5cd984d79054c091c6e5f97e0352b3137
+  metadata.gz: 010dde5e6758227f807cb7b17095b68df2d987ff4911c7c1e5f8876cff2f5bf2
+  data.tar.gz: 7925b79c6e1431c175aab35c1181ffa8127b1051427a5810411bacfe61c1ae27
 SHA512:
-  metadata.gz: 1defd1fb2ee651015231b0ed4d1407ed56e25a907e0602ee9e175b23f3b88938e020f438d2171ceea8d52bc58984901543c97184a3da13c9b08cdaf62200a4aa
-  data.tar.gz: 97eb6120db724822830398a85f14faa4415638e965d21aef0703991e7a14d335f32df65d72bb877be6f0706f24154deea3f08a6bbeb2cdf5d7c392d03ce2af23
+  metadata.gz: 794d63f91e2fd22e5e5dba8a1b1032ec0c85b5fbe4e4db991f02cef6c205ac777f0dc9ea611378fe1702ee57c2fb917d4a1d95f02e10dda402df6d451d6cbd54
+  data.tar.gz: 3bf224c6ed71160031e95d3258401a314d8a480b069a5c6c9d555a163f288d1128eac3f76decd3033b2d32d98ed89f65b37bfeef696fd475a2d2b8749aa097da

data/bin/htmlproofer

@@ -50,7 +50,7 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'typhoeus_config', '--typhoeus-config CONFIG', String, 'JSON-formatted string of Typhoeus 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-folder PATH', String, 'The absolute path to the directory serving your html-files. Used when running html-proofer on a file, rather than a directory.'
+  p.option 'root_dir', '--root-dir PATH', String, 'The absolute path to the directory serving your html-files.'
 
   p.action do |args, opts|
     args = ['.'] if args.empty?

data/lib/html-proofer.rb

@@ -1,3 +1,4 @@
+# rubocop:disable Naming/FileName
 # frozen_string_literal: true
 
 def require_all(path)
@@ -52,3 +53,4 @@ module HTMLProofer
     HTMLProofer::Runner.new(links, options)
   end
 end
+# rubocop:enable Naming/FileName

data/lib/html-proofer/check.rb

@@ -26,8 +26,8 @@ module HTMLProofer
       raise NotImplementedError, 'HTMLProofer::Check subclasses must implement #run'
     end
 
-    def add_issue(desc, line: nil, status: -1, content: nil)
-      @issues << Issue.new(@path, desc, line: line, status: status, content: content)
+    def add_issue(desc, line: nil, path: nil, status: -1, content: nil)
+      @issues << Issue.new(path || @path, desc, line: line, status: status, content: content)
       false
     end
 

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

@@ -7,7 +7,7 @@ class FaviconCheck < ::HTMLProofer::Check
       favicon = create_element(node)
       next if favicon.ignore?
 
-      found = true if favicon.rel.split(' ').last.eql? 'icon'
+      found = true if favicon.rel.split.last.eql? 'icon'
       break if found
     end
 

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

@@ -65,15 +65,15 @@ class LinkCheck < ::HTMLProofer::Check
     external_urls
   end
 
-  def check_internal_link(link, line, content)
+  def check_internal_link(link, path, line, content)
     # does the local directory have a trailing slash?
     if link.unslashed_directory?(link.absolute_path)
-      add_issue("internally linking to a directory #{link.absolute_path} without trailing slash", line: line, content: content)
+      add_issue("internally linking to a directory #{link.absolute_path} without trailing slash", path: path, line: line, content: content)
       return false
     end
 
     # verify the target hash
-    return handle_hash(link, line, content) if link.hash
+    return handle_hash(link, path, line, content) if link.hash
 
     true
   end
@@ -103,9 +103,9 @@ class LinkCheck < ::HTMLProofer::Check
     add_issue("#{link.href} contains no phone number", line: line, content: content) if link.path.empty?
   end
 
-  def handle_hash(link, line, content)
+  def handle_hash(link, path, line, content)
     if link.internal? && !hash_exists?(link.html, link.hash) # rubocop:disable Style/GuardClause
-      return add_issue("linking to internal hash ##{link.hash} that does not exist", line: line, content: content)
+      return add_issue("linking to internal hash ##{link.hash} that does not exist", path: path, line: line, content: content)
     elsif link.external?
       return external_link_check(link, line, content)
     end

data/lib/html-proofer/element.rb

@@ -169,6 +169,10 @@ module HTMLProofer
       url.start_with?('?')
     end
 
+    def absolute_path?(path)
+      path.start_with?('/')
+    end
+
     def file_path
       return if path.nil? || path.empty?
 
@@ -176,22 +180,19 @@ module HTMLProofer
 
       path_dot_ext = path + @check.options[:extension] if @check.options[:assume_extension]
 
-      if %r{^/}.match?(path) # path relative to root
-        if File.directory?(@check.src)
-          base = @check.src
-        else
-          root_dir = @check.options[:root_dir]
-          base = root_dir || File.dirname(@check.src)
-        end
-      elsif File.exist?(File.expand_path(path, @check.src)) || File.exist?(File.expand_path(path_dot_ext, @check.src)) # relative links, path is a file
-        base = File.dirname @check.path
-      elsif File.exist?(File.join(File.dirname(@check.path), path)) || File.exist?(File.join(File.dirname(@check.path), path_dot_ext)) # rubocop:disable Lint/DuplicateBranch; relative links in nested dir, path is a file
-        base = File.dirname @check.path
-      else # relative link, path is a directory
-        base = @check.path
-      end
+      base = if absolute_path?(path) # path relative to root
+               # either overwrite with root_dir; or, if source is directory, use that; or, just get the current file's dirname
+               @check.options[:root_dir] || (File.directory?(@check.src) ? @check.src : File.dirname(@check.src))
+             elsif File.exist?(File.expand_path(path, @check.src)) || File.exist?(File.expand_path(path_dot_ext, @check.src)) # relative links, path is a file
+               File.dirname(@check.path)
+             elsif File.exist?(File.join(File.dirname(@check.path), path)) || File.exist?(File.join(File.dirname(@check.path), path_dot_ext)) # rubocop:disable Lint/DuplicateBranch; relative links in nested dir, path is a file
+               File.dirname(@check.path)
+             else # relative link, path is a directory
+               @check.path
+             end
+
+      file = File.join(base, path)
 
-      file = File.join base, path
       if @check.options[:assume_extension] && File.file?("#{file}#{@check.options[:extension]}")
         file = "#{file}#{@check.options[:extension]}"
       elsif File.directory?(file) && !unslashed_directory?(file) # implicit index support
@@ -203,14 +204,15 @@ module HTMLProofer
 
     # checks if a file exists relative to the current pwd
     def exists?
-      return @checked_paths[absolute_path] if @checked_paths.key? absolute_path
+      return @checked_paths[absolute_path] if @checked_paths.key?(absolute_path)
 
-      @checked_paths[absolute_path] = File.exist? absolute_path
+      @checked_paths[absolute_path] = File.exist?(absolute_path)
     end
 
     def absolute_path
       path = file_path || @check.path
-      File.expand_path path, Dir.pwd
+
+      File.expand_path(path, Dir.pwd)
     end
 
     def ignores_pattern_check(links)

data/lib/html-proofer/middleware.rb

@@ -60,7 +60,7 @@ module HTMLProofer
       body = []
       result.last.each { |e| body << e }
 
-      body = body.join('')
+      body = body.join
       begin
         html = body.lstrip
       rescue StandardError

data/lib/html-proofer/runner.rb

@@ -147,14 +147,17 @@ module HTMLProofer
         urls_to_check = load_internal_cache
 
         urls_to_check.each_pair do |url, internal_urls|
-          result = @internal_link_checks.check_internal_link(internal_urls.first.link, internal_urls.first.line, internal_urls.first.content)
+          # pulled from cache
+          internal_urls = @internal_urls[url] unless internal_urls.first.is_a?(LinkCheck::InternalLink)
+
+          result = @internal_link_checks.check_internal_link(internal_urls.first.link, internal_urls.first.path, internal_urls.first.line, internal_urls.first.content)
           code = result ? 200 : 404
           @cache.add(url, @internal_urls_to_paths[url].sort, code, '') # TODO: blank msg for now
         end
         @cache.write
       else
         @internal_urls.values.flatten.each do |internal_url|
-          @internal_link_checks.check_internal_link(internal_url.link, internal_url.line, internal_url.content)
+          @internal_link_checks.check_internal_link(internal_url.link, internal_url.path, internal_url.line, internal_url.content)
         end
       end
 
@@ -211,7 +214,8 @@ module HTMLProofer
       sorted_failures.sort_and_report
       count = @failures.length
       failure_text = pluralize(count, 'failure', 'failures')
-      raise @logger.colorize :fatal, "HTML-Proofer found #{failure_text}!"
+      @logger.log :fatal, "\nHTML-Proofer found #{failure_text}!"
+      exit 1
     end
 
     # Set before_request callback.
@@ -226,7 +230,7 @@ module HTMLProofer
     # @return [ Array<Block> ] All before_request blocks.
     def before_request(&block)
       @before_request ||= []
-      @before_request << block if block_given?
+      @before_request << block if block
       @before_request
     end
 

data/lib/html-proofer/url_validator.rb

@@ -120,7 +120,7 @@ module HTMLProofer
     def clean_url(href)
       # catch any obvious issues, like strings in port numbers
       parsed = Addressable::URI.parse(href)
-      if href =~ /^([!#{$&}-;=?-\[\]_a-z~]|%[0-9a-fA-F]{2})+$/
+      if href =~ /^([!#{Regexp.last_match(0)}-;=?-\[\]_a-z~]|%[0-9a-fA-F]{2})+$/
         href
       else
         parsed.normalize

data/lib/html-proofer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.17.0
+  version: 3.18.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2020-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -308,7 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image