html-proofer 3.0.6 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b26505bd1c7a6f0632a95f2bb1718ae9e2bae90f
-  data.tar.gz: c8cbb29407b3eedcd997f8e9226323c6e4a55dc3
+  metadata.gz: 2d69ea6f2eb74095372c3f46f5b0b40beb25d4c2
+  data.tar.gz: b788331194e898263a88a47f41c60f77a4f3051a
 SHA512:
-  metadata.gz: 1432ff5ff5ad2c0eeb1ef40b66f46608f0d737e39474f2e8185614ca6ede77af17fd4dd1893fa86fa12bf2c6f9c2c12b19a5713044b99cc705f2a43e236e57be
-  data.tar.gz: 0f1a23a1534ef863223808efb54dcb493ebb04a51a1793fd25f3875d89e891a19e8beea085791947bee5791a93baa68f4dc2048406acc71b822477b28cef7d6a
+  metadata.gz: a98a1fd90173d4481caae3c2fa7b702e1d5ab04cd262f4c555d250b7ce4518e29bcb0f3cfba7cd33d88526389bd05f3665b3ebb6ca0a46404057fa01f7663c62
+  data.tar.gz: 603de7c0256dde6120f0cce01e4803768c09468c620a04d81d6b053bd3d66e72573bc8fbe33efa9597a090fcd3c9f8744826021829e1619fc35fdc584c8c7513

data/bin/htmlproofer

@@ -18,9 +18,10 @@ Mercenary.program(:htmlproofer) do |p|
   p.option 'alt_ignore', '--alt-ignore image1,[image2,...]', Array, 'A comma-separated list of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore'
   p.option 'assume_extension', '--assume-extension', 'Automatically add extension (e.g. `.html`) to file paths, to allow extensionless URLs (as supported by Jekyll 3 and GitHub Pages) (default: `false`).'
   p.option 'checks_to_ignore', '--checks-to-ignore check1,[check2,...]', Array, ' An array of Strings indicating which checks you\'d like to not perform.'
-  p.option 'check_external_hash', '--check-external-hash', 'Checks whether external hashes exist (even if the website exists). This slows the checker down (default: `false`).'
+  p.option 'check_external_hash', '--check-external-hash', 'Checks whether external hashes exist (even if the webpage exists). This slows the checker down (default: `false`).'
   p.option 'check_favicon', '--check-favicon', 'Enables the favicon checker (default: `false`).'
   p.option 'check_html', '--check-html', 'Enables HTML validation errors from Nokogiri (default: `false`).'
+  p.option 'check_img_http', '--check-img-http', 'Fails an image if it\'s marked as `http` (default: `false`).'
   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'
@@ -37,7 +38,8 @@ Mercenary.program(:htmlproofer) do |p|
   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`.'
+  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.action do |args, opts|
     args = ['.'] if args.empty?
@@ -47,7 +49,7 @@ Mercenary.program(:htmlproofer) do |p|
 
     # prepare everything to go to proofer
     p.options.select { |o| !opts[o.config_key].nil? }.each do |option|
-      if option.return_type.to_s == 'Array' # TODO: is_a? doesn't work here?
+      if opts[option.config_key].is_a?(Array)
         opts[option.config_key] = opts[option.config_key].map { |i| HTMLProofer::Configuration.to_regex?(i) }
       end
       options[option.config_key.to_sym] = opts[option.config_key]
@@ -57,8 +59,11 @@ Mercenary.program(:htmlproofer) do |p|
     unless opts['url_swap'].nil?
       options[:url_swap] = {}
       opts['url_swap'].each do |s|
-        pair = s.split(':', 2)
-        options[:url_swap][Regexp.new(pair[0])] = pair[1]
+        splt = s.split(/(?<!\\):/,2)
+
+        re = splt[0].gsub(/\\:/, ':')
+        string = splt[1].gsub(/\\:/, ':')
+        options[:url_swap][Regexp.new(re)] = string
       end
     end
 
@@ -73,7 +78,7 @@ Mercenary.program(:htmlproofer) do |p|
 
     options[:cache] = {}
     options[:cache][:timeframe] = opts['timeframe'] unless opts['timeframe'].nil?
-    
+
     options[:http_status_ignore] = Array(options[:http_status_ignore]).map(&:to_i)
 
     paths = path.split(',')

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

@@ -40,6 +40,10 @@ class ImageCheck < ::HTMLProofer::Check
       if !@img.ignore_alt? && (@img.alt.nil? || (empty_alt_tag? && !@img.ignore_empty_alt?))
         add_issue("image #{@img.url} does not have an alt attribute", line: line)
       end
+
+      if @img.check_img_http? && @img.scheme == 'http'
+        add_issue("image #{@img.url} uses the http scheme", line: line)
+      end
     end
 
     external_urls

data/lib/html-proofer/configuration.rb

@@ -9,6 +9,7 @@ module HTMLProofer
       :check_external_hash => false,
       :check_favicon => false,
       :check_html => false,
+      :check_img_http => false,
       :checks_to_ignore => [],
       :directory_index_file => 'index.html',
       :disable_external => false,
@@ -19,10 +20,11 @@ module HTMLProofer
       :external_only => false,
       :file_ignore => [],
       :http_status_ignore => [],
+      :internal_domains => [],
       :log_level => :info,
       :only_4xx => false,
       :url_ignore => [],
-      :url_swap => []
+      :url_swap => {}
     }
 
     TYPHOEUS_DEFAULTS = {

data/lib/html-proofer/element.rb

@@ -9,7 +9,7 @@ module HTMLProofer
     attr_reader :id, :name, :alt, :href, :link, :src, :line, :data_proofer_ignore
 
     def initialize(obj, check)
-      # Contruct readable ivars for every element
+      # Construct readable ivars for every element
       obj.attributes.each_pair do |attribute, value|
         name = "#{attribute.tr('-:.', '_')}".to_sym
         (class << self; self; end).send(:attr_reader, name)
@@ -91,6 +91,10 @@ module HTMLProofer
       @check.options[:allow_hash_href]
     end
 
+    def check_img_http?
+      @check.options[:check_img_http]
+    end
+
     # path is external to the file
     def external?
       !internal?

data/lib/html-proofer/runner.rb

@@ -23,6 +23,15 @@ module HTMLProofer
         FileUtils.mkdir_p(STORAGE_DIR)
       end
 
+      # Add swap patterns for internal domains
+      unless @options[:internal_domains].empty?
+        @options[:internal_domains].each do |dom|
+          @options[:url_swap][Regexp.new("^http://#{dom}")] = ''
+          @options[:url_swap][Regexp.new("^https://#{dom}")] = ''
+          @options[:url_swap][Regexp.new("^//#{dom}")] = ''
+        end
+      end
+
       @failures = []
     end
 

data/lib/html-proofer/version.rb

@@ -1,3 +1,3 @@
 module HTMLProofer
-  VERSION = '3.0.6'
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.1.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -112,16 +112,22 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement