jekyll_run 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcf2b4160579d3201e5b404e9af50a7bd06d542ebf6ede5bfcd86db0c91f0f92
+  data.tar.gz: 36f813049d6c657458edf0b4442b09e27a2cb1f93972451153fbbf33ac7e9b6d
+SHA512:
+  metadata.gz: 350c8eaebe6c995d5eb0b4931d81ddea464d2a4f39ffcb88c122c2d09f05d6710cddc5391fbdb54af61bf7cb543f3b352d02166cced1f941b33e18771c097d07
+  data.tar.gz: 0a58a6e748b477c98e662288c3336e42693f1f669a6e762381e799af6e32ed3618d1f281b38b48733cf02669fd35fbcaa3b6e717311fc1ed4644327d89722d1c

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/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 / 2022-03-16
+  * Published as a gem
+
+## 2020-10-03
+  * Initial version published at https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,79 @@
+`jekyll_run`
+[![Gem Version](https://badge.fury.io/rb/jekyll_run.svg)](https://badge.fury.io/rb/jekyll_run)
+===========
+
+`jekyll_run` Jekyll tag plugin that executes a program and returns the output from STDOUT. Because the output includes the command that was executed,
+and contains unselectable span tags,
+this plugin is intended to be embedded within a pre tag.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_run'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_run
+
+
+## Additional Information
+More information is available on
+[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Install development dependencies like this:
+```
+$ BUNDLE_WITH="development" bundle install
+```
+
+To build and install this gem onto your local machine, run:
+```shell
+$ bundle exec rake install
+jekyll_run 1.0.0 built to pkg/jekyll_run-0.1.0.gem.
+jekyll_run (1.0.0) installed.
+
+$ gem info jekyll_run
+
+*** LOCAL GEMS ***
+
+jekyll_run (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_run
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_run.
+
+
+## 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_run.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_run/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_run"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    Jekyll tag plugin that executes a program and returns the output from STDOUT.
+  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#run"
+  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_run"
+  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 tag plugin that executes a program and returns the output from STDOUT."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllRun::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_run/version.rb

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

data/lib/jekyll_run.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require "liquid"
+require_relative "jekyll_run/version"
+
+# Jekyll tag plugin that executes a program and returns the output from STDOUT.
+# Because the output includes the command that was executed,
+# and is contains unselectable span tags,
+# this plugin is intended to be embedded within a pre tag.
+# Executes a program and returns the output from STDOUT.
+class RunTag < Liquid::Tag
+  # Constructor.
+  # @param tag_name [String] is the name of the tag, which we already know.
+  # @param command_line [Hash, String, Liquid::Tag::Parser] the arguments from the web page.
+  # @param tokens [Liquid::ParseContext] tokenized command line
+  # @return [void]
+  def initialize(tag_name, command_line, tokens)
+    super
+    @command = command_line
+    @command = "" if @command.nil? || @command.empty?
+    @logger = PluginMetaLogger.instance.new_logger(self)
+  end
+
+  # Method prescribed by the Jekyll plugin lifecycle.
+  # @return [String]
+  def render(_context)
+    @logger.info "Running #{@command}"
+    output = `#{@command}`.rstrip
+    "<span class='unselectable'>$ </span>#{@command}\n<span class='unselectable'>#{output}</span>"
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded jekyll_run v#{JekyllRun::VERSION} plugin." }
+Liquid::Template.register_tag("run", RunTag)

data/spec/jekyll_run.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_run"
+
+RSpec.describe(Jekyll) do
+  include Jekyll
+
+  let(:config) { instance_double("Configuration") }
+  let(:context) {
+    context_ = instance_double("Liquid::Context")
+    context_.config = config
+    context_
+  }
+
+  it "is created properly" do
+    run_tag = RunTag.new("run", "echo asdf")
+    output = run_tag.render(context)
+    expect(output).to eq("asdf")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_run"
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_run
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+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: 'Jekyll tag plugin that executes a program and returns the output from
+  STDOUT.
+
+'
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_run.gemspec
+- lib/jekyll_run.rb
+- lib/jekyll_run/version.rb
+- spec/jekyll_run.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#run
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_run/issues
+  changelog_uri: https://github.com/mslinn/jekyll_run/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#run
+  source_code_uri: https://github.com/mslinn/jekyll_run
+post_install_message: |2+
+
+  Thanks for installing jekyll_run!
+
+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: Jekyll tag plugin that executes a program and returns the output from STDOUT.
+test_files:
+- spec/jekyll_run.rb
+- spec/spec_helper.rb