jekyll-write-and-commit-changes 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1861eb1e9821fc6eeb6b728019add0efc2594dab19d9c927702fc56c16776a6
-  data.tar.gz: 69f8e3bdd0b90a7b55b66d200b39ee9f60a413e122fd402f4566eb69342cbf7f
+  metadata.gz: 655b02a7cc7a4889eab96ca03d4f382761a18cb1f53c1f5d2e7425dffbccf4d2
+  data.tar.gz: 515baaf4b6f14889b65e7e21f346709b1b0304b11c32ef2d2e4213fee960f9f0
 SHA512:
-  metadata.gz: a3f0498280143b872d32706442c6889b3ae463674624fe28b9fbdf2c635bd7c23d9d6c5e558efe3e709409f53b4a06fbe59e48736037be12b1ee56bc230dfa84
-  data.tar.gz: 3c6da359fbb2c6b7cd793f20c8a2978222adb191e8374a3d647ac374a0d0e80f8288a4174fb084ceb9f18908e7df2f67494fac924a2638c4b84be40e3ec087b9
+  metadata.gz: 94c7196b4f10affc4f8a618587e49d43ecddf19ee60a0c13d45ac4f7253d1e1bb55ccf15e485b29144fab5811bd42927cc005d279bab451788ae576a18aa5ea9
+  data.tar.gz: 6141bfb6372ca466d4ab7620c1d9e6eaed3507d7e9dac81777e82c0714a946514df6420c835918a8b2a0fdb0f289e26ceb7250e1b6fb74a76c8c442186ea2af9

data/README.md

@@ -47,6 +47,13 @@ Jekyll::Hooks.register :site, :post_read do |site|
 end
 ```
 
+## Sutty CMS
+
+If you're using the [Sutty CMS](https://panel.sutty.nl), the plugin will
+detect the layout schemas on the `_data/layouts/` directory and extract
+the required attributes on the order they're set. This way the post will
+not change the order of the attributes.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on 0xacab.org at

data/lib/jekyll/document_writer.rb

@@ -1,25 +1,32 @@
 # frozen_string_literal: true
 
+require 'digest'
 require 'jekyll/document'
 
 module Jekyll
   module DocumentWriter
+    EXCLUDED_ATTRIBUTES = %w[slug ext date excerpt].freeze
+    SUTTY_FIELDS = %w[permalink alternate_permalinks layout uuid render_with_liquid usuaries created_at last_modified_at].freeze
+
     def self.included(base)
       base.class_eval do
         # Writes changes to the file and adds it to git staged changes
+        #
+        # @return [Bool,nil]
         def save
           return unless data.fetch('save', true)
 
-          Jekyll.logger.debug 'Writing', path
+          file_digest = Digest::SHA2.file(path).hexdigest
+          content_digest = Digest::SHA2.hexdigest(writable_content)
+
+          return if file_digest == content_digest
+
+          Jekyll.logger.debug 'Writing:', real_path
 
           file = File.open(path, File::RDWR | File::CREAT, 0o640) do |f|
             f.flock(File::LOCK_EX)
             f.rewind
-
-            f.write(sanitized_data.to_yaml)
-            f.write("---\n\n")
-            f.write(content)
-
+            f.write(writable_content)
             f.flush
             f.truncate(f.pos)
           end
@@ -29,30 +36,16 @@ module Jekyll
           file.zero?
         end
 
-        # Resolves the real path for the document
-        # @return [String]
-        def real_path
-          @real_path ||= Pathname.new(relative_path).realpath.relative_path_from(site.source).to_s
-        end
-
         # Prepares the data for dumping, by excluding some keys and
         # transforming other Documents replaced by jekyll-linked-posts.
         #
         # @return [Hash]
         def sanitized_data
-          data.reject do |k, _|
-            excluded_attributes.include? k
-          end.transform_values do |value|
+          data.slice(*attributes).transform_values do |value|
             case value
-            when Jekyll::Document
+            when Jekyll::Document, Jekyll::Convertible
               value.data['uuid']
-            when Jekyll::Convertible
-              value.data['uuid']
-            when Set
-              value.map do |v|
-                v.respond_to?(:data) ? v.data['uuid'] : v
-              end
-            when Array
+            when Array, Set
               value.map do |v|
                 v.respond_to?(:data) ? v.data['uuid'] : v
               end
@@ -66,8 +59,49 @@ module Jekyll
           end
         end
 
-        def excluded_attributes
-          @excluded_attributes ||= %w[slug ext date excerpt]
+        private
+
+        # Resolves the real path for the document
+        #
+        # @return [String]
+        def real_path
+          @real_path ||= Pathname.new(relative_path).realpath.relative_path_from(site.source).to_s
+        rescue Errno::ENOENT
+          relative_path
+        end
+
+        # @return [Array<String>]
+        def attributes
+          @attributes ||= data.keys - EXCLUDED_ATTRIBUTES
+        end
+
+        def layout?
+          layout.is_a? Hash
+        end
+
+        # @return [Hash,nil]
+        def layout
+          @layout ||= site.data.dig('layouts', data['layout'])
+        end
+
+        def fields
+          @fields ||= (layout.keys + SUTTY_FIELDS).uniq
+        end
+
+        # @return [String]
+        def writable_content
+          @writable_content ||=
+            begin
+              dumpable_data = sanitized_data
+              dumpable_data = dumpable_data.slice(*fields) if layout?
+
+              <<~CONTENT
+                #{dumpable_data.to_yaml.chomp}
+                ---
+
+                #{content.chomp}
+              CONTENT
+            end
         end
       end
     end

metadata

@@ -1,14 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-write-and-commit-changes
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - f
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2022-07-26 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-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -84,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Write changes to the repository