jekyll-readme-index 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92d5d65f136e0fb3a174c22cea5fa6b20f9a8e0f
-  data.tar.gz: e11c2bfea7414fc7c9c3ac9f544666ec43588512
+  metadata.gz: 4a6dbcea7f7b27ff87d656d95b87378598989165
+  data.tar.gz: 413e078182aab9e9a0116fbc8e6cf67c6758ff7a
 SHA512:
-  metadata.gz: db9cf78c152d7a0b17ce5cddad7ab7fdfe061d9c4157cfd3ce224e7c16fe8b17ce1cb45d285fdb5e8207427eccfeb9fe08b6b55b1e67d0fa8f0c1f02c5622cef
-  data.tar.gz: 6dec5692130b04d5d781bd75bfe01caf0fa8a582962275fbf04346c6d57f68c9cb174ce5497a9601e1333c16049d8a2a4cfc22113df2641bfb8e5b79313651ba
+  metadata.gz: '07838efab593f1637a60272937fbed94b6234f6a2795681bee23217303034beae03ff65572ef16335bb02d4057332fc73bc6b1bcaf31b839a1019fbad85673a8'
+  data.tar.gz: 8e7b984a6bc9ca0e81ea42f2480917cb48f5378c6b88bcc234bb6f039c0c16ba290395ba6800ce3304e8840fbb1f44e0a9603769530966b9201af51bb13c8cac

data/lib/jekyll-readme-index.rb

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

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

@@ -1,7 +1,6 @@
 module JekyllReadmeIndex
   class Generator < Jekyll::Generator
-    README_REGEX = %r!^/readme(\.[^.]+)?$!i
-    INDEX_REGEX = %r!^/($|index\.(html?|xhtml|xml)$)!i
+    INDEX_REGEX = %r!$|index\.(html?|xhtml|xml)$!i
 
     attr_accessor :site
 
@@ -15,27 +14,41 @@ module JekyllReadmeIndex
     def generate(site)
       @site = site
 
-      return if index? || readme.nil?
-      site.pages << page
+      readmes.each do |readme|
+        next unless should_be_index?(readme)
+        site.pages << readme.to_page
+      end
     end
 
     private
 
-    def readme
-      site.static_files.find { |file| file.relative_path =~ README_REGEX }
+    # Returns an array of all READMEs as StaticFiles
+    def readmes
+      site.static_files.select { |file| file.relative_path =~ readme_regex }
     end
 
-    def index?
-      (site.pages + site.static_files).any? { |file| file.url =~ INDEX_REGEX }
+    # 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)
     end
 
-    def page
-      base = readme.instance_variable_get("@base")
-      dir  = readme.instance_variable_get("@dir")
-      name = readme.instance_variable_get("@name")
-      page = Jekyll::Page.new(site, base, dir, name)
-      page.data["permalink"] = "/"
-      page
+    # 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 }
+    end
+
+    # Regexp to match a file path against to detect if the given file is a README
+    def readme_regex
+      @readmes_regex ||= %r!/readme(#{Regexp.union(markdown_converter.extname_list)})$!i
+    end
+
+    def markdown_converter
+      @markdown_converter ||= site.find_converter_instance(Jekyll::Converters::Markdown)
     end
   end
 end

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

@@ -1,3 +1,3 @@
 module JekyllReadmeIndex
-  VERSION = "0.0.4".freeze
+  VERSION = "0.1.0".freeze
 end

data/lib/jekyll/static_file_ext.rb

@@ -0,0 +1,10 @@
+module Jekyll
+  class StaticFile
+    # Convert this static file to a Page
+    def to_page
+      page = Jekyll::Page.new(@site, @base, @dir, @name)
+      page.data["permalink"] = File.dirname(url) + "/"
+      page
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-readme-index
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-20 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -62,6 +62,7 @@ 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