html-proofer 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee04feecbb1a662c1c5023003314a6647292fd13
-  data.tar.gz: f01200df1a2f69ea90a2bb8cb49feac80bb4593b
+  metadata.gz: 6849cc3fcff2f9484b194cbeb1e6a74c5ce569df
+  data.tar.gz: a926c5b784dc04b8437b042b11fd96b9f2e0e822
 SHA512:
-  metadata.gz: aae793b1fd1d3672cba9a86557efad2b728dd4e09326076c24aeda5203fb03a6aa2600198ae50549d26712ffaf378d405e8f39121e9f0396d34d540f2f5a2c62
-  data.tar.gz: 0ecb402b29e2721ca83acc1b6582d4642954d2378ad0bb992fdfaa93e6d6a326c7199fad2c5056186bfc18b78bf94565f5375fb6f05e8dda69efd90c3108f804
+  metadata.gz: bc5fb91918a157a54496abc4340f4731507a393aca4da5ce21f2afd42c83d49b7636d48777acabb1542e4854944aa0242c798605b3966fb5e55ee805648736d3
+  data.tar.gz: 1d7b2107525185bcdc87647c958f71c00d0fa575665a852306de8f945fb18652ad467b76473d5255d1b11de5c101e164363984340385de47aee7cc5482a713ea

data/bin/htmlproofer

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 STDOUT.sync = true
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w( .. lib ))
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'html-proofer'
 require 'mercenary'
@@ -51,7 +51,7 @@ Mercenary.program(:htmlproofer) do |p|
     options = {}
 
     # prepare everything to go to proofer
-    p.options.select { |o| !opts[o.config_key].nil? }.each do |option|
+    p.options.reject { |o| opts[o.config_key].nil? }.each do |option|
       if opts[option.config_key].is_a?(Array)
         opts[option.config_key] = opts[option.config_key].map { |i| HTMLProofer::Configuration.to_regex?(i) }
       end

data/lib/html-proofer.rb

@@ -1,3 +1,5 @@
+# rubocop:disable Style/FileName
+
 def require_all(path)
   dir = File.join(File.dirname(__FILE__), path)
   Dir[File.join(dir, '*.rb')].each do |f|
@@ -16,32 +18,30 @@ begin
   require 'awesome_print'
   require 'pry'
 rescue LoadError; end
-
 module HTMLProofer
-
   def check_file(file, options = {})
-    fail ArgumentError unless file.is_a?(String)
+    raise ArgumentError unless file.is_a?(String)
     options[:type] = :file
     HTMLProofer::Runner.new(file, options)
   end
   module_function :check_file
 
   def check_directory(directory, options = {})
-    fail ArgumentError unless directory.is_a?(String)
+    raise ArgumentError unless directory.is_a?(String)
     options[:type] = :directory
     HTMLProofer::Runner.new([directory], options)
   end
   module_function :check_directory
 
   def check_directories(directories, options = {})
-    fail ArgumentError unless directories.is_a?(Array)
+    raise ArgumentError unless directories.is_a?(Array)
     options[:type] = :directory
     HTMLProofer::Runner.new(directories, options)
   end
   module_function :check_directories
 
   def check_links(links, options = {})
-    fail ArgumentError unless links.is_a?(Array)
+    raise ArgumentError unless links.is_a?(Array)
     options[:type] = :links
     HTMLProofer::Runner.new(links, options)
   end

data/lib/html-proofer/cache.rb

@@ -10,7 +10,7 @@ module HTMLProofer
     include HTMLProofer::Utils
 
     DEFAULT_STORAGE_DIR = File.join('tmp', '.htmlproofer')
-    DEFAULT_CACHE_FILE_NAME = "cache.log"
+    DEFAULT_CACHE_FILE_NAME = 'cache.log'.freeze
 
     attr_reader :exists, :cache_log, :storage_dir, :cache_file
 
@@ -54,17 +54,17 @@ module HTMLProofer
       when 'h'
         time.hours.ago
       else
-        fail ArgumentError, "#{date} is not a valid timeframe!"
+        raise ArgumentError, "#{date} is not a valid timeframe!"
       end
     end
 
     def add(url, filenames, status, msg = '')
       data = {
-                :time => @cache_time,
-                :filenames => filenames,
-                :status => status,
-                :message => msg
-             }
+        time: @cache_time,
+        filenames: filenames,
+        status: status,
+        message: msg
+      }
 
       @cache_log[clean_url(url)] = data
     end
@@ -148,28 +148,25 @@ module HTMLProofer
     end
 
     def setup_cache!(options)
-      if options[:storage_dir]
-        @storage_dir = options[:storage_dir]
-      else
-        @storage_dir = DEFAULT_STORAGE_DIR
-      end
+      @storage_dir = if options[:storage_dir]
+                       options[:storage_dir]
+                     else
+                       DEFAULT_STORAGE_DIR
+                     end
 
-      if !Dir.exist?(storage_dir)
-        FileUtils.mkdir_p(storage_dir)
-      end
+      FileUtils.mkdir_p(storage_dir) unless Dir.exist?(storage_dir)
 
-      if options[:cache_file]
-        cache_file_name = options[:cache_file]
-      else
-        cache_file_name = DEFAULT_CACHE_FILE_NAME
-      end
+      cache_file_name = if options[:cache_file]
+                          options[:cache_file]
+                        else
+                          DEFAULT_CACHE_FILE_NAME
+                        end
 
       @cache_file = File.join(storage_dir, cache_file_name)
 
-      if File.exist?(cache_file)
-        contents = File.read(cache_file)
-        @cache_log = contents.empty? ? {} : JSON.parse(contents)
-      end
+      return unless File.exist?(cache_file)
+      contents = File.read(cache_file)
+      @cache_log = contents.empty? ? {} : JSON.parse(contents)
     end
   end
 end

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

@@ -30,12 +30,10 @@ class ImageCheck < ::HTMLProofer::Check
       # does the image exist?
       if missing_src?
         add_issue('image has no src or srcset attribute', line: line, content: content)
-      else
-        if @img.remote?
-          add_to_external_urls(@img.url)
-        elsif !@img.exists?
-          add_issue("internal image #{@img.url} does not exist", line: line, content: content)
-        end
+      elsif @img.remote?
+        add_to_external_urls(@img.url)
+      elsif !@img.exists?
+        add_issue("internal image #{@img.url} does not exist", line: line, content: content)
       end
 
       if !@img.ignore_alt? && (@img.alt.nil? || (empty_alt_tag? && !@img.ignore_empty_alt?))

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

@@ -40,6 +40,7 @@ class LinkCheck < ::HTMLProofer::Check
       next if @link.non_http_remote?
 
       if !@link.internal? && @link.remote?
+        check_sri(line, content) if @link.check_sri?
         # 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'
@@ -107,18 +108,36 @@ class LinkCheck < ::HTMLProofer::Check
 
   def hash_check(html, href_hash)
     decoded_href_hash = URI.decode(href_hash)
-    href_hash = "'#{href_hash.split("'").join("', \"'\", '")}', ''"
-    decoded_href_hash = "'#{decoded_href_hash.split("'").join("', \"'\", '")}', ''"
-    html.xpath("//*[case_insensitive_equals(@id, concat(#{href_hash}))]", \
-               "//*[case_insensitive_equals(@name, concat(#{href_hash}))]", \
-               "//*[case_insensitive_equals(@id, concat(#{decoded_href_hash}))]", \
-               "//*[case_insensitive_equals(@name, concat(#{decoded_href_hash}))]", \
-               XpathFunctions.new).length > 0
+    fragment_ids = [href_hash, decoded_href_hash]
+    fragment_ids.include?('top') || !find_fragments(html, fragment_ids).empty?
+  end
+
+  def find_fragments(html, fragment_ids)
+    xpaths = fragment_ids.flat_map do |frag_id|
+      escaped_frag_id = "'#{frag_id.split("'").join("', \"'\", '")}', ''"
+      [
+        "//*[case_insensitive_equals(@id, concat(#{escaped_frag_id}))]",
+        "//*[case_insensitive_equals(@name, concat(#{escaped_frag_id}))]"
+      ]
+    end
+    xpaths << XpathFunctions.new
+
+    html.xpath(*xpaths)
+  end
+
+  def check_sri(line, content)
+    if !defined?(@link.integrity) && !defined?(@link.crossorigin)
+      add_issue("SRI and CORS not provided in: #{@link.src}", line: line, content: content)
+    elsif !defined?(@link.integrity)
+      add_issue("Integrity is missing in: #{@link.src}", line: line, content: content)
+    elsif !defined?(@link.crossorigin)
+      add_issue("CORS not provided for external resource in: #{@link.src}", line: line, content: content)
+    end
   end
 
   class XpathFunctions
     def case_insensitive_equals(node_set, str_to_match)
-      node_set.find_all {|node| node.to_s.downcase == str_to_match.to_s.downcase }
+      node_set.find_all { |node| node.to_s.casecmp(str_to_match.to_s.downcase).zero? }
     end
   end
 end

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

@@ -2,12 +2,12 @@
 
 class OpenGraphElement < ::HTMLProofer::Element
   attr_reader :src
-  
+
   def initialize(obj, check)
     super(obj, check)
     # Fake up src from the content attribute
-    instance_variable_set("@src", @content)
-    
+    instance_variable_set('@src', @content)
+
     @src.insert 0, 'http:' if @src =~ %r{^//}
   end
 end
@@ -16,11 +16,11 @@ class OpenGraphCheck < ::HTMLProofer::Check
   def missing_src?
     !@opengraph.src
   end
-  
+
   def empty_src?
     blank?(@opengraph.src)
   end
-  
+
   def run
     @html.css('meta[property="og:url"], meta[property="og:image"]').each do |m|
       @opengraph = OpenGraphElement.new(m, self)

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

@@ -19,17 +19,17 @@ class ScriptCheck < ::HTMLProofer::Check
         add_issue('script is empty and has no src attribute', line: line, content: content)
       elsif @script.remote?
         add_to_external_urls(@script.src)
+        check_sri(line, content) if @script.check_sri?
       elsif !@script.exists?
         add_issue("internal script #{@script.src} does not exist", line: line, content: content)
       end
-      check_sri(line, content) if @script.check_sri?
     end
 
     external_urls
   end
 
   def check_sri(line, content)
-    if !defined? @script.integrity and !defined? @script.crossorigin
+    if !defined? @script.integrity && !defined? @script.crossorigin
       add_issue("SRI and CORS not provided in: #{@script.src}", line: line, content: content)
     elsif !defined? @script.integrity
       add_issue("Integrity is missing in: #{@script.src}", line: line, content: content)

data/lib/html-proofer/configuration.rb

@@ -3,54 +3,54 @@ module HTMLProofer
     require_relative 'version'
 
     PROOFER_DEFAULTS = {
-      :allow_hash_href => false,
-      :alt_ignore => [],
-      :assume_extension => false,
-      :check_external_hash => false,
-      :check_favicon => false,
-      :check_html => false,
-      :check_img_http => false,
-      :check_opengraph => false,
-      :checks_to_ignore => [],
-      :check_sri => false,
-      :directory_index_file => 'index.html',
-      :disable_external => false,
-      :empty_alt_ignore => false,
-      :enforce_https => false,
-      :error_sort => :path,
-      :extension => '.html',
-      :external_only => false,
-      :file_ignore => [],
-      :http_status_ignore => [],
-      :internal_domains => [],
-      :log_level => :info,
-      :only_4xx => false,
-      :url_ignore => [],
-      :url_swap => {}
-    }
+      allow_hash_href: false,
+      alt_ignore: [],
+      assume_extension: false,
+      check_external_hash: false,
+      check_favicon: false,
+      check_html: false,
+      check_img_http: false,
+      check_opengraph: false,
+      checks_to_ignore: [],
+      check_sri: false,
+      directory_index_file: 'index.html',
+      disable_external: false,
+      empty_alt_ignore: false,
+      enforce_https: false,
+      error_sort: :path,
+      extension: '.html',
+      external_only: false,
+      file_ignore: [],
+      http_status_ignore: [],
+      internal_domains: [],
+      log_level: :info,
+      only_4xx: false,
+      url_ignore: [],
+      url_swap: {}
+    }.freeze
 
     TYPHOEUS_DEFAULTS = {
-      :followlocation => true,
-      :headers => {
+      followlocation: true,
+      headers: {
         'User-Agent' => "Mozilla/5.0 (compatible; HTML Proofer/#{HTMLProofer::VERSION}; +https://github.com/gjtorikian/html-proofer)"
       },
-      :connecttimeout => 10,
-      :timeout => 30
-    }
+      connecttimeout: 10,
+      timeout: 30
+    }.freeze
 
     HYDRA_DEFAULTS = {
-      :max_concurrency => 50
-    }
+      max_concurrency: 50
+    }.freeze
 
-    PARALLEL_DEFAULTS = {}
+    PARALLEL_DEFAULTS = {}.freeze
 
     VALIDATION_DEFAULTS = {
-      :report_script_embeds => false,
-      :report_missing_names => false,
-      :report_invalid_tags => false
-    }
+      report_script_embeds: false,
+      report_missing_names: false,
+      report_invalid_tags: false
+    }.freeze
 
-    CACHE_DEFAULTS = {}
+    CACHE_DEFAULTS = {}.freeze
 
     def self.to_regex?(item)
       if item.start_with?('/') && item.end_with?('/')

data/lib/html-proofer/element.rb

@@ -11,12 +11,12 @@ module HTMLProofer
     def initialize(obj, check)
       # Construct readable ivars for every element
       obj.attributes.each_pair do |attribute, value|
-        name = "#{attribute.tr('-:.', '_')}".to_sym
+        name = attribute.tr('-:.', '_').to_s.to_sym
         (class << self; self; end).send(:attr_reader, name)
         instance_variable_set("@#{name}", value.value)
       end
 
-      @aria_hidden = @aria_hidden == "true" ? true : false
+      @aria_hidden = @aria_hidden == 'true' ? true : false
 
       @text = obj.content
       @check = check
@@ -28,7 +28,7 @@ module HTMLProofer
 
       parent_attributes = obj.ancestors.map { |a| a.try(:attributes) }
       parent_attributes.pop # remove document at the end
-      @parent_ignorable = parent_attributes.any? { |a| !a["data-proofer-ignore"].nil? }
+      @parent_ignorable = parent_attributes.any? { |a| !a['data-proofer-ignore'].nil? }
 
       # fix up missing protocols
       @href.insert 0, 'http:' if @href =~ %r{^//}
@@ -38,10 +38,8 @@ module HTMLProofer
 
     def url
       return @url if defined?(@url)
-      @url = (@src || @srcset || @href || '').gsub("\u200b", '')
-      if base
-        @url = Addressable::URI.join(base.attr('href'), url).to_s
-      end
+      @url = (@src || @srcset || @href || '').delete("\u200b")
+      @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])
     end
@@ -70,7 +68,7 @@ module HTMLProofer
 
     # path is to an external server
     def remote?
-      %w( http https ).include? scheme
+      %w[http https].include? scheme
     end
 
     def non_http_remote?
@@ -84,7 +82,7 @@ module HTMLProofer
       return true if url =~ /^javascript:/
 
       # ignore base64 encoded images
-      if %w(ImageCheck FaviconCheck).include? @type
+      if %w[ImageCheck FaviconCheck].include? @type
         return true if url =~ /^data:image/
       end
 
@@ -201,14 +199,12 @@ module HTMLProofer
     end
 
     def html
-      if internal?
-        # If link is on the same page, then URL is on the current page so can use the same HTML as for current page
-        if hash_link || param_link
-          @html
-        elsif slash_link
-          # link on another page, e.g. /about#Team - need to get HTML from the other page
-          create_nokogiri(absolute_path)
-        end
+      # If link is on the same page, then URL is on the current page so can use the same HTML as for current page
+      if (hash_link || param_link) && internal?
+        @html
+      elsif slash_link && internal?
+        # link on another page, e.g. /about#Team - need to get HTML from the other page
+        create_nokogiri(absolute_path)
       end
     end
   end

data/lib/html-proofer/log.rb

@@ -6,11 +6,11 @@ module HTMLProofer
     include Yell::Loggable
 
     def initialize(log_level)
-      @logger = Yell.new(:format => false, \
-                         :name => 'HTMLProofer', \
-                         :level => "gte.#{log_level}") do |l|
-        l.adapter :stdout, :level => [:debug, :info, :warn]
-        l.adapter :stderr, :level => [:error, :fatal]
+      @logger = Yell.new(format: false, \
+                         name: 'HTMLProofer', \
+                         level: "gte.#{log_level}") do |l|
+        l.adapter :stdout, level: %i[debug info warn]
+        l.adapter :stderr, level: %i[error fatal]
       end
     end
 

data/lib/html-proofer/runner.rb

@@ -91,7 +91,7 @@ module HTMLProofer
     end
 
     def check_path(path)
-      result = { :external_urls => {}, :failures => [] }
+      result = { external_urls: {}, failures: [] }
       html = create_nokogiri(path)
 
       @src = [@src] if @type == :file
@@ -164,7 +164,7 @@ module HTMLProofer
       sorted_failures.sort_and_report
       count = @failures.length
       failure_text = pluralize(count, 'failure', 'failures')
-      fail @logger.colorize :red, "HTML-Proofer found #{failure_text}!"
+      raise @logger.colorize :red, "HTML-Proofer found #{failure_text}!"
     end
   end
 end

data/lib/html-proofer/url_validator.rb

@@ -123,7 +123,7 @@ module HTMLProofer
     def clean_url(href)
       # catch any obvious issues, like strings in port numbers
       parsed = Addressable::URI.parse(href)
-      if href !~ %r{^([!#$&-;=?-\[\]_a-z~]|%[0-9a-fA-F]{2})+$}
+      if href !~ /^([!#{$&}-;=?-\[\]_a-z~]|%[0-9a-fA-F]{2})+$/
         parsed.normalize
       else
         href
@@ -131,7 +131,7 @@ module HTMLProofer
     end
 
     def queue_request(method, href, filenames)
-      opts = @options[:typhoeus].merge({ :method => method })
+      opts = @options[:typhoeus].merge(method: method)
       request = Typhoeus::Request.new(href, opts)
       request.on_complete { |response| response_handler(response, filenames) }
       @hydra.queue request
@@ -179,7 +179,7 @@ module HTMLProofer
 
       # user-content is a special addition by GitHub.
       xpath = %(//*[@name="#{hash}"]|//*[@id="#{hash}"])
-      if URI.parse(href).host.match(/github\.com/i)
+      if URI.parse(href).host =~ /github\.com/i
         xpath << %(|//*[@name="user-content-#{hash}"]|//*[@id="user-content-#{hash}"])
       end
 

data/lib/html-proofer/utils.rb

@@ -7,11 +7,11 @@ module HTMLProofer
     end
 
     def create_nokogiri(path)
-      if File.exist? path
-        content = File.open(path).read
-      else
-        content = path
-      end
+      content = if File.exist? path
+                  File.open(path).read
+                else
+                  path
+                end
 
       Nokogiri::HTML(clean_content(content))
     end

data/lib/html-proofer/version.rb

@@ -1,3 +1,3 @@
 module HTMLProofer
-  VERSION = '3.6.0'.freeze
+  VERSION = '3.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-github
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -272,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A set of tests to validate your HTML output. These tests check if your image