jekyll_block_tag_plugin_template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73983c5ebf962b1754d17c322dc69f547ad6aaa80eb6d1412dd1a6942d4ef3d7
+  data.tar.gz: 2098a2671793bd943c53470577128e7a1074f4b512c4ce69290a1e8a1b2b238e
+SHA512:
+  metadata.gz: fa7b2a8f807b8c640bbdd9decca7c4592648f5c44da755055b026b96e9b7389b446cc0b2e50a10b64042b4ad1ce2c87981b5aa50ba487f87e210791706e63b3b
+  data.tar.gz: e69e561eecfa9682f14b7d8adb9f409115c1b12f166e1be8060c984e50391807be4eb4ea9381a4fe002cf78481901c298e6f95392070d50999d6501eb9bbe13b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require: rubocop-jekyll
+inherit_gem:
+ rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+# Gemspec/RequireMFA:
+#   enable: false

data/.vscode/launch.json

@@ -0,0 +1,47 @@
+{
+  // 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,
+      "stopOnEntry": true,
+      "type": "Ruby",
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - all",
+      "program": "${env:HOME}/.gems/bin/rspec",
+      "request": "launch",
+      "showDebuggerOutput": false,
+      "type": "Ruby",
+      "useBundler": true,
+    },
+    {
+      "args": [
+        "-I",
+        "${workspaceRoot}",
+        "${file}"
+      ],
+      "cwd": "${workspaceRoot}",
+      "name": "RSpec - active spec file only",
+      "program": "${env:HOME}/.gems/bin/rspec",
+      "request": "launch",
+      "showDebuggerOutput": false,
+      "type": "Ruby",
+      "useBundler": true,
+    }
+  ]
+}

data/.vscode/settings.json

@@ -0,0 +1,6 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+  "ruby.rubocop.configFilePath": ".rubocop.yml",
+  "ruby.rubocop.useBundler": true,
+  "ruby.rubocop.executePath": "/home/mslinn/.rbenv/versions/3.0.0/lib/ruby/gems/3.0.0/gems/rubocop-1.18.4/exe/"
+}

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## x.y.z / YYY-MM-DD
+  * Initial version published

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll_block_tag_plugin_template.gemspec
+gemspec
+
+gem "bundler", require: false
+gem "rake", require: false
+gem "rspec", require: false
+gem "rubocop", "= 1.18.0", require: false # rubocop-jekyll requires this older version

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    jekyll_block_tag_plugin_template (0.1.0)
+      jekyll (>= 3.5.0)
+      jekyll_plugin_logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    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 (1.10.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    jekyll_plugin_logger (2.0.0)
+      jekyll (>= 3.5.0)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    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.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.7.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)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
+    ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  debase
+  jekyll_block_tag_plugin_template!
+  rake
+  rspec
+  rubocop (= 1.18.0)
+  ruby-debug-ide
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 COPYRIGHT_OWNER
+
+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,110 @@
+`jekyll_block_tag_plugin_template`
+[![Gem Version](https://badge.fury.io/rb/jekyll_block_tag_plugin_template.svg)](https://badge.fury.io/rb/jekyll_block_tag_plugin_template)
+===========
+
+**TODO After cloning this repo, run `bin/run_this_first`, after which this line will automatically be deleted.**
+
+`jekyll_block_tag_plugin_template` is a Jekyll plugin that provides a new Liquid tag called `new_tag_name` and a new tag block called `new_tag_block_name`.
+The plugin is packaged as a Ruby gem.
+
+ * A `new_tag_block_name` block tag that can do magic with its eyes closed.
+   ```
+   {% new_tag_name [arguments] %}
+   Contents of new_tag_block_name
+   {% endnew_tag_name %}
+   ```
+ * A `new_tag_name` tag that can turn on a dime and leave 15 cents change.
+   ```
+   {% new_tag_name Contents of new_tag_name tag%}
+   ```
+
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_block_tag_plugin_template'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_block_tag_plugin_template
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## 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.
+
+
+### 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
+jekyll_block_tag_plugin_template 0.1.0 built to pkg/jekyll_block_tag_plugin_template-0.1.0.gem.
+jekyll_block_tag_plugin_template (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_block_tag_plugin_template
+
+*** LOCAL GEMS ***
+
+jekyll_block_tag_plugin_template (0.1.0)
+    Author: Firstname Lastname
+    Homepage:
+    https://github.com/username/jekyll_block_tag_plugin_template
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Write a short summary, because RubyGems requires one.
+```
+
+
+### 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_block_tag_plugin_template.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_block_tag_plugin_template/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_block_tag_plugin_template"
+
+  spec.authors = ["Firstname Lastname"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    Expand on what spec.summary says.
+  END_OF_DESC
+  spec.email = ["email@email.com"]
+
+  # 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.homepage = "https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html"
+  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_block_tag_plugin_template"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "Write a short summary; RubyGems requires one."
+  spec.version = JekyllBlockTagTemplate::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+
+  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
+# rubocop:enable Metrics/BlockLength

data/lib/jekyll_block_tag_plugin_template/version.rb

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

data/lib/jekyll_block_tag_plugin_template.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require_relative "jekyll_block_tag_plugin_template/version"
+
+module JekyllPluginBlockTagTemplate
+  PLUGIN_NAME = "jekyll_block_tag_plugin_template"
+end
+
+# This is the module-level description.
+#
+# @example Heading for this example
+#   Describe what this example does
+#   {% my_block_template "parameter" %}
+#     Hello, world!
+#   {% endmy_block_template %}
+#
+# 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, pass the --verbose option, like this:
+#   bundle exec jekyll build --verbose
+#   JEKYLL_ENV=development bundle exec jekyll serve --verbose
+# To set the log level to :error, pass the --quiet option, like this:
+#   bundle exec jekyll build --quiet
+#   JEKYLL_ENV=development bundle exec jekyll serve --quiet
+
+module Jekyll
+  # This class implements the Jekyll tag functionality
+  class MyBlock < Liquid::Block
+    # Constructor.
+    # @param tag_name [String] the name of the tag, which we already know.
+    # @param text [Hash, String, Liquid::Tag::Parser] the arguments from the tag.
+    # @param _tokens [Liquid::ParseContext] parsed and tokenized command line
+    # @return [void]
+    def initialize(tag_name, arguments, _tokens)
+      super
+      @logger = PluginMetaLogger.instance.new_logger(self)
+      @logger.debug <<~HEREDOC
+        tag_name [#{tag_name.class}] = "#{tag_name}" [#{tag_name.class}]
+        arguments [#{arguments.class}] = "#{arguments}"
+      HEREDOC
+      @arguments = arguments
+      @arguments = "" if @arguments.nil? || @arguments.empty?
+    end
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @return [String]
+    def render(context)
+      content = super # This underdocumented assignment returns the text within the block.
+
+      @site = context.registers[:site]
+      @config = @site.config
+      @mode = @config["env"]["JEKYLL_ENV"]
+      @page = context.registers[:page]
+
+      @logger.debug <<~HEREDOC
+        mode="#{@mode}"
+        page.path="#{@page.path}"
+        page.url="#{@page.url}"
+      HEREDOC
+
+      # Compute the return value of this Jekyll tag
+      <<~HEREDOC
+        <p style="color: green; background-color: yellow; padding: 1em; border: solid thin grey;">
+          #{content}
+        </p>
+      HEREDOC
+    end
+
+    private # Your private methods go here
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{JekyllPluginBlockTagTemplate::PLUGIN_NAME} v#{JekyllBlockTagTemplate::VERSION} plugin." }
+Liquid::Template.register_tag(JekyllPluginBlockTagTemplate::PLUGIN_NAME, Jekyll::MyBlock)

data/sig/jekyll_block_tag_plugin_template.rbs

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

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_block_tag_plugin_template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Firstname Lastname
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-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: debase
+  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
+    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: 'Expand on what spec.summary says.
+
+'
+email:
+- email@email.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- ".vscode/settings.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_block_tag_plugin_template.gemspec
+- lib/jekyll_block_tag_plugin_template.rb
+- lib/jekyll_block_tag_plugin_template/version.rb
+- sig/jekyll_block_tag_plugin_template.rbs
+homepage: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_block_tag_plugin_template/issues
+  changelog_uri: https://github.com/mslinn/jekyll_block_tag_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_block_tag_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.1.4
+signing_key: 
+specification_version: 4
+summary: Write a short summary; RubyGems requires one.
+test_files: []