tkmr-jekyll 0.5.1

data/lib/jekyll/convertible.rb

@@ -0,0 +1,82 @@
+# Convertible provides methods for converting a pagelike item
+# from a certain type of markup into actual content
+#
+# Requires
+#   self.site -> Jekyll::Site
+module Jekyll
+  module Convertible
+    # Return the contents as a string
+    def to_s
+      self.content || ''
+    end
+
+    # Read the YAML frontmatter
+    #   +base+ is the String path to the dir containing the file
+    #   +name+ is the String filename of the file
+    #
+    # Returns nothing
+    def read_yaml(base, name)
+      self.content = File.read(File.join(base, name))
+
+      if self.content =~ /^(---\s*\n.*?)\n---\s*\n/m
+        self.content = self.content[($1.size + 5)..-1]
+
+        self.data = YAML.load($1)
+      end
+    end
+
+    # Transform the contents based on the file extension.
+    #
+    # Returns nothing
+    def transform
+      case self.content_type
+      when 'textile'
+        self.ext = ".html"
+        self.content = self.site.textile(self.content)
+      when 'markdown'
+        self.ext = ".html"
+        self.content = self.site.markdown(self.content)
+      end
+    end
+
+    # Determine which formatting engine to use based on this convertible's
+    # extension
+    #
+    # Returns one of :textile, :markdown or :unknown
+    def content_type
+      case self.ext[1..-1]
+      when /textile/i
+        return 'textile'
+      when /markdown/i, /mkdn/i, /md/i
+        return 'markdown'
+      end
+      return 'unknown'
+    end
+
+    # Add any necessary layouts to this convertible document
+    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +site_payload+ is the site payload hash
+    #
+    # Returns nothing
+    def do_layout(payload, layouts)
+      info = { :filters => [Jekyll::Filters], :registers => { :site => self.site } }
+
+      # render and transform content (this becomes the final content of the object)
+      payload["content_type"] = self.content_type
+      self.content = Liquid::Template.parse(self.content).render(payload, info)
+      self.transform
+
+      # output keeps track of what will finally be written
+      self.output = self.content
+
+      # recursively render layouts
+      layout = layouts[self.data["layout"]]
+      while layout
+        payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
+        self.output = Liquid::Template.parse(layout.content).render(payload, info)
+
+        layout = layouts[layout.data["layout"]]
+      end
+    end
+  end
+end

data/lib/jekyll/core_ext.rb

@@ -0,0 +1,22 @@
+class Hash
+  # Merges self with another hash, recursively.
+  #
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  #
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+
+      target[key] = hash[key]
+    end
+
+    target
+  end
+end

data/lib/jekyll/filters.rb

@@ -0,0 +1,47 @@
+module Jekyll
+
+  module Filters
+    def textilize(input)
+      RedCloth.new(input).to_html
+    end
+
+    def date_to_string(date)
+      date.strftime("%d %b %Y")
+    end
+
+    def date_to_long_string(date)
+      date.strftime("%d %B %Y")
+    end
+
+    def date_to_xmlschema(date)
+      date.xmlschema
+    end
+
+    def xml_escape(input)
+      CGI.escapeHTML(input)
+    end
+
+    def cgi_escape(input)
+      CGI::escape(input)
+    end
+
+    def number_of_words(input)
+      input.split.length
+    end
+
+    def array_to_sentence_string(array)
+      connector = "and"
+      case array.length
+      when 0
+        ""
+      when 1
+        array[0].to_s
+      when 2
+        "#{array[0]} #{connector} #{array[1]}"
+      else
+        "#{array[0...-1].join(', ')}, #{connector} #{array[-1]}"
+      end
+    end
+
+  end
+end

data/lib/jekyll/layout.rb

@@ -0,0 +1,36 @@
+module Jekyll
+
+  class Layout
+    include Convertible
+
+    attr_accessor :site
+    attr_accessor :ext
+    attr_accessor :data, :content
+
+    # Initialize a new Layout.
+    #   +site+ is the Site
+    #   +base+ is the String path to the <source>
+    #   +name+ is the String filename of the post file
+    #
+    # Returns <Page>
+    def initialize(site, base, name)
+      @site = site
+      @base = base
+      @name = name
+
+      self.data = {}
+
+      self.process(name)
+      self.read_yaml(base, name)
+    end
+
+    # Extract information from the layout filename
+    #   +name+ is the String filename of the layout file
+    #
+    # Returns nothing
+    def process(name)
+      self.ext = File.extname(name)
+    end
+  end
+
+end

data/lib/jekyll/page.rb

@@ -0,0 +1,70 @@
+module Jekyll
+
+  class Page
+    include Convertible
+
+    attr_accessor :site
+    attr_accessor :ext
+    attr_accessor :data, :content, :output
+
+    # Initialize a new Page.
+    #   +site+ is the Site
+    #   +base+ is the String path to the <source>
+    #   +dir+ is the String path between <source> and the file
+    #   +name+ is the String filename of the file
+    #
+    # Returns <Page>
+    def initialize(site, base, dir, name)
+      @site = site
+      @base = base
+      @dir = dir
+      @name = name
+
+      self.data = {}
+
+      self.process(name)
+      self.read_yaml(File.join(base, dir), name)
+      #self.transform
+    end
+
+    # Extract information from the page filename
+    #   +name+ is the String filename of the page file
+    #
+    # Returns nothing
+    def process(name)
+      self.ext = File.extname(name)
+    end
+
+    # Add any necessary layouts to this post
+    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +site_payload+ is the site payload hash
+    #
+    # Returns nothing
+    def render(layouts, site_payload)
+      payload = {"page" => self.data}.deep_merge(site_payload)
+      do_layout(payload, layouts)
+    end
+
+    # Write the generated page file to the destination directory.
+    #   +dest_prefix+ is the String path to the destination dir
+    #   +dest_suffix+ is a suffix path to the destination dir
+    #
+    # Returns nothing
+    def write(dest_prefix, dest_suffix = nil)
+      dest = File.join(dest_prefix, @dir)
+      dest = File.join(dest, dest_suffix) if dest_suffix
+      FileUtils.mkdir_p(dest)
+
+      name = @name
+      if self.ext != ""
+        name = @name.split(".")[0..-2].join('.') + self.ext
+      end
+
+      path = File.join(dest, name)
+      File.open(path, 'w') do |f|
+        f.write(self.output)
+      end
+    end
+  end
+
+end

data/lib/jekyll/pager.rb

@@ -0,0 +1,45 @@
+module Jekyll
+  class Pager
+    attr_reader :page, :per_page, :posts, :total_posts, :total_pages, :previous_page, :next_page
+    
+    def self.calculate_pages(all_posts, per_page)
+      num_pages = all_posts.size / per_page.to_i
+      num_pages.abs + 1 if all_posts.size % per_page.to_i != 0
+      num_pages
+    end
+    
+    def self.pagination_enabled?(config, file)
+      file == 'index.html' && !config['paginate'].nil?
+    end
+    
+    def initialize(config, page, all_posts, num_pages = nil)
+      @page = page
+      @per_page = config['paginate'].to_i
+      @total_pages = num_pages || Pager.calculate_pages(all_posts, @per_page)
+      
+      if @page > @total_pages
+        raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
+      end
+      
+      init = (@page - 1) * @per_page
+      offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
+      
+      @total_posts = all_posts.size
+      @posts = all_posts[init..offset]
+      @previous_page = @page != 1 ? @page - 1 : nil
+      @next_page = @page != @total_pages ? @page + 1 : nil
+    end
+    
+    def to_hash
+      {
+        'page' => page, 
+        'per_page' => per_page, 
+        'posts' => posts, 
+        'total_posts' => total_posts,
+        'total_pages' => total_pages,
+        'previous_page' => previous_page,
+        'next_page' => next_page
+      }
+    end
+  end
+end

data/lib/jekyll/post.rb

@@ -0,0 +1,243 @@
+module Jekyll
+
+  class Post
+    include Comparable
+    include Convertible
+
+    class << self
+      attr_accessor :lsi
+    end
+
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+
+    # Post name validator. Post filenames must be like:
+    #   2008-11-05-my-awesome-post.textile
+    #
+    # Returns <Bool>
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+
+    attr_accessor :site, :date, :slug, :ext, :topics, :published, :data, :content, :output
+    attr_writer :categories
+
+    def categories
+      @categories ||= []
+    end
+
+    # Initialize this Post instance.
+    #   +site+ is the Site
+    #   +base+ is the String path to the dir containing the post file
+    #   +name+ is the String filename of the post file
+    #   +categories+ is an Array of Strings for the categories for this post
+    #
+    # Returns <Post>
+    def initialize(site, source, dir, name)
+      @site = site
+      @base = File.join(source, dir, '_posts')
+      @name = name
+
+      self.categories = dir.split('/').reject { |x| x.empty? }
+
+      parts = name.split('/')
+      self.topics = parts.size > 1 ? parts[0..-2] : []
+
+      self.process(name)
+      self.read_yaml(@base, name)
+
+      if self.data.has_key?('published') && self.data['published'] == false
+        self.published = false
+      else
+        self.published = true
+      end
+
+      if self.categories.empty?
+        if self.data.has_key?('category')
+          self.categories << self.data['category']
+        elsif self.data.has_key?('categories')
+          # Look for categories in the YAML-header, either specified as
+          # an array or a string.
+          if self.data['categories'].kind_of? String
+            self.categories = self.data['categories'].split
+          else
+            self.categories = self.data['categories']
+          end
+        end
+      end
+    end
+
+    # Spaceship is based on Post#date
+    #
+    # Returns -1, 0, 1
+    def <=>(other)
+      self.date <=> other.date
+    end
+
+    # Extract information from the post filename
+    #   +name+ is 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
+    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 <String>
+    def dir
+      File.dirname(url)
+    end
+
+    # The full path and filename of the post.
+    # Defined in the YAML of the post body
+    # (Optional)
+    #
+    # Returns <String>
+    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"
+      else
+        self.site.permalink_style.to_s
+      end
+    end
+
+    # The generated relative url of this post
+    # e.g. /2008/11/05/my-awesome-post.html
+    #
+    # Returns <String>
+    def url
+      return permalink if permalink
+
+      @url ||= {
+        "year"       => date.strftime("%Y"),
+        "month"      => date.strftime("%m"),
+        "day"        => date.strftime("%d"),
+        "title"      => CGI.escape(slug),
+        "categories" => categories.sort.join('/')
+      }.inject(template) { |result, token|
+        result.gsub(/:#{token.first}/, token.last)
+      }.gsub(/\/\//, "/")
+    end
+
+    # The UID for this post (useful in feeds)
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns <String>
+    def id
+      File.join(self.dir, self.slug)
+    end
+
+    # Calculate related posts.
+    #
+    # Returns [<Post>]
+    def related_posts(posts)
+      return [] unless posts.size > 1
+
+      if self.site.lsi
+        self.class.lsi ||= begin
+          puts "Running the classifier... this could take a while."
+          lsi = Classifier::LSI.new
+          posts.each { |x| $stdout.print(".");$stdout.flush;lsi.add_item(x) }
+          puts ""
+          lsi
+        end
+
+        related = self.class.lsi.find_related(self.content, 11)
+        related - [self]
+      else
+        (posts - [self])[0..9]
+      end
+    end
+
+    # Add any necessary layouts to this post
+    #   +layouts+ is a Hash of {"name" => "layout"}
+    #   +site_payload+ is 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
+      }
+      payload = payload.deep_merge(site_payload)
+
+      do_layout(payload, layouts)
+    end
+
+    # Write the generated post file to the destination directory.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      FileUtils.mkdir_p(File.join(dest, dir))
+
+      # The url needs to be unescaped in order to preserve the correct filename
+      path = File.join(dest, CGI.unescape(self.url))
+
+      if template[/\.html$/].nil?
+        FileUtils.mkdir_p(path)
+        path = File.join(path, "index.html")
+      end
+
+      File.open(path, 'w') do |f|
+        f.write(self.output)
+      end
+    end
+
+    # Convert this post into a Hash for use in Liquid templates.
+    #
+    # Returns <Hash>
+    def to_liquid
+      { "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+        "url" => self.url,
+        "date" => self.date,
+        "id" => self.id,
+        "topics" => self.topics,
+        "categories" => self.categories,
+        "next" => self.next,
+        "previous" => self.previous,
+        "content" => self.content }.deep_merge(self.data)
+    end
+
+    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
+  end
+
+end