octopress-hooks 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0d0774f7625cae78e384fc8004ca3640dfcf4d8
-  data.tar.gz: f63912d9b875e753fffe029c1327f86b9dbc8f08
+  metadata.gz: 6b16cdad0d0ab96fd3be82495163c0016bc2ba0a
+  data.tar.gz: c68895b002b5994f26850aac35683a9851cc32c4
 SHA512:
-  metadata.gz: bbf2b44e45b52911125489f25773c5a8867e3834d0d099c069967190ea748d08ada056523ab4f64ebe03785fec0c844dae31cd7aa63848705f7ffd821cb2d755
-  data.tar.gz: 8e05d286d5a2d3509ca8f1c2918f3d19c372dea71c0dc641a92e3cb0a06db15d0dc4474f9d9c70f91c0b6f116ad1ebfb9f9ccc5a51af8715126d8d568d49ee3e
+  metadata.gz: 2b973e48ff39db131289d97f828be2c3002bd78af0c086ce1cb749c07d0f2c21ad80bc70b5c7904a6662a7da2e65e518270db9c11e4b28c9efcebc8af7cf5703
+  data.tar.gz: 5b91e5e25c04fa8d5adc97483dad2a3166eacd432cf8a874e034f84601d8384268e7da27f416e493635bc7da51665f13b96d081edfcae5839bee39ab79474827

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 
-### 2.2.3 - 2014-12-19
+### 2.3.0 - 2015-01-05
+- Added hooks to collection documents
+- Added New All hook which hooks posts, pages and collection pages.
 
+### 2.2.3 - 2014-12-19
 - Readme updates
 
 ### 2.2.2 - 2014-10-12

data/README.md

@@ -27,6 +27,7 @@ First extend the appropriate Hook class.
 - `Octopress::Hooks::Site` - access Jekyll's Site instance.
 - `Octopress::Hooks::Page` - access to each of Jekyll's Page instances.
 - `Octopress::Hooks::Post` - access to each of Jekyll's Post instances.
+- `Octopress::Hooks::Document` - access to each of Jekyll's Collection Documents instances.
 
 Then add a method based on when you want to trigger your hooks.
 
@@ -64,10 +65,9 @@ Use the `merge_paylod` hook to modify the site payload or merge custom data into
 
 Use the `post_write` to trigger and action after all documents have been written to disk.
 
-#### Post/Page hooks
+#### Post/Page/Documents hooks
 
-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.
+The Page, Post and Document hooks have four methods and are identical except that Post hooks only operate on posts, and Page hooks only operate on pages and Document hooks only Operate on Collection Documents. Here's an example of a Page hook.
 
 ```ruby
 class MyPageHook < Octopress::Hooks::Page
@@ -95,23 +95,37 @@ With `post_render` you can access pages and posts after it has been converted in
 
 With `post_write` you can execute a code block after a page or post has been successfully written to disk.
 
-To run an action on both posts and pages, you'd do something like this.
+To work with all page types, you'd do something like this.
 
 ```ruby
-module MyModule
-  def self.do_awesome(document)
-    # something awesome
+module Toaster
+  ProcessAll < Octopress::Hooks::All
+    def pre_render(item)
+      item.content.gsub!(/bread/, 'tost')
+    end
   end
+end
+```
 
-  MyPostHook < Octopress::Hooks::Post
+To process pages, posts, or documents individually, you'd do this.
+
+```ruby
+module Samurai
+  ProcessPosts < Octopress::Hooks::Post
     def pre_render(post)
-      do_awesome(post)
+      post.gsub!(/bread/, 'sliced bread')
+    end
+  end
+
+  ProcessPages < Octopress::Hooks::Page
+    def pre_render(page)
+      post.gsub!(/bread/, 'sliced bread')
     end
   end
 
-  MyPageHook < Octopress::Hooks::Page
+  ProcessPages < Octopress::Hooks::Document
     def pre_render(page)
-      MyModule.do_awesome(page)
+      post.gsub!(/bread/, 'sliced bread')
     end
   end
 end
@@ -123,12 +137,12 @@ 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 `post_init`
+3. Post/Page/Document `post_init`
 4. Site `pre_render`
 5. Site `merge_payload`
-6. Post/Page `pre_render`
-7. Post/Page `post_render`
-8. Post/Page `post_write`
+6. Post/Page/Document `pre_render`
+7. Post/Page/Document `post_render`
+8. Post/Page/Document `post_write`
 9. Site `post_write`
 
 ## Contributing

data/lib/octopress-hooks/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Hooks
-    VERSION = "2.2.3"
+    VERSION = "2.3.0"
   end
 end

data/lib/octopress-hooks.rb

@@ -44,28 +44,28 @@ module Octopress
       # allows you to modify a # page object before it is 
       # added to the Jekyll pages array
       #
-      def post_init(post)
+      def post_init(page)
       end
 
       # Called before post is sent to the converter. Allows
       # you to modify the post object before the converter
       # does it's thing
       #
-      def pre_render(post)
+      def pre_render(page)
       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.
       #
-      def post_render(post)
+      def post_render(page)
       end
 
       # Called after the post is written to the disk.
       # Use the post object to read it's contents to do something
       # after the post is safely written.
       #
-      def post_write(post)
+      def post_write(page)
       end
     end
 
@@ -76,6 +76,19 @@ module Octopress
       def post_write(post); end
     end
 
+    class Document < Jekyll::Plugin
+      def post_init(doc); end
+      def pre_render(doc); end
+      def post_render(doc); end
+      def post_write(doc); end
+    end
+
+    class All < Jekyll::Plugin
+      def post_init(item); end
+      def pre_render(item); end
+      def post_render(item); end
+      def post_write(item); end
+    end
   end
 end
 
@@ -92,7 +105,7 @@ module Jekyll
 
     # Instance variable to store the various page_hook
     # plugins that are loaded.
-    attr_accessor :page_hooks, :post_hooks, :site_hooks
+    attr_accessor :page_hooks, :post_hooks, :site_hooks, :doc_hooks, :all_hooks
 
     # Instantiates all of the hook plugins. This is basically
     # a duplication of the other loaders in Site#setup.
@@ -100,6 +113,8 @@ module Jekyll
       self.site_hooks = instantiate_subclasses(Octopress::Hooks::Site) || []
       self.page_hooks = instantiate_subclasses(Octopress::Hooks::Page) || []
       self.post_hooks = instantiate_subclasses(Octopress::Hooks::Post) || []
+      self.doc_hooks  = instantiate_subclasses(Octopress::Hooks::Document) || []
+      self.all_hooks  = instantiate_subclasses(Octopress::Hooks::All) || []
     end
 
 
@@ -112,14 +127,15 @@ module Jekyll
     # can be triggered during initialization
     #
     def read
-      self.load_hooks
-      self.site_hooks.each do |hook|
+      load_hooks
+
+      site_hooks.each do |hook|
         hook.pre_read(self)
       end
 
       old_read
 
-      self.site_hooks.each do |hook|
+      site_hooks.each do |hook|
         hook.post_read(self)
       end
     end
@@ -129,10 +145,8 @@ module Jekyll
     #
     # Returns nothing
     def render
-      if self.site_hooks
-        self.site_hooks.each do |hook|
-          hook.pre_render(self)
-        end
+      site_hooks.each do |hook|
+        hook.pre_render(self)
       end
 
       old_render
@@ -145,12 +159,10 @@ module Jekyll
       unless @cached_payload
         payload = old_site_payload
 
-        if self.site_hooks
-          self.site_hooks.each do |hook|
-            p = hook.merge_payload(payload, self) || {}
-            if p != {}
-              payload = Jekyll::Utils.deep_merge_hashes(payload, p)
-            end
+        site_hooks.each do |hook|
+          p = hook.merge_payload(payload, self) || {}
+          if p != {}
+            payload = Jekyll::Utils.deep_merge_hashes(payload, p)
           end
         end
 
@@ -166,10 +178,8 @@ module Jekyll
     def write
       old_write
     
-      if self.site_hooks
-        self.site_hooks.each do |hook|
-          hook.post_write(self)
-        end
+      site_hooks.each do |hook|
+        hook.post_write(self)
       end
     end
   end
@@ -182,11 +192,71 @@ module Jekyll
 
     def initialize(*args)
       old_initialize(*args)
-      post_init if respond_to?(:post_init) && self.hooks
+      post_init if respond_to?(:post_init) && hooks
+    end
+
+    def hooks
+      @hooks ||= site.all_hooks + site.page_hooks
+    end
+  end
+
+  # Monkey patch Jekyll's Document class
+  #
+  class Document
+    alias_method :old_initialize, :initialize
+    alias_method :old_write, :write
+
+    def initialize(*args)
+      old_initialize(*args)
+      post_init if place_in_layout?
+    end
+
+    def write(dest)
+      post_render if place_in_layout?
+      old_write(dest)
+      post_write if place_in_layout?
     end
 
     def hooks
-      self.site.page_hooks
+      @hooks ||= site.all_hooks + site.doc_hooks
+    end
+
+    def post_init
+      puts 'post_init doc'
+      hooks.each do |hook|
+        hook.post_init(self)
+      end
+    end
+
+    def pre_render
+      puts 'pre_render doc'
+      hooks.each do |hook|
+        hook.pre_render(self)
+      end
+    end
+
+    def post_render
+      puts 'post_render doc'
+      hooks.each do |hook|
+        hook.post_render(self)
+      end
+    end
+
+    def post_write
+      puts 'post_write doc'
+      hooks.each do |hook|
+        hook.post_write(self)
+      end
+    end
+  end
+
+  class Renderer
+    alias_method :old_run, :run
+    attr_accessor :output
+
+    def run
+      document.pre_render if document.place_in_layout?
+      old_run
     end
   end
 
@@ -197,11 +267,11 @@ module Jekyll
 
     def initialize(*args)
       old_initialize(*args)
-      post_init if respond_to?(:post_init) && self.hooks
+      post_init if respond_to?(:post_init) && hooks
     end
 
     def hooks
-      self.site.post_hooks
+      @hooks ||= site.all_hooks + site.post_hooks
     end
   end
 
@@ -219,9 +289,9 @@ module Jekyll
     #
     # Returns nothing.
     def do_layout(payload, layouts)
-      pre_render if respond_to?(:pre_render) && self.hooks
+      pre_render if respond_to?(:pre_render) && hooks
       old_do_layout(payload, layouts)
-      post_render if respond_to?(:post_render) && self.hooks
+      post_render if respond_to?(:post_render) && hooks
     end
 
     # Write the generated post file to the destination directory. It
@@ -231,7 +301,7 @@ module Jekyll
     # Returns nothing
     def write(dest)
       old_write(dest)
-      post_write if respond_to?(:post_write) && self.hooks
+      post_write if respond_to?(:post_write) && hooks
     end
 
     def hooks
@@ -239,25 +309,25 @@ module Jekyll
     end
 
     def post_init
-      self.hooks.each do |hook|
+      hooks.each do |hook|
         hook.post_init(self)
       end
     end
     
     def pre_render
-      self.hooks.each do |hook|
+      hooks.each do |hook|
         hook.pre_render(self)
       end
     end
 
     def post_render
-      self.hooks.each do |hook|
+      hooks.each do |hook|
         hook.post_render(self)
       end
     end
 
     def post_write
-      self.hooks.each do |hook|
+      hooks.each do |hook|
         hook.post_write(self)
       end
     end
@@ -265,7 +335,7 @@ module Jekyll
     # Returns the full url of the post, including the configured url
     #
     def full_url
-      File.join(self.site.config['url'], self.url)
+      File.join(site.config['url'], url)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-hooks
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,43 +52,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Allows access to Jekyll's site, posts and pages at different points in
-  the life cycle of a build. Formerly known as 'jekyll-page-hooks'.
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 
 email:
 - brandon@imathis.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".clash.yml"
-- ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/octopress-hooks.rb
 - lib/octopress-hooks/version.rb
-- octopress-hooks.gemspec
-- test/.gitignore
-- test/Gemfile
-- test/_config.yml
-- 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
-- test/post_render_page.md
-- test/post_write_page.md
-- test/pre_render_page.md
 homepage: http://github.com/octopress/hooks
 licenses:
 - MIT

data/.clash.yml

@@ -1,10 +0,0 @@
--
-  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/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-.DS_Store
-_site

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 1.9.3
-script: bundle exec clash test
-notifications:
-  slack:
-    secure: FZR2kuuJF2PwpzsoSsPgU5r2Uaj9LL611gOt2de9/x1bx2N464DTBVa3nhV8SfNRNOrqR10nvt8CvKqL4iWNdt3OpU8iK7/PTqCIsggJbdfAkqU5WAhsmV7+shYIJxi+kOH+8bockG7c4kY9GMBaJUSe1VgM+BHsykUyrna8ywQ=

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in octopress-hooks.gemspec
-gemspec

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/octopress-hooks.gemspec

@@ -1,23 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'octopress-hooks/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "octopress-hooks"
-  gem.version       = Octopress::Hooks::VERSION
-  gem.authors       = ["Brandon Mathis"]
-  gem.email         = ["brandon@imathis.com"]
-  gem.description   = %q{Allows access to Jekyll's site, posts and pages at different points in the life cycle of a build. Formerly known as 'jekyll-page-hooks'.}
-  gem.summary       = %q{Allows access to Jekyll's site, posts and pages at different points in the life cycle of a build. Formerly known as 'jekyll-page-hooks'.}
-  gem.homepage      = "http://github.com/octopress/hooks"
-  gem.license       = "MIT"
-
-  gem.add_runtime_dependency 'jekyll', '~> 2.0'
-
-  gem.add_development_dependency 'clash', '~> 1.0'
-  gem.add_development_dependency 'rake'
-
-  gem.files         = `git ls-files`.split($/)
-  gem.require_paths = ["lib"]
-end

data/test/.gitignore

@@ -1 +0,0 @@
-_site

data/test/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'octopress-hooks', :path => '../'
-gem 'pry-debugger'
-gem 'clash'
-

data/test/_config.yml

@@ -1,5 +0,0 @@
-title: Your New Jekyll Site
-markdown: redcarpet
-highlighter: pygments
-exclude:
-  - Gemfile*

data/test/_expected/post_read

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

data/test/_expected/site/2014/05/21/hi-guys.html

@@ -1 +0,0 @@
-<p>Hi guys awesome</p>

data/test/_expected/site/boom

@@ -1 +0,0 @@
-BOOM

data/test/_expected/site/magic

@@ -1 +0,0 @@
-MAGIC

data/test/_expected/site/merge_payload.html

@@ -1 +0,0 @@
-<p>Your New Jekyll Site == Your New Jekyll Site</p>

data/test/_expected/site/post_render_page.html

@@ -1 +0,0 @@
-<p><code>&lt;strong&gt;</code> is for the weak. The age of <code>&lt;blink&gt;&lt;strong&gt;</code> is <blink><strong>upon us</strong></blink>.</p>

data/test/_expected/site/post_write_page.html

@@ -1 +0,0 @@
-<p>This page has been written</p>

data/test/_expected/site/pre_read

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

data/test/_expected/site/pre_render_page.html

@@ -1 +0,0 @@
-<p>Snatch this _______ from my hand.</p>

data/test/_plugins/test.rb

@@ -1,85 +0,0 @@
-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') }
-      site.static_files << Jekyll::StaticFile.new(site, site.source, '', 'magic')
-    end
-
-    def merge_payload(payload, site)
-      if payload['site']['title']
-        payload['site']['name'] ||= payload['site']['title']
-      end
-
-      payload
-    end
-
-    def post_write(site)
-      file = File.join(site.config['destination'], 'boom')
-      File.open(file, 'w') { |f| f.write('BOOM') }
-      FileUtils.rm('magic')
-    end
-  end
-
-  class PostHooksTest < Octopress::Hooks::Post
-    def post_init(post)
-      post.data['injected_data'] = 'awesome'
-    end
-  end
-
-  class PageHooksTest < Octopress::Hooks::Page
-
-    # Inherited methods from PageHooks
-   
-    # Called before processors
-    # 
-    def pre_render(page)
-      page.content = snatch_cupcake page.content
-    end
-
-    # Called after processors
-    # 
-    def post_render(page)
-      page.content = blink_strong page.content
-    end
-
-    # Called after write
-    # 
-    def post_write(page)
-      file = page.destination(page.site.config['destination'])
-      File.open(file, 'w') { |f| f.write(log_write(page.content)) }
-    end
-
-    # Plugin methods
-
-    # Replaces *cupcake* with _______ before markdown renders <em>cupcake</em>.
-    #
-    def snatch_cupcake(content)
-      content.sub /\*cupcake\*/, '_______'
-    end
-
-    def log_write(content)
-      content.sub /hasn&#39;t/, 'has'
-    end
-    
-    # Replaces <strong> tag with <strong><blink> after html has been rendered.
-    #
-    def blink_strong(content)
-      content.gsub /(<strong>.+?<\/strong>)/ do
-        "<blink>#{$1}</blink>"
-      end
-    end
-  end
-end

data/test/_posts/2014-05-21-hi-guys.md

@@ -1,3 +0,0 @@
----
----
-Hi guys {{ page.injected_data }}

data/test/merge_payload.md

@@ -1,3 +0,0 @@
----
----
-{{ site.name }} == {{ site.title }}

data/test/post_render_page.md

@@ -1,3 +0,0 @@
----
----
-`<strong>` is for the weak. The age of `<blink><strong>` is **upon us**.

data/test/post_write_page.md

@@ -1,3 +0,0 @@
----
----
-This page hasn't been written

data/test/pre_render_page.md

@@ -1,3 +0,0 @@
----
----
-Snatch this *cupcake* from my hand.{{ page.injected_data }}