jekyll_plugin_support 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3264ff6310b66634f83d08ad21feab06f1bd871938fa11d4d72c2ab7be462f9c
-  data.tar.gz: aa2aacb039f82cb4fdec2821367254806683c39f0ba0dff1cdc715f37eb1577a
+  metadata.gz: 1a564d99fd3a1f1ec146bc48a9ad2afbb77c9d35b3af011930e36618c29e15b4
+  data.tar.gz: 4888e9972bfad0307f2391079f5a815ea4ffc2588d570738362b310220be2a73
 SHA512:
-  metadata.gz: 9e0487e0752e6ae0a9ba384e82b779a724cdc7733746c0b849fa9d2113f44b323b30d67a8d16933892b9b5221cdea990b53c4d7e93c1aecca354449c8bc6fbc7
-  data.tar.gz: 84989c8b7a0d10e37240fdb0f2f166e600d6aadb2d396e572e962e9c2541edef5d06509d991a82a252649e43089a00fe6a91b90545c34b7cf3ff9b113510fa15
+  metadata.gz: 485072f986cb15a89b0b70070b992b73e16e35bdea8003e82a770fed2918ab21f70470314beb65ca4b08343db5b41fd9237a99e686d06d1619d13502ed1e9f49
+  data.tar.gz: '0780bed92c05b1351cb67a9859e7d25c0f96c57d9cd7a3ee1b5f9e6678dde11ef72f7e4b0623f1d5143d9905a357e252fa641e38fbea1d147e0399cf38051bae'

data/CHANGELOG.md

@@ -3,3 +3,6 @@
 
 ## 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'
 
@@ -47,4 +44,3 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rspec'
   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.2.0'
+  VERSION = '0.3.0'
 end

data/lib/jekyll_plugin_support.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'jekyll_plugin_logger'
 require_relative 'jekyll_plugin_support_helper'
@@ -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_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'

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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-12 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -139,9 +139,9 @@ 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
-- spec/status_persistence.txt
 homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
 licenses:
 - MIT
@@ -174,7 +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
-- spec/status_persistence.txt
 ...