-
-
Notifications
You must be signed in to change notification settings - Fork 192
/
element.rb
237 lines (187 loc) · 6.07 KB
/
element.rb
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# frozen_string_literal: true
require 'addressable/uri'
require_relative './utils'
module HTMLProofer
# Represents the element currently being processed
class Element
include HTMLProofer::Utils
attr_reader :id, :name, :alt, :href, :link, :src, :line, :data_proofer_ignore
def initialize(obj, check)
# Construct readable ivars for every element
obj.attributes.each_pair do |attribute, value|
name = attribute.tr('-:.', '_').to_s.to_sym
(class << self; self; end).send(:attr_reader, name)
instance_variable_set("@#{name}", value.value)
end
@aria_hidden = (defined?(@aria_hidden) && @aria_hidden == 'true') ? true : false
@data_proofer_ignore = defined?(@data_proofer_ignore)
@text = obj.content
@check = check
@checked_paths = {}
@type = check.class.name
@line = obj.line
@html = check.html
parent_attributes = obj.ancestors.map { |a| a.respond_to?(:attributes) && a.attributes }
parent_attributes.pop # remove document at the end
@parent_ignorable = parent_attributes.any? { |a| !a['data-proofer-ignore'].nil? }
# fix up missing protocols
if defined?(@href)
@href.insert(0, 'http:') if @href =~ %r{^//}
else
@href = nil
end
if defined?(@src)
@src.insert(0, 'http:') if @src =~ %r{^//}
else
@src = nil
end
if defined?(@srcset)
@srcset.insert(0, 'http:') if @srcset =~ %r{^//}
else
@srcset = nil
end
end
def url
return @url if defined?(@url)
@url = (@src || @srcset || @href || '').delete("\u200b").strip
@url = Addressable::URI.join(base.attr('href') || '', url).to_s if base
return @url if @check.options[:url_swap].empty?
@url = swap(@url, @check.options[:url_swap])
end
def valid?
!parts.nil?
end
def parts
@parts ||= Addressable::URI.parse url
rescue URI::Error, Addressable::URI::InvalidURIError
@parts = nil
end
def path
Addressable::URI.unencode parts.path unless parts.nil?
end
def hash
parts.fragment unless parts.nil?
end
def scheme
parts.scheme unless parts.nil?
end
# path is to an external server
def remote?
%w[http https].include? scheme
end
def non_http_remote?
!scheme.nil? && !remote?
end
def ignore?
return true if @data_proofer_ignore
return true if @parent_ignorable
return true if url =~ /^javascript:/
# ignore base64 encoded images
if %w[ImageCheck FaviconCheck].include? @type
return true if url =~ /^data:image/
end
# ignore user defined URLs
return true if ignores_pattern_check(@check.options[:url_ignore])
end
def ignore_alt?
return true if ignores_pattern_check(@check.options[:alt_ignore]) || @aria_hidden
end
def ignore_empty_alt?
@check.options[:empty_alt_ignore]
end
def allow_missing_href?
@check.options[:allow_missing_href]
end
def allow_hash_href?
@check.options[:allow_hash_href]
end
def check_img_http?
@check.options[:check_img_http]
end
def check_sri?
@check.options[:check_sri]
end
# path is external to the file
def external?
!internal?
end
# path is an anchor or a query
def internal?
hash_link || param_link || slash_link
end
def hash_link
url.start_with?('#')
end
def param_link
url.start_with?('?')
end
def slash_link
url.start_with?('|')
end
def file_path
return if path.nil?
path_dot_ext = ''
if @check.options[:assume_extension]
path_dot_ext = path + @check.options[:extension]
end
if path =~ %r{^/} # path relative to root
if File.directory?(@check.src)
base = @check.src
else
root_dir = @check.options[:root_dir]
base = root_dir ? root_dir : File.dirname(@check.src)
end
elsif File.exist?(File.expand_path(path, @check.src)) || File.exist?(File.expand_path(path_dot_ext, @check.src)) # relative links, path is a file
base = File.dirname @check.path
elsif File.exist?(File.join(File.dirname(@check.path), path)) || File.exist?(File.join(File.dirname(@check.path), path_dot_ext)) # relative links in nested dir, path is a file
base = File.dirname @check.path
else # relative link, path is a directory
base = @check.path
end
file = File.join base, path
if @check.options[:assume_extension] && File.file?("#{file}#{@check.options[:extension]}")
file = "#{file}#{@check.options[:extension]}"
elsif File.directory?(file) && !unslashed_directory?(file) # implicit index support
file = File.join file, @check.options[:directory_index_file]
end
file
end
# checks if a file exists relative to the current pwd
def exists?
return @checked_paths[absolute_path] if @checked_paths.key? absolute_path
@checked_paths[absolute_path] = File.exist? absolute_path
end
def absolute_path
path = file_path || @check.path
File.expand_path path, Dir.pwd
end
def ignores_pattern_check(links)
links.each do |ignore|
if ignore.is_a? String
return true if ignore == url
elsif ignore.is_a? Regexp
return true if ignore =~ url
end
end
false
end
def unslashed_directory?(file)
File.directory?(file) && !file.end_with?(File::SEPARATOR) && !follow_location?
end
def follow_location?
@check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
end
def base
@base ||= @html.at_css('base')
end
def html
# If link is on the same page, then URL is on the current page so can use the same HTML as for current page
if (hash_link || param_link) && internal?
@html
elsif slash_link && internal?
# link on another page, e.g. /about#Team - need to get HTML from the other page
create_nokogiri(absolute_path)
end
end
end
end