Class: HTMLProofer::Element

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

Overview

Represents the element currently being processed

Constant Summary

Constants included from Utils

Utils::STORAGE_DIR

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
# 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_sym
    (class << self; self; end).send(:attr_reader, name)
    instance_variable_set("@#{name}", value.value)
  end

  @text = obj.content
  @check = check
  @checked_paths = {}
  @type = check.class.name
  @line = obj.line

  @html = check.html

  # 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

#altObject (readonly)

Returns the value of attribute alt


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

def alt
  @alt
end

#data_proofer_ignoreObject (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

#hrefObject (readonly)

Returns the value of attribute href


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

def href
  @href
end

#idObject (readonly)

Returns the value of attribute id


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

def id
  @id
end

#lineObject (readonly)

Returns the value of attribute line


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

def line
  @line
end

Returns the value of attribute link


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

def link
  @link
end

#nameObject (readonly)

Returns the value of attribute name


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

def name
  @name
end

#srcObject (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_pathObject


151
152
153
154
# File 'lib/html-proofer/element.rb', line 151

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

#allow_hash_href?Boolean

Returns:

  • (Boolean)

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

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

#baseObject


176
177
178
# File 'lib/html-proofer/element.rb', line 176

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

#check_img_http?Boolean

Returns:

  • (Boolean)

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

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

#exists?Boolean

checks if a file exists relative to the current pwd

Returns:

  • (Boolean)

146
147
148
149
# File 'lib/html-proofer/element.rb', line 146

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)

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

def external?
  !internal?
end

#file_pathObject


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

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)

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

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

#hashObject


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

def hash
  parts.fragment unless parts.nil?
end

#ignore?Boolean

Returns:

  • (Boolean)

74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/html-proofer/element.rb', line 74

def ignore?
  return true if @data_proofer_ignore

  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)

88
89
90
# File 'lib/html-proofer/element.rb', line 88

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

#ignore_empty_alt?Boolean

Returns:

  • (Boolean)

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

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

#ignores_pattern_check(links) ⇒ Object


156
157
158
159
160
161
162
163
164
165
166
# File 'lib/html-proofer/element.rb', line 156

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)

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

def internal?
  url.start_with? '#', '?'
end

#non_http_remote?Boolean

Returns:

  • (Boolean)

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

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

#partsObject


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

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

#pathObject


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

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

#remote?Boolean

path is to an external server

Returns:

  • (Boolean)

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

def remote?
  %w( http https ).include? scheme
end

#schemeObject


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

def scheme
  parts.scheme unless parts.nil?
end

#unslashed_directory?(file) ⇒ Boolean

Returns:

  • (Boolean)

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

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

#urlObject


33
34
35
36
37
38
39
40
41
# File 'lib/html-proofer/element.rb', line 33

def url
  return @url if defined?(@url)
  @url = (@src || @srcset || @href || '').gsub("\u200b", '')
  if base
    @url = Addressable::URI.join(base.attr('href'), url).to_s
  end
  return @url if @check.options[:url_swap].empty?
  @url = swap(@url, @check.options[:url_swap])
end

#valid?Boolean

Returns:

  • (Boolean)

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

def valid?
  !parts.nil?
end