jekyll_draft 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b81abf3dd2ad47f14dc0c7a5694642337e779a82e28500510f81eb72622abd8
-  data.tar.gz: ef24a39d682076c1d73d29dd286ce8bc5c5162af5fcc6d461aeb275f95b79598
+  metadata.gz: 6247e977c1fc678658877ae531a93041fce2cc1c2ae4df0cdab2d5f69df599c3
+  data.tar.gz: d3d03b417141f2daf752118bef92de184a3aabf02bd03a90c1cc33bb44ee6572
 SHA512:
-  metadata.gz: 3d20f8aa839be087692b4da14db1993d762d32aac95f6a6410f9cb17ee377e8516e3e218891602085eb9da1e69e95760765d2aefab370c2131f42b55c5e9ca7e
-  data.tar.gz: c191c1ff541451b6a6247c0974d2af7a7ef2d1d11e6aded828f124fe0ffb1167344ec8811c0b7235ce6d9e5dd10c0c7c52e6f2995041a45973715de751930d60
+  metadata.gz: f3f6458afb1fc8f2c62e0f79b53aade5f91b87ed2301a29cc02038c84eea68fa166530ece6531cdac1f948b22b11a8c5e632ee24f8d90547d0cf4c5b335a07a3
+  data.tar.gz: 16d8ca0eb55a72ddb9689880be8ad95c7e74f7d09dba815031037e3f7cfc740da7c02bdecf009e029ec662cb447aa66ea4c4533aaa07a21ca620749512a397d1

data/.rubocop.yml

@@ -1,6 +1,6 @@
-require: rubocop-jekyll
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
+# require: rubocop-jekyll
+# inherit_gem:
+#   rubocop-jekyll: .rubocop.yml
 
 AllCops:
   Exclude:

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+## 1.0.1 / 2022-08-05
+  * Improved how drafts are recognized
+
 ## 1.0.0 / 2022-04-02
   * Initial version

data/lib/jekyll_draft/version.rb

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

data/lib/jekyll_draft.rb

@@ -2,44 +2,44 @@
 
 # @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
 
-require "jekyll_plugin_logger"
+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
+  # Define these methods outside of module DraftFilter so they can be invoked externally and tested easily
   module Draft
-    def draft?(doc)
-      abort "Jekyll:Draft.draft? doc is nil!".red if doc.nil?
+    # @return true if doc front matter contains published that is not true, or document is in _drafts; published has priority
+    def draft?(doc) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      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.draft if doc.respond_to?(:draft)
 
-      return doc.published==false if doc.respond_to?(:published)
+      return doc['draft'] if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('draft'))
 
-      return doc['published']==false if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('published'))
+      return !doc.data['published'] if doc.respond_to?(:data) && doc.data.key?('published')
 
-      return doc.draft if doc.respond_to?(:draft)
+      return doc.published == false if doc.respond_to?(:published)
 
-      return doc['draft'] if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('draft'))
+      return doc['published'] == false if doc.respond_to?(:[]) || (doc.respond_to?(:key) && doc.key?('published'))
 
       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>"
     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
@@ -48,22 +48,21 @@ module Jekyll
     module_function :draft?, :draft_html, :root
   end
 
+  # Interface to Jekyll filters
   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
 
-    # 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,37 @@
 # frozen_string_literal: true
 
-require "jekyll"
-require_relative "../lib/jekyll_draft"
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require_relative '../lib/jekyll_draft'
 
-RSpec.describe(jekyllDraftName) do
-  include jekyllDraftName
+RSpec.describe(Jekyll::Draft) do # rubocop:disable Metrics/BlockLength
+  include Jekyll::Draft
 
-  it "verifies basename" do
-    expect(basename("a/b/c/d/e.html")).to be_true
+  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 '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,13 @@
 # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_draft
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Slinn
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -57,7 +57,6 @@ files:
 - 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
@@ -86,11 +85,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key:
+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
-...

data/spec/status_persistence.txt

@@ -1,4 +0,0 @@
-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  |