jekyll-linked-posts 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90e7a22303bc20289f133ee54a2f59a60948728a9beb56ed6a4ac163f8d3678
-  data.tar.gz: c22383603722fc768d7b02c80be83edab9032d86cc8ab86c1169f43a6255da10
+  metadata.gz: 39edda049f0e0f58c262ce78dbfdb628dcbe8a817ea09500106ee3b3997cd776
+  data.tar.gz: f8a917ff13833ab7ab122b565e3c1da5f93f8ce65fa323d7110449fc2bac6877
 SHA512:
-  metadata.gz: aaa69aa67d59681692f3b359f2884b2a3949d7a1fa5caff19e768d8daac72d1b8871ba514c2c8f9d9b975134870cc5f9fc2c798825e6976afd3dd70f19d91f0f
-  data.tar.gz: f4650ff35e5233daa11cdaa5b6a24ab8bcc13665c612274e41afaf3adffd8d8bd206bef1537f7b7c9752822ea854c2e5142bda4a3e11e4fe25a8e31d9d27cbe2
+  metadata.gz: 72367aa83c205d0e70422006e90375d6f6bb520f480950583544e19b6fffed1336578efa629e2cf352e915c094ed5b3c51ea2f4dae38e8582563ac810ae0475a
+  data.tar.gz: 0dd64960259f80cc7db62bf49668d7932aee32b9669d0c248a90bfff47dc2979f1da64a412eabf1c2da06e006607e47d835a7bfd802b1e68a51c52b759b0e14c

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,9 +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
 
@@ -19,22 +22,22 @@ module Jekyll
     def read
       indexed_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])
+            case values
+            when String then find(values)
             when Array
-              doc.data[field].map do |doc|
+              values.map do |doc|
                 find doc
               end.compact
             when Hash
-              doc.data[field].map do |f, uuid|
-                [f, find(uuid)]
-              end.to_h
+              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.path}"
+              Jekyll.logger.warn "Couldn't link posts on #{doc.relative_path}"
               nil
             end
         end
@@ -43,18 +46,44 @@ module Jekyll
 
     private
 
-    # Obtain docs from the whole site, indexing them by uuid
+    # 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[doc.data['uuid']] = doc
+          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:
     #
@@ -67,12 +96,12 @@ module Jekyll
       @fields ||= site.config.fetch('linked_fields', FIELDS).compact.uniq
     end
 
-    # Find a post with the given UUID and log alert if missing.
+    # Find a post with the given value and log alert if missing.
     #
     # @return [Jekyll::Document,Nil]
-    def find(uuid)
-      indexed_documents[uuid].tap do |i|
-        Jekyll.logger.warn "#{uuid} couldn't be found" if i.nil?
+    def find(value)
+      indexed_documents[value].tap do |i|
+        Jekyll.logger.warn "#{value} couldn't be found" if i.nil?
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linked-posts
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll