jekyll_block_tag_plugin_template 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73983c5ebf962b1754d17c322dc69f547ad6aaa80eb6d1412dd1a6942d4ef3d7
-  data.tar.gz: 2098a2671793bd943c53470577128e7a1074f4b512c4ce69290a1e8a1b2b238e
+  metadata.gz: e8c3464e4fc8f3e6b0004d525d310eede0e2613dfdd5ab90e573a02fdee34993
+  data.tar.gz: 5a731752a3d13dd5de7e5b2a8db4bf316a3ecf4f6d1c07bd97b02b207393eed1
 SHA512:
-  metadata.gz: fa7b2a8f807b8c640bbdd9decca7c4592648f5c44da755055b026b96e9b7389b446cc0b2e50a10b64042b4ad1ce2c87981b5aa50ba487f87e210791706e63b3b
-  data.tar.gz: e69e561eecfa9682f14b7d8adb9f409115c1b12f166e1be8060c984e50391807be4eb4ea9381a4fe002cf78481901c298e6f95392070d50999d6501eb9bbe13b
+  metadata.gz: a1c86d170b12a3c997da2254385070c1ad2ab90d4c05a90078342120e220bdba94db8e39c9ea9ffed4ca426f1b5995136460d2c27821c0288baed1fc92efcd1a
+  data.tar.gz: 1ac5a17ced6e8a6bcfdb4ccb14d313b3ca3630ceb22e5fd2155b093a4954573c6dd0c903ba508407c0eaba8afafc7f6958433ef28026e3e9ab64f56cacefa6f4

data/.rspec

@@ -1,2 +1,3 @@
 --color
---format progress
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -14,4 +14,7 @@ Layout/LineLength:
   Max: 150
 
 # Gemspec/RequireMFA:
-#   enable: false
+#   Enabled: false
+
+Jekyll/NoPutsAllowed:
+  Enabled: false

data/.vscode/launch.json

@@ -4,6 +4,14 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
+    {
+      "args": ["/tmp/jekyll_block_tag_plugin_template"],
+      "console": "externalTerminal",
+      "name": "Debug run_this_first",
+      "program": "${workspaceRoot}/bin/run_this_first",
+      "type": "Ruby",
+      "request": "launch",
+    },
     {
       "cwd": "${workspaceRoot}",
       "name": "Attach rdebug-ide",
@@ -22,6 +30,7 @@
         "${workspaceRoot}"
       ],
       "cwd": "${workspaceRoot}",
+      "see": "https://relishapp.com/rspec/rspec-core/docs/command-line",
       "name": "RSpec - all",
       "program": "${env:HOME}/.gems/bin/rspec",
       "request": "launch",
@@ -39,6 +48,7 @@
       "name": "RSpec - active spec file only",
       "program": "${env:HOME}/.gems/bin/rspec",
       "request": "launch",
+      "see": "https://relishapp.com/rspec/rspec-core/docs/command-line",
       "showDebuggerOutput": false,
       "type": "Ruby",
       "useBundler": true,

data/Gemfile.lock

@@ -1,9 +1,14 @@
 PATH
   remote: .
   specs:
-    jekyll_block_tag_plugin_template (0.1.0)
+    jekyll_block_tag_plugin_template (0.1.1)
+      git
       jekyll (>= 3.5.0)
       jekyll_plugin_logger
+      key-value-parser
+      os
+      shellwords
+      tty-prompt
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +17,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     colorator (1.1.0)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     debase (0.2.4.1)
       debase-ruby_core_source (>= 0.10.2)
     debase-ruby_core_source (0.10.14)
@@ -23,6 +28,8 @@ GEM
     eventmachine (1.2.7)
     ffi (1.15.5)
     forwardable-extended (2.6.0)
+    git (1.10.2)
+      rchardet (~> 1.8)
     http_parser.rb (0.8.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
@@ -47,7 +54,8 @@ GEM
       listen (~> 3.0)
     jekyll_plugin_logger (2.0.0)
       jekyll (>= 3.5.0)
-    kramdown (2.3.1)
+    key-value-parser (0.0.2)
+    kramdown (2.3.2)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
@@ -56,9 +64,12 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.4.0)
+    os (1.1.4)
     parallel (1.21.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
@@ -67,6 +78,7 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rchardet (1.8.0)
     regexp_parser (2.2.1)
     rexml (3.2.5)
     rouge (3.28.0)
@@ -100,9 +112,21 @@ GEM
     safe_yaml (1.0.5)
     sassc (2.4.0)
       ffi (~> 1.9)
+    shellwords (0.1.0)
     terminal-table (2.0.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
     unicode-display_width (1.8.0)
+    wisper (2.0.1)
 
 PLATFORMS
   x86_64-linux

data/PLUGIN_README.md

@@ -0,0 +1,108 @@
+`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)
+===========
+
+`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/README.md

@@ -1,110 +1,26 @@
-`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)
-===========
+# Jekyll Plugin Gem Customization
 
-**TODO After cloning this repo, run `bin/run_this_first`, after which this line will automatically be deleted.**
+The [`bin/run_this_first`](bin/run_this_first) script customizes your new Jekyll plugin gem.
+It does the following:
+  1) Renames the Jekyll template, including directories, files and contents.
+  2) Deletes itself, its tests and its test data.
+  3) Does not delete tests for the Jekyll plugin.
+  4) Deletes this README.md and renames [`PLUGIN_README.md`](PLUGIN_README.md) to `README.md`.
+  5) Initializes a new local git repository and optionally creates a public or private project on GitHub.
+  6) Provides scripts for building and testing your new Jekyll plugin gem locally.
+  7) Provides settings for Visual Studio Code, Rake, Rubocop and RSpec.
 
-`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
+The customized gem is ready to be pushed to RubyGems.org, or any other Ruby gem repository, whenever your feel ready.
 
 
 ## 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:
+  1) Clone this repo.
+  2) Run the `bin/run_this_first` script and answer the prompts.
+  3) Open the project in Visual Studio Code and explore the project:
      ```shell
-     $ bundle exec rake release
+     $ code .
      ```
-     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
+  4) You can immediately use your new Jekyll plugin in a Jekyll website.
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+## For More Information
+Please see the blog post about this {% href https://mslinn.com/blog/2022/03/28/jekyll-plugin-template-collection.html Jekyll plugin gem template %}.

data/jekyll_block_tag_plugin_template.gemspec

@@ -38,6 +38,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "jekyll", ">= 3.5.0"
   spec.add_dependency "jekyll_plugin_logger"
+  spec.add_dependency "key-value-parser"
+  spec.add_dependency "git"
+  spec.add_dependency "os"
+  spec.add_dependency "shellwords"
+  spec.add_dependency "tty-prompt"
 
   spec.add_development_dependency "debase"
   # spec.add_development_dependency "rubocop-jekyll"

data/lib/jekyll_block_tag_plugin_template/version.rb

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

data/lib/jekyll_block_tag_plugin_template.rb

@@ -1,46 +1,55 @@
 # frozen_string_literal: true
 
 require "jekyll_plugin_logger"
+require "key_value_parser"
+require "shellwords"
 require_relative "jekyll_block_tag_plugin_template/version"
 
 module JekyllPluginBlockTagTemplate
-  PLUGIN_NAME = "jekyll_block_tag_plugin_template"
+  PLUGIN_NAME = "block_tag_template"
 end
 
 # This is the module-level description.
 #
 # @example Heading for this example
 #   Describe what this example does
-#   {% my_block_template "parameter" %}
+#   {% block_tag_template "parameter" %}
 #     Hello, world!
-#   {% endmy_block_template %}
+#   {% endblock_tag_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
+# To set the log level to :debug, write an entery into _config.yml, like this:
+# plugin_loggers:
+#   MyBlock: debug
 
 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
+    # @param argument_string [String] the arguments from the tag, as a single string.
+    # @param _parse_context [Liquid::ParseContext] Liquid variables name/value pairs accessible in the calling page
+    #        See https://www.rubydoc.info/gems/liquid/Liquid/ParseContext
     # @return [void]
-    def initialize(tag_name, arguments, _tokens)
+    def initialize(tag_name, argument_string, _parse_context)
       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?
+
+      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
+      @param1 = params[:param1] # Example of obtaining the value of parameter param1
+      @param_x = params[:not_present] # The value of parameters that are present is nil, but displays as the empty string
+
+      @logger.debug do
+        <<~HEREDOC
+          tag_name = '#{tag_name}'
+          argument_string = '#{argument_string}'
+          @param1 = '#{@param1}'
+          @param_x = '#{@param_x}'
+          params =
+            #{params.map { |k, v| "#{k} = #{v}" }.join("\n  ")}
+        HEREDOC
+      end
     end
 
     # Method prescribed by the Jekyll plugin lifecycle.
@@ -62,7 +71,7 @@ module Jekyll
       # Compute the return value of this Jekyll tag
       <<~HEREDOC
         <p style="color: green; background-color: yellow; padding: 1em; border: solid thin grey;">
-          #{content}
+          #{content} #{@param1}
         </p>
       HEREDOC
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_block_tag_plugin_template
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Firstname Lastname
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,76 @@ dependencies:
     - - ">="
       - !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: 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: 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'
 - !ruby/object:Gem::Dependency
   name: debase
   requirement: !ruby/object:Gem::Requirement
@@ -83,6 +153,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- PLUGIN_README.md
 - README.md
 - Rakefile
 - jekyll_block_tag_plugin_template.gemspec