jekyll-optional-front-matter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87c57f05b8d4ee99eafa0aa57f03c2d9ab434587
-  data.tar.gz: 85095f5dd70bcfaa0af3ad15bff56bd267a33a1e
+  metadata.gz: 7fe8954cd00f73507e5758cfab84cbb43c5c841e
+  data.tar.gz: d8c156ef4f997e5204d68f2b8ae096e52d3a4a2a
 SHA512:
-  metadata.gz: d1f7ff3e067a5c704173af9ef7a7451a154310573a493067df37dd1fdb97e003043b0f9c17739e64a28eb54e4f71ba59ebd6a1fe2cfab0b42e191c278458e331
-  data.tar.gz: eb0b768b1b7a150df5c46653fc10a832baae1c9da2ab0c9fc7fd553217ce314c49fd5e58e0a382f0a6200ef008272ee24919b502c37ed215d198d15cece0816a
+  metadata.gz: 4b66ccd1cd180988edbbe76eaab3526c32f52c7486034c63f82e3d39cb9bb713e75053419ba21a79aa74fef771527363907c3fd5d882a087e1526fe5f22984f6
+  data.tar.gz: 2e8d918fcc4910d45f661edfb2d4c0cec37e02a377d439eb8a60fd2252d32ec92a6b6845d1a998022ef8564c6091de378ec3ba2b8919a2dde2232cdd9af4341e

data/lib/jekyll-optional-front-matter.rb

@@ -1,5 +1,19 @@
 require "jekyll"
 
 module JekyllOptionalFrontMatter
+  # Case-insensitive array of filenames to exclude. All files must first
+  # match the config-defined list of markdown extensions. If you'd like one
+  # of these files included in your site, simply add YAML front matter to it.
+  FILENAME_BLACKLIST = %w(
+    README
+    LICENSE
+    LICENCE
+    COPYING
+    CODE_OF_CONDUCT
+    CONTRIBUTING
+    ISSUE_TEMPLATE
+    PULL_REQUEST_TEMPLATE
+  ).freeze
+
   autoload :Generator, "jekyll-optional-front-matter/generator"
 end

data/lib/jekyll-optional-front-matter/generator.rb

@@ -2,7 +2,7 @@ module JekyllOptionalFrontMatter
   class Generator < Jekyll::Generator
     attr_accessor :site
 
-    safe :true
+    safe true
     priority :low
 
     def initialize(site)
@@ -12,15 +12,27 @@ module JekyllOptionalFrontMatter
     def generate(site)
       @site = site
       return if site.config["require_front_matter"]
-      site.pages.concat(pages)
+      site.pages.concat(pages_to_add)
     end
 
     private
 
+    # An array of Jekyll::Pages to add, *excluding* blacklisted files
+    def pages_to_add
+      pages.reject { |page| blacklisted?(page) }
+    end
+
+    # An array of potential Jekyll::Pages to add, *including* blacklisted files
     def pages
       markdown_files.map { |static_file| page_from_static_file(static_file) }
     end
 
+    # An array of Jekyll::StaticFile's with a site-defined markdown extension
+    def markdown_files
+      site.static_files.select { |file| markdown_converter.matches(file.extname) }
+    end
+
+    # Given a Jekyll::StaticFile, returns the file as a Jekyll::Page
     def page_from_static_file(static_file)
       base = static_file.instance_variable_get("@base")
       dir  = static_file.instance_variable_get("@dir")
@@ -28,12 +40,13 @@ module JekyllOptionalFrontMatter
       Jekyll::Page.new(site, base, dir, name)
     end
 
-    def markdown_files
-      site.static_files.select { |f| markdown_converter.matches(f.extname) }
+    # Does the given Jekyll::Page match our filename blacklist?
+    def blacklisted?(page)
+      FILENAME_BLACKLIST.include?(page.basename.upcase)
     end
 
     def markdown_converter
-      site.find_converter_instance(Jekyll::Converters::Markdown)
+      @markdown_converter ||= site.find_converter_instance(Jekyll::Converters::Markdown)
     end
   end
 end

data/lib/jekyll-optional-front-matter/version.rb

@@ -1,3 +1,3 @@
 module JekyllOptionalFrontMatter
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-optional-front-matter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll