tigefa 1.0.0 → 1.1.1

data/lib/tigefa/plugin.rb

@@ -0,0 +1,75 @@
+module Tigefa
+  class Plugin
+    PRIORITIES = { :lowest => -100,
+                   :low => -10,
+                   :normal => 0,
+                   :high => 10,
+                   :highest => 100 }
+
+    # Install a hook so that subclasses are recorded. This method is only
+    # ever called by Ruby itself.
+    #
+    # base - The Class subclass.
+    #
+    # Returns nothing.
+    def self.inherited(base)
+      subclasses << base
+      subclasses.sort!
+    end
+
+    # The list of Classes that have been subclassed.
+    #
+    # Returns an Array of Class objects.
+    def self.subclasses
+      @subclasses ||= []
+    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.has_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
+
+    # 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/tigefa/post.rb

@@ -0,0 +1,312 @@
+module Tigefa
+  class Post
+    include Comparable
+    include Convertible
+
+    # Valid post name regex.
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+
+    EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
+      title
+      url
+      date
+      id
+      categories
+      next
+      previous
+      tags
+      path
+    ]
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
+      content
+      excerpt
+    ]
+
+    # 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, :published, :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 = self.containing_dir(source, dir)
+      @name = name
+
+      self.categories = dir.downcase.split('/').reject { |x| x.empty? }
+      self.process(name)
+      self.read_yaml(@base, name)
+
+      if self.data.has_key?('date')
+        self.date = Time.parse(self.data["date"].to_s)
+      end
+
+      self.published = self.published?
+
+      self.populate_categories
+      self.populate_tags
+    end
+
+    def published?
+      if self.data.has_key?('published') && self.data['published'] == false
+        false
+      else
+        true
+      end
+    end
+
+    def populate_categories
+      if self.categories.empty?
+        self.categories = self.data.pluralized_array('category', 'categories').map {|c| c.to_s.downcase}
+      end
+      self.categories.flatten!
+    end
+
+    def populate_tags
+      self.tags = self.data.pluralized_array("tag", "tags").flatten
+    end
+
+    # Get the full path to the directory containing the post files
+    def containing_dir(source, dir)
+      return File.join(source, 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 = self.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
+      self.data.fetch('excerpt', self.extracted_excerpt.to_s)
+    end
+
+    # Public: the Post title, from the YAML Front-Matter or from the slug
+    #
+    # Returns the post title
+    def title
+      self.data.fetch("title", self.titleized_slug)
+    end
+
+    # Turns the post slug into a suitable title
+    def titleized_slug
+      self.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
+      self.data.fetch('path', self.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)
+    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 = Time.parse(date)
+      self.slug = slug
+      self.ext = ext
+    rescue ArgumentError
+      raise FatalException.new("Post #{name} does not have a valid date.")
+    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
+      self.data && self.data['permalink']
+    end
+
+    def template
+      case self.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
+        self.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       => CGI.escape(slug),
+        :i_day       => date.strftime("%d").to_i.to_s,
+        :i_month     => date.strftime("%m").to_i.to_s,
+        :categories  => (categories || []).map { |c| URI.escape(c.to_s) }.join('/'),
+        :short_month => date.strftime("%b"),
+        :y_day       => date.strftime("%j"),
+        :output_ext  => self.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(self.dir, self.slug)
+    end
+
+    # Calculate related posts.
+    #
+    # Returns an Array of related Posts.
+    def related_posts(posts)
+      Jekyll::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 = {
+        "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
+        "page" => self.to_liquid(EXCERPT_ATTRIBUTES_FOR_LIQUID)
+      }.deep_merge(site_payload)
+
+      if generate_excerpt?
+        self.extracted_excerpt.do_layout(payload, {})
+      end
+
+      do_layout(payload.merge({"page" => self.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 = File.join(dest, File.expand_path(CGI.unescape(self.url), "/"))
+      path = File.join(path, "index.html") if path[/\.html$/].nil?
+      path
+    end
+
+    # Returns the shorthand String identifier of this Post.
+    def inspect
+      "<Post: #{self.id}>"
+    end
+
+    def next
+      pos = self.site.posts.index(self)
+
+      if pos && pos < self.site.posts.length-1
+        self.site.posts[pos+1]
+      else
+        nil
+      end
+    end
+
+    def previous
+      pos = self.site.posts.index(self)
+      if pos && pos > 0
+        self.site.posts[pos-1]
+      else
+        nil
+      end
+    end
+
+    protected
+
+    def extract_excerpt
+      if generate_excerpt?
+        Jekyll::Excerpt.new(self)
+      else
+        ""
+      end
+    end
+
+    def generate_excerpt?
+      !(site.config['excerpt_separator'].to_s.empty?)
+    end
+  end
+end

data/lib/tigefa/related_posts.rb

@@ -0,0 +1,59 @@
+module Tigefa
+  class RelatedPosts
+
+    class << self
+      attr_accessor :lsi
+    end
+
+    attr_reader :post, :site
+
+    def initialize(post)
+      @post = post
+      @site = post.site
+      require 'classifier' if site.lsi
+    end
+
+    def build
+      return [] unless self.site.posts.size > 1
+
+      if self.site.lsi
+        build_index
+        lsi_related_posts
+      else
+        most_recent_posts
+      end
+    end
+
+
+    def build_index
+      self.class.lsi ||= begin
+        lsi = Classifier::LSI.new(:auto_rebuild => false)
+        display("Populating LSI...")
+
+        self.site.posts.each do |x|
+          lsi.add_item(x)
+        end
+
+        display("Rebuilding index...")
+        lsi.build_index
+        display("")
+        lsi
+      end
+    end
+
+    def lsi_related_posts
+      self.class.lsi.find_related(post.content, 11) - [self.post]
+    end
+
+    def most_recent_posts
+      recent_posts = self.site.posts.reverse - [self.post]
+      recent_posts.first(10)
+    end
+
+    def display(output)
+      $stdout.print("\n")
+      $stdout.print(Jekyll.logger.formatted_topic(output))
+      $stdout.flush
+    end
+  end
+end