Class: HTML::Proofer
- Inherits:
-
Object
- Object
- HTML::Proofer
- Includes:
- Yell::Loggable
- Defined in:
- lib/html/proofer.rb,
lib/html/proofer/checks.rb,
lib/html/proofer/checkable.rb
Defined Under Namespace
Instance Attribute Summary collapse
-
#failed_tests ⇒ Object
Returns the value of attribute failed_tests.
Class Method Summary collapse
Instance Method Summary collapse
- #files ⇒ Object
- #get_checks ⇒ Object
- #hydra ⇒ Object
-
#initialize(src, opts = {}) ⇒ Proofer
constructor
A new instance of Proofer.
- #log_level ⇒ Object
- #response_handler(response, filenames) ⇒ Object
- #run ⇒ Object
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 |
# File 'lib/html/proofer.rb', line 13 def initialize(src, opts={}) @srcDir = src @proofer_opts = { :ext => ".html", :favicon => false, :href_swap => [], :href_ignore => [], :alt_ignore => [], :disable_external => false, :verbose => 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
132 133 134 135 136 |
# File 'lib/html/proofer.rb', line 132 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
#files ⇒ Object
124 125 126 127 128 129 130 |
# File 'lib/html/proofer.rb', line 124 def files if File.directory? @srcDir Dir.glob("#{@srcDir}/**/*#{@options[:ext]}") else File.extname(@srcDir) == @options[:ext] ? [@srcDir] : [] end end |
#get_checks ⇒ Object
138 139 140 |
# File 'lib/html/proofer.rb', line 138 def get_checks HTML::Proofer::Checks::Check.subclasses end |
#hydra ⇒ Object
120 121 122 |
# File 'lib/html/proofer.rb', line 120 def hydra @hydra ||= Typhoeus::Hydra.new end |
#log_level ⇒ Object
142 143 144 |
# File 'lib/html/proofer.rb', line 142 def log_level @options[:verbose] ? :debug : :info end |
#response_handler(response, filenames) ⇒ Object
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/html/proofer.rb', line 93 def response_handler(response, filenames) href = response.[:effective_url] method = response.request.[:method] response_code = response.code logger.debug "Received a #{response_code} for #{href} in #{filenames.join(' ')}" if response_code.between?(200, 299) # continue with no op elsif response.timed_out? @failed_tests << "#{filenames.join(' ').blue}: External link #{href} failed: got a time out" 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_tests << "#{filenames.join(' ').blue}: External link #{href} failed: #{response_code} #{response.}" end end |
#run ⇒ Object
35 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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/html/proofer.rb', line 35 def run total_files = 0 external_urls = {} logger.info "Running #{get_checks} checks on #{@srcDir} 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 = klass.new(@srcDir, path, html, @options) check.run external_urls.merge!(check.external_urls) @failed_tests.concat(check.issues) if check.issues.length > 0 end end # 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 external_urls = Hash[external_urls.sort] unless @options[:disable_external] 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 logger.info "Ran on #{total_files} files!\n\n".green 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 |