class Webby::LinkValidator

The Webby LinkValidator class is used to validate the hyperlinks of all the HTML files in the output directory. By default, only links to other pages in the output directory are checked. However, setting the :external flag to true will cause hyperlinks to external web sites to be validated as well.

Attributes

validate_externals[RW]

Public Class Methods

new( opts = {} ) click to toggle source

Creates a new LinkValidator object. The only supported option is the :external flag. When set to true, the link validator will also check out links to external websites. This is done by opening a connection to the remote site and pulling down the page specified in the hyperlink. Use with caution.

# File lib/webby/link_validator.rb, line 32
def initialize( opts = {} )
  @log = Logging::Logger[self]

  glob = ::File.join(::Webby.site.output_dir, '**', '*.html')
  @files = Dir.glob(glob).sort
  @attr_rgxp = /\[@(\w+)\]$/o

  @validate_externals = opts.getopt(:external, false)
  @valid_uris = ::Webby.site.valid_uris.flatten
  @invalid_uris = []
end
validate( opts = {} ) click to toggle source

A lazy man's method that will instantiate a new link validator and run the validations.

# File lib/webby/link_validator.rb, line 17
def self.validate( opts = {} )
  new(opts).validate
end

Public Instance Methods

check_file( fn ) click to toggle source

Check the given file (identified by its filename {fn for short here}) by iterating through all the configured xpaths and validating that those hyperlinks ae valid.

# File lib/webby/link_validator.rb, line 55
def check_file( fn )
  @log.info "validating #{fn}"

  dir = ::File.dirname(fn)
  doc = Hpricot(::File.read(fn))

  ::Webby.site.xpaths.each do |xpath|
    @attr_name = nil

    doc.search(xpath).each do |element|
      attr_name ||= @attr_rgxp.match(xpath)[1]
      uri = URI.parse(element.get_attribute(attr_name))
      validate_uri(uri, dir, doc)
    end
  end
  return nil # side effect of original implementation
end
validate() click to toggle source

Iterate over all the HTML files in the output directory and validate the hyperlinks.

# File lib/webby/link_validator.rb, line 47
def validate
  @files.each {|fn| check_file fn}
end
validate_anchor( uri, doc ) click to toggle source

Validate that the anchor fragment of the URI exists in the given document. The document is an Hpricot document object.

Returns true if the anchor exists in the document and false if it does not.

# File lib/webby/link_validator.rb, line 100
def validate_anchor( uri, doc )
  return false if uri.fragment.nil?

  anchor = '#' + uri.fragment
  if doc.at(anchor).nil?
    @log.error "invalid URI '#{uri.to_s}'"
    false
  else true end
end
validate_external_uri( uri, dir, doc ) click to toggle source

Validate that an external URI can be opened

# File lib/webby/link_validator.rb, line 140
def validate_external_uri( uri, dir, doc )
  return unless @validate_externals

  if @invalid_uris.include? uri.to_s
    @log.error "could not open URI '#{uri.to_s}'"
    return
  end

  begin
    uri.open {|_| nil}
    @valid_uris << uri.to_s
  rescue Exception
    @log.error "could not open URI '#{uri.to_s}'"
    @invalid_uris << uri.to_s
  end 
end
validate_relative_uri( uri, dir, doc ) click to toggle source

Validate that the file pointed to by the relative URI exists in the output directory. If the URI has an anchor, validate that the anchor exists as well.

# File lib/webby/link_validator.rb, line 114
def validate_relative_uri( uri, dir, doc )
  return validate_anchor(uri, doc) if uri.path.empty?

  path = if uri.path =~ /^\//
      ::File.join(::Webby.site.output_dir, uri.path)
    else
      ::File.join(dir, uri.path)
    end
  path = ::File.join(path, 'index.html') if ::File.extname(path).empty?

  uri_str = path.dup
  (uri_str << '#' << uri.fragment) if uri.fragment
  return if @valid_uris.include? uri_str

  if test ?f, path
    valid = if uri.fragment
        validate_anchor(uri, Hpricot(::File.read(path)))
      else true end
    @valid_uris << uri_str if valid
  else
    @log.error "invalid URI '#{uri.to_s}'"
  end
end
validate_uri( uri, dir, doc ) click to toggle source

Validate the the page the uri refers to actually exists. The directory of the current page being processed is needed in order to resolve relative paths.

If the uri is a relative path, then the output directory is searched for the appropriate page. If the uri is an absolute path, then the remote server is contacted and the page requested from the server. This will only take place if the LinkValidator was created with the :external flag set to true.

# File lib/webby/link_validator.rb, line 83
def validate_uri( uri, dir, doc )
  # do not retry external uris that have already been validated
  return if @valid_uris.include? uri.to_s

  return validate_relative_uri(uri, dir, doc) if uri.relative?
  return validate_external_uri(uri, dir, doc) if uri.respond_to? :open

  # otherwise, post a warning that the URI could not be validated
  @log.warn "could not validate URI '#{uri.to_s}'"
end