Class: HTML::Proofer

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/html/proofer.rb,
lib/html/proofer/log.rb,
lib/html/proofer/version.rb,
lib/html/proofer/checkable.rb,
lib/html/proofer/check_runner.rb,
lib/html/proofer/url_validator.rb

Defined Under Namespace

Classes: CheckRunner, Checkable, Log, UrlValidator

Constant Summary collapse

VERSION =
'2.0.3'

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils

create_nokogiri, swap

Constructor Details

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

Returns a new instance of Proofer.


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/html/proofer.rb', line 26

def initialize(src, opts = {})
  @src = src

  @proofer_opts = {
    :ext => '.html',
    :check_favicon => false,
    :href_swap => [],
    :href_ignore => [],
    :file_ignore => [],
    :check_external_hash => false,
    :alt_ignore => [],
    :disable_external => false,
    :verbose => false,
    :only_4xx => false,
    :directory_index_file => 'index.html',
    :check_html => false,
    :error_sort => :path,
    :checks_to_ignore => []
  }

  @typhoeus_opts = opts[:typhoeus] || {
    :followlocation => true
  }
  opts.delete(:typhoeus)

  @hydra_opts = opts[:hydra] || {}
  opts.delete(:hydra)

  # fall back to parallel defaults
  @parallel_opts = opts[:parallel] || {}
  opts.delete(:parallel)

  @options = @proofer_opts.merge(opts)

  @failed_tests = []
end

Instance Attribute Details

#optionsObject (readonly)

Returns the value of attribute options


24
25
26
# File 'lib/html/proofer.rb', line 24

def options
  @options
end

#parallel_optsObject (readonly)

Returns the value of attribute parallel_opts


24
25
26
# File 'lib/html/proofer.rb', line 24

def parallel_opts
  @parallel_opts
end

#typhoeus_optsObject (readonly)

Returns the value of attribute typhoeus_opts


24
25
26
# File 'lib/html/proofer.rb', line 24

def typhoeus_opts
  @typhoeus_opts
end

Instance Method Details

#check_directory_of_filesObject

Collects any external URLs found in a directory of files. Also collectes every failed test from check_files_for_internal_woes. Sends the external URLs to Typhoeus for batch processing.


98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/html/proofer.rb', line 98

def check_directory_of_files
  external_urls = {}
  results = check_files_for_internal_woes

  results.each do |item|
    external_urls.merge!(item[:external_urls])
    @failed_tests.concat(item[:failed_tests])
  end

  validate_urls(external_urls) unless @options[:disable_external]

  logger.log :info, :blue, "Ran on #{files.length} files!\n\n"
end

#check_files_for_internal_woesObject

Walks over each implemented check and runs them on the files, in parallel.


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/html/proofer.rb', line 113

def check_files_for_internal_woes
  Parallel.map(files, @parallel_opts) do |path|
    html = create_nokogiri(path)
    result = { :external_urls => {}, :failed_tests => [] }

    checks.each do |klass|
      logger.log :debug, :yellow, "Checking #{klass.to_s.downcase} on #{path} ..."
      check = Object.const_get(klass).new(@src, path, html, @options)
      check.run
      result[:external_urls].merge!(check.external_urls)
      result[:failed_tests].concat(check.issues) if check.issues.length > 0
    end
    result
  end
end

85
86
87
88
89
90
91
92
93
# File 'lib/html/proofer.rb', line 85

def check_list_of_links
  if @options[:href_swap]
    @src = @src.map do |external_url|
      swap(external_url, @options[:href_swap])
    end
  end
  external_urls = Hash[*@src.map { |s| [s, nil] }.flatten]
  validate_urls(external_urls)
end

#checksObject


155
156
157
158
159
160
161
162
163
164
# File 'lib/html/proofer.rb', line 155

def checks
  return @checks unless @checks.nil?
  @checks = HTML::Proofer::CheckRunner.checks.map(&:name)
  @checks.delete('FaviconCheck') unless @options[:check_favicon]
  @checks.delete('HtmlCheck') unless @options[:check_html]
  @options[:checks_to_ignore].each do |ignored|
    @checks.delete(ignored)
  end
  @checks
end

#failed_testsObject


166
167
168
169
170
171
# File 'lib/html/proofer.rb', line 166

def failed_tests
  return [] if @failed_tests.empty?
  result = []
  @failed_tests.each { |f| result << f.to_s }
  result
end

#filesObject


134
135
136
137
138
139
140
141
142
143
144
# File 'lib/html/proofer.rb', line 134

def files
  if File.directory? @src
    pattern = File.join(@src, '**', "*#{@options[:ext]}")
    files = Dir.glob(pattern).select { |fn| File.file? fn }
    files.reject { |f| ignore_file?(f) }
  elsif File.extname(@src) == @options[:ext]
    [@src].reject { |f| ignore_file?(f) }
  else
    []
  end
end

#ignore_file?(file) ⇒ Boolean

Returns:

  • (Boolean)

146
147
148
149
150
151
152
153
# File 'lib/html/proofer.rb', line 146

def ignore_file?(file)
  options[:file_ignore].each do |pattern|
    return true if pattern.is_a?(String) && pattern == file
    return true if pattern.is_a?(Regexp) && pattern =~ file
  end

  false
end

#loggerObject


63
64
65
# File 'lib/html/proofer.rb', line 63

def logger
  @logger ||= HTML::Proofer::Log.new(@options[:verbose])
end

173
174
175
176
177
178
179
180
# File 'lib/html/proofer.rb', line 173

def print_failed_tests
  sorted_failures = HTML::Proofer::CheckRunner::SortedIssues.new(@failed_tests, @options[:error_sort], logger)

  sorted_failures.sort_and_report
  count = @failed_tests.length
  failure_text = "#{count} " << (count == 1 ? 'failure' : 'failures')
  fail logger.colorize :red, "HTML-Proofer found #{failure_text}!"
end

#runObject


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/html/proofer.rb', line 67

def run
  count = checks.length
  check_text = "#{checks} " << (count == 1 ? 'check' : 'checks')
  logger.log :info, :blue, "Running #{check_text} on #{@src} on *#{@options[:ext]}... \n\n"

  if @src.is_a?(Array) && !@options[:disable_external]
    check_list_of_links
  else
    check_directory_of_files
  end

  if @failed_tests.empty?
    logger.log :info, :green, 'HTML-Proofer finished successfully.'
  else
    print_failed_tests
  end
end

#validate_urls(external_urls) ⇒ Object


129
130
131
132
# File 'lib/html/proofer.rb', line 129

def validate_urls(external_urls)
  url_validator = HTML::Proofer::UrlValidator.new(logger, external_urls, @options, @typhoeus_opts, @hydra_opts)
  @failed_tests.concat(url_validator.run)
end