Class: HTML::Proofer

Inherits:
Object
  • Object
show all
Includes:
Yell::Loggable
Defined in:
lib/html/proofer.rb,
lib/html/proofer/checks.rb,
lib/html/proofer/checkable.rb

Defined Under Namespace

Classes: Checkable, Checks

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(src, opts = {}) ⇒ Proofer

Returns a new instance of Proofer.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/html/proofer.rb', line 13

def initialize(src, opts={})
  @src = src

  @proofer_opts = {
    :ext => ".html",
    :favicon => false,
    :href_swap => [],
    :href_ignore => [],
    :alt_ignore => [],
    :disable_external => false,
    :verbose => false,
    :as_link_array => false
  }
  @options = @proofer_opts.merge({:followlocation => true}).merge(opts)

  @failed_tests = []

  Yell.new({ :format => false, :name => "HTML::Proofer", :level => "gte.#{log_level}" }) do |l|
    l.adapter :stdout, level: [:debug, :info, :warn]
    l.adapter :stderr, level: [:error, :fatal]
  end
end

Instance Attribute Details

#failed_tests ⇒ Object

Returns the value of attribute failed_tests.



11
12
13
 
# File 'lib/html/proofer.rb', line 11

def failed_tests
  @failed_tests
end

Class Method Details

.create_nokogiri(path) ⇒ Object 



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

def self.create_nokogiri(path)
  path << "/index.html" if File.directory? path # support for Jekyll-style links
  content = File.open(path, "rb") {|f| f.read }
  Nokogiri::HTML(content)
end

Instance Method Details

the hypothesis is that Proofer runs way faster if we pull out all the external URLs and run the checks at the end. Otherwise, we’re halting the consuming process for every file. In addition, sorting the list lets libcurl keep connections to hosts alive. Finally, we’ll make a HEAD request, rather than GETing all the contents



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/html/proofer.rb', line 80

def external_link_checker(external_urls)
  external_urls = Hash[external_urls.sort]

  logger.info "Checking #{external_urls.length} external links...".yellow

  # Typhoeus won't let you pass any non-Typhoeus option
  @proofer_opts.each_key do |opt|
    @options.delete opt
  end

  Ethon.logger = logger # log from Typhoeus/Ethon

  external_urls.each_pair do |href, filenames|
    request = Typhoeus::Request.new(href, @options.merge({:method => :head}))
    request.on_complete { |response| response_handler(response, filenames) }
    hydra.queue request
  end
  logger.debug "Running requests for all #{hydra.queued_requests.size} external URLs...".yellow
  hydra.run
end

#files ⇒ Object 



138
139
140
141
142
143
144
 
# File 'lib/html/proofer.rb', line 138

def files
  if File.directory? @src
    Dir.glob("#{@src}/**/*#{@options[:ext]}")
  else
    File.extname(@src) == @options[:ext] ? [@src] : []
  end
end

#get_checks ⇒ Object 



152
153
154
155
156
 
# File 'lib/html/proofer.rb', line 152

def get_checks
  checks = HTML::Proofer::Checks::Check.subclasses.map { |c| c.name }
  checks.delete("Favicons") unless @options[:favicon]
  checks
end

#hydra ⇒ Object 



134
135
136
 
# File 'lib/html/proofer.rb', line 134

def hydra
  @hydra ||= Typhoeus::Hydra.new
end

#log_level ⇒ Object 



158
159
160
 
# File 'lib/html/proofer.rb', line 158

def log_level
  @options[:verbose] ? :debug : :info
end

#response_handler(response, filenames) ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/html/proofer.rb', line 101

def response_handler(response, filenames)
  href = response.options[:effective_url]
  method = response.request.options[:method]
  response_code = response.code

  debug_msg = "Received a #{response_code} for #{href}"
  debug_msg << " in #{filenames.join(' ')}" unless filenames.nil?
  logger.debug debug_msg

  if response_code.between?(200, 299)
    # continue with no op
  elsif response.timed_out?
    failed_test_msg = "External link #{href} failed: got a time out"
    failed_test_msg.insert(0, "#{filenames.join(' ').blue}: ") unless filenames.nil?
    @failed_tests << failed_test_msg
  elsif (response_code == 405 || response_code == 420 || response_code == 503) && method == :head
    # 420s usually come from rate limiting; let's ignore the query and try just the path with a GET
    uri = URI(href)
    next_response = Typhoeus.get(uri.scheme + "://" + uri.host + uri.path, @options)
    response_handler(next_response, filenames)
  # just be lazy; perform an explicit get request. some servers are apparently not configured to
  # intercept HTTP HEAD
  elsif method == :head
    next_response = Typhoeus.get(href, @options)
    response_handler(next_response, filenames)
  else
    # Received a non-successful http response.
    failed_test_msg = "External link #{href} failed: #{response_code} #{response.return_message}"
    failed_test_msg.insert(0, "#{filenames.join(' ').blue}: ") unless filenames.nil?
    @failed_tests << failed_test_msg
  end
end

#run ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/html/proofer.rb', line 36

def run
  unless @options[:as_link_array]
    total_files = 0
    external_urls = {}

    logger.info "Running #{get_checks} checks on #{@src} on *#{@options[:ext]}... \n\n".white

    files.each do |path|
      total_files += 1
      html = HTML::Proofer.create_nokogiri(path)

      get_checks.each do |klass|
        logger.debug "Checking #{klass.to_s.downcase} on #{path} ...".blue
        check =  Object.const_get(klass).new(@src, path, html, @options)
        check.run
        external_urls.merge!(check.external_urls)
        @failed_tests.concat(check.issues) if check.issues.length > 0
      end
    end

    external_link_checker(external_urls) unless @options[:disable_external]

    logger.info "Ran on #{total_files} files!\n\n".green
  else
    external_urls = Hash[*@src.map{ |s| [s, nil] }.flatten]
    external_link_checker(external_urls) unless @options[:disable_external]
  end

  if @failed_tests.empty?
    logger.info "HTML-Proofer finished successfully.".green
  else
    @failed_tests.sort.each do |issue|
      logger.error issue.to_s.red
    end

    raise "HTML-Proofer found #{@failed_tests.length} failures!".red
  end
end