jekyll_plugin_template 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 589cb215e8458e084b40967bd4b4360c457bb65a3fd01c9830af52a17d5c3bab
+  data.tar.gz: 323ea35b37a006144ccb10227bff0f49a048a098670f79ee51dda4df4787fb4b
+SHA512:
+  metadata.gz: 3d0850c46f853f9925e99e92f423e1918303f4ae253b5f45bad8711e614d3cfc76824b7f369d0d6b7a82282440647fd1a9c6d4d5ac66b3605f56ca2d4f62cf41
+  data.tar.gz: 59fdefd6d4baff1526db8065f2691b01c86a0d889d3aaed5f81ff75adb2ea83da5982b23198fa90a3e167815ff8285d8879841078ebac374ae673cc30f8fba37

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# require: rubocop-jekyll
+# inherit_gem:
+#  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+# Gemspec/RequireMFA:
+#   Enabled: false
+
+# Jekyll/NoPutsAllowed:
+#   Enabled: false
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.3 / 2022-04-15
+  * Renamed `lib/jekyll_tag_plugins.rb` to  `lib/jekyll_block_tag_plugin.rb`
+  * Added `lib/jekyll_tag_plugin.rb`
+## 0.1.2 / 2022-04-05
+  * Initial version published
+  * `bin/run_this_first` is unfinished but plugins work

data/LICENSE.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

data/PLUGIN_README.md

@@ -0,0 +1,178 @@
+`jekyll_plugin_template`
+[![Gem Version](https://badge.fury.io/rb/jekyll_plugin_template.svg)](https://badge.fury.io/rb/jekyll_plugin_template)
+===========
+
+`jekyll_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%}
+   ```
+
+
+## Demo
+The `demo` directory contains a small Jekyll website pre-configured for instant gratification.
+Run the demo by typing:
+```shell
+$ bin/attach demo
+```
+
+The `bin/attach` script builds the plugin locally and installs it locally,
+then launches the demo Jekyll website under control of the Ruby Fast Debugger.
+
+As described in [Debugging Jekyll Plugins with an IDE](https://www.mslinn.com/blog/2022/02/21/jekyll-debugging.html),
+attach to the process using `ruby-debug-ide` by selecting the **Run / Debug** configuration called **Attach rdebug-ide**.
+
+![Demo screen shot](demo.png)
+
+### Control Log Verbosity
+`demo/_config.yml` contains a block of YAML that looks something like:
+```yaml
+plugin_loggers:
+  PluginMetaLogger: info
+  CleanHook: info
+  DocumentHooks: info
+  MyBlock: info
+  PageHooks: info
+  PostHooks: info
+  SiteHooks: warn
+```
+The above sets the verbosity for each of the loggers.
+Possible values are: `debug`, `info`, `warn` and `error`.
+
+
+## Debugging
+Run `bin/attach` and pass it the directory name of a Jekyll website that has a suitable script called `_bin/debug`.
+The `demo` subdirectory fits this description.
+```script
+$ bin/attach demo
+Successfully uninstalled jekyll_plugin_template-0.1.2
+jekyll_plugin_template 0.1.2 built to pkg/jekyll_plugin_template-0.1.2.gem.
+jekyll_plugin_template (0.1.2) installed.
+Fast Debugger (ruby-debug-ide 0.7.3, debase 0.2.4.1, file filtering is supported) listens on 0.0.0.0:1234
+```
+Now attach to the debugger process.
+This git repo includes a Visual Studio Code launcher for this purpose labeled `Attach rdebug-ide`.
+
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Installation
+This has already been done for the demo; these instructions are for incorporating the plugin(s) into other Jekyll websites.
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_plugin_template'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_plugin_template
+
+
+## Usage
+
+Given this markup in an HTML file:
+
+```
+{% block_tag_template param1="Today is a wonderful day!" %}
+Hello, world!
+{% endblock_tag_template %}
+The rendered HTML from the block tag looks like this:
+```
+
+<p style="color: green; background-color: yellow; padding: 1em; border: solid thin grey;">Hello, world! Today is a wonderful day!</p>
+
+Console output looks like this, when the plugin's log level is set to `debug`:
+```
+DEBUG MyBlock: tag_name = 'block_tag_template'
+argument_string = 'param1="Today is a wonderful day!" '
+@param1 = 'Today is a wonderful day!'
+@param_x = ''
+params =
+  param1 = Today is a wonderful day!
+  param2 =
+  param3 =
+
+DEBUG MyBlock: mode=""
+page.path="_posts/2022-03-28-jekyll-plugin-template-collection.html"
+page.url="/blog/2022/03/28/jekyll-plugin-template-collection.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.
+
+
+### 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_plugin_template 0.1.0 built to pkg/jekyll_plugin_template-0.1.0.gem.
+jekyll_plugin_template (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_plugin_template
+
+*** LOCAL GEMS ***
+
+jekyll_plugin_template (0.1.0)
+    Author: Firstname Lastname
+    Homepage:
+    https://github.com/username/jekyll_plugin_template
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Write a short summary; 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

@@ -0,0 +1,105 @@
+# Jekyll Plugin Gem Customization
+
+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.
+
+The customized gem is ready to be pushed to `RubyGems.org`, or any other Ruby gem repository, whenever your feel ready.
+
+
+## About Developing Jekyll Plugins and Ruby Gems
+  * [Setting Up a Ruby Development Environment](https://www.mslinn.com/blog/2022/02/12/ruby-setup.html)
+  * [Working with Jekyll Plugins as Ruby Gems](https://www.mslinn.com/blog/2022/02/13/jekyll-gem.html)
+  * [Making a Jekyll Plugin as a Ruby Gem](https://www.mslinn.com/blog/2022/02/13/jekyll-gem2.html)
+  * [Debugging Jekyll Plugins with an IDE](https://www.mslinn.com/blog/2022/02/21/jekyll-debugging.html)
+  * [Installing Rubocop As a Development Dependency](https://www.mslinn.com/blog/2022/03/06/rubocop-install.html)
+  * [Jekyll Plugin Template Collection](https://www.mslinn.com/blog/2022/03/28/jekyll-plugin-template-collection.html)
+
+
+## Usage
+  1) Clone this repo into a directory called `my_plugin`, or whatever you want to call your plugin.
+     ```shell
+     $ git clone https://github.com/mslinn/jekyll_plugin_template.git my_plugin
+     ```
+     Or, if you have forked the project, replace `mslinn` below with your GitHub user id:
+     ```shell
+     $ git clone git@github.com:mslinn/jekyll_plugin_template.git my_plugin
+     ```
+  2) Change directory to the new plugin project:
+     ```shell
+     $ cd my_plugin
+     ```
+  3) Run the customization script and answer the prompts.
+     ```shell
+     $ bin/run_this_first
+     ```
+  4) Open the project in Visual Studio Code and explore the project:
+     ```shell
+     $ code .
+     ```
+  5) Build the plugins provided with this template.
+     ```shell
+     $ rake install:local
+     ```
+  6) You can now use your new Jekyll plugins in a Jekyll website.
+
+     a) Add the following to your Jekyll website's `Gemfile`.
+        The installation script had you rename the plugin template from `jekyll_plugin_template` to a name of your choosing.
+        Use that name instead below:
+        ```ruby
+        group :jekyll_plugins do
+          gem 'jekyll_plugin_template'
+        end
+        ```
+     b) Add the following you your Jekyll website's `_config.yml` to set log levels for each type of plugin from the template.
+        Customize the log levels as desired:
+        ```yaml
+        plugin_loggers:
+          CleanHook: info
+          DocumentHooks: warn
+          MyBlock: info
+          PageHooks: warn
+          PostHooks: warn
+          PluginMetaLogger: info
+          SiteHooks: info
+        ```
+  7) Delete the portions of the template that you do not need.
+  8) [Debug the Jekyll plugin](https://www.mslinn.com/blog/2022/02/21/jekyll-debugging.html) if required.
+  8) [Publish the gem](https://www.mslinn.com/blog/2022/02/13/jekyll-gem2.html#publish) when ready:
+     ```shell
+     $ bundle exec rake release
+     ```
+
+
+## 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 %}.
+
+
+## Hook Call Order
+The Jekyll documentation does not indicate the exact order that each of the 45 hooks gets called.
+However, the log output from this template makes that clear.
+Following is elided output; I removed duplicate log entries.
+All loggers were set to level `info`.
+Output will vary, depending on the Jekyll site that is processed and the log levels you set.
+`:post_init`, in particular, gets called many times.
+```
+INFO Module: Jekyll::Hooks.register(:site, :after_reset) invoked.
+INFO Module: Jekyll::Hooks.register(:pages, :post_init) invoked.
+INFO Module: Jekyll::Hooks.register(:documents, :post_init) invoked.
+INFO Module: Jekyll::Hooks.register(:posts, :post_init) invoked.
+INFO Module: Jekyll::Hooks.register(:site, :post_read) invoked.
+INFO Module: Jekyll::Hooks.register(:pages, :post_init) invoked.
+INFO Module: Jekyll::Hooks.register(:site, :pre_render) invoked.
+INFO Module: Jekyll::Hooks.register(:pages, :pre_render) invoked.
+INFO Module: Jekyll::Hooks.register(:pages, :post_convert) invoked.
+INFO Module: Jekyll::Hooks.register(:pages, :post_render) invoked.
+INFO Module: Jekyll::Hooks.register(:site, :post_render) invoked.
+INFO Module: Jekyll::Hooks.register(:clean, :on_obsolete) invoked for [].
+INFO Module: Jekyll::Hooks.register(:pages, :post_write) invoked.
+```

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_template.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_plugin_template/version"
+
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_plugin_template"
+
+  spec.authors = ["Firstname Lastname"]
+  spec.bindir = "bin"
+  spec.description = <<~END_OF_DESC
+    Expand on what spec.summary says.
+  END_OF_DESC
+  spec.email = ["email@email.com"]
+  spec.executables = []
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
+
+  spec.homepage = "https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html"
+  spec.license = "CC0-1.0"
+  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_template"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "Write a short summary; RubyGems requires one."
+  spec.version = JekyllPluginTemplateVersion::VERSION
+
+  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 "nokogiri"
+  spec.add_dependency "os"
+  spec.add_dependency "shellwords"
+  spec.add_dependency "talk_like_a_pirate", ">= 0.2.2"
+  spec.add_dependency "tty-prompt"
+
+  # spec.add_development_dependency "debase"
+  # spec.add_development_dependency "ruby-debug-ide"
+end

data/lib/category_combiner.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Testing...
+module CategoryCombiner
+  # For each catagory, makes a combined page from the collection pages, saves into _site/combined/#{collection.label}.html.
+  def combine
+    proc do |site, _payload|
+      site.collections.each do |_name, collection|
+        collection_page = Jekyll::PageWithoutAFile.new(site, site.source, "combined", "#{collection.label}.html")
+        collection_page.output = collection.docs.map(&:content).join("\f")
+        site.pages << collection_page
+      end
+    end
+  end
+
+  module_function :combine
+
+  Jekyll::Hooks.register(:site, :post_render, &combine)
+
+  PluginMetaLogger.instance.logger.info { "Loaded CategoryCombiner v#{JekyllPluginTemplateVersion::VERSION} plugin." }
+end

data/lib/category_index_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Inspired by the badly broken example on https://jekyllrb.com/docs/plugins/generators/, and completely redone so it works.
+module CategoryIndexGenerator
+  # Creates an index page for each catagory, plus a main index, all within a directory called _site/categories.
+  class CategoryGenerator < Jekyll::Generator
+    safe true
+
+    # Only generates content in development mode
+    # rubocop:disable Style/StringConcatenation, Metrics/AbcSize
+    def generate(site)
+      # This plugin is disabled unless _config.yml contains an entry for category_generator_enable and the value is not false
+      return if site.config['category_generator_enable']
+
+      return if site.config['env']['JEKYLL_ENV'] == "production"
+
+      index = Jekyll::PageWithoutAFile.new(site, site.source, 'categories', "index.html")
+      index.data['layout'] = "default"
+      index.data['title'] = "Post Categories"
+      index.content = "<p>"
+
+      site.categories.each do |category, posts|
+        new_page = Jekyll::PageWithoutAFile.new(site, site.source, 'categories', "#{category}.html")
+        new_page.data['layout'] = "default"
+        new_page.data['title'] = "Category #{category} Posts"
+        new_page.content = "<p>" + posts.map do |post|
+          "<a href='#{post.url}'>#{post.data['title']}</a><br>"
+        end.join("\n") + "</p>\n"
+        site.pages << new_page
+        index.content += "<a href='#{category}.html'>#{category}</a><br>\n"
+      end
+      index.content += "</p>"
+      site.pages << index
+    end
+    # rubocop:enable Style/StringConcatenation, Metrics/AbcSize
+  end
+
+  PluginMetaLogger.instance.logger.info { "Loaded CategoryGenerator v#{JekyllPluginTemplateVersion::VERSION} plugin." }
+end