jekyll-group 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe61a07b981e56547a789bdf64a0dccaf75af2d47cc5322807fd5e9d3154cb89
+  data.tar.gz: da5833ceca1ce204de8459eaed6698f849931d63c0ba0608c51b93afe4a0c469
+SHA512:
+  metadata.gz: abe9797211068dfbc1b2e17e91c199fa5745e810a45d17935555229de4d2600832278376668a82d0c1a25698d0634c960481d87e4ee78bb6ef4f26edcb8f5920
+  data.tar.gz: 1632954755c4d589f0b88a3bbf763d09827208f5ea62f5417265003c883d0593cc3f937e7dbc1e79306db8b99ffda24fccf6c2624eb577f74fb6aa4cc93ae074

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Rob Miller <r@robm.me.uk>
+
+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/jekyll-group.gemspec

@@ -0,0 +1,18 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-group/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-group"
+  spec.summary       = "Jekyll plugin for making posts part of a wider series"
+  spec.description   = "Jekyll plugin for making posts part of a chronological series of posts that can be navigated through."
+  spec.version       = JekyllGroup::VERSION
+  spec.authors       = ["Rob Miller"]
+  spec.email         = ["r@robm.me.uk"]
+  spec.homepage      = "https://github.com/robmiller/jekyll-group"
+  spec.licenses      = ["MIT"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|spec|features)/!) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 11.0"
+end

data/lib/jekyll-group.rb

@@ -0,0 +1,3 @@
+require_relative "jekyll-group/version"
+require_relative "jekyll-group/generator"
+require_relative "jekyll-group/tag"

data/lib/jekyll-group/generator.rb

@@ -0,0 +1,41 @@
+module JekyllGroup
+  class Generator < Jekyll::Generator
+    safe true
+    priority :lowest
+
+    def generate(site)
+      @site = site
+      group_posts
+      generate_groups
+
+      @site.posts.docs.each do |post|
+        next unless post.data["group"]
+
+        group_slug = post.data["group"]
+        post.data["group"] = groups[group_slug]
+      end
+    end
+
+    private
+
+    attr_reader :groups
+    attr_reader :posts_by_group
+
+    def generate_groups
+      @groups =
+        @site.posts.docs
+          .map { |p| p.data["group"] }
+          .compact
+          .uniq
+          .map { |g| [g, { "slug" => g, "posts" => posts_by_group[g] }] }
+          .to_h
+    end
+
+    def group_posts
+      @posts_by_group =
+        @site.posts.docs
+          .select { |p| p.data["group"] }
+          .group_by { |p| p.data["group"] }
+    end
+  end
+end

data/lib/jekyll-group/tag.rb

@@ -0,0 +1,30 @@
+module JekyllGroup
+  class PostGroupTag < Liquid::Tag
+    def render(context)
+      page = context["page"]
+      group = page["group"]
+
+      return "" unless group
+
+      liquid = <<~EOL
+        <h3>Part of the {{ page.group.slug }} series</h3>
+        <ol>
+        {% for post in page.group.posts %}
+          {% if post.id == page.id %}
+            <li>{{ post.title }}</li>
+          {% else %}
+            <li><a href="{{ post.url | absolute_url }}">{{ post.title }}</a></li>
+          {% endif %}
+        {% endfor %}
+        </ol>
+      EOL
+
+      partial = Liquid::Template.parse(liquid)
+      context.stack do
+        partial.render(context)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("post_group", JekyllGroup::PostGroupTag)

data/lib/jekyll-group/version.rb

@@ -0,0 +1,3 @@
+module JekyllGroup
+  VERSION = "0.1"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-group
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Rob Miller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: Jekyll plugin for making posts part of a chronological series of posts
+  that can be navigated through.
+email:
+- r@robm.me.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- jekyll-group.gemspec
+- lib/jekyll-group.rb
+- lib/jekyll-group/generator.rb
+- lib/jekyll-group/tag.rb
+- lib/jekyll-group/version.rb
+homepage: https://github.com/robmiller/jekyll-group
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Jekyll plugin for making posts part of a wider series
+test_files: []