jekyll-linked-posts 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f93e87d40ed284d13bb31784c5b2d11684cca725444dd94d3cb9e264ce3b394
-  data.tar.gz: a2fbc7b95e5746b654ec59a32d73a30e693eb787955f3e9938b7a753c6c7661f
+  metadata.gz: 16d971d2aea65fdae7aa301bb61ed483c64c640e0606acfd7677d02f56de8147
+  data.tar.gz: 5ddf6ade823e07c478386c1c67f11dd9e3ef8bf9c9b5c0fc1972b8cb4291b8b5
 SHA512:
-  metadata.gz: d955d83efd3a820eabb360c0c2472d77ec30fd143dafb982db43c479ecb2df7aed7e9d17edf1df43155dac6fe3f0951f2b25050458902c53b986d44655dac4a9
-  data.tar.gz: 5aedb476f2dc7e2c8d66a519279ec6c9904c9273b7c196d8cfb16b1b665c1794bcc61e74d7c560b62ba72e2bfaf85a5ccd4d6d4cbb0026c922ce8d1bb0245c52
+  metadata.gz: 63fad8fd0d3aa089444acebd8280f5bc42c83ccf837e116215c096e56a9c3149b4f4cd09e8ded29131fd44d6cc5967f98be1128df9832a4ef17cb5bc2f8941a6
+  data.tar.gz: 447fbe203ca57f77e38207751ddfdc439549c512a77a67b7bc984efe6662b3b8c5382ca818d73b30fde57a6f1c4d161009f1e392d1df8ed21c099586de1fb716

data/README.md

@@ -91,6 +91,10 @@ linked_fields:
 These values are replaced by your configuration, so if you want to use
 them with other fields, re-add them to the configuration.
 
+If you're using the [Sutty CMS](https://panel.sutty.nl), this plugin
+supports Sutty's schemas, so it can link posts automatically.  No need
+for `linked_fields` in `_config.yml`.
+
 It also works between collections!
 
 ## Breadcrumbs

data/lib/jekyll/filters/breadcrumbs.rb

@@ -12,12 +12,10 @@ module Jekyll
       def breadcrumbs(input, field)
         return unless input.respond_to? :[]
 
-        crumbs = [ input ]
-        prev   =   input
+        crumbs = [input]
+        prev = input
 
-        while prev&.public_send(:[], field)
-          crumbs << (prev = prev[field])
-        end
+        crumbs << (prev = prev[field]) while prev&.public_send(:[], field)
 
         crumbs.reverse
       end

data/lib/jekyll/linked_posts.rb

@@ -8,6 +8,13 @@ module Jekyll
     # Value types allowed to index by
     INDEXABLE_TYPES = [String, Integer].freeze
 
+    # Field types that link to other documents on Sutty schemas.
+    SCHEMA_LINKED_FIELD_TYPES = %w[
+      locales related_posts
+      belongs_to has_many has_one has_and_belongs_to_many
+      new_belongs_to new_has_many new_has_one new_has_and_belongs_to_many
+    ].freeze
+
     attr_reader :site
 
     def initialize(site)
@@ -27,11 +34,34 @@ module Jekyll
 
     private
 
+    # @param message [String]
+    def warn(message)
+      Jekyll.logger.warn 'Linked:', message
+    end
+
+    # @param doc [Jekyll::Document,Jekyll::Page]
+    # @return [nil,Hash]
+    def schema_for(doc)
+      site.data.dig('schemas', doc['layout']) || site.data.dig('layouts', doc['layout'])
+    end
+
+    # @param schema [Hash]
+    # @return [Array<String>]
+    def linked_fields_for(schema)
+      schema.select do |_, value|
+        SCHEMA_LINKED_FIELD_TYPES.include? value['type']
+      end.keys
+    end
+
     # Processes fields from a document-like object
     #
     # @param :doc [Jekyll::Document,Jekyll::Page]
     # @return [nil]
     def process(doc)
+      schema = schema_for(doc)
+
+      @fields = linked_fields_for(schema) if schema
+
       fields.each do |field|
         next if (values = doc.data[field]).nil?
 
@@ -44,11 +74,11 @@ module Jekyll
               find doc
             end.compact
           when Hash
-            values.map do |f, value|
-              [f, v] if (v = find value)
-            end.compact.to_h
+            values.transform_values do |value|
+              find value
+            end.compact
           else
-            Jekyll.logger.warn "Couldn't link posts on #{doc.relative_path}"
+            warn "Couldn't link posts on #{doc.relative_path}"
             nil
           end
       end
@@ -56,6 +86,9 @@ module Jekyll
       nil
     end
 
+    # All documents and pages
+    #
+    # @return [Array]
     def indexable_documents
       @indexable_documents ||= site.documents + site.pages
     end
@@ -77,17 +110,17 @@ module Jekyll
         index_value = doc.data[indexed_field]
 
         unless index_value
-          Jekyll.logger.warn "#{doc.relative_path} is missing field #{indexed_field}"
+          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"
+          warn "#{doc.relative_path} value for #{indexed_field} is #{index_value.class} instead of #{INDEXABLE_TYPES.map(&:to_s).join(', ')}"
           next docs
         end
 
         if (dup = docs[index_value]) && dup != doc
-          Jekyll.logger.warn "#{doc.relative_path} shares the same indexing value as #{dup.relative_path}: #{index_value}"
+          warn "#{doc.relative_path} shares the same indexing value as #{dup.relative_path}: #{index_value}"
           next docs
         end
 
@@ -105,7 +138,7 @@ module Jekyll
     #   - related
     #   - lang
     #
-    # @return [Array]
+    # @return [Array<String>]
     def fields
       @fields ||= site.config.fetch('linked_fields', FIELDS).compact.uniq
     end
@@ -114,8 +147,11 @@ module Jekyll
     #
     # @return [Jekyll::Document,Nil]
     def find(value)
+      return value if value.is_a? Jekyll::Document
+      return value if value.is_a? Jekyll::Page
+
       indexed_documents[value].tap do |i|
-        Jekyll.logger.warn "#{value} couldn't be found" if i.nil?
+        warn "#{value} couldn't be found" if i.nil?
       end
     end
   end

data/lib/jekyll-linked-posts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'jekyll/linked_posts'
 require_relative 'jekyll/filters/breadcrumbs'
 

metadata

@@ -1,14 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-linked-posts
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEYDCCAsigAwIBAgIBATANBgkqhkiG9w0BAQsFADA7MQ4wDAYDVQQDDAVmYXVu
+  bzEVMBMGCgmSJomT8ixkARkWBXN1dHR5MRIwEAYKCZImiZPyLGQBGRYCbmwwHhcN
+  MjUwMTA3MTczMTQ1WhcNMjYwMTA3MTczMTQ1WjA7MQ4wDAYDVQQDDAVmYXVubzEV
+  MBMGCgmSJomT8ixkARkWBXN1dHR5MRIwEAYKCZImiZPyLGQBGRYCbmwwggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDqrFZ8PCNQbaW1incHEZp/OZTIt7bZ
+  TMKmkVLeRDqsSBGWTGdZbzRS6idn0vUKlTTnclPPG7dXw1r+AiYVdwIdjx16SLV1
+  ipbT/ezdzchfBVQHqdvExszAlL689iUnM9r22KkAXSzidSWuySjA5BY+8p1S2QO5
+  NcuB/+R5JRybVn6g500EB60jAZNUMM+2OlDqzS7oVqObOZ8zl8/HJaJnBGNNYLbN
+  cUY6qV9/0HUD2fS/eidBUGhg4jPKWHLHOZuXHPmGyE8bqdKC9T+Jbk/8KFM+SW7B
+  i4nZK4afoA6IT3KfQr5xnuyH0sUQj9M9eevWcGeGMTUv+ZiWM9zdJdyOvKhqjenX
+  G32KTR1tPgV6TK5jWyi7AHGos+2huBlKCsIJzDuw4zxs5cT9cVbkJFYHRIFQIHKq
+  gKSsTSUFt1ehfGtF/rLpv+Cm75BfZPi7OMePVE2FBaXBOvSRi0cYJkmuap9BjOut
+  OfvhZ41piDp/Kh0Cjgl1+o/fWTCh27yxb50CAwEAAaNvMG0wCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFIH0kjcsF7inzAwy488EEY5thfpiMBkGA1Ud
+  EQQSMBCBDmZhdW5vQHN1dHR5Lm5sMBkGA1UdEgQSMBCBDmZhdW5vQHN1dHR5Lm5s
+  MA0GCSqGSIb3DQEBCwUAA4IBgQCEo4E1ZAjlzw7LeJlju4BWUvKLjrbGiDNBYQir
+  lmyHhYXWV3gnozs08sM3BNzwsPwDwIhYOu3Kc+36DtEpKToUxqEGbsxX8uGzyp88
+  HTlaNsaHCZBeB2wgUYcIeO2lKdNu+V9WxfTRhYu+02OfLRv65qSfm6uck1Ml1Cg/
+  tn1Y7mLHSdnWPZCQhQZA0wX/SFL64DeozAwJLhYtKneU/m5PEqv9nNnJVCLlbODB
+  zFTjbsKtpWxNN+xWsJbjukggS8uX1400WqyjUCitDxDJknP+xeAg8wt2wT+IC1X1
+  zMY8gjxoBfwPum74cBTaZzYMpeGaS1fJ3N4NBU+SHLRDiKaVZzEnoNyJDHnsXXrX
+  MvF98+bTUHC9xcklH7RCO5uqUOq7cxIcMjzx3cpR6+AW6zXYQBjWfNB9KfaAstZy
+  cpurTQHNJfL/ah+9dYbgDXdG5HAAjRMAsWSvERw95YdN9XzQZCdUk5wUs+A6cNtO
+  AZZUMTVYNx8JqUeemxlXBRjsD/s=
+  -----END CERTIFICATE-----
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Finds linked posts using UUIDs to make them available to Liquid
 email:
 - f@sutty.nl
@@ -71,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Adds linked posts to Jekyll