bunto 1.0.0

data/lib/bunto/frontmatter_defaults.rb

@@ -0,0 +1,188 @@
+module Bunto
+  # This class handles custom defaults for YAML frontmatter settings.
+  # These are set in _config.yml and apply both to internal use (e.g. layout)
+  # and the data available to liquid.
+  #
+  # It is exposed via the frontmatter_defaults method on the site class.
+  class FrontmatterDefaults
+    # Initializes a new instance.
+    def initialize(site)
+      @site = site
+    end
+
+    def update_deprecated_types(set)
+      return set unless set.key?('scope') && set['scope'].key?('type')
+
+      set['scope']['type'] =
+        case set['scope']['type']
+        when 'page'
+          Deprecator.defaults_deprecate_type('page', 'pages')
+          'pages'
+        when 'post'
+          Deprecator.defaults_deprecate_type('post', 'posts')
+          'posts'
+        when 'draft'
+          Deprecator.defaults_deprecate_type('draft', 'drafts')
+          'drafts'
+        else
+          set['scope']['type']
+        end
+
+      set
+    end
+
+    def ensure_time!(set)
+      return set unless set.key?('values') && set['values'].key?('date')
+      return set if set['values']['date'].is_a?(Time)
+      set['values']['date'] = Utils.parse_date(set['values']['date'], "An invalid date format was found in a front-matter default set: #{set}")
+      set
+    end
+
+    # Finds a default value for a given setting, filtered by path and type
+    #
+    # path - the path (relative to the source) of the page, post or :draft the default is used in
+    # type - a symbol indicating whether a :page, a :post or a :draft calls this method
+    #
+    # Returns the default value or nil if none was found
+    def find(path, type, setting)
+      value = nil
+      old_scope = nil
+
+      matching_sets(path, type).each do |set|
+        if set['values'].key?(setting) && has_precedence?(old_scope, set['scope'])
+          value = set['values'][setting]
+          old_scope = set['scope']
+        end
+      end
+      value
+    end
+
+    # Collects a hash with all default values for a page or post
+    #
+    # path - the relative path of the page or post
+    # type - a symbol indicating the type (:post, :page or :draft)
+    #
+    # Returns a hash with all default values (an empty hash if there are none)
+    def all(path, type)
+      defaults = {}
+      old_scope = nil
+      matching_sets(path, type).each do |set|
+        if has_precedence?(old_scope, set['scope'])
+          defaults = Utils.deep_merge_hashes(defaults, set['values'])
+          old_scope = set['scope']
+        else
+          defaults = Utils.deep_merge_hashes(set['values'], defaults)
+        end
+      end
+      defaults
+    end
+
+    private
+
+    # Checks if a given default setting scope matches the given path and type
+    #
+    # scope - the hash indicating the scope, as defined in _config.yml
+    # path - the path to check for
+    # type - the type (:post, :page or :draft) to check for
+    #
+    # Returns true if the scope applies to the given path and type
+    def applies?(scope, path, type)
+      applies_path?(scope, path) && applies_type?(scope, type)
+    end
+
+    def applies_path?(scope, path)
+      return true if !scope.key?('path') || scope['path'].empty?
+
+      scope_path = Pathname.new(scope['path'])
+      Pathname.new(sanitize_path(path)).ascend do |path|
+        if path.to_s == scope_path.to_s
+          return true
+        end
+      end
+    end
+
+    # Determines whether the scope applies to type.
+    # The scope applies to the type if:
+    #   1. no 'type' is specified
+    #   2. the 'type' in the scope is the same as the type asked about
+    #
+    # scope - the Hash defaults set being asked about application
+    # type  - the type of the document being processed / asked about
+    #         its defaults.
+    #
+    # Returns true if either of the above conditions are satisfied,
+    #   otherwise returns false
+    def applies_type?(scope, type)
+      !scope.key?('type') || scope['type'].eql?(type.to_s)
+    end
+
+    # Checks if a given set of default values is valid
+    #
+    # set - the default value hash, as defined in _config.yml
+    #
+    # Returns true if the set is valid and can be used in this class
+    def valid?(set)
+      set.is_a?(Hash) && set['values'].is_a?(Hash)
+    end
+
+    # Determines if a new scope has precedence over an old one
+    #
+    # old_scope - the old scope hash, or nil if there's none
+    # new_scope - the new scope hash
+    #
+    # Returns true if the new scope has precedence over the older
+    def has_precedence?(old_scope, new_scope)
+      return true if old_scope.nil?
+
+      new_path = sanitize_path(new_scope['path'])
+      old_path = sanitize_path(old_scope['path'])
+
+      if new_path.length != old_path.length
+        new_path.length >= old_path.length
+      elsif new_scope.key? 'type'
+        true
+      else
+        !old_scope.key? 'type'
+      end
+    end
+
+    # Collects a list of sets that match the given path and type
+    #
+    # Returns an array of hashes
+    def matching_sets(path, type)
+      valid_sets.select do |set|
+        !set.key?('scope') || applies?(set['scope'], path, type)
+      end
+    end
+
+    # Returns a list of valid sets
+    #
+    # This is not cached to allow plugins to modify the configuration
+    # and have their changes take effect
+    #
+    # Returns an array of hashes
+    def valid_sets
+      sets = @site.config['defaults']
+      return [] unless sets.is_a?(Array)
+
+      sets.map do |set|
+        if valid?(set)
+          ensure_time!(update_deprecated_types(set))
+        else
+          Bunto.logger.warn "Defaults:", "An invalid front-matter default set was found:"
+          Bunto.logger.warn "#{set}"
+          nil
+        end
+      end.compact
+    end
+
+    # Sanitizes the given path by removing a leading and adding a trailing slash
+    def sanitize_path(path)
+      if path.nil? || path.empty?
+        ""
+      else
+        path.gsub(/\A\//, '').gsub(/([^\/])\z/, '\1')
+      end
+    end
+  end
+end

data/lib/bunto/generator.rb

@@ -0,0 +1,3 @@
+module Bunto
+  Generator = Class.new(Plugin)
+end

data/lib/bunto/hooks.rb

@@ -0,0 +1,101 @@
+module Bunto
+  module Hooks
+    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_render => [],
+        :post_write => []
+      },
+      :pages => {
+        :post_init => [],
+        :pre_render => [],
+        :post_render => [],
+        :post_write => []
+      },
+      :posts => {
+        :post_init => [],
+        :pre_render => [],
+        :post_render => [],
+        :post_write => []
+      },
+      :documents => {
+        :post_init => [],
+        :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)
+      @registry[owner] ||={
+        :post_init => [],
+        :pre_render => [],
+        :post_render => [],
+        :post_write => []
+      }
+
+      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 Bunto core components to trigger hooks
+    def self.trigger(owner, event, *args)
+      # proceed only if there are hooks to call
+      return unless @registry[owner]
+      return unless @registry[owner][event]
+
+      # hooks to call for this owner and event
+      hooks = @registry[owner][event]
+
+      # sort and call hooks according to priority and load order
+      hooks.sort_by { |h| @hook_priority[h] }.each do |hook|
+        hook.call(*args)
+      end
+    end
+  end
+end

data/lib/bunto/layout.rb

@@ -0,0 +1,49 @@
+module Bunto
+  class Layout
+    include Convertible
+
+    # Gets the Site object.
+    attr_reader :site
+
+    # Gets the name of this layout.
+    attr_reader :name
+
+    # Gets the path to this layout.
+    attr_reader :path
+
+    # Gets/Sets the extension of this layout.
+    attr_accessor :ext
+
+    # Gets/Sets the Hash that holds the metadata for this layout.
+    attr_accessor :data
+
+    # Gets/Sets the content of this layout.
+    attr_accessor :content
+
+    # Initialize a new Layout.
+    #
+    # site - The Site.
+    # base - The String path to the source.
+    # name - The String filename of the post file.
+    def initialize(site, base, name)
+      @site = site
+      @base = base
+      @name = name
+      @path = site.in_source_dir(base, name)
+
+      self.data = {}
+
+      process(name)
+      read_yaml(base, name)
+    end
+
+    # Extract information from the layout filename.
+    #
+    # name - The String filename of the layout file.
+    #
+    # Returns nothing.
+    def process(name)
+      self.ext = File.extname(name)
+    end
+  end
+end

data/lib/bunto/liquid_extensions.rb

@@ -0,0 +1,22 @@
+module Bunto
+  module LiquidExtensions
+
+    # Lookup a Liquid variable in the given context.
+    #
+    # context  - the Liquid context in question.
+    # variable - the variable name, as a string.
+    #
+    # Returns the value of the variable in the context
+    #   or the variable name if not found.
+    def lookup_variable(context, variable)
+      lookup = context
+
+      variable.split(".").each do |value|
+        lookup = lookup[value]
+      end
+
+      lookup || variable
+    end
+
+  end
+end

data/lib/bunto/liquid_renderer.rb

@@ -0,0 +1,39 @@
+require 'bunto/liquid_renderer/file'
+require 'bunto/liquid_renderer/table'
+
+module Bunto
+  class LiquidRenderer
+    def initialize(site)
+      @site = site
+      reset
+    end
+
+    def reset
+      @stats = {}
+    end
+
+    def file(filename)
+      filename = @site.in_source_dir(filename).sub(/\A#{Regexp.escape(@site.source)}\//, '')
+
+      LiquidRenderer::File.new(self, filename).tap do
+        @stats[filename] ||= {}
+        @stats[filename][:count] ||= 0
+        @stats[filename][:count] += 1
+      end
+    end
+
+    def increment_bytes(filename, bytes)
+      @stats[filename][:bytes] ||= 0
+      @stats[filename][:bytes] += bytes
+    end
+
+    def increment_time(filename, time)
+      @stats[filename][:time] ||= 0.0
+      @stats[filename][:time] += time
+    end
+
+    def stats_table(n = 50)
+      LiquidRenderer::Table.new(@stats).to_s(n)
+    end
+  end
+end

data/lib/bunto/liquid_renderer/file.rb

@@ -0,0 +1,50 @@
+module Bunto
+  class LiquidRenderer
+    class File
+      def initialize(renderer, filename)
+        @renderer = renderer
+        @filename = filename
+      end
+
+      def parse(content)
+        measure_time do
+          @template = Liquid::Template.parse(content, line_numbers: true)
+        end
+
+        self
+      end
+
+      def render(*args)
+        measure_time do
+          measure_bytes do
+            @template.render(*args)
+          end
+        end
+      end
+
+      def render!(*args)
+        measure_time do
+          measure_bytes do
+            @template.render!(*args)
+          end
+        end
+      end
+
+      private
+
+      def measure_bytes
+        yield.tap do |str|
+          @renderer.increment_bytes(@filename, str.bytesize)
+        end
+      end
+
+      def measure_time
+        before = Time.now
+        yield
+      ensure
+        after = Time.now
+        @renderer.increment_time(@filename, after - before)
+      end
+    end
+  end
+end