jekyll_flexible_include 2.0.2 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d4ee5a84b021c967aaafa2e1894537041e4770c0604a76f02d8d9e03fc3c9e
-  data.tar.gz: 9f6337ca74f362b8a3870eb347f988ebc21ceaf73e3073c4bdd42c0bd2818cde
+  metadata.gz: 7728aa7304d9fef053bb7b6f0e5adb59938a13711764f5ec1615497d54e23845
+  data.tar.gz: 1ef45a4764e136856e80e9a874cfa6e30ac1a9bc2523a10a024fa79bafc1b3d5
 SHA512:
-  metadata.gz: 5dbdeef00337d13e4a2db94c80e25a324e2bf731886ead64678b3e579a2fb2b568fa9b3c2e68cafa00e21a2bc72fe47d2463e0f046df58f96285f76de0cc78e0
-  data.tar.gz: dae0c2b23c91458111599ee0db43dad4dc863dc14f6d52ba48e919bff0132d3b3eae160f748fffa7aabe5f82a82f0702113fad71bc6c7a2c16d2ad5f0f8a8180
+  metadata.gz: 33c164b768d259e680458b14fab226d7fe038685a8dc98b459140a812628c8e9978e200e1ea3da414be678ebaca5f73e3b42957f26879162d6ce9c874f5346d2
+  data.tar.gz: 43b56da5e19d31a4aa51c87ba21d284c57f1f242a2f25f16bf71d3524ad620df09ba98faf18b234992073ddb2b09fbe89a912a6a15877d9ce1b71608eaa6ea33

data/.rubocop.yml

@@ -9,6 +9,9 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.6
 
+# Gemspec/RequireMFA:
+  # Enabled: false
+
 Layout/LineLength:
   Max: 150
 
@@ -18,6 +21,9 @@ Layout/MultilineMethodCallIndentation:
 Metrics/BlockLength:
   Enabled: false
 
+Style/CommandLiteral:
+  Enabled: false
+
 Style/PercentLiteralDelimiters:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,14 +1,19 @@
-## 2.0.2 / 2022-03-11
-  * This version should actually work, crossing fingers
+## 2.0.5 / 2022-04-11
+  * Now using <code>Shellwords</code> and <code>KeyValueParser</code> instead of a homegrown parser.
+  * Refactored helper methods to jekyll_tag_helper.rb
+  * Looks up values for liquid variable references from several scopes.
+  * Suppresses stack dump when an error occurs.
+  * Deleted a lot of old cruft.
+  * Added pre, label and copy_button optional parameters
+
+## 2.0.4 / 2022-04-05
+  * Updated to `jekyll_plugin_logger` v2.1.0
 
-## 2.0.1 / 2022-03-11
-  * Struggling with poorly documented gem naming conventions, this release is broken, do not use
 ## 2.0.0 / 2022-03-11
   * Made into a Ruby gem and published on RubyGems.org as [jekyll_flexible_include](https://rubygems.org/gems/jekyll_flexible_include).
   * `bin/attach` script added for debugging
   * Rubocop standards added
   * Proper versioning and CHANGELOG.md added
-  * This release is broken, do not use
 
 ## 1.1.1 / 2021-05-01
   * Handles spaces in filenames properly.

data/README.md

@@ -4,7 +4,12 @@ Jekyll `flexible_include` Plugin
 
 `Flexible_include` is a Jekyll plugin that includes the contents of a file or the result of a process into a generated page. `Flexible_include` is useful because Jekyll's built-in `include` tag only supports the including of files residing within the `_includes/` subfolder of a Jekyll project, and because `flexible_include` offers additional ways of including content.
 
-Originally called  `include_absolute`, this plugin has been renamed to `flexible_include` because it no longer just includes absolute file names. This plugin supports 4 types of includes:
+Originally called  `include_absolute`, this plugin has been renamed to `flexible_include` because it no longer just includes absolute file names.
+
+This plugin is available as a [Ruby gem](https://rubygems.org/gems/jekyll_flexible_include).
+More information is available on my website about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+This plugin supports 4 types of includes:
 
 ### Include Types
 
@@ -17,14 +22,31 @@ Originally called  `include_absolute`, this plugin has been renamed to `flexible
 In addition, filenames that require environment expansion because they contain a <code>$</code> character are
 expanded according to the environment variables defined when <code>jekyll build</code> executes.
 
-### Syntax:
+### Syntax
+The following are equivalent:
 ```
-{% flexible_include path [ do_not_escape='true' ] %}
+{% flexible_include path [ OPTIONS ] %}
+{% flexible_include 'path' [ OPTIONS ] %}
+{% flexible_include "path" [ OPTIONS ] %}
 ```
 
-The included file will escape characters <code>&lt;</code>, <code>{</code> and <code>}</code> unless <code>do_not_escape</code>
-is specified with a value other than <code>false</code>.
-Note that the [square brackets] merely indicate an optional parameter and are not intended to be literally written.
+By default, the included file will escape characters <code>&lt;</code>, <code>{</code> and <code>}</code>
+unless <code>do_not_escape</code> is specified.
+Note that the [square brackets] merely indicate optional parameters and are not intended to be written literally.
+
+### Options
+  * `do_not_escape` includes the content without HTML escaping it.
+  * `pre` causes the included file to be wrapped inside a &lt;pre>&lt;/pre> tag, no label is generated.
+
+The following options imply `pre`:
+  * `download` uses the name of the file as a label, and displays it above the &lt;pre>&lt;/pre> tag. Clicking the label causes the file to be downloaded.
+  * `copy_button` draws an icon at the top right of the &lt;pre>&lt;/pre> tag that causes the included contents to be copied to the clipboard.
+  * `label` specifies that an automatically generated label be placed above the contents. There is no need to specify this option if `download` or `copy_button` options are provided.
+  * `label="blah blah"` specifies a label for the contents; this value overrides the default label. The value can be enclosed in single or double quotes.
+
+
+### Additional Information
+More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Installation
@@ -36,9 +58,24 @@ group :jekyll_plugins do
 end
 ```
 
+Also add it to `_config.yml`:
+```yaml
+plugins:
+  - flexible_include
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_flexible_include
+
+
 ## Examples
 
-1. Include files without parameters; all four types of includes are shown.
+1. Include files, escaping any HTML markup so it appears as written; all four types of includes are shown.
    ```
    {% flexible_include '../../folder/outside/jekyll/site/foo.html' %}
    {% flexible_include 'folder/within/jekyll/site/bar.js' %}
@@ -50,9 +87,14 @@ end
 
 2. Include a JSON file (without escaping characters).
    ```
-   {% flexible_include '~/folder/under/home/directory/foo.html' do_not_escape='true' %}
+   {% flexible_include '~/folder/under/home/directory/foo.html' do_not_escape %}
    ```
 
+## Additional Information
+More information is available on
+[Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
 ## GitHub Pages
 GitHub Pages only allows [these plugins](https://pages.github.com/versions/).
 That means `flexible_include` will not work on GitHub Pages.
@@ -75,9 +117,48 @@ If the plugin does not work:
 
 ## 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.
+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.
+
+### Build and Install Locally
+To build and install this gem onto your local machine, run:
+```shell
+$ rake install:local
+```
+
+The following also does the same thing:
+```shell
+$ bundle exec rake install
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_flexible_include
+
+*** LOCAL GEMS ***
+
+jekyll_flexible_include (2.0.4)
+    Authors: Mike Slinn, Tan Nhu, Maarten Brakkee
+    Homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#flexibleInclude
+    License: MIT
+    Installed at (2.0.4): /home/mslinn/.rbenv/versions/2.7.2/lib/ruby/gems/2.7.0
+
+    Jekyll plugin supports various ways to include content into the
+    generated site.
+```
+
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### 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
@@ -89,4 +170,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## License
 
-[MIT](./LICENSE)
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_flexible_include_plugin.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/flexible_include/version"
+
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_flexible_include_plugin"
+
+  spec.authors = ["Mike Slinn", "Tan Nhu", "Maarten Brakkee"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    Jekyll's built-in include tag only supports including files within the _includes folder.
+    This plugin supports 4 types of includes: absolute filenames,
+    filenames relative to the top-level directory of the Jekyll web site,
+    filenames relative to the user home directory,
+    and executable filenames on the PATH.
+  END_OF_DESC
+  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#flexibleInclude"
+  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_flexible_include"
+  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 = "Jekyll plugin supports various ways to include content into the generated site."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllFlexibleIncludePluginVersion::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger", '~> 2.1.0'
+
+  spec.add_development_dependency "debase"
+  # 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

data/lib/flexible_include/version.rb

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

data/lib/flexible_include.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll_plugin_logger"
+require "securerandom"
+require_relative "flexible_include/version"
+require_relative "jekyll_tag_helper"
+
+module JekyllFlexibleIncludeName
+  PLUGIN_NAME = "flexible_include"
+end
+
+class FlexibleInclude < Liquid::Tag
+  FlexibleIncludeError = Class.new(Liquid::Error)
+
+  # @param tag_name [String] the name of the tag, which we already know.
+  # @param markup [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
+  def initialize(tag_name, markup, _parse_context)
+    super
+    @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    @helper = JekyllTagHelper.new(tag_name, markup, @logger)
+  end
+
+  # @param liquid_context [Liquid::Context]
+  def render(liquid_context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+    @helper.liquid_context = liquid_context
+    @do_not_escape = @helper.parameter_specified? "do_not_escape"
+    @download = @helper.parameter_specified? "download"
+    @label = @helper.parameter_specified? "label"
+    @label_specified = @label
+    @copy_button = @helper.parameter_specified? "copyButton"
+    @pre = @copy_button || @download || @label_specified || @helper.parameter_specified?("pre") # Download or label implies pre
+    filename = @helper.params.first # Do this after all options have been checked for
+    @label ||= filename
+
+    # If a label was specified, use it, otherwise concatenate any dangling parameters and use that as the label
+    @label ||= @helper.params[1..].join(" ")
+
+    @logger.debug("filename=#{filename}")
+
+    path = JekyllTagHelper.expand_env(filename)
+    case path
+    when /\A\// # Absolute path
+      @logger.debug { "Absolute path=#{path}, filename=#{filename}" }
+    when /\A~/ # Relative path to user's home directory
+      @logger.debug { "User home start filename=#{filename}, path=#{path}" }
+      filename.slice! "~/"
+      path = File.join(ENV['HOME'], filename)
+      @logger.debug { "User home end filename=#{filename}, path=#{path}" }
+    when /\A!/ # Run command and return response
+      filename = JekyllTagHelper.remove_quotes(@helper.argv.first)
+      filename.slice! "!"
+      contents = run(filename)
+    else # Relative path
+      site = liquid_context.registers[:site]
+      source = File.expand_path(site.config['source']) # website root directory
+      path = File.join(source, filename) # Fully qualified path of include file from relative path
+      @relative = true
+      @logger.debug { "Relative end filename=#{filename}, path=#{path}" }
+    end
+    render_completion(path, contents)
+    # rescue StandardError => e
+    #   raise FlexibleIncludeError, e.message.red, [] # Suppress stack trace
+  end
+
+  private
+
+  def read_file(file)
+    File.read(file)
+  end
+
+  def realpath_prefixed_with?(path, dir)
+    File.exist?(path) && File.realpath(path).start_with?(dir)
+  rescue StandardError
+    false
+  end
+
+  def render_completion(path, contents)
+    contents ||= read_file(path)
+    contents2 = @do_not_escape ? contents : JekyllTagHelper.escape_html(contents)
+    @pre ? wrap_in_pre(path, contents2) : contents2
+  end
+
+  def run(cmd)
+    @logger.debug { "Executing filename=#{cmd}" }
+    %x[#{cmd}].chomp
+  end
+
+  PREFIX = "<button class='copyBtn' data-clipboard-target="
+  SUFFIX = "title='Copy to clipboard'><img src='/assets/images/clippy.svg' alt='Copy to clipboard' style='width: 13px'></button>"
+
+  def wrap_in_pre(path, content)
+    basename = File.basename(path)
+    label_or_href = if @download
+                      label = @label_specified ? @label : basename
+                      <<~END_HREF
+                        <a href='data:text/plain;charset=UTF-8,#{basename}' download='#{basename}'
+                          title='Click on the file name to download the file'>#{label}</a>
+                      END_HREF
+                    else
+                      @label_specified ? @label : basename
+                    end
+    pre_id = "id#{SecureRandom.hex 6}"
+    copy_button = @copy_button ? "#{PREFIX}'##{pre_id}'#{SUFFIX}" : ""
+    <<~END_PRE
+      <div class="codeLabel">#{label_or_href}</div>
+      <pre data-lt-active="false" class="maxOneScreenHigh copyContainer" id="#{pre_id}">#{copy_button}#{content}</pre>
+    END_PRE
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{JekyllFlexibleIncludeName::PLUGIN_NAME} v#{JekyllFlexibleIncludePluginVersion::VERSION} plugin." }
+Liquid::Template.register_tag('flexible_include', FlexibleInclude)

data/lib/jekyll_tag_helper.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+class JekyllTagHelper
+  attr_reader :argv, :liquid_context, :logger, :params, :tag_name
+
+  def self.escape_html(string)
+    string.gsub("{", "&#123;").gsub("}", "&#125;").gsub("<", "&lt;")
+  end
+
+  # Expand environment variable references
+  def self.expand_env(str)
+    str.gsub(/\$([a-zA-Z_][a-zA-Z0-9_]*)|\${\g<1>}|%\g<1>%/) { ENV[Regexp.last_match(1)] }
+  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)
+    @tag_name = tag_name
+    @argv = Shellwords.split(markup)
+    @keys_values = KeyValueParser.new.parse(@argv) # Hash[Symbol, String|Boolean]
+    @logger = logger
+    @logger.debug { "@keys_values='#{@keys_values}'" }
+  end
+
+  def delete_parameter(name)
+    @params.delete(name)
+    @argv.delete_if { |x| x.start_with? name }
+    @keys_values.delete(name.to_sym)
+  end
+
+  # @return if parameter was specified, returns value and removes it from the available tokens
+  def parameter_specified?(name)
+    value = @keys_values[name.to_sym]
+    delete_parameter(name)
+    value
+  end
+
+  PREDEFINED_SCOPE_KEYS = [: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)
+    @liquid_context[name] || # Finds variables named like 'include.my_variable', found in @liquid_context.scopes.first
+      @page[name] || # Finds variables named like 'page.my_variable'
+      dereference_include_variable(name) ||
+      ""
+  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

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_flexible_include
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.5
 platform: ruby
 authors:
 - Mike Slinn
+- Tan Nhu
+- Maarten Brakkee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,19 +27,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jekyll_plugin_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: debase
   requirement: !ruby/object:Gem::Requirement
@@ -52,104 +54,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: jekyll
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: 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'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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'
-- !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
-  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'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  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'
 - !ruby/object:Gem::Dependency
   name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
@@ -170,34 +74,33 @@ description: |
   filenames relative to the top-level directory of the Jekyll web site,
   filenames relative to the user home directory,
   and executable filenames on the PATH.
-email: mslinn@mslinn.com
+email:
+- mslinn@mslinn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
 - ".rubocop.yml"
-- ".vscode/launch.json"
-- ".vscode/settings.json"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
 - Rakefile
-- jekyll_flexible_include.gemspec
-- lib/jekyll_flexible_include.rb
-- lib/jekyll_flexible_include/version.rb
-- sig/jekyll_flexible_include.rbs
-homepage: https://github.com/mslinn/jekyll_flexible_include_plugin
+- jekyll_flexible_include_plugin.gemspec
+- lib/flexible_include.rb
+- lib/flexible_include/version.rb
+- lib/jekyll_tag_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#flexibleInclude
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/mslinn/jekyll_flexible_include_plugin
-  source_code_uri: https://github.com/mslinn/jekyll_flexible_include_plugin
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_flexible_include_plugin/issues
   changelog_uri: https://github.com/mslinn/jekyll_flexible_include_plugin/CHANGELOG.md
-post_install_message: Thanks for installing jekyll_flexible_include!
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#flexibleInclude
+  source_code_uri: https://github.com/mslinn/jekyll_flexible_include_plugin
+post_install_message: |2+
+
+  Thanks for installing jekyll_flexible_include!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -212,9 +115,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: This Jekyll plugin supports various ways to include content into the generated
+summary: Jekyll plugin supports various ways to include content into the generated
   site.
 test_files: []

data/.editorconfig

@@ -1,39 +0,0 @@
-# This file is for unifying the coding style for different editors and IDEs
-# editorconfig.org
-
-# https://editorconfig.org/
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-tab_width = 2
-end_of_line = lf
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.{java,jsp}]
-indent_size = 4
-tab_width = 4
-insert_final_newline = false
-
-[{*.{awk,bat,c,cpp,d,h,l,mk,re,skl,w32,y},Makefile*}]
-indent_size              = 4
-indent_style             = tab
-
-[*.{dtd,html,inc,php,phpt,rng,wsdl,xml,xsd,xsl}]
-indent_size              = 4
-indent_style             = space
-
-[*.md]
-indent_style             = space
-max_line_length          = 80
-
-[COMMIT_EDITMSG]
-indent_size              = 4
-indent_style             = space
-max_line_length          = 80
-
-[*.patch]
-trim_trailing_whitespace = false

data/.vscode/launch.json

@@ -1,75 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "cwd": "${workspaceRoot}",
-      "name": "Attach rdebug-ide",
-      "request": "attach",
-      "remoteHost": "localhost",
-      "remotePort": "1234",
-      "remoteWorkspaceRoot": "/",
-      "restart": true,
-      "showDebuggerOutput": true,
-      "type": "Ruby",
-    },
-    {
-      "cwd": "${workspaceRoot}",
-      "debuggerPort": "1234",
-      "name": "Debug Jekyll",
-      "program": "/usr/local/bin/jekyll",
-                   "args": [
-                     "serve",
-                     "--livereload_port", "35721",
-                     "--force_polling",
-                     "--host", "0.0.0.0",
-                     "--port", "4001",
-                     "--future",
-                     "--incremental",
-                     "--livereload",
-                     "--drafts",
-                     "--unpublished"
-                   ],
-      "request": "launch",
-      "restart": true,
-      "showDebuggerOutput": true,
-      "stopOnEntry": true,
-      "type": "Ruby",
-    },
-    {
-      "name": "Debug Local Ruby",
-      "type": "Ruby",
-      "request": "launch",
-      "program": "${workspaceRoot}/main.rb"
-    },
-    {
-      "args": [
-        "-I",
-        "${workspaceRoot}",
-        "${file}"
-      ],
-      "cwd": "${workspaceRoot}",
-      "name": "RSpec - active spec file only",
-      "program": "/home/mslinn/.gems/bin/rspec",
-      "showDebuggerOutput": false,
-      "request": "launch",
-      "type": "Ruby",
-      "useBundler": true,
-    },
-    {
-      "args": [
-        "-I",
-        "${workspaceRoot}"
-      ],
-      "cwd": "${workspaceRoot}",
-      "name": "RSpec - all",
-      "program": "/home/mslinn/.gems/bin/rspec",
-      "request": "launch",
-      "showDebuggerOutput": false,
-      "type": "Ruby",
-      "useBundler": true,
-    }
-  ]
-}

data/.vscode/settings.json

@@ -1,4 +0,0 @@
-{
-  "ruby.rubocop.configFilePath": ".rubocop.yml",
-  "ruby.rubocop.useBundler": true
-}

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in jekyll_flexible_include.gemspec
-gemspec
-
-gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,131 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll_flexible_include (2.0.2)
-      jekyll (>= 3.5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    colorator (1.1.0)
-    concurrent-ruby (1.1.9)
-    debase (0.2.4.1)
-      debase-ruby_core_source (>= 0.10.2)
-    debase-ruby_core_source (0.10.14)
-    diff-lcs (1.5.0)
-    em-websocket (0.5.3)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0)
-    eventmachine (1.2.7)
-    ffi (1.15.5)
-    forwardable-extended (2.6.0)
-    http_parser.rb (0.8.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jekyll (3.9.1)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 2.0)
-      kramdown (>= 1.17, < 3)
-      liquid (~> 4.0)
-      mercenary (~> 0.3.3)
-      pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
-      safe_yaml (~> 1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-watch (2.2.1)
-      listen (~> 3.0)
-    kramdown (2.3.1)
-      rexml
-    liquid (4.0.3)
-    listen (3.7.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
-    method_source (1.0.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    pathutil (0.16.2)
-      forwardable-extended (~> 2.6)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rb-fsevent (0.11.1)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rouge (3.28.0)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.18.4)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-jekyll (0.12.0)
-      rubocop (~> 1.18.0)
-      rubocop-performance (~> 1.2)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
-    ruby-debug-ide (0.7.3)
-      rake (>= 0.8.1)
-    ruby-progressbar (1.11.0)
-    safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  debase
-  jekyll
-  jekyll_flexible_include!
-  pry
-  rake (~> 13.0)
-  rspec
-  rubocop
-  rubocop-jekyll
-  rubocop-rake
-  ruby-debug-ide
-
-BUNDLED WITH
-   2.3.7

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Tan Nhu, Maarten Brakkee
-Copyright (c) 2022 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/jekyll_flexible_include.gemspec

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/jekyll_flexible_include/version"
-
-Gem::Specification.new do |spec|
-  spec.name = 'jekyll_flexible_include'
-  spec.version = JekyllFlexibleIncludePlugin::VERSION
-  spec.authors = ['Mike Slinn']
-  spec.email = 'mslinn@mslinn.com'
-
-  spec.summary = "This Jekyll plugin supports various ways to include content into the generated site."
-  spec.description = <<~END_OF_DESC
-    Jekyll's built-in include tag only supports including files within the _includes folder.
-    This plugin supports 4 types of includes: absolute filenames,
-    filenames relative to the top-level directory of the Jekyll web site,
-    filenames relative to the user home directory,
-    and executable filenames on the PATH.
-  END_OF_DESC
-  spec.homepage = "https://github.com/mslinn/jekyll_flexible_include_plugin"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mslinn/jekyll_flexible_include_plugin"
-  spec.metadata["changelog_uri"] = "https://github.com/mslinn/jekyll_flexible_include_plugin/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.post_install_message = "Thanks for installing jekyll_flexible_include!"
-
-  spec.add_runtime_dependency 'jekyll', '>= 3.5.0'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'debase'
-  spec.add_development_dependency 'jekyll'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-jekyll'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'ruby-debug-ide'
-end

data/lib/jekyll_flexible_include/version.rb

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

data/lib/jekyll_flexible_include.rb

@@ -1,182 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "jekyll_flexible_include/version"
-
-module Jekyll
-  module Tags
-    class FlexibleIncludeError < StandardError
-      attr_accessor :path
-
-      def initialize(msg, path)
-        super(msg)
-        @path = path
-      end
-    end
-
-    class FlexibleInclude < Liquid::Tag
-      VALID_SYNTAX = %r!
-        ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
-      !x
-      VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
-        (?<params>.*)
-      !mx
-
-      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!
-      VALID_FILENAME_CHARS = %r!^[\w/\.-]+$!
-
-      def initialize(tag_name, markup, tokens)
-        super
-        matched = markup.strip.match(VARIABLE_SYNTAX)
-        if matched
-          @file = matched["variable"].strip
-          @params = matched["params"].strip
-        else
-          @file, @params = markup.strip.split(%r!\s+!, 2)
-        end
-        validate_params if @params
-        @tag_name = tag_name
-      end
-
-      def syntax_example
-        "{% #{@tag_name} 'file.ext' optional_param_1='value' optional_param_n='value' %}"
-      end
-
-      def parse_params(context)
-        params = {}
-        markup = @params
-
-        while (match = VALID_SYNTAX.match(markup))
-          markup = markup[match.end(0)..-1]
-
-          value = if match[2]
-                    match[2].gsub(%r!\\"!, '"')
-                  elsif match[3]
-                    match[3].gsub(%r!\\'!, "'")
-                  elsif match[4]
-                    context[match[4]]
-                  end
-
-          params[match[1]] = value
-        end
-        params
-      end
-
-      def validate_params
-        unless @params.match FULL_VALID_SYNTAX
-          raise ArgumentError, <<~MSG
-            Invalid syntax for the flexible_include tag:
-
-              #{@params}
-
-            Valid syntax:
-
-              #{syntax_example}
-
-          MSG
-        end
-      end
-
-      # See https://gist.github.com/steakknife/4606598
-      def expand_env_vars(str)
-        str.gsub(/\$([a-zA-Z_]+[a-zA-Z0-9_]*)|\$\{(.+)\}/) { ENV[Regexp.last_match(1) || egexp.last_match(2)] }
-      end
-
-      # Grab file read opts in the context
-      def file_read_opts(context)
-        context.registers[:site].file_read_opts
-      end
-
-      # Render the variable if required
-      def render_variable(context)
-        if @file.match VARIABLE_SYNTAX
-          partial = context.registers[:site]
-            .liquid_renderer
-            .file("(variable)")
-            .parse(@file)
-          partial.render!(context)
-        end
-      end
-
-      def render(context) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-        file = render_variable(context) || @file
-        # strip leading and trailing quotes, and expand environment variables
-        file = expand_env_vars(file.gsub(/\A'|'\Z/, ''))
-        path = file
-        case file
-        when %r{\A/} # Is the file absolute?
-          # puts "********** render path=#{path}, file=#{file} *************"
-        when /\A~/ # Is the file relative to user's home directory?
-          # puts "********** render original file=#{file}, path=#{path} *************"
-          file.slice! "~/"
-          path = File.join(ENV['HOME'], file)
-          # puts "********** render path=#{path}, file=#{file} *************"
-        when /\A!/ # Is the file on the PATH?
-          # puts "********** render original file=#{file}, path=#{path} *************"
-          file.slice! "!"
-          path = File.which(file)
-          Jekyll.logger.error "Flexible_include error: #{file} was not found on the PATH, output was not included" unless path
-          # puts "********** render path=#{path}, file=#{file} *************"
-        else # The file is relative
-          source = File.expand_path(context.registers[:site].config['source']) # website root directory
-          path = File.join(source, file) # Fully qualified path of include file
-          # puts "********** render file=#{file}, path=#{path}, source=#{source} *************"
-        end
-        return unless path
-
-        begin
-          escaped_contents = read_file(path, context).gsub("{", "&#123;").gsub("}", "&#125;").gsub("<", "&lt;")
-          # puts escaped_contents
-          partial = Liquid::Template.parse(escaped_contents)
-        rescue StandardError => e
-          abort "flexible_include.rb: #{e.message}"
-        end
-
-        context.stack do
-          context["include"] = parse_params(context) if @params
-          begin
-            partial.render!(context)
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def valid_include_file?(path, dir, safe)
-        !outside_site_source?(path, dir, safe) && File.file?(path)
-      end
-
-      def outside_site_source?(path, dir, safe)
-        safe && !realpath_prefixed_with?(path, dir)
-      end
-
-      def realpath_prefixed_with?(path, dir)
-        File.exist?(path) && File.realpath(path).start_with?(dir)
-      rescue StandardError
-        false
-      end
-
-      # This method allows to modify the file content by inheriting from the class.
-      def read_file(file, context)
-        File.read(file, **file_read_opts(context))
-      end
-
-      private
-
-      def could_not_locate_message(file, includes_dirs, safe)
-        message = "Could not locate the included file '#{file}' in any of "\
-                  "#{includes_dirs}. Ensure it exists in one of those directories and"
-        message + if safe
-                    " is not a symlink as those are not allowed in safe mode."
-                  else
-                    ", if it is a symlink, does not point outside your site source."
-                  end
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag("flexible_include", Jekyll::Tags::FlexibleInclude)

data/sig/jekyll_flexible_include.rbs

@@ -1,4 +0,0 @@
-module JekyllFlexibleIncludePlugin
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end