html-proofer 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8e32513d55bbc3b6fe0b8b238199fa0270c13a4
-  data.tar.gz: 6b1f6264dae93f15f2e09e4542e2f7b5d6ffff3c
+  metadata.gz: ee04feecbb1a662c1c5023003314a6647292fd13
+  data.tar.gz: f01200df1a2f69ea90a2bb8cb49feac80bb4593b
 SHA512:
-  metadata.gz: b9f3c3a6028eb2eae4b3fb0f999702c80c06b3a89a6a715ee7f1d5b09d12b50ca47bd739c8696d1b6ff531f647afa3b85d1ee29c04fb0c81fa5e60896787661f
-  data.tar.gz: b5eaa5f478efd12a53161a91218da9661a979dfe91cd1ba2873b365ec94ec0c9b2f9d8202befacb062c92da6820cd83a914e54fa9c83046a12648ba11b862337
+  metadata.gz: aae793b1fd1d3672cba9a86557efad2b728dd4e09326076c24aeda5203fb03a6aa2600198ae50549d26712ffaf378d405e8f39121e9f0396d34d540f2f5a2c62
+  data.tar.gz: 0ecb402b29e2721ca83acc1b6582d4642954d2378ad0bb992fdfaa93e6d6a326c7199fad2c5056186bfc18b78bf94565f5375fb6f05e8dda69efd90c3108f804

data/bin/htmlproofer

@@ -27,7 +27,7 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'directory_index_file', '--directory-index-file', String, 'Sets the file to look for when a link refers to a directory. (default: `index.html`)'
   p.option 'disable_external', '--disable-external', 'If `true`, does not run the external link checker, which can take a lot of time (default: `false`)'
   p.option 'empty_alt_ignore', '--empty-alt-ignore', 'If `true`, ignores images with empty alt tags'
-  p.option 'error_sort', '--error-sort SORT', 'Defines the sort order for error output. Can be `:path`, `:desc`, or `:status` (default: `path`).'
+  p.option 'error_sort', '--error-sort SORT', 'Defines the sort order for error output. Can be `:path`, `:desc`, or `:status` (default: `:path`).'
   p.option 'enforce_https', '--enforce-https', 'Fails a link if it\'s not marked as `https` (default: `false`).'
   p.option 'extension', '--extension EXT', String, 'The extension of your HTML files including the dot. (default: `.html`)'
   p.option 'external_only', '--external_only', 'Only checks problems with external references'
@@ -36,12 +36,13 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'report_invalid_tags', '--report-invalid-tags', 'Ignore `check_html` errors associated with unknown markup (default: `false`)'
   p.option 'report_missing_names', '--report-missing-names', 'Ignore `check_html` errors associated with missing entities (default: `false`)'
   p.option 'report_script_embeds', '--report-script-embeds', 'Ignore `check_html` errors associated with `script`s (default: `false`)'
-  p.option 'log_level', '--log-level <level>', String, 'Sets the logging level, as determined by Yell'
+  p.option 'log_level', '--log-level <level>', String, 'Sets the logging level, as determined by Yell. One of `:debug`, `:info`, `:warn`, `:error`, or `:fatal`. (default: `:info`)'
   p.option 'only_4xx', '--only-4xx', 'Only reports errors for links that fall within the 4xx status code range'
   p.option 'timeframe', '--timeframe <time>', String, 'A string representing the caching timeframe.'
   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 'internal_domains', '--internal-domains domain1,[domain2,...]', Array, 'A comma-separated list of Strings containing domains that will be treated as internal urls.'
+  p.option 'storage_dir', '--storage-dir PATH', String, 'Directory where to store the cache log (default: "tmp/.htmlproofer")'
 
   p.action do |args, opts|
     args = ['.'] if args.empty?
@@ -80,6 +81,7 @@ Mercenary.program(:htmlproofer) do |p|
 
     options[:cache] = {}
     options[:cache][:timeframe] = opts['timeframe'] unless opts['timeframe'].nil?
+    options[:cache][:storage_dir] = opts['storage_dir'] unless opts['storage_dir'].nil?
 
     options[:http_status_ignore] = Array(options[:http_status_ignore]).map(&:to_i)
 

data/lib/html-proofer/cache.rb

@@ -9,9 +9,10 @@ module HTMLProofer
   class Cache
     include HTMLProofer::Utils
 
-    CACHE_LOG = File.join(STORAGE_DIR, 'cache.log')
+    DEFAULT_STORAGE_DIR = File.join('tmp', '.htmlproofer')
+    DEFAULT_CACHE_FILE_NAME = "cache.log"
 
-    attr_reader :exists, :cache_log
+    attr_reader :exists, :cache_log, :storage_dir, :cache_file
 
     def initialize(logger, options)
       @logger = logger
@@ -21,15 +22,11 @@ module HTMLProofer
         define_singleton_method('use_cache?') { false }
       else
         define_singleton_method('use_cache?') { true }
+        setup_cache!(options)
         @parsed_timeframe = parsed_timeframe(options[:timeframe])
       end
 
       @cache_time = Time.now
-
-      if File.exist?(CACHE_LOG)
-        contents = File.read(CACHE_LOG)
-        @cache_log = contents.empty? ? {} : JSON.parse(contents)
-      end
     end
 
     def within_timeframe?(time)
@@ -111,7 +108,7 @@ module HTMLProofer
     end
 
     def write
-      File.write(CACHE_LOG, @cache_log.to_json)
+      File.write(cache_file, @cache_log.to_json)
     end
 
     def load?
@@ -149,5 +146,30 @@ module HTMLProofer
     def clean_url(url)
       slashless_url(unescape_url(url))
     end
+
+    def setup_cache!(options)
+      if options[:storage_dir]
+        @storage_dir = options[:storage_dir]
+      else
+        @storage_dir = DEFAULT_STORAGE_DIR
+      end
+
+      if !Dir.exist?(storage_dir)
+        FileUtils.mkdir_p(storage_dir)
+      end
+
+      if options[:cache_file]
+        cache_file_name = options[:cache_file]
+      else
+        cache_file_name = 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
+    end
   end
 end

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

@@ -107,10 +107,12 @@ class LinkCheck < ::HTMLProofer::Check
 
   def hash_check(html, href_hash)
     decoded_href_hash = URI.decode(href_hash)
-    html.xpath("//*[case_insensitive_equals(@id, '#{href_hash}')]", \
-               "//*[case_insensitive_equals(@name, '#{href_hash}')]", \
-               "//*[case_insensitive_equals(@id, '#{decoded_href_hash}')]", \
-               "//*[case_insensitive_equals(@name, '#{decoded_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
   end
 

data/lib/html-proofer/configuration.rb

@@ -33,7 +33,9 @@ module HTMLProofer
       :followlocation => true,
       :headers => {
         'User-Agent' => "Mozilla/5.0 (compatible; HTML Proofer/#{HTMLProofer::VERSION}; +https://github.com/gjtorikian/html-proofer)"
-      }
+      },
+      :connecttimeout => 10,
+      :timeout => 30
     }
 
     HYDRA_DEFAULTS = {

data/lib/html-proofer/runner.rb

@@ -19,10 +19,6 @@ module HTMLProofer
       @type = @options.delete(:type)
       @logger = HTMLProofer::Log.new(@options[:log_level])
 
-      if !@options[:cache].empty? && !File.exist?(STORAGE_DIR)
-        FileUtils.mkdir_p(STORAGE_DIR)
-      end
-
       # Add swap patterns for internal domains
       unless @options[:internal_domains].empty?
         @options[:internal_domains].each do |dom|

data/lib/html-proofer/utils.rb

@@ -2,8 +2,6 @@ require 'nokogiri'
 
 module HTMLProofer
   module Utils
-    STORAGE_DIR = File.join('tmp', '.htmlproofer')
-
     def pluralize(count, single, plural)
       "#{count} " << (count == 1 ? single : plural)
     end

data/lib/html-proofer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-04 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary