octopress-hooks 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8146d664fb709b511c92e4ae185dcc904896b395
+  data.tar.gz: 0842bc67f1fafbf5f853c9bc88a5a79ae91f6312
+SHA512:
+  metadata.gz: df5cdfe5412c3a0e089b3d2d30f332283a8554477c0a0be790cb2dbc88466fd2e44963b398d66bd5e77b07689b79afb2d704cb4d3f31fcbdd192a02aad58d80b
+  data.tar.gz: 34191d047548eca5d6a081be03b59e9351450ba59b53872ceae5a08d7a45f0ed43fca2a47c883e895140d1e6942616e61c1344fb7908a474ecac57b1b336f15f

data/.gitignore

@@ -0,0 +1,19 @@
+*.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

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && bundle exec clash
+

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+### 2.0.0
+- Added support for Site hooks: pre_render, post_write and a way to patch the site payload.
+- Changed name to octopress-hooks and moved repository to octopress/hooks.
+
+### 1.3.1
+- No longer requires Octopress Ink.
+- Renamed to octopress-hooks
+- moved to https://github.com/octopress/hooks
+
+### 1.3.0
+- Added support for processing partials as a ConvertiblePartial.
+
+### 1.2.0
+- Added support Jekyll 2.0
+
+### 1.1.1
+- Added support for Octopress Ink.
+
+### 1.1.0
+- Added Jekyll::ConvertiblePage type to hookable classes.
+
+### 1.0.2
+- Now requires Jekyll (oops).
+- Added tests.
+
+### 1.0.1
+- Naming refactor.
+
+### 1.0.0
+- Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in octopress-hooks.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,109 @@
+# Octopress 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 'octopress-hooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-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 'octopress-hooks'
+
+class YourPageHooks < Octopress::Hooks::Page
+
+  # 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
+
+class YourSiteHooks < Octopress::Hooks::Site
+
+  # Get access to the site before the render process
+  #
+  def pre_render(site)
+    # do something interesting
+  end
+
+  # Return a hash to be merged into the site payload
+  #
+  def merge_payload(payload, site)
+    { 'awesome' => true }
+  end
+
+  # Trigger some action after the site has been written 
+  #
+  def post_write(site)
+    # do something interesting
+  end
+
+end
+```
+
+For a more complete example, check out [test.rb](test/_plugins/test.rb).
+
+### When to use what
+
+#### For posts/pages
+
+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.
+
+#### For site
+
+Use the `pre_render` hook to get access to the site class and modify it as necessary before posts and pages are rendered.
+You could use this to modify these objects or even add to them.
+
+Use the `merge_paylod` hook to add data that all documents will have access to when they are rendered, or modify the contents
+of the site payload. Be sure to return a hash that can be merged.
+
+Use the `post_write` to trigger and action after all documents have been written. With this you could gzip assets, or trigger a shell command.
+
+## Contributing
+
+1. Fork it ( https://github.com/octopress/hooks/fork )
+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 a new Pull Request
+

data/Rakefile

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

data/lib/octopress-hooks.rb

@@ -0,0 +1,259 @@
+require 'octopress-hooks/version'
+require 'jekyll'
+
+module Octopress  
+  module Hooks
+    
+    # Extended plugin type that allows the plugin
+    # to be called on varous callback methods.
+    #
+    class Page < Jekyll::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
+
+    class Site < Jekyll::Plugin
+
+      # Called before Jekyll renders posts and pages
+      # Returns nothing
+      # 
+      def pre_render(site)
+      end
+
+      # Merges hash into site_payload
+      # Returns hash to be merged
+      #
+      def merge_payload(payload, site)
+        payload
+      end
+
+      # Called after Jekyll writes site files
+      # Returns nothing
+      #
+      def post_write(site)
+      end
+
+    end
+  end
+end
+
+# Monkey-patch Jekyll to add triggers for hooks
+
+module Jekyll
+
+  # For compatibilty with old jekyll-page-hooks gem
+  #
+  class PageHooks < Octopress::Hooks::Page; end
+
+  # Monkey patch for the Jekyll Site class.
+  class Site
+
+    # Instance variable to store the various page_hook
+    # plugins that are loaded.
+    attr_accessor :page_hooks, :site_hooks
+
+    # Instantiates all of the hook plugins. This is basically
+    # a duplication of the other loaders in Site#setup.
+    def load_hooks
+      self.site_hooks = instantiate_subclasses(Octopress::Hooks::Site)
+      self.page_hooks = instantiate_subclasses(Octopress::Hooks::Page)
+    end
+
+
+    alias_method :old_site_payload, :site_payload
+    alias_method :old_render, :render
+    alias_method :old_write, :write
+
+    # Allows site hooks to get access to the site before
+    # the render method is called
+    #
+    # Returns nothing
+    def render
+      self.load_hooks
+
+      if self.site_hooks
+        self.site_hooks.each do |hook|
+          hook.pre_render(self)
+        end
+      end
+
+      old_render
+    end
+
+    # Allows site hooks to merge data into the site payload
+    #
+    # Returns the patched site payload
+    def site_payload
+      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
+          end
+        end
+
+        @cached_payload = payload
+      end
+
+      @cached_payload
+    end
+
+    # Trigger site hooks after site has been written
+    #
+    # Returns nothing
+    def write
+      old_write
+    
+      if self.site_hooks
+        self.site_hooks.each do |hook|
+          hook.post_write(self)
+        end
+      end
+    end
+
+  end
+
+
+  # Create a new page class to allow partials to trigger Jekyll Page Hooks.
+  #
+  class ConvertiblePartial
+    include Convertible
+    
+    attr_accessor :name, :content, :site, :ext, :output, :data
+    
+    def initialize(site, name, content)
+      @site     = site
+      @name     = name
+      @ext      = File.extname(name)
+      @content  = content
+      @data     = { layout: "no_layout" } # hack
+      
+    end
+    
+    def render(payload)
+      do_layout(payload, { no_layout: nil })
+    end
+  end
+
+  # Monkey patch for the Jekyll Convertible module.
+  module Convertible
+
+    def is_post?
+      self.is_a? Jekyll::Post
+    end
+
+    def is_page?
+      self.is_a? Jekyll::Page ||
+      self.class.to_s == 'Octopress::Ink::Page'
+    end
+
+    def is_convertible_partial?
+      self.is_a? Jekyll::ConvertiblePartial
+    end
+
+    def is_filterable?
+      is_post? or is_page? or is_convertible_partial?
+    end
+
+    # Call the #pre_render methods on all of the loaded
+    # page_hook plugins.
+    #
+    # Returns nothing
+    def pre_render
+      if self.site.page_hooks and is_filterable?
+        self.site.page_hooks.each do |filter|
+          filter.pre_render(self)
+        end
+      end
+    end
+
+    # Call the #post_render methods on all of the loaded
+    # page_hook plugins.
+    #
+    # Returns nothing
+    def post_render
+      if self.site.page_hooks and is_filterable?
+        self.site.page_hooks.each do |filter|
+          filter.post_render(self)
+        end
+      end
+    end
+
+    # Call the #post_write methods on all of the loaded
+    # page_hook plugins.
+    #
+    # Returns nothing
+    def post_write
+      if self.site.page_hooks and is_filterable?
+        self.site.page_hooks.each do |filter|
+          filter.post_write(self)
+        end
+      end
+    end
+
+    alias_method :old_transform, :transform
+    alias_method :old_do_layout, :do_layout
+    alias_method :old_write, :write
+
+    # 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
+
+    # 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
+
+    # 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
+
+    # Returns the full url of the post, including the configured url
+    #
+    def full_url
+      self.site.config['url'] + self.url
+    end
+  end
+end
+

data/lib/octopress-hooks/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Hooks
+    VERSION = "2.0.0"
+  end
+end

data/octopress-hooks.gemspec

@@ -0,0 +1,22 @@
+# -*- 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.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/test/.clash.yml

@@ -0,0 +1,2 @@
+build: true
+compare: _expected _site

data/test/.gitignore

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

data/test/Gemfile

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

data/test/_config.yml

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

data/test/_expected/boom

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

data/test/_expected/magic

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

data/test/_expected/merge_payload.html

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

data/test/_expected/post_render_page.html

@@ -0,0 +1 @@
+<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/post_write_page.html

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

data/test/_expected/pre_render_page.html

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

data/test/_plugins/test.rb

@@ -0,0 +1,69 @@
+require 'octopress-hooks'
+
+module TestingHooks
+  class SiteHookTest < Octopress::Hooks::Site
+    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 PageHooksTest < Jekyll::PageHooks
+
+    # 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/merge_payload.md

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

data/test/post_render_page.md

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

data/test/post_write_page.md

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

data/test/pre_render_page.md

@@ -0,0 +1,3 @@
+---
+---
+Snatch this *cupcake* from my hand.

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: octopress-hooks
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'.
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/octopress-hooks.rb
+- lib/octopress-hooks/version.rb
+- octopress-hooks.gemspec
+- test/.clash.yml
+- test/.gitignore
+- test/Gemfile
+- test/_config.yml
+- 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/_plugins/test.rb
+- 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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 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'.
+test_files: []