jekyll-readme-index 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ff724c2f3f4731b73dc6b4b4ced3bcd84793669c41913c477ea0c926b25a11b
-  data.tar.gz: 49768447b305e6dda9605997b1ef8b45b513dfe6ebd9a95136db3bdc383291df
+  metadata.gz: a962fee2eeeb3f2afc21c0e7a4d99d50db52e11750358d7ea13a1cfc76ea5b01
+  data.tar.gz: ed15d139b9f068004a0a7e36defdc56bcfd2fc289299f404548531724b18dad5
 SHA512:
-  metadata.gz: cea83b276e2017f4c150400e77f39a6e985bee2a0c0cd7b4fff61da9f0e6f2dce75a2ac0a9be4fd76ea768252cc1fd71457751816c56db91486b908b7cc17526
-  data.tar.gz: 3d538fec44f058263ea888acc364f3741304eb9482c4b28e6ea171634d00250f513d6f330fb13da9d7f15bcd5ebc882582ce086cc3a56a178ae3ca233077bdaa
+  metadata.gz: 259e6eabc8d4b5ea02b77377f331099ec70413fede4d8dc4d2d9ef5ae9ca120d8cdb7892f17b54d00745f48277a0edd976e770d2a6eabba27940fefdedf36a85
+  data.tar.gz: d3770314f5f85253a15ad8b471f13ae6fe265f1b6eac759fd56cd62cff09ccd5fd8a8665ed644a5fb68e790ee717f806f1dca3f71fc3b7e54b54f6591d3429a6

data/lib/jekyll-readme-index/generator.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require "set"
+
 module JekyllReadmeIndex
   class Generator < Jekyll::Generator
-    INDEX_REGEX = %r!$|index\.(html?|xhtml|xml)$!i.freeze
+    # Captures the directory a URL is the index of, e.g. "/a/" for "/a/" or "/a/index.html"
+    INDEX_URL_REGEX = %r!\A(.*/)(?:index\.(?:html?|xhtml|xml))?\z!i.freeze
     GITHUB_DIR = "/.github"
     DOCS_DIR = "/docs"
     SPECIAL_DIRS = [GITHUB_DIR, DOCS_DIR].freeze
@@ -27,12 +30,15 @@ module JekyllReadmeIndex
 
     def generate(site)
       @site = site
+      @index_dirs = nil
       return if disabled?
 
       readmes.each do |readme|
         next unless should_be_index?(readme)
 
-        site.pages << readme.to_page
+        page = to_page(readme)
+        site.pages << page
+        add_index_dir(page.url)
         site.static_files.delete(readme) if cleanup?
       end
 
@@ -40,7 +46,7 @@ module JekyllReadmeIndex
         readmes_with_frontmatter.each do |readme|
           next unless should_be_index?(readme)
 
-          readme.update_permalink
+          add_index_dir(update_permalink(readme))
         end
       end
     end
@@ -60,7 +66,6 @@ module JekyllReadmeIndex
 
     # Prioritize READMEs according to GitHub's order: .github > root > docs
     # For each target directory, keep only the highest priority README
-    # rubocop:disable Metrics/PerceivedComplexity
     def prioritize_readmes(candidates)
       grouped = candidates.group_by do |file|
         # Get the directory that would become the index
@@ -80,8 +85,7 @@ module JekyllReadmeIndex
       grouped.flat_map do |_dir, files|
         # Sort by priority: .github first, then root, then docs, then others
         files.min_by do |file|
-          path = file.respond_to?(:relative_path) ? file.relative_path : "/" + file.path
-          case path
+          case readme_path(file)
           when GITHUB_README_PATTERN then 0
           when ROOT_README_PATTERN then 1
           when DOCS_README_PATTERN then 2
@@ -90,22 +94,81 @@ module JekyllReadmeIndex
         end
       end.compact
     end
-    # rubocop:enable Metrics/PerceivedComplexity
+
+    # Convert a README StaticFile to a Page that serves as its directory's index
+    def to_page(static_file)
+      # StaticFile doesn't expose its base, dir, or name (the last only since
+      # Jekyll 4), so read them the same way jekyll-optional-front-matter does.
+      base = static_file.instance_variable_get(:@base)
+      dir  = static_file.instance_variable_get(:@dir)
+      name = static_file.instance_variable_get(:@name)
+      page = Jekyll::Page.new(site, base, dir, name)
+
+      page.data["permalink"] = target_dir(static_file)
+      page
+    end
+
+    # Point a README Page's permalink at its directory
+    def update_permalink(page)
+      # If URL already ends with '/', it's a directory URL and should be used as-is
+      url = page.url
+      page.data["permalink"] = url.end_with?("/") ? url : target_dir(page)
+      # Page#url is memoized; drop it so it's rebuilt from the new permalink
+      page.instance_variable_set(:@url, nil)
+      page.url
+    end
+
+    # The directory a README should be the index for
+    def target_dir(file)
+      # For READMEs in .github or docs at root level, they should be the root index
+      return "/" if special_readme?(file)
+
+      File.join(File.dirname(file.url), "/")
+    end
+
+    # Check if this is a README in a special directory (.github or docs)
+    def special_readme?(file)
+      path = readme_path(file)
+      path =~ GITHUB_README_PATTERN || path =~ DOCS_README_PATTERN
+    end
+
+    # The file's path relative to the site source, with a leading slash.
+    #
+    # StaticFile#relative_path starts with "/", but Page#relative_path doesn't
+    # on Jekyll 4 (or for root pages on Jekyll 3), so the priority patterns
+    # never matched READMEs with front matter.
+    def readme_path(file)
+      path = file.relative_path
+      path.start_with?("/") ? path : "/#{path}"
+    end
 
     # Should the given readme be the containing directory's index?
     def should_be_index?(readme)
       return false unless readme
 
-      !dir_has_index? File.dirname(readme.url)
+      !dir_has_index? target_dir(readme)
     end
 
     # Does the given directory have an index?
     #
     # relative_path - the directory path relative to the site root
     def dir_has_index?(relative_path)
-      relative_path << "/" unless relative_path.end_with? "/"
-      regex = %r!^#{Regexp.escape(relative_path)}#{INDEX_REGEX}!i
-      (site.pages + site.static_files).any? { |file| file.url =~ regex }
+      relative_path = File.join(relative_path, "/") unless relative_path.end_with?("/")
+      index_dirs.include?(relative_path.downcase)
+    end
+
+    # The (downcased) directories that already have an index page or file.
+    # Built once per generate instead of scanning every file for every README.
+    def index_dirs
+      @index_dirs ||= Set.new.tap do |dirs|
+        site.pages.each { |page| add_index_dir(page.url, dirs) }
+        site.static_files.each { |file| add_index_dir(file.url, dirs) }
+      end
+    end
+
+    def add_index_dir(url, dirs = index_dirs)
+      match = INDEX_URL_REGEX.match(url)
+      dirs << match[1].downcase if match
     end
 
     # Regexp to match a file path against to detect if the given file is a README

data/lib/jekyll-readme-index/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllReadmeIndex
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/jekyll-readme-index.rb

@@ -2,7 +2,6 @@
 
 require "jekyll"
 require "jekyll-readme-index/generator"
-require_relative "./jekyll/static_file_ext"
 
 module JekyllReadmeIndex
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-readme-index
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Balter
@@ -36,7 +36,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -178,7 +178,6 @@ files:
 - lib/jekyll-readme-index.rb
 - lib/jekyll-readme-index/generator.rb
 - lib/jekyll-readme-index/version.rb
-- lib/jekyll/static_file_ext.rb
 homepage: https://github.com/benbalter/jekyll-readme-index
 licenses:
 - MIT
@@ -190,14 +189,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Jekyll plugin to render a project's README as the site's index.
 test_files: []

data/lib/jekyll/static_file_ext.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class StaticFile
-    # Convert this static file to a Page
-    def to_page
-      page = Jekyll::Page.new(@site, @base, @dir, @name)
-
-      # For READMEs in .github or docs at root level, they should be the root index
-      target_dir = if special_readme?
-                     "/"
-                   else
-                     File.dirname(url) + "/"
-                   end
-
-      page.data["permalink"] = target_dir
-      page
-    end
-
-    private
-
-    # Check if this is a README in a special directory (.github or docs)
-    def special_readme?
-      relative_path =~ JekyllReadmeIndex::Generator::GITHUB_README_PATTERN ||
-        relative_path =~ JekyllReadmeIndex::Generator::DOCS_README_PATTERN
-    end
-  end
-
-  class Page
-    def update_permalink
-      # If URL already ends with '/', it's a directory URL and should be used as-is
-      # Otherwise, extract the directory from the file URL
-      target_dir = url.end_with?("/") ? url : File.dirname(url) + "/"
-
-      data["permalink"] = target_dir
-      @url = URL.new(
-        :template     => template,
-        :placeholders => url_placeholders,
-        :permalink    => permalink
-      ).to_s
-    end
-  end
-end