nugem 0.8.0 → 0.8.3

data/templates/common/gem_scaffold/bin/attach

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# Change to parent directory of this script
+SOURCE=${BASH_SOURCE[0]}
+while [ -L "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+  SOURCE=$(readlink "$SOURCE")
+  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+cd "$DIR/.."
+
+# Requires the target project contains a script called _bin/debug.
+# See https://www.mslinn.com/blog/2022/02/21/jekyll-debugging.html
+
+if [ -z "$1" ]; then
+  echo "Error: Please provide the project directory to run the test from."
+  exit 1
+fi
+
+if [ ! -f "$1/_bin/debug" ]; then
+  echo "Error: $1/_bin/debug does not exist."
+  exit 1
+fi
+
+GIT_ROOT="$( git rev-parse --show-toplevel )"
+cd "${GIT_ROOT}"
+
+bin/build
+
+set -e
+
+cd "$1" > /dev/null || exit 1
+shift
+_bin/debug "$@"

data/templates/common/gem_scaffold/bin/build

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+NAME="$( basename -s .git "$( git remote get-url origin )" )"
+
+gem uninstall "$NAME" -aIx --user-install --force
+
+bundle exec rake install

data/templates/common/gem_scaffold/bin/console.tt

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require_relative '../lib/<%= @gem_name %>'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start

data/templates/common/gem_scaffold/bin/rake

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+
+require 'pathname'
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', Pathname.new(__dir__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/templates/common/gem_scaffold/bin/reset

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+git checkout . # restores project
+git clean -fd  # Nukes untracked files and directories

data/templates/common/gem_scaffold/bin/setup.tt

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Change to parent directory of this script
+SOURCE=${BASH_SOURCE[0]}
+while [ -L "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+  SOURCE=$(readlink "$SOURCE")
+  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+cd "$DIR/.." || exit
+
+if [[ $(which apt) ]]; then
+  if [[ ! -f /usr/lib/x86_64-linux-gnu/libyaml.so ]]; then sudo apt install libyaml-dev; fi
+fi
+
+rm -f Gemfile.lock
+if [[ -z "$( which bundle )" ]]; then gem install bundler; fi
+BUNDLE_WITH="development" bundle
+
+<%- if @jekyll -%>
+bundle binstubs jekyll         --force --path binstub
+<%- end -%>
+bundle binstubs rspec-core     --force --path binstub
+bundle binstubs rubocop        --force --path binstub
+
+# Do any other automated setup that you need to do here

data/templates/common/gem_scaffold/lib/%gem_name%/version.rb.tt

@@ -0,0 +1,3 @@
+module <%= @class_name %>
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/templates/common/gem_scaffold/lib/%gem_name%.rb.tt

@@ -0,0 +1,14 @@
+<%- if @jekyll -%>
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+
+<%- end -%>
+require_relative '<%= @gem_name %>/version'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join(__dir__, '*.rb')].each do |file|
+  require file unless file.end_with?('/<%= @gem_name %>.rb')
+end
+
+# Write the code for your gem here

data/templates/common/gem_scaffold/test/%gem_name%_test.rb.tt

@@ -0,0 +1,11 @@
+require_relative 'test_helper'
+
+class <%= @class_name %>Test < Minitest::Test
+  def test_it_is_a_module
+    assert_kind_of Module, <%= @class_name %>
+  end
+
+  def test_that_it_has_a_version_number
+    refute_nil ::<%= @class_name %>::VERSION
+  end
+end

data/templates/common/gem_scaffold/test/test_helper.rb.tt

@@ -0,0 +1,96 @@
+<%- unless @repository.private? -%>
+require 'coveralls'
+Coveralls.wear!
+<%- end -%>
+
+<%- unless @rails -%>
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require '<%= @gem_name %>'
+<%- end -%>
+
+require 'minitest/autorun'
+
+require 'minitest/reporters'
+<%- if @rails -%>
+require 'minitest/reporters/screenshot_reporter'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new,
+                          Minitest::Reporters::JUnitReporter.new,
+                          Minitest::Reporters::ScreenshotReporter.new]
+<%- else -%>
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+<%- end -%>
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+<%- if @rails -%>
+require File.expand_path('../test/dummy/config/environment.rb',  __dir__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../test/dummy/db/migrate', __dir__)]
+<%- if @mountable -%>
+ActiveRecord::Migrator.migrations_paths << File.expand_path('../db/migrate', __dir__)
+<%- end -%>
+require 'rails/test_help'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path('fixtures', __dir__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.fixtures :all
+end
+
+# default test class for unit tests
+class UnitTest < ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+end
+
+# configure webtests with capybara and poltergeist (headless)
+require 'capybara/rails'
+require 'capybara_minitest_spec'
+require 'capybara/poltergeist'
+
+CAPYBARA_WINDOW_SIZE = [1024, 768]
+
+if ENV['HEADLESS'] == 'true'
+  # headless driver configuration
+  Capybara.register_driver :poltergeist do |app|
+    poltergeist_options = { debug: false, timeout: 30, js_errors: true, window_size: CAPYBARA_WINDOW_SIZE }
+    Capybara::Poltergeist::Driver.new(app, poltergeist_options)
+  end
+  Capybara.default_driver = :poltergeist
+else
+  # chrome browser driver configuration
+  Capybara.register_driver :selenium do |app|
+    Capybara::Selenium::Driver.new(app, :browser => :chrome)
+  end
+  Capybara.default_driver = :selenium
+  Capybara.current_session.driver.browser.manage.window.resize_to CAPYBARA_WINDOW_SIZE[0], CAPYBARA_WINDOW_SIZE[1]
+end
+Capybara.default_max_wait_time = 5   # how long should capybara wait for elements to appear on the page (ajax)
+
+# use database_cleaner to clean the database after every test with truncation, instead of using transactional fixtures
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation
+
+# default test class for webtests
+class WebTest < ActionDispatch::IntegrationTest
+  include Capybara::DSL
+  extend Minitest::Spec::DSL
+  include Minitest::Reporters::Screenshot
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # disable transactional fixtures, as we use DatabaseCleaner
+  self.use_transactional_fixtures = false
+
+  # clean database after each test with database_cleaner
+  def after_teardown
+    super
+    DatabaseCleaner.clean
+  end
+end
+<%- end -%>

data/templates/jekyll/block_no_arg_scaffold/lib/%block_name%.rb.tt

@@ -0,0 +1,23 @@
+require 'jekyll_plugin_support'
+require_relative '<%= @gem_name %>/version.rb'
+
+module <%= @class_name %>
+  PLUGIN_NAME = '<%= @block_name %>'.freeze unless defined? PLUGIN_NAME
+
+  # This class implements the Jekyll block tag functionality
+  class <%= @jekyll_class_name %> < JekyllBlock
+    VERSION = <%= @class_name %>::VERSION
+
+    def initialize(tag_name, argument_string, parse_context)
+      class << self
+        include NoArgParsing
+      end
+
+      super
+      @logger.debug { "#{self.class}: respond_to?(:o_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 2
+    end
+  end
+end

data/templates/jekyll/block_scaffold/lib/%block_name%.rb.tt

@@ -0,0 +1,50 @@
+require 'jekyll_plugin_support'
+require_relative '<%= @gem_name %>/version.rb'
+
+# This Jekyll block tag plugin is a minimal example.
+#
+# See https://www.mslinn.com/jekyll/10200-jekyll-plugin-background.html
+# See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
+#
+# @example Heading for this example
+#   Describe what this example does
+#   {% my_block_tag param1="value1" %}
+#     Hello, world!
+#   {% endmy_block_tag %}
+#
+# 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, write an entery into _config.yml, like this:
+# plugin_loggers:
+#   MyBlockTag: debug
+
+module <%= @class_name %>
+  # This class implements the Jekyll block tag functionality
+  class <%= @jekyll_class_name %> < JekyllSupport::JekyllBlock
+    PLUGIN_NAME = '<%= @block_name %>'.freeze
+    VERSION = <%= @class_name %>::VERSION
+
+    # Put your plugin logic here.
+    # The following variables are predefined:
+    #   @argument_string, @block_name, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site and @theme
+    #
+    # @return [String]
+    def render_impl(content)
+      <%= parse_jekyll_parameters %>
+
+      # Compute the return value of this Jekyll tag
+      <<~HEREDOC
+        <pre class="example">
+          content = '#{content}'
+          <%= dump_jekyll_parameters %>
+          Remaining markup: '#{@helper.remaining_markup}'.
+        </pre>
+      HEREDOC
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 3
+    end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/templates/jekyll/common_scaffold/spec/%gem_name%_spec.rb.tt

@@ -0,0 +1,13 @@
+require_relative '../lib/<%= @gem_name %>'
+
+RSpec.describe <%= @class_name %>::<%= @class_name %> do
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/templates/jekyll/common_scaffold/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/<%= @gem_name %>'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+
+  config.filter_run_when_matching focus: true
+end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load_file(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

data/templates/jekyll/demo/demo/Gemfile.tt

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# gem 'ffi'
+gem 'jekyll', '>= 4.3.2'
+# gem 'nokogumbo', '=2.0.3'
+# gem 'ptools'
+
+group :jekyll_plugins do
+  gem '<%= @gem_name %>', path: '../'  # use unreleased gem dependencies defined in the parent project
+  gem 'classifier-reborn'
+  gem 'html-proofer'
+  gem 'jekyll-assets', git: 'https://github.com/envygeeks/jekyll-assets'
+  gem 'jekyll-environment-variables'
+  gem 'jekyll-tagging'
+end
+
+group :test, :development do
+  gem 'debug', '>= 1.0.0', require: false
+  gem 'rspec-core', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+end

data/templates/jekyll/demo/demo/_bin/debug

@@ -0,0 +1,71 @@
+#!/bin/bash
+
+# shellcheck disable=SC2086,SC2155,SC2059
+
+function help {
+  echo "
+$(basename $0) - Run the demo Jekyll website.
+By default the demo Jekyll website runs without restriction under `debug`,
+and listens on 0.0.0.0:1234.
+Options:
+  -h  Show this error message
+  -r  Run freely, without a debugger
+"
+  exit 1
+}
+
+
+unset RUN_FREE
+while getopts "hr" OPT; do
+  case "$OPT" in
+    h) help ;;
+
+    r) export RUN_FREE=true
+       echo "The RUN_FREE option was specified (without a debugger)."
+       ;;
+
+    *) help ;;
+  esac
+done
+shift $((OPTIND-1))
+
+
+# Change to parent directory of this script
+SOURCE=${BASH_SOURCE[0]}
+while [ -L "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+  DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+  SOURCE=$(readlink "$SOURCE")
+  [[ $SOURCE != /* ]] && SOURCE=$DIR/$SOURCE # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+DIR=$( cd -P "$( dirname "$SOURCE" )" >/dev/null 2>&1 && pwd )
+cd "$DIR/.."
+
+# dispatcher-port and dispatcher-port are arbitrarily chosen to prevent conflicts with other instances.
+
+run="serve \
+    --livereload_port 25721 \
+    --force_polling \
+    --host 0.0.0.0 \
+    --port 4444 \
+    --future \
+    --incremental \
+    --livereload \
+    --drafts \
+    --unpublished"
+
+../bin/setup
+
+rm -f Gemfile.lock
+bundle
+bundle exec ../binstub/jekyll clean # Ensure all hooks get called
+
+if [ "$RUN_FREE" ]; then
+  bundle exec ../binstub/jekyll $run
+else
+  bundle exec ../binstub/rdebug-ide \
+    --host 0.0.0.0 \
+    --port 1234 \
+    --dispatcher-port 26162 \
+    -- \
+    ../binstub/jekyll $run
+fi

data/templates/jekyll/demo/demo/_config.yml.tt

@@ -0,0 +1,48 @@
+author: <%= @repository.user %>
+compress_html:
+  blanklines: false
+  clippings: all
+  comments: ["<!-- ", " -->"]
+  endings: all
+  ignore:
+    envs: [development]
+  profile: false
+  startings: [html, head, body]
+domain: bogus.jekylldemo.com
+email: bogus@jekylldemo.com
+exclude:  # Wildcards are not supported yet https://github.com/jekyll/jekyll-watch/pull/93
+  - .git
+  - .github
+  - .gitignore
+  - .jekyll-cache
+  - .jekyll-metadata
+  - .ruby-version
+  - .vscode
+  - BingSiteAuth.xml
+  - Gemfile
+  - Gemfile.lock
+  - README.md
+ignore_theme_config: true
+liquid:
+  error_mode: strict
+  # strict_filters: true
+  # strict_variables: true
+plugin_loggers:
+  PluginMetaLogger: info
+  CleanHook: warn
+  DocumentHooks: warn
+  MyBlock: warn
+  PageHooks: warn
+  PostHooks: warn
+  SiteHooks: warn
+permalink: "/blog/:year/:month/:day/:title:output_ext"
+plugins: # Use file name of the plugin entry point, not the gem name
+  - classifier-reborn
+  - jekyll
+  - jekyll_plugin_logger
+  - html-proofer
+  - <%= @gem_name %>
+sass:
+  style: compressed
+title: <%= gem_name %> Demonstration
+url: https://bogus.jekylldemo.com

data/templates/jekyll/demo/demo/_drafts/2022/2022-05-01-test2.html

@@ -0,0 +1,15 @@
+---
+categories: [Jekyll]
+description: Just a draft test post I wrote
+date: 2022-03-28
+last_modified_at: 2022-04-12
+layout: default
+front_matter_variable: Provided in front matter
+title: Test Draft Post
+---
+<h2>Hello, World!</h2>
+
+<h3>The Future Is So Bright</h3>
+<p>
+  Plugins <b>may</b> receive variables as arguments, if they are enclosed in double curly braces.
+</p>

data/templates/jekyll/demo/demo/_includes/block_tag_template_wrapper

@@ -0,0 +1,9 @@
+{% assign include_variable = "variable set in _includes/block_tag_template_wrapper" %}
+{% block_tag_template param1='{{include_variable}}'
+                      param2='{{include.param2}}'
+                      param3='{{include.param3}}'
+                      param4='{{page.last_modified_at}}'
+                      param5='{{layout.compress}}'
+                      remainder of invocation string %}
+  Hello, world!
+{% endblock_tag_template %}

data/templates/jekyll/demo/demo/_layouts/default.html.tt

@@ -0,0 +1,67 @@
+---
+layout: compress
+---
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
+  {% capture description %}{{ page.description | default: page.title | default: page.subtitle }}{% endcapture %}
+  {% capture page.title %}{{ page.title | default: page.subtitle }}{% endcapture %}
+  {% assign nowMillis = site.time | date: '%s' %}
+  <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: nowMillis }}" type="text/css">
+
+  {% assign csses = page.css | default: layout.css %}
+  {% for css in csses %}
+    <link rel="stylesheet" href="{{css | append: '?v=' | append: nowMillis }}" type="text/css">
+  {% endfor %}
+
+  <link rel="icon" type="image/png" href="/assets/images/favicon.png">
+  <!--[if lt IE 9]>
+  <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <title>{{ page.title-override | default: page.title | default: page.subtitle }}</title>
+  {% if page.keywords %}<meta name="keywords" content="{{page.keywords}}">{% endif %}
+</head>
+<body id="body">
+  <header>
+    <div class="inner">
+      <a href="/index.html">
+        <div class="h1">{{ site.title }}</div>
+      </a>
+      {% capture Title %}{{ page.title | default: layout.title }}{% endcapture %}
+      {% capture Subtitle %}{{ page.subtitle | default: layout.subtitle }}{% endcapture %}
+      <h1 id="headerH1">{{ Title | default: Subtitle }}</h1>
+  </div>
+  </header>
+  <div id="content-wrapper">
+    <div class="inner clearfix">
+      <nav id="sidebar">
+        <ul>
+          <li><a href="/index.html">Tests</a></li>
+          <li><a href="/blog/blogsByDate.html">Blog</a></li>
+        </ul>
+      </nav>
+      <section id="main-content">
+        {{ content }}
+
+        <p class="copyright" id="copyright" xmlns:dct="http://purl.org/dc/terms/" xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#">
+          <a rel="license" style="float: left; margin-right: 1em; padding-top: 9px; padding-bottom: 2em;"
+              href="http://creativecommons.org/publicdomain/zero/1.0/">
+            <img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0" />
+          </a>
+          To the extent possible under law,
+          <a rel="dct:publisher"
+              href="https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html">
+            <span property="dct:title"><%= @repository.user_name %></span></a>
+          has waived all copyright and related or neighboring rights to
+          <span property="dct:title"><%= @gem_name %> Demonstration</span>.
+          This work is published from <span property="vcard:Country" datatype="dct:ISO3166" content="CA"
+              about="https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html">Canada</span>.
+        </p>
+      </section>
+    </div>
+  </div>
+</body>
+</html>

data/templates/jekyll/demo/demo/_posts/2022/2022-01-02-redact-test.html

@@ -0,0 +1,12 @@
+---
+categories: [Jekyll, Ruby]
+description: Another test.
+date: 2022-12-15
+last_modified_at: 2022-12-15
+layout: default
+title: Another Test
+---
+<h2>Bogus Confidential Memo</h2>
+<p>
+  Coca-Cola announced a merger with Pepsi that will happen on December 15th, 2222 for 200 trillion pounds of sugar.
+</p>