html-proofer 2.4.2 → 2.5.0

data/lib/html/proofer/checks/favicon.rb

@@ -1,21 +1,21 @@
 # encoding: utf-8
 
 class FaviconCheckable < ::HTML::Proofer::Checkable
-  def rel
-    @rel
-  end
+  attr_reader :rel
 end
 
 class FaviconCheck < ::HTML::Proofer::CheckRunner
-
   def run
-    @html.xpath('//link[not(ancestor::pre or ancestor::code)]').each do |favicon|
-      favicon = FaviconCheckable.new favicon, self
+    found = false
+    @html.xpath('//link[not(ancestor::pre or ancestor::code)]').each do |node|
+      favicon = FaviconCheckable.new(node, self)
       next if favicon.ignore?
-      return if favicon.rel.split(' ').last.eql? 'icon'
+      found = true if favicon.rel.split(' ').last.eql? 'icon'
+      break if found
     end
 
+    return if found
+
     add_issue 'no favicon specified'
   end
-
 end

data/lib/html/proofer/checks/html.rb

@@ -27,16 +27,18 @@ class HtmlCheck < ::HTML::Proofer::CheckRunner
                   rect set stop switch symbol text textPath tref tspan use
                   view vkern)
 
+  SCRIPT_EMBEDS_MSG = /Element script embeds close tag/
+
   def run
-    @html.errors.each do |e|
-      message = e.message
-      line    = e.line
+    @html.errors.each do |error|
+      message = error.message
+      line    = error.line
       # Nokogiri (or rather libxml2 underhood) only recognizes html4 tags,
       # so we need to skip errors caused by the new tags in html5
       next if HTML5_TAGS.include? message[/Tag ([\w-]+) invalid/o, 1]
 
       # tags embedded in scripts are used in templating languages: http://git.io/vOovv
-      next if @validation_opts[:ignore_script_embeds] && message =~ /Element script embeds close tag/
+      next if @validation_opts[:ignore_script_embeds] && message =~ SCRIPT_EMBEDS_MSG
 
       add_issue(message, line)
     end

data/lib/html/proofer/checks/images.rb

@@ -1,12 +1,9 @@
 # encoding: utf-8
 
 class ImageCheckable < ::HTML::Proofer::Checkable
-
   SCREEN_SHOT_REGEX = /Screen(?: |%20)Shot(?: |%20)\d+-\d+-\d+(?: |%20)at(?: |%20)\d+.\d+.\d+/
 
-  def alt
-    @alt
-  end
+  attr_reader :alt
 
   def empty_alt_tag?
     alt.strip.empty?
@@ -23,32 +20,32 @@ class ImageCheckable < ::HTML::Proofer::Checkable
   def missing_src?
     !src
   end
-
 end
 
 class ImageCheck < ::HTML::Proofer::CheckRunner
   def run
-    @html.css('img').each do |i|
-      img = ImageCheckable.new i, self
+    @html.css('img').each do |node|
+      img = ImageCheckable.new(node, self)
+      line = node.line
 
       next if img.ignore?
 
       # screenshot filenames should return because of terrible names
-      next add_issue("image has a terrible filename (#{img.src})", i.line) if img.terrible_filename?
+      next add_issue("image has a terrible filename (#{img.src})", line) if img.terrible_filename?
 
       # does the image exist?
       if img.missing_src?
-        add_issue('image has no src or srcset attribute', i.line)
+        add_issue('image has no src or srcset attribute', line)
       else
         if img.remote?
-          add_to_external_urls img.src
+          add_to_external_urls(img.src, line)
         else
-          add_issue("internal image #{img.src} does not exist", i.line) unless img.exists?
+          add_issue("internal image #{img.src} does not exist", line) unless img.exists?
         end
       end
 
       if img.alt.nil? || (img.empty_alt_tag? && !img.ignore_empty_alt?)
-        add_issue("image #{img.src} does not have an alt attribute", i.line)
+        add_issue("image #{img.src} does not have an alt attribute", line)
       end
     end
 

data/lib/html/proofer/checks/links.rb

@@ -19,15 +19,15 @@ class LinkCheckable < ::HTML::Proofer::Checkable
   def placeholder?
     (id || name) && href.nil?
   end
-
 end
 
 class LinkCheck < ::HTML::Proofer::CheckRunner
-  include HTML::Utils
+  include HTML::Proofer::Utils
 
   def run
-    @html.css('a, link').each do |l|
-      link = LinkCheckable.new l, self
+    @html.css('a, link').each do |node|
+      link = LinkCheckable.new(node, self)
+      line = node.line
 
       next if link.ignore?
       next if link.href =~ /^javascript:/ # can't put this in ignore? because the URI does not parse
@@ -35,24 +35,15 @@ class LinkCheck < ::HTML::Proofer::CheckRunner
 
       # is it even a valid URL?
       unless link.valid?
-        add_issue("#{link.href} is an invalid URL", l.line)
+        add_issue("#{link.href} is an invalid URL", line)
         next
       end
 
-      case link.scheme
-      when 'mailto'
-        if link.path.empty?
-          add_issue("#{link.href} contains no email address", l.line)
-        elsif !link.path.include?('@')
-          add_issue("#{link.href} contains an invalid email address", l.line)
-        end
-      when 'tel'
-        add_issue("#{link.href} contains no phone number", l.line) if link.path.empty?
-      end
+      check_schemes(link, line)
 
       # is there even a href?
       if link.missing_href?
-        add_issue('anchor has no href attribute', l.line)
+        add_issue('anchor has no href attribute', line)
         next
       end
 
@@ -61,47 +52,71 @@ class LinkCheck < ::HTML::Proofer::CheckRunner
 
       # does the file even exist?
       if link.remote?
-        add_to_external_urls link.href
+        add_to_external_urls(link.href, line)
         next
       elsif !link.internal?
-        add_issue("internally linking to #{link.href}, which does not exist", l.line) unless link.exists?
+        add_issue("internally linking to #{link.href}, which does not exist", line) unless link.exists?
       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", l.line)
+        add_issue("internally linking to a directory #{link.absolute_path} without trailing slash", line)
         next
       end
 
       # verify the target hash
-      if link.hash
-        if link.internal?
-          unless hash_check @html, link.hash
-            add_issue("linking to internal hash ##{link.hash} that does not exist", l.line)
-          end
-        elsif link.external?
-          external_link_check(link)
-        end
-      end
+      handle_hash(link, line) if link.hash
     end
 
     external_urls
   end
 
-  def external_link_check(link)
+  def check_schemes(link, line)
+    case link.scheme
+    when 'mailto'
+      handle_mailto(link, line)
+    when 'tel'
+      handle_tel(link, line)
+    end
+  end
+
+  def handle_mailto(link, line)
+    if link.path.empty?
+      add_issue("#{link.href} contains no email address", line)
+    elsif !link.path.include?('@')
+      add_issue("#{link.href} contains an invalid email address", line)
+    end
+  end
+
+  def handle_tel(link, line)
+    add_issue("#{link.href} contains no phone number", line) if link.path.empty?
+  end
+
+  def handle_hash(link, line)
+    if link.internal?
+      unless hash_check @html, link.hash
+        add_issue("linking to internal hash ##{link.hash} that does not exist", line)
+      end
+    elsif link.external?
+      external_link_check(link, line)
+    end
+  end
+
+  def external_link_check(link, line)
     if !link.exists?
-      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", link.line)
+      add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", line)
     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", link.line)
+        add_issue("linking to #{link.href}, but #{link.hash} does not exist", line)
       end
     end
   end
 
   def hash_check(html, href_hash)
     html.xpath("//*[case_insensitive_equals(@id, '#{href_hash}')]", \
-               "//*[case_insensitive_equals(@name, '#{href_hash}')]", HTML::Proofer::XpathFunctions.new).length > 0
+               "//*[case_insensitive_equals(@name, '#{href_hash}')]", \
+               HTML::Proofer::XpathFunctions.new).length > 0
   end
 
 end

data/lib/html/proofer/checks/scripts.rb

@@ -18,19 +18,20 @@ end
 
 class ScriptCheck < ::HTML::Proofer::CheckRunner
   def run
-    @html.css('script').each do |s|
-      script = ScriptCheckable.new s, self
+    @html.css('script').each do |node|
+      script = ScriptCheckable.new(node, self)
+      line = node.line
 
       next if script.ignore?
       next unless script.blank?
 
       # does the script exist?
       if script.missing_src?
-        add_issue('script is empty and has no src attribute', s.line)
+        add_issue('script is empty and has no src attribute', line)
       elsif script.remote?
-        add_to_external_urls script.src
+        add_to_external_urls(script.src, line)
       else
-        add_issue("internal script #{script.src} does not exist", s.line) unless script.exists?
+        add_issue("internal script #{script.src} does not exist", line) unless script.exists?
       end
     end
 

data/lib/html/proofer/log.rb

@@ -6,8 +6,12 @@ module HTML
     class Log
       include Yell::Loggable
 
-      def initialize(verbose)
-        log_level = verbose ? :debug : :info
+      def initialize(verbose, verbosity = nil)
+        log_level = if verbosity.nil?
+                      verbose ? :debug : :info
+                    else
+                      verbosity
+                    end
 
         @logger = Yell.new(:format => false, \
                            :name => 'HTML::Proofer', \

data/lib/html/proofer/url_validator.rb

@@ -5,7 +5,7 @@ require_relative './utils'
 module HTML
   class Proofer
     class UrlValidator
-      include Utils
+      include HTML::Proofer::Utils
 
       attr_accessor :logger, :external_urls, :hydra
 
@@ -74,6 +74,7 @@ module HTML
         href = response.request.base_url.to_s
         method = response.request.options[:method]
         response_code = response.code
+
         debug_msg = "Received a #{response_code} for #{href}"
         debug_msg << " in #{filenames.join(' ')}" unless filenames.nil?
         logger.log :debug, :yellow, debug_msg
@@ -87,7 +88,7 @@ module HTML
         else
           return if @options[:only_4xx] && !response_code.between?(400, 499)
           # Received a non-successful http response.
-          add_failed_tests filenames, "External link #{href} failed: #{response_code} #{response.return_message}", response_code
+          add_external_issue(filenames, "External link #{href} failed: #{response_code} #{response.return_message}", response_code)
         end
       end
 
@@ -108,15 +109,15 @@ module HTML
 
         return unless body_doc.xpath(xpath).empty?
 
-        add_failed_tests filenames, "External link #{href} failed: #{effective_url} exists, but the hash '#{hash}' does not", response.code
+        add_external_issue filenames, "External link #{href} failed: #{effective_url} exists, but the hash '#{hash}' does not", response.code
       end
 
       def handle_timeout(href, filenames, response_code)
         return if @options[:only_4xx]
-        add_failed_tests filenames, "External link #{href} failed: got a time out", response_code
+        add_external_issue filenames, "External link #{href} failed: got a time out", response_code
       end
 
-      def add_failed_tests(filenames, desc, status = nil)
+      def add_external_issue(filenames, desc, status = nil)
         if filenames.nil?
           @failed_tests << CheckRunner::Issue.new('', desc, nil, status)
         else
@@ -129,7 +130,6 @@ module HTML
       rescue URI::InvalidURIError
         nil
       end
-
     end
   end
 end

data/lib/html/proofer/utils.rb

@@ -1,24 +1,26 @@
 require 'nokogiri'
 
 module HTML
-  module Utils
-    def create_nokogiri(path)
-      if File.exist? path
-        content = File.open(path).read
-      else
-        content = path
-      end
+  class Proofer
+    module Utils
+      def create_nokogiri(path)
+        if File.exist? path
+          content = File.open(path).read
+        else
+          content = path
+        end
 
-      Nokogiri::HTML(content)
-    end
-    module_function :create_nokogiri
+        Nokogiri::HTML(content)
+      end
+      module_function :create_nokogiri
 
-    def swap(href, replacement)
-      replacement.each do |link, replace|
-        href = href.gsub(link, replace)
+      def swap(href, replacement)
+        replacement.each do |link, replace|
+          href = href.gsub(link, replace)
+        end
+        href
       end
-      href
+      module_function :swap
     end
-    module_function :swap
   end
 end

data/lib/html/proofer/version.rb

@@ -1,5 +1,5 @@
 module HTML
   class Proofer
-    VERSION = '2.4.2'
+    VERSION = '2.5.0'
   end
 end

data/spec/html/proofer/fixtures/links/check_just_once.html

@@ -0,0 +1,8 @@
+<a href="https://github.com/contact?form%5Bsubject%5D=New+Assigned+Events">First</a>
+
+<a href="https://github.com/contact?form%5Bsubject%5D=Organization+and+Team+Membership+APIs">Ignored</a>
+
+<a href="https://github.com/contact#false?form%5Bsubject%5D=Organization+and+Team+Membership+APIs">Second, because of hash</a>
+
+
+<a href="https://github.com/contact?form%5Bsubject%5D=Blah+and+blah+blah+APIs">Ignored</a>

data/spec/html/proofer/fixtures/vcr_cassettes/links/check_just_once_html.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: head
+    uri: https://github.com/contact#false?form%5Bsubject%5D=Organization+and+Team+Membership+APIs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Mozilla/5.0 (compatible; HTML Proofer/2.4.2; +https://github.com/gjtorikian/html-proofer)
+  response:
+    status:
+      code: 0
+      message: 
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+    adapter_metadata:
+      effective_url: https://github.com/contact
+  recorded_at: Fri, 04 Sep 2015 21:28:18 GMT
+- request:
+    method: head
+    uri: https://github.com/contact?form%5Bsubject%5D=New+Assigned+Events
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Mozilla/5.0 (compatible; HTML Proofer/2.4.2; +https://github.com/gjtorikian/html-proofer)
+  response:
+    status:
+      code: 0
+      message: 
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+    adapter_metadata:
+      effective_url: https://github.com/contact?form%5Bsubject%5D=New+Assigned+Events
+  recorded_at: Fri, 04 Sep 2015 21:28:18 GMT
+- request:
+    method: get
+    uri: https://github.com/contact#false?form%5Bsubject%5D=Organization+and+Team+Membership+APIs
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Mozilla/5.0 (compatible; HTML Proofer/2.4.2; +https://github.com/gjtorikian/html-proofer)
+  response:
+    status:
+      code: 0
+      message: 
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+    adapter_metadata:
+      effective_url: https://github.com/contact
+  recorded_at: Fri, 04 Sep 2015 21:28:18 GMT
+- request:
+    method: get
+    uri: https://github.com/contact?form%5Bsubject%5D=New+Assigned+Events
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Mozilla/5.0 (compatible; HTML Proofer/2.4.2; +https://github.com/gjtorikian/html-proofer)
+  response:
+    status:
+      code: 0
+      message: 
+    headers: {}
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+    adapter_metadata:
+      effective_url: https://github.com/contact?form%5Bsubject%5D=New+Assigned+Events
+  recorded_at: Fri, 04 Sep 2015 21:28:18 GMT
+recorded_with: VCR 2.9.3