Class: HTML::Proofer

Inherits:
Object
  • Object
show all
Defined in:
lib/html/proofer.rb,
lib/html/proofer/checks.rb,
lib/html/proofer/version.rb

Defined Under Namespace

Classes: Checks

Constant Summary collapse

VERSION =
"0.0.16"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(src, opts = {}) ⇒ Proofer

Returns a new instance of Proofer.


6
7
8
9
10
# File 'lib/html/proofer.rb', line 6

def initialize(src, opts={})
  @srcDir = src
  @options = {:ext => ".html"}.merge(opts)
  @failedTests = []
end

Class Method Details

.create_nokogiri(path) ⇒ Object


43
44
45
46
# File 'lib/html/proofer.rb', line 43

def self.create_nokogiri(path)
  path << "index.html" if File.directory? path #support for Jekyll-style links
  Nokogiri::HTML(File.read(path))
end

Instance Method Details

#get_checksObject


48
49
50
# File 'lib/html/proofer.rb', line 48

def get_checks
  HTML::Proofer::Checks::Check.subclasses
end

52
53
54
55
56
57
58
# File 'lib/html/proofer.rb', line 52

def print_issues(klass, issues)
  return if issues.empty?
  @failedTests.push klass
  issues.each do |issue|
    $stderr.puts issue + "\n\n"
  end
end

#runObject


12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/html/proofer.rb', line 12

def run
  get_checks.each do |klass|
    puts "Running #{klass.name.split(/:/).pop()} check... \n\n"

    Find.find(@srcDir) do |path|
      if File.extname(path) == @options[:ext]
        html = HTML::Proofer.create_nokogiri(path)
        check = klass.new(path, html, @options)
        check.run
        check.hydra.run
        self.print_issues(klass, check.issues)
      end
    end
  end

  if !@failedTests.empty?
    # make the hash default to 0 so that += will work correctly
    count = Hash.new(0)

    # iterate over the array, counting duplicate entries
    @failedTests.each do |v|
      count[v] += 1
    end

    count.each do |k, v|
      $stderr.puts "#{k} failed #{v} times"
    end
    raise "Tests ran, but found failures!"
  end
end