jekyll-linked-posts 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6fd76736e5b6a0ad623396a4fdcbae2ecade1d238c543d230f9838db8676d0f
-  data.tar.gz: 9574fc8c1000bdb034ec270d512b63e3d08c0c4f85239dd8a70ad68417251255
+  metadata.gz: 062cad3991af05112873e7c17f8cf892c64a8d14d657062a09375bce163e939a
+  data.tar.gz: c0ed5ea2f74e4a9820d93c1a167ce4a6b5f58d8241da7743626f5d6547eecf13
 SHA512:
-  metadata.gz: 1460920ac472f1c6507315ab62f5bb8b257bdb2e9e14bc783a662bcc9fc7b259d255b32cefcf300946f8e8900d1e54a8297e3b07622273c1e28ec60d8a6937cf
-  data.tar.gz: 1807a345bcaeaf0603bf6da6c9a7a7865cd185497a304a48923a3fb255fab72dd1c0fd2e89a9eaca0f8d1bc737a3c38a6b23b409cc91757d75959a02732e7124
+  metadata.gz: 5993651482aa7722650f42c1d91af57eb1dad1c8be5b32418055b4d7d116164ba7e1609aa46c2ba8461ec6ca33374bb2936330f906506b56d11c35bc1e87ffcb
+  data.tar.gz: ddb553827ed04c755a0851baf3311c6b2713451b11e38a6371491fef3317d7f3c7e1986ff296a24d29c1a225da5a62daca37ced79b278ae63df35f1b789cf38f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.2.0 - 2020-09-03
+
+* Breadcrumbs!
+
 ## v0.1.0 - 2020-05-20
 
 * First release!

data/README.md

@@ -3,6 +3,9 @@
 This plugin finds the actual posts on front matter fields by UUID, for
 comfortable access on Liquid templates.
 
+From v0.4.0 you don't need UUIDs and can use any field name you want
+and this plugin will link string or integer values.
+
 We use them for [translations](https://rubygems.org/gems/jekyll-locales)
 and manually provided related posts.
 
@@ -90,6 +93,40 @@ them with other fields, re-add them to the configuration.
 
 It also works between collections!
 
+## Breadcrumbs
+
+If you're linking articles by the same field, you can create
+a breadcrumb like this:
+
+```html
+{%- assign breadcrumbs = page | breadcrumbs: 'previous' -%}
+
+<nav aria-label="Breadcrumbs">
+  <ol class="breadcrumb">
+    {% for crumb in breadcrumbs %}
+      {% if forloop.last %}
+        <li class="breadcrumb-item active" aria-current="page">{{ crumb.title }}</li>
+      {% else %}
+        <li class="breadcrumb-item">
+          <a href="{{ crumb.url }}">{{ crumb.title }}</a>
+        </li>
+      {% endif %}
+    {% endfor %}
+  </ol>
+</nav>
+```
+
+## Link by any field name
+
+If you don't want to use UUIDs, you can configure this plugin to link by
+any field name as long as their values are strings or integers.
+
+Add to your `_config.yml`:
+
+```yaml
+indexed_field: title
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on 0xacab.org at
@@ -98,6 +135,9 @@ intended to be a safe, welcoming space for collaboration, and
 contributors are expected to adhere to the [Sutty code of
 conduct](https://sutty.nl/en/code-of-conduct/).
 
+If you like our plugins, [please consider
+donating](https://donaciones.sutty.nl/en/)!
+
 ## License
 
 The gem is available as free software under the terms of the GPL3

data/lib/jekyll-linked-posts.rb

@@ -1,4 +1,5 @@
 require_relative 'jekyll/linked_posts'
+require_relative 'jekyll/filters/breadcrumbs'
 
 # Process the site replacing UUIDs for posts in certain front matter fields
 Jekyll::Hooks.register :site, :post_read do |site|

data/lib/jekyll/filters/breadcrumbs.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Filters
+    module Breadcrumbs
+      # The breadcrumbs filter returns an Array of Jekyll::Documents
+      # that are linked recursively by the same field.
+      #
+      # @param [Jekyll::Document]
+      # @param [String]
+      # @return [Array]
+      def breadcrumbs(input, field)
+        return unless input.respond_to? :[]
+
+        crumbs = [ input ]
+        prev   =   input
+
+        while prev&.public_send(:[], field)
+          crumbs << (prev = prev[field])
+        end
+
+        crumbs.reverse
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Filters::Breadcrumbs)

data/lib/jekyll/linked_posts.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module Jekyll
-  # Link posts by UUIDs
+  # Link posts by a field value, ideally an UUID
   class LinkedPosts
+    # Default linked fields
     FIELDS = %w[lang related].freeze
+    # Value types allowed to index by
+    INDEXABLE_TYPES = [String, Integer].freeze
 
     attr_reader :site
 
@@ -15,58 +20,89 @@ module Jekyll
     # If it doesn't find anything it'll show a warning and replace the
     # value for nil.
     def read
-      docs.each do |doc|
+      site.documents.values.each do |doc|
         fields.each do |field|
-          next unless doc.data.key? field
+          next if (values = doc.data[field]).nil?
 
           # XXX: this lacks... elegance
           doc.data[field] =
-            case doc.data[field]
-              when String then
-                find doc.data[field]
-              when Array then
-                doc.data[field].map do |doc|
-                  find doc
-                end.compact
-              when Hash
-                doc.data[field].map do |f, uuid|
-                  [f, find(uuid)]
-                end.to_h
-              else
-                Jekyll.logger.warn "Couldn't link posts on #{doc.path}"
-                nil
-              end
+            case values
+            when String then find(values)
+            when Array
+              values.map do |doc|
+                find doc
+              end.compact
+            when Hash
+              values.map do |f, value|
+                [f, v] if (v = find value)
+              end.compact.to_h
+            else
+              Jekyll.logger.warn "Couldn't link posts on #{doc.relative_path}"
+              nil
             end
+        end
       end
     end
 
     private
 
-    # Obtain docs from the whole site
-    def docs
-      @docs ||= site.collections.map(&:last).map(&:docs).flatten
+    # The field to index posts by
+    #
+    # @return [String] by default uuid
+    def indexed_field
+      @indexed_field ||= site.config.fetch('indexed_field', 'uuid')
+    end
+
+    # Obtain docs from the whole site, indexing them by field value and
+    # warning if docs have missing field, duplicate values or invalid
+    # types.
+    #
+    # @return [Hash]
+    def indexed_documents
+      @indexed_documents ||= site.documents.reduce({}) do |docs, doc|
+        index_value = doc.data[indexed_field]
+
+        unless index_value
+          Jekyll.logger.warn "#{doc.relative_path} is missing field #{indexed_field}"
+          next docs
+        end
+
+        unless INDEXABLE_TYPES.include? index_value.class
+          Jekyll.logger.warn "#{doc.relative_path} value for #{indexed_field} is #{index_value.class.downcase} instead of string or integer"
+          next docs
+        end
+
+        if (dup = docs[index_value])
+          Jekyll.logger.warn "#{doc.relative_path} shares the same indexing value as #{dup.relative_path}: #{index_value}"
+          next docs
+        end
+
+        docs.tap do |d|
+          d[index_value] = doc
+        end
+      end
     end
 
-    # Search for UUIDs in these front matter fields.  You can add more
+    # Search for posts in these front matter fields.  You can add more
     # as an Array called 'fields' on _config.yml for the plugin
     # configuration:
     #
     # linked_fields:
     #   - related
     #   - lang
+    #
+    # @return [Array]
     def fields
       @fields ||= site.config.fetch('linked_fields', FIELDS).compact.uniq
     end
 
-    # Find a post with the given UUID
-    def find(uuid)
-      r = docs.lazy.find do |doc|
-        doc.data['uuid'] == uuid
+    # Find a post with the given value and log alert if missing.
+    #
+    # @return [Jekyll::Document,Nil]
+    def find(value)
+      indexed_documents[value].tap do |i|
+        Jekyll.logger.warn "#{value} couldn't be found" if i.nil?
       end
-
-      Jekyll.logger.warn "#{uuid} couldn't be found" if r.nil?
-
-      r
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linked-posts
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - f
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/jekyll-linked-posts.rb
+- lib/jekyll/filters/breadcrumbs.rb
 - lib/jekyll/linked_posts.rb
 homepage: https://0xacab.org/sutty/jekyll/jekyll-linked-posts
 licenses:
@@ -48,7 +49,7 @@ metadata:
   source_code_uri: https://0xacab.org/sutty/jekyll/jekyll-linked-posts
   changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-linked-posts/-/blob/master/CHANGELOG.md
   documentation_uri: https://rubydoc.info/gems/jekyll-linked-posts
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - jekyll-linked-posts - Adds linked posts to Jekyll
@@ -70,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Adds linked posts to Jekyll
 test_files: []