jekyll_draft 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86ee1458ee28aab9d7f99d46deeff46e98a795cb6d3737a84b2e0e9f17f68632
-  data.tar.gz: a1abc81b94ccfdc3ee46ec312324d0d086567bbabcaa40784fca3d8d1c8415e4
+  metadata.gz: d19e46e62c8e1d7cf29a6337023ea875a6497040f773c2b416f9798488820199
+  data.tar.gz: c4e3f0ae938781b77a267b3681640234c15dffa3349cf966fff74836bbe4234e
 SHA512:
-  metadata.gz: a70c60fa72cfb2dc9a8842e5b54ec9f0dec2746976edd90ed174990dcf24a14aadf801246258c257ac375c68fd72a518c9e9bc55bbbf975498c43d09a5a94774
-  data.tar.gz: 030ef794350d158b43395d957ce6f080c8497dde0db7005dacc96dd2900cacbc712c353addf1cb2443f8261e2e2fee471d9e1f39c7f7c9a758776f23a7ca56d5
+  metadata.gz: b192fb472d77c23932160650cdfe68eacfb1f52b1ccf9d0f84c6e19642e4471eeb82d3ffcba920dc3e1ae6d5ba42a04ae8372361b873bae6386521c96eacab2f
+  data.tar.gz: b7e2bfbdd778dfe7dd89846c7c7fb0d57fdb1b7d6a1c2688278c32cf9f17edaf28707749fdb90b7698820ae713f3900afb0e93d4fce41c4fea2ff4d433515b51

data/.rubocop.yml

@@ -55,7 +55,7 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Exclude:
     - spec/**/*
-  Max: 60
+  Max: 100
 
 Metrics/CyclomaticComplexity:
   Max: 20

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 3.0.1 / 2025-08-26
+
+* Now requires [Jekyll 4.4.1](https://jekyllrb.com/news/2025/01/29/jekyll-4-4-1-released/) or later, and Ruby 3.2.0 or later
+
+
 ## 2.1.0 / 2025-02-07
 
 * Added ability to return a page in any collection, or those not in a collection,

data/README.md

@@ -5,6 +5,9 @@ visible when the website is published in `production` mode.
 The Jekyll documentation is scattered and incomplete regarding detecting draft pages and documents.
 This plugin provides standard ways for detecting draft pages and documents.
 
+You can display the Jekyll mode that was active when a page was
+generated with `{{jekyll.environment}}`.
+
 `Jekyll_draft` provides the following:
 
 * Jekyll block tags: `if_draft`, `if_page_draft`, `unless_draft`, and `unless_page_draft`.
@@ -93,8 +96,8 @@ so you can learn how to write Jekyll pages that include this functionality.
 
    ```ruby
    group :jekyll_plugins do
-     gem 'jekyll_all_collections', '>= 0.3.8'
-     gem 'jekyll_draft', '>=2.1.0'
+     gem 'jekyll_plugin_support', '>= 3.0.0'
+     gem 'jekyll_draft', '>=3.0.0'
    end
    ```
 
@@ -112,8 +115,8 @@ so you can learn how to write Jekyll pages that include this functionality.
 1. Add the following to your gem’s `.gemspec`:
 
    ```ruby
-   spec.add_dependency 'jekyll_all_collections', '>= 0.3.8'
-   spec.add_dependency 'jekyll_draft', '>=2.1.0'
+   spec.add_dependency 'jekyll_plugin_support', '>= 3.0.0'
+   spec.add_dependency 'jekyll_draft', '>=3.0.0'
    ```
 
 2. Type:
@@ -312,7 +315,7 @@ Here is an example of embedding the `draft_html` inline tag into an HTML documen
 ```
 
 By default, if the document is a draft, and the Jekyll website generation was performed in development mode,
-`draft_html` emits ` <i class='jekyll_draft>Draft</i>`,
+`draft_html` emits ` <i class='jekyll_draft'>Draft</i>`,
 otherwise it does not emit anything.
 
 <p>You can change this behavior in several ways:</p>

data/jekyll_draft.gemspec

@@ -1,6 +1,6 @@
 require_relative 'lib/jekyll_draft/version'
 
-Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_draft'
 
   spec.authors     = ['Mike Slinn']
@@ -27,11 +27,12 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
 
   END_MESSAGE
   spec.require_paths         = ['lib']
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.2.0'
   spec.summary               = 'This Jekyll filter detects draft documents.'
   spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
   spec.version               = DraftVersion::VERSION
 
-  spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '>=1.1.0'
+  spec.add_dependency 'jekyll', '>= 4.4.0'
+  spec.add_dependency 'jekyll_plugin_support', '>=3.0.0'
+  spec.add_dependency 'sorted_set'
 end

data/lib/jekyll_draft/common/else.rb

@@ -1,5 +1,3 @@
-require 'jekyll_plugin_support'
-
 class ElseBase < JekyllSupport::JekyllTag
   VERSION = '0.1.0'.freeze
 

data/lib/jekyll_draft/common/module_functions.rb

@@ -24,7 +24,12 @@ module Jekyll
 
       false
     rescue StandardError => e
-      Draft.logger.error { e.full_message }
+      msg = e.full_message
+      if msg.length < 250
+        Draft.logger.error { msg }
+      else
+        Draft.logger.error { "#{msg[0..125]} ... #{msg[-125..msg.length]}" }
+      end
       false
     end
 
@@ -35,25 +40,27 @@ module Jekyll
 
       " <i class='jekyll_draft'>Draft</i>"
     rescue StandardError => e
-      Draft.logger.error { e.full_message }
+      msg = e.full_message
+      if msg.length < 250
+        Draft.logger.error { msg }
+      else
+        Draft.logger.error { "#{msg[0..125]} ... #{msg[-125..msg.length]}" }
+      end
       ''
     end
 
-    # This is a computationally intense method, and really slows down site generation.
-    # TODO: implement cache in front of sorted objects containing paths and page reference
-    # This cache is also needed by compute_link_and_text in jekyll_href
     # @return APage whose href uniquely contains path_portion,
     #         or `path_portion` as a String for non-local URLs.
     def page_match(path_portion, error_if_no_match: true, verify_unique_match: false)
       return :non_local_url if path_portion.start_with? 'http:', 'https:', 'mailto'
 
       matching_pages = if verify_unique_match
-                         ::AllCollectionsHooks.sorted_lru_files.select path_portion
+                         ::AllCollectionsHooks.sorted_lru_files.find(path_portion)
                        else
-                         match = ::AllCollectionsHooks.sorted_lru_files.find path_portion
+                         match = ::AllCollectionsHooks.sorted_lru_files.find(path_portion)
                          match.nil? ? [] : [match]
                        end
-      case matching_pages.length
+      case matching_pages.size
       when 0
         return '' unless error_if_no_match
 
@@ -70,7 +77,12 @@ module Jekyll
         exit! 2 # The user should fix this problem before allowing the website to generate
       end
     rescue StandardError => e
-      puts e.full_message
+      msg = e.full_message
+      if msg.length < 250
+        Draft.logger.error { msg }
+      else
+        Draft.logger.error { "#{msg[0..125]} ... #{msg[-125..msg.length]}" }
+      end
     end
 
     # @return path to root of the collection that doc is a member of
@@ -83,6 +95,13 @@ module Jekyll
       return index.href if index
 
       docs.min.href
+    rescue StandardError => e
+      msg = e.full_message
+      if msg.length < 250
+        Draft.logger.error { msg }
+      else
+        Draft.logger.error { "#{msg[0..150]} ... #{msg[-150..msg.length]}" }
+      end
     end
 
     module_function :draft?, :draft_html, :page_match, :root

data/lib/jekyll_draft/other_page/if_draft.rb

@@ -34,7 +34,12 @@ class DraftPageBase < JekyllSupport::JekyllBlock
                    end
     process_variables clause_value
   rescue StandardError => e
-    puts e.full_message
+    msg = e.full_message
+    if msg.length < 250
+      @logger.error { msg }
+    else
+      @logger.error { "#{msg[0..125]} ... #{msg[-125..msg.length]}" }
+    end
     exit!
   end
 
@@ -46,7 +51,7 @@ class DraftPageBase < JekyllSupport::JekyllBlock
       @error_if_no_match = tag_config['error_if_no_match'] # defaults true
       @error_if_no_match = @error_if_no_match ? @error_if_no_match == true : true
 
-      @verify_unique_match     = tag_config['verify_unique_match'] == true # defaults false
+      @verify_unique_match = true # tag_config['verify_unique_match'] == true # defaults false
     else
       @logger.warn { "There is no entry for #{@tag_name} in _config.yml; default values were applied." }
     end
@@ -58,31 +63,55 @@ class DraftPageBase < JekyllSupport::JekyllBlock
     @verify_unique_match = env_var != 'false' if env_var
   end
 
+  # @param markup [String] might contain <<path_portion>> or <<matched_page.url>>
   def process_variables(markup)
     return '' unless markup
 
     path_portion = @path_portion # add this to the binding
-    matched_page = @matched_page # add this to the binding
+    matched_page = @matched_page.instance_of?(Enumerator) ? @matched_page.first : @matched_page # add this to the binding
     _ = path_portion == matched_page # Just to keep the lint checker happy
-    markup.gsub!(/(<<([^<>]*)>>)/) do
-      token = Regexp.last_match[1] # gsub replaces token with the return value of this block
-      expression = Regexp.last_match[2]
-      if expression == 'matched_page' && matched_page.class != String
-        @logger.warn do
-          expression = 'matched_page.href'
-          <<~END_MSG
-            The expression #{token} should either specify a property, for example <<matched_page.href>>,
-            or a hash value, for example <<matched_page['title']>>.
-            The expression was modified to <<matched_page.href>> for you.
-          END_MSG
-        end
-      end
-      result = eval expression, binding # rubocop:disable Security/Eval
-      result.to_s
+    markup.gsub!(/(<<([^<>]*)>>)/) do # gsub replaces token with the return value of this block
+      replace_token Regexp.last_match[1], Regexp.last_match[2], binding
     end
     markup
   rescue StandardError => e
-    @logger.error { e.full_message }
+    msg = e.full_message
+    if msg.length < 250
+      @logger.error { msg }
+    else
+      @logger.error { "#{msg[0..125]} ... #{msg[-125..msg.length]}" }
+    end
+  end
+
+  def replace_token(token, expression, binding)
+    if expression == 'matched_page'
+      expression = case matched_page
+                   when String
+                     matched_page
+                   when APage
+                     'matched_page&.href'
+                   when LruFile
+                     'matched_page&.url'
+                   else
+                     @logger.warn do
+                       <<~END_MSG
+                         The type #{matched_page.class} has an invalid valueexpression #{token}.
+                       END_MSG
+                     end
+                     exit!
+                   end
+      @logger.warn do
+        <<~END_MSG
+          The expression #{token} should either specify a property, for example <<matched_page&.href>>,
+          or a hash value, for example <<matched_page['title']>>.
+          The expression was modified to <<#{expression}>> for you.
+        END_MSG
+      end
+    else
+      puts expression
+    end
+    result = eval expression, binding # rubocop:disable Security/Eval
+    result.to_s
   end
 end
 

data/lib/jekyll_draft/version.rb

@@ -1,3 +1,3 @@
 module DraftVersion
-  VERSION = '2.1.0'.freeze
+  VERSION = '3.0.1'.freeze unless defined?(VERSION)
 end

data/lib/jekyll_draft.rb

@@ -1,6 +1,8 @@
-# @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
-
-require 'jekyll_plugin_support'
+if ENV['USE_JPS_SOURCE']
+  require_relative "#{ENV.fetch('jekyll_plugin_support')}/lib/jekyll_plugin_support"
+else
+  require 'jekyll_plugin_support'
+end
 require 'yaml'
 require_relative 'jekyll_draft/version' unless defined?(VERSION)
 

data/spec/jekyll/draft_spec.rb

@@ -11,7 +11,8 @@ RSpec.describe(Jekyll::Draft) do
     PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
   end
 
-  let(:parse_context) { TestParseContext.new }
+  let(:parse_context_published) { TestParseContext.new(published: true) }
+  let(:parse_context_draft) { TestParseContext.new(published: false) }
 
   it 'detects drafts' do
     # expect(result).to match_ignoring_whitespace <<-END_RESULT

data/spec/jekyll/mocks.rb

@@ -23,7 +23,7 @@ end
 
 # Mock for Liquid::Context
 class TestLiquidContext < Liquid::Context
-  def initialize
+  def initialize(published: false)
     super
 
     page = {
@@ -35,6 +35,7 @@ class TestLiquidContext < Liquid::Context
       "layout"      => "default",
       "name"        => "index.html",
       "path"        => "index.html",
+      "published"   => published,
       "title"       => "Welcome",
       "url"         => "/",
     }

data/spec/status_persistence.txt

@@ -1,3 +1,3 @@
 example_id                       | status | run_time        |
 -------------------------------- | ------ | --------------- |
-./spec/jekyll/draft_spec.rb[1:1] | passed | 0.00007 seconds |
+./spec/jekyll/draft_spec.rb[1:1] | passed | 0.00041 seconds |

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_draft
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Mike Slinn
 bindir: exe
 cert_chain: []
-date: 2025-02-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -15,28 +15,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.4.0
 - !ruby/object:Gem::Dependency
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: sorted_set
+  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.
 
   '
@@ -86,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.7.1
 specification_version: 4
 summary: This Jekyll filter detects draft documents.
 test_files: