jekyll_plugin_support 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5704c55f7166173f403cb54d03524eec33e0180fdb1f1ef4e3fe7f3d928d1c42
-  data.tar.gz: bac72f2f2a1e579256482b6e9e2c5583c8de1fc9c570d95e862b4ca0620a69d2
+  metadata.gz: ad3dd2c6f00993d77f9db69e844a1f70e52c21ac1ef66c47294cc7683dee5743
+  data.tar.gz: 121436f415bbcb0cddffa4f9b9c26f735e899aa733df38749e5be2856d56d238
 SHA512:
-  metadata.gz: 6023e3b8096284d039794a90be4669181f583a25fb3f5507b35cf8458ed84fd1ce17d538ce7c513b3729fa4eff06da8f5360a6c444d8678826cbbd35ab1cd0a4
-  data.tar.gz: 637ec49f7e0438c88acfc6ed042fd921a0cda96a986b99c3b9dfe8f9b520056af7235f8085ac1115fa092150bd6e8cd9641eb8beb50cdf00f114609306ef9a06
+  metadata.gz: b6d186e5d5347b7857cef3318a152a4a9db75e57ebe7dc244dd0574542b47b2c97c4ba55af03065099cca94c3ca3fb3e666268fb4e2427683b94a0c058388a7b
+  data.tar.gz: 1529488c906cc7c687356f22b65223f347d75eb35f1747742466166921b266c4f172233eaf638bb06af7fdf6fcd93e67d0f6ca25cbde0f98139edb05fb07d64a

data/.rubocop.yml

@@ -1,11 +1,17 @@
 AllCops:
   Exclude:
-      - vendor/**/*
-      - Gemfile*
-      - '*.gemspec' # This does nothing. Why?
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
 Layout/HashAlignment:
   Enabled: false
 
@@ -15,5 +21,21 @@ Layout/LineLength:
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_plugin_support.gemspec
+
+Metrics/MethodLength:
+  Max: 25
+
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0 / 2023-02-15
+  * Plugins now register themselves
+  * Plugins now report their name and version
+  * `@layout`, `@paginator`, and `@theme` have values if supported by the version of Jekyll, and they are active. (See [Jekyll docs](https://jekyllrb.com/docs/variables/).)
+
+## 0.4.1 / 2023-02-14
+  * Fixed several problems
+  * Added demo site
+
 ## 0.4.0 / 2023-02-12
  * `render_impl` for tags and blocks now predefines more instance variables:
    - `@liquid_context` – passed to `render`

data/README.md

@@ -50,11 +50,11 @@ and can parse parameters passed to the tag / block tag, [as described here](http
 ```ruby
 # For a tag:
 module Jekyll
-  class Quote < JekyllSupport::JekyllTag
+  class MyTag < JekyllSupport::JekyllTag
+    VERSION = '0.1.0'.freeze
+
     def render_impl
-      site_data = @site.data
-      @break  = @helper.parameter_specified? 'break'
-      # ...
+      # Your code here
     end
   end
 end
@@ -63,11 +63,34 @@ end
 ```ruby
 # For a tag block:
 module Jekyll
-  class Quote < JekyllSupport::JekyllBlock
+  class MyBlock < JekyllSupport::JekyllBlock
+    VERSION = '0.1.0'.freeze
+
     def render_impl(text)
-      site_url = @site.url
-      @break  = @helper.parameter_specified? 'break'
-      # ...
+      # Your code here
+    end
+  end
+end
+```
+
+Note that each tag or tag block must define a constant called `VERSION`.
+If your plugin is packaged as a gem, then you might need to include `version.rb` into the plugin class.
+For example, if `lib/my_plugin/version.rb` looks like this:
+
+```ruby
+module MyPluginVersion
+  VERSION = '0.5.0'.freeze
+end
+```
+
+Then your plugin can incorporate the `VERSION` constant into your plugin like this:
+```ruby
+module Jekyll
+  class MyBlock < JekyllSupport::JekyllBlock
+    include MyPluginVersion
+
+    def render_impl(text)
+      # Your code here
     end
   end
 end
@@ -109,6 +132,20 @@ jekyll_plugin_support (0.1.0)
 ```
 
 
+## Test
+A test website is provided in the `demo` directory.
+ 1. Set breakpoints.
+
+ 2. Initiate a debug session from the command line:
+    ```shell
+    $ bin/attach demo
+    ```
+
+  3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdebug-ide`.
+
+  4. View the generated website at [`http://localhost:4444`](http://localhost:4444)
+
+
 ### Build and Push to RubyGems
 To release a new version,
   1. Update the version number in `version.rb`.

data/Rakefile

@@ -2,4 +2,4 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/jekyll_plugin_support.gemspec

@@ -21,26 +21,14 @@ Gem::Specification.new do |spec|
 
     Thanks for installing #{spec.name}!
 
-  END_MESSAGE
-  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 = 'Provides support for writing Jekyll plugins.'
   spec.test_files = spec.files.grep %r{^(test|spec|features)/}
-  spec.version = JekyllQuoteVersion::VERSION
+  spec.version = JekyllPluginSupportVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_plugin_logger'
   spec.add_dependency 'key-value-parser'
-
-  spec.add_development_dependency 'debase'
-  spec.add_development_dependency 'rspec-match_ignoring_whitespace'
-  # 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

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
-module JekyllQuoteVersion
-  VERSION = '0.4.0'.freeze
+module JekyllPluginSupportVersion
+  VERSION = '0.5.0'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -31,7 +31,7 @@ module JekyllSupport
     # @return [String]
     def render(liquid_context)
       text = super
-      @liquid_context = liquid_context
+      @helper.liquid_context = liquid_context
 
       # The names of front matter variables are hash keys for @page
       @page = liquid_context.registers[:page] # Jekyll::Drops::DocumentDrop
@@ -74,12 +74,20 @@ module JekyllSupport
 
     # Method prescribed by the Jekyll plugin lifecycle.
     def render(liquid_context)
-      @liquid_context = liquid_context
-      @page = liquid_context.registers[:page]
-      @site = liquid_context.registers[:site]
+      @helper.liquid_context = liquid_context
+
+      @envs      = liquid_context.environments.first
+
+      @layout    = @envs[:layout]
+      @paginator = @envs[:paginator]
+      @theme     = @envs[:theme]
+
+      @page      = liquid_context.registers[:page]
+      @site      = liquid_context.registers[:site]
+
       @config = @site.config
-      @envs = liquid_context.environments.first
       @mode = @config['env']['JEKYLL_ENV'] || 'development'
+
       render_impl
     end
 

data/lib/jekyll_plugin_support_helper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'shellwords'
 require 'key_value_parser'
 
@@ -7,17 +5,32 @@ require 'key_value_parser'
 class JekyllPluginHelper
   attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :params, :tag_name
 
-  # Expand a environment variable reference
+  # Expand an environment variable reference
   def self.expand_env(str, die_if_undefined: false)
     str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
       envar = Regexp.last_match(1)
       raise HrefError, "jekyll_href error: #{envar} is undefined".red, [] \
         if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
 
-      ENV[envar]
+      ENV.fetch(envar, nil)
     end
   end
 
+  def self.register(klass, name)
+    abort("Error: The #{name} plugin does not define VERSION") \
+      unless klass.const_defined?(:VERSION)
+
+    version = klass.const_get(:VERSION)
+
+    abort("Error: The #{name} plugin is not an instance of JekyllSupport::JekyllBlock or JekyllSupport::JekyllTag") \
+      unless klass.instance_of?(Class) &&
+             (klass.ancestors.include?(JekyllSupport::JekyllBlock) || \
+              klass.ancestors.include?(JekyllSupport::JekyllTag))
+
+    Liquid::Template.register_tag(name, klass)
+    PluginMetaLogger.instance.info { "Loaded #{name} v#{version} plugin." }
+  end
+
   # strip leading and trailing quotes if present
   def self.remove_quotes(string)
     string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
@@ -35,14 +48,14 @@ class JekyllPluginHelper
   def initialize(tag_name, markup, logger)
     @tag_name = tag_name
     @logger = logger
-    @logger.debug { "@keys_values='#{@keys_values}'" }
     reinitialize(markup.strip)
+    @logger.debug { "@keys_values='#{@keys_values}'" }
   end
 
   def reinitialize(markup)
     # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
-    @markup = markup # Useful for debugging
-    @argv = Shellwords.split(JekyllPluginHelper.expand_env(markup))
+    @markup = markup
+    @argv = Shellwords.split(self.class.expand_env(markup))
     @keys_values = KeyValueParser \
       .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
       .parse(@argv)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,76 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: debase
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-match_ignoring_whitespace
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-debug-ide
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description:
 email:
 - mslinn@mslinn.com