Class: HTML::Proofer::Checkable
- Inherits:
-
Object
- Object
- HTML::Proofer::Checkable
- Defined in:
- lib/html/proofer/checkable.rb
Instance Method Summary collapse
- #absolute_path ⇒ Object
-
#exists? ⇒ Boolean
checks if a file exists relative to the current pwd.
-
#external? ⇒ Boolean
path is external to the file.
- #file_path ⇒ Object
- #hash ⇒ Object
- #ignore? ⇒ Boolean
-
#initialize(obj, check) ⇒ Checkable
constructor
A new instance of Checkable.
-
#internal? ⇒ Boolean
path is an anchor.
- #parts ⇒ Object
- #path ⇒ Object
-
#remote? ⇒ Boolean
path is to an external server.
- #url ⇒ Object
- #valid? ⇒ Boolean
Constructor Details
#initialize(obj, check) ⇒ Checkable
Returns a new instance of Checkable.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
# File 'lib/html/proofer/checkable.rb', line 4 def initialize(obj, check) @src = obj['src'] @href = obj['href'] @alt = obj['alt'] @name = obj['name'] @id = obj['id'] @data_ignore_proofer = obj['data-proofer-ignore'] @check = check @checked_paths = {} if @href && @check.[:href_swap] @check.[:href_swap].each do |link, replace| @href = @href.gsub(link, replace) end end end |
Instance Method Details
#absolute_path ⇒ Object
102 103 104 105 |
# File 'lib/html/proofer/checkable.rb', line 102 def absolute_path path = file_path || @check.path File. path, Dir.pwd end |
#exists? ⇒ Boolean
checks if a file exists relative to the current pwd
97 98 99 100 |
# File 'lib/html/proofer/checkable.rb', line 97 def exists? return @checked_paths[absolute_path] if @checked_paths.has_key? absolute_path @checked_paths[absolute_path] = File.exist? absolute_path end |
#external? ⇒ Boolean
path is external to the file
66 67 68 |
# File 'lib/html/proofer/checkable.rb', line 66 def external? !internal? end |
#file_path ⇒ Object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/html/proofer/checkable.rb', line 75 def file_path return if path.nil? if path =~ /^\// # path relative to root base = File.directory?(@check.src) ? @check.src : File.dirname(@check.src) elsif File.exist?(File. path, @check.src) # relative links, path is a file base = File.dirname @check.path elsif File.exist?(File.join(File.dirname(@check.path), path)) # 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.html support, with support for tailing slashes file = File.join path, "index.html" if File.directory? File. file, @check.src file end |
#hash ⇒ Object
42 43 44 |
# File 'lib/html/proofer/checkable.rb', line 42 def hash parts.fragment end |
#ignore? ⇒ Boolean
56 57 58 59 60 61 62 63 |
# File 'lib/html/proofer/checkable.rb', line 56 def ignore? uri = URI.parse url @data_ignore_proofer || %w( mailto ).include?(uri.scheme) || @check.additional_href_ignores.include?(url) rescue URI::BadURIError false rescue URI::InvalidURIError false end |
#internal? ⇒ Boolean
path is an anchor
71 72 73 |
# File 'lib/html/proofer/checkable.rb', line 71 def internal? url[0] == "#" end |
#parts ⇒ Object
34 35 36 |
# File 'lib/html/proofer/checkable.rb', line 34 def parts URI.parse url end |
#path ⇒ Object
38 39 40 |
# File 'lib/html/proofer/checkable.rb', line 38 def path parts.path end |
#remote? ⇒ Boolean
path is to an external server
47 48 49 50 51 52 53 54 |
# File 'lib/html/proofer/checkable.rb', line 47 def remote? uri = URI.parse url %w( http https ).include?(uri.scheme) rescue URI::BadURIError false rescue URI::InvalidURIError false end |
#url ⇒ Object
22 23 24 |
# File 'lib/html/proofer/checkable.rb', line 22 def url @src || @href || "" end |
#valid? ⇒ Boolean
26 27 28 29 30 31 32 |
# File 'lib/html/proofer/checkable.rb', line 26 def valid? begin URI.parse url rescue false end end |