Class: HTML::Proofer

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

Defined Under Namespace

Modules: Cache, Utils Classes: CheckRunner, Checkable, Log, UrlValidator, XpathFunctions

Constant Summary collapse

TYPHOEUS_DEFAULTS =
{
  :followlocation => true,
  :headers => {
    'User-Agent' => "Mozilla/5.0 (compatible; HTML Proofer/#{VERSION}; +https://github.com/gjtorikian/html-proofer)"
  }
}
VERSION =
'2.5.0'

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.


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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/html/proofer.rb', line 34

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

  if opts[:verbose]
    warn '`@options[:verbose]` will be removed in a future 3.x.x release: http://git.io/vGHHh'
  end
  if opts[:href_ignore]
    warn '`@options[:href_ignore]` will be renamed in a future 3.x.x release: http://git.io/vGHHy'
  end

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

  @typhoeus_opts = TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
  opts.delete(:typhoeus)

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

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

  @validation_opts = opts[:validation] || {}
  opts.delete(:validation)

  @options = @proofer_opts.merge(opts)

  @failed_tests = []
end

Instance Attribute Details

#external_urlsObject (readonly)

Returns the value of attribute external_urls


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

def external_urls
  @external_urls
end

#hydra_optsObject (readonly)

Returns the value of attribute hydra_opts


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

def hydra_opts
  @hydra_opts
end

#optionsObject (readonly)

Returns the value of attribute options


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

def options
  @options
end

#parallel_optsObject (readonly)

Returns the value of attribute parallel_opts


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

def parallel_opts
  @parallel_opts
end

#typhoeus_optsObject (readonly)

Returns the value of attribute typhoeus_opts


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

def typhoeus_opts
  @typhoeus_opts
end

#validation_optsObject (readonly)

Returns the value of attribute validation_opts


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

def validation_opts
  @validation_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.


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

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 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.


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

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, @typhoeus_opts, @hydra_opts, @parallel_opts, @validation_opts)
      check.run
      result[:external_urls].merge!(check.external_urls)
      result[:failed_tests].concat(check.issues) if check.issues.length > 0
    end
    result
  end
end

103
104
105
106
107
108
109
110
111
# File 'lib/html/proofer.rb', line 103

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

#checksObject


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

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


184
185
186
187
188
189
# File 'lib/html/proofer.rb', line 184

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

#filesObject


152
153
154
155
156
157
158
159
160
161
162
# File 'lib/html/proofer.rb', line 152

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)

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

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


81
82
83
# File 'lib/html/proofer.rb', line 81

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

191
192
193
194
195
196
197
198
# File 'lib/html/proofer.rb', line 191

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


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/html/proofer.rb', line 85

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_urlsObject


147
148
149
150
# File 'lib/html/proofer.rb', line 147

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