octopress-hooks 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd69c98bc8337275d5b72a08567470fd2ca44ec2
-  data.tar.gz: 5feead0c6d8d1e7be2fbef7e05146bf9e66936e6
+  metadata.gz: b5489d93d6480735a17b982c3cbe72eaa2ac0158
+  data.tar.gz: 4d845ad77101c20506aa6d0f73a1ce70910d1046
 SHA512:
-  metadata.gz: 46edce7df9ba106fd554da4da903ce0e876f3badb6eee0477775dfa17fda127c0c2d8499d36920ea9e3665dc76569be9dc9ad7341d86d1a2a8ff30d105711cdf
-  data.tar.gz: 768660aec8ebb54a39df0d0ad9fd60ed2c088c9ea0652e922e39be2d37905690fc5215603a06ad8b1f02b47883a8e8f0b7c6eba1b40f6ff0ba6c127461ef0f1d
+  metadata.gz: 4b1e7f334b3976066a6050c289d4c3495bac4c7e2d28eedd2d6d0a5ff8d65df5280c5e50a27766881b3e0429e0cb631893ccace3603e092e512b780551b7a111
+  data.tar.gz: 13038c6045c7560470a228ebbe99edf46ad41d117a655bb0d15c286d2cea62eca362e5ff2613225de7f5ffde657d0e2849e5dd579e253c13583a9d7a14143ae4

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 2.5.0 - 2015-02-16
+- New: `deep_merge_payload` hook allows Posts, Pages, and Documents to have control over the way the payload is merged. (Expert level) 
+
 ### 2.4.1 - 2015-01-30
 - Fix: Collection rendering issues for no-output collection items.
 

data/README.md

@@ -20,6 +20,21 @@ Or install it yourself as:
 
     $ gem install octopress-hooks
 
+## Hook timeline
+
+This is the order in which hooks are triggered.
+
+1. Site `pre_read`
+2. Site `post_read`
+3. Post/Page/Document `post_init`
+4. Site `pre_render`
+5. Site `merge_payload`
+6. Post/Page/Document `pre_render`
+5. Post/Page/Document `merge_payload`
+7. Post/Page/Document `post_render`
+8. Post/Page/Document `post_write`
+9. Site `post_write`
+
 ## Usage
 
 First extend the appropriate Hook class.
@@ -142,21 +157,6 @@ module Samurai
 end
 ```
 
-### Hook timeline
-
-Just to be clear, this is the order in which these hooks are triggered.
-
-1. Site `pre_read`
-2. Site `post_read`
-3. Post/Page/Document `post_init`
-4. Site `pre_render`
-5. Site `merge_payload`
-6. Post/Page/Document `pre_render`
-5. Post/Page/Document `merge_payload`
-7. Post/Page/Document `post_render`
-8. Post/Page/Document `post_write`
-9. Site `post_write`
-
 ## Contributing
 
 1. Fork it ( https://github.com/octopress/hooks/fork )

data/lib/octopress-hooks.rb

@@ -63,6 +63,17 @@ module Octopress
         payload
       end
 
+      # Merges payload with original page payload
+      # Allowing merged_payload to return hash fragments, for example:
+      # merge_payload can return { awesome => true } and it will be merged
+      # into the full payload.
+      #
+      # Retuns: a payload that has been deep merged with the original page's payload
+      #
+      def deep_merge_payload(page_payload, hook_payload)
+        Jekyll::Utils.deep_merge_hashes(page_payload, hook_payload)
+      end
+
       # Called after the post is rendered with the converter.
       # Use the post object to modify it's contents before the
       # post is inserted into the template.
@@ -81,6 +92,9 @@ module Octopress
     class Post < Jekyll::Plugin
       def post_init(post); end
       def merge_payload(payload, post); payload; end
+      def deep_merge_payload(page_payload, hook_payload)
+        Jekyll::Utils.deep_merge_hashes(page_payload, hook_payload)
+      end
       def pre_render(post); end
       def post_render(post); end
       def post_write(post); end
@@ -89,6 +103,9 @@ module Octopress
     class Document < Jekyll::Plugin
       def post_init(doc); end
       def merge_payload(payload, doc); payload; end
+      def deep_merge_payload(page_payload, hook_payload)
+        Jekyll::Utils.deep_merge_hashes(page_payload, hook_payload)
+      end
       def pre_render(doc); end
       def post_render(doc); end
       def post_write(doc); end
@@ -97,6 +114,9 @@ module Octopress
     class All < Jekyll::Plugin
       def post_init(item); end
       def merge_payload(payload, item); payload; end
+      def deep_merge_payload(page_payload, hook_payload)
+        Jekyll::Utils.deep_merge_hashes(page_payload, hook_payload)
+      end
       def pre_render(item); end
       def post_render(item); end
       def post_write(item); end
@@ -175,10 +195,9 @@ module Jekyll
         payload = old_site_payload
 
         site_hooks.each do |hook|
-          p = hook.merge_payload(payload, self) || {}
-          if p != {}
-            payload = Jekyll::Utils.deep_merge_hashes(payload, p)
-          end
+          p = hook.merge_payload(payload, self)
+          next unless p && p.is_a?(Hash)
+          payload = Jekyll::Utils.deep_merge_hashes(payload, p)
         end
         payload
       end
@@ -248,9 +267,8 @@ module Jekyll
     def merge_payload(payload)
       hooks.each do |hook|
         p = hook.merge_payload(payload, self)
-        if p && p.is_a?(Hash)
-          payload = Jekyll::Utils.deep_merge_hashes(payload, p)
-        end
+        next unless p && p.is_a?(Hash)
+        payload = hook.deep_merge_payload(payload, p)
       end
       payload
     end
@@ -350,9 +368,8 @@ module Jekyll
     def merge_payload(payload)
       hooks.each do |hook|
         p = hook.merge_payload(payload, self)
-        if p && p.is_a?(Hash)
-          payload = Jekyll::Utils.deep_merge_hashes(payload, p)
-        end
+        next unless p && p.is_a?(Hash)
+        payload = hook.deep_merge_payload(payload, p)
       end
       payload
     end

data/lib/octopress-hooks/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Hooks
-    VERSION = "2.4.1"
+    VERSION = "2.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-hooks
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll