html-proofer 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8328f696789f830910e2bee17b2b015e8ffc0b0d
-  data.tar.gz: f051884d9787841d70dfdaf2ebedc5bb7818a6e2
+  metadata.gz: 2e94fed7b3cb30e272c5de25511ad9604e2a9663
+  data.tar.gz: d2ba44ef2943e993d69906089e374ae51013ff4b
 SHA512:
-  metadata.gz: cf0bfd4a6060c0eebe58be4caad40cbada074241ed378ced25236f52e594b1ff1f1d528c4bb757fac11fe4bb3a68dce072950ccbe5eb965652179660fda19285
-  data.tar.gz: 53fe8b4b33e7d6507da659f18e54279c85bf741d9bb84439430147584ac1928ff085b31cd61576313098e1e383b216bdff0f844fb9e4fb0f3156c11176a2195a
+  metadata.gz: 9f65536fcc74006b51ca34ecc77b048ea59608a2a055c4961afaa086d92c3fe09cc2056de5b7d2a5546f37ec0d6586bec29d1fd7fd05607aaaae3c777cf60172
+  data.tar.gz: ca131c1f0a7d06da44a40a7e714ece99821102153c158f130d909d226a86347ce10745d87b62954cdf71657188459fffef8b7410a949a5134b0ee9236ead3ec9

data/Gemfile

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

data/README.md

@@ -22,6 +22,47 @@ 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
+
+### Favicon
+
+Checks if your favicons are valid. This is an optional feature, set the `check_favicon` option to turn it on.
+
+### 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 `check_html` option to enable validation errors from Nokogiri.
+
 ## Usage
 
 ### Using in a script
@@ -35,7 +76,7 @@ require 'html/pipeline'
 require 'find'
 
 # make an out dir
-Dir.mkdir("out") unless File.exists?("out")
+Dir.mkdir("out") unless File.exist?("out")
 
 pipeline = HTML::Pipeline.new [
   HTML::Pipeline::MarkdownFilter,
@@ -90,79 +131,47 @@ 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:
 
 | Option | Description | Default |
 | :----- | :---------- | :------ |
+| `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
+| `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` |
+|`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]`
+| `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |
 | `disable_external` | If `true`, does not run the external link checker, which can take a lot of time. | `false` |
+| `error_sort` | Defines the sort order for error output. Can be `:path`, `:desc`, or `:status`. | `:path`
 | `ext` | The extension of your HTML files including the dot. | `.html`
-| `favicon` | Enables the favicon checker. | `false` |
-| `followlocation` | Follows external redirections. Amends missing trailing slashes to internal directories. | `true` |
-| `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |
-| `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored. | `[]` |
-| `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
 | `file_ignore` | An array of Strings or RegExps containing file paths that are safe to ignore. | `[]` |
+| `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored. | `[]` |
 | `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. | `{}` |
-| `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
 | `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
-| `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` |
+| `check_favicon` | Enables the favicon checker. | `false` |
+| `check_html` | Enables HTML validation errors from Nokogiri | `false` |
+| `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. | `false` |
 
-### Configuring Typhoeus
+### Configuring Typhoeus and Hydra
 
-You can also pass in any of Typhoeus' options for the external link check. For example:
+[Typhoeus](https://github.com/typhoeus/typhoeus) is used to make fast, parallel requests to external URLs. You can pass in any of Typhoeus' options for the external link checks with the options namespace of `:typhoeus`. 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.
+
+The default value is `typhoeus => { :followlocation => true }`.
+
 ### 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:
+[Parallel](https://github.com/grosser/parallel) is being used to speed internal file checks. You can pass in any of its options with the options "namespace" `:parallel`. For example:
 
 ``` ruby
-HTML::Proofer.new("out/", {:ext => ".htm", :verbose => true, :ssl_verifyhost => 2, :parallel => { :in_processes => 3} })
+HTML::Proofer.new("out/", {:ext => ".htm", :parallel => { :in_processes => 3} })
 ```
 
 `:in_processes => 3` will be passed into Parallel as a configuration option.
@@ -185,14 +194,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::CheckRunner`, and another that inherits from `HTML::Proofer::Checkable`.
+
+The `CheckRunner` 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 +223,14 @@ class OctocatLink < ::HTML::Proofer::Checkable
 
 end
 
-class MailToOctocat < ::HTML::Proofer::Checks::Check
+class MailToOctocat < ::HTML::Proofer::CheckRunner
 
   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

data/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

data/bin/htmlproof

@@ -1,59 +1,69 @@
 #!/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'
+
+def to_regex?(item)
+  if item.start_with? '/' and item.end_with? '/'
+    Regexp.new item[1...-1]
+  else
+    item
+  end
+end
 
 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.option 'ext', '--ext EXT', 'The extension of your HTML files (default: `.html`)'
-  p.option 'favicon', '--favicon', 'Enables the favicon checker (default: `false`).'
-  p.option 'as-links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
-  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 'href_ignore', '--href_ignore link1,[link2,...]', Array, 'Array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored.'
-  p.option 'alt_ignore', '--alt_ignore image1,[image2,...]', Array, 'Array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore'
-  p.option 'file_ignore', '--file_ignore file1,[file2,...]', Array, 'Array of Strings or RegExps containing file paths that are safe to ignore'
-  p.option 'disable_external', '--disable_external', 'Disables the external link checker (default: `false`)'
-  p.option 'only_4xx', '--only_4xx', 'Only reports errors for links that fall within the 4x status code range.'
+  p.description 'Runs the HTML-Proofer suite on the files in PATH. For more details, see the README.'
+
+  p.option 'as_links', '--as-links', 'Assumes that `PATH` is a comma-separated array of links to check.'
+  p.option 'alt_ignore', '--alt-ignore image1,[image2,...]', Array, 'Comma-separated list of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore'
+  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 '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', 'Disables the external link checker (default: `false`)'
+  p.option 'error_sort', '--error-sort SORT', 'Defines the sort order for error output. Can be `path`, `desc`, or `status` (default: `path`).'
+  p.option 'ext', '--ext EXT', String, 'The extension of your HTML files (default: `.html`)'
+  p.option 'file_ignore', '--file-ignore file1,[file2,...]', Array, 'Comma-separated list of Strings or RegExps containing file paths that are safe to ignore'
+  p.option 'href_ignore', '--href-ignore link1,[link2,...]', Array, 'Comma-separated list of Strings or RegExps containing `href`s that are safe to ignore.'
+  p.option 'href_swap', '--href-swap re:string,[re:string,...]', Array, 'Comma-separated list of key-value pairs of `RegExp:String`. Transforms links matching `RegExp` into `String`'
+  p.option 'only_4xx', '--only-4xx', 'Only reports errors for links that fall within the 4x status code range.'
+  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 'verbose', '--verbose', 'Enables more verbose logging.'
-  p.option 'directory_index_file', '--directory_index_file', 'Sets the file to look for when a link refers to a directory.'
-  p.option 'validate_html', '--validate_html', 'Enables HTML validation errors from Nokogiri (default: `false`).'
-  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?
+
+    # prepare every 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?
+        opts[option.config_key] = opts[option.config_key].map { |i| to_regex?(i) }
+      end
+      options[option.config_key.to_sym] = opts[option.config_key]
+    end
+
+    # some minor manipulation of a special option
+    unless opts['href_swap'].nil?
       options[:href_swap] = {}
-      opts["swap"].each do |s|
-        pair = s.split(":")
-        options[:href_swap][%r{#{pair[0]}}] = pair[1]
+      opts['href_swap'].each do |s|
+        pair = s.split(':')
+        options[:href_swap][Regexp.new(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[:error_sort] = opts['error-sort'].to_sym unless opts['error-sort'].nil?
+
+    path = path.delete(' ').split(',') if opts['as_links']
 
     HTML::Proofer.new(path, options).run
   end

data/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.files         = `git ls-files`.split($/)
+  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 -z`.split("\x0")
   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

data/lib/html/proofer/check_runner/issue.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+class HTML::Proofer::CheckRunner
+
+  class Issue
+    attr_reader :path, :desc, :status, :line_number
+
+    def initialize(path, desc, line_number = nil, status = -1)
+      @line_number = line_number.nil? ? '' : " (line #{line_number})"
+      @path = path
+      @desc = desc
+      @status = status
+    end
+
+    def to_s
+      "#{@path}: #{@desc}#{@line_number}"
+    end
+  end
+
+  class SortedIssues
+    attr_reader :issues
+
+    def initialize(issues, error_sort, logger)
+      @issues = issues
+      @error_sort = error_sort
+      @logger = logger
+    end
+
+    def sort_and_report
+      case @error_sort
+      when :path
+        sorted_issues = sort(:path, :desc)
+        report(sorted_issues, :path, :desc)
+      when :desc
+        sorted_issues = sort(:desc, :path)
+        report(sorted_issues, :desc, :path)
+      when :status
+        sorted_issues = sort(:status, :path)
+        report(sorted_issues, :status, :path)
+      end
+    end
+
+    def sort(first_sort, second_sort)
+      issues.sort_by { |t| [t.send(first_sort), t.send(second_sort)] }
+    end
+
+    def report(sorted_issues, first_report, second_report)
+      matcher = nil
+
+      sorted_issues.each do |issue|
+        if matcher != issue.send(first_report)
+          @logger.log :error, :red, "- #{issue.send(first_report)}"
+          matcher = issue.send(first_report)
+        end
+        if first_report == :status
+          @logger.log :error, :red, "  *  #{issue}"
+        else
+          @logger.log :error, :red, "  *  #{issue.send(second_report)}#{issue.line_number}"
+        end
+      end
+    end
+  end
+end

data/lib/html/proofer/{check.rb → check_runner.rb}

@@ -1,15 +1,11 @@
 # encoding: utf-8
-require 'net/http'
-require 'net/https'
-require 'timeout'
-require 'uri'
-require 'typhoeus'
 
-class HTML::Proofer::Checks
+class HTML::Proofer
 
-  class Check
+  # Mostly handles issue management and collecting of external URLs.
+  class CheckRunner
 
-    attr_reader :issues, :src, :path, :options, :external_urls, :additional_href_ignores, :additional_alt_ignores
+    attr_reader :issues, :src, :path, :options, :external_urls, :href_ignores, :alt_ignores
 
     def initialize(src, path, html, opts={})
       @src    = src
@@ -17,21 +13,17 @@ class HTML::Proofer::Checks
       @html   = remove_ignored(html)
       @options = opts
       @issues = []
-      @additional_href_ignores = @options[:href_ignore]
-      @additional_alt_ignores = @options[:alt_ignore]
+      @href_ignores = @options[:href_ignore]
+      @alt_ignores = @options[:alt_ignore]
       @external_urls = {}
     end
 
     def run
-      raise NotImplementedError.new("HTML::Proofer::Check subclasses must implement #run")
+      fail NotImplementedError, 'HTML::Proofer::CheckRunner subclasses must implement #run'
     end
 
-    def add_issue(desc, status = -1)
-      @issues << Issue.new(@path, desc, status)
-    end
-
-    def output_filenames
-      Dir[@site.config[:output_dir] + '/**/*'].select{ |f| File.file?(f) }
+    def add_issue(desc, line_number = nil, status = -1)
+      @issues << Issue.new(@path, desc, line_number, status)
     end
 
     def add_to_external_urls(href)
@@ -42,7 +34,7 @@ class HTML::Proofer::Checks
       end
     end
 
-    def self.subclasses
+    def self.checks
       classes = []
 
       ObjectSpace.each_object(Class) do |c|
@@ -56,7 +48,7 @@ class HTML::Proofer::Checks
   private
 
     def remove_ignored(html)
-      html.css("code, pre").each { |node| node.unlink }
+      html.css('code, pre').each(&:unlink)
       html
     end