jekyll-link-checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab9d005b30ac7520a5f7912083966a50948c0d21d4e713bbb9639358dd033f77
+  data.tar.gz: ed02ed3ec9066ce54f4f74730c1de5d50206e83e39737eb8dead37ce4ae1f7ac
+SHA512:
+  metadata.gz: 35940136ad2ddb9ccac822abf3f1fe3999c52b92052e732c9eb846be0eadc21f9b9b3f6de2fe61b4395c7ded8706c9e57cd22ad86bf1fb6c6bcaa4446785d44a
+  data.tar.gz: ef06e898f334b7d6a49f10af2ab9a084e77bf890fca8cd37903083483363c8e81a4b41c8af7da96fb7318eda1701747cfd951295018cb427944c4bee8f5cb977

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/exe/jekyll-link-checker

@@ -0,0 +1,63 @@
+require 'optionparser'
+require 'yaml'
+require 'jekyll-link-checker'
+
+# Find the config file
+config = nil
+['.yml', '.yaml'].each do |ext|
+file = "_config#{ext}"
+begin
+  config = YAML.load_file(file)
+  break
+rescue
+end
+end
+
+link_checker = if config
+LinkChecker.from_config(config)
+else
+puts "`_config.yml` or `_config.yaml` couldn't be read"
+puts "The default configuration will be used"
+LinkChecker.new
+end
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: jekyll-link-checker [options]"
+
+  opts.on("-n HOSTNAME", "--hostname HOSTNAME", "Hostname of the site. Ex.: example.com") do |hostname|
+    link_checker.hostname = hostname
+  end
+  opts.on("-b BASEURL", "--baseurl BASEURL", "(this option is currently ignored)") do |baseurl|
+    link_checker.baseurl = baseurl
+  end
+  opts.on("-d SITE_FOLDER", "--site-folder SITE_FOLDER", "Path to the site's folder") do |site_folder|
+    link_checker.site_folder = site_folder
+  end
+  opts.on("-s [ARRAY]", "--skip-list [ARRAY]", Array, "Comma separated list of links not to check") do |skip_list|
+    link_checker.update_skip_list(skip_list)
+  end
+  opts.on("-S SKIP_LIST", "--skip-list-file SKIP_LIST", "File containing a list of links not to check. There must be one link per line.") do |skip_list|
+    link_checker.update_skip_list(skip_list)
+  end
+  opts.on("-m MODE", "--mode MODE", "try-head (default): Tries to do a HEAD request and then a GET request if HEAD didn't return a success status\n" \
+                                    "head-only: Only tries to do a HEAD request\n" \
+                                    "get-only: Only tries to do a GET request") do |mode|
+    link_checker.mode = mode
+  end
+  opts.on("-f", "--fail-fast", "Exits the program on the first invalid link") do |_|
+    link_checker.fail_fast = true
+  end
+  opts.on("-a", "--[no]-abort", "Abort the program on the first invalid link") do |abort_on_failure|
+    link_checker.abort_on_failure = abort_on_failure
+  end
+  opts.on("-V", "--verbose", "Run with verbose output") do |_|
+    link_checker.verbose = true
+  end
+  opts.on_tail("-v", "--version", "Outputs the version and exit") do |_|
+    puts JekyllLinkChecker::VERSION
+    exit
+  end
+end
+
+parser.parse!
+link_checker.check_links

data/lib/jekyll-hook.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+Jekyll::Hooks.register :site, :post_write, priority: 0 do |site|
+  link_checker = LinkChecker.from_config(site.config)
+  link_checker.check_links
+end

data/lib/jekyll-link-checker.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "link-checker"
+require_relative "jekyll-hook"
+require_relative "version"

data/lib/link-checker.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require "faraday-cookie_jar"
+require "addressable"
+require "pathname"
+
+# Checks all the links of a
+class LinkChecker
+  HEADERS = {
+    "User-Agent" => "Mozilla/5.0 (Windows NT 6.1) " \
+                    "AppleWebKit/537.36 (KHTML, like Gecko) " \
+                    "Chrome/41.0.2228.0 Safari/537.36",
+    "Accept" => "text/html," \
+                "application/xhtml+xml," \
+                "application/xml;" \
+                "q=0.9,*/*;q=0.8",
+    "Accept-Language" => "en-US,en;q=0.5",
+    "DNT" => "1",
+    "Upgrade-Insecure-Requests" => "1",
+    "Pragma" => "no-cache",
+    "Cache-Control" => "no-cache"
+  }.freeze
+
+  HREF = /href="([^#"\n][^"\n]*)"/.freeze
+  HTML = %w[.html .htm].freeze
+  SCHEMES = %w[https http].freeze
+
+  DEFAULT_BASE_URL = "/"
+  DEFAULT_SITE_FOLDER = "_site"
+  DEFAULT_MODE = "try_head"
+
+  attr_accessor :hostname, :baseurl, :site_folder, :skip_list, :mode, :verbose,
+                :fail_fast, :abort_on_failure
+  attr_writer :files, :html_files, :links
+
+  # Set default values for all the properties
+  def initialize(opts = {})
+    @hostname = opts[:hostname]
+    @baseurl = opts[:baseurl] || DEFAULT_BASE_URL
+    @site_folder = opts[:site_folder] || DEFAULT_SITE_FOLDER
+
+    update_skip_list(opts[:skip_list] || [])
+
+    @mode = opts[:mode] || DEFAULT_MODE
+    @verbose = opts[:verbose]
+    @fail_fast = opts[:fail_fast]
+
+    abort_on_failure = opts[:abort_on_failure]
+    @abort_on_failure = abort_on_failure.nil? ? true : abort_on_failure
+  end
+
+  # Initialize the link checker from a Jekyll configuration file
+  def self.from_config(config)
+    opts = {}
+
+    url = config["url"]
+    if url
+      uri = Addressable::URI.parse(url)
+      opts[:hostname] = uri.hostname
+    end
+
+    opts[:baseurl] = config["baseurl"]
+    opts[:site_folder] = config["destination"]
+
+    link_checker_config = config["link-checker"]
+    if link_checker_config
+      opts[:skip_list] = link_checker_config["skip-list"]
+      opts[:mode] = link_checker_config["mode"]
+      opts[:verbose] = link_checker_config["verbose"]
+      opts[:fail_fast] = link_checker_config["fail-fast"]
+      opts[:abort_on_failure] = link_checker_config["abort"]
+    end
+
+    LinkChecker.new(opts)
+  end
+
+  # Whether the options are valid
+  def valid?
+    return false unless @hostname
+
+    true
+  end
+
+  # Updates skip_list with the given argument.
+  # If the argument is an array, skip_list is set to the array.
+  # If the argument is a string, the argument will be interpreted as a filename
+  # where each line is a filename.
+  def update_skip_list(skip_list)
+    if skip_list.is_a?(Array)
+      @skip_list = skip_list
+    elsif skip_list.is_a?(String)
+      begin
+        @skip_list = File.readlines(File.expand_path(skip_list)).map(&:strip)
+      rescue StandardError => e
+        warn "Couldn't read the skip list"
+        raise e
+      end
+      @skip_list.reject!(&:empty?)
+    else
+      raise ArgumentError, "skip_list must be a String or an array of String"
+    end
+  end
+
+  # Checks all the links
+  def check_links
+    # Make sure the configuration is valid
+    abort "Invalid configuration" unless valid?
+
+    # basepath = @baseurl ? Addressable::URI.parse(@baseurl).path : "/"
+
+    conn = create_connection
+
+    # Test each link
+    error_count = 0
+    i = 0
+    prev_msg_size = 0
+    links.each do |link, files|
+      i += 1
+      if verbose
+        prev_msg_size.times { print " " }
+        msg = "#{link} #{i}/#{links.size}"
+        print "\r#{msg}\r"
+        prev_msg_size = msg.size
+      end
+
+      # Skip the link if it's in the skip list
+      next if @skip_list.include?(link)
+
+      # Parse the uri
+      uri = Addressable::URI.parse(link)
+      next if uri.site&.end_with?(":")
+
+      error = false
+
+      # If the link is internal
+      if uri.hostname.nil? || uri.hostname == hostname
+        uri.path.chomp!("/")
+
+        # If the uri can't be found in the site's file
+        unless valid_links.include?(uri.path)
+          puts "Invalid internal link '#{link}' is present in:"
+          files.each { |file| puts "\t#{file}" }
+          error = true
+        end
+      elsif uri.scheme.nil? || SCHEMES.include?(uri.scheme)
+        status = make_request(conn, link)
+        error = !status_allowed?(status)
+        puts "Request to #{link} in #{files} returned #{status}" if error
+      end
+
+      next unless error
+
+      error_count += 1
+      if fail_fast
+        abort if abort_on_failure
+        return nil
+      end
+    end
+
+    puts if verbose
+
+    if error_count != 0
+      msg = "There were #{error_count} invalid links"
+      if @abort_on_failure
+      then abort msg
+      else puts msg
+      end
+    end
+
+    error_count
+  end
+
+  # Find all files in the site folder
+  def files
+    return @files unless @files.nil?
+
+    @files = Dir[File.join(@site_folder, "**/*")].select { |f| File.file?(f) }
+    @files
+  end
+
+  # Find all the valid links for the site
+  def valid_links
+    return @valid_links if @valid_links
+
+    @valid_links = files.map do |file|
+      path = Pathname.new(file)
+      path = path.relative_path_from(@site_folder)
+      path = "/" + path.to_s
+      path.chomp!("index.html")
+      path.chomp!("/")
+      path
+    end
+  end
+
+  # Find all HTML files
+  def html_files
+    return @html_files if @html_files
+
+    @html_files = files.filter { |file| HTML.include?(File.extname(file)) }
+  end
+
+  # Find all links in html_files
+  def links
+    return @links if @links
+
+    @links = {}
+    html_files.each do |file|
+      File.open(file).read.scan(HREF)
+          .map { |match| match[0].strip }
+          .uniq.each do |link|
+        link_files = @links[link]
+        if link_files
+        then link_files.push(file)
+        else @links[link] = [file]
+        end
+      end
+    end
+    @links
+  end
+
+  private
+
+  # Create a connection to make requests
+  def create_connection
+    Faraday.new do |faraday|
+      faraday.use FaradayMiddleware::FollowRedirects
+      faraday.use :cookie_jar
+      faraday.adapter Faraday.default_adapter
+    end
+  end
+
+  # Make a request on the connection for the URL
+  def make_request(conn, url)
+    if @mode != "get_only"
+      response = conn.head(url, {}, HEADERS)
+      return response.status if mode == "head_only" ||
+                                status_allowed?(response.status)
+    end
+
+    conn.get(url, {}, HEADERS).status
+  end
+
+  # Returns whether the status is successfull
+  def status_allowed?(status)
+    status >= 200 && status < 300
+  end
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllLinkChecker
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-link-checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zakary Kamal Ismail
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Verifies that all the links in a Jekyll website are valid.It can also
+  work with any static site generator.
+email: zakary.kamal.fs@outlook.com
+executables:
+- jekyll-link-checker
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- exe/jekyll-link-checker
+- lib/jekyll-hook.rb
+- lib/jekyll-link-checker.rb
+- lib/link-checker.rb
+- lib/version.rb
+homepage: https://gitlab.com/ZakCodes/jekyll-link-checker
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/ZakCodes/jekyll-link-checker/issues
+  changelog_uri: https://gitlab.com/ZakCodes/jekyll-link-checker/-/releases
+  homepage_uri: https://gitlab.com/ZakCodes/jekyll-link-checker
+  source_code_uri: https://gitlab.com/ZakCodes/jekyll-link-checker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Checks all the links of a Jekyll website.
+test_files: []