jekyll-linked-posts 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 567b5bf4cd5fbc9ed6b521ed1a76d6b609ac4bdd0d5e61b01f963ffe81ec6229
-  data.tar.gz: 9fbca911800e53b4259be09b74d82c8d96e8e59c555a276b774310bf4b90cab1
+  metadata.gz: 0c792272b2c2f7fe9e8b9464f35b5743458229ecba36f3e1bed1e471418ee052
+  data.tar.gz: d863dd78fd66ff0572d29a5cda8326e92632acf33b68b5793dd62a55d1e76a17
 SHA512:
-  metadata.gz: 0d52bf528f5ad92507d44c698321e95cdfc7b1bd6506b5c618f6f4aafea9e97d2fdf76b56b0288653e4eeb1611b5541a19f22f4c776cafd78b82143d24cc46ae
-  data.tar.gz: f1ecddd44fcc19576bbc58382df7371587ab3bcd60bb4c5b3ff74fc26c0a7af48d574324714633a24f13bf5310359ea76f27780c17121d8dd11997a4dea55ef9
+  metadata.gz: ce5a1eb85f8976e80635391bd49fd5131d2f733571355cef6fc2de6e082002477f36351465adcaebfa7e40e747f2587a29b5f7e17061369f055fca3c040d3a24
+  data.tar.gz: a8a56dcff3ad0ce0d1850e0e0254e0b8bb3a809953ae825959910aa51ddc177972ee8b7e694557fc9f07002e7b0fb7f0dacdd61ef306e27b9f5c4da34d915e12

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.
 
@@ -113,6 +116,17 @@ a breadcrumb like this:
 </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

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.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.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Adds linked posts to Jekyll