html-proofer 3.10.1 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b785a108ad8a82bdc21dbc428240bcba1b77ac3a0a5cf08d0de68bac11583e5
-  data.tar.gz: 52f4c91fb3a9ba242667a9a4b079fe6426fde92d29e7f121116c0544062a3a16
+  metadata.gz: 03572c9956b3d257f19ce6b0692164a4bb18ced1351d05dfa79e3f218504e271
+  data.tar.gz: 92f19a6d0ecf5a5f298d1d6aa2df02c4d788d48e4348d28064d5edba32bb9f15
 SHA512:
-  metadata.gz: 17c9ca468bb8ca4c20deb9387e3d85ff9c80281711f25cb87cdfbad22b733700a49ad5721e78b2169283d9178276434bef63974d250441de0297c3fbf4f698ea
-  data.tar.gz: 89db5416f295bdfa12c8545d1b613aad7a4fb235f2e4c6470f2a2d4968e663d23689e6ca529e0cdf59e1fdcc3b95ca2467b62e9b83a6cab8bcb0790a12c12663
+  metadata.gz: ae17c5d646967fc246d0e2661f7c2fc45d1e07321db23a6cd3cf33398e2e675a825b59325154cd9bd249f2e949c4b3351845e260663591dc14aa9fa05d66f867
+  data.tar.gz: c8a7518a4d75224aa18a7ec617bfeb8b302592d4b07259bdd711690558a9d98cbf541c9b92765871dbded8ee32a8cba1524fd29e632c56f8d1b4c132efba7875

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')

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,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'utils'
 
 require 'json'

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

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
 

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'
 
@@ -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.starts_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.11.0'.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.11.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !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
@@ -157,7 +157,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-github
+  name: rubocop-standard
+  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: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -290,6 +304,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