jekyll_plugin_template 0.1.3

data/lib/jekyll_tag_plugin.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require "key_value_parser"
+require "shellwords"
+
+module JekyllPluginTagTemplate
+  PLUGIN_NAME = "tag_template"
+end
+
+# This Jekyll tag plugin creates an emoji of the desired size and alignment.
+#
+# @example Float Smiley emoji right, sized 3em
+#     {% tag_template name='smile' align='right' size='5em' %}
+#   The above results in the following HTML:
+#     <span style="float: right; font-size: 5em;">&#x1F601;</span>
+#
+# @example Defaults
+#     {% tag_template name='smile' %}
+#   The above results in the following HTML:
+#     <span style="font-size: 3em;">&#x1F601;</span>
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entery into _config.yml, like this:
+# plugin_loggers:
+#   MyTag: debug
+module JekyllTagPlugin
+  # This class implements the Jekyll tag functionality
+  class MyTag < Liquid::Tag
+    # 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
+      'kiss'       => '&#x1F619;',
+      'scream'     => '&#x1F631;',
+      'smiley'     => '&#x1F601;', # default emoji
+      'smirk'      => '&#x1F60F;',
+      'two_hearts' => '&#x1F495;',
+    }
+
+    # @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"
+
+      # 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
+
+      @envs = liquid_context.environments.first
+      @layout_hash = @envs['layout']
+      # @layout_hash = @page['layout']
+
+      @logger.debug do
+        <<~HEREDOC
+          liquid_context.scopes=#{liquid_context.scopes}
+          mode="#{@mode}"
+          page attributes:
+            #{@page.sort
+                   .reject { |k, _| REJECTED_ATTRIBUTES.include? k }
+                   .map { |k, v| "#{k}=#{v}" }
+                   .join("\n  ")}
+        HEREDOC
+      end
+
+      assemble_emoji
+    end
+
+    def assemble_emoji # rubocop:disable Metrics/MethodLength
+      case @emoji_align
+      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 = ""
+      end
+      # Compute the return value of this Jekyll tag
+      "<span style='font-size: #{@emoji_size}; #{align}'>#{@emoji_hex_code}</span>"
+    end
+  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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+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
+    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[: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")
+  end
+end

data/spec/nokogiri_test.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+
+class NokoTest
+  webpage = <<~END_PAGE
+    <html>
+      <body>
+        <p>Marvin the Martian, from Warner Bros, was <a href="https://kidadl.com/quotes/marvin-the-martian-quotes-from-the-looney-tunes-beloved-character">often angry</a>.</p>
+        <p>Being disintegrated makes me very angry! Very angry indeed!</p>
+        <p>I’m not angry. Just terribly, terribly hurt.</p>
+        <p>You make me very angry, very angry.</p>
+        <p>Flux to blow Mars into subatomic space dust make me very angry.</p>
+      </body>
+    </html>
+  END_PAGE
+
+  html = Nokogiri.HTML(webpage)
+  html.css("p").each do |node|
+    # This strips any HTML tags from node.content:
+    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

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

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OldNameVersion
+  VERSION = "0.1.0"
+end

data/spec/run_this_first_data/lib/old_name.rb

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

data/spec/run_this_first_data/old_name.gemspec

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

data/spec/run_this_first_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+load "bin/run_this_first"
+
+RSpec.configure do |config|
+  config.add_setting :work_dir
+  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
+  end
+  config.filter_run :focus
+  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"
+end

data/spec/run_this_first_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require_relative "run_this_first_helper"
+load "bin/run_this_first"
+
+RSpec.describe(JekyllPluginTemplateModule) 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")
+
+    gemspec = File.read("old_name.gemspec")
+    expect(gemspec).to include <<~END_GEMSPEC
+      require_relative "lib/new_name/version"
+
+      Gem::Specification.new do |spec|
+        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")
+
+    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
+    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"
+    ]
+  end
+end

data/spec/spec_helper.rb

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

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

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_plugin_template
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Firstname Lastname
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: key-value-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shellwords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: talk_like_a_pirate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Expand on what spec.summary says.
+
+  '
+email:
+- email@email.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- PLUGIN_README.md
+- README.md
+- Rakefile
+- jekyll_plugin_template.gemspec
+- lib/category_combiner.rb
+- lib/category_index_generator.rb
+- lib/dumpers.rb
+- lib/jekyll_block_tag_plugin.rb
+- lib/jekyll_filter_template.rb
+- lib/jekyll_hook_examples.rb
+- lib/jekyll_hooks.rb
+- lib/jekyll_plugin_template.rb
+- lib/jekyll_plugin_template/version.rb
+- lib/jekyll_tag_plugin.rb
+- spec/jekyll_plugin_template_spec.rb
+- spec/nokogiri_test.rb
+- spec/run_this_first_data/lib/old_name.rb
+- spec/run_this_first_data/lib/old_name/old_name.rb
+- spec/run_this_first_data/lib/old_name/version.rb
+- spec/run_this_first_data/old_name.gemspec
+- spec/run_this_first_helper.rb
+- spec/run_this_first_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/blog/2020/12/30/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
+  source_code_uri: https://github.com/mslinn/jekyll_plugin_template
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Write a short summary; RubyGems requires one.
+test_files: []