jekyll_plugin_support 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d7d771129ced9b40dd3910fd9a36104e3c497bd26a20a4bb0ce821abceca7de
+  data.tar.gz: dcbf44d0d30980e90aff16792fc59d33a6e3c6e3a0f9d757f26184894499180a
+SHA512:
+  metadata.gz: c32a692546b9f806ee3325396a804ab9b0b2c30dd2aa835dbd989d924f10e959b04dd85608315bf4412fa2cf89c70ff06c278348f4d837a9e1da1eb748952f9e
+  data.tar.gz: a126b88309c016407baad103e09f6c3e4eb554962ad8aabfbe31b31565001c9a98003bc7b56889329c669d638de75c255f939dd06b151c4a548dcdeac4daa4f7

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0 / 2023-01-10
+  * Initial version; only supports Jekyll block tags

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+`jekyll_plugin_support`
+[![Gem Version](https://badge.fury.io/rb/jekyll_plugin_support.svg)](https://badge.fury.io/rb/jekyll_plugin_support)
+===========
+
+`jekyll_plugin_support` is a Ruby gem that facilitates writing and testing Jekyll plugins.
+At present only Jekyll block tags are supported.
+
+## Installation
+
+Add this line to your Jekyll plugin's Gemfile:
+
+```ruby
+gem 'jekyll_plugin_support'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Additional Information
+More information is available on
+[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+To build and install this gem onto your local machine, run:
+```shell
+$ bundle exec rake install
+jekyll_plugin_support 0.1.0 built to pkg/jekyll_plugin_support-0.1.0.gem.
+jekyll_plugin_support (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_plugin_support
+
+*** LOCAL GEMS ***
+
+jekyll_plugin_support (0.1.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_plugin_support
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+
+### Build and Push to RubyGems
+To release a new version,
+  1. Update the version number in `version.rb`.
+  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+  3. Run the following:
+     ```shell
+     $ bundle exec rake release
+     ```
+     The above creates a git tag for the version, commits the created tag,
+     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_plugin_support.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jekyll_plugin_support/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = 'https://github.com/mslinn/jekyll_plugin_support'
+
+  spec.bindir = 'exe'
+  spec.authors = ['Mike Slinn']
+  spec.email = ['mslinn@mslinn.com']
+  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage = 'https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote'
+  spec.license = 'MIT'
+  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,
+  }
+  spec.name = 'jekyll_plugin_support'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'Provides support for writing Jekyll plugins.'
+  spec.test_files = spec.files.grep %r{^(test|spec|features)/}
+  spec.version = JekyllQuoteVersion::VERSION
+
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_logger'
+  spec.add_dependency 'key-value-parser'
+
+  # spec.add_development_dependency 'debase'
+  # spec.add_development_dependency 'rspec-match_ignoring_whitespace'
+  # spec.add_development_dependency 'rubocop-jekyll'
+  # spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  # spec.add_development_dependency 'ruby-debug-ide'
+end
+# rubocop:enable Metrics/BlockLength

data/lib/jekyll_plugin_support/version.rb

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

data/lib/jekyll_plugin_support.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require_relative 'jekyll_plugin_support_helper'
+require_relative 'jekyll_plugin_support/version'
+
+# @author Copyright 2022 Michael Slinn
+# @license SPDX-License-Identifier: Apache-2.0
+module JekyllSupport
+  # Base class for Jekyll block tags
+  class JekyllBlock < Liquid::Block
+    attr_reader :argument_string, :helper, :line_number, :logger, :page, :site, :text
+
+    # 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 usually know.
+    # @param argument_string [String] the arguments passed to 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)
+      super
+      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+      @helper = JekyllPluginHelper.new(tag_name, argument_string, @logger)
+      @argument_string = argument_string
+    end
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @return [String]
+    def render(context)
+      text = super
+      render_impl text
+    end
+
+    # Jekyll plugins should override this method, not render, so their plugin can be tested more easily
+    # @return [String]
+    def render_impl(text)
+      text
+    end
+  end
+end

data/lib/jekyll_plugin_support_helper.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'key_value_parser'
+
+# Base class for all types of Jekyll plugin helpers
+class JekyllPluginHelper
+  attr_reader :argv, :keys_values, :liquid_context, :logger, :markup, :params, :tag_name
+
+  # Expand a environment variable reference
+  def self.expand_env(str, die_if_undefined: false)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) do
+      envar = Regexp.last_match(1)
+      raise HrefError, "jekyll_href error: #{envar} is undefined".red, [] \
+        if !ENV.key?(envar) && die_if_undefined # Suppress stack trace
+
+      ENV[envar]
+    end
+  end
+
+  # strip leading and trailing quotes if present
+  def self.remove_quotes(string)
+    string.strip.gsub(/\A'|\A"|'\Z|"\Z/, '').strip if string
+  end
+
+  def initialize(tag_name, markup, logger)
+    # @keys_values was a Hash[Symbol, String|Boolean] but now it is Hash[String, String|Boolean]
+    @tag_name = tag_name
+    @markup = markup # Useful for debugging
+    @argv = Shellwords.split(JekyllPluginHelper.expand_env(markup))
+    @keys_values = KeyValueParser \
+      .new({}, { array_values: false, normalize_keys: false, separator: /=/ }) \
+      .parse(@argv)
+    @logger = logger
+    @logger.debug { "@keys_values='#{@keys_values}'" }
+  end
+
+  def delete_parameter(key)
+    return if @keys_values.empty? || @params.nil?
+
+    @params.delete(key)
+    @argv.delete_if { |x| x == key or x.start_with?("#{key}=") }
+    @keys_values.delete(key)
+  end
+
+  # @return if parameter was specified, removes it from the available tokens and returns value
+  def parameter_specified?(name)
+    return false if @keys_values.empty?
+
+    key = name
+    key = name.to_sym if @keys_values.first.first.instance_of?(Symbol)
+    value = @keys_values[key]
+    delete_parameter(name)
+    value
+  end
+
+  PREDEFINED_SCOPE_KEYS = %i[include page].freeze
+
+  # Finds variables defined in an invoking include, or maybe somewhere else
+  # @return variable value or nil
+  def dereference_include_variable(name)
+    @liquid_context.scopes.each do |scope|
+      next if PREDEFINED_SCOPE_KEYS.include? scope.keys.first
+
+      value = scope[name]
+      return value if value
+    end
+    nil
+  end
+
+  # @return value of variable, or the empty string
+  def dereference_variable(name)
+    value = @liquid_context[name] # Finds variables named like 'include.my_variable', found in @liquid_context.scopes.first
+    value ||= @page[name] if @page # Finds variables named like 'page.my_variable'
+    value ||= dereference_include_variable(name)
+    value ||= ''
+    value
+  end
+
+  # Sets @params by replacing any Liquid variable names with their values
+  def liquid_context=(context)
+    @liquid_context = context
+    @params = @keys_values.map { |k, _v| lookup_variable(k) }
+  end
+
+  def lookup_variable(symbol)
+    string = symbol.to_s
+    return string unless string.start_with?('{{') && string.end_with?('}}')
+
+    dereference_variable(string.delete_prefix('{{').delete_suffix('}}'))
+  end
+
+  def page
+    @liquid_context.registers[:page]
+  end
+end

data/lib/jekyll_plugin_support_spec_support.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def collections
+    Collections.new
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  # rubocop:disable Layout/CommentIndentation
+  # def initialize
+    # super
+    # @line_number = 123
+
+    # @registers = Registers.new(
+    #   { 'path' => 'https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss' },
+    #   SiteMock.new
+    # )
+  # end
+  # rubocop:enable Layout/CommentIndentation
+end

data/spec/jekyll_plugin_support_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'jekyll_plugin_logger'
+# require 'rspec/match_ignoring_whitespace'
+require_relative '../lib/jekyll_plugin_support'
+require_relative '../lib/jekyll_plugin_support_spec_support'
+
+# Lets get this party started
+class MyTest
+  RSpec.describe Jekyll::Quote do
+    let(:logger) do
+      PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    end
+
+    let(:parse_context) { TestParseContext.new }
+
+    # Example for plugin authors to refer to:
+    #
+    # let(:helper) do
+    #   JekyllTagHelper.new(
+    #     'quote',
+    #     "cite='This is a citation' url='https://blah.com' This is the quoted text.",
+    #     logger
+    #   )
+    # end
+    #
+    # fit 'is created properly' do
+    #   command_line = "cite='This is a citation' url='https://blah.com' This is the quoted text.".dup
+    #   quote = Jekyll::Quote.send(
+    #     :new,
+    #     'quote',
+    #     command_line,
+    #     parse_context
+    #   )
+    #   result = quote.send(:render_impl, command_line)
+    #   expect(result).to match_ignoring_whitespace <<-END_RESULT
+    #     <div class='quote'>
+    #       This is the quoted text.
+    #     </div>
+    #   END_RESULT
+    # end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require_relative '../lib/jekyll_plugin_support'
+
+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

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_plugin_support
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-11 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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_plugin_support.gemspec
+- lib/jekyll_plugin_support.rb
+- lib/jekyll_plugin_support/version.rb
+- lib/jekyll_plugin_support_helper.rb
+- lib/jekyll_plugin_support_spec_support.rb
+- spec/jekyll_plugin_support_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_plugin_support/issues
+  changelog_uri: https://github.com/mslinn/jekyll_plugin_support/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
+  source_code_uri: https://github.com/mslinn/jekyll_plugin_support
+post_install_message: |2+
+
+  Thanks for installing jekyll_plugin_support!
+
+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: Provides support for writing Jekyll plugins.
+test_files:
+- spec/jekyll_plugin_support_spec.rb
+- spec/spec_helper.rb
+...