class Overcommit::Hook::PreCommit::W3cHtml

Runs `w3c_validators` against any modified HTML files.

@see github.com/alexdunae/w3c_validators

Public Instance Methods

run() click to toggle source
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 8
def run
  collect_messages
rescue W3CValidators::ParsingError,
       W3CValidators::ValidatorUnavailable => e
  [:fail, e.message]
end

Private Instance Methods

charset() click to toggle source

Values specified at

http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#CHARSETS
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 54
def charset
  @charset ||= config['charset']
end
collect_messages() click to toggle source
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 17
def collect_messages
  applicable_files.collect do |path|
    results = validator.validate_file(path)
    messages = results.errors + results.warnings
    messages.collect do |msg|
      # Some warnings are not per-line, so use 0 as a default
      line = Integer(msg.line || 0)

      # Build message by hand to reduce noise from the validator response
      text = "#{msg.type.to_s.upcase}; URI: #{path}; line #{line}: #{msg.message.strip}"
      Overcommit::Hook::Message.new(msg.type, path, line, text)
    end
  end.flatten
end
doctype() click to toggle source

Values specified at

http://www.rubydoc.info/gems/w3c_validators/1.2/W3CValidators#DOCTYPES
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 60
def doctype
  @doctype ||= config['doctype']
end
opts() click to toggle source
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 42
def opts
  @opts ||= {
    validator_uri: config['validator_uri'],
    proxy_server:  config['proxy_server'],
    proxy_port:    config['proxy_port'],
    proxy_user:    config['proxy_user'],
    proxy_pass:    config['proxy_pass']
  }
end
validator() click to toggle source
# File lib/overcommit/hook/pre_commit/w3c_html.rb, line 32
def validator
  unless @validator
    @validator = W3CValidators::MarkupValidator.new(opts)
    @validator.set_charset!(charset, true) unless charset.nil?
    @validator.set_doctype!(doctype, true) unless doctype.nil?
    @validator.set_debug!
  end
  @validator
end