jekyll-page-hooks 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Jekyll Page Hooks
+
+This plugin isn't useful on its own. It monkeypatches Jekyll's Site, Post, Page and Convertible classes to allow plugin authors to access page and post data before and after render, and after write. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jekyll-page-hooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-page-hooks
+
+## Usage
+
+First require this plugin at the top of a plugin file, inside of Jekyll's plugin directory. Then if your plugin class inherits the PageHooks class, the methods, `pre_render`, `post_render`, `post_write` will execute automatically in turn.
+
+Here's an example.
+
+```ruby
+require 'jeykll-page-hooks'
+
+module Jekyll
+  class YourFancyPlugin < PageHooks
+
+    # Manipulate page/post data before it has been processed with Liquid or
+    # Converters like Markdown or Textile.
+    #
+    def pre_render(page)
+      page.content = highlight_code(page.content)
+    end
+
+    # Manipulate page/post data after content has been processed to html.
+    #
+    def post_render(page)
+      page.content = link_headings(page.content)
+    end
+
+    # Access page/post data after it has been succesfully written to disk.
+    #
+    def post_write(page)
+      log_something(page.title)
+    end
+
+  end
+end
+```
+
+### When to use what
+
+With `pre_render` you can access page and post data before it has been
+processed by Liquid, Markdown, Textile, etc. You might want to do this if your
+plugin requires text which conflicts with some content convertors. This way
+you can replace that content with the correctly generated HTML before Liquid
+or other convertors sees it.
+
+With `post_render` you can access pages and posts after it has been proccessed into HTML. You might use this option if you want to modify generated HTML, for example adding anchors for each heading element.
+
+With `post_write` you can execute a code block after a page or post has been
+successfully written to disk. You might use this for logging or triggering
+some external process.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Lisence
+
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

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

data/jekyll-page-hooks.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-page-hooks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jekyll-page-hooks"
+  gem.version       = Jekyll::PageHooksVersion::VERSION
+  gem.authors       = ["Brandon Mathis"]
+  gem.email         = ["brandon@imathis.com"]
+  gem.description   = %q{Monkeypatches Jekyll's Site, Post, Page and Convertible classes to allow other plugins to access page/post content before and after render, and after write.}
+  gem.summary       = %q{Allows other plugins to access page/post content before and after render, and after write.}
+  gem.homepage      = "http://github.com/octopress/jekyll-page-hooks"
+  gem.license       = "MIT"
+
+  gem.add_dependency 'jekyll', '>= 1.0.0'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/lib/jekyll-page-hooks/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module PageHooksVersion
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll-page-hooks.rb

@@ -0,0 +1,174 @@
+module Jekyll  
+
+  # Extended plugin type that allows the plugin
+  # to be called on varous callback methods.
+  #
+  class PageHooks < Plugin
+
+    #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)
+    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)
+    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)
+    end
+  end
+
+  # Monkey patch for the Jekyll Site class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/site.rb
+  class Site
+
+    # Instance variable to store the various post_filter
+    # plugins that are loaded.
+    attr_accessor :post_filters
+
+    # Instantiates all of the post_filter plugins. This is basically
+    # a duplication of the other loaders in Site#setup.
+    def load_post_filters
+      self.post_filters = Jekyll::PageHooks.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
+      end
+    end
+  end
+
+  # Monkey patch for the Jekyll Post class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/post.rb
+  class Post
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Page class. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/page.rb
+  class Page
+
+    # Copy the #write method to #old_write, so we can redefine #write
+    # method.
+    alias_method :old_write, :write
+
+    # Write the generated post file to the destination directory. It
+    # then calls any post_write methods that may exist.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      old_write(dest)
+      post_write if respond_to?(:post_write)
+    end
+  end
+
+  # Monkey patch for the Jekyll Convertible module. For the original class,
+  # see: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/convertible.rb
+  module Convertible
+
+    def is_post?
+      self.class.to_s == 'Jekyll::Post'
+    end
+
+    def is_page?
+      self.class.to_s == 'Jekyll::Page'
+    end
+
+    def is_filterable?
+      is_post? or is_page?
+    end
+
+    # Call the #pre_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def pre_render
+      self.site.load_post_filters unless self.site.post_filters
+
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.pre_render(self)
+        end
+      end
+    end
+
+    # Call the #post_render methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_render
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_render(self)
+        end
+      end
+    end
+
+    # Call the #post_write methods on all of the loaded
+    # post_filter plugins.
+    #
+    # Returns nothing
+    def post_write
+      if self.site.post_filters and is_filterable?
+        self.site.post_filters.each do |filter|
+          filter.post_write(self)
+        end
+      end
+    end
+
+    # Copy the #transform method to #old_transform, so we can
+    # redefine #transform method.
+    alias_method :old_transform, :transform
+
+    # Transform the contents based on the content type. Then calls the
+    # #post_render method if it exists
+    #
+    # Returns nothing.
+    def transform
+      old_transform
+      post_render if respond_to?(:post_render)
+    end
+
+    # Copy the #do_layout method to #old_do_layout, so we can
+    # redefine #do_layout method.
+    alias_method :old_do_layout, :do_layout
+
+    # Calls the pre_render method if it exists and then adds any necessary
+    # layouts to this convertible document.
+    #
+    # payload - The site payload Hash.
+    # layouts - A Hash of {"name" => "layout"}.
+    #
+    # Returns nothing.
+    def do_layout(payload, layouts)
+      pre_render if respond_to?(:pre_render)
+      old_do_layout(payload, layouts)
+    end
+
+    # Returns the full url of the post, including the
+    # configured url
+    def full_url
+      self.site.config['url'] + self.url
+    end
+  end
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-page-hooks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Monkeypatches Jekyll's Site, Post, Page and Convertible classes to allow
+  other plugins to access page/post content before and after render, and after write.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-page-hooks.gemspec
+- lib/jekyll-page-hooks.rb
+- lib/jekyll-page-hooks/version.rb
+homepage: http://github.com/octopress/jekyll-page-hooks
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Allows other plugins to access page/post content before and after render,
+  and after write.
+test_files: []