html-proofer 3.10.1 → 3.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b785a108ad8a82bdc21dbc428240bcba1b77ac3a0a5cf08d0de68bac11583e5
-  data.tar.gz: 52f4c91fb3a9ba242667a9a4b079fe6426fde92d29e7f121116c0544062a3a16
+  metadata.gz: 04d2b18950f5d8c6b2bcfadb24dec58d50d7c2fd8997977506a79a22d24aeeef
+  data.tar.gz: f33be2af98f5a199b563eb78aef31518c94b304c1fd120985dc3ee2febee233f
 SHA512:
-  metadata.gz: 17c9ca468bb8ca4c20deb9387e3d85ff9c80281711f25cb87cdfbad22b733700a49ad5721e78b2169283d9178276434bef63974d250441de0297c3fbf4f698ea
-  data.tar.gz: 89db5416f295bdfa12c8545d1b613aad7a4fb235f2e4c6470f2a2d4968e663d23689e6ca529e0cdf59e1fdcc3b95ca2467b62e9b83a6cab8bcb0790a12c12663
+  metadata.gz: 1e9fd7e64a8c76c74351128fd63a25c1c56ce11351fc8cd4ce0e91ee793586ab71609ae247d3fa66615b089546887a330cb2eeec9550888ebbf9f8abb59b628d
+  data.tar.gz: bed4a30375077f6bfd35900f75976e9f960deb316421e113b65b33ad7d61f9084be427f5241c3700aa1d8fbd717d4104389855db71a43f60f846af58c3a6694b

data/bin/htmlproofer

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 STDOUT.sync = true
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
@@ -75,18 +77,24 @@ Mercenary.program(:htmlproofer) do |p|
     options[:error_sort] = opts['error-sort'].to_sym unless opts['error-sort'].nil?
     options[:log_level] = opts['log_level'].to_sym unless opts['log_level'].nil?
 
-    # FIXME: this is gross
-    options[:validation] = {}
-    options[:validation][:report_script_embeds] = opts['report_script_embeds']
-    options[:validation][:report_missing_names] = opts['report_missing_names']
-    options[:validation][:report_invalid_tags] = opts['report_invalid_tags']
+    options[:validation] = HTMLProofer::Configuration::VALIDATION_DEFAULTS.dup
+    options[:validation][:report_script_embeds] = opts['report_script_embeds'] unless opts['report_script_embeds'].nil?
+    options[:validation][:report_missing_names] = opts['report_missing_names'] unless opts['report_missing_names'].nil?
+    options[:validation][:report_invalid_tags] = opts['report_invalid_tags'] unless opts['report_invalid_tags'].nil?
 
-    options[:typhoeus] = {}
-    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'])
+    end
 
-    options[:cache] = {}
-    options[:cache][:timeframe] = opts['timeframe'] unless opts['timeframe'].nil?
-    options[:cache][:storage_dir] = opts['storage_dir'] unless opts['storage_dir'].nil?
+    unless opts['timeframe'].nil?
+      options[:cache] ||= {}
+      options[:cache][:timeframe] = opts['timeframe'] unless opts['timeframe'].nil?
+    end
+
+    unless opts['storage_dir'].nil?
+      options[:cache] ||= {}
+      options[:cache][:storage_dir] = opts['storage_dir'] unless opts['storage_dir'].nil?
+    end
 
     options[:http_status_ignore] = Array(options[:http_status_ignore]).map(&:to_i)
 

data/lib/html-proofer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def require_all(path)
   dir = File.join(File.dirname(__FILE__), path)
   Dir[File.join(dir, '*.rb')].each do |f|

data/lib/html-proofer/cache.rb

@@ -1,9 +1,8 @@
-require_relative 'utils'
+# frozen_string_literal: true
 
+require_relative 'utils'
+require 'date'
 require 'json'
-require 'active_support/core_ext/string'
-require 'active_support/core_ext/date'
-require 'active_support/core_ext/numeric/time'
 
 module HTMLProofer
   class Cache
@@ -18,6 +17,9 @@ module HTMLProofer
       @logger = logger
       @cache_log = {}
 
+      @cache_datetime = DateTime.now
+      @cache_time = @cache_datetime.to_time
+
       if options.nil? || options.empty?
         define_singleton_method('use_cache?') { false }
       else
@@ -25,12 +27,10 @@ module HTMLProofer
         setup_cache!(options)
         @parsed_timeframe = parsed_timeframe(options[:timeframe])
       end
-
-      @cache_time = Time.now
     end
 
     def within_timeframe?(time)
-      (@parsed_timeframe..@cache_time).cover?(time)
+      (@parsed_timeframe..@cache_time).cover?(Time.parse(time))
     end
 
     def urls
@@ -43,16 +43,16 @@ module HTMLProofer
 
     def parsed_timeframe(timeframe)
       time, date = timeframe.match(/(\d+)(\D)/).captures
-      time = time.to_f
+      time = time.to_i
       case date
       when 'M'
-        time.months.ago
+        time_ago(time, :months)
       when 'w'
-        time.weeks.ago
+        time_ago(time, :weeks)
       when 'd'
-        time.days.ago
+        time_ago(time, :days)
       when 'h'
-        time.hours.ago
+        time_ago(time, :hours)
       else
         raise ArgumentError, "#{date} is not a valid timeframe!"
       end
@@ -162,5 +162,20 @@ module HTMLProofer
       contents = File.read(cache_file)
       @cache_log = contents.empty? ? {} : JSON.parse(contents)
     end
+
+    private
+
+    def time_ago(measurement, unit)
+      case unit
+      when :months
+        @cache_datetime >> -measurement
+      when :weeks
+        @cache_datetime - measurement * 7
+      when :days
+        @cache_datetime - measurement
+      when :hours
+        @cache_datetime - Rational(measurement/24.0)
+      end.to_time
+    end
   end
 end

data/lib/html-proofer/check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTMLProofer
   # Mostly handles issue management and collecting of external URLs.
   class Check

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FaviconCheck < ::HTMLProofer::Check
   def run
     found = false
@@ -19,7 +21,7 @@ class FaviconCheck < ::HTMLProofer::Check
 
   def is_immediate_redirect?
     # allow any instant-redirect meta tag
-    @html.xpath("//meta[@http-equiv='refresh']").attribute('content').value.starts_with? '0;' rescue false
+    @html.xpath("//meta[@http-equiv='refresh']").attribute('content').value.start_with? '0;' rescue false
   end
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class HtmlCheck < ::HTMLProofer::Check
   SCRIPT_EMBEDS_MSG = /Element script embeds close tag/
   INVALID_TAG_MSG = /Tag ([\w\-:]+) invalid/

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ImageCheck < ::HTMLProofer::Check
   SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class LinkCheck < ::HTMLProofer::Check
   include HTMLProofer::Utils
 
@@ -44,7 +46,7 @@ class LinkCheck < ::HTMLProofer::Check
         check_sri(line, content) if @link.check_sri? && node.name == 'link'
         # we need to skip these for now; although the domain main be valid,
         # curl/Typheous inaccurately return 404s for some links. cc https://git.io/vyCFx
-        next if @link.try(:rel) == 'dns-prefetch'
+        next if @link.respond_to?(:rel) && @link.rel == 'dns-prefetch'
         add_to_external_urls(@link.href)
         next
       elsif !@link.internal? && !@link.exists?

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

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 class OpenGraphElement < ::HTMLProofer::Element
   attr_reader :src

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ScriptCheck < ::HTMLProofer::Check
   attr_reader :src
 

data/lib/html-proofer/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTMLProofer
   module Configuration
     require_relative 'version'

data/lib/html-proofer/element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'addressable/uri'
 require_relative './utils'
 
@@ -28,7 +30,7 @@ module HTMLProofer
 
       @html = check.html
 
-      parent_attributes = obj.ancestors.map { |a| a.try(:attributes) }
+      parent_attributes = obj.ancestors.map { |a| a.respond_to?(:attributes) && a.attributes }
       parent_attributes.pop # remove document at the end
       @parent_ignorable = parent_attributes.any? { |a| !a['data-proofer-ignore'].nil? }
 
@@ -54,7 +56,7 @@ module HTMLProofer
 
     def url
       return @url if defined?(@url)
-      @url = (@src || @srcset || @href || '').delete("\u200b")
+      @url = (@src || @srcset || @href || '').delete("\u200b").strip
       @url = Addressable::URI.join(base.attr('href') || '', url).to_s if base
       return @url if @check.options[:url_swap].empty?
       @url = swap(@url, @check.options[:url_swap])

data/lib/html-proofer/issue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTMLProofer
   class Issue
     attr_reader :path, :desc, :status, :line, :content

data/lib/html-proofer/log.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'yell'
-require 'colorized_string'
+require 'rainbow'
 
 module HTMLProofer
   class Log
@@ -17,7 +19,7 @@ module HTMLProofer
     def log(level, message)
       color = case level
               when :debug
-                :light_blue
+                :cyan
               when :info
                 :blue
               when :warn
@@ -35,7 +37,7 @@ module HTMLProofer
 
     def colorize(color, message)
       if $stdout.isatty && $stderr.isatty
-        ColorizedString.new(message).colorize(color)
+        Rainbow(message).send(color)
       else
         message
       end

data/lib/html-proofer/middleware.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module HTMLProofer
+  class Middleware
+
+    class InvalidHtmlError < StandardError
+      def initialize(failures)
+        @failures = failures
+      end
+
+      def message
+          "HTML Validation errors (skip by adding `?proofer-ignore` to URL): \n#{@failures.join("\n")}"
+      end
+    end
+
+    def self.options
+      @options ||= {
+        type:                :file,
+        allow_missing_href:  true, # Permitted in html5
+        allow_hash_href:     true,
+        check_external_hash: true,
+        check_html:          true,
+        url_ignore:          [/.*/], # Don't try to check local files exist
+      }
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    HTML_SIGNATURE = [
+      '<!DOCTYPE HTML',
+      '<HTML',
+      '<HEAD',
+      '<SCRIPT',
+      '<IFRAME',
+      '<H1',
+      '<DIV',
+      '<FONT',
+      '<TABLE',
+      '<A',
+      '<STYLE',
+      '<TITLE',
+      '<B',
+      '<BODY',
+      '<BR',
+      '<P',
+      '<!--'
+    ]
+
+    def call(env)
+      result = @app.call(env)
+      return result if env['REQUEST_METHOD'] != 'GET'
+      return result if env['QUERY_STRING'] =~ /proofer-ignore/
+      return result if result.first != 200
+      body = []
+      result.last.each { |e| body << e }
+
+      body = body.join('')
+      begin
+        html = body.lstrip
+      rescue
+        return result # Invalid encoding; it's not gonna be html.
+      end
+      if HTML_SIGNATURE.any? { |sig| html.upcase.start_with? sig }
+        parsed = HTMLProofer::Runner.new(
+          'response',
+          Middleware.options
+        ).check_parsed(
+          Nokogiri::HTML(Utils.clean_content(html)), 'response'
+        )
+
+        if parsed[:failures].length > 0
+          raise InvalidHtmlError.new(parsed[:failures])
+        end
+      end
+      result
+    end
+  end
+end

data/lib/html-proofer/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTMLProofer
   class Runner
     include HTMLProofer::Utils
@@ -90,9 +92,8 @@ module HTMLProofer
       end
     end
 
-    def check_path(path)
+    def check_parsed(html, path)
       result = { external_urls: {}, failures: [] }
-      html = create_nokogiri(path)
 
       @src = [@src] if @type == :file
 
@@ -112,6 +113,10 @@ module HTMLProofer
       result
     end
 
+    def check_path(path)
+      check_parsed create_nokogiri(path), path
+    end
+
     def validate_urls
       url_validator = HTMLProofer::UrlValidator.new(@logger, @external_urls, @options)
       @failures.concat(url_validator.run)

data/lib/html-proofer/url_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'typhoeus'
 require 'uri'
 require_relative './utils'
@@ -144,8 +146,12 @@ module HTMLProofer
       response_code = response.code
       response.body.gsub!("\x00", '')
 
-      debug_msg = "Received a #{response_code} for #{href}"
-      debug_msg << " in #{filenames.join(' ')}" unless filenames.nil?
+      if filenames.nil?
+        debug_msg = "Received a #{response_code} for #{href}"
+      else
+        debug_msg = "Received a #{response_code} for #{href}  in #{filenames.join(' ')}"
+      end
+
       @logger.log :debug, debug_msg
 
       return if @options[:http_status_ignore].include?(response_code)
@@ -179,13 +185,18 @@ module HTMLProofer
       body_doc = create_nokogiri(response.body)
 
       unencoded_hash = Addressable::URI.unescape(hash)
-      xpath = %(//*[@name="#{hash}"]|/*[@name="#{unencoded_hash}"]|//*[@id="#{hash}"]|//*[@id="#{unencoded_hash}"])
+      xpath = [%(//*[@name="#{hash}"]|/*[@name="#{unencoded_hash}"]|//*[@id="#{hash}"]|//*[@id="#{unencoded_hash}"])]
       # user-content is a special addition by GitHub.
       if URI.parse(href).host =~ /github\.com/i
-        xpath << %(|//*[@name="user-content-#{hash}"]|//*[@id="user-content-#{hash}"])
+        xpath << [%(//*[@name="user-content-#{hash}"]|//*[@id="user-content-#{hash}"])]
+        # when linking to a file on GitHub, like #L12-L34, only the first "L" portion
+        # will be identified as a linkable portion
+        if hash =~ /\A(L\d)+/
+          xpath << [%(//td[@id="#{Regexp.last_match[1]}"])]
+        end
       end
 
-      return unless body_doc.xpath(xpath).empty?
+      return unless body_doc.xpath(xpath.join('|')).empty?
 
       msg = "External link #{href} failed: #{effective_url} exists, but the hash '#{hash}' does not"
       add_external_issue(filenames, msg, response.code)

data/lib/html-proofer/utils.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 module HTMLProofer
   module Utils
     def pluralize(count, single, plural)
-      "#{count} " << (count == 1 ? single : plural)
+      "#{count} #{(count == 1 ? single : plural)}"
     end
 
     def create_nokogiri(path)

data/lib/html-proofer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HTMLProofer
-  VERSION = '3.10.1'.freeze
+  VERSION = '3.12.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.10.1
+  version: 3.12.1
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -109,27 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -143,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-github
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -290,6 +284,7 @@ files:
 - lib/html-proofer/element.rb
 - lib/html-proofer/issue.rb
 - lib/html-proofer/log.rb
+- lib/html-proofer/middleware.rb
 - lib/html-proofer/runner.rb
 - lib/html-proofer/url_validator.rb
 - lib/html-proofer/utils.rb
@@ -313,8 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image