monad 0.0.2 → 0.0.3

data/lib/{monad → jekyll}/layout.rb

@@ -1,10 +1,13 @@
-module Monad
+module Jekyll
   class Layout
     include Convertible
 
     # Gets the Site object.
     attr_reader :site
 
+    # Gets the name of this layout.
+    attr_reader :name
+
     # Gets/Sets the extension of this layout.
     attr_accessor :ext
 

data/lib/{monad → jekyll}/page.rb

@@ -1,4 +1,4 @@
-module Monad
+module Jekyll
   class Page
     include Convertible
 
@@ -7,6 +7,13 @@ module Monad
     attr_accessor :name, :ext, :basename
     attr_accessor :data, :content, :output
 
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = %w[
+      url
+      content
+      path
+    ]
+
     # Initialize a new Page.
     #
     # site - The Site object.
@@ -37,7 +44,12 @@ module Monad
     #
     # Returns the String permalink or nil if none has been set.
     def permalink
-      self.data && self.data['permalink']
+      return nil if self.data.nil? || self.data['permalink'].nil?
+      if site.config['relative_permalinks']
+        File.join(@dir, self.data['permalink'])
+      else
+        self.data['permalink']
+      end
     end
 
     # The template of the permalink.
@@ -61,29 +73,21 @@ module Monad
     #
     # Returns the String url.
     def url
-      return @url if @url
-
-      url = if permalink
-        if site.config['relative_permalinks']
-          File.join(@dir, permalink)
-        else
-          permalink
-        end
-      else
-        {
-          "path"       => @dir,
-          "basename"   => self.basename,
-          "output_ext" => self.output_ext,
-        }.inject(template) { |result, token|
-          result.gsub(/:#{token.first}/, token.last)
-        }.gsub(/\/\//, "/")
-      end
+      @url ||= URL.new({
+        :template => template,
+        :placeholders => url_placeholders,
+        :permalink => permalink
+      }).to_s
+    end
 
-      # sanitize url
-      @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
-      @url += "/" if url =~ /\/$/
-      @url.gsub!(/\A([^\/])/, '/\1')
-      @url
+    # 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   => self.basename,
+        :output_ext => self.output_ext
+      }
     end
 
     # Extract information from the page filename.
@@ -111,21 +115,16 @@ module Monad
       do_layout(payload, layouts)
     end
 
-    # Convert this Page's data to a Hash suitable for use by Liquid.
-    #
-    # Returns the Hash representation of this Page.
-    def to_liquid
-      self.data.deep_merge({
-        "url"        => self.url,
-        "content"    => self.content,
-        "path"       => self.data['path'] || path })
-    end
-
     # The path to the source file
     #
     # Returns the path to the source file
     def path
-      File.join(@dir, @name).sub(/\A\//, '')
+      self.data.fetch('path', self.relative_path.sub(/\A\//, ''))
+    end
+
+    # The path to the page source file, relative to the site source
+    def relative_path
+      File.join(@dir, @name)
     end
 
     # Obtain destination path.
@@ -134,16 +133,14 @@ module Monad
     #
     # Returns the destination file path String.
     def destination(dest)
-      # The url needs to be unescaped in order to preserve the correct
-      # filename.
-      path = File.join(dest, CGI.unescape(self.url))
+      path = File.join(dest, self.url)
       path = File.join(path, "index.html") if self.url =~ /\/$/
       path
     end
 
     # Returns the object as a debug String.
     def inspect
-      "#<Monad:Page @name=#{self.name.inspect}>"
+      "#<Jekyll:Page @name=#{self.name.inspect}>"
     end
 
     # Returns the Boolean of whether this Page is HTML or not.

data/lib/{monad → jekyll}/plugin.rb

@@ -1,4 +1,4 @@
-module Monad
+module Jekyll
   class Plugin
     PRIORITIES = { :lowest => -100,
                    :low => -10,

data/lib/{monad → jekyll}/post.rb

@@ -1,17 +1,12 @@
-module Monad
+module Jekyll
   class Post
     include Comparable
     include Convertible
 
-    class << self
-      attr_accessor :lsi
-    end
-
     # Valid post name regex.
     MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
 
-    # Attributes for Liquid templates
-    ATTRIBUTES_FOR_LIQUID = %w[
+    EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
       title
       url
       date
@@ -20,9 +15,13 @@ module Monad
       next
       previous
       tags
+      path
+    ]
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
       content
       excerpt
-      path
     ]
 
     # Post name validator. Post filenames must be like:
@@ -106,18 +105,19 @@ module Monad
     #
     # Returns excerpt string.
     def excerpt
-      if self.data.has_key? 'excerpt'
-        self.data['excerpt']
-      else
-        self.extracted_excerpt
-      end
+      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["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' ')
+      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,
@@ -127,7 +127,12 @@ module Monad
     #
     # Returns the path to the file relative to the site source
     def path
-      self.data['path'] || File.join(@dir, '_posts', @name).sub(/\A\//, '')
+      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
@@ -158,14 +163,6 @@ module Monad
       raise FatalException.new("Post #{name} does not have a valid date.")
     end
 
-    # Transform the contents and excerpt based on the content type.
-    #
-    # Returns nothing.
-    def transform
-      super
-      self.extracted_excerpt = converter.convert(self.extracted_excerpt)
-    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
@@ -200,36 +197,31 @@ module Monad
     end
 
     # The generated relative url of this post.
-    # e.g. /2008/11/05/my-awesome-post.html
     #
-    # Returns the String URL.
+    # Returns the String url.
     def url
-      return @url if @url
-
-      url = if permalink
-        permalink
-      else
-        {
-          "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
-        }.inject(template) { |result, token|
-          result.gsub(/:#{Regexp.escape token.first}/, token.last)
-        }.gsub(/\/\//, "/")
-      end
+      @url ||= URL.new({
+        :template => template,
+        :placeholders => url_placeholders,
+        :permalink => permalink
+      }).to_s
+    end
 
-      # sanitize url
-      @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
-      @url += "/" if url =~ /\/$/
-      @url.gsub!(/\A([^\/])/, '/\1')
-      @url
+    # 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).
@@ -244,29 +236,7 @@ module Monad
     #
     # Returns an Array of related Posts.
     def related_posts(posts)
-      return [] unless posts.size > 1
-
-      if self.site.lsi
-        build_index
-
-        related = self.class.lsi.find_related(self.content, 11)
-        related - [self]
-      else
-        (posts - [self])[0..9]
-      end
-    end
-
-    def build_index
-      self.class.lsi ||= begin
-        puts "Starting the classifier..."
-        lsi = Classifier::LSI.new(:auto_rebuild => false)
-        $stdout.print("  Populating LSI... "); $stdout.flush
-        self.site.posts.each { |x| $stdout.print("."); $stdout.flush; lsi.add_item(x) }
-        $stdout.print("\n  Rebuilding LSI index... ")
-        lsi.build_index
-        puts ""
-        lsi
-      end
+      Jekyll::RelatedPosts.new(self).build
     end
 
     # Add any necessary layouts to this post.
@@ -279,10 +249,14 @@ module Monad
       # construct payload
       payload = {
         "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
-        "page" => self.to_liquid
+        "page" => self.to_liquid(EXCERPT_ATTRIBUTES_FOR_LIQUID)
       }.deep_merge(site_payload)
 
-      do_layout(payload, layouts)
+      if generate_excerpt?
+        self.extracted_excerpt.do_layout(payload, {})
+      end
+
+      do_layout(payload.merge({"page" => self.to_liquid}), layouts)
     end
 
     # Obtain destination path.
@@ -293,20 +267,10 @@ module Monad
     def destination(dest)
       # The url needs to be unescaped in order to preserve the correct filename
       path = File.join(dest, CGI.unescape(self.url))
-      path = File.join(path, "index.html") if template[/\.html$/].nil?
+      path = File.join(path, "index.html") if path[/\.html$/].nil?
       path
     end
 
-    # Convert this post into a Hash for use in Liquid templates.
-    #
-    # Returns the representative Hash.
-    def to_liquid
-      further_data = Hash[ATTRIBUTES_FOR_LIQUID.map { |attribute|
-        [attribute, send(attribute)]
-      }]
-      data.deep_merge(further_data)
-    end
-
     # Returns the shorthand String identifier of this Post.
     def inspect
       "<Post: #{self.id}>"
@@ -333,45 +297,16 @@ module Monad
 
     protected
 
-    # Internal: Extract excerpt from the content
-    #
-    # By default excerpt is your first paragraph of a post: everything before
-    # the first two new lines:
-    #
-    #     ---
-    #     title: Example
-    #     ---
-    #
-    #     First paragraph with [link][1].
-    #
-    #     Second paragraph.
-    #
-    #     [1]: http://example.com/
-    #
-    # This is fairly good option for Markdown and Textile files. But might cause
-    # problems for HTML posts (which is quite unusual for Monad). If default
-    # excerpt delimiter is not good for you, you might want to set your own via
-    # configuration option `excerpt_separator`. For example, following is a good
-    # alternative for HTML posts:
-    #
-    #     # file: _config.yml
-    #     excerpt_separator: "<!-- more -->"
-    #
-    # Notice that all markdown-style link references will be appended to the
-    # excerpt. So the example post above will have this excerpt source:
-    #
-    #     First paragraph with [link][1].
-    #
-    #     [1]: http://example.com/
-    #
-    # Excerpts are rendered same time as content is rendered.
-    #
-    # Returns excerpt String
     def extract_excerpt
-      separator     = self.site.config['excerpt_separator']
-      head, _, tail = self.content.partition(separator)
+      if generate_excerpt?
+        Jekyll::Excerpt.new(self)
+      else
+        ""
+      end
+    end
 
-      "" << head << "\n\n" << tail.scan(/^\[[^\]]+\]:.+$/).join("\n")
+    def generate_excerpt?
+      !(site.config['excerpt_separator'].to_s.empty?)
     end
   end
 end

data/lib/jekyll/related_posts.rb

@@ -0,0 +1,59 @@
+module Jekyll
+  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