jekyll_draft 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 508d8293b65652e57262601a7de1aacebfe7b29e1eeb492b9fefaed87f377794
-  data.tar.gz: cf23341ecad96d666b5e5f14e44ca83b6cef430ae8c07321294539b096cc644a
+  metadata.gz: 5123990f175f9d09091e7f092a202b075067497e9b17dabf3eda397c48d9b11e
+  data.tar.gz: 80f3912e94858f6ccc373d2a155f0b6f907c79c13ea6bb8495837d019656508b
 SHA512:
-  metadata.gz: b15902c8ed65cd8fd43434a5640ad6cce272cb797ef61c47a5f768a95c3dd86768f17f513ed97dcd82dd93917e09088432fbd1976f6a89490740ae4bb2abf25c
-  data.tar.gz: efeca601d5941f016d1ec0046e6e9001c32b3bf9ab518cd92872eea8647cccbf87804aa389ef98f3bb1d0b49e64317a6f2698a692768074b3c98373140ef3a24
+  metadata.gz: 406222aeae0160d0ff1ef9c5c5d5ad9af0a4f357541dd43742a58c229bc6094343960c215efd498cee33d37fb76457aac1e6d0d5183c4f16277cbf044f4c0f79
+  data.tar.gz: eed26a657a04c4907700ef805fb41d67b2ed4842058f12918d3231035c46b2c6fe7c17b065a3a8c625410401f5376c86d3db4d40f607baa7e8c89320f623d6f5

data/.rubocop.yml

@@ -11,11 +11,11 @@ require:
 AllCops:
   Exclude:
     - demo/_site/**/*
-    - exe/**/*
+    - binstub/**/*
     - vendor/**/*
     - Gemfile*
+    - _site/**/*
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
@@ -23,10 +23,12 @@ Gemspec/DeprecatedAttributeAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
-  Exclude:
-    - jekyll_draft.gemspec
+  EnforcedHashRocketStyle: table
 
 Layout/InitialIndentation:
   Exclude:
@@ -53,7 +55,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
     - spec/**/*
-  Max: 40
+  Max: 50
 
 Metrics/CyclomaticComplexity:
   Max: 20
@@ -74,6 +76,9 @@ RSpec/ExampleLength:
 RSpec/MultipleExpectations:
   Max: 15
 
+RSpec/NoExpectationExample:
+  Enabled: false
+
 Style/CommandLiteral:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,15 +1,32 @@
+# Change Log
+
+## 2.0.0 / 2023-11-29
+
+* Made into a Jekyll block tag, because the filter implementation had problems with infinite recursing Jekyll exerpts.
+  This was a complete rewrite, incompatible with previous version.
+
+
 ## 1.1.2 / 2023-02-25
-  * Avoids Jekyll generating the message `Deprecation: Document#published is now a key in the #data hash.`
+
+* Avoids Jekyll generating the message `Deprecation: Document#published is now a key in the #data hash.`
+
 
 ## 1.1.1 / 2023-02-16
-  * Avoids Jekyll generating the message `Deprecation: Document#draft is now a key in the #data hash.`
+
+* 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
+
+* 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
+
+* Improved how drafts are recognized
+
 
 ## 1.0.0 / 2022-04-02
-  * Initial version
+
+* Initial version

data/README.md

@@ -1,15 +1,14 @@
-jekyll_draft
-[![Gem Version](https://badge.fury.io/rb/jekyll_draft.svg)](https://badge.fury.io/rb/jekyll_draft)
-===========
+# 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: `is_draft` and `draft_html`.
 
-More information is available on my website 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#draft).
 
 
 ## Installation
 
 Add the following to your CSS:
+
 ```css
 .jekyll_draft {
   background-color: #fefeab;
@@ -30,40 +29,54 @@ end
 
 And then execute:
 
-    $ bundle install
+```shell
+$ bundle
+```
 
 
 ## Usage
 
 ### `is_draft`
 
-Filters a page according to the directory it resides in, and its front matter.
-```
+This filter detects if a page is invisible when published in  `production` mode,
+and either returns `true` or `false`.
+
+```html
 {{ page | is_draft }} => true
 ```
 
 ### `draft_html`
-Filters a page according to the directory it resides in, and its front matter.
+
+This filter generates HTML to display if a page is invisible when published in `production` mode.
 If the page is not a draft then the empty string is returned.
-```
+The generated HTML for draft pages is:<br>
+`" &lt;i class='jekyll_draft'>Draft&lt;/i>"`
+
+```html
 {{ 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
+puts '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
 
 
@@ -72,28 +85,36 @@ Now point your web browser to http://localhost:4444
 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
+
+```shell
+$ BUNDLE_WITH="development" bundle
 ```
 
 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).
 
+
 ### 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
@@ -101,6 +122,7 @@ 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`.
 

data/jekyll_draft.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   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.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_draft.html'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -29,8 +29,8 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   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.version = DraftVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_logger'
+  spec.add_dependency 'jekyll_plugin_support'
 end

data/lib/draft.rb

@@ -0,0 +1,29 @@
+# Define these methods outside of the JekyllDraft class so they can be invoked externally and tested more easily
+module Draft
+  # @return true by checking in this order:
+  #   - document is in _drafts directory, detectable by doc['draft']==true
+  #   - document front matter contains 'published: false'
+  def draft?(doc)
+    return true if doc.respond_to?(:draft) && doc.draft
+    return true if doc.key?('draft') && doc['draft'] # ignore !doc['draft']
+    return !doc['published'] if doc.key?('published')
+
+    false
+  rescue StandardError => e
+    @logger.error { e }
+    false
+  end
+
+  # @param doc [Jekyll::Drops::DocumentDrop]
+  # @return HTML that indicates if a doc is a draft or not
+  def draft_html
+    return '' unless is_draft
+
+    " <i class='jekyll_draft'>Draft</i>"
+  rescue StandardError => e
+    @logger.error { e }
+    ''
+  end
+
+  module_function :draft?, :draft_html
+end

data/lib/draft_html.rb

@@ -0,0 +1,13 @@
+require 'jekyll_plugin_support'
+
+class Else < JekyllSupport::JekyllTag
+  VERSION = '0.1.0'.freeze
+  PLUGIN_NAME = 'else'.freeze
+
+  def render_impl
+    " <i class='jekyll_draft'>Draft</i>" if Draft.draft?(@page)
+  end
+
+  JekyllPluginHelper.register(self, PLUGIN_NAME)
+  PluginMetaLogger.instance.info { "Loaded #{PLUGIN_NAME.class} v#{DraftVersion::VERSION} plugin." }
+end

data/lib/else.rb

@@ -0,0 +1,13 @@
+require 'jekyll_plugin_support'
+
+class Else < JekyllSupport::JekyllTag
+  VERSION = '0.1.0'.freeze
+  PLUGIN_NAME = 'else'.freeze
+
+  def render_impl
+    RECORD_SEPARATOR
+  end
+
+  JekyllPluginHelper.register(self, PLUGIN_NAME)
+  PluginMetaLogger.instance.info { "Loaded #{PLUGIN_NAME.class} v#{DraftVersion::VERSION} plugin." }
+end

data/lib/if_draft.rb

@@ -0,0 +1,17 @@
+require 'jekyll_plugin_support'
+
+# Jekyll inline plugin that detects draft documents
+class JekyllDraft < JekyllSupport::JekyllBlock
+  PLUGIN_NAME = 'if_draft'.freeze
+  VERSION = DraftVersion::VERSION
+
+  def render_impl(content)
+    true_value, false_value, extra = content.split(RECORD_SEPARATOR)
+    raise DraftError, "Warning: More than one else clause detected" if extra
+
+    Draft.draft?(@page) ? true_value : false_value
+  end
+
+  JekyllPluginHelper.register(self, PLUGIN_NAME)
+  PluginMetaLogger.instance.info { "Loaded #{PLUGIN_NAME.class} v#{DraftVersion::VERSION} plugin." }
+end

data/lib/jekyll_draft/version.rb

@@ -1,3 +1,3 @@
-module JekyllDraftVersion
-  VERSION = '1.1.2'.freeze
+module DraftVersion
+  VERSION = '2.0.0'.freeze
 end

data/lib/jekyll_draft.rb

@@ -1,93 +1,14 @@
 # @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
 
-require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
 require 'yaml'
+require_relative 'jekyll_draft/version' unless defined?(VERSION)
 
-# Jekyll filter that detects draft documents
-module Jekyll
-  # 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?
+# Unicode record separator https://www.compart.com/en/unicode/U+241E
+RECORD_SEPARATOR = "\u{241E}".freeze
 
-      return is_unpublished(doc) if published_was_specified(doc)
+DraftError = JekyllSupport.define_error
 
-      # 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)
-
-      false
-    end
-
-    # @return HTML that indicates if a doc is a draft or not
-    def draft_html(doc)
-      return '' unless draft?(doc)
-
-      " <i class='jekyll_draft'>Draft</i>"
-    end
-
-    # @return path to root of the collection that doc is a member of
-    def root(doc, site)
-      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
-
-    # 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.
-    # Looks in data before checking for property.
-    # @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.data['published'] if doc.respond_to?(:data) && doc.data.key?('published')
-
-      return !doc.published if doc.respond_to?(:published)
-
-      return !doc['published'] if doc.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) # rubocop:disable Naming/PredicateName
-      Draft.draft?(doc)
-    end
-
-    def draft_html(doc)
-      Draft.draft_html(doc)
-    end
-
-    def is_unpublished(doc) # rubocop:disable Naming/PredicateName
-      Draft.is_unpublished(doc)
-    end
-
-    def root(doc, site)
-      Draft.root(doc, site)
-    end
-  end
-
-  Liquid::Template.register_filter(DraftFilter)
-  PluginMetaLogger.instance.info { 'Loaded DraftFilter plugin.' }
-end
+require_relative 'draft'
+require_relative 'else'
+require_relative 'if_draft'

data/spec/draft_spec.rb

@@ -0,0 +1,12 @@
+require 'rspec/match_ignoring_whitespace'
+require_relative 'lib/draft'
+
+class JekyllPluginHelperOptionsTest
+  RSpec.describe Jekyll::Draft do
+    it 'does nothing' do
+      # TODO: mock doc
+      # described_class.draft? doc
+      expect(true).to be_truthy
+    end
+  end
+end

data/spec/jekyll/draft_spec.rb

@@ -1,11 +1,21 @@
 require 'jekyll'
 require 'jekyll_plugin_logger'
+require 'rspec/match_ignoring_whitespace'
 require_relative '../../lib/jekyll_draft'
+require_relative 'mocks'
 
 RSpec.describe(Jekyll::Draft) do
   include described_class
 
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
   it 'detects drafts' do
-    pending('Not yet')
+    # expect(result).to match_ignoring_whitespace <<-END_RESULT
+    #   <img src="./blah.webp">
+    # END_RESULT
   end
 end

data/spec/jekyll/mocks.rb

@@ -0,0 +1,62 @@
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+# Mock for Liquid::Context
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      "content"     => "blah blah",
+      "description" => "Jekyll draft demo",
+      "dir"         => "/",
+      "excerpt"     => nil,
+      "layout"      => "default",
+      "name"        => "index.html",
+      "path"        => "index.html",
+      "title"       => "Welcome",
+      "url"         => "/",
+    }
+
+    @content = "This is the content"
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -2,10 +2,8 @@ require 'jekyll'
 require_relative '../lib/jekyll_draft'
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.order = 'random'
-  config.run_all_when_everything_filtered = true
-
+  config.filter_run_when_matching focus: true
+  # config.order = 'random'
   # 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

@@ -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.00007 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_draft
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: jekyll_plugin_logger
+  name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,19 +53,25 @@ files:
 - README.md
 - Rakefile
 - jekyll_draft.gemspec
+- lib/draft.rb
+- lib/draft_html.rb
+- lib/else.rb
+- lib/if_draft.rb
 - lib/jekyll_draft.rb
 - lib/jekyll_draft/version.rb
+- spec/draft_spec.rb
 - spec/jekyll/draft_spec.rb
+- spec/jekyll/mocks.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_draft.html
 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
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_draft.html
   source_code_uri: https://github.com/mslinn/jekyll_draft
 post_install_message: |2+
 
@@ -85,12 +91,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: This Jekyll filter detects draft documents.
 test_files:
+- spec/draft_spec.rb
 - spec/jekyll/draft_spec.rb
+- spec/jekyll/mocks.rb
 - spec/spec_helper.rb
 - spec/status_persistence.txt
 ...