jekyll 3.0.0.pre.beta3 → 3.0.0.pre.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3bfbcb3305b1d99e27d4f8e0b4498a9bd26162e
-  data.tar.gz: bce86abbe4ecf82618bb8ab2cfd46c94a82c83e1
+  metadata.gz: 8b671ad21c396f69a1ce1e75bfa41ae9f7ab299f
+  data.tar.gz: 65895690b84df23c794c12dc1d3f1c4d6e61ba15
 SHA512:
-  metadata.gz: a35034599b1cf1be9b4194b058a244b070bb7deaac9525068239cfd307f4c4aaa64e7534002b0d517cdf69cbf8855eddea5b8501d91d1b9fd319feec9dc2d423
-  data.tar.gz: 0ea6b82be241eb5bbdcf1124e178c510b7450e1c86b27367b8351358236ee51c4b63a4eb9aee2bc62a16094bbdbdc3dc8812f04c1c1936a4750e4e6fa090b1bf
+  metadata.gz: 017c26c08ee3989732900b36af6464ed884d5c6a19f083c42bfbfce8cc345910934ea3695f02b2198fe91da9d813562c91da2d93d25d851f549773fa7f1e4840
+  data.tar.gz: 3298b7ff1db4e4e271d3f0ed1e48e95e32c05c8908cdfbfd58d42086f6275f72962fe97f9063b03bb2e296705aefaa0a88d2bc1aa342640ed68260460d5ec052

data/lib/jekyll.rb

@@ -48,6 +48,7 @@ module Jekyll
   autoload :External,            'jekyll/external'
   autoload :Filters,             'jekyll/filters'
   autoload :FrontmatterDefaults, 'jekyll/frontmatter_defaults'
+  autoload :Hooks,               'jekyll/hooks'
   autoload :Layout,              'jekyll/layout'
   autoload :CollectionReader,    'jekyll/readers/collection_reader'
   autoload :DataReader,          'jekyll/readers/data_reader'

data/lib/jekyll/convertible.rb

@@ -236,6 +236,7 @@ module Jekyll
     #
     # Returns nothing.
     def do_layout(payload, layouts)
+      Jekyll::Hooks.trigger self, :pre_render, payload
       info = { :filters => [Jekyll::Filters], :registers => { :site => site, :page => payload['page'] } }
 
       # render and transform content (this becomes the final content of the object)
@@ -249,6 +250,7 @@ module Jekyll
       self.output = content
 
       render_all_layouts(layouts, payload, info) if place_in_layout?
+      Jekyll::Hooks.trigger self, :post_render
     end
 
     # Write the generated page file to the destination directory.
@@ -262,6 +264,7 @@ module Jekyll
       File.open(path, 'wb') do |f|
         f.write(output)
       end
+      Jekyll::Hooks.trigger self, :post_write
     end
 
     # Accessor for data properties by Liquid.

data/lib/jekyll/document.rb

@@ -4,8 +4,7 @@ module Jekyll
   class Document
     include Comparable
 
-    attr_reader   :path, :site, :extname, :output_ext
-    attr_accessor :content, :collection, :output
+    attr_reader :path, :site, :extname, :output_ext, :content, :output, :collection
 
     YAML_FRONT_MATTER_REGEXP = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
 
@@ -24,6 +23,16 @@ module Jekyll
       @has_yaml_header = nil
     end
 
+    def output=(output)
+      @to_liquid = nil
+      @output = output
+    end
+
+    def content=(content)
+      @to_liquid = nil
+      @content = content
+    end
+
     # Fetch the Document's data.
     #
     # Returns a Hash containing the data. An empty hash is returned if
@@ -180,6 +189,8 @@ module Jekyll
       File.open(path, 'wb') do |f|
         f.write(output)
       end
+
+      Jekyll::Hooks.trigger self, :post_write
     end
 
     # Returns merged option hash for File.read of self.site (if exists)
@@ -205,6 +216,8 @@ module Jekyll
     #
     # Returns nothing.
     def read(opts = {})
+      @to_liquid = nil
+
       if yaml_file?
         @data = SafeYAML.load_file(path)
       else
@@ -213,9 +226,9 @@ module Jekyll
           unless defaults.empty?
             @data = defaults
           end
-          @content = File.read(path, merged_file_read_opts(opts))
+          self.content = File.read(path, merged_file_read_opts(opts))
           if content =~ YAML_FRONT_MATTER_REGEXP
-            @content = $POSTMATCH
+            self.content = $POSTMATCH
             data_file = SafeYAML.load($1)
             unless data_file.nil?
               @data = Utils.deep_merge_hashes(defaults, data_file)
@@ -233,7 +246,7 @@ module Jekyll
     #
     # Returns a Hash representing this Document's data.
     def to_liquid
-      if data.is_a?(Hash)
+      @to_liquid ||= if data.is_a?(Hash)
         Utils.deep_merge_hashes data, {
           "output"        => output,
           "content"       => content,
@@ -279,6 +292,5 @@ module Jekyll
     def write?
       collection && collection.write?
     end
-
   end
 end

data/lib/jekyll/hooks.rb

@@ -0,0 +1,107 @@
+module Jekyll
+  module Hooks
+    # Helps look up hooks from the registry by owner's class
+    OWNER_MAP = {
+      Jekyll::Site => :site,
+      Jekyll::Page => :page,
+      Jekyll::Post => :post,
+      Jekyll::Document => :document,
+    }.freeze
+
+    DEFAULT_PRIORITY = 20
+
+    # compatibility layer for octopress-hooks users
+    PRIORITY_MAP = {
+      low: 10,
+      normal: 20,
+      high: 30,
+    }.freeze
+
+    # initial empty hooks
+    @registry = {
+      :site => {
+        after_reset: [],
+        post_read: [],
+        pre_render: [],
+        post_write: [],
+      },
+      :page => {
+        post_init: [],
+        pre_render: [],
+        post_render: [],
+        post_write: [],
+      },
+      :post => {
+        post_init: [],
+        pre_render: [],
+        post_render: [],
+        post_write: [],
+      },
+      :document => {
+        pre_render: [],
+        post_render: [],
+        post_write: [],
+      },
+    }
+
+    # map of all hooks and their priorities
+    @hook_priority = {}
+
+    NotAvailable = Class.new(RuntimeError)
+    Uncallable = Class.new(RuntimeError)
+
+    # register hook(s) to be called later, public API
+    def self.register(owners, event, priority: DEFAULT_PRIORITY, &block)
+      Array(owners).each do |owner|
+        register_one(owner, event, priority_value(priority), &block)
+      end
+    end
+
+    # Ensure the priority is a Fixnum
+    def self.priority_value(priority)
+      return priority if priority.is_a?(Fixnum)
+      PRIORITY_MAP[priority] || DEFAULT_PRIORITY
+    end
+
+    # register a single hook to be called later, internal API
+    def self.register_one(owner, event, priority, &block)
+      unless @registry[owner]
+        raise NotAvailable, "Hooks are only available for the following " <<
+          "classes: #{@registry.keys.inspect}"
+      end
+
+      unless @registry[owner][event]
+        raise NotAvailable, "Invalid hook. #{owner} supports only the " <<
+          "following hooks #{@registry[owner].keys.inspect}"
+      end
+
+      unless block.respond_to? :call
+        raise Uncallable, "Hooks must respond to :call"
+      end
+
+      insert_hook owner, event, priority, &block
+    end
+
+    def self.insert_hook(owner, event, priority, &block)
+      @hook_priority[block] = "#{priority}.#{@hook_priority.size}".to_f
+      @registry[owner][event] << block
+    end
+
+    # interface for Jekyll core components to trigger hooks
+    def self.trigger(instance, event, *args)
+      owner_symbol = OWNER_MAP[instance.class]
+
+      # proceed only if there are hooks to call
+      return unless @registry[owner_symbol]
+      return unless @registry[owner_symbol][event]
+
+      # hooks to call for this owner and event
+      hooks = @registry[owner_symbol][event]
+
+      # sort and call hooks according to priority and load order
+      hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
+        hook.call(instance, *args)
+      end
+    end
+  end
+end

data/lib/jekyll/page.rb

@@ -35,6 +35,8 @@ module Jekyll
       data.default_proc = proc do |hash, key|
         site.frontmatter_defaults.find(File.join(dir, name), type, key)
       end
+
+      Jekyll::Hooks.trigger self, :post_init
     end
 
     # The generated directory into which the page will be placed

data/lib/jekyll/post.rb

@@ -68,6 +68,8 @@ module Jekyll
 
       populate_categories
       populate_tags
+
+      Jekyll::Hooks.trigger self, :post_init
     end
 
     def published?

data/lib/jekyll/renderer.rb

@@ -35,6 +35,8 @@ module Jekyll
         "page" => document.to_liquid
       }, site_payload || site.site_payload)
 
+      Jekyll::Hooks.trigger document, :pre_render, payload
+
       info = {
         filters:   [Jekyll::Filters],
         registers: { :site => site, :page => payload['page'] }

data/lib/jekyll/site.rb

@@ -75,6 +75,8 @@ module Jekyll
       if limit_posts < 0
         raise ArgumentError, "limit_posts must be a non-negative number"
       end
+
+      Jekyll::Hooks.trigger self, :after_reset
     end
 
     # Load necessary libraries, plugins, converters, and generators.
@@ -132,6 +134,7 @@ module Jekyll
     def read
       reader.read
       limit_posts!
+      Jekyll::Hooks.trigger self, :post_read
     end
 
     # Run each of the Generators.
@@ -150,15 +153,18 @@ module Jekyll
       relative_permalinks_are_deprecated
 
       payload = site_payload
+
+      Jekyll::Hooks.trigger self, :pre_render, payload
+
       collections.each do |label, collection|
         collection.docs.each do |document|
           if regenerator.regenerate?(document)
             document.output = Jekyll::Renderer.new(self, document, payload).run
+            Jekyll::Hooks.trigger document, :post_render
           end
         end
       end
 
-      payload = site_payload
       [posts, pages].flatten.each do |page_or_post|
         if regenerator.regenerate?(page_or_post)
           page_or_post.render(layouts, payload)
@@ -183,6 +189,7 @@ module Jekyll
         item.write(dest) if regenerator.regenerate?(item)
       }
       regenerator.write_metadata
+      Jekyll::Hooks.trigger self, :post_write
     end
 
     # Construct a Hash of Posts indexed by the specified Post attribute.

data/lib/jekyll/version.rb

@@ -1,3 +1,3 @@
 module Jekyll
-  VERSION = '3.0.0.pre.beta3'
+  VERSION = '3.0.0.pre.beta4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.beta3
+  version: 3.0.0.pre.beta4
 platform: ruby
 authors:
 - Tom Preston-Werner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-07 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -162,6 +162,7 @@ files:
 - lib/jekyll/filters.rb
 - lib/jekyll/frontmatter_defaults.rb
 - lib/jekyll/generator.rb
+- lib/jekyll/hooks.rb
 - lib/jekyll/layout.rb
 - lib/jekyll/liquid_extensions.rb
 - lib/jekyll/log_adapter.rb
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 2
 summary: A simple, blog aware, static site generator.