1
2
3
4
5
6
7
8
9
10
11
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
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
# frozen_string_literal: true
module HTMLProofer
# Mostly handles issue management and collecting of external URLs.
class Check
include HTMLProofer::Utils
attr_reader :failures, :options, :internal_urls, :external_urls
def initialize(runner, html)
@runner = runner
@html = remove_ignored(html)
@external_urls = {}
@internal_urls = {}
@failures = []
end
def create_element(node)
Element.new(@runner, node, base_url: base_url)
end
def run
raise NotImplementedError, "HTMLProofer::Check subclasses must implement #run"
end
def add_failure(description, element: nil, line: nil, status: nil, content: nil)
@failures << Failure.new(
@runner.current_filename,
short_name,
description,
line: element.nil? ? line : element.line,
status: status,
content: element.nil? ? content : element.content,
element: element,
)
end
def short_name
self.class.name.split("::").last
end
def add_to_internal_urls(url, element)
url_string = url.raw_attribute
@internal_urls[url_string] = [] if @internal_urls[url_string].nil?
metadata = {
source: url.source,
filename: url.filename,
line: element.line,
base_url: base_url,
found: false,
element: element,
}
@internal_urls[url_string] << metadata
end
def add_to_external_urls(url, element)
url_string = url.to_s
@external_urls[url_string] = [] if @external_urls[url_string].nil?
@external_urls[url_string] << { filename: url.filename, line: element.line, element: element }
end
class << self
def subchecks(runner_options)
# grab all known checks
checks = ObjectSpace.each_object(Class).select do |klass|
klass < self
end
# remove any checks not explicitly included
checks.each_with_object([]) do |check, arr|
next unless runner_options[:checks].include?(check.short_name)
arr << check
end
end
def short_name
name.split("::").last
end
end
private def base_url
return @base_url if defined?(@base_url)
return (@base_url = "") if (base = @html.at_css("base")).nil?
@base_url = base["href"]
end
private def remove_ignored(html)
return if html.nil?
html.css("code, pre, tt").each(&:unlink)
html
end
end
end
|
