jekyll_plugin_support 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a564d99fd3a1f1ec146bc48a9ad2afbb77c9d35b3af011930e36618c29e15b4
-  data.tar.gz: 4888e9972bfad0307f2391079f5a815ea4ffc2588d570738362b310220be2a73
+  metadata.gz: 978c34638bfb0bae5b74952bb29d48dd15a8afe491406239fb05050efc78e5c2
+  data.tar.gz: fc570654d04aa4abdd8ed28fc551314fe36c0fb35ee1a14ce3ba98682298b084
 SHA512:
-  metadata.gz: 485072f986cb15a89b0b70070b992b73e16e35bdea8003e82a770fed2918ab21f70470314beb65ca4b08343db5b41fd9237a99e686d06d1619d13502ed1e9f49
-  data.tar.gz: '0780bed92c05b1351cb67a9859e7d25c0f96c57d9cd7a3ee1b5f9e6678dde11ef72f7e4b0623f1d5143d9905a357e252fa641e38fbea1d147e0399cf38051bae'
+  metadata.gz: b1d27d2008c53695c6c2a2fa85b6519bf4f95a6106a84e7ff9ffd45b3f68187159d1a88cff4c4a3c9911b8c16f28c87f33696d41b75ddbf03c07ca6f7121ee0e
+  data.tar.gz: a4729e61ca106f2f5ee8ead49771dde0a08bd55ea96e254c4fe5efd1f49a8fe82f964eb68322cedadf7061f94a982626c686ef3d5ce22914a6761a03453e1f1a

data/.rubocop.yml

@@ -14,3 +14,6 @@ Layout/LineLength:
 
 Layout/MultilineMethodCallIndentation:
   Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -1,8 +1,11 @@
-## 0.1.0 / 2023-01-10
-  * Initial version; only supports Jekyll block tags
+## 0.3.1 / 2023-02-07
+  * `JekyllBlock.render_impl` and `JekyllTag.render_impl` now define `@page` and `@site`.
+
+## 0.3.0 / 2023-01-14
+  * Added support for tags, which should subclass JekyllSupport::JekyllTag
 
 ## 0.2.0 / 2023-01-12
   * Refactored
 
-## 0.3.0 / 2023-01-14
-  * Added support for tags, which should subclass JekyllSupport::JekyllTag
+## 0.1.0 / 2023-01-10
+  * Initial version; only supports Jekyll block tags

data/README.md

@@ -10,13 +10,68 @@ At present, only Jekyll tags and blocks are supported.
 Add this line to your Jekyll plugin's Gemfile:
 
 ```ruby
-gem 'jekyll_plugin_support'
+group :jekyll_plugins do
+  gem 'jekyll_plugin_support'
+end
 ```
 
 And then execute:
 
     $ bundle install
 
+## Usage
+`JekyllSupport::JekyllBlock` and `JekyllSupport::JekyllTag`
+provide support for Jekyll tag blocks and Jekyll tags, respectively.
+They are very similar in construction and usage.
+
+Instead of subclassing your Jekyll block tag class from `Liquid::Block`,
+subclass from `JekyllSupport::JekyllBlock` instead.
+Similarly, instead of subclassing your Jekyll tag class from `Liquid::Tag`,
+subclass from `JekyllSupport::JekyllTag` instead.
+
+Both `JekyllSupport` classes instantiate new instances of
+[`PluginMetaLogger`](https://github.com/mslinn/jekyll_plugin_logger) (called `@logger`) and
+[`JekyllPluginHelper`](lib/jekyll_plugin_support_helper.rb) (called `@helper`).
+
+`JekyllPluginHelper` defines a generic `initialize` method,
+and your tag or block tag class should not override it.
+Also, your tag or block tag class should not define a method called `render`,
+because `JekyllBlock.initialize` defines one, which creates variables called
+[`@page`](https://jekyllrb.com/docs/variables/#page-variables) and
+[`@site`](https://jekyllrb.com/docs/variables/#site-variables).
+
+Instead, define a method called `render_impl`.
+For tags, `render_impl` does not accept any parameters.
+For block tags, a single parameter is required, which contains any text enclosed within your block.
+
+Your implementation of `render_impl` can access `@page` and `@site`,
+and can parse parameters passed to the tag / block tag, [as described here](https://mslinn.com/jekyll/10100-jekyll-plugin-background.html#params):
+
+```ruby
+# For a tag:
+module Jekyll
+  class Quote < JekyllSupport::JekyllTag
+    def render_impl
+      site_data = @site.data
+      @break  = @helper.parameter_specified? 'break'
+      # ...
+    end
+  end
+end
+```
+
+```ruby
+# For a tag block:
+module Jekyll
+  class Quote < JekyllSupport::JekyllBlock
+    def render_impl(text)
+      site_url = @site.url
+      @break  = @helper.parameter_specified? 'break'
+      # ...
+    end
+  end
+end
+```
 
 ## Additional Information
 More information is available on

data/lib/jekyll_plugin_support/version.rb

@@ -1,3 +1,3 @@
 module JekyllQuoteVersion
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'.freeze
 end

data/lib/jekyll_plugin_support.rb

@@ -29,19 +29,21 @@ module JekyllSupport
 
     # Method prescribed by the Jekyll plugin lifecycle.
     # @return [String]
-    def render(context)
+    def render(liquid_context)
       text = super
+      @page = liquid_context.registers[:page]
+      @site = liquid_context.registers[:site]
       render_impl text
     end
 
     # Jekyll plugins should override this method, not render, so their plugin can be tested more easily
+    # @page and @site are available
     # @return [String]
     def render_impl(text)
       text
     end
   end
 
-
   # Base class for Jekyll tags
   class JekyllTag < Liquid::Tag
     attr_reader :argument_string, :helper, :line_number, :logger, :page, :site
@@ -64,11 +66,14 @@ module JekyllSupport
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
-    def render(context)
+    def render(liquid_context)
+      @page = liquid_context.registers[:page]
+      @site = liquid_context.registers[:site]
       render_impl
     end
 
     # Jekyll plugins must override this method, not render, so their plugin can be tested more easily
+    # @page and @site are available
     def render_impl
       abort "JekyllTag render_impl for tag #{@tag_name} must be overridden, but it was not."
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_support
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll