jekyll_plugin_support 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7d771129ced9b40dd3910fd9a36104e3c497bd26a20a4bb0ce821abceca7de
-  data.tar.gz: dcbf44d0d30980e90aff16792fc59d33a6e3c6e3a0f9d757f26184894499180a
+  metadata.gz: 1a564d99fd3a1f1ec146bc48a9ad2afbb77c9d35b3af011930e36618c29e15b4
+  data.tar.gz: 4888e9972bfad0307f2391079f5a815ea4ffc2588d570738362b310220be2a73
 SHA512:
-  metadata.gz: c32a692546b9f806ee3325396a804ab9b0b2c30dd2aa835dbd989d924f10e959b04dd85608315bf4412fa2cf89c70ff06c278348f4d837a9e1da1eb748952f9e
-  data.tar.gz: a126b88309c016407baad103e09f6c3e4eb554962ad8aabfbe31b31565001c9a98003bc7b56889329c669d638de75c255f939dd06b151c4a548dcdeac4daa4f7
+  metadata.gz: 485072f986cb15a89b0b70070b992b73e16e35bdea8003e82a770fed2918ab21f70470314beb65ca4b08343db5b41fd9237a99e686d06d1619d13502ed1e9f49
+  data.tar.gz: '0780bed92c05b1351cb67a9859e7d25c0f96c57d9cd7a3ee1b5f9e6678dde11ef72f7e4b0623f1d5143d9905a357e252fa641e38fbea1d147e0399cf38051bae'

data/CHANGELOG.md

@@ -1,2 +1,8 @@
 ## 0.1.0 / 2023-01-10
   * Initial version; only supports Jekyll block tags
+
+## 0.2.0 / 2023-01-12
+  * Refactored
+
+## 0.3.0 / 2023-01-14
+  * Added support for tags, which should subclass JekyllSupport::JekyllTag

data/README.md

@@ -2,8 +2,8 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll_plugin_support.svg)](https://badge.fury.io/rb/jekyll_plugin_support)
 ===========
 
-`jekyll_plugin_support` is a Ruby gem that facilitates writing and testing Jekyll plugins.
-At present only Jekyll block tags are supported.
+`Jekyll_plugin_support` is a Ruby gem that facilitates writing and testing Jekyll plugins.
+At present, only Jekyll tags and blocks are supported.
 
 ## Installation
 

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/jekyll_plugin_support.gemspec

@@ -1,8 +1,5 @@
-# frozen_string_literal: true
-
 require_relative 'lib/jekyll_plugin_support/version'
 
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_plugin_support'
 
@@ -40,11 +37,10 @@ Gem::Specification.new do |spec|
   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 '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-rake'
   spec.add_development_dependency 'rubocop-rspec'
-  # spec.add_development_dependency 'ruby-debug-ide'
+  spec.add_development_dependency 'ruby-debug-ide'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/jekyll_plugin_support/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllQuoteVersion
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/lib/jekyll_plugin_support.rb

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'jekyll_plugin_logger'
 require_relative 'jekyll_plugin_support_helper'
 require_relative 'jekyll_plugin_support/version'
 
 # @author Copyright 2022 Michael Slinn
-# @license SPDX-License-Identifier: Apache-2.0
+# @license SPDX-License-Identifier: Apache-2.0``
 module JekyllSupport
   # Base class for Jekyll block tags
   class JekyllBlock < Liquid::Block
@@ -23,6 +21,7 @@ module JekyllSupport
     # @return [void]
     def initialize(tag_name, argument_string, parse_context)
       super
+      @tag_name = tag_name
       @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
       @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
       @argument_string = argument_string
@@ -41,4 +40,37 @@ module JekyllSupport
       text
     end
   end
+
+
+  # Base class for Jekyll tags
+  class JekyllTag < Liquid::Tag
+    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
+
+    # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+    # @param tag_name [String] the name of the tag, which we usually know.
+    # @param argument_string [String] the arguments passed to the tag, as a single string.
+    # @param parse_context [Liquid::ParseContext] hash that stores Liquid options.
+    #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
+    #        a boolean parameter that determines if error messages should display the line number the error occurred.
+    #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
+    #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+    # @return [void]
+    def initialize(tag_name, argument_string, parse_context)
+      super
+      @tag_name = tag_name
+      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
+      @argument_string = argument_string
+    end
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    def render(context)
+      render_impl
+    end
+
+    # Jekyll plugins must override this method, not render, so their plugin can be tested more easily
+    def render_impl
+      abort "JekyllTag render_impl for tag #{@tag_name} must be overridden, but it was not."
+    end
+  end
 end

data/lib/jekyll_plugin_support_helper.rb

@@ -23,16 +23,29 @@ class JekyllPluginHelper
     string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
   end
 
+  # See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+  # @param tag_name [String] the name of the tag, which we already know.
+  # @param argument_string [String] the arguments from the tag, as a single string.
+  # @param parse_context [Liquid::ParseContext] hash that stores Liquid options.
+  #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
+  #        a boolean parameter that determines if error messages should display the line number the error occurred.
+  #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
+  #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
+  # @return [void]
   def initialize(tag_name, markup, logger)
-    # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
     @tag_name = tag_name
+    @logger = logger
+    @logger.debug { "@keys_values='#{@keys_values}'" }
+    reinitialize(markup.strip)
+  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))
     @keys_values = KeyValueParser \
       .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
       .parse(@argv)
-    @logger = logger
-    @logger.debug { "@keys_values='#{@keys_values}'" }
   end
 
   def delete_parameter(key)

data/lib/jekyll_plugin_support_spec_support.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 
 Registers = Struct.new(:page, :site)

data/spec/{jekyll_plugin_support_spec.rb → jekyll_block_plugin_support_spec.rb}

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll_plugin_logger'
 # require 'rspec/match_ignoring_whitespace'
 require_relative '../lib/jekyll_plugin_support'
@@ -7,7 +5,7 @@ require_relative '../lib/jekyll_plugin_support_spec_support'
 
 # Lets get this party started
 class MyTest
-  RSpec.describe Jekyll::Quote do
+  RSpec.describe JekyllSupport::JekyllBlock do
     let(:logger) do
       PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
     end

data/spec/jekyll_tag_plugin_support_spec.rb

@@ -0,0 +1,41 @@
+require 'jekyll_plugin_logger'
+# require 'rspec/match_ignoring_whitespace'
+require_relative '../lib/jekyll_plugin_support'
+require_relative '../lib/jekyll_plugin_support_spec_support'
+
+# Lets get this party started
+class MyTest
+  RSpec.describe JekyllSupport::JekyllTag do
+    let(:logger) do
+      PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    end
+
+    let(:parse_context) { TestParseContext.new }
+
+    # Example for plugin authors to refer to:
+    #
+    # let(:helper) do
+    #   JekyllTagHelper.new(
+    #     'quote',
+    #     "cite='This is a citation' url='https://blah.com' This is the quoted text.",
+    #     logger
+    #   )
+    # end
+    #
+    # fit 'is created properly' do
+    #   command_line = "cite='This is a citation' url='https://blah.com' This is the quoted text.".dup
+    #   quote = Jekyll::Quote.send(
+    #     :new,
+    #     'quote',
+    #     command_line,
+    #     parse_context
+    #   )
+    #   result = quote.send(:render_impl, command_line)
+    #   expect(result).to match_ignoring_whitespace <<-END_RESULT
+    #     <div class='quote'>
+    #       This is the quoted text.
+    #     </div>
+    #   END_RESULT
+    # end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require_relative '../lib/jekyll_plugin_support'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,48 @@ 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
@@ -66,6 +108,20 @@ dependencies:
     - - ">="
       - !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
@@ -83,7 +139,8 @@ files:
 - lib/jekyll_plugin_support/version.rb
 - lib/jekyll_plugin_support_helper.rb
 - lib/jekyll_plugin_support_spec_support.rb
-- spec/jekyll_plugin_support_spec.rb
+- spec/jekyll_block_plugin_support_spec.rb
+- spec/jekyll_tag_plugin_support_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
 licenses:
@@ -117,6 +174,7 @@ signing_key:
 specification_version: 4
 summary: Provides support for writing Jekyll plugins.
 test_files:
-- spec/jekyll_plugin_support_spec.rb
+- spec/jekyll_block_plugin_support_spec.rb
+- spec/jekyll_tag_plugin_support_spec.rb
 - spec/spec_helper.rb
 ...