jekyll_outline 1.0.0

checksums.yaml

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

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,2 @@
+## 1.0.0 / 2022-04-02
+  * Initial version

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,77 @@
+`jekyll_outline`
+[![Gem Version](https://badge.fury.io/rb/jekyll_outline.svg)](https://badge.fury.io/rb/jekyll_outline)
+===========
+
+`jekyll_outline` Jekyll tag plugin that creates a clickable table of contents.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_outline'
+```
+
+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).
+
+
+## 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_outline 1.0.0 built to pkg/jekyll_outline-0.1.0.gem.
+jekyll_outline (1.0.0) installed.
+
+$ gem info jekyll_outline
+
+*** LOCAL GEMS ***
+
+jekyll_outline (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_outline
+    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_outline.
+
+
+## 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,48 @@
+# 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/lib/jekyll_outline/version.rb

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

data/lib/jekyll_outline.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# @author Copyright 2022 {https://www.mslinn.com Michael Slinn}
+
+require "jekyll_draft"
+require "jekyll_plugin_logger"
+require 'yaml'
+
+module Outline
+  PLUGIN_NAME = "outline"
+
+  # Interleaves with docs
+  class Header
+    attr_accessor :order, :title
+
+    def initialize(yaml)
+      @order = yaml[0]
+      @published = true
+      @title = yaml[1]
+    end
+
+    def to_s
+      <<~END_STR
+        <h3 id="title_#{order}">#{title}</h3>
+      END_STR
+    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)
+      @collection_name = argument_string.strip
+      abort "OutlineTag: collection_name was not specified" unless @collection_name
+    end
+
+    # 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">
+          #{make_entries(collection).join("\n")}
+        </div>
+      HEREDOC
+    end
+
+    private
+
+    def header?(variable)
+      variable.instance_of?(Header)
+    end
+
+    def make_headers(content)
+      yaml = YAML.safe_load content
+      yaml.map { |entry| Header.new entry }
+    end
+
+    def make_entries(collection) # rubocop:disable Metrics/MethodLength
+      sorted = collection.sort_by(&obtain_order)
+      pruned = remove_empty_headers(sorted)
+      pruned.map do |entry|
+        if entry.instance_of? Header
+          <<~END_ENTRY
+            <span></span> <span>#{entry}</span>
+          END_ENTRY
+        else
+          date = entry.data['last_modified_at'] # "%Y-%m-%d"
+          draft = Jekyll::Draft.draft_html(entry)
+          <<~END_ENTRY
+            <span>#{date}</span> <span><a href="#{entry.url}">#{entry.data['title']}</a>#{draft}</span>
+          END_ENTRY
+        end
+      end
+    end
+
+    # Ignores files called index.html
+    def obtain_docs(collection_name)
+      abort "#{@collection_name} is not a valid collection." unless @site.collections.key? @collection_name
+      @site
+        .collections[collection_name]
+        .docs
+        .reject { |doc| doc.path.end_with? "index.html" }
+    end
+
+    # Sort entries without an order property at the end
+    def obtain_order
+      proc do |entry|
+        if entry.respond_to? :data
+          entry.data.key?('order') ? entry.data['order'] : FIXNUM_MAX
+        else
+          entry.order
+        end
+      end
+    end
+
+    def remove_empty_headers(array)
+      i = 0
+      while i < array.length - 1
+        if header?(array[i]) && header?(array[i + 1])
+          array.delete_at(i)
+        else
+          i += 1
+        end
+      end
+      if header?(array.last)
+        array.delete_at(array.length - 1)
+      end
+      array
+    end
+  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/jekyll_outline_spec.rb

@@ -0,0 +1,14 @@
+# 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/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_outline"
+
+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"
+end

data/spec/status_persistence.txt

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_outline
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-05-03 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_draft
+  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: 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'
+description: 'Jekyll tag plugin that creates a clickable table of contents.
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_run.gemspec
+- lib/jekyll_outline.rb
+- lib/jekyll_outline/version.rb
+- spec/jekyll_outline_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+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_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
+  source_code_uri: https://github.com/mslinn/jekyll_outline
+post_install_message: |2+
+
+  Thanks for installing jekyll_outline!
+
+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.3.3
+signing_key:
+specification_version: 4
+summary: Jekyll tag plugin that creates a clickable table of contents.
+test_files:
+- spec/jekyll_outline_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+...