Class: HTMLProofer::Element

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/html-proofer/element.rb

Overview

Represents the element currently being processed

Direct Known Subclasses

OpenGraphElement

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
 
# File 'lib/html-proofer/element.rb', line 11

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 = @aria_hidden == 'true' ? true : false

  @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 # remove document at the end
  @parent_ignorable = parent_attributes.any? { |a| !a['data-proofer-ignore'].nil? }

  # fix up missing protocols
  @href.insert 0, 'http:' if @href =~ %r{^//}
  @src.insert 0, 'http:' if @src =~ %r{^//}
  @srcset.insert 0, 'http:' if @srcset =~ %r{^//}
end

Instance Attribute Details

#alt ⇒ Object (readonly)

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 (readonly)

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 (readonly)

Returns the value of attribute href.



9
10
11
 
# File 'lib/html-proofer/element.rb', line 9

def href
  @href
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



9
10
11
 
# File 'lib/html-proofer/element.rb', line 9

def id
  @id
end

#line ⇒ Object (readonly)

Returns the value of attribute line.



9
10
11
 
# File 'lib/html-proofer/element.rb', line 9

def line
  @line
end

#link ⇒ Object (readonly)

Returns the value of attribute link.



9
10
11
 
# File 'lib/html-proofer/element.rb', line 9

def link
  @link
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



9
10
11
 
# File 'lib/html-proofer/element.rb', line 9

def name
  @name
end

#src ⇒ Object (readonly)

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 



172
173
174
175
 
# File 'lib/html-proofer/element.rb', line 172

def absolute_path
  path = file_path || @check.path
  File.expand_path path, Dir.pwd
end

#allow_hash_href? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/html-proofer/element.rb', line 101

def allow_hash_href?
  @check.options[:allow_hash_href]
end

#base ⇒ Object 



197
198
199
 
# File 'lib/html-proofer/element.rb', line 197

def base
  @base ||= @html.at_css('base')
end

#check_img_http? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/html-proofer/element.rb', line 105

def check_img_http?
  @check.options[:check_img_http]
end

#check_sri? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/html-proofer/element.rb', line 109

def check_sri?
  @check.options[:check_sri]
end

#exists? ⇒ Boolean

checks if a file exists relative to the current pwd

Returns:

  • (Boolean) 


167
168
169
170
 
# File 'lib/html-proofer/element.rb', line 167

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

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/html-proofer/element.rb', line 114

def external?
  !internal?
end

#file_path ⇒ Object 



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
 
# File 'lib/html-proofer/element.rb', line 135

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
    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)) # 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

  # implicit index support
  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

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/html-proofer/element.rb', line 193

def follow_location?
  @check.options[:typhoeus] && @check.options[:typhoeus][:followlocation]
end

#hash ⇒ Object 



61
62
63
 
# File 'lib/html-proofer/element.rb', line 61

def hash
  parts.fragment unless parts.nil?
end

#hash_link ⇒ Object 



123
124
125
 
# File 'lib/html-proofer/element.rb', line 123

def hash_link
  url.start_with?('#')
end

#html ⇒ Object 



201
202
203
204
205
206
207
208
209
 
# File 'lib/html-proofer/element.rb', line 201

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

#ignore? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/html-proofer/element.rb', line 78

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

#ignore_alt? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/html-proofer/element.rb', line 93

def ignore_alt?
  return true if ignores_pattern_check(@check.options[:alt_ignore]) || @aria_hidden
end

#ignore_empty_alt? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/html-proofer/element.rb', line 97

def ignore_empty_alt?
  @check.options[:empty_alt_ignore]
end

#ignores_pattern_check(links) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/html-proofer/element.rb', line 177

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

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/html-proofer/element.rb', line 119

def internal?
  hash_link || param_link || slash_link
end

#non_http_remote? ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/html-proofer/element.rb', line 74

def non_http_remote?
  !scheme.nil? && !remote?
end

#param_link ⇒ Object 



127
128
129
 
# File 'lib/html-proofer/element.rb', line 127

def param_link
  url.start_with?('?')
end

#parts ⇒ Object 



51
52
53
54
55
 
# File 'lib/html-proofer/element.rb', line 51

def parts
  @parts ||= Addressable::URI.parse url
rescue URI::Error, Addressable::URI::InvalidURIError => e
  @parts = nil
end

#path ⇒ Object 



57
58
59
 
# File 'lib/html-proofer/element.rb', line 57

def path
  Addressable::URI.unencode parts.path unless parts.nil?
end

#remote? ⇒ Boolean

path is to an external server

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/html-proofer/element.rb', line 70

def remote?
  %w[http https].include? scheme
end

#scheme ⇒ Object 



65
66
67
 
# File 'lib/html-proofer/element.rb', line 65

def scheme
  parts.scheme unless parts.nil?
end

#slash_link ⇒ Object 



131
132
133
 
# File 'lib/html-proofer/element.rb', line 131

def slash_link
  url.start_with?('|')
end

#unslashed_directory?(file) ⇒ Boolean

Returns:

  • (Boolean) 


189
190
191
 
# File 'lib/html-proofer/element.rb', line 189

def unslashed_directory?(file)
  File.directory?(file) && !file.end_with?(File::SEPARATOR) && !follow_location?
end

#url ⇒ Object 



39
40
41
42
43
44
45
 
# File 'lib/html-proofer/element.rb', line 39

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

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/html-proofer/element.rb', line 47

def valid?
  !parts.nil?
end