Class: HTMLProofer::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/html_proofer/configuration.rb

Defined Under Namespace

Modules: ConfigurationHelp

Constant Summary collapse

DEFAULT_TESTS = 
["Links", "Images", "Scripts"].freeze
PROOFER_DEFAULTS = 
{
  allow_hash_href: true,
  allow_missing_href: false,
  assume_extension: ".html",
  check_external_hash: true,
  check_internal_hash: true,
  checks: DEFAULT_TESTS,
  directory_index_files: ["index.html"],
  disable_external: false,
  ignore_empty_alt: true,
  ignore_empty_mailto: false,
  ignore_files: [],
  ignore_missing_alt: false,
  ignore_status_codes: [],
  ignore_urls: [],
  enforce_https: true,
  extensions: [".html"],
  log_level: :info,
  only_4xx: false,
  swap_attributes: {},
  swap_urls: {},
}.freeze
TYPHOEUS_DEFAULTS = 
{
  followlocation: true,
  headers: {
    "User-Agent" => "Mozilla/5.0 (compatible; HTML Proofer/#{HTMLProofer::VERSION}; +https://github.com/gjtorikian/html-proofer)",
    "Accept" => "application/xml,application/xhtml+xml,text/html;q=0.9, text/plain;q=0.8,image/png,*/*;q=0.5",
  },
  connecttimeout: 10,
  timeout: 30,
}.freeze
HYDRA_DEFAULTS = 
{
  max_concurrency: 50,
}.freeze
CACHE_DEFAULTS = 
{}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



69
70
71
 
# File 'lib/html_proofer/configuration.rb', line 69

def initialize
  @options = {}
end

Class Method Details

.generate_defaults(opts) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/html_proofer/configuration.rb', line 49

def generate_defaults(opts)
  # If `:directory_index_file` (singular) is given, convert it into an
  # array for `:directory_index_files` (plural) instead.
  if opts.key?(:directory_index_file)
    opts[:directory_index_files] = [opts.delete(:directory_index_file)]
  end

  options = PROOFER_DEFAULTS.merge(opts)

  options[:typhoeus] = HTMLProofer::Configuration::TYPHOEUS_DEFAULTS.merge(opts[:typhoeus] || {})
  options[:hydra] = HTMLProofer::Configuration::HYDRA_DEFAULTS.merge(opts[:hydra] || {})

  options[:cache] = HTMLProofer::Configuration::CACHE_DEFAULTS.merge(opts[:cache] || {})

  options.delete(:src)

  options
end

Instance Method Details

#parse_cli_options(args) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/html_proofer/configuration.rb', line 73

def parse_cli_options(args)
  define_options.parse!(args)

  input = ARGV.empty? ? "." : ARGV.join(",")

  [@options, input]
end

#parse_json_option(option_name, config, symbolize_names: true) ⇒ Object

Raises:

  • (ArgumentError) 


273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/html_proofer/configuration.rb', line 273

def parse_json_option(option_name, config, symbolize_names: true)
  raise ArgumentError, "Must provide an option name in string format." unless option_name.is_a?(String)
  raise ArgumentError, "Must provide an option name in string format." if option_name.strip.empty?

  return {} if config.nil?

  raise ArgumentError, "Must provide a JSON configuration in string format." unless config.is_a?(String)

  return {} if config.strip.empty?

  begin
    JSON.parse(config, { symbolize_names: symbolize_names })
  rescue StandardError
    raise ArgumentError, "Option '#{option_name} did not contain valid JSON."
  end
end