octopress-hooks 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3169a133f7c3a17900e54db52932fb84a202ec66
-  data.tar.gz: 104ff2a28bcce7a7bea13e51acd7b3585025bbfe
+  metadata.gz: 5e3bd95b88b25cb56b6a5bbd8f7c34fca11d523f
+  data.tar.gz: 106875c913792ed39b59775a987179d90486de30
 SHA512:
-  metadata.gz: 9985494e92eb14430704b568b60beb58fd14e5043779f76eb0ed87bac8a23abc1da593128b30514b50c7091b7aea3e0565aacb186d38371d78e58d2da1ae8884
-  data.tar.gz: e4cb99f4706e85ac8d39b0fb8da9bfb006b21c7afaf286a7e38de1bb8ff9d5c267ede3b3e1c6eeeb984fdfcc26a19a06926cd159ec6834d93111966bd76731be
+  metadata.gz: 4f268204aef608a201f1f1ee5de87bd904f35ba2874fbdc9ca84c6e392e1c5d67d3ddce2a739be6d436fee17b3032f60038b3adda6e7b4c092cf91e2a4098373
+  data.tar.gz: f055592a699b4573b0898393d4227037cb5d8c1e47f47e75d8be50c91c67c722df4146fb2c685bb5a410a4dfaaf039fd82a1dfb111984b2fec895175ff09bda0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-### 2.1.0
+### 2.2.0 - 2014-07-28
+- New: Site hook - pre_read, runs before site reads items
+- New: Site hook - post_read, runs after site reads items
+
+### 2.1.0 - 2014-07-28
 - New: Added Post hooks.
 - Change: Page hooks now only target pages.
 - New: Added post_init hooks for pages and posts which is triggered after initialization.

data/README.md

@@ -34,9 +34,15 @@ Then add a method based on when you want to trigger your hooks.
 
 The Site class has three methods. Here's an example.
 
-```
+```ruby
 class MySiteHook < Octopress::Hooks::Site
   
+  def pre_read(site)
+  end
+
+  def post_read(site)
+  end
+
   def pre_render(site)
   end
 
@@ -48,6 +54,10 @@ class MySiteHook < Octopress::Hooks::Site
 end
 ```
 
+Use the `pre_read` hook to modify the site instance before posts, pages and static files are read.
+
+Use the `pre_read` hook to modify the site instance after posts, pages and static files are read but before generators are triggered.
+
 Use the `pre_render` hook to modify the site instance before posts and pages are rendered.
 
 Use the `merge_paylod` hook to modify the site payload or merge custom data into it. This data will be available to all documents when they are rendered. This method must return a hash.
@@ -59,8 +69,8 @@ Use the `post_write` to trigger and action after all documents have been written
 The Page and Post hooks have four methods and are identical except that Post hooks only operate on posts, and Page hooks only operate on
 pages. Here's an example of a Page hook.
 
-```
-class MySiteHook < Octopress::Hooks::Page
+```ruby
+class MyPageHook < Octopress::Hooks::Page
 
   def post_init(page)
   end
@@ -99,9 +109,9 @@ module MyModule
     end
   end
 
-  MyPostHook < Octopress::Hooks::Page
-    def pre_render(post)
-      MyModule.do_awesome(post)
+  MyPageHook < Octopress::Hooks::Page
+    def pre_render(page)
+      MyModule.do_awesome(page)
     end
   end
 end
@@ -111,13 +121,16 @@ end
 
 Just to be clear, this is the order in which these hooks are triggered.
 
-1. Post/Page `post_init`
-2. Site `pre_render`
-3. Site `merge_payload`
-4. Post/Page `pre_render`
-5. Post/Page `post_render`
-6. Post/Page `post_write`
-7. Site `post_write`
+1. Site `pre_read`
+2. Site `post_read`
+3. Post/Page `post_init`
+4. Post/Page `post_init`
+5. Site `pre_render`
+6. Site `merge_payload`
+7. Post/Page `pre_render`
+8. Post/Page `post_render`
+9. Post/Page `post_write`
+10. Site `post_write`
 
 ## Contributing
 

data/lib/octopress-hooks/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Hooks
-    VERSION = "2.1.0"
+    VERSION = "2.2.0"
   end
 end

data/lib/octopress-hooks.rb

@@ -6,6 +6,18 @@ module Octopress
 
     class Site < Jekyll::Plugin
 
+      # Called before after Jekyll reads in items
+      # Returns nothing
+      #
+      def pre_read(site)
+      end
+
+      # Called right after Jekyll reads in all items, but before generators
+      # Returns nothing
+      #
+      def post_read(site)
+      end
+
       # Called before Jekyll renders posts and pages
       # Returns nothing
       # 
@@ -101,7 +113,15 @@ module Jekyll
     #
     def read
       self.load_hooks
+      self.site_hooks.each do |hook|
+        hook.pre_read(self)
+      end
+
       old_read
+
+      self.site_hooks.each do |hook|
+        hook.post_read(self)
+      end
     end
 
     # Allows site hooks to get access to the site before

data/test/.clash.yml

@@ -1,2 +1,10 @@
-build: true
-compare: _expected _site
+-
+  build: true
+  before: rm pre_read post_read
+  compare: _expected/site _site
+-
+  name: Test post_read
+  enforce_missing: _site/post_read
+  compare: _expected/post_read post_read
+  after: rm pre_read post_read
+

data/test/_expected/post_read

@@ -0,0 +1 @@
+pages: 4

data/test/_expected/site/pre_read

@@ -0,0 +1 @@
+pages: 0

data/test/_plugins/test.rb

@@ -2,6 +2,16 @@ require 'octopress-hooks'
 
 module TestingHooks
   class SiteHookTest < Octopress::Hooks::Site
+    def pre_read(site)
+      file = File.join(site.source, 'pre_read')
+      File.open(file, 'w') { |f| f.write("pages: #{site.pages.size}") }
+    end
+
+    def post_read(site)
+      file = File.join(site.source, 'post_read')
+      File.open(file, 'w') { |f| f.write("pages: #{site.pages.size}") }
+    end
+
     def pre_render(site)
       file = File.join(site.source, 'magic')
       File.open(file, 'w') { |f| f.write('MAGIC') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-hooks
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -60,13 +60,15 @@ files:
 - test/.gitignore
 - test/Gemfile
 - test/_config.yml
-- test/_expected/2014/05/21/hi-guys.html
-- test/_expected/boom
-- test/_expected/magic
-- test/_expected/merge_payload.html
-- test/_expected/post_render_page.html
-- test/_expected/post_write_page.html
-- test/_expected/pre_render_page.html
+- test/_expected/post_read
+- test/_expected/site/2014/05/21/hi-guys.html
+- test/_expected/site/boom
+- test/_expected/site/magic
+- test/_expected/site/merge_payload.html
+- test/_expected/site/post_render_page.html
+- test/_expected/site/post_write_page.html
+- test/_expected/site/pre_read
+- test/_expected/site/pre_render_page.html
 - test/_plugins/test.rb
 - test/_posts/2014-05-21-hi-guys.md
 - test/merge_payload.md