jekyll-optional-front-matter 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f87caf5a804dae1eb6d85a67b3a4c407d6eb635cf7e5981d1f75b718bbbeb3
-  data.tar.gz: 48b03a7fdb8d446e8eaa338ae054b2aa77433c81924dcf816ea054a8281b47b4
+  metadata.gz: 256286d5e37418605dcfff4045918e459575542b56e64f59d72044991d9f052c
+  data.tar.gz: 415a9ebd808dc1fa8171e4a8fcbc848d59c16f7196cc38312a65c383c3be2746
 SHA512:
-  metadata.gz: 27201178d468af47e9c5ed655b7825525a1830ec14fe7c8e0455bc58fa240a7a1f34c9e6e93817be641030b3d244eab05dfb9bc56946b32a1651fce581ea7ba8
-  data.tar.gz: 86a055fcfe7bba180ed788822d92faa48c96b53a6bad70256c254686d858d9bd67629acf7b8b8de6b987c1accd751ee461d3dd3349a80a945d630fe3d886728a
+  metadata.gz: 9f217c725fb604e2147bcb5709ee818ec908b9d940b405f2f6d6ea3eb24912bb761c5093d12a551b653fb26612722ad421edee13f936092ccb1632c3060d6510
+  data.tar.gz: 67676b4ce80ec3a5696e950f3a2d023e2d6791995300cbe4b19e1da1f2731d292f8c69f6c787227866e224d91d5eaa58c9f36eda3c9bed929d6cb522842ca6ab

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

@@ -26,23 +26,17 @@ module JekyllOptionalFrontMatter
 
     private
 
-    # Convert markdown content to HTML for the page
-    def convert_content(page)
-      renderer = Jekyll::Renderer.new(site, page)
-      page.content = renderer.convert(page.content)
-    end
-
-    # An array of Jekyll::Pages to add, *excluding* blacklisted files
+    # An array of Jekyll::Pages to add, *excluding* denylisted files
     def pages_to_add
-      pages.reject { |page| blacklisted?(page) }
+      pages.reject { |page| denylisted?(page) }
     end
 
-    # An array of Jekyll::StaticFile's, *excluding* blacklisted files
+    # An array of Jekyll::StaticFile's, *excluding* denylisted files
     def static_files_to_remove
-      markdown_files.reject { |page| blacklisted?(page) }
+      markdown_files.reject { |page| denylisted?(page) }
     end
 
-    # An array of potential Jekyll::Pages to add, *including* blacklisted files
+    # An array of potential Jekyll::Pages to add, *including* denylisted files
     def pages
       markdown_files.map { |static_file| page_from_static_file(static_file) }
     end
@@ -60,14 +54,15 @@ module JekyllOptionalFrontMatter
       Jekyll::Page.new(site, base, dir, name)
     end
 
-    # Does the given Jekyll::Page match our filename blacklist?
-    def blacklisted?(page)
-      return false if whitelisted?(page)
+    # Does the given Jekyll::Page match our filename denylist?
+    def denylisted?(page)
+      return false if explicitly_included?(page)
 
-      FILENAME_BLACKLIST.include?(page.basename.upcase)
+      FILENAME_DENYLIST.include?(page.basename.upcase)
     end
 
-    def whitelisted?(page)
+    # Is the given Jekyll::Page explicitly listed in the site's `include` config?
+    def explicitly_included?(page)
       return false unless site.config["include"].is_a? Array
 
       entry_filter.included?(page.relative_path)
@@ -82,11 +77,14 @@ module JekyllOptionalFrontMatter
     end
 
     def option(key)
-      site.config[CONFIG_KEY] && site.config[CONFIG_KEY][key]
+      config = site.config[CONFIG_KEY]
+      config[key] if config.is_a?(Hash)
     end
 
+    # `optional_front_matter: false` is shorthand for `enabled: false`
     def disabled?
-      option(ENABLED_KEY) == false || site.config["require_front_matter"]
+      site.config[CONFIG_KEY] == false || option(ENABLED_KEY) == false ||
+        site.config["require_front_matter"]
     end
 
     def cleanup?

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllOptionalFrontMatter
-  VERSION = "0.3.3"
+  VERSION = "0.3.5"
 end

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

@@ -7,7 +7,7 @@ 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(
+  FILENAME_DENYLIST = %w(
     README
     LICENSE
     LICENCE
@@ -17,4 +17,8 @@ module JekyllOptionalFrontMatter
     ISSUE_TEMPLATE
     PULL_REQUEST_TEMPLATE
   ).freeze
+
+  # Deprecated: use FILENAME_DENYLIST. Kept so existing callers don't break.
+  FILENAME_BLACKLIST = FILENAME_DENYLIST
+  deprecate_constant :FILENAME_BLACKLIST
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-optional-front-matter
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Ben Balter
@@ -43,6 +43,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +183,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+description: Jekyll plugin to render Markdown files that have no YAML front matter.
+  Supported on GitHub Pages.
 email:
 - ben.balter@github.com
 executables: []
@@ -181,7 +197,11 @@ files:
 homepage: https://github.com/benbalter/jekyll-optional-front-matter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/benbalter/jekyll-optional-front-matter
+  source_code_uri: https://github.com/benbalter/jekyll-optional-front-matter
+  bug_tracker_uri: https://github.com/benbalter/jekyll-optional-front-matter/issues
+  changelog_uri: https://github.com/benbalter/jekyll-optional-front-matter/releases
 rdoc_options: []
 require_paths:
 - lib
@@ -189,14 +209,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      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: 4.0.20
 specification_version: 4
 summary: A Jekyll plugin to make front matter optional for Markdown files
 test_files: []