jekyll-link-checker 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651ec0822b7f2a5acf4000eb0a6d61a41ee52d02ef9f761387fccebe010756fc
-  data.tar.gz: 1f2ce68855ff4c8806c55fbc8bb18d8152adffca6e19d7c698a7998d258169f9
+  metadata.gz: 95ce2357aa0eaea04dbc5695f935918cfb98b8a76786dfb2c9317579e8801a4f
+  data.tar.gz: 2e1cbde04eaa0f36daf75027f14a45364a57b203409d30abfd353d82a1242235
 SHA512:
-  metadata.gz: dbf951f15490ccc110cbd58fc277e6375521d42d30c5f9b202624c39ce4ba6d6a3042282a51e9d9f8fc7b706cca9c91fcfa2f421032c2a36b6cf10894a7e7429
-  data.tar.gz: 6001df2b2bee99cb2ac04a8b1481de2b7553c11e3e48868b44c0328e17faf88efee79aaeebe54bd8a626febae969cc344eef04f44f0e92ea83c4dd25902b977d
+  metadata.gz: d77c8b80e72b2ff133b2188eed42c60fb07e174997097d9b7f4c558833bbe3db75b2c91c308a566f3f6fe757056c0a6c1913942062d886180ea552d15ea48348
+  data.tar.gz: 7b2714ae7ebe65845a225d882091d3c34a0aa62a4e5104cc577296a759d37a0fde82369e85c0d420d6383e7690be774f3185490a4d835ad44b06a99dce03fbc0

data/exe/jekyll-link-checker

@@ -39,15 +39,19 @@ parser = OptionParser.new do |opts|
   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" \
+  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",
+                                    "head-only: Only tries to do a HEAD request",
                                     "get-only: Only tries to do a GET request") do |mode|
     link_checker.mode = mode
   end
+  opts.on("-i", "--[no-]ignore-fragments", "Whether to ignore the fragments " \
+                                             "in links. Defaults to false.") do |ignore_fragments|
+    link_checker.ignore_fragments = ignore_fragments
+  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|
+  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 |_|

data/lib/link-checker.rb

@@ -6,7 +6,7 @@ require "faraday-cookie_jar"
 require "addressable"
 require "pathname"
 
-# Checks all the links of a
+# Checks all the links of a static website to make sure they're all valid
 class LinkChecker
   HEADERS = {
     "User-Agent" => "Mozilla/5.0 (Windows NT 6.1) " \
@@ -23,7 +23,8 @@ class LinkChecker
     "Cache-Control" => "no-cache"
   }.freeze
 
-  HREF = /href="([^#"\n][^"\n]*)"/.freeze
+  HREF = /href="([^"\n]+)"/.freeze
+  ID = /id="([^"\n]+)"/.freeze
   HTML = %w[.html .htm].freeze
   SCHEMES = %w[https http].freeze
 
@@ -32,7 +33,7 @@ class LinkChecker
   DEFAULT_MODE = "try_head"
 
   attr_accessor :hostname, :baseurl, :site_folder, :skip_list, :mode, :verbose,
-                :fail_fast, :abort_on_failure
+                :ignore_fragments, :fail_fast, :abort_on_failure
   attr_writer :files, :html_files, :links
 
   # Set default values for all the properties
@@ -42,6 +43,7 @@ class LinkChecker
     @site_folder = opts[:site_folder] || DEFAULT_SITE_FOLDER
 
     update_skip_list(opts[:skip_list] || [])
+    @ignore_fragments = opts[:ignore_fragments]
 
     @mode = opts[:mode] || DEFAULT_MODE
     @verbose = opts[:verbose]
@@ -67,6 +69,7 @@ class LinkChecker
     link_checker_config = config["link-checker"]
     if link_checker_config
       opts[:skip_list] = link_checker_config["skip-list"]
+      opts[:ignore_fragments] = link_checker_config["ignore-fragments"]
       opts[:mode] = link_checker_config["mode"]
       opts[:verbose] = link_checker_config["verbose"]
       opts[:fail_fast] = link_checker_config["fail-fast"]
@@ -116,21 +119,17 @@ class LinkChecker
     error_count = 0
     i = 0
     prev_msg_size = 0
-    links.each do |link, files|
+    links.each do |uri, fragments|
       i += 1
       if verbose
         prev_msg_size.times { print " " }
-        msg = "#{link} #{i}/#{links.size}"
+        msg = "#{uri} #{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?(":")
+      next if @skip_list.include?(uri.to_s)
 
       error = false
 
@@ -138,16 +137,52 @@ class LinkChecker
       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}" }
+        # If the uri's path is valid
+        valid_fragments = valid_links[uri.path]
+        if valid_fragments
+          fragments.each do |fragment, files|
+            # Skip the base fragment
+            next unless fragment
+
+            next if valid_fragments.include?(fragment)
+
+            error = true
+            puts "Invalid fragment '#{fragment}' in link '#{uri}' " \
+                 "is present in:"
+            files.each { |file| puts "\t#{file}" }
+          end
+        else
           error = true
+          puts "Invalid internal link '#{link}' is present in:"
+          fragments.flat_map { |_, files| files }.uniq
+                   .each { |file| puts "\t#{file}" }
         end
-      elsif uri.scheme.nil? || SCHEMES.include?(uri.scheme)
-        status = make_request(conn, link)
+      elsif fragments.keys == [nil]
+        status = make_request(conn, uri)
         error = !status_allowed?(status)
-        puts "Request to #{link} in #{files} returned #{status}" if error
+        if error
+          puts "Request to #{link} returned #{status} present in"
+          fragments[nil].each { |file| puts "\t#{file}" }
+        end
+      else
+        response = get_request(conn, uri)
+        status = response.status
+        if status == 200
+          valid_fragments = uniq_string_matches(response.body, ID)
+          fragments.each do |fragment, files|
+            unless valid_fragments.include?(fragment)
+              puts "Invalid link to fragment '#{fragment}' present in: "
+              files.each { |file| puts "\t#{file}" }
+            end
+          end
+        else
+          error = true
+          puts "Request to #{link} in #{files} returned #{status}"
+          error = true
+          puts "Invalid internal link '#{link}' is present in:"
+          fragments.flat_map { |_, files| files }.uniq
+                   .each { |file| puts "\t#{file}" }
+        end
       end
 
       next unless error
@@ -181,40 +216,75 @@ class LinkChecker
   end
 
   # Find all the valid links for the site
+  # The value returned by this method is formatted like so:
+  # {
+  #   "path": [
+  #     fragment
+  #   ]
+  # }
   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
+      fragments = []
+      fragments = uniq_file_matches(file, ID) if html?(file) &&
+                                                 !@ignore_fragments
+
+      [file_url(file), fragments]
     end
+    @valid_links = @valid_links.to_h
   end
 
   # Find all HTML files
   def html_files
     return @html_files if @html_files
 
-    @html_files = files.filter { |file| HTML.include?(File.extname(file)) }
+    @html_files = files.filter { |file| html?(file) }
   end
 
   # Find all links in html_files
+  # The value returned by this method is formatted like so:
+  # {
+  #   uri without fragment: {
+  #     uri's fragment: Set [
+  #       "file containing this link"
+  #     ]
+  #   }
+  # }
   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
+      file_path = file_url(file)
+
+      # For each link in the file
+      uniq_file_matches(file, HREF).each do |link|
+        uri = Addressable::URI.parse(link)
+
+        # Skip the emails and phone numbers URIs
+        next if uri.site&.end_with?(":")
+        # Skip the URIs with unknown schemes
+        next unless uri.scheme.nil? || SCHEMES.include?(uri.scheme)
+
+        # Set the URI's path to the file's valid link if the link is a
+        # fragment of the current file
+        uri.path = file_path if link.start_with?("#")
+        uri.path = uri.path.dup
+
+        # Remove the fragment from the URI and put it in a local variable
+        fragment = uri.fragment.nil? || uri.fragment.empty? ? nil : uri.fragment
+        uri.fragment = nil
+
+        fragment = nil if @ignore_fragments
+
+        # Get the link for the URI
+        uri_fragments = @links[uri] ||= {}
+
+        # Get the files for the fragment
+        fragment_files = uri_fragments[fragment] ||= Set.new
+
+        fragment_files << file
       end
     end
     @links
@@ -234,16 +304,53 @@ class LinkChecker
   # 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)
+      response_status = head_request(conn, url).status
+      return response_status if mode == "head_only" ||
+                                status_allowed?(response_status)
     end
 
-    conn.get(url, {}, HEADERS).status
+    get_request(conn, url).status
+  end
+
+  # Make a get request on the connection for the URL
+  def get_request(conn, url)
+    conn.get(url, {}, HEADERS)
+  end
+
+  # Make a head request on the connection for the URL
+  def head_request(conn, url)
+    conn.head(url, {}, HEADERS)
   end
 
   # Returns whether the status is successfull
   def status_allowed?(status)
     status >= 200 && status < 300
   end
+
+  # Finds all the matches in a file for a given regex
+  def uniq_file_matches(path, regex)
+    uniq_string_matches(File.open(path).read, regex)
+  end
+
+  # Finds all the matches in a String for a given regex
+  def uniq_string_matches(str, regex)
+    str.scan(regex)
+       .map { |matches| matches[0].strip }
+       .uniq
+  end
+
+  # Determines whether the file is an HTML file based on it's extension
+  def html?(path)
+    HTML.include?(File.extname(path))
+  end
+
+  # Gets the url of a file in the static site based on its path
+  def file_url(path)
+    path = Pathname.new(path)
+    path = path.relative_path_from(@site_folder)
+    path = "/" + path.to_s
+    path.chomp!("index.html")
+    path.chomp!("/")
+    path
+  end
 end

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-link-checker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Zakary Kamal Ismail
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-15 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -72,6 +72,34 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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