html-proofer 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f817c1ae8d770d45dd99985fc84bb54f7c0749f7
-  data.tar.gz: d673641ab131ef192b2de800f7acd9b018939f36
+  metadata.gz: 4158a32821a881ebd52b68d22058614bf593cdb3
+  data.tar.gz: 9fd06100599bb970ac6e1f62e8f5ffcf3c761e31
 SHA512:
-  metadata.gz: 501fda80a1d0185ed11f68d52c590e0afa5542d6d14be3da21d829ee5a941eea5892505680de183753c9c2ab38eb06304da8a56c53705f0b7c94010cd7c9b4bc
-  data.tar.gz: 80efd9f43797a5708f1a226ab7965749f73a83a897ecc6ca84a17c01f53b8bd135f04b199af85edc021383ed28933f96842e5e83840fdb48bbfa868731643e1f
+  metadata.gz: 345e1cd5381f31064f52429b91252ffc85b013daefcb4c83ea717ca4cf607e02b75c8b652ac9a53add7269a10870bc9e7a4e80afd30e4516de8506e6c723ebf0
+  data.tar.gz: c51bd43c8cfd5ddd20834932e68686f41d00bebd85151f82c8a8588ed51a2105fcd2353dd0cec5fefe643213f56876efc3787ccde1a06d5a99b7a9d68fd29f05

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-### In a script
+### Using in a script
 
 Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on
 your output folder; then `run` it. Here's a simple example:
@@ -54,7 +54,7 @@ end
 HTML::Proofer.new("./out").run
 ```
 
-### Usage on the command-line
+### Using on the command-line
 
 You'll get a new program called `htmlproof` with this gem. Jawesome!
 
@@ -67,7 +67,7 @@ htmlproof run ./out --swap wow:cow,mow:doh --ext .html.erb --ignore www.github.c
 Note: since `swap` is a bit special, you'll pass in a pair of `RegEx:String` values.
 `htmlproof` will figure out what you mean.
 
-## Usage with Jekyll
+### Using with Jekyll
 
 Want to use HTML Proofer with your Jekyll site? Awesome. Simply add `gem 'html-proofer'`
 to your `Gemfile` as described above, and add the following to your `Rakefile`,
@@ -104,6 +104,7 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 * `:href_swap`: a hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`.
 * `:href_ignore`: an array of Strings or RegExps containing `href`s that are safe to ignore (`mailto` is always ignored)
 * `:disable_external`: if `true`, does not run the external link checker, which can take a lot of time (default: `false`)
+* `:verbose`: if `true`, outputs extra information as the checking happens. Useful for debugging. (default: `false`)
 
 You can also pass in any of Typhoeus' options for the external link check. For example:
 
@@ -113,6 +114,41 @@ HTML::Proofer.new("out/", {:ext => ".htm", :verbose = > true, :ssl_verifyhost =>
 
 This sets `HTML::Proofer`'s' extensions to use _.htm_, and gives Typhoeus a configurtion for it to be verbose, and use specific SSL settings. Check [the Typhoeus documentation](https://github.com/typhoeus/typhoeus#other-curl-options) for more information on what options it can receive.
 
-## Ignoring links
+## Ignoring content
+
+Add the `data-proofer-ignore` attribute to any `<a>` or `<img>` tag to ignore it from the checks.
+
+## Custom tests
+
+Want to write your own test? Sure! Just create two classes--one that inherits from `HTML::Proofer::Checkable`, and another that inherits from `HTML::Proofer::Checks::Check`. `Checkable` defines various helper methods for your test, while `Checks::Check` actually runs across your content. `Checks::Check` should call `self.add_issue` on failures, to add them to the list.
+
+Here's an example custom test that protects against `mailto` links:
+
+``` ruby
+class OctocatLink < ::HTML::Proofer::Checkable
+
+  def mailto?
+    return false if @data_ignore_proofer || @href.nil? || @href.empty?
+    return @href.match /^mailto\:/
+  end
+
+  def octocat?
+    return @href.match /\:octocat@github.com\Z/
+  end
+
+end
+
+class MailToOctocat < ::HTML::Proofer::Checks::Check
+
+  def run
+    @html.css('a').each do |l|
+      link = OctocatLink.new l, "octocat_link", self
+
+      if link.mailto? && link.octocat?
+        return self.add_issue("Don't email the Octocat directly!")
+      end
+    end
+  end
+end
+```
 
-To any `<a>` or `<img>` tag, you may add the `data-proofer-ignore` attribute to ignore the link.

data/bin/htmlproof

@@ -15,9 +15,10 @@ Mercenary.program(:htmlproof) do |p|
   p.description "Runs the HTML-Proofer suite on the files in PATH"
 
   p.option 'ext', '--ext EXT', 'The extension of your HTML files (default: `.html`)'
-  p.option 'swap', '--swap regex:string,[regex:string,...]', 'Array containing key-value pairs of `RegExp:String`. It transforms links that match `RegExp` into `String`'
-  p.option 'ignore', '--ignore link1,[link2,...]', 'Array of Strings containing `href`s that are safe to ignore (default: `mailto`)'
+  p.option 'swap', '--swap regex:string,[regex:string,...]', Array, 'Array containing key-value pairs of `RegExp:String`. It transforms links that match `RegExp` into `String`'
+  p.option 'ignore', '--ignore link1,[link2,...]', Array, 'Array of Strings containing `href`s that are safe to ignore (default: `mailto`)'
   p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
+  p.option 'verbose', '--verbose', 'Enables more verbose logging.'
 
   p.action do |args, opts|
     args = ["."] if args.empty?
@@ -34,6 +35,7 @@ Mercenary.program(:htmlproof) do |p|
     end
     options[:href_ignore] = opts["ignore"] unless opts["ignore"].nil?
     options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
+    options[:verbose] = opts["verbose"] unless opts["verbose"].nil?
 
     HTML::Proofer.new(path, options).run
   end

data/html-proofer.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = "html-proofer"
-  gem.version       = "0.6.7"
+  gem.version       = "0.6.8"
   gem.authors       = ["Garen Torikian"]
   gem.email         = ["gjtorikian@gmail.com"]
   gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}
@@ -19,8 +19,10 @@ Gem::Specification.new do |gem|
   gem.add_dependency "nokogiri",        "~> 1.6.0"
   gem.add_dependency "colored",         "~> 1.2"
   gem.add_dependency "typhoeus",        "~> 0.6.7"
+  gem.add_dependency "yell",            "~> 2.0"
 
-  gem.add_development_dependency "html-pipeline", "~> 0.0.12"
+  gem.add_development_dependency "html-pipeline", "~> 1.8"
+  gem.add_development_dependency "escape_utils", "~> 1.0" # Ruby 2.1 fix
   gem.add_development_dependency "rspec", "~> 2.13.0"
   gem.add_development_dependency "rake"
 end

data/lib/html/proofer.rb

@@ -1,30 +1,39 @@
 require 'nokogiri'
+require 'yell'
 
 require File.dirname(__FILE__) + '/proofer/checkable'
 require File.dirname(__FILE__) + '/proofer/checks'
 
 module HTML
   class Proofer
+    include Yell::Loggable
+
     def initialize(src, opts={})
       @srcDir = src
 
-      @proofer_opts = {:ext => ".html", :href_swap => [], :href_ignore => [], :disable_external => false }
+      @proofer_opts = {:ext => ".html", :href_swap => [], :href_ignore => [], :disable_external => false, :verbose => false }
       @options = @proofer_opts.merge({:followlocation => true}).merge(opts)
 
       @failed_tests = []
+
+      Yell.new({ :format => false, :name => "HTML::Proofer", :level => "gte.#{log_level}" }) do |l|
+        l.adapter :stdout, level: [:debug, :info, :warn]
+        l.adapter :stderr, level: [:error, :fatal]
+      end
     end
 
     def run
       total_files = 0
       external_urls = {}
 
-      puts "Running #{get_checks} checks on #{@srcDir} on *#{@options[:ext]}... \n\n"
+      logger.info "Running #{get_checks} checks on #{@srcDir} on *#{@options[:ext]}... \n\n".white
 
       files.each do |path|
         total_files += 1
         html = HTML::Proofer.create_nokogiri(path)
 
         get_checks.each do |klass|
+          logger.debug "Checking #{klass.to_s.downcase} on #{path} ...".blue
           check = klass.new(@srcDir, path, html, @options)
           check.run
           external_urls.merge!(check.external_urls)
@@ -40,31 +49,34 @@ module HTML
       external_urls = Hash[external_urls.sort]
 
       unless @options[:disable_external]
-        puts "Checking #{external_urls.length} external links... \n\n"
+        logger.info "Checking #{external_urls.length} external links...".yellow
 
         # Typhoeus won't let you pass any non-Typhoeus option
         @proofer_opts.each_key do |opt|
           @options.delete opt
         end
 
+        Ethon.logger = logger # log from Typhoeus/Ethon
+
         external_urls.each_pair do |href, filenames|
           request = Typhoeus::Request.new(href, @options.merge({:method => :head}))
           request.on_complete { |response| response_handler(response, filenames) }
           hydra.queue request
         end
+        logger.debug "Running requests for all #{hydra.queued_requests.size} external URLs...".yellow
         hydra.run
       end
 
-      puts "Ran on #{total_files} files!"
+      logger.info "Ran on #{total_files} files!\n\n".green
 
       if @failed_tests.empty?
-        puts "HTML-Proofer finished successfully.".green
+        logger.info "HTML-Proofer finished successfully.".green
       else
         @failed_tests.each do |issue|
-          $stderr.puts issue + "\n\n"
+          logger.error (issue + "\n\n").red
         end
 
-        raise "HTML-Proofer found #{@failed_tests.length} failures!"
+        raise "HTML-Proofer found #{@failed_tests.length} failures!".red
       end
     end
 
@@ -73,6 +85,8 @@ module HTML
       method = response.request.options[:method]
       response_code = response.code
 
+      logger.debug "Received a #{response_code} for #{href} in #{filenames.join(' ')}"
+
       if response_code.between?(200, 299)
         # continue with no op
       elsif response.timed_out?
@@ -114,5 +128,9 @@ module HTML
     def get_checks
       HTML::Proofer::Checks::Check.subclasses
     end
+
+    def log_level
+      @options[:verbose] ? :debug : :info
+    end
   end
 end

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ def capture_stderr(&block)
   rescue RuntimeError
   ensure
     $stderr = original_stderr
-    # $stdout = original_stdout
+    $stdout = original_stdout
   end
   fake_err.string
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html-proofer
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -66,20 +66,48 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.7
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: html-pipeline
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement