bunto 1.0.0

data/lib/bunto/page.rb

@@ -0,0 +1,180 @@
+module Bunto
+  class Page
+    include Convertible
+
+    attr_writer :dir
+    attr_accessor :site, :pager
+    attr_accessor :name, :ext, :basename
+    attr_accessor :data, :content, :output
+
+    alias_method :extname, :ext
+
+    FORWARD_SLASH = '/'.freeze
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = %w(
+      content
+      dir
+      name
+      path
+      url
+    )
+
+    # A set of extensions that are considered HTML or HTML-like so we
+    # should not alter them,  this includes .xhtml through XHTM5.
+
+    HTML_EXTENSIONS = %W(
+      .html
+      .xhtml
+      .htm
+    )
+
+    # Initialize a new Page.
+    #
+    # site - The Site object.
+    # base - The String path to the source.
+    # dir  - The String path between the source and the file.
+    # name - The String filename of the file.
+    def initialize(site, base, dir, name)
+      @site = site
+      @base = base
+      @dir  = dir
+      @name = name
+
+      process(name)
+      read_yaml(File.join(base, dir), name)
+
+      data.default_proc = proc do |_, key|
+        site.frontmatter_defaults.find(File.join(dir, name), type, key)
+      end
+
+      Bunto::Hooks.trigger :pages, :post_init, self
+    end
+
+    # The generated directory into which the page will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, we be '/'
+    #
+    # Returns the String destination directory.
+    def dir
+      if url.end_with?(FORWARD_SLASH)
+        url
+      else
+        url_dir = File.dirname(url)
+        url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
+      end
+    end
+
+    # The full path and filename of the post. Defined in the YAML of the post
+    # body.
+    #
+    # Returns the String permalink or nil if none has been set.
+    def permalink
+      data.nil? ? nil : data['permalink']
+    end
+
+    # The template of the permalink.
+    #
+    # Returns the template String.
+    def template
+      if !html?
+        "/:path/:basename:output_ext"
+      elsif index?
+        "/:path/"
+      else
+        Utils.add_permalink_suffix("/:path/:basename", site.permalink_style)
+      end
+    end
+
+    # The generated relative url of this page. e.g. /about.html.
+    #
+    # Returns the String url.
+    def url
+      @url ||= URL.new({
+        :template => template,
+        :placeholders => url_placeholders,
+        :permalink => permalink
+      }).to_s
+    end
+
+    # Returns a hash of URL placeholder names (as symbols) mapping to the
+    # desired placeholder replacements. For details see "url.rb"
+    def url_placeholders
+      {
+        :path       => @dir,
+        :basename   => basename,
+        :output_ext => output_ext
+      }
+    end
+
+    # Extract information from the page filename.
+    #
+    # name - The String filename of the page file.
+    #
+    # Returns nothing.
+    def process(name)
+      self.ext = File.extname(name)
+      self.basename = name[0..-ext.length - 1]
+    end
+
+    # Add any necessary layouts to this post
+    #
+    # layouts      - The Hash of {"name" => "layout"}.
+    # site_payload - The site payload Hash.
+    #
+    # Returns nothing.
+    def render(layouts, site_payload)
+      site_payload["page"] = to_liquid
+      site_payload["paginator"] = pager.to_liquid
+
+      do_layout(site_payload, layouts)
+    end
+
+    # The path to the source file
+    #
+    # Returns the path to the source file
+    def path
+      data.fetch('path') { relative_path.sub(/\A\//, '') }
+    end
+
+    # The path to the page source file, relative to the site source
+    def relative_path
+      File.join(*[@dir, @name].map(&:to_s).reject(&:empty?))
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns the destination file path String.
+    def destination(dest)
+      path = site.in_dest_dir(dest, URL.unescape_path(url))
+      path = File.join(path, "index") if url.end_with?("/")
+      path << output_ext unless path.end_with? output_ext
+      path
+    end
+
+    # Returns the object as a debug String.
+    def inspect
+      "#<Bunto:Page @name=#{name.inspect}>"
+    end
+
+    # Returns the Boolean of whether this Page is HTML or not.
+    def html?
+      HTML_EXTENSIONS.include?(output_ext)
+    end
+
+    # Returns the Boolean of whether this Page is an index file or not.
+    def index?
+      basename == 'index'
+    end
+
+    def trigger_hooks(hook_name, *args)
+      Bunto::Hooks.trigger :pages, hook_name, self, *args
+    end
+
+    def write?
+      true
+    end
+  end
+end

data/lib/bunto/plugin.rb

@@ -0,0 +1,96 @@
+module Bunto
+  class Plugin
+    PRIORITIES = {
+      :low => -10,
+      :highest => 100,
+      :lowest => -100,
+      :normal => 0,
+      :high => 10
+    }
+
+    #
+
+    def self.inherited(const)
+      return catch_inheritance(const) do |const_|
+        catch_inheritance(const_)
+      end
+    end
+
+    #
+
+    def self.catch_inheritance(const)
+      const.define_singleton_method :inherited do |const_|
+        (@children ||= Set.new).add const_
+        if block_given?
+          yield const_
+        end
+      end
+    end
+
+    #
+
+    def self.descendants
+      @children ||= Set.new
+      out = @children.map(&:descendants)
+      out << self unless superclass == Plugin
+      Set.new(out).flatten
+    end
+
+    # Get or set the priority of this plugin. When called without an
+    # argument it returns the priority. When an argument is given, it will
+    # set the priority.
+    #
+    # priority - The Symbol priority (default: nil). Valid options are:
+    #            :lowest, :low, :normal, :high, :highest
+    #
+    # Returns the Symbol priority.
+    def self.priority(priority = nil)
+      @priority ||= nil
+      if priority && PRIORITIES.key?(priority)
+        @priority = priority
+      end
+      @priority || :normal
+    end
+
+    # Get or set the safety of this plugin. When called without an argument
+    # it returns the safety. When an argument is given, it will set the
+    # safety.
+    #
+    # safe - The Boolean safety (default: nil).
+    #
+    # Returns the safety Boolean.
+    def self.safe(safe = nil)
+      if safe
+        @safe = safe
+      end
+      @safe || false
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # other - The class to be compared.
+    #
+    # Returns -1, 0, 1.
+    def self.<=>(other)
+      PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+    end
+
+    # Spaceship is priority [higher -> lower]
+    #
+    # other - The class to be compared.
+    #
+    # Returns -1, 0, 1.
+    def <=>(other)
+      self.class <=> other.class
+    end
+
+    # Initialize a new plugin. This should be overridden by the subclass.
+    #
+    # config - The Hash of configuration options.
+    #
+    # Returns a new instance.
+    def initialize(config = {})
+      # no-op for default
+    end
+  end
+end

data/lib/bunto/plugin_manager.rb

@@ -0,0 +1,95 @@
+module Bunto
+  class PluginManager
+    attr_reader :site
+
+    # Create an instance of this class.
+    #
+    # site - the instance of Bunto::Site we're concerned with
+    #
+    # Returns nothing
+    def initialize(site)
+      @site = site
+    end
+
+    # Require all the plugins which are allowed.
+    #
+    # Returns nothing
+    def conscientious_require
+      require_plugin_files
+      require_gems
+      deprecation_checks
+    end
+
+    # Require each of the gem plugins specified.
+    #
+    # Returns nothing.
+    def require_gems
+      Bunto::External.require_with_graceful_fail(site.gems.select { |gem| plugin_allowed?(gem) })
+    end
+
+    def self.require_from_bundler
+      if !ENV["BUNTO_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
+        require "bundler"
+        Bundler.setup # puts all groups on the load path
+        required_gems = Bundler.require(:bunto_plugins) # requires the gems in this group only
+        Bunto.logger.debug("PluginManager:", "Required #{required_gems.map(&:name).join(', ')}")
+        ENV["BUNTO_NO_BUNDLER_REQUIRE"] = "true"
+        true
+      else
+        false
+      end
+    rescue LoadError, Bundler::GemfileNotFound
+      false
+    end
+
+    # Check whether a gem plugin is allowed to be used during this build.
+    #
+    # gem_name - the name of the gem
+    #
+    # Returns true if the gem name is in the whitelist or if the site is not
+    #   in safe mode.
+    def plugin_allowed?(gem_name)
+      !site.safe || whitelist.include?(gem_name)
+    end
+
+    # Build an array of allowed plugin gem names.
+    #
+    # Returns an array of strings, each string being the name of a gem name
+    #   that is allowed to be used.
+    def whitelist
+      @whitelist ||= Array[site.config['whitelist']].flatten
+    end
+
+    # Require all .rb files if safe mode is off
+    #
+    # Returns nothing.
+    def require_plugin_files
+      unless site.safe
+        plugins_path.each do |plugin_search_path|
+          plugin_files = Utils.safe_glob(plugin_search_path, File.join("**", "*.rb"))
+          Bunto::External.require_with_graceful_fail(plugin_files)
+        end
+      end
+    end
+
+    # Public: Setup the plugin search path
+    #
+    # Returns an Array of plugin search paths
+    def plugins_path
+      if site.config['plugins_dir'] == Bunto::Configuration::DEFAULTS['plugins_dir']
+        [site.in_source_dir(site.config['plugins_dir'])]
+      else
+        Array(site.config['plugins_dir']).map { |d| File.expand_path(d) }
+      end
+    end
+
+    def deprecation_checks
+      pagination_included = (site.config['gems'] || []).include?('bunto-paginate') || defined?(Bunto::Paginate)
+      if site.config['paginate'] && !pagination_included
+        Bunto::Deprecator.deprecation_message "You appear to have pagination " \
+          "turned on, but you haven't included the `bunto-paginate` gem. " \
+          "Ensure you have `gems: [bunto-paginate]` in your configuration file."
+      end
+    end
+  end
+end

data/lib/bunto/post.rb

@@ -0,0 +1,329 @@
+module Bunto
+  class Post
+    include Comparable
+    include Convertible
+
+    # Valid post name regex.
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+
+    EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
+      title
+      url
+      dir
+      date
+      id
+      categories
+      next
+      previous
+      tags
+      path
+    ]
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
+      content
+      excerpt
+      excerpt_separator
+      draft?
+    ]
+
+    # Post name validator. Post filenames must be like:
+    # 2008-11-05-my-awesome-post.textile
+    #
+    # Returns true if valid, false if not.
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+
+    attr_accessor :site
+    attr_accessor :data, :extracted_excerpt, :content, :output, :ext
+    attr_accessor :date, :slug, :tags, :categories
+
+    attr_reader :name
+
+    # Initialize this Post instance.
+    #
+    # site       - The Site.
+    # base       - The String path to the dir containing the post file.
+    # name       - The String filename of the post file.
+    #
+    # Returns the new Post.
+    def initialize(site, source, dir, name)
+      @site = site
+      @dir = dir
+      @base = containing_dir(dir)
+      @name = name
+
+      self.categories = dir.split('/').reject { |x| x.empty? }
+      process(name)
+      read_yaml(@base, name)
+
+      data.default_proc = proc do |hash, key|
+        site.frontmatter_defaults.find(relative_path, type, key)
+      end
+
+      if data.key?('date')
+        self.date = Utils.parse_date(data["date"].to_s, "Post '#{relative_path}' does not have a valid date in the YAML front matter.")
+      end
+
+      populate_categories
+      populate_tags
+    end
+
+    def published?
+      if data.key?('published') && data['published'] == false
+        false
+      else
+        true
+      end
+    end
+
+    def populate_categories
+      categories_from_data = Utils.pluralized_array_from_hash(data, 'category', 'categories')
+      self.categories = (
+        Array(categories) + categories_from_data
+      ).map { |c| c.to_s }.flatten.uniq
+    end
+
+    def populate_tags
+      self.tags = Utils.pluralized_array_from_hash(data, "tag", "tags").flatten
+    end
+
+    # Get the full path to the directory containing the post files
+    def containing_dir(dir)
+      site.in_source_dir(dir, '_posts')
+    end
+
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      super(base, name)
+      self.extracted_excerpt = extract_excerpt
+    end
+
+    # The post excerpt. This is either a custom excerpt
+    # set in YAML front matter or the result of extract_excerpt.
+    #
+    # Returns excerpt string.
+    def excerpt
+      data.fetch('excerpt') { extracted_excerpt.to_s }
+    end
+
+    # Public: the Post title, from the YAML Front-Matter or from the slug
+    #
+    # Returns the post title
+    def title
+      data.fetch('title') { titleized_slug }
+    end
+
+    # Public: the Post excerpt_separator, from the YAML Front-Matter or site default
+    #         excerpt_separator value
+    #
+    # Returns the post excerpt_separator
+    def excerpt_separator
+      (data['excerpt_separator'] || site.config['excerpt_separator']).to_s
+    end
+
+    # Turns the post slug into a suitable title
+    def titleized_slug
+      slug.split('-').select {|w| w.capitalize! || w }.join(' ')
+    end
+
+    # Public: the path to the post relative to the site source,
+    #         from the YAML Front-Matter or from a combination of
+    #         the directory it's in, "_posts", and the name of the
+    #         post file
+    #
+    # Returns the path to the file relative to the site source
+    def path
+      data.fetch('path') { relative_path.sub(/\A\//, '') }
+    end
+
+    # The path to the post source file, relative to the site source
+    def relative_path
+      File.join(*[@dir, "_posts", @name].map(&:to_s).reject(&:empty?))
+    end
+
+    # Compares Post objects. First compares the Post date. If the dates are
+    # equal, it compares the Post slugs.
+    #
+    # other - The other Post we are comparing to.
+    #
+    # Returns -1, 0, 1
+    def <=>(other)
+      cmp = self.date <=> other.date
+      if 0 == cmp
+       cmp = self.slug <=> other.slug
+      end
+      return cmp
+    end
+
+    # Extract information from the post filename.
+    #
+    # name - The String filename of the post file.
+    #
+    # Returns nothing.
+    def process(name)
+      m, cats, date, slug, ext = *name.match(MATCHER)
+      self.date = Utils.parse_date(date, "Post '#{relative_path}' does not have a valid date in the filename.")
+      self.slug = slug
+      self.ext = ext
+    end
+
+    # The generated directory into which the post will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, set to the default date
+    # e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing.
+    #
+    # Returns the String directory.
+    def dir
+      File.dirname(url)
+    end
+
+    # The full path and filename of the post. Defined in the YAML of the post
+    # body (optional).
+    #
+    # Returns the String permalink.
+    def permalink
+      data && data['permalink']
+    end
+
+    def template
+      case site.permalink_style
+      when :pretty
+        "/:categories/:year/:month/:day/:title/"
+      when :none
+        "/:categories/:title.html"
+      when :date
+        "/:categories/:year/:month/:day/:title.html"
+      when :ordinal
+        "/:categories/:year/:y_day/:title.html"
+      else
+        site.permalink_style.to_s
+      end
+    end
+
+    # The generated relative url of this post.
+    #
+    # Returns the String url.
+    def url
+      @url ||= URL.new({
+        :template => template,
+        :placeholders => url_placeholders,
+        :permalink => permalink
+      }).to_s
+    end
+
+    # Returns a hash of URL placeholder names (as symbols) mapping to the
+    # desired placeholder replacements. For details see "url.rb"
+    def url_placeholders
+      {
+        :year        => date.strftime("%Y"),
+        :month       => date.strftime("%m"),
+        :day         => date.strftime("%d"),
+        :title       => slug,
+        :i_day       => date.strftime("%-d"),
+        :i_month     => date.strftime("%-m"),
+        :categories  => (categories || []).map { |c| c.to_s.downcase }.uniq.join('/'),
+        :short_month => date.strftime("%b"),
+        :short_year  => date.strftime("%y"),
+        :y_day       => date.strftime("%j"),
+        :output_ext  => output_ext
+      }
+    end
+
+    # The UID for this post (useful in feeds).
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns the String UID.
+    def id
+      File.join(dir, slug)
+    end
+
+    # Calculate related posts.
+    #
+    # Returns an Array of related Posts.
+    def related_posts(posts)
+      Bunto::RelatedPosts.new(self).build
+    end
+
+    # Add any necessary layouts to this post.
+    #
+    # layouts      - A Hash of {"name" => "layout"}.
+    # site_payload - The site payload hash.
+    #
+    # Returns nothing.
+    def render(layouts, site_payload)
+      # construct payload
+      payload = Utils.deep_merge_hashes({
+        "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
+        "page" => to_liquid(self.class::EXCERPT_ATTRIBUTES_FOR_LIQUID)
+      }, site_payload)
+
+      if generate_excerpt?
+        extracted_excerpt.do_layout(payload, {})
+      end
+
+      do_layout(payload.merge({"page" => to_liquid}), layouts)
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path String.
+    def destination(dest)
+      # The url needs to be unescaped in order to preserve the correct filename
+      path = site.in_dest_dir(dest, URL.unescape_path(url))
+      path = File.join(path, "index.html") if self.url.end_with?("/")
+      path << output_ext unless path.end_with?(output_ext)
+      path
+    end
+
+    # Returns the shorthand String identifier of this Post.
+    def inspect
+      "<Post: #{id}>"
+    end
+
+    def next
+      pos = site.posts.index {|post| post.equal?(self) }
+      if pos && pos < site.posts.length - 1
+        site.posts[pos + 1]
+      else
+        nil
+      end
+    end
+
+    def previous
+      pos = site.posts.index {|post| post.equal?(self) }
+      if pos && pos > 0
+        site.posts[pos - 1]
+      else
+        nil
+      end
+    end
+
+    # Returns if this Post is a Draft
+    def draft?
+      is_a?(Bunto::Draft)
+    end
+
+    protected
+
+    def extract_excerpt
+      if generate_excerpt?
+        Bunto::Excerpt.new(self)
+      else
+        ""
+      end
+    end
+
+    def generate_excerpt?
+      !excerpt_separator.empty?
+    end
+  end
+end