bunto-optional-front-matter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ee5606d18fa268f587a7bc476ce9cf283ba0168
+  data.tar.gz: da94660a90797ae09398894ba2d857e09b7e5e7a
+SHA512:
+  metadata.gz: 63e5fc4d9a550cb1848ed36b89fdbc592b3c21b01e1ea8d70c0380910c3b07f6265242c4984cca3894b9eae49eeeed12c04d521760ec92746ca8deb7c742768b
+  data.tar.gz: 87df35adc4601bd78bb79504921239af92136e3f3e5912ddea36526abbaf8078e12d8fabd888c13ff07047f737bb6acc19f86d4d3b8be6433e4e812671c4bb24

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

@@ -0,0 +1,18 @@
+require "bunto"
+require "bunto-optional-front-matter/generator"
+
+module BuntoOptionalFrontMatter
+  # 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
+end

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

@@ -0,0 +1,62 @@
+module BuntoOptionalFrontMatter
+  class Generator < Bunto::Generator
+    attr_accessor :site
+
+    safe true
+    priority :normal
+
+    def initialize(site)
+      @site = site
+    end
+
+    def generate(site)
+      @site = site
+      return if site.config["require_front_matter"]
+      site.pages.concat(pages_to_add)
+    end
+
+    private
+
+    # An array of Bunto::Pages to add, *excluding* blacklisted files
+    def pages_to_add
+      pages.reject { |page| blacklisted?(page) }
+    end
+
+    # An array of potential Bunto::Pages to add, *including* blacklisted files
+    def pages
+      markdown_files.map { |static_file| page_from_static_file(static_file) }
+    end
+
+    # An array of Bunto::StaticFile's with a site-defined markdown extension
+    def markdown_files
+      site.static_files.select { |file| markdown_converter.matches(file.extname) }
+    end
+
+    # Given a Bunto::StaticFile, returns the file as a Bunto::Page
+    def page_from_static_file(static_file)
+      base = static_file.instance_variable_get("@base")
+      dir  = static_file.instance_variable_get("@dir")
+      name = static_file.instance_variable_get("@name")
+      Bunto::Page.new(site, base, dir, name)
+    end
+
+    # Does the given Bunto::Page match our filename blacklist?
+    def blacklisted?(page)
+      return false if whitelisted?(page)
+      FILENAME_BLACKLIST.include?(page.basename.upcase)
+    end
+
+    def whitelisted?(page)
+      return false unless site.config["include"].is_a? Array
+      entry_filter.included?(page.path)
+    end
+
+    def markdown_converter
+      @markdown_converter ||= site.find_converter_instance(Bunto::Converters::Markdown)
+    end
+
+    def entry_filter
+      @entry_filter ||= Bunto::EntryFilter.new(site)
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module BuntoOptionalFrontMatter
+  VERSION = "0.2.0".freeze
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: bunto-optional-front-matter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ben Balter
+- Suriyaa Kudo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bunto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+description: 
+email:
+- ben.balter@github.com
+- github@suriyaa.tk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bunto-optional-front-matter.rb
+- lib/bunto-optional-front-matter/generator.rb
+- lib/bunto-optional-front-matter/version.rb
+homepage: https://github.com/bunto/bunto-optional-front-matter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A Bunto plugin to make front matter optional for Markdown files
+test_files: []