Class: LinkCheck
Defined Under Namespace
Classes: XpathFunctions
Instance Attribute Summary
#element, #external_urls, #html, #issues, #node, #options, #path, #src
Instance Method Summary
collapse
-
#check_schemes(link, line, content) ⇒ Object
-
#check_sri(line, content) ⇒ Object
-
#external_link_check(link, line, content) ⇒ Object
-
#find_fragments(html, fragment_ids) ⇒ Object
-
#handle_hash(link, line, content) ⇒ Object
-
#handle_mailto(link, line, content) ⇒ Object
-
#handle_tel(link, line, content) ⇒ Object
-
#hash_check(html, href_hash) ⇒ Object
-
#missing_href? ⇒ Boolean
-
#placeholder? ⇒ Boolean
-
#run ⇒ Object
clean_content, create_nokogiri, #pluralize, swap
#add_issue, #add_path_for_url, #add_to_external_urls, #blank?, #create_element, #initialize, subchecks
Instance Method Details
#check_schemes(link, line, content) ⇒ Object
66
67
68
69
70
71
72
73
74
75
76
|
# File 'lib/html-proofer/check/links.rb', line 66
def check_schemes(link, line, content)
case link.scheme
when 'mailto'
handle_mailto(link, line, content)
when 'tel'
handle_tel(link, line, content)
when 'http'
return unless @options[:enforce_https]
add_issue("#{link.href} is not an HTTPS link", line: line, content: content)
end
end
|
#check_sri(line, content) ⇒ Object
128
129
130
131
132
133
134
135
136
137
|
# File 'lib/html-proofer/check/links.rb', line 128
def check_sri(line, content)
return if (@link.rel == 'canonical' || @link.rel == 'alternate')
if !defined?(@link.integrity) && !defined?(@link.crossorigin)
add_issue("SRI and CORS not provided in: #{@link.src}", line: line, content: content)
elsif !defined?(@link.integrity)
add_issue("Integrity is missing in: #{@link.src}", line: line, content: content)
elsif !defined?(@link.crossorigin)
add_issue("CORS not provided for external resource in: #{@link.src}", line: line, content: content)
end
end
|
#external_link_check(link, line, content) ⇒ Object
98
99
100
101
102
103
104
105
106
107
|
# File 'lib/html-proofer/check/links.rb', line 98
def external_link_check(link, line, content)
if !link.exists?
add_issue("trying to find hash of #{link.href}, but #{link.absolute_path} does not exist", line: line, content: content)
else
target_html = create_nokogiri link.absolute_path
unless hash_check target_html, link.hash
add_issue("linking to #{link.href}, but #{link.hash} does not exist", line: line, content: content)
end
end
end
|
#find_fragments(html, fragment_ids) ⇒ Object
115
116
117
118
119
120
121
122
123
124
125
126
|
# File 'lib/html-proofer/check/links.rb', line 115
def find_fragments(html, fragment_ids)
xpaths = fragment_ids.flat_map do |frag_id|
escaped_frag_id = "'#{frag_id.split("'").join("', \"'\", '")}', ''"
[
"//*[case_insensitive_equals(@id, concat(#{escaped_frag_id}))]",
"//*[case_insensitive_equals(@name, concat(#{escaped_frag_id}))]"
]
end
xpaths << XpathFunctions.new
html.xpath(*xpaths)
end
|
#handle_hash(link, line, content) ⇒ Object
90
91
92
93
94
95
96
|
# File 'lib/html-proofer/check/links.rb', line 90
def handle_hash(link, line, content)
if link.internal? && !hash_check(link.html, link.hash)
add_issue("linking to internal hash ##{link.hash} that does not exist", line: line, content: content)
elsif link.external?
external_link_check(link, line, content)
end
end
|
#handle_mailto(link, line, content) ⇒ Object
78
79
80
81
82
83
84
|
# File 'lib/html-proofer/check/links.rb', line 78
def handle_mailto(link, line, content)
if link.path.empty?
add_issue("#{link.href} contains no email address", line: line, content: content)
elsif !link.path.include?('@')
add_issue("#{link.href} contains an invalid email address", line: line, content: content)
end
end
|
#handle_tel(link, line, content) ⇒ Object
86
87
88
|
# File 'lib/html-proofer/check/links.rb', line 86
def handle_tel(link, line, content)
add_issue("#{link.href} contains no phone number", line: line, content: content) if link.path.empty?
end
|
#hash_check(html, href_hash) ⇒ Object
109
110
111
112
113
|
# File 'lib/html-proofer/check/links.rb', line 109
def hash_check(html, href_hash)
decoded_href_hash = Addressable::URI.unescape(href_hash)
fragment_ids = [href_hash, decoded_href_hash]
fragment_ids.include?('top') || !find_fragments(html, fragment_ids).empty?
end
|
#missing_href? ⇒ Boolean
4
5
6
|
# File 'lib/html-proofer/check/links.rb', line 4
def missing_href?
blank?(@link.href) && blank?(@link.name) && blank?(@link.id)
end
|
#placeholder? ⇒ Boolean
8
9
10
|
# File 'lib/html-proofer/check/links.rb', line 8
def placeholder?
(!blank?(@link.id) || !blank?(@link.name)) && @link.href.nil?
end
|
#run ⇒ Object
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
|
# File 'lib/html-proofer/check/links.rb', line 12
def run
@html.css('a, link').each do |node|
@link = create_element(node)
line = node.line
content = node.to_s
next if @link.ignore?
next if placeholder?
next if @link.allow_hash_href? && @link.href == '#'
unless @link.valid?
add_issue("#{@link.href} is an invalid URL", line: line, content: content)
next
end
check_schemes(@link, line, content)
if missing_href?
next if @html.internal_subset.name == 'html' && @html.internal_subset.external_id.nil?
add_issue('anchor has no href attribute', line: line, content: content)
next
end
next if @link.non_http_remote?
if !@link.internal? && @link.remote?
check_sri(line, content) if @link.check_sri? && node.name == 'link'
next if @link.try(:rel) == 'dns-prefetch'
add_to_external_urls(@link.href)
next
elsif !@link.internal? && !@link.exists?
add_issue("internally linking to #{@link.href}, which does not exist", line: line, content: content)
end
if @link.unslashed_directory? @link.absolute_path
add_issue("internally linking to a directory #{@link.absolute_path} without trailing slash", line: line, content: content)
next
end
handle_hash(@link, line, content) if @link.hash
end
external_urls
end
|