Refactor html-proofer

Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec

README.md

@@ -22,6 +22,43 @@ Or install it yourself as:
 
 **NOTE:** When installation speed matters, set `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true` in your environment. This is useful for increasing the speed of your Continuous Integration builds.
 
+## Real-life examples
+
+Project | Repository
+:--- | :---
+[Raspberry Pi documentation](http://www.raspberrypi.org/documentation/) | [raspberrypi/documentation]( https://github.com/raspberrypi/documentation)
+[Open Whisper Systems website](https://whispersystems.org/) | [WhisperSystems/whispersystems.org](https://github.com/WhisperSystems/whispersystems.org)
+[Jekyll website](http://jekyllrb.com/) | [jekyll/jekyll](https://github.com/jekyll/jekyll)
+
+## What's Tested?
+
+### Images
+
+`img` elements:
+
+* Whether all your images have alt tags
+* Whether your internal image references are not broken
+* Whether external images are showing
+
+### Links
+
+`a`, `link` elements:
+
+* Whether your internal links are not broken; this includes hash references (`#linkToMe`)
+* Whether external links are working
+
+### Scripts
+
+`script` elements:
+
+* Whether your internal script references are not broken
+* Whether external scripts are loading
+
+### HTML
+
+Nokogiri looks at the markup and [provides errors](http://www.nokogiri.org/tutorials/ensuring_well_formed_markup.html) when parsing your document.
+This is an optional feature, set the `validate_html` option to enable validation errors from Nokogiri.
+
 ## Usage
 
 ### Using in a script
@@ -90,43 +127,6 @@ Don't have or want a `Rakefile`? You _could_ also do something like the followin
 htmlproof ./_site
 ```
 
-### Real-life examples
-
-Project | Repository
-:--- | :---
-[Raspberry Pi documentation](http://www.raspberrypi.org/documentation/) | [raspberrypi/documentation]( https://github.com/raspberrypi/documentation)
-[Open Whisper Systems website](https://whispersystems.org/) | [WhisperSystems/whispersystems.org](https://github.com/WhisperSystems/whispersystems.org)
-[Jekyll website](http://jekyllrb.com/) | [jekyll/jekyll](https://github.com/jekyll/jekyll)
-
-## What's Tested?
-
-### Images
-
-`img` elements:
-
-* Whether all your images have alt tags
-* Whether your internal image references are not broken
-* Whether external images are showing
-
-### Links
-
-`a`, `link` elements:
-
-* Whether your internal links are not broken; this includes hash references (`#linkToMe`)
-* Whether external links are working
-
-### Scripts
-
-`script` elements:
-
-* Whether your internal script references are not broken
-* Whether external scripts are loading
-
-### HTML
-
-Nokogiri looks at the markup and [provides errors](http://www.nokogiri.org/tutorials/ensuring_well_formed_markup.html) when parsing your document.
-This is an optional feature, set the `validate_html` option to enable validation errors from Nokogiri.
-
 ## Configuration
 
 The `HTML::Proofer` constructor takes an optional hash of additional options:
@@ -147,16 +147,18 @@ The `HTML::Proofer` constructor takes an optional hash of additional options:
 | `validate_html` | Enables HTML validation errors from Nokogiri | `false` |
 | `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` |
 
-### Configuring Typhoeus
+### Configuring Typhoeus and Hydra
 
 You can also pass in any of Typhoeus' options for the external link check. For example:
 
 ``` ruby
-HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2 })
+HTML::Proofer.new("out/", {:ext => ".htm", :typhoeus => { :verbose => true, :ssl_verifyhost => 2 } })
 ```
 
 This sets `HTML::Proofer`'s extensions to use _.htm_, and gives Typhoeus a configuration 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.
 
+You can similarly pass in a `:hydra` option with a hash configuration for Hydra.
+
 ### Configuring Parallel
 
 [Parallel](https://github.com/grosser/parallel) is being used to speed things up a bit. You can pass in any of its options with the options "namespace" `:parallel`. For example:
@@ -185,14 +187,23 @@ bin/htmlproof www.google.com,www.github.com --as-links
 
 Add the `data-proofer-ignore` attribute to any tag to ignore it from the checks.
 
+
+``` html
+<a href="http://notareallink" data-proofer-ignore>Not checked.</a>
+```
+
 ## 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.
+Want to write your own test? Sure! Just create two classes--one that inherits from `HTML::Proofer::Runner`, and another that inherits from `HTML::Proofer::Checkable`.
+
+The `Runner` subclass must define one method called `run`. This is called on your content, and is responsible for performing the validation on whatever elements you like. When you catch a broken issue, call `add_issue(message)` to explain the error.
+
+The `Checkable` subclass defines various helper methods you can use as part of your test. Usually, you'll want to instantiate it within `run`. You have access to all of your element's attributes.
 
 Here's an example custom test that protects against `mailto` links that point to `octocat@github.com`:
 
 ``` ruby
-class OctocatLink < ::HTML::Proofer::Checkable
+class OctocatLinkCheck < ::HTML::Proofer::Checkable
 
   def mailto?
     return false if @data_ignore_proofer || @href.nil? || @href.empty?
@@ -205,14 +216,14 @@ class OctocatLink < ::HTML::Proofer::Checkable
 
 end
 
-class MailToOctocat < ::HTML::Proofer::Checks::Check
+class MailToOctocat < ::HTML::Proofer::Runner
 
   def run
     @html.css('a').each do |l|
-      link = OctocatLink.new l, "octocat_link", self
+      link = OctocatLinkCheck.new l, "octocat_link", self
 
       if link.mailto? && link.octocat?
-        return self.add_issue("Don't email the Octocat directly!")
+        return add_issue("Don't email the Octocat directly!")
       end
     end
   end

Rakefile

@@ -12,12 +12,10 @@ task :proof_readme do
   require 'redcarpet'
 
   redcarpet = Redcarpet::Markdown.new Redcarpet::Render::HTML.new({}), {}
-  html = redcarpet.render File.open("README.md").read
+  html = redcarpet.render File.read('README.md')
 
-  mkdir_p "out"
-  File.open "out/README.html", File::CREAT|File::WRONLY do |file|
-    file.puts html
-  end
+  mkdir_p 'out'
+  File.write('out/README.html', html)
 
-  HTML::Proofer.new("./out").run
+  HTML::Proofer.new('./out').run
 end

bin/htmlproof

@@ -1,18 +1,18 @@
 #!/usr/bin/env ruby
 STDOUT.sync = true
 
-$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w( .. lib ))
 
 require 'html/proofer'
 require 'mercenary'
-require "rubygems"
+require 'rubygems'
 
 Mercenary.program(:htmlproof) do |p|
-  p.version Gem::Specification::load(File.join(File.dirname(__FILE__), "..", "html-proofer.gemspec")).version
-  p.description "Test your rendered HTML files to make sure they're accurate."
+  p.version Gem::Specification.load(File.join(File.dirname(__FILE__), '..', 'html-proofer.gemspec')).version
+  p.description %(Test your rendered HTML files to make sure they're accurate.)
   p.syntax 'htmlproof PATH [options]'
 
-  p.description "Runs the HTML-Proofer suite on the files in PATH"
+  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 'favicon', '--favicon', 'Enables the favicon checker (default: `false`).'
@@ -29,31 +29,31 @@ Mercenary.program(:htmlproof) do |p|
   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.action do |args, opts|
-    args = ["."] if args.empty?
+    args = ['.'] if args.empty?
     path = args.first
 
     options = {}
-    options[:ext] = opts["ext"] unless opts["ext"].nil?
-    unless opts["swap"].nil?
+    options[:ext] = opts['ext'] unless opts['ext'].nil?
+    unless opts['swap'].nil?
       options[:href_swap] = {}
-      opts["swap"].each do |s|
-        pair = s.split(":")
-        options[:href_swap][%r{#{pair[0]}}] = pair[1]
+      opts['swap'].each do |s|
+        pair = s.split(':')
+        options[:href_swap][/#{pair[0]}/] = pair[1]
       end
     end
 
-    options[:href_ignore] = opts["href_ignore"] unless opts["href_ignore"].nil?
-    options[:alt_ignore] = opts["alt_ignore"] unless opts["alt_ignore"].nil?
-    options[:file_ignore] = opts["file_ignore"] unless opts["file_ignore"].nil?
-    options[:disable_external] = opts["disable_external"] unless opts["disable_external"].nil?
-    options[:only_4xx] = opts["only_4xx"] unless opts["only_4xx"].nil?
-    options[:favicon] = opts["favicon"] unless opts["favicon"].nil?
-    options[:verbose] = opts["verbose"] unless opts["verbose"].nil?
-    options[:directory_index_file] = opts["directory_index_file"] unless opts["directory_index_file"].nil?
-    options[:validate_html] = opts["validate_html"] unless opts["validate_html"].nil?
-    options[:check_external_hash] = opts["check_external_hash"] unless opts["check_external_hash"].nil?
-
-    path = path.delete(' ').split(",") if opts["as-links"]
+    options[:href_ignore] = opts['href_ignore'] unless opts['href_ignore'].nil?
+    options[:alt_ignore] = opts['alt_ignore'] unless opts['alt_ignore'].nil?
+    options[:file_ignore] = opts['file_ignore'] unless opts['file_ignore'].nil?
+    options[:disable_external] = opts['disable_external'] unless opts['disable_external'].nil?
+    options[:only_4xx] = opts['only_4xx'] unless opts['only_4xx'].nil?
+    options[:favicon] = opts['favicon'] unless opts['favicon'].nil?
+    options[:verbose] = opts['verbose'] unless opts['verbose'].nil?
+    options[:directory_index_file] = opts['directory_index_file'] unless opts['directory_index_file'].nil?
+    options[:validate_html] = opts['validate_html'] unless opts['validate_html'].nil?
+    options[:check_external_hash] = opts['check_external_hash'] unless opts['check_external_hash'].nil?
+
+    path = path.delete(' ').split(',') if opts['as-links']
 
     HTML::Proofer.new(path, options).run
   end

html-proofer.gemspec

@@ -1,31 +1,31 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'html/proofer/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "html-proofer"
+  gem.name          = 'html-proofer'
   gem.version       = HTML::Proofer::VERSION
-  gem.authors       = ["Garen Torikian"]
-  gem.email         = ["gjtorikian@gmail.com"]
-  gem.description   = %q{Test your rendered HTML files to make sure they're accurate.}
-  gem.summary       = %q{A set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output.}
-  gem.homepage      = "https://github.com/gjtorikian/html-proofer"
-  gem.license       = "MIT"
-  gem.executables   = ["htmlproof"]
+  gem.authors       = ['Garen Torikian']
+  gem.email         = ['gjtorikian@gmail.com']
+  gem.description   = %(Test your rendered HTML files to make sure they're accurate.)
+  gem.summary       = %(A set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output.)
+  gem.homepage      = 'https://github.com/gjtorikian/html-proofer'
+  gem.license       = 'MIT'
+  gem.executables   = ['htmlproof']
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency "mercenary",       "~> 0.3.2"
-  gem.add_dependency "nokogiri",        "~> 1.5"
-  gem.add_dependency "colored",         "~> 1.2"
-  gem.add_dependency "typhoeus",        "~> 0.6.7"
-  gem.add_dependency "yell",            "~> 2.0"
-  gem.add_dependency "parallel",        "~> 1.3"
-  gem.add_dependency "addressable",     "~> 2.3"
+  gem.add_dependency 'mercenary',       '~> 0.3.2'
+  gem.add_dependency 'nokogiri',        '~> 1.5'
+  gem.add_dependency 'colored',         '~> 1.2'
+  gem.add_dependency 'typhoeus',        '~> 0.6.7'
+  gem.add_dependency 'yell',            '~> 2.0'
+  gem.add_dependency 'parallel',        '~> 1.3'
+  gem.add_dependency 'addressable',     '~> 2.3'
 
-  gem.add_development_dependency "redcarpet"
-  gem.add_development_dependency "rspec", "~> 3.1.0"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "awesome_print"
+  gem.add_development_dependency 'redcarpet'
+  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'awesome_print'
 end