jekyll_draft 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b81abf3dd2ad47f14dc0c7a5694642337e779a82e28500510f81eb72622abd8
-  data.tar.gz: ef24a39d682076c1d73d29dd286ce8bc5c5162af5fcc6d461aeb275f95b79598
+  metadata.gz: 2024b9ea176d56e527de8b6adfcb10c5072f6ea93d3c9d661cf64859e6c69dbc
+  data.tar.gz: d4518a8a07e342bd9586628c4d66a796ae284d89bd4808f805f0f77614b53ea5
 SHA512:
-  metadata.gz: 3d20f8aa839be087692b4da14db1993d762d32aac95f6a6410f9cb17ee377e8516e3e218891602085eb9da1e69e95760765d2aefab370c2131f42b55c5e9ca7e
-  data.tar.gz: c191c1ff541451b6a6247c0974d2af7a7ef2d1d11e6aded828f124fe0ffb1167344ec8811c0b7235ce6d9e5dd10c0c7c52e6f2995041a45973715de751930d60
+  metadata.gz: a5c3c44b58c2983dc6399822b0b223a387d06c3f624d0891748539569cf5abe72ab7ae1e109101c9fbeaae99002a3d8e02984e75af086940c866b2377997b282
+  data.tar.gz: bdef2fa61858f15620e7e54a43199ec434115a91147db7fe485b052f45c3a7cb0be1227e682da7bc6a8b1bdaef2f8d664f14b4f60dd73aaa9ec08ded17f918d0

data/.rubocop.yml

@@ -1,7 +1,3 @@
-require: rubocop-jekyll
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
-
 AllCops:
   Exclude:
       - vendor/**/*
@@ -9,5 +5,11 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Layout/HashAlignment:
+  Enabled: false
+
 Layout/LineLength:
   Max: 150
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -1,2 +1,12 @@
+## 1.1.1 / 2023-02-16
+  * Avoids Jekyll generating the message `Deprecation: Document#draft is now a key in the #data hash.`
+
+## 1.1.0 / 2023-02-05
+  * Works with CSS classes instead of generating CSS styling
+  * Improved how unpublished documents are recognized
+
+## 1.0.1 / 2022-08-05
+  * Improved how drafts are recognized
+
 ## 1.0.0 / 2022-04-02
   * Initial version

data/README.md

@@ -2,13 +2,24 @@ 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`.
+This is a Jekyll plugin that provides two Liquid filters: `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).
+More information is available on my website about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Installation
 
+Add the following to your CSS:
+```css
+.jekyll_draft {
+  background-color: #fefeab;
+  padding-bottom: 2px;
+  padding-left: 0.5em;
+  padding-right: 0.5em;
+  padding-top: 2px;
+}
+```
+
 Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
 
 ```ruby
@@ -21,21 +32,40 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install jekyll_draft
-
 
 ## Usage
 
-### is_draft
+### `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.
+Filters a page according to the directory it resides in, and its front matter.
 ```
 {{ page | is_draft }} => true
 ```
 
+### `draft_html`
+Filters a page according to the directory it resides in, and its front matter.
+If the page is not a draft then the empty string is returned.
+```
+{{ page | draft_html }} => " <i class='bg_light_yellow' style='padding-left: 0.5em; padding-right: 0.5em;'>Draft</i>"
+```
+
+### Invoking From Another Jekyll Plugin
+```ruby
+require 'jekyll_draft'
+
+p 'Found a draft' if Jekyll::Draft.is_draft post
+
+draft = Jekyll::Draft.draft_html post
+```
+
+## Demo
+The [`demo`](./demo) directory contains a demonstration website, which uses the plugin.
+To run, type:
+```console
+$ demo/_bin/debug -r
+```
+Now point your web browser to http://localhost:4444
+
 
 ## Development
 
@@ -61,6 +91,21 @@ To release a new version,
      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).
 
+### Debugging
+Run `bin/attach` and pass the directory name of a Jekyll website that has a suitable script called `_bin/debug`.
+The `demo` subdirectory fits this description.
+```console
+$ bin/attach demo
+Successfully uninstalled jekyll_draft-0.1.0
+jekyll_draft 0.1.0 built to pkg/jekyll_draft-0.1.0.gem.
+jekyll_draft (0.1.0) installed.
+Fast Debugger (ruby-debug-ide 0.7.3, debase 0.2.4.1, file filtering is supported) listens on 0.0.0.0:1234
+```
+Now attach to the debugger process.
+This git repo includes a [Visual Studio Code launcher](./.vscode/launch.json) for this purpose labeled `Listen for rdebug-ide`.
+
+Now point your web browser to http://localhost:4444
+
 
 ## Contributing
 

data/jekyll_draft.gemspec

@@ -1,46 +1,36 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_draft/version'
 
-require_relative "lib/jekyll_draft/version"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_draft'
 
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_draft"
-
-  spec.authors = ["Mike Slinn"]
-  spec.bindir = "exe"
+  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.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,
+    '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.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.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"
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_logger'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/jekyll_draft/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllDraftVersion
-  VERSION = "1.0.0"
+  VERSION = '1.1.1'.freeze
 end

data/lib/jekyll_draft.rb

@@ -1,69 +1,92 @@
-# frozen_string_literal: true
-
 # @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
 
-require "jekyll_plugin_logger"
+require 'jekyll_plugin_logger'
 require 'yaml'
 
-# Detects draft documents
+# Jekyll filter that detects draft documents
 module Jekyll
-  # Define these methods outside of the filter module so they can be invoked externally
+  # Define these methods outside of module DraftFilter so they can be invoked externally and tested easily
   module Draft
+    # @return true if document front matter contains published that is not true,
+    # or document is in _drafts.
+    # If draft and published are both specified in front matter then published has priority.
     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)
+      abort 'Jekyll::Draft.draft? doc is nil!'.red if doc.nil?
 
-      return doc['published']==false if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('published'))
+      return is_unpublished(doc) if published_was_specified(doc)
 
+      # Try Jekyll's naming convention to determine draft status
+      return doc.data['draft'] if doc.respond_to?('data') && doc.data.key?('draft')
       return doc.draft if doc.respond_to?(:draft)
 
-      return doc['draft'] if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('draft'))
-
       false
     end
 
+    # @return HTML that indicates if a doc is a draft or not
     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>"
+      " <i class='jekyll_draft'>Draft</i>"
     end
 
+    # @return path to root of the collection that doc is a member of
     def root(doc, site)
-      # puts "root invoked from #{doc.path}"
-      return "/index.html" unless doc.respond_to?(:collection)
+      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" }
+      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
+    # Non-standard name used so this method could be invoked from Liquid
+    # @return true if published was specified in a document's front matter, and the value is false
+    def published_was_specified(doc)
+      return true if doc.respond_to?('published')
+
+      return false unless doc.respond_to?('data')
+
+      return true if doc.data.key?('published')
+
+      false
+    end
+
+    # Non-standard name used so this method could be invoked from Liquid
+    # @return true if published was specified in a document's front matter, and the value is false
+    def is_unpublished(doc) # rubocop:disable Naming/PredicateName
+      return !doc.published if doc.respond_to?('published')
+
+      return !doc['published'] if doc.key?('published')
+
+      return !doc.data['published'] if doc.respond_to?('data') && doc.data.key?('published')
+
+      false
+    end
+
+    module_function :draft?, :draft_html, :is_unpublished, :published_was_specified, :root
   end
 
+  # Jekyll filters interface
   module DraftFilter
-    def is_draft(doc)
-      Draft::draft?(doc)
+    def is_draft(doc) # rubocop:disable Naming/PredicateName
+      Draft.draft?(doc)
     end
 
     def draft_html(doc)
-      Draft::draft_html(doc)
+      Draft.draft_html(doc)
+    end
+
+    def is_unpublished(doc) # rubocop:disable Naming/PredicateName
+      Draft.is_unpublished(doc)
     end
 
-    # DraftFilter.singleton_class.included_modules
-    #   [JSON::Ext::Generator::GeneratorMethods::Object, PP::ObjectMixin, Kernel]
     def root(doc, site)
-      Draft::root(doc, site)
+      Draft.root(doc, site)
     end
   end
 
   Liquid::Template.register_filter(DraftFilter)
-  PluginMetaLogger.instance.info { "Loaded DraftFilter plugin." }
+  PluginMetaLogger.instance.info { 'Loaded DraftFilter plugin.' }
 end

data/spec/jekyll_draft_spec.rb

@@ -1,12 +1,35 @@
-# frozen_string_literal: true
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require_relative '../lib/jekyll_draft'
 
-require "jekyll"
-require_relative "../lib/jekyll_draft"
+RSpec.describe(Jekyll::Draft) do # rubocop:disable Metrics/BlockLength
+  include Jekyll::Draft
 
-RSpec.describe(jekyllDraftName) do
-  include jekyllDraftName
+  let(:page_draft) do
+    page_ = double('Jekyll::Page')
+    allow(page_).to receive(:draft) { true }
+    page_
+  end
+  let(:page_not_draft) do
+    page_ = double('Jekyll::Page')
+    allow(page_).to receive(:draft) { false }
+    page_
+  end
+  let(:page_published) do
+    page_ = double('Jekyll::Page')
+    allow(page_).to receive(:published) { true }
+    page_
+  end
+  let(:page_not_published) do
+    page_ = double('Jekyll::Page')
+    allow(page_).to receive(:published) { false }
+    page_
+  end
 
-  it "verifies basename" do
-    expect(basename("a/b/c/d/e.html")).to be_true
+  it 'detects drafts' do
+    expect(draft?(page_draft)).to be_truthy
+    expect(draft?(page_not_draft)).to be_falsey
+    expect(draft?(page_published)).to be_falsey
+    expect(draft?(page_not_published)).to be_truthy
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,11 @@
-# frozen_string_literal: true
-
-require "liquid"
-require "fileutils"
-require_relative "../lib/jekyll_draft"
+require 'jekyll'
+require_relative '../lib/jekyll_draft'
 
 RSpec.configure do |config|
   config.filter_run :focus
-  config.order = "random"
+  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"
+  config.example_status_persistence_file_path = 'spec/status_persistence.txt'
 end

data/spec/status_persistence.txt

@@ -1,4 +1,3 @@
-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  |
+example_id                       | status | run_time        |
+-------------------------------- | ------ | --------------- |
+./spec/jekyll_draft_spec.rb[1:1] | passed | 0.00903 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_draft
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll