jekyll_plugin_template 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 589cb215e8458e084b40967bd4b4360c457bb65a3fd01c9830af52a17d5c3bab
-  data.tar.gz: 323ea35b37a006144ccb10227bff0f49a048a098670f79ee51dda4df4787fb4b
+  metadata.gz: a4c4b04f631f93d694b6ac414c7c13e9ee040bdb054adad7d8fcacf74c86d26d
+  data.tar.gz: 83990ea5e791dc5fddf63e9493ca50af1ecacbd35021481f1400b09df70b0cc1
 SHA512:
-  metadata.gz: 3d0850c46f853f9925e99e92f423e1918303f4ae253b5f45bad8711e614d3cfc76824b7f369d0d6b7a82282440647fd1a9c6d4d5ac66b3605f56ca2d4f62cf41
-  data.tar.gz: 59fdefd6d4baff1526db8065f2691b01c86a0d889d3aaed5f81ff75adb2ea83da5982b23198fa90a3e167815ff8285d8879841078ebac374ae673cc30f8fba37
+  metadata.gz: f37621435bcb0c4d22a3765deee2e2a8942a3c6e1198ad2f737076c8aa8898937bc32d1ce2b2573fdfc16390cf05be92de5701226355764ab086553c21b03024
+  data.tar.gz: 3968dcc9173c86d0466cd00fb5d67e5236e716136a237b6e03b9a3509a319a948f8c804e22b1d46d5021d8f43d82911c6f1c75e22008bbb883b16234acb834ad

data/.rubocop.yml

@@ -1,35 +1,103 @@
-# 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/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+    - Rakefile
+    - jekyll_plugin_template.gemspec
   NewCops: enable
   TargetRubyVersion: 2.6
 
-# Gemspec/RequireMFA:
-#   Enabled: false
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
 
-# Jekyll/NoPutsAllowed:
-#   Enabled: false
+Gemspec/RequireMFA:
+  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: 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:
+  Enabled: false
+
+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,6 +1,21 @@
+## 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.
+
+## 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.
+
 ## 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`
+
 ## 0.1.2 / 2022-04-05
   * Initial version published
   * `bin/run_this_first` is unfinished but plugins work

data/Rakefile

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-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,46 +1,39 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_plugin_template/version'
 
-require_relative "lib/jekyll_plugin_template/version"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_plugin_template'
 
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_plugin_template"
-
-  spec.authors = ["Firstname Lastname"]
-  spec.bindir = "bin"
+  spec.authors = ['Firstname Lastname']
+  spec.bindir = 'bin'
   spec.description = <<~END_OF_DESC
     Expand on what spec.summary says.
   END_OF_DESC
-  spec.email = ["email@email.com"]
+  spec.email = ['email@email.com']
   spec.executables = []
 
   # 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.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'
   spec.metadata = {
-    "allowed_push_host" => "https://rubygems.org",
-    "bug_tracker_uri"   => "#{github}/issues",
-    "changelog_uri"     => "#{github}/CHANGELOG.md",
-    "homepage_uri"      => spec.homepage,
-    "source_code_uri"   => github,
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{github}/issues",
+    'changelog_uri'     => "#{github}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => github,
   }
-  spec.name = "jekyll_plugin_template"
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.6.0"
-  spec.summary = "Write a short summary; RubyGems requires one."
+  spec.name = 'jekyll_plugin_template'
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'Write a short summary; RubyGems requires one.'
   spec.version = JekyllPluginTemplateVersion::VERSION
 
-  spec.add_dependency "jekyll", ">= 3.5.0"
-  spec.add_dependency "jekyll_plugin_logger"
-  spec.add_dependency "key-value-parser"
-  spec.add_dependency "git"
-  spec.add_dependency "nokogiri"
-  spec.add_dependency "os"
-  spec.add_dependency "shellwords"
-  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"
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.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'
 end

data/lib/category_combiner.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Testing...
 module CategoryCombiner
   # For each catagory, makes a combined page from the collection pages, saves into _site/combined/#{collection.label}.html.

data/lib/category_index_generator.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Inspired by the badly broken example on https://jekyllrb.com/docs/plugins/generators/, and completely redone so it works.
 module CategoryIndexGenerator
   # Creates an index page for each catagory, plus a main index, all within a directory called _site/categories.
@@ -12,24 +10,24 @@ module CategoryIndexGenerator
       # This plugin is disabled unless _config.yml contains an entry for category_generator_enable and the value is not false
       return if site.config['category_generator_enable']
 
-      return if site.config['env']['JEKYLL_ENV'] == "production"
+      return if site.config['env']['JEKYLL_ENV'] == 'production'
 
-      index = Jekyll::PageWithoutAFile.new(site, site.source, 'categories', "index.html")
-      index.data['layout'] = "default"
-      index.data['title'] = "Post Categories"
-      index.content = "<p>"
+      index = Jekyll::PageWithoutAFile.new(site, site.source, 'categories', 'index.html')
+      index.data['layout'] = 'default'
+      index.data['title'] = 'Post Categories'
+      index.content = '<p>'
 
       site.categories.each do |category, posts|
         new_page = Jekyll::PageWithoutAFile.new(site, site.source, 'categories', "#{category}.html")
-        new_page.data['layout'] = "default"
+        new_page.data['layout'] = 'default'
         new_page.data['title'] = "Category #{category} Posts"
-        new_page.content = "<p>" + posts.map do |post|
+        new_page.content = '<p>' + posts.map do |post|
           "<a href='#{post.url}'>#{post.data['title']}</a><br>"
         end.join("\n") + "</p>\n"
         site.pages << new_page
         index.content += "<a href='#{category}.html'>#{category}</a><br>\n"
       end
-      index.content += "</p>"
+      index.content += '</p>'
       site.pages << index
     end
     # rubocop:enable Style/StringConcatenation, Metrics/AbcSize

data/lib/dumpers.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Methods to display Jekyll variable contents
 module Dumpers
   # See https://github.com/jekyll/jekyll/blob/master/lib/jekyll/collection.rb
@@ -8,7 +6,7 @@ module Dumpers
   #   Metadata is a hash with at least these keys: output[Boolean], permalink[String]
   #   selected methods: collection_dir, directory, entries, exists?, files, filtered_entries, relative_directory
   def collection_as_string(collection, indent_spaces)
-    indent = " " * indent_spaces
+    indent = ' ' * indent_spaces
     result = <<~END_COLLECTION
       '#{collection.label}' collection within '#{collection.relative_directory}' subdirectory
         #{indent}Directory: #{collection.directory}

data/lib/jekyll_block_tag_plugin.rb

@@ -1,18 +1,14 @@
-# frozen_string_literal: true
-
-require "jekyll_plugin_logger"
-require "key_value_parser"
-require "shellwords"
+require 'jekyll_plugin_support'
 
 module JekyllPluginBlockTagTemplate
-  PLUGIN_NAME = "block_tag_template"
+  PLUGIN_NAME = 'block_tag_template'.freeze
 end
 
 # This is the module-level description.
 #
 # @example Heading for this example
 #   Describe what this example does
-#   {% block_tag_template "parameter" %}
+#   {% block_tag_template 'parameter' %}
 #     Hello, world!
 #   {% endblock_tag_template %}
 #
@@ -24,35 +20,27 @@ end
 
 module JekyllBlockTagPlugin
   # This class implements the Jekyll block tag functionality
-  class MyBlock < Liquid::Block
-    # 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)
+  class MyBlock < JekyllSupport::JekyllBlock
+    include JekyllPluginTemplateVersion
+
+    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}'
@@ -60,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, Metrics/MethodLength
-      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,13 +67,16 @@ module JekyllBlockTagPlugin
 
       # Compute the return value of this Jekyll tag
       <<~HEREDOC
-        <p style="color: green; background-color: yellow; padding: 1em; border: solid thin grey;">
+        <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)
   end
 end
-
-PluginMetaLogger.instance.info { "Loaded #{JekyllPluginBlockTagTemplate::PLUGIN_NAME} v#{JekyllPluginTemplateVersion::VERSION} plugin." }
-Liquid::Template.register_tag(JekyllPluginBlockTagTemplate::PLUGIN_NAME, JekyllBlockTagPlugin::MyBlock)

data/lib/jekyll_filter_template.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require "jekyll_plugin_logger"
+require 'jekyll_plugin_logger'
 
 # @author Copyright 2020 {https://www.mslinn.com Michael Slinn}
 # Template for Jekyll filters.
@@ -14,12 +12,12 @@ module JekyllFilterTemplate
   # @param input_string [String].
   # @return [String] empty string if input_string has no contents except whitespace.
   # @example Use.
-  #   {{ "joy" | my_filter_template }} => <a href='https://www.google.com/search?q=joy' target='_blank' rel='nofollow'>joy</a>
+  #   {{ 'joy' | my_filter_template }} => <a href='https://www.google.com/search?q=joy' target='_blank' rel='nofollow'>joy</a>
   def my_filter_template(input_string)
     # @context[Liquid::Context] is available here to look up variables defined in front matter, templates, page, etc.
 
     JekyllFilterTemplate.logger.debug do
-      "Defined filters are: " + self.class # rubocop:disable Style/StringConcatenation
+      'Defined filters are: ' + self.class # rubocop:disable Style/StringConcatenation
                                     .class_variable_get('@@global_strainer')
                                     .filter_methods.instance_variable_get('@hash')
                                     .map { |k, _v| k }
@@ -29,7 +27,7 @@ module JekyllFilterTemplate
     input_string.strip!
     JekyllFilterTemplate.logger.debug "input_string=#{input_string}"
     if input_string.empty?
-      ""
+      ''
     else
       "<a href='https://www.google.com/search?q=#{input_string}' target='_blank' rel='nofollow'>#{input_string}</a>"
     end

data/lib/jekyll_hook_examples.rb

@@ -1,10 +1,8 @@
-# frozen_string_literal: true
-
-require "active_support"
-require "active_support/inflector"
+require 'active_support'
+require 'active_support/inflector'
 require 'confidential_info_redactor'
-require "nokogiri"
-require "talk_like_a_pirate"
+require 'nokogiri'
+require 'talk_like_a_pirate'
 
 # Sample Jekyll Hook plugins
 module JekyllHookExamples
@@ -19,7 +17,7 @@ module JekyllHookExamples
       next unless webpage.data['pirate_talk']
 
       html = Nokogiri.HTML(webpage.output)
-      html.css("p").each do |node|
+      html.css('p').each do |node|
         node.content = TalkLikeAPirate.translate(node.content)
       end
       webpage.output = html
@@ -43,9 +41,9 @@ module JekyllHookExamples
   def redact_all(content)
     tokens = ConfidentialInfoRedactor::Extractor.new.extract(content)
     ConfidentialInfoRedactor::Redactor.new(
-      number_text: wrap(" number"), # This redactor is over-eager
-      date_text: wrap(" date"),
-      token_text: wrap(""),
+      number_text: wrap(' number'), # This redactor is over-eager
+      date_text: wrap(' date'),
+      token_text: wrap(''),
       tokens: tokens
     ).redact(content)
   end
@@ -55,11 +53,11 @@ module JekyllHookExamples
   # Uncomment the following lines, rebuild the plugin and view http://localhost:4444/
   # to see these hooks in action:
   #
-  # Convert "Jekyll" to "Awesome Jekyll"
+  # Convert 'Jekyll' to 'Awesome Jekyll'
   # Jekyll::Hooks.register(:documents, :post_render, &modify_output)
   # Jekyll::Hooks.register(:pages, :post_render, &modify_output)
 
-  # Convert "English" to "Pirate Talk"
+  # Convert 'English' to 'Pirate Talk'
   Jekyll::Hooks.register(:documents, :post_render, &pirate_translator)
   Jekyll::Hooks.register(:pages, :post_render, &pirate_translator)