Module: HTMLProofer

Defined in:
lib/html_proofer.rb,
lib/html_proofer/cli.rb,
lib/html_proofer/log.rb,
lib/html_proofer/cache.rb,
lib/html_proofer/check.rb,
lib/html_proofer/utils.rb,
lib/html_proofer/runner.rb,
lib/html_proofer/element.rb,
lib/html_proofer/failure.rb,
lib/html_proofer/version.rb,
lib/html_proofer/reporter.rb,
lib/html_proofer/attribute.rb,
lib/html_proofer/check/links.rb,
lib/html_proofer/check/images.rb,
lib/html_proofer/attribute/url.rb,
lib/html_proofer/check/favicon.rb,
lib/html_proofer/check/scripts.rb,
lib/html_proofer/configuration.rb,
lib/html_proofer/url_validator.rb,
lib/html_proofer/xpath_functions.rb,
lib/html_proofer/check/open_graph.rb,
lib/html_proofer/reporter/terminal.rb,
lib/html_proofer/url_validator/external.rb,
lib/html_proofer/url_validator/internal.rb

Defined Under Namespace

Modules: Utils Classes: Attribute, CLI, Cache, Check, Configuration, Element, Failure, Log, Reporter, Runner, UrlValidator, XpathFunctions

Constant Summary collapse

VERSION = 
"5.0.6"

Class Method Summary collapse

Class Method Details

.check_directories(directories, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


40
41
42
43
44
45
46
47
48
 
# File 'lib/html_proofer.rb', line 40

def check_directories(directories, options = {})
  raise ArgumentError unless directories.is_a?(Array)

  options[:type] = :directory
  directories.each do |directory|
    raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)
  end
  HTMLProofer::Runner.new(directories, options)
end

.check_directory(directory, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


32
33
34
35
36
37
38
 
# File 'lib/html_proofer.rb', line 32

def check_directory(directory, options = {})
  raise ArgumentError unless directory.is_a?(String)
  raise ArgumentError, "#{directory} does not exist" unless Dir.exist?(directory)

  options[:type] = :directory
  HTMLProofer::Runner.new([directory], options)
end

.check_file(file, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


24
25
26
27
28
29
30
 
# File 'lib/html_proofer.rb', line 24

def check_file(file, options = {})
  raise ArgumentError, "File isn't a string" unless file.is_a?(String)
  raise ArgumentError, "#{file} does not exist" unless File.exist?(file)

  options[:type] = :file
  HTMLProofer::Runner.new(file, options)
end

.check_links(links, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


50
51
52
53
54
55
 
# File 'lib/html_proofer.rb', line 50

def check_links(links, options = {})
  raise ArgumentError unless links.is_a?(Array)

  options[:type] = :links
  HTMLProofer::Runner.new(links, options)
end