jekyll_plugin_template 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b8804da5578887e2b1dd581de8ad30d4e7e4f4ed4a9a4d6c517e710f52a94c3
-  data.tar.gz: 9237ebfda58f9da784c9c19c13f60ca9f4b7fcaa62a818b9b383c58b66a931ae
+  metadata.gz: bbf29c25ea3f418a5aaed7a236aedaf123bdc00a56e9c5d4d695ff0fba17b7ca
+  data.tar.gz: 753290a87bcab62f7f67649633b6c26b1a5cdff1ebde9d8bd44cad4370616e3d
 SHA512:
-  metadata.gz: 8a034a2186a0cd8835a96de90c959da5969b8703d8321c86cd3ed5a34fc8473d8ef6363c67aa6ce51a5214b97e97d19be8d790f8d22667ff9eb460f6279e27be
-  data.tar.gz: 2286531c8782695985b19746a019f1215c257ea2c4ffee55bf2fdacf38d3555c85f8a15cd3145f30d466a67c6d31d7ba522b86b4baae1d6779bafeecb9bba86b
+  metadata.gz: 92dd8e9cade06df75d6cadde7156d9ef55762ae59e7f2a28a7d3965477742513aca7ec71cd24461148c3991e9f254f9c79df006b873dcaf365340f5a6c1c3b36
+  data.tar.gz: db9fc71ce9001fd46cb3a5068f707a1670288c574cb87e3b757e9bef23c11b249e6ca0ee00a6ffd52358e7779df7f1fa1230144cb18ec20560cf54ada57c86a9

data/.rubocop.yml

@@ -1,37 +1,82 @@
-# require: rubocop-jekyll
-# inherit_gem:
-#  rubocop-jekyll: .rubocop.yml
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   Exclude:
-      - vendor/**/*
-      - Gemfile*
-      - '*.gemspec' # This does nothing. Why?
+    - demo/_site/**/*
+    - binstub/**/*
+    - vendor/**/*
+    - Gemfile*
+    - Rakefile
+    - jekyll_plugin_template.gemspec
   NewCops: enable
-  TargetRubyVersion: 2.6
 
-# Gemspec/RequireMFA:
-#   Enabled: false
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
 
-# Jekyll/NoPutsAllowed:
-#   Enabled: false
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
 
 Layout/HashAlignment:
+  EnforcedColonStyle: table
   EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_plugin_template.gemspec
+
 Metrics/AbcSize:
-  Max: 20
+  Max: 35
 
 Metrics/BlockLength:
-  Max: 50
+  Exclude:
+    - jekyll_plugin_template.gemspec
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
 
 Metrics/MethodLength:
   Max: 40
 
-Metrics/ModuleLength:
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 15
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/CommentedKeyword:
   Enabled: false
 
 Style/Documentation:
@@ -40,5 +85,21 @@ Style/Documentation:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - spec/**/*
+
 Style/StringLiterals:
   Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,17 +1,38 @@
+# Change Log
+
+
+## 0.3.1 / 2024-07-24
+
+* Updated to `jekyll_plugin_support` v1.0.0.
+
+
+## 0.3.0 / 2023-04-05
+
+* Updated to `jekyll_plugin_support` v0.6.0 for attribution support.
+* Fixed `jeky_block_tag_plugin.rb` so it works properly with `jekyll_plugin_support`.
+
+
 ## 0.2.0 / 2023-02-16
-  * Updated to `jekyll_plugin_support` v0.5.0.
+
+* Updated to `jekyll_plugin_support` v0.5.0.
+
 
 ## 0.1.3 / 2023-02-12
-  * Added `grin`, `horns`, `open`, `poop` and `sad` emojis.
-  * Now based on [`JekyllSupport::JekyllTag`](https://mslinn.com/jekyll/10200-jekyll-plugin-support.html) instead of `Liquid::Tag`.
-  * Added `list` and `emoji_and_name` options.
-  * Updated `demo` to exercise the new features.
-  * `Demo` now builds the plugins prior to each run.
+
+* Added `grin`, `horns`, `open`, `poop` and `sad` emojis.
+* Now based on [`JekyllSupport::JekyllTag`](https://mslinn.com/jekyll/10200-jekyll-plugin-support.html) instead of `Liquid::Tag`.
+* Added `list` and `emoji_and_name` options.
+* Updated `demo` to exercise the new features.
+* `Demo` now builds the plugins prior to each run.
+
 
 ## 0.1.3 / 2022-04-15
-  * Renamed `lib/jekyll_tag_plugins.rb` to  `lib/jekyll_block_tag_plugin.rb`
-  * Added `lib/jekyll_tag_plugin.rb`
+
+* Renamed `lib/jekyll_tag_plugins.rb` to  `lib/jekyll_block_tag_plugin.rb`
+* Added `lib/jekyll_tag_plugin.rb`
+
 
 ## 0.1.2 / 2022-04-05
-  * Initial version published
-  * `bin/run_this_first` is unfinished but plugins work
+
+* Initial version published
+* `bin/run_this_first` is unfinished but plugins work

data/README.md

@@ -45,7 +45,7 @@ The customized gem is ready to be pushed to `RubyGems.org`, or any other Ruby ge
      ```
   5) Build the plugins provided with this template.
      ```shell
-     $ rake install:local
+     $ bundle exec rake install
      ```
   6) You can now use your new Jekyll plugins in a Jekyll website.
 

data/Rakefile

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

data/jekyll_plugin_template.gemspec

@@ -1,10 +1,10 @@
 require_relative 'lib/jekyll_plugin_template/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   github = 'https://github.com/mslinn/jekyll_plugin_template'
 
-  spec.authors = ['Firstname Lastname']
-  spec.bindir = 'bin'
+  spec.authors = ['Mike Slinn']
+  spec.bindir = 'exe'
   spec.description = <<~END_OF_DESC
     Expand on what spec.summary says.
   END_OF_DESC
@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
 
-  spec.homepage = 'https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html'
-  spec.license = 'CC0-1.0'
+  spec.homepage = 'https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html'
+  spec.license = 'CC0-1.0' # MIT is most popular for Ruby gems
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri'   => "#{github}/issues",
@@ -30,13 +30,10 @@ Gem::Specification.new do |spec|
   spec.version = JekyllPluginTemplateVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 1.0.0'
   spec.add_dependency 'git'
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'os'
   spec.add_dependency 'talk_like_a_pirate', '~> 0.2.2'
   spec.add_dependency 'tty-prompt'
-
-  # spec.add_development_dependency 'debase'
-  # spec.add_development_dependency 'ruby-debug-ide'
 end

data/lib/jekyll_block_tag_plugin.rb

@@ -1,7 +1,7 @@
 require 'jekyll_plugin_support'
 
 module JekyllPluginBlockTagTemplate
-  PLUGIN_NAME = 'block_tag_template'
+  PLUGIN_NAME = 'block_tag_template'.freeze
 end
 
 # This is the module-level description.
@@ -23,34 +23,24 @@ module JekyllBlockTagPlugin
   class MyBlock < JekyllSupport::JekyllBlock
     include JekyllPluginTemplateVersion
 
-    # 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, argument_string, parse_context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      super
-      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    REJECTED_ATTRIBUTES = %w[content excerpt next previous].freeze
 
-      @argument_string = argument_string
+    # Method prescribed by the Jekyll support plugin.
+    # @return [String]
+    def render_impl(content)
+      @helper.gem_file __FILE__ # This enables attribution
 
-      argv = Shellwords.split(argument_string) # Scans name/value arguments
-      params = KeyValueParser.new.parse(argv) # Extracts key/value pairs, default value for non-existant keys is nil
-      @param1 = params[:param1] # Obtain the value of parameter param1
-      @param2 = params[:param2]
-      @param3 = params[:param3]
-      @param4 = params[:param4]
-      @param5 = params[:param5]
-      @param_x = params[:not_present] # The value of parameters that are present is nil, but displays as the empty string
+      @param1  = @helper.keys_values['param1'] # Obtain the value of parameter param1
+      @param2  = @helper.keys_values['param2']
+      @param3  = @helper.keys_values['param3']
+      @param4  = @helper.keys_values['param4']
+      @param5  = @helper.keys_values['param5']
+      @param_x = @helper.keys_values['not_present'] # The value of parameters that are present is nil, but displays as the empty string
 
       @logger.debug do
         <<~HEREDOC
-          tag_name = '#{tag_name}'
-          argument_string = '#{argument_string}'
+          tag_name = '#{@helper.tag_name}'
+          argument_string = '#{@helper.argument_string}'
           @param1 = '#{@param1}'
           @param2 = '#{@param2}'
           @param3 = '#{@param3}'
@@ -58,36 +48,14 @@ module JekyllBlockTagPlugin
           @param5 = '#{@param5}'
           @param_x = '#{@param_x}'
           params =
-            #{params.map { |k, v| "#{k} = #{v}" }.join("\n  ")}
+            #{@helper.keys_values.map { |k, v| "#{k} = #{v}" }.join("\n  ")}
         HEREDOC
       end
-    end
-
-    REJECTED_ATTRIBUTES = %w[content excerpt next previous].freeze
-
-    # Method prescribed by the Jekyll plugin lifecycle.
-    # @param liquid_context [Liquid::Context]
-    # @return [String]
-    def render(liquid_context) # rubocop:disable Metrics/AbcSize
-      content = super # This underdocumented assignment returns the text within the block.
-
-      @site = liquid_context.registers[:site]
-      @config = @site.config
-      @mode = @config.dig('env', 'JEKYLL_ENV') || 'development'
-
-      # variables defined in pages are stored as hash values in liquid_context
-      _assigned_page_variable = liquid_context['assigned_page_variable']
-
-      # The names of front matter variables are hash keys for @page
-      @page = liquid_context.registers[:page] # @page is a Jekyll::Drops::DocumentDrop
-      # layout = @page['layout']
 
-      @envs = liquid_context.environments.first
       @layout_hash = @envs['layout']
 
       @logger.debug do
         <<~HEREDOC
-          liquid_context.scopes=#{liquid_context.scopes}
           mode="#{@mode}"
           page attributes:
             #{@page.sort
@@ -101,10 +69,14 @@ module JekyllBlockTagPlugin
       <<~HEREDOC
         <p style='color: green; background-color: yellow; padding: 1em; border: solid thin grey;'>
           #{content} #{@param1}
+          #{@helper.attribute if @helper.attribution}
         </p>
       HEREDOC
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 3
     end
 
-    JekyllPluginHelper.register(self, JekyllPluginBlockTagTemplate::PLUGIN_NAME)
+    JekyllSupport::JekyllPluginHelper.register(self, JekyllPluginBlockTagTemplate::PLUGIN_NAME)
   end
 end

data/lib/jekyll_plugin_template/version.rb

@@ -1,3 +1,3 @@
 module JekyllPluginTemplateVersion
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/jekyll_tag_plugin.rb

@@ -1,9 +1,5 @@
 require 'jekyll_plugin_support'
 
-module JekyllPluginTagTemplate
-  PLUGIN_NAME = 'tag_template'.freeze
-end
-
 # This Jekyll tag plugin creates an emoji of the desired size and alignment.
 #
 # @example Float Smiley emoji right, sized 3em
@@ -22,6 +18,8 @@ end
 # plugin_loggers:
 #   MyTag: debug
 module JekyllTagPlugin
+  PLUGIN_NAME = 'tag_template'.freeze
+
   # This class implements the Jekyll tag functionality
   class MyTag < JekyllSupport::JekyllTag
     include JekyllPluginTemplateVersion
@@ -41,7 +39,7 @@ module JekyllTagPlugin
       'smiley'     => '&#x1F601;', # default emoji
       'smirk'      => '&#x1F60F;',
       'two_hearts' => '&#x1F495;',
-    }.sort_by { |k, v| [k] }.to_h
+    }.sort_by { |k, _v| [k] }.to_h
 
     # @param tag_name [String] is the name of the tag, which we already know.
     # @param argument_string [String] the arguments from the web page.
@@ -101,13 +99,16 @@ module JekyllTagPlugin
     end
 
     def list
-      "<ul class='emoji_list'>\n" +
-      (@@emojis.map do |ename, hex_code|
-        "  <li>#{ assemble_emoji(ename, hex_code) }</li>\n"
-      end).join +
-      "</ul>\n"
+      items = @@emojis.map do |ename, hex_code|
+        "  <li>#{assemble_emoji(ename, hex_code)}</li>"
+      end
+      <<~END_RESULT
+        <ul class='emoji_list'>
+          #{items.join("\n  ")}
+        </ul>
+      END_RESULT
     end
 
-    JekyllPluginHelper.register(self, JekyllPluginTagTemplate::PLUGIN_NAME)
+    JekyllSupport::JekyllPluginHelper.register(self, JekyllTagPlugin::PLUGIN_NAME)
   end
 end

data/spec/spec_helper.rb

@@ -8,9 +8,8 @@ require_relative '../lib/jekyll_plugin_template'
 Jekyll.logger.log_level = :info
 
 RSpec.configure do |config|
-  config.filter_run :focus
+  config.filter_run_when_matching focus: true
   config.order = 'random'
-  config.run_all_when_everything_filtered = true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = 'spec/status_persistence.txt'

data/spec/status_persistence.txt

@@ -0,0 +1,5 @@
+example_id                                 | status | run_time        |
+------------------------------------------ | ------ | --------------- |
+./spec/jekyll_plugin_template_spec.rb[1:1] | passed | 0.02165 seconds |
+./spec/run_this_first_spec.rb[1:1]         | failed | 0.00134 seconds |
+./spec/run_this_first_spec.rb[1:2]         | failed | 2.84 seconds    |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_plugin_template
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
-- Firstname Lastname
+- Mike Slinn
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,16 @@ dependencies:
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +143,15 @@ files:
 - spec/run_this_first_helper.rb
 - spec/run_this_first_spec.rb
 - spec/spec_helper.rb
-homepage: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
 licenses:
 - CC0-1.0
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_plugin_template/issues
   changelog_uri: https://github.com/mslinn/jekyll_plugin_template/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+  homepage_uri: https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
   source_code_uri: https://github.com/mslinn/jekyll_plugin_template
 post_install_message:
 rdoc_options: []
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Write a short summary; RubyGems requires one.