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.
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
|
# File 'lib/html-proofer/element.rb', line 13
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.respond_to?(:attributes) && a.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.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def alt
@alt
end
|
#data_proofer_ignore ⇒ Object
Returns the value of attribute data_proofer_ignore.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def data_proofer_ignore
@data_proofer_ignore
end
|
#href ⇒ Object
Returns the value of attribute href.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def href
@href
end
|
#id ⇒ Object
Returns the value of attribute id.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def id
@id
end
|
#line ⇒ Object
Returns the value of attribute line.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def line
@line
end
|
#link ⇒ Object
Returns the value of attribute link.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def link
@link
end
|
#name ⇒ Object
Returns the value of attribute name.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def name
@name
end
|
#src ⇒ Object
Returns the value of attribute src.
11
12
13
|
# File 'lib/html-proofer/element.rb', line 11
def src
@src
end
|
Instance Method Details
#absolute_path ⇒ Object
193
194
195
196
|
# File 'lib/html-proofer/element.rb', line 193
def absolute_path
path = file_path || @check.path
File.expand_path path, Dir.pwd
end
|
#allow_hash_href? ⇒ Boolean
123
124
125
|
# File 'lib/html-proofer/element.rb', line 123
def allow_hash_href?
@check.options[:allow_hash_href]
end
|
#allow_missing_href? ⇒ Boolean
119
120
121
|
# File 'lib/html-proofer/element.rb', line 119
def allow_missing_href?
@check.options[:allow_missing_href]
end
|
#base ⇒ Object
218
219
220
|
# File 'lib/html-proofer/element.rb', line 218
def base
@base ||= @html.at_css('base')
end
|
#check_img_http? ⇒ Boolean
127
128
129
|
# File 'lib/html-proofer/element.rb', line 127
def check_img_http?
@check.options[:check_img_http]
end
|
#check_sri? ⇒ Boolean
131
132
133
|
# File 'lib/html-proofer/element.rb', line 131
def check_sri?
@check.options[:check_sri]
end
|
#exists? ⇒ Boolean
checks if a file exists relative to the current pwd
188
189
190
191
|
# File 'lib/html-proofer/element.rb', line 188
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
136
137
138
|
# File 'lib/html-proofer/element.rb', line 136
def external?
!internal?
end
|
#file_path ⇒ Object
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
|
# File 'lib/html-proofer/element.rb', line 157
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 @check.options[:assume_extension] && File.file?("#{file}#{@check.options[:extension]}")
file = "#{file}#{@check.options[:extension]}"
elsif File.directory?(file) && !unslashed_directory?(file) file = File.join file, @check.options[:directory_index_file]
end
file
end
|
#follow_location? ⇒ Boolean
214
215
216
|
# File 'lib/html-proofer/element.rb', line 214
def follow_location?
@check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
end
|
#hash ⇒ Object
79
80
81
|
# File 'lib/html-proofer/element.rb', line 79
def hash
parts.fragment unless parts.nil?
end
|
#hash_link ⇒ Object
145
146
147
|
# File 'lib/html-proofer/element.rb', line 145
def hash_link
url.start_with?('#')
end
|
#html ⇒ Object
222
223
224
225
226
227
228
229
230
|
# File 'lib/html-proofer/element.rb', line 222
def html
if (hash_link || param_link) && internal?
@html
elsif slash_link && internal?
create_nokogiri(absolute_path)
end
end
|
#ignore? ⇒ Boolean
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
# File 'lib/html-proofer/element.rb', line 96
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
111
112
113
|
# File 'lib/html-proofer/element.rb', line 111
def ignore_alt?
return true if ignores_pattern_check(@check.options[:alt_ignore]) || @aria_hidden
end
|
#ignore_empty_alt? ⇒ Boolean
115
116
117
|
# File 'lib/html-proofer/element.rb', line 115
def ignore_empty_alt?
@check.options[:empty_alt_ignore]
end
|
#ignores_pattern_check(links) ⇒ Object
198
199
200
201
202
203
204
205
206
207
208
|
# File 'lib/html-proofer/element.rb', line 198
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
141
142
143
|
# File 'lib/html-proofer/element.rb', line 141
def internal?
hash_link || param_link || slash_link
end
|
#non_http_remote? ⇒ Boolean
92
93
94
|
# File 'lib/html-proofer/element.rb', line 92
def non_http_remote?
!scheme.nil? && !remote?
end
|
#param_link ⇒ Object
149
150
151
|
# File 'lib/html-proofer/element.rb', line 149
def param_link
url.start_with?('?')
end
|
#parts ⇒ Object
69
70
71
72
73
|
# File 'lib/html-proofer/element.rb', line 69
def parts
@parts ||= Addressable::URI.parse url
rescue URI::Error, Addressable::URI::InvalidURIError
@parts = nil
end
|
#path ⇒ Object
75
76
77
|
# File 'lib/html-proofer/element.rb', line 75
def path
Addressable::URI.unencode parts.path unless parts.nil?
end
|
#remote? ⇒ Boolean
path is to an external server
88
89
90
|
# File 'lib/html-proofer/element.rb', line 88
def remote?
%w[http https].include? scheme
end
|
#scheme ⇒ Object
83
84
85
|
# File 'lib/html-proofer/element.rb', line 83
def scheme
parts.scheme unless parts.nil?
end
|
#slash_link ⇒ Object
153
154
155
|
# File 'lib/html-proofer/element.rb', line 153
def slash_link
url.start_with?('|')
end
|
#unslashed_directory?(file) ⇒ Boolean
210
211
212
|
# File 'lib/html-proofer/element.rb', line 210
def unslashed_directory?(file)
File.directory?(file) && !file.end_with?(File::SEPARATOR) && !follow_location?
end
|
#url ⇒ Object
57
58
59
60
61
62
63
|
# File 'lib/html-proofer/element.rb', line 57
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
|
#valid? ⇒ Boolean
65
66
67
|
# File 'lib/html-proofer/element.rb', line 65
def valid?
!parts.nil?
end
|