jekyll_plugin_template 0.1.3 → 0.3.0

data/lib/jekyll_hooks.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
-require "jekyll_plugin_logger"
-require_relative "jekyll_plugin_template/version"
-require_relative "dumpers"
+require 'jekyll_plugin_logger'
+require_relative 'jekyll_plugin_template/version'
+require_relative 'dumpers'
 
 module JekyllPluginHooksName
-  PLUGIN_NAME = "jekyll_plugin_hooks"
+  PLUGIN_NAME = 'jekyll_plugin_hooks'
 end
 
 # The Jekyll processing steps are described in https://jekyllrb.com/tutorials/orderofinterpretation/
@@ -38,8 +36,8 @@ module JekyllPluginHooks
   # However, this hook will not be called unless safe mode is OFF, so define loggers in the :site :after_init hook instead
   Jekyll::Hooks.register(:site, :after_reset, priority: :normal) do |site|
     @log_site ||= PluginMetaLogger.instance.new_logger(:SiteHooks, PluginMetaLogger.instance.config)
-    @log_site.info { "Jekyll::Hooks.register(:site, :after_reset) invoked." }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :after_reset)", site)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :after_reset) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :after_reset)', site)
   end
 
   # This hook is called just after the site initializes.
@@ -52,17 +50,17 @@ module JekyllPluginHooks
     @log_posts = PluginMetaLogger.instance.new_logger(:PostHooks,     PluginMetaLogger.instance.config)
     @log_site  ||= PluginMetaLogger.instance.new_logger(:SiteHooks,   PluginMetaLogger.instance.config)
 
-    @log_site.info { "Loaded #{JekyllPluginHooksName::PLUGIN_NAME} v#{JekyllPluginTemplate::VERSION} plugin." }
-    @log_site.info { "Jekyll::Hooks.register(:site, :after_init) invoked." }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :after_init)", site)
+    @log_site.info { "Loaded #{JekyllPluginHooksName::PLUGIN_NAME} v#{JekyllPluginTemplateVersion::VERSION} plugin." }
+    @log_site.info { 'Jekyll::Hooks.register(:site, :after_init) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :after_init)', site)
   end
 
   # Called after all source files have been read and loaded from disk.
   # This is a good hook for enriching posts;
   # for example, adding links to author pages or adding posts to author pages.
   Jekyll::Hooks.register(:site, :post_read, priority: :normal) do |site|
-    @log_site.info { "Jekyll::Hooks.register(:site, :post_read) invoked." }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :post_read)", site)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_read) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_read)', site)
   end
 
   # Called before rendering the whole site
@@ -72,10 +70,10 @@ module JekyllPluginHooks
   # @param payload [Hash] according to the docs, payload is a hash containing the variables available during rendering; the hash can be modified here.
   # However, the debugger shows payload has type Jekyll::UnifiedPayloadDrop
   Jekyll::Hooks.register(:site, :pre_render, priority: :normal) do |site, payload|
-    @log_site.info { "Jekyll::Hooks.register(:site, :pre_render) invoked." }
-    @log_site.debug { dump(":site, :pre_render payload", payload) }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :pre_render)", site)
-    Dumpers.dump_payload(@log_site, "Jekyll::Hooks.register(:site, :pre_render)", payload)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :pre_render) invoked.' }
+    @log_site.debug { dump(':site, :pre_render payload', payload) }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :pre_render)', site)
+    Dumpers.dump_payload(@log_site, 'Jekyll::Hooks.register(:site, :pre_render)', payload)
   end
 
   # Called after rendering the whole site, but before writing any files.
@@ -87,16 +85,16 @@ module JekyllPluginHooks
   # :documents and :pages, whereas the :pages and :documents hooks are called once for each page and document.
   # @param payload [Hash] contains final values of variables after rendering the entire site (useful for sitemaps, feeds, etc).
   Jekyll::Hooks.register(:site, :post_render, priority: :normal) do |site, payload|
-    @log_site.info { "Jekyll::Hooks.register(:site, :post_render) invoked." }
-    @log_site.debug { dump(":site, :post_render payload", payload) }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :post_render)", site)
-    Dumpers.dump_payload(@log_site, "Jekyll::Hooks.register(:site, :post_render)", payload)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_render) invoked.' }
+    @log_site.debug { dump(':site, :post_render payload', payload) }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_render)', site)
+    Dumpers.dump_payload(@log_site, 'Jekyll::Hooks.register(:site, :post_render)', payload)
   end
 
   # Called after writing all of the rendered files to disk
   Jekyll::Hooks.register(:site, :post_write, priority: :normal) do |site|
-    @log_site.info { "Jekyll::Hooks.register(:site, :post_write) invoked." }
-    Dumpers.dump_site(@log_site, "Jekyll::Hooks.register(:site, :post_write)", site)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_write) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_write)', site)
   end
 
   ########## :pages hooks
@@ -105,34 +103,34 @@ module JekyllPluginHooks
 
   # Called whenever a page is initialized
   Jekyll::Hooks.register(:pages, :post_init, priority: :normal) do |page|
-    @log_pages.info { "Jekyll::Hooks.register(:pages, :post_init) invoked." }
-    Dumpers.dump_page(@log_pages, "Jekyll::Hooks.register(:pages, :post_init)", page)
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_init) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_init)', page)
   end
 
   # Called just before rendering a page
   Jekyll::Hooks.register(:pages, :pre_render, priority: :normal) do |page, payload|
-    @log_pages.info { "Jekyll::Hooks.register(:pages, :pre_render) invoked." }
-    Dumpers.dump_page(@log_pages, "Jekyll::Hooks.register(:pages, :pre_render)", page)
-    Dumpers.dump_payload(@log_pages, ":pages, :pre_render payload", payload)
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :pre_render) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :pre_render)', page)
+    Dumpers.dump_payload(@log_pages, ':pages, :pre_render payload', payload)
   end
 
   # Called after converting the page content, but before rendering the page layout
   Jekyll::Hooks.register(:pages, :post_convert, priority: :normal) do |page|
-    @log_pages.info { "Jekyll::Hooks.register(:pages, :post_convert) invoked." }
-    Dumpers.dump_page(@log_pages, "Jekyll::Hooks.register(:pages, :post_convert)", page)
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_convert) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_convert)', page)
   end
 
   # Called after rendering a page, but before writing it to disk
   Jekyll::Hooks.register(:pages, :post_render, priority: :normal) do |page|
     page.site.safe = true
-    @log_pages.info { "Jekyll::Hooks.register(:pages, :post_render) invoked." }
-    Dumpers.dump_page(@log_pages, "Jekyll::Hooks.register(:pages, :post_render)", page)
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_render) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_render)', page)
   end
 
   # Called after writing a page to disk
   Jekyll::Hooks.register(:pages, :post_write, priority: :normal) do |page|
-    @log_pages.info { "Jekyll::Hooks.register(:pages, :post_write) invoked." }
-    Dumpers.dump_page(@log_pages, "Jekyll::Hooks.register(:pages, :post_write)", page)
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_write) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_write)', page)
   end
 
   ########## :documents hooks
@@ -149,9 +147,9 @@ module JekyllPluginHooks
   # excerpt and ext (file extension).
   # The collection attribute will be set properly for this hook.
   Jekyll::Hooks.register(:documents, :post_init, priority: :normal) do |document|
-    @log_docs.info { "Jekyll::Hooks.register(:documents, :post_init) invoked." }
-    Dumpers.dump_document(@log_docs, "Jekyll::Hooks.register(:documents, :post_init)", document)
-    "stop"
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_init) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_init)', document)
+    'stop'
   end
 
   # Called just before rendering a document.
@@ -160,30 +158,30 @@ module JekyllPluginHooks
   # If the document contains markdown (or some other markup),
   # it will not have been converted to HTML (or whatever the target format is) yet.
   Jekyll::Hooks.register(:documents, :pre_render, priority: :normal) do |document, payload|
-    @log_docs.info { "Jekyll::Hooks.register(:documents, :pre_render) invoked." }
-    Dumpers.dump_document(@log_docs, "Jekyll::Hooks.register(:documents, :pre_render)", document)
-    Dumpers.dump_payload(@log_docs, ":documents, :pre_render payload", payload)
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :pre_render) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :pre_render)', document)
+    Dumpers.dump_payload(@log_docs, ':documents, :pre_render payload', payload)
   end
 
   # Called after converting the document content to HTML (or whatever),
   # but before rendering the document using the layout.
   Jekyll::Hooks.register(:documents, :post_convert, priority: :normal) do |document|
-    @log_docs.info { "Jekyll::Hooks.register(:documents, :post_convert) invoked." }
-    Dumpers.dump_document(@log_docs, "Jekyll::Hooks.register(:documents, :post_convert)", document)
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_convert) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_convert)', document)
   end
 
   # Called after rendering a document using the layout, but before writing it to disk.
   # This is your last chance to modify the content.
   Jekyll::Hooks.register(:documents, :post_render, priority: :normal) do |document|
-    @log_docs.info { "Jekyll::Hooks.register(:documents, :post_render) invoked." }
-    Dumpers.dump_document(@log_docs, "Jekyll::Hooks.register(:documents, :post_render)", document)
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_render) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_render)', document)
   end
 
   # Called after writing a document to disk.
   # Useful for statistics regarding completed renderings.
   Jekyll::Hooks.register(:documents, :post_write, priority: :normal) do |document|
-    @log_docs.info { "Jekyll::Hooks.register(:documents, :post_write) invoked." }
-    Dumpers.dump_document(@log_docs, "Jekyll::Hooks.register(:documents, :post_write)", document)
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_write) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_write)', document)
   end
 
   ########## :posts hooks
@@ -192,16 +190,16 @@ module JekyllPluginHooks
 
   # Called whenever any post is initialized
   Jekyll::Hooks.register(:posts, :post_init, priority: :normal) do |post|
-    @log_posts.info { "Jekyll::Hooks.register(:posts, :post_init) invoked." }
-    Dumpers.dump_document(@log_posts, "Jekyll::Hooks.register(:posts, :post_init)", post)
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_init) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_init)', post)
   end
 
   # Called just before rendering a post
   Jekyll::Hooks.register(:posts, :pre_render, priority: :normal) do |post, payload|
     # post is a Jekyll::Document
-    @log_posts.info { "Jekyll::Hooks.register(:posts, :pre_render) invoked." }
-    Dumpers.dump_document(@log_posts, "Jekyll::Hooks.register(:posts, :pre_render)", post)
-    Dumpers.dump_payload(@log_posts, ":posts, :pre_render payload", payload)
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :pre_render) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :pre_render)', post)
+    Dumpers.dump_payload(@log_posts, ':posts, :pre_render payload', payload)
   end
 
   # Called after converting the post content, but before rendering the post layout.
@@ -213,21 +211,21 @@ module JekyllPluginHooks
   #     post.output.gsub!('programming PHP', 'banging rocks together')
   #   end
   Jekyll::Hooks.register(:posts, :post_convert, priority: :normal) do |post|
-    @log_posts.info { "Jekyll::Hooks.register(:posts, :post_convert) invoked." }
-    Dumpers.dump_document(@log_posts, "Jekyll::Hooks.register(:posts, :post_convert)", post)
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_convert) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_convert)', post)
   end
 
   # Called after rendering a post, but before writing it to disk.
   # Changing `post.conent` has no effect on visible output.
   Jekyll::Hooks.register(:posts, :post_render, priority: :normal) do |post|
-    @log_posts.info { "Jekyll::Hooks.register(:posts, :post_render) invoked." }
-    Dumpers.dump_document(@log_posts, "Jekyll::Hooks.register(:posts, :post_render)", post)
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_render) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_render)', post)
   end
 
   # Called after writing a post to disk
   Jekyll::Hooks.register(:posts, :post_write, priority: :normal) do |post|
-    @log_posts.info { "Jekyll::Hooks.register(:posts, :post_write) invoked." }
-    Dumpers.dump_document(@log_posts, "Jekyll::Hooks.register(:posts, :post_write)", post)
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_write) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_write)', post)
   end
 
   ########## :clean hooks

data/lib/jekyll_plugin_template/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllPluginTemplateVersion
-  VERSION = "0.1.3"
+  VERSION = '0.3.0'.freeze
 end

data/lib/jekyll_plugin_template.rb

@@ -1,15 +1,13 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require "jekyll_plugin_logger"
-require_relative "jekyll_plugin_template/version"
-require_relative "jekyll_block_tag_plugin"
-require_relative "jekyll_filter_template"
-require_relative "jekyll_tag_plugin"
-require_relative "jekyll_hooks"
-require_relative "jekyll_hook_examples"
-require_relative "category_index_generator"
-require_relative "category_combiner"
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require_relative 'jekyll_plugin_template/version'
+require_relative 'jekyll_block_tag_plugin'
+require_relative 'jekyll_filter_template'
+require_relative 'jekyll_tag_plugin'
+require_relative 'jekyll_hooks'
+require_relative 'jekyll_hook_examples'
+require_relative 'category_index_generator'
+require_relative 'category_combiner'
 
 module JekyllPluginTemplate
   include JekyllBlockTagPlugin

data/lib/jekyll_tag_plugin.rb

@@ -1,11 +1,7 @@
-# frozen_string_literal: true
-
-require "jekyll_plugin_logger"
-require "key_value_parser"
-require "shellwords"
+require 'jekyll_plugin_support'
 
 module JekyllPluginTagTemplate
-  PLUGIN_NAME = "tag_template"
+  PLUGIN_NAME = 'tag_template'.freeze
 end
 
 # This Jekyll tag plugin creates an emoji of the desired size and alignment.
@@ -27,58 +23,46 @@ end
 #   MyTag: debug
 module JekyllTagPlugin
   # This class implements the Jekyll tag functionality
-  class MyTag < Liquid::Tag
+  class MyTag < JekyllSupport::JekyllTag
+    include JekyllPluginTemplateVersion
+
     # Supported emojis (GitHub symbol, hex code) - see https://gist.github.com/rxaviers/7360908 and
     # https://www.quackit.com/character_sets/emoji/emoji_v3.0/unicode_emoji_v3.0_characters_all.cfm
     @@emojis = {
       'angry'      => '&#x1F620;',
       'boom'       => '&#x1F4A5;', # used when requested emoji is not recognized
+      'grin'       => '&#128512;',
+      'horns'      => '&#128520;',
       'kiss'       => '&#x1F619;',
+      'open'       => '&#128515;',
+      'poop'       => '&#x1F4A9;',
+      'sad'        => '&#128546;',
       'scream'     => '&#x1F631;',
       'smiley'     => '&#x1F601;', # default emoji
       'smirk'      => '&#x1F60F;',
       'two_hearts' => '&#x1F495;',
-    }
+    }.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.
     # @param tokens [Liquid::ParseContext] tokenized command line
     # @return [void]
-    def initialize(tag_name, argument_string, tokens)
-      super
-      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-
-      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
-
-      @emoji_name  = params[:name]  || "smiley"
-      @emoji_align = params[:align] || "inline" # Could be inline, right or left
-      @emoji_size  = params[:size]  || "3em"
-      @emoji_hex_code = @@emojis[@emoji_name] || @@emojis['boom']
-    end
-
-    # Method prescribed by the Jekyll plugin lifecycle.
-    # Several variables are created to illustrate how they are made.
-    # @param liquid_context [Liquid::Context]
-    # @return [String]
-    def render(liquid_context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      @site = liquid_context.registers[:site]
-      @config = @site.config
-      @mode = @config["env"]["JEKYLL_ENV"] || "development"
+    def render_impl
+      @emoji_name     = @helper.parameter_specified?('name')  || 'smiley' # Ignored if `list` is specified
+      @emoji_align    = @helper.parameter_specified?('align') || 'inline' # Allowable values are: inline, right or left
+      @emoji_size     = @helper.parameter_specified?('size')  || '3em'
+      @emoji_and_name = @helper.parameter_specified?('emoji_and_name')
+      @list           = @helper.parameter_specified?('list')
+      @emoji_hex_code = @@emojis[@emoji_name] if @emoji_name || @@emojis['boom']
 
       # 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
+      # _assigned_page_variable = @liquid_context['assigned_page_variable']
 
-      @envs = liquid_context.environments.first
-      @layout_hash = @envs['layout']
-      # @layout_hash = @page['layout']
+      @layout_hash = @page['layout']
 
       @logger.debug do
         <<~HEREDOC
-          liquid_context.scopes=#{liquid_context.scopes}
+          liquid_context.scopes=#{@liquid_context.scopes}
           mode="#{@mode}"
           page attributes:
             #{@page.sort
@@ -88,26 +72,45 @@ module JekyllTagPlugin
         HEREDOC
       end
 
-      assemble_emoji
+      # Return the value of this Jekyll tag
+      if @list
+        list
+      else
+        assemble_emoji(@emoji_name, @emoji_hex_code)
+      end
     end
 
-    def assemble_emoji # rubocop:disable Metrics/MethodLength
+    private
+
+    def assemble_emoji(emoji_name, emoji_hex_code)
       case @emoji_align
-      when "inline"
-        align = ""
-      when "right"
-        align = "float: right; margin-left: 5px;"
-      when "left"
-        align = "float: left; margin-right: 5px;"
+      when 'inline'
+        align = ''
+      when 'right'
+        align = ' float: right; margin-left: 5px;'
+      when 'left'
+        align = ' float: left; margin-right: 5px;'
       else
         @logger.error { "Invalid emoji alignment #{@emoji_align}" }
-        align = ""
+        align = ''
+      end
+
+      name = " <code>#{emoji_name}</code>" if @emoji_and_name
+
+      "<span style='font-size: #{@emoji_size};#{align}'>#{emoji_hex_code}</span>#{name}"
+    end
+
+    def list
+      items = @@emojis.map do |ename, hex_code|
+        "  <li>#{assemble_emoji(ename, hex_code)}</li>"
       end
-      # Compute the return value of this Jekyll tag
-      "<span style='font-size: #{@emoji_size}; #{align}'>#{@emoji_hex_code}</span>"
+      <<~END_RESULT
+        <ul class='emoji_list'>
+          #{items.join("\n  ")}
+        </ul>
+      END_RESULT
     end
+
+    JekyllPluginHelper.register(self, JekyllPluginTagTemplate::PLUGIN_NAME)
   end
 end
-
-PluginMetaLogger.instance.info { "Loaded #{JekyllPluginTagTemplate::PLUGIN_NAME} v#{JekyllPluginTemplateVersion::VERSION} plugin." }
-Liquid::Template.register_tag(JekyllPluginTagTemplate::PLUGIN_NAME, JekyllTagPlugin::MyTag)

data/spec/jekyll_plugin_template_spec.rb

@@ -1,26 +1,24 @@
-# frozen_string_literal: true
-
-require "fileutils"
-require "jekyll"
-require "key_value_parser"
-require "shellwords"
-require_relative "../lib/jekyll_plugin_template"
+require 'fileutils'
+require 'jekyll'
+require 'key_value_parser'
+require 'shellwords'
+require_relative '../lib/jekyll_plugin_template'
 
 RSpec.describe(KeyValueParser) do
-  it "parses arguments" do
-    argv = "param0 param1=value1 param2='value2' param3=\"value3's tricky\" remainder of line".shellsplit
+  it 'parses arguments' do
+    argv = 'param0 param1=value1 param2=\'value2\' param3="value3\'s tricky" remainder of line'.shellsplit
     parser = KeyValueParser.new
     options = parser.parse(argv)
     # puts options.map { |k, v| "#{k} = #{v}" }.join("\n")
 
     expect(options[:param0]).to eq(true)
-    expect(options[:param1]).to eq("value1")
-    expect(options[:param2]).to eq("value2")
+    expect(options[:param1]).to eq('value1')
+    expect(options[:param2]).to eq('value2')
     expect(options[:param3]).to eq("value3's tricky")
     expect(options[:unknown]).to be_nil
 
-    [:param0, :param1, :param2, :param3].each { |key| options.delete key }
-    remainder_of_line = options.keys.join(" ")
-    expect(remainder_of_line).to eq("remainder of line")
+    %i[param0 param1 param2 param3].each { |key| options.delete key }
+    remainder_of_line = options.keys.join(' ')
+    expect(remainder_of_line).to eq('remainder of line')
   end
 end

data/spec/nokogiri_test.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require "nokogiri"
+require 'nokogiri'
 
 class NokoTest
   webpage = <<~END_PAGE
@@ -16,9 +14,9 @@ class NokoTest
   END_PAGE
 
   html = Nokogiri.HTML(webpage)
-  html.css("p").each do |node|
+  html.css('p').each do |node|
     # This strips any HTML tags from node.content:
-    node.content = node.content.gsub("angry", "happy")
+    node.content = node.content.gsub('angry', 'happy')
   end
   puts "\n\nHTML:\n#{html}"
 end

data/spec/run_this_first_data/lib/old_name/old_name.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class OldName
-  old_name = "blah"
+  old_name = 'blah'
 end

data/spec/run_this_first_data/lib/old_name/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module OldNameVersion
-  VERSION = "0.1.0"
+  VERSION = '0.1.0'.freeze
 end

data/spec/run_this_first_data/lib/old_name.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 class OldName
-  old_name = "blah"
+  old_name = 'blah'
 end

data/spec/run_this_first_data/old_name.gemspec

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
-require_relative "lib/old_name/version"
+require_relative 'lib/old_name/version'
 
 Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/old_name"
-  spec.name = "old_name"
+  github = 'https://github.com/mslinn/old_name'
+  spec.name = 'old_name'
   spec.version = OldName::VERSION
 end

data/spec/run_this_first_helper.rb

@@ -1,21 +1,19 @@
-# frozen_string_literal: true
-
-load "bin/run_this_first"
+load 'bin/run_this_first'
 
 RSpec.configure do |config|
   config.add_setting :work_dir
-  config.work_dir = "/tmp/jekyll_plugin_template"
+  config.work_dir = '/tmp/jekyll_plugin_template'
 
   config.after(:suite) do
     FileUtils.rm_rf(config.work_dir)
   end
   config.before(:suite) do
-    FileUtils.cp_r "spec/run_this_first_data", config.work_dir, :verbose => true
+    FileUtils.cp_r 'spec/run_this_first_data', config.work_dir, :verbose => true
   end
   config.filter_run :focus
-  config.order = "random"
+  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/first_status_persistence.txt"
+  config.example_status_persistence_file_path = 'spec/first_status_persistence.txt'
 end

data/spec/run_this_first_spec.rb

@@ -1,40 +1,38 @@
-# frozen_string_literal: true
-
-require "fileutils"
-require_relative "run_this_first_helper"
-load "bin/run_this_first"
+require 'fileutils'
+require_relative 'run_this_first_helper'
+load 'bin/run_this_first'
 
 RSpec.describe(JekyllPluginTemplateModule) do
-  it "rename_identifiers" do
+  it 'rename_identifiers' do
     run_this_first = JekyllPluginTemplateModule::RunThisFirst.new(RSpec.configuration.work_dir)
-    run_this_first.rename_identifiers("old_variable_name", "new_variable_name")
+    run_this_first.rename_identifiers('old_variable_name', 'new_variable_name')
 
-    gemspec = File.read("old_name.gemspec")
+    gemspec = File.read('old_name.gemspec')
     expect(gemspec).to include <<~END_GEMSPEC
-      require_relative "lib/new_name/version"
+      require_relative 'lib/new_name/version'
 
       Gem::Specification.new do |spec|
-        github = "https://github.com/mslinn/new_name"
-        spec.name = "new_name"
+        github = 'https://github.com/mslinn/new_name'
+        spec.name = 'new_name'
         spec.version = NewNameVersion::VERSION
       end
     END_GEMSPEC
 
-    version_rb = File.read("old_name/old_name/version.rb")
-    expect(version_rb).to include("class NewName")
+    version_rb = File.read('old_name/old_name/version.rb')
+    expect(version_rb).to include('class NewName')
 
-    old_name_rb = File.read("old_name/old_name/old_name.rb")
-    expect(old_name_rb).to include("new_name")
+    old_name_rb = File.read('old_name/old_name/old_name.rb')
+    expect(old_name_rb).to include('new_name')
   end
 
-  it "rename_files" do
+  it 'rename_files' do
     run_this_first = JekyllPluginTemplateModule::RunThisFirst.new(RSpec.configuration.work_dir)
-    run_this_first.rename_files("old_name", "new_name")
-    expect(Dir["."]).to match_array[
-      "new_name.gemspec",
-      "lib/new_name.rb",
-      "lib/new_name/new_name.rb",
-      "lib/new_name/version.rb"
+    run_this_first.rename_files('old_name', 'new_name')
+    expect(Dir['.']).to match_array[
+      'new_name.gemspec',
+      'lib/new_name.rb',
+      'lib/new_name/new_name.rb',
+      'lib/new_name/version.rb'
     ]
   end
 end

data/spec/spec_helper.rb

@@ -1,19 +1,17 @@
-# frozen_string_literal: true
+require 'jekyll'
+require 'fileutils'
+require 'key_value_parser'
+require 'shellwords'
 
-require "jekyll"
-require "fileutils"
-require "key_value_parser"
-require "shellwords"
-
-require_relative "../lib/jekyll_plugin_template"
+require_relative '../lib/jekyll_plugin_template'
 
 Jekyll.logger.log_level = :info
 
 RSpec.configure do |config|
   config.filter_run :focus
-  config.order = "random"
+  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"
+  config.example_status_persistence_file_path = 'spec/status_persistence.txt'
 end