octopress-hooks 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4415c898ae72423c07d0b171d2a456f50fe55a4
-  data.tar.gz: 7f5c99bdea785555d3ef710b4bc270e6bebbb08e
+  metadata.gz: 897a94043175acc88720a482f9d7a66c8d04949a
+  data.tar.gz: a6a4aac535cb14c7eeabbdc6f27c6a4c00e09b3c
 SHA512:
-  metadata.gz: 7ac8b877dcfe57f74481dc5ecfb551cde10d2d0eba353ccb35f749fc5ef205d5e0de6a0c599b824001b94218f27d693dd04de20f364360bd8343385e9e391228
-  data.tar.gz: ec11834eb99a8168c740c85b2fe8320d01f845ef7245fc9fa50619d0819b51707ad453942ee7c79ec733c05db8610b305ee2bb36abb609d2d2c27f9ea8c6d2c9
+  metadata.gz: b100527547ec43794f052775b04a66fae671ad642f152f57e2f4562ba8ed79cf9c3b7382a799fa4bf10757a25a2f096cb80ae6de3991852320f98adffd572bdd
+  data.tar.gz: ed07cf819b9901754e151bba0edfd2bada8be13a5311c6491b05c4cbb218b8b49e37b3f203a57c6954576003e3b0b485676ff1e097b892901f3f0c16602213aa

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 2.4.0 - 2015-01-30
+- New: Pages, Posts, and Documents now have a `merge_payload` method which lets you modify the payload for each page before render.
+
 ### 2.3.2 - 2015-01-07
 - Now hooks are registered after Jekyll Site resets.
 

data/README.md

@@ -47,7 +47,10 @@ class MySiteHook < Octopress::Hooks::Site
   def pre_render(site)
   end
 
+  # Return a hash to merge into payload
+  #
   def merge_payload(payload, site)
+    {}
   end
 
   def post_write(site)
@@ -78,6 +81,12 @@ class MyPageHook < Octopress::Hooks::Page
   def pre_render(page)
   end
 
+  # Return a hash to merge into payload
+  #
+  def merge_payload(payload, page)
+    {}
+  end
+
   def post_render(page)
   end
 
@@ -91,6 +100,8 @@ modify the instance before the Site compiles its payload, which includes arrays
 
 With `pre_render` you can parse and modify page contents before it is processed by Liquid, Markdown, Textile and the like, and rendered to HTML.
 
+Use the `merge_paylod` hook to modify the page and site payload or merge custom data into it. Changes to the payload will only affect this page when it is rendered. This method must return a hash to be merged.
+
 With `post_render` you can access pages and posts after it has been converted into HTML. You might use this option if you want to modify generated HTML. At this stage, be sure to modify the `page.output` if you want change what the page displays.
 
 With `post_write` you can execute a code block after a page or post has been successfully written to disk.
@@ -99,9 +110,9 @@ To work with all page types, you'd do something like this.
 
 ```ruby
 module Toaster
-  ProcessAll < Octopress::Hooks::All
+  class ProcessAll < Octopress::Hooks::All
     def pre_render(item)
-      item.content.gsub!(/bread/, 'tost')
+      item.content.gsub!(/bread/, 'toast')
     end
   end
 end
@@ -111,19 +122,19 @@ To process pages, posts, or documents individually, you'd do this.
 
 ```ruby
 module Samurai
-  ProcessPosts < Octopress::Hooks::Post
+  class ProcessPosts < Octopress::Hooks::Post
     def pre_render(post)
       post.gsub!(/bread/, 'sliced bread')
     end
   end
 
-  ProcessPages < Octopress::Hooks::Page
+  class ProcessPages < Octopress::Hooks::Page
     def pre_render(page)
       post.gsub!(/bread/, 'sliced bread')
     end
   end
 
-  ProcessPages < Octopress::Hooks::Document
+  class ProcessPages < Octopress::Hooks::Document
     def pre_render(page)
       post.gsub!(/bread/, 'sliced bread')
     end
@@ -141,6 +152,7 @@ Just to be clear, this is the order in which these hooks are triggered.
 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`

data/lib/octopress-hooks.rb

@@ -54,6 +54,15 @@ module Octopress
       def pre_render(page)
       end
 
+      # Called right after pre_render hook. Allows you to
+      # act on the page's payload data. 
+      #
+      # Return: hash to be deep_merged into payload
+      #
+      def merge_payload(payload, page)
+        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.
@@ -71,6 +80,7 @@ module Octopress
 
     class Post < Jekyll::Plugin
       def post_init(post); end
+      def merge_payload(payload, post); payload; end
       def pre_render(post); end
       def post_render(post); end
       def post_write(post); end
@@ -78,6 +88,7 @@ module Octopress
 
     class Document < Jekyll::Plugin
       def post_init(doc); end
+      def merge_payload(payload, doc); payload; end
       def pre_render(doc); end
       def post_render(doc); end
       def post_write(doc); end
@@ -85,6 +96,7 @@ module Octopress
 
     class All < Jekyll::Plugin
       def post_init(item); end
+      def merge_payload(payload, item); payload; end
       def pre_render(item); end
       def post_render(item); end
       def post_write(item); end
@@ -159,7 +171,7 @@ module Jekyll
     #
     # Returns the patched site payload
     def site_payload
-      unless @cached_payload
+      @cached_payload = begin
         payload = old_site_payload
 
         site_hooks.each do |hook|
@@ -168,11 +180,8 @@ module Jekyll
             payload = Jekyll::Utils.deep_merge_hashes(payload, p)
           end
         end
-
-        @cached_payload = payload
+        payload
       end
-
-      @cached_payload
     end
 
     # Trigger site hooks after site has been written
@@ -236,6 +245,16 @@ module Jekyll
       end
     end
 
+    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
+      end
+      payload
+    end
+
     def post_render
       hooks.each do |hook|
         hook.post_render(self)
@@ -250,12 +269,17 @@ module Jekyll
   end
 
   class Renderer
-    alias_method :old_run, :run
+    alias_method :old_render_liquid, :render_liquid
     attr_accessor :output
 
-    def run
-      document.pre_render if document.place_in_layout?
-      old_run
+    def render_liquid(content, payload, info, path = nil)
+      document.pre_render if document.respond_to?(:pre_render) && document.hooks
+
+      if document.respond_to?(:merge_payload) && document.hooks
+        old_render_liquid(document.content, document.merge_payload(payload.dup), info)
+      else
+        old_render_liquid(document.content, payload, info)
+      end
     end
   end
 
@@ -289,7 +313,13 @@ module Jekyll
     # Returns nothing.
     def do_layout(payload, layouts)
       pre_render if respond_to?(:pre_render) && hooks
-      old_do_layout(payload, layouts)
+
+      if respond_to?(:merge_payload) && hooks
+        old_do_layout(merge_payload(payload.dup), layouts)
+      else
+        old_do_layout(payload, layouts)
+      end
+
       post_render if respond_to?(:post_render) && hooks
     end
 
@@ -313,6 +343,16 @@ module Jekyll
       end
     end
     
+    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
+      end
+      payload
+    end
+
     def pre_render
       hooks.each do |hook|
         hook.pre_render(self)

data/lib/octopress-hooks/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Hooks
-    VERSION = "2.3.2"
+    VERSION = "2.4.0"
   end
 end

metadata

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