Class: HTMLProofer::Element
- Inherits:
-
Object
- Object
- HTMLProofer::Element
show all
- Includes:
- Utils
- Defined in:
- lib/html-proofer/element.rb
Overview
Represents the element currently being processed
Instance Attribute Summary collapse
Instance Method Summary
collapse
Methods included from Utils
clean_content, create_nokogiri, #pluralize, swap
Constructor Details
#initialize(obj, check) ⇒ Element
Returns a new instance of Element.
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
|
# File 'lib/html-proofer/element.rb', line 11
def initialize(obj, check)
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.try(:attributes) }
parent_attributes.pop @parent_ignorable = parent_attributes.any? { |a| !a['data-proofer-ignore'].nil? }
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
|
Instance Attribute Details
#alt ⇒ Object
Returns the value of attribute alt.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def alt
@alt
end
|
#data_proofer_ignore ⇒ Object
Returns the value of attribute data_proofer_ignore.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def data_proofer_ignore
@data_proofer_ignore
end
|
#href ⇒ Object
Returns the value of attribute href.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def href
@href
end
|
#id ⇒ Object
Returns the value of attribute id.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def id
@id
end
|
#line ⇒ Object
Returns the value of attribute line.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def line
@line
end
|
#link ⇒ Object
Returns the value of attribute link.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def link
@link
end
|
#name ⇒ Object
Returns the value of attribute name.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def name
@name
end
|
#src ⇒ Object
Returns the value of attribute src.
9
10
11
|
# File 'lib/html-proofer/element.rb', line 9
def src
@src
end
|
Instance Method Details
#absolute_path ⇒ Object
192
193
194
195
|
# File 'lib/html-proofer/element.rb', line 192
def absolute_path
path = file_path || @check.path
File.expand_path path, Dir.pwd
end
|
#allow_hash_href? ⇒ Boolean
121
122
123
|
# File 'lib/html-proofer/element.rb', line 121
def allow_hash_href?
@check.options[:allow_hash_href]
end
|
#allow_missing_href? ⇒ Boolean
117
118
119
|
# File 'lib/html-proofer/element.rb', line 117
def allow_missing_href?
@check.options[:allow_missing_href]
end
|
#base ⇒ Object
217
218
219
|
# File 'lib/html-proofer/element.rb', line 217
def base
@base ||= @html.at_css('base')
end
|
#check_img_http? ⇒ Boolean
125
126
127
|
# File 'lib/html-proofer/element.rb', line 125
def check_img_http?
@check.options[:check_img_http]
end
|
#check_sri? ⇒ Boolean
129
130
131
|
# File 'lib/html-proofer/element.rb', line 129
def check_sri?
@check.options[:check_sri]
end
|
#exists? ⇒ Boolean
checks if a file exists relative to the current pwd
187
188
189
190
|
# File 'lib/html-proofer/element.rb', line 187
def exists?
return @checked_paths[absolute_path] if @checked_paths.key? absolute_path
@checked_paths[absolute_path] = File.exist? absolute_path
end
|
#external? ⇒ Boolean
path is external to the file
134
135
136
|
# File 'lib/html-proofer/element.rb', line 134
def external?
!internal?
end
|
#file_path ⇒ Object
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
|
# File 'lib/html-proofer/element.rb', line 155
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{^/} base = File.directory?(@check.src) ? @check.src : File.dirname(@check.src)
elsif File.exist?(File.expand_path(path, @check.src)) || File.exist?(File.expand_path(path_dot_ext, @check.src)) 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)) base = File.dirname @check.path
else base = @check.path
end
file = File.join base, path
if File.directory?(file) && !unslashed_directory?(file)
file = File.join file, @check.options[:directory_index_file]
elsif @check.options[:assume_extension] && File.file?("#{file}#{@check.options[:extension]}")
file = "#{file}#{@check.options[:extension]}"
end
file
end
|
#follow_location? ⇒ Boolean
213
214
215
|
# File 'lib/html-proofer/element.rb', line 213
def follow_location?
@check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
end
|
#hash ⇒ Object
77
78
79
|
# File 'lib/html-proofer/element.rb', line 77
def hash
parts.fragment unless parts.nil?
end
|
#hash_link ⇒ Object
143
144
145
|
# File 'lib/html-proofer/element.rb', line 143
def hash_link
url.start_with?('#')
end
|
#html ⇒ Object
221
222
223
224
225
226
227
228
229
|
# File 'lib/html-proofer/element.rb', line 221
def html
if (hash_link || param_link) && internal?
@html
elsif slash_link && internal?
create_nokogiri(absolute_path)
end
end
|
#ignore? ⇒ Boolean
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
# File 'lib/html-proofer/element.rb', line 94
def ignore?
return true if @data_proofer_ignore
return true if @parent_ignorable
return true if url =~ /^javascript:/
if %w[ImageCheck FaviconCheck].include? @type
return true if url =~ /^data:image/
end
return true if ignores_pattern_check(@check.options[:url_ignore])
end
|
#ignore_alt? ⇒ Boolean
109
110
111
|
# File 'lib/html-proofer/element.rb', line 109
def ignore_alt?
return true if ignores_pattern_check(@check.options[:alt_ignore]) || @aria_hidden
end
|
#ignore_empty_alt? ⇒ Boolean
113
114
115
|
# File 'lib/html-proofer/element.rb', line 113
def ignore_empty_alt?
@check.options[:empty_alt_ignore]
end
|
#ignores_pattern_check(links) ⇒ Object
197
198
199
200
201
202
203
204
205
206
207
|
# File 'lib/html-proofer/element.rb', line 197
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
|
#internal? ⇒ Boolean
path is an anchor or a query
139
140
141
|
# File 'lib/html-proofer/element.rb', line 139
def internal?
hash_link || param_link || slash_link
end
|
#non_http_remote? ⇒ Boolean
90
91
92
|
# File 'lib/html-proofer/element.rb', line 90
def non_http_remote?
!scheme.nil? && !remote?
end
|
#param_link ⇒ Object
147
148
149
|
# File 'lib/html-proofer/element.rb', line 147
def param_link
url.start_with?('?')
end
|
#parts ⇒ Object
67
68
69
70
71
|
# File 'lib/html-proofer/element.rb', line 67
def parts
@parts ||= Addressable::URI.parse url
rescue URI::Error, Addressable::URI::InvalidURIError
@parts = nil
end
|
#path ⇒ Object
73
74
75
|
# File 'lib/html-proofer/element.rb', line 73
def path
Addressable::URI.unencode parts.path unless parts.nil?
end
|
#remote? ⇒ Boolean
path is to an external server
86
87
88
|
# File 'lib/html-proofer/element.rb', line 86
def remote?
%w[http https].include? scheme
end
|
#scheme ⇒ Object
81
82
83
|
# File 'lib/html-proofer/element.rb', line 81
def scheme
parts.scheme unless parts.nil?
end
|
#slash_link ⇒ Object
151
152
153
|
# File 'lib/html-proofer/element.rb', line 151
def slash_link
url.start_with?('|')
end
|
#unslashed_directory?(file) ⇒ Boolean
209
210
211
|
# File 'lib/html-proofer/element.rb', line 209
def unslashed_directory?(file)
File.directory?(file) && !file.end_with?(File::SEPARATOR) && !follow_location?
end
|
#url ⇒ Object
55
56
57
58
59
60
61
|
# File 'lib/html-proofer/element.rb', line 55
def url
return @url if defined?(@url)
@url = (@src || @srcset || @href || '').delete("\u200b")
@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
|
#valid? ⇒ Boolean
63
64
65
|
# File 'lib/html-proofer/element.rb', line 63
def valid?
!parts.nil?
end
|