class Nanoc::Extra::Checking::Checks::InternalLinks

A check that verifies that all internal links point to a location that exists.

@api private

Public Instance Methods

run() click to toggle source

Starts the validator. The results will be printed to stdout.

Internal links that match a regexp pattern in `@config[:internal_links]` will be skipped.

@return [void]

# File lib/nanoc/extra/checking/checks/internal_links.rb, line 14
def run
  # TODO: de-duplicate this (duplicated in external links check)
  filenames = output_filenames.select { |f| File.extname(f) == '.html' }
  hrefs_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_href
  hrefs_with_filenames.each_pair do |href, fns|
    fns.each do |filename|
      next if valid?(href, filename)

      add_issue(
        "broken reference to #{href}",
        subject: filename)
    end
  end
end

Protected Instance Methods

excluded?(href) click to toggle source
# File lib/nanoc/extra/checking/checks/internal_links.rb, line 68
def excluded?(href)
  excludes = @config.fetch(:checks, {}).fetch(:internal_links, {}).fetch(:exclude, [])
  excludes.any? { |pattern| Regexp.new(pattern).match(href) }
end
valid?(href, origin) click to toggle source
# File lib/nanoc/extra/checking/checks/internal_links.rb, line 31
def valid?(href, origin)
  # Skip hrefs that point to self
  # FIXME: this is ugly and won’t always be correct
  return true if href == '.'

  # Skip hrefs that are specified in the exclude configuration
  return true if excluded?(href)

  # Remove target
  path = href.sub(/#.*$/, '')
  return true if path.empty?

  # Remove query string
  path = path.sub(/\?.*$/, '')
  return true if path.empty?

  # Decode URL (e.g. '%20' -> ' ')
  path = URI.unescape(path)

  # Make absolute
  path =
    if path[0, 1] == '/'
      @config[:output_dir] + path
    else
      ::File.expand_path(path, ::File.dirname(origin))
    end

  # Check whether file exists
  return true if File.file?(path)

  # Check whether directory with index file exists
  return true if File.directory?(path) && @config[:index_filenames].any? { |fn| File.file?(File.join(path, fn)) }

  # Nope :(
  false
end