jekyll-readme-index 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b0cb46a6f56d8a5898262b8b61441de116c84ad
-  data.tar.gz: '0992bcb775494cd0fa27d842877b8c397a79a3a1'
+SHA256:
+  metadata.gz: e5bd74269cd40c7051ee807361769d9a049977d4270ee22d0c59db95adb98fea
+  data.tar.gz: 3b02a03d7b5a5184d0cb3743cf1e778302fb843f16acfaa898a9c7f1870db6a1
 SHA512:
-  metadata.gz: a11b7475e60decc7ebb9640117f49619ac4745d5038f4bd36953dca3fe743fbef59724df995450cf07448c17af08db03a4bf2e66bfab94c023f4f9abf9e62e17
-  data.tar.gz: 7b22c70e35d4562c3884da6915632e1af7135b5d93374473b0a818461ebed11976e5e6c0a290209c6e2d85faff96cb43eb63cb00d970616284a1212b6cc6ddd0
+  metadata.gz: 698899c2dd728705703b01002c82854e18b49728eef9f0761caab3e179f05693322579a0fcfdcfb1e6625f0a6ca0afe14220386f6e263daf6b2b11d0e5f04d19
+  data.tar.gz: 51953c2dd58f121c858b6ff20e712ba20093c35936a517e3f3ebe4369162086daf792fd6ac3db8ae8689507a891f55976947ecf93c552441456880253d3c9b91

data/lib/jekyll-readme-index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "jekyll-readme-index/generator"
 require_relative "./jekyll/static_file_ext"

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

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 module JekyllReadmeIndex
   class Generator < Jekyll::Generator
-    INDEX_REGEX = %r!$|index\.(html?|xhtml|xml)$!i
+    INDEX_REGEX = %r!$|index\.(html?|xhtml|xml)$!i.freeze
 
     attr_accessor :site
 
     safe true
     priority :low
 
-    CONFIG_KEY = "readme_index".freeze
-    ENABLED_KEY = "enabled".freeze
-    CLEANUP_KEY = "remove_originals".freeze
+    CONFIG_KEY = "readme_index"
+    ENABLED_KEY = "enabled"
+    CLEANUP_KEY = "remove_originals"
+    FRONTMATTER_KEY = "with_frontmatter"
 
     def initialize(site)
       @site = site
@@ -21,9 +24,18 @@ module JekyllReadmeIndex
 
       readmes.each do |readme|
         next unless should_be_index?(readme)
+
         site.pages << readme.to_page
         site.static_files.delete(readme) if cleanup?
       end
+
+      if with_frontmatter?
+        readmes_with_frontmatter.each do |readme|
+          next unless should_be_index?(readme)
+
+          readme.update_permalink
+        end
+      end
     end
 
     private
@@ -33,9 +45,14 @@ module JekyllReadmeIndex
       site.static_files.select { |file| file.relative_path =~ readme_regex }
     end
 
+    def readmes_with_frontmatter
+      site.pages.select { |file| ("/" + file.path) =~ readme_regex }
+    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)
     end
 
@@ -50,7 +67,7 @@ module JekyllReadmeIndex
 
     # 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
+      @readme_regex ||= %r!/readme(#{Regexp.union(markdown_converter.extname_list)})$!i
     end
 
     def markdown_converter
@@ -68,5 +85,9 @@ module JekyllReadmeIndex
     def cleanup?
       option(CLEANUP_KEY) == true
     end
+
+    def with_frontmatter?
+      option(FRONTMATTER_KEY) == true
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllReadmeIndex
-  VERSION = "0.2.0".freeze
+  VERSION = "0.3.0"
 end

data/lib/jekyll/static_file_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jekyll
   class StaticFile
     # Convert this static file to a Page
@@ -7,4 +9,15 @@ module Jekyll
       page
     end
   end
+
+  class Page
+    def update_permalink
+      data["permalink"] = File.dirname(url) + "/"
+      @url = URL.new(
+        :template     => template,
+        :placeholders => url_placeholders,
+        :permalink    => permalink
+      ).to_s
+    end
+  end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-readme-index
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-11 00:00:00.000000000 Z
+date: 2019-11-05 00:00:00.000000000 Z
 dependencies:
 - !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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: 
 email:
 - ben.balter@github.com
@@ -82,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to render a project's README as the site's index.