jekyll_draft 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b81abf3dd2ad47f14dc0c7a5694642337e779a82e28500510f81eb72622abd8
+  data.tar.gz: ef24a39d682076c1d73d29dd286ce8bc5c5162af5fcc6d461aeb275f95b79598
+SHA512:
+  metadata.gz: 3d20f8aa839be087692b4da14db1993d762d32aac95f6a6410f9cb17ee377e8516e3e218891602085eb9da1e69e95760765d2aefab370c2131f42b55c5e9ca7e
+  data.tar.gz: c191c1ff541451b6a6247c0974d2af7a7ef2d1d11e6aded828f124fe0ffb1167344ec8811c0b7235ce6d9e5dd10c0c7c52e6f2995041a45973715de751930d60

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0 / 2022-04-02
+  * Initial version

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+jekyll_draft
+[![Gem Version](https://badge.fury.io/rb/jekyll_draft.svg)](https://badge.fury.io/rb/jekyll_draft)
+===========
+
+This is a Jekyll plugin that provides two Liquid filters called `is_draft` and `draft_html`.
+
+More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Installation
+
+Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_draft'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_draft
+
+
+## Usage
+
+### is_draft
+
+Filters a string containing a path and returns the portion of th path before the filename and extension.
+Example: Extracts "blah/blah" from the path.
+```
+{{ page | is_draft }} => true
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Install development dependencies like this:
+```
+$ BUNDLE_WITH="development" bundle install
+```
+
+To install this gem onto your local machine, run:
+```shell
+$ bundle exec rake install
+```
+
+To release a new version,
+  1. Update the version number in `version.rb`.
+  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+  3. Run the following:
+     ```shell
+     $ bundle exec rake release
+     ```
+     The above creates a git tag for the version, commits the created tag,
+     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_draft.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_draft.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_draft/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_draft"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    This Jekyll filter detects draft documents.
+  END_OF_DESC
+  spec.email = ["mslinn@mslinn.com"]
+  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
+  spec.homepage = "https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename"
+  spec.license = "MIT"
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "bug_tracker_uri"   => "#{github}/issues",
+    "changelog_uri"     => "#{github}/CHANGELOG.md",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => github,
+  }
+  spec.name = "jekyll_draft"
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "This Jekyll filter detects draft documents."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllDraftVersion::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+
+  # spec.add_development_dependency "debase"
+  # spec.add_development_dependency "rubocop-jekyll"
+  # spec.add_development_dependency "rubocop-rake"
+  # spec.add_development_dependency "rubocop-rspec"
+  # spec.add_development_dependency "ruby-debug-ide"
+end
+# rubocop:enable Metrics/BlockLength

data/lib/jekyll_draft/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllDraftVersion
+  VERSION = "1.0.0"
+end

data/lib/jekyll_draft.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
+
+require "jekyll_plugin_logger"
+require 'yaml'
+
+# Detects draft documents
+module Jekyll
+  # Define these methods outside of the filter module so they can be invoked externally
+  module Draft
+    def draft?(doc)
+      abort "Jekyll:Draft.draft? doc is nil!".red if doc.nil?
+
+      # puts "draft? invoked from #{doc.path}"
+      return !doc.data['published'] if doc.respond_to?(:data) && doc.data.key?('published')
+
+      return doc.published==false if doc.respond_to?(:published)
+
+      return doc['published']==false if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('published'))
+
+      return doc.draft if doc.respond_to?(:draft)
+
+      return doc['draft'] if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('draft'))
+
+      false
+    end
+
+    def draft_html(doc)
+      # puts "draft_html invoked from #{doc.path}"
+      return '' unless draft?(doc)
+
+      " <i class='bg_light_yellow' style='padding-left: 0.5em; padding-right: 0.5em;'>Draft</i>"
+    end
+
+    def root(doc, site)
+      # puts "root invoked from #{doc.path}"
+      return "/index.html" unless doc.respond_to?(:collection)
+
+      collection_name = doc.collection
+      docs = site.key?(collection_name) ? site[collection_name] : site.collections[collection_name].docs
+      index = docs.find { |d| d.url.end_with? "index.html" }
+      return index.url if index
+
+      docs.min.url
+    end
+
+    module_function :draft?, :draft_html, :root
+  end
+
+  module DraftFilter
+    def is_draft(doc)
+      Draft::draft?(doc)
+    end
+
+    def draft_html(doc)
+      Draft::draft_html(doc)
+    end
+
+    # DraftFilter.singleton_class.included_modules
+    #   [JSON::Ext::Generator::GeneratorMethods::Object, PP::ObjectMixin, Kernel]
+    def root(doc, site)
+      Draft::root(doc, site)
+    end
+  end
+
+  Liquid::Template.register_filter(DraftFilter)
+  PluginMetaLogger.instance.info { "Loaded DraftFilter plugin." }
+end

data/spec/jekyll_draft_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_draft"
+
+RSpec.describe(jekyllDraftName) do
+  include jekyllDraftName
+
+  it "verifies basename" do
+    expect(basename("a/b/c/d/e.html")).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "fileutils"
+require_relative "../lib/jekyll_draft"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.order = "random"
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = "spec/status_persistence.txt"
+end

data/spec/status_persistence.txt

@@ -0,0 +1,4 @@
+example_id                           | status | run_time        |
+------------------------------------ | ------ | --------------- |
+./spec/basename_dirname_spec.rb[1:1] | passed | 0.00214 seconds |
+./spec/basename_dirname_spec.rb[1:2] | passed | 0.0002 seconds  |

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_draft
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This Jekyll filter detects draft documents.
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_draft.gemspec
+- lib/jekyll_draft.rb
+- lib/jekyll_draft/version.rb
+- spec/jekyll_draft_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_draft/issues
+  changelog_uri: https://github.com/mslinn/jekyll_draft/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+  source_code_uri: https://github.com/mslinn/jekyll_draft
+post_install_message: |2+
+
+  Thanks for installing jekyll_draft!
+
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: This Jekyll filter detects draft documents.
+test_files:
+- spec/jekyll_draft_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+...