html-proofer 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d69ea6f2eb74095372c3f46f5b0b40beb25d4c2
-  data.tar.gz: b788331194e898263a88a47f41c60f77a4f3051a
+  metadata.gz: cf114815adfcc6b231c9f8b119d2e5c02dee4738
+  data.tar.gz: 382848c036bf27e114796531c07c55c970f8b890
 SHA512:
-  metadata.gz: a98a1fd90173d4481caae3c2fa7b702e1d5ab04cd262f4c555d250b7ce4518e29bcb0f3cfba7cd33d88526389bd05f3665b3ebb6ca0a46404057fa01f7663c62
-  data.tar.gz: 603de7c0256dde6120f0cce01e4803768c09468c620a04d81d6b053bd3d66e72573bc8fbe33efa9597a090fcd3c9f8744826021829e1619fc35fdc584c8c7513
+  metadata.gz: be3e69485788801d9ce34e6374eee233b2fe91553fc8051bd8fc96fa1d22792aba37b2b06d44a50a31fb50f832730a883006282e08c52bd917c7da003465b3b5
+  data.tar.gz: 235a71993139147fa3a1909da8bfe25d23b1124fb9f5d4e676625650ed5a3b0381aa435957f5781284c386ab7365f425bc4099b784d0309b23f9761a9ae21939

data/bin/htmlproofer

@@ -59,7 +59,7 @@ Mercenary.program(:htmlproofer) do |p|
     unless opts['url_swap'].nil?
       options[:url_swap] = {}
       opts['url_swap'].each do |s|
-        splt = s.split(/(?<!\\):/,2)
+        splt = s.split(/(?<!\\):/, 2)
 
         re = splt[0].gsub(/\\:/, ':')
         string = splt[1].gsub(/\\:/, ':')

data/lib/html-proofer/check.rb

@@ -1,7 +1,7 @@
 module HTMLProofer
   # Mostly handles issue management and collecting of external URLs.
   class Check
-    attr_reader :node, :element, :src, :path, :options, :issues, :external_urls
+    attr_reader :node, :html, :element, :src, :path, :options, :issues, :external_urls
 
     def initialize(src, path, html, options)
       @src    = src
@@ -18,14 +18,14 @@ module HTMLProofer
     end
 
     def run
-      fail NotImplementedError, 'HTMLProofer::Check subclasses must implement #run'
+      raise NotImplementedError, 'HTMLProofer::Check subclasses must implement #run'
     end
 
-    def add_issue(desc, line: nil, status: -1)
-      @issues << Issue.new(@path, desc, line: line, status: status)
+    def add_issue(desc, line: nil, status: -1, content: nil)
+      @issues << Issue.new(@path, desc, line: line, status: status, content: content)
     end
 
-    def add_to_external_urls(url, _)
+    def add_to_external_urls(url)
       return if @external_urls[url]
       add_path_for_url(url)
     end

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

@@ -10,6 +10,6 @@ class FaviconCheck < ::HTMLProofer::Check
 
     return if found
 
-    add_issue 'no favicon specified'
+    add_issue('no favicon specified')
   end
 end

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

@@ -17,32 +17,33 @@ class ImageCheck < ::HTMLProofer::Check
     @html.css('img').each do |node|
       @img = create_element(node)
       line = node.line
+      content = node.content
 
       next if @img.ignore?
 
       # screenshot filenames should return because of terrible names
       if terrible_filename?
-        add_issue("image has a terrible filename (#{@img.url})", line: line)
+        add_issue("image has a terrible filename (#{@img.url})", line: line, content: content)
         next
       end
 
       # does the image exist?
       if missing_src?
-        add_issue('image has no src or srcset attribute', line: line)
+        add_issue('image has no src or srcset attribute', line: line, content: content)
       else
         if @img.remote?
-          add_to_external_urls(@img.url, line)
+          add_to_external_urls(@img.url)
         elsif !@img.exists?
-          add_issue("internal image #{@img.url} does not exist", line: line)
+          add_issue("internal image #{@img.url} does not exist", line: line, content: content)
         end
       end
 
       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)
+        add_issue("image #{@img.url} does not have an alt attribute", line: line, content: content)
       end
 
       if @img.check_img_http? && @img.scheme == 'http'
-        add_issue("image #{@img.url} uses the http scheme", line: line)
+        add_issue("image #{@img.url} uses the http scheme", line: line, content: content)
       end
     end
 

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

@@ -12,7 +12,8 @@ class LinkCheck < ::HTMLProofer::Check
   def run
     @html.css('a, link').each do |node|
       @link = create_element(node)
-      line = @node.line
+      line = node.line
+      content = node.to_s
 
       next if @link.ignore?
 
@@ -21,17 +22,17 @@ class LinkCheck < ::HTMLProofer::Check
 
       # is it even a valid URL?
       unless @link.valid?
-        add_issue("#{@link.href} is an invalid URL", line: line)
+        add_issue("#{@link.href} is an invalid URL", line: line, content: content)
         next
       end
 
-      check_schemes(@link, line)
+      check_schemes(@link, line, content)
 
       # is there even an href?
       if missing_href?
         # HTML5 allows dropping the href: http://git.io/vBX0z
         next if @html.internal_subset.name == 'html' && @html.internal_subset.external_id.nil?
-        add_issue('anchor has no href attribute', line: line)
+        add_issue('anchor has no href attribute', line: line, content: content)
         next
       end
 
@@ -39,66 +40,66 @@ class LinkCheck < ::HTMLProofer::Check
       next if @link.non_http_remote?
       # does the file even exist?
       if @link.remote?
-        add_to_external_urls(@link.href, line)
+        add_to_external_urls(@link.href)
         next
       elsif !@link.internal? && !@link.exists?
-        add_issue("internally linking to #{@link.href}, which does not exist", line: line)
+        add_issue("internally linking to #{@link.href}, which does not exist", line: line, content: content)
       end
 
       # does the local directory have a trailing slash?
       if @link.unslashed_directory? @link.absolute_path
-        add_issue("internally linking to a directory #{@link.absolute_path} without trailing slash", line: line)
+        add_issue("internally linking to a directory #{@link.absolute_path} without trailing slash", line: line, content: content)
         next
       end
 
       # verify the target hash
-      handle_hash(@link, line) if @link.hash
+      handle_hash(@link, line, content) if @link.hash
     end
 
     external_urls
   end
 
-  def check_schemes(link, line)
+  def check_schemes(link, line, content)
     case link.scheme
     when 'mailto'
-      handle_mailto(link, line)
+      handle_mailto(link, line, content)
     when 'tel'
-      handle_tel(link, line)
+      handle_tel(link, line, content)
     when 'http'
       return unless @options[:enforce_https]
-      add_issue("#{link.href} is not an HTTPS link", line: line)
+      add_issue("#{link.href} is not an HTTPS link", line: line, content: content)
     end
   end
 
-  def handle_mailto(link, line)
+  def handle_mailto(link, line, content)
     if link.path.empty?
-      add_issue("#{link.href} contains no email address", line: line)
+      add_issue("#{link.href} contains no email address", line: line, content: content)
     elsif !link.path.include?('@')
-      add_issue("#{link.href} contains an invalid email address", line: line)
+      add_issue("#{link.href} contains an invalid email address", line: line, content: content)
     end
   end
 
-  def handle_tel(link, line)
-    add_issue("#{link.href} contains no phone number", line: line) if link.path.empty?
+  def handle_tel(link, line, content)
+    add_issue("#{link.href} contains no phone number", line: line, content: content) if link.path.empty?
   end
 
-  def handle_hash(link, line)
+  def handle_hash(link, line, content)
     if link.internal?
       unless hash_check @html, link.hash
-        add_issue("linking to internal hash ##{link.hash} that does not exist", line: line)
+        add_issue("linking to internal hash ##{link.hash} that does not exist", line: line, content: content)
       end
     elsif link.external?
-      external_link_check(link, line)
+      external_link_check(link, line, content)
     end
   end
 
-  def external_link_check(link, line)
+  def external_link_check(link, line, content)
     if !link.exists?
-      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", line: line)
+      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", line: line, content: content)
     else
       target_html = create_nokogiri link.absolute_path
       unless hash_check target_html, link.hash
-        add_issue("linking to #{link.href}, but #{link.hash} does not exist", line: line)
+        add_issue("linking to #{link.href}, but #{link.hash} does not exist", line: line, content: content)
       end
     end
   end

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

@@ -9,17 +9,18 @@ class ScriptCheck < ::HTMLProofer::Check
     @html.css('script').each do |node|
       @script = create_element(node)
       line = node.line
+      content = node.content
 
       next if @script.ignore?
       next unless node.text.strip.empty?
 
       # does the script exist?
       if missing_src?
-        add_issue('script is empty and has no src attribute', line: line)
+        add_issue('script is empty and has no src attribute', line: line, content: content)
       elsif @script.remote?
-        add_to_external_urls(@script.src, line)
+        add_to_external_urls(@script.src)
       elsif !@script.exists?
-        add_issue("internal script #{@script.src} does not exist", line: line)
+        add_issue("internal script #{@script.src} does not exist", line: line, content: content)
       end
     end
 

data/lib/html-proofer/element.rb

@@ -22,6 +22,8 @@ module HTMLProofer
       @type = check.class.name
       @line = obj.line
 
+      @html = check.html
+
       # fix up missing protocols
       @href.insert 0, 'http:' if @href =~ %r{^//}
       @src.insert 0, 'http:' if @src =~ %r{^//}
@@ -29,9 +31,13 @@ module HTMLProofer
     end
 
     def url
-      url = (@src || @srcset || @href || '').gsub("\u200b", '')
-      return url if @check.options[:url_swap].empty?
-      swap(url, @check.options[:url_swap])
+      return @url if defined?(@url)
+      @url = (@src || @srcset || @href || '').gsub("\u200b", '')
+      if base
+        @url = Addressable::URI.join(base.attr('href'), url).to_s
+      end
+      return @url if @check.options[:url_swap].empty?
+      @url = swap(@url, @check.options[:url_swap])
     end
 
     def valid?
@@ -68,11 +74,11 @@ module HTMLProofer
     def ignore?
       return true if @data_proofer_ignore
 
-      return true if url.match(/^javascript:/)
+      return true if url =~ /^javascript:/
 
       # ignore base64 encoded images
       if %w(ImageCheck FaviconCheck).include? @type
-        return true if url.match(/^data:image/)
+        return true if url =~ /^data:image/
       end
 
       # ignore user defined URLs
@@ -166,5 +172,9 @@ module HTMLProofer
     def follow_location?
       @check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
     end
+
+    def base
+      @base ||= @html.at_css('base')
+    end
   end
 end

data/lib/html-proofer/issue.rb

@@ -1,12 +1,13 @@
 module HTMLProofer
   class Issue
-    attr_reader :path, :desc, :status, :line
+    attr_reader :path, :desc, :status, :line, :content
 
-    def initialize(path, desc, line: nil, status: -1)
+    def initialize(path, desc, line: nil, status: -1, content: nil)
       @line = line.nil? ? '' : " (line #{line})"
       @path = path
       @desc = desc
       @status = status
+      @content = content
     end
 
     def to_s
@@ -52,7 +53,11 @@ module HTMLProofer
         if first_report == :status
           @logger.log :error, "  *  #{issue}"
         else
-          @logger.log :error, "  *  #{issue.send(second_report)}#{issue.line}"
+          msg = "  *  #{issue.send(second_report)}#{issue.line}"
+          if !issue.content.nil? && !issue.content.empty?
+            msg = "#{msg}\n     #{issue.content}"
+          end
+          @logger.log(:error, msg)
         end
       end
     end

data/lib/html-proofer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary