jekyll_outline 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4d559d814621351a2af4cb4100c83f375de62f7c66c5d21efbe60e651df1564
-  data.tar.gz: f97c2a34d62012e1b43ea6c70980747376830f72165dd254533c7a142ac2fd5f
+  metadata.gz: a9d31ca01b4964fe4a2f449ae0af3e9c62778378dbcfd2e093aea52bf5bd4cc5
+  data.tar.gz: 0c9eefb3062c192bbc31c9dc972e363c3c62ff9ad1bbe92479337cf46f0f1a75
 SHA512:
-  metadata.gz: 1c2056fc66da354151c7676d66e16f07de1ba445d45e88f665a32496587d5985e8a2dea33577d1d8f65dba2559d4bced9468166779214067f1ceb95f53625bcb
-  data.tar.gz: b923a57ea06fac9460ceb273f26fb49e441579146446b50aabbaf91dfc51cc8e6690b94a4e853fe9b4654907a9dd1d02b35757666833e51f2a6e3f89220ce0f2
+  metadata.gz: d60b91075f29d828182822dea631af65b31e436a2301ff505fb29febdf1554b8b8e0a85879c472f30a309daaa204b8869d8dcf4be38771088cf644c2399832bf
+  data.tar.gz: a0dfba650a90e1c34ba3bffaaf95cf31552a0f7a4589086f4debba869fed0fcc819438057ab201f2b78913f0feb0fb5bce965b8686d6aa2da5555ea8610609b4

data/.rubocop.yml

@@ -1,17 +1,48 @@
-require: rubocop-jekyll
-inherit_gem:
- rubocop-jekyll: .rubocop.yml
+require:
+ - rubocop-rspec
+ - rubocop-rake
 
 AllCops:
   Exclude:
-      - vendor/**/*
-      - Gemfile*
-      - '*.gemspec' # This does nothing. Why?
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
 Layout/LineLength:
   Max: 150
 
-# Gemspec/RequireMFA:
-#   enable: false
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_outline.gemspec
+  Max: 30
+
+Metrics/MethodLength:
+  Max: 30
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true

data/CHANGELOG.md

@@ -1,2 +1,8 @@
+## 1.0.2 / 2023-02-16
+  * Updated to `jekyll_plugin_support` v0.5.1
+
+## 1.0.1 / 2023-02-14
+  * Now dependent upon `jekyll_plugin_support`
+
 ## 1.0.0 / 2022-04-02
   * Initial version

data/README.md

@@ -17,19 +17,16 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install jekyll_outline
-
 
 ## Additional Information
 More information is available on
-[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+[Mike Slinn’s website](https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#outline).
 
 
 ## 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.
+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:
 ```
@@ -39,14 +36,14 @@ $ BUNDLE_WITH="development" bundle install
 To build and install this gem onto your local machine, run:
 ```shell
 $ bundle exec rake install
-jekyll_outline 1.0.0 built to pkg/jekyll_outline-0.1.0.gem.
-jekyll_outline (1.0.0) installed.
+jekyll_outline 0.1.0 built to pkg/jekyll_outline-0.1.0.gem.
+jekyll_outline (0.1.0) installed.
 
 $ gem info jekyll_outline
 
 *** LOCAL GEMS ***
 
-jekyll_outline (1.0.0)
+jekyll_outline (0.1.0)
     Author: Mike Slinn
     Homepage:
     https://github.com/mslinn/jekyll_outline
@@ -56,10 +53,27 @@ jekyll_outline (1.0.0)
     Generates Jekyll logger with colored output.
 ```
 
+
+## Test
+A test website is provided in the `demo` directory.
+ 1. Set breakpoints.
+
+ 2. Initiate a debug session from the command line:
+    ```shell
+    $ bin/attach demo
+    ```
+
+  3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdebug-ide`.
+
+  4. View the generated website at [`http://localhost:4444`](http://localhost:4444)
+
+
+## Release
 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:
+  2. Describe the changes in `CHANGELOG.md`.
+  3. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+  4. Run the following:
      ```shell
      $ bundle exec rake release
      ```

data/Rakefile

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/jekyll_outline.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/jekyll_outline/version'
+
+Gem::Specification.new do |spec|
+  github = 'https://github.com/mslinn/jekyll_outline'
+
+  spec.authors = ['Mike Slinn']
+  spec.bindir = 'exe'
+  spec.description = <<~END_OF_DESC
+    Jekyll tag plugin that creates a clickable table of contents.
+  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#outline'
+  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_outline'
+  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 creates a clickable table of contents.'
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.version = JekyllOutlineVersion::VERSION
+
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_draft', '~> 1.1.1'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.1'
+end

data/lib/jekyll_outline/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllOutlineVersion
-  VERSION = "1.0.0"
+  VERSION = '1.0.2'.freeze
 end

data/lib/jekyll_outline.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
 # @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
 
-require "jekyll_draft"
-require "jekyll_plugin_logger"
+require 'jekyll_draft'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
 require 'yaml'
+require_relative 'jekyll_outline/version'
 
 module Outline
-  PLUGIN_NAME = "outline"
+  PLUGIN_NAME = 'outline'.freeze
 
   # Interleaves with docs
   class Header
@@ -26,32 +26,16 @@ module Outline
     end
   end
 
-  # Makes outlines for Jekyll pages
-  class OutlineTag < Liquid::Block
-    FIXNUM_MAX = 2**(0.size * 8 - 2) - 1
-
-    # Called by Jekyll only once to register the tag.
-    # @param tag_name [String] is the name of the tag, which we already know.
-    # @param argument_string [String] the arguments from the web page.
-    # @param _parse_context [Liquid::ParseContext] hash that stores Liquid options.
-    #        By default it has two keys: :locale and :line_numbers, the first is a Liquid::I18n object, and the second,
-    #        a boolean parameter that determines if error messages should display the line number the error occurred.
-    #        This argument is used mostly to display localized error messages on Liquid built-in Tags and Filters.
-    #        See https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers#create-your-own-tags
-    # @return [void]
-    def initialize(tag_name, argument_string, _parse_context)
-      super
-      @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  class OutlineTag < JekyllSupport::JekyllBlock
+    include JekyllOutlineVersion
+
+    FIXNUM_MAX = (2**((0.size * 8) - 2)) - 1
+
+    def render_impl(text)
       @collection_name = argument_string.strip
-      abort "OutlineTag: collection_name was not specified" unless @collection_name
-    end
+      abort 'OutlineTag: collection_name was not specified' unless @collection_name
 
-    # Method prescribed by the Jekyll plugin lifecycle.
-    # @param liquid_context [Liquid::Context]
-    # @return [String]
-    def render(liquid_context)
       headers = make_headers(super) # Process the block content.
-      @site = liquid_context.registers[:site]
       collection = headers + obtain_docs(@collection_name)
       <<~HEREDOC
         <div class="posts">
@@ -71,7 +55,7 @@ module Outline
       yaml.map { |entry| Header.new entry }
     end
 
-    def make_entries(collection) # rubocop:disable Metrics/MethodLength
+    def make_entries(collection)
       sorted = collection.sort_by(&obtain_order)
       pruned = remove_empty_headers(sorted)
       pruned.map do |entry|
@@ -95,7 +79,7 @@ module Outline
       @site
         .collections[collection_name]
         .docs
-        .reject { |doc| doc.path.end_with? "index.html" }
+        .reject { |doc| doc.path.end_with? 'index.html' }
     end
 
     # Sort entries without an order property at the end
@@ -118,14 +102,11 @@ module Outline
           i += 1
         end
       end
-      if header?(array.last)
-        array.delete_at(array.length - 1)
-      end
+
+      array.delete_at(array.length - 1) if header?(array.last)
       array
     end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
   end
 end
-
-# PluginMetaLogger.instance.info { "Loaded #{JekyllPluginTagTemplate::PLUGIN_NAME} v#{JekyllPluginTemplateVersion::VERSION} plugin." }
-PluginMetaLogger.instance.info { "Loaded Outline plugin." }
-Liquid::Template.register_tag(Outline::PLUGIN_NAME, Outline::OutlineTag)

data/spec/outline_spec.rb

@@ -0,0 +1,13 @@
+require 'jekyll'
+require_relative '../lib/jekyll_outline'
+
+RSpec.describe(Outline) do
+  include Jekyll
+
+  it 'is created properly' do
+    pending 'This is just a placeholder'
+    run_tag = RunTag.new('run', 'echo asdf')
+    output = run_tag.render(context)
+    expect(output).to eq('asdf')
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,11 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll_outline"
+require 'jekyll'
+require_relative '../lib/jekyll_outline'
 
 RSpec.configure do |config|
   config.filter_run :focus
-  config.order = "random"
+  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.example_status_persistence_file_path = 'spec/status_persistence.txt'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_outline
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,30 +28,30 @@ dependencies:
   name: jekyll_draft
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
-  name: jekyll_plugin_logger
+  name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 description: 'Jekyll tag plugin that creates a clickable table of contents.
 
   '
@@ -66,20 +66,19 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- jekyll_run.gemspec
+- jekyll_outline.gemspec
 - lib/jekyll_outline.rb
 - lib/jekyll_outline/version.rb
-- spec/jekyll_outline_spec.rb
+- spec/outline_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#run
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#outline
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_outline/issues
   changelog_uri: https://github.com/mslinn/jekyll_outline/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#run
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#outline
   source_code_uri: https://github.com/mslinn/jekyll_outline
 post_install_message: |2+
 
@@ -104,7 +103,6 @@ signing_key:
 specification_version: 4
 summary: Jekyll tag plugin that creates a clickable table of contents.
 test_files:
-- spec/jekyll_outline_spec.rb
+- spec/outline_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
 ...

data/jekyll_run.gemspec

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/jekyll_outline/version"
-
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_outline"
-
-  spec.authors = ["Mike Slinn"]
-  spec.bindir = "exe"
-  spec.description = <<~END_OF_DESC
-    Jekyll tag plugin that creates a clickable table of contents.
-  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_outline"
-  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 creates a clickable table of contents."
-  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
-  spec.version = JekyllOutlineVersion::VERSION
-
-  spec.add_dependency "jekyll", ">= 3.5.0"
-  spec.add_dependency "jekyll_draft"
-  spec.add_dependency "jekyll_plugin_logger"
-
-#  spec.add_development_dependency "debase"
-#  spec.add_development_dependency "rubocop-jekyll"
-#  spec.add_development_dependency "rake"
-#  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/spec/jekyll_outline_spec.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll_outline"
-
-RSpec.describe(Jekyll) do
-  include Jekyll
-
-  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/status_persistence.txt

@@ -1,3 +0,0 @@
-example_id                         | status | run_time        |
----------------------------------- | ------ | --------------- |
-./spec/jekyll_outline_spec.rb[1:1] | passed | 0.00023 seconds |