jekyll-reloaded 0.12

data/lib/jekyll/post.rb

@@ -0,0 +1,262 @@
+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
+    attr_accessor :content, :output, :ext
+    attr_accessor :date, :slug, :published, :tags, :categories
+
+    attr_reader :name, :data
+
+    # Initialize a new Post.
+    #
+    # site   - The Site object.
+    # source - 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, source, dir, name)
+      @site = site
+      @base = File.join(source, dir, '_posts')
+      @name = name
+      @categories = dir.split('/').reject { |x| x.empty? }
+
+      self.process(name)
+      self.read_yaml(@base, name)
+    end
+
+    # The source filename for this post.
+    def filename
+      File.join(@base, name)
+    end
+
+    # Save post data and extract various post properties from it.
+    def data=(data)
+      @data = data
+      return if data.nil?
+
+      # data can override the date from the filename
+      if data.has_key?('date')
+        self.date = Time.parse(data['date'].to_s)
+      end
+
+      self.published = data['published'] != false
+
+      self.tags = data.pluralized_array('tag', 'tags')
+
+      if self.categories.empty?
+        # TODO: merge with categories from path?
+        self.categories = data.pluralized_array('category', 'categories')
+      end
+
+      @data
+    end
+
+    # Spaceship is based on Post#date, slug
+    #
+    # 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+ is the String filename of the post file
+    #
+    # Returns nothing
+    def process(name)
+      _, date, self.slug, self.ext = *name.match(MATCHER)
+      self.date = Time.parse(date)
+    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 <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 @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) }.join('/'),
+          "output_ext" => self.output_ext
+        }.inject(template) { |result, token|
+          result.gsub(/:#{Regexp.escape token.first}/, token.last)
+        }.gsub(/\/\//, "/")
+      end
+
+      # sanitize url
+      @url = url.split('/').reject{ |part| part =~ /^\.+$/ }.join('/')
+      @url += "/" if url =~ /\/$/
+      @url
+    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
+      }.deep_merge(site_payload)
+
+      do_layout(payload, layouts)
+    end
+    
+    # Obtain destination path.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns destination file path.
+    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
+    end
+
+    # Write the generated post file to the destination directory.
+    #   +dest+ is the String path to the destination dir
+    #
+    # Returns nothing
+    def write(dest)
+      path = destination(dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      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
+      self.data.deep_merge({
+        "title"      => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+        "url"        => self.url,
+        "date"       => self.date,
+        "id"         => self.id,
+        "categories" => self.categories,
+        "next"       => self.next,
+        "previous"   => self.previous,
+        "tags"       => self.tags,
+        "content"    => self.content })
+    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

data/lib/jekyll/site.rb

@@ -0,0 +1,339 @@
+require 'set'
+
+module Jekyll
+
+  class Site
+    attr_accessor :config, :layouts, :posts, :pages, :static_files,
+                  :categories, :exclude, :include, :source, :dest, :lsi, :pygments,
+                  :permalink_style, :tags, :time, :future, :safe, :plugins, :limit_posts
+
+    attr_accessor :converters, :generators
+
+    # Public: Initialize a new Site.
+    #
+    # config - A Hash containing site configuration details.
+    def initialize(config)
+      self.config          = config.clone
+
+      self.safe            = config['safe']
+      self.source          = File.expand_path(config['source'])
+      self.dest            = File.expand_path(config['destination'])
+      self.plugins         = Array(config['plugins']).map { |d| File.expand_path(d) }
+      self.lsi             = config['lsi']
+      self.pygments        = config['pygments']
+      self.permalink_style = config['permalink'].to_sym
+      self.exclude         = config['exclude'] || []
+      self.include         = config['include'] || []
+      self.future          = config['future']
+      self.limit_posts     = config['limit_posts'] || nil
+
+      self.reset
+      self.setup
+    end
+
+    # Public: Read, process, and write this Site to output.
+    #
+    # Returns nothing.
+    def process
+      self.reset
+      self.read
+      self.generate
+      self.render
+      self.cleanup
+      self.write
+    end
+
+    # Reset Site details.
+    #
+    # Returns nothing
+    def reset
+      self.time            = if self.config['time']
+                               Time.parse(self.config['time'].to_s)
+                             else
+                               Time.now
+                             end
+      self.layouts         = {}
+      self.posts           = []
+      self.pages           = []
+      self.static_files    = []
+      self.categories      = Hash.new { |hash, key| hash[key] = [] }
+      self.tags            = Hash.new { |hash, key| hash[key] = [] }
+
+      if !self.limit_posts.nil? && self.limit_posts < 1
+        raise ArgumentError, "Limit posts must be nil or >= 1"
+      end
+    end
+
+    # Load necessary libraries, plugins, converters, and generators.
+    #
+    # Returns nothing.
+    def setup
+      require 'classifier' if self.lsi
+
+      # If safe mode is off, load in any Ruby files under the plugins
+      # directory.
+      unless self.safe
+        self.plugins.each do |plugins|
+            Dir[File.join(plugins, "**/*.rb")].each do |f|
+              require f
+            end
+        end
+      end
+
+      self.converters = Jekyll::Converter.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
+      end
+
+      self.generators = Jekyll::Generator.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
+      end
+    end
+
+    # Read Site data from disk and load it into internal data structures.
+    #
+    # Returns nothing.
+    def read
+      self.read_layouts
+      self.read_directories
+    end
+
+    # Read all the files in <source>/<dir>/_layouts and create a new Layout
+    # object with each one.
+    #
+    # Returns nothing.
+    def read_layouts(dir = '')
+      base = File.join(self.source, dir, "_layouts")
+      return unless File.exists?(base)
+      entries = []
+      Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }
+
+      entries.each do |f|
+        name = f.split(".")[0..-2].join(".")
+        self.layouts[name] = Layout.new(self, base, f)
+      end
+    end
+
+    # Recursively traverse directories to find posts, pages and static files
+    # that will become part of the site according to the rules in
+    # filter_entries.
+    #
+    # dir - The String relative path of the directory to read.
+    #
+    # Returns nothing.
+    def read_directories(dir = '')
+      base = File.join(self.source, dir)
+      entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) }
+
+      self.read_posts(dir)
+
+      entries.each do |f|
+        f_abs = File.join(base, f)
+        f_rel = File.join(dir, f)
+        if File.directory?(f_abs)
+          next if self.dest.sub(/\/$/, '') == f_abs
+          read_directories(f_rel)
+        elsif !File.symlink?(f_abs)
+          first3 = File.open(f_abs) { |fd| fd.read(3) }
+          if first3 == "---"
+            # file appears to have a YAML header so process it as a page
+            pages << Page.new(self, self.source, dir, f)
+          else
+            # otherwise treat it as a static file
+            static_files << StaticFile.new(self, self.source, dir, f)
+          end
+        end
+      end
+    end
+
+    # Read all the files in <source>/<dir>/_posts and create a new Post
+    # object with each one.
+    #
+    # dir - The String relative path of the directory to read.
+    #
+    # Returns nothing.
+    def read_posts(dir)
+      base = File.join(self.source, dir, '_posts')
+      return unless File.exists?(base)
+      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+
+      # first pass processes, but does not yet render post content
+      entries.each do |f|
+        if Post.valid?(f)
+          post = Post.new(self, self.source, dir, f)
+
+          if post.published && (self.future || post.date <= self.time)
+            self.posts << post
+            post.categories.each { |c| self.categories[c] << post }
+            post.tags.each { |c| self.tags[c] << post }
+          end
+        end
+      end
+
+      self.posts.sort!
+
+      # limit the posts if :limit_posts option is set
+      if limit_posts
+        limit = self.posts.length < limit_posts ? self.posts.length : limit_posts
+        self.posts = self.posts[-limit, limit]
+      end
+    end
+
+    # Run each of the Generators.
+    #
+    # Returns nothing.
+    def generate
+      self.generators.each do |generator|
+        generator.generate(self)
+      end
+    end
+
+    # Render the site to the destination.
+    #
+    # Returns nothing.
+    def render
+      payload = site_payload
+
+      self.posts.each do |post|
+        post.render(self.layouts, payload)
+      end
+
+      self.pages.each do |page|
+        page.render(self.layouts, payload)
+      end
+
+      self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a } }
+      self.tags.values.map { |ps| ps.sort! { |a, b| b <=> a } }
+    rescue Errno::ENOENT
+      # ignore missing layout dir
+    end
+
+    # Remove orphaned files and empty directories in destination.
+    #
+    # Returns nothing.
+    def cleanup
+      # all files and directories in destination, including hidden ones
+      dest_files = Set.new
+      Dir.glob(File.join(self.dest, "**", "*"), File::FNM_DOTMATCH) do |file|
+        dest_files << file unless file =~ /\/\.{1,2}$/
+      end
+
+      # files to be written
+      files = Set.new
+      self.posts.each do |post|
+        files << post.destination(self.dest)
+      end
+      self.pages.each do |page|
+        files << page.destination(self.dest)
+      end
+      self.static_files.each do |sf|
+        files << sf.destination(self.dest)
+      end
+
+      # adding files' parent directories
+      dirs = Set.new
+      files.each { |file| dirs << File.dirname(file) }
+      files.merge(dirs)
+
+      obsolete_files = dest_files - files
+
+      FileUtils.rm_rf(obsolete_files.to_a)
+    end
+
+    # Write static files, pages, and posts.
+    #
+    # Returns nothing.
+    def write
+      self.posts.each do |post|
+        post.write(self.dest)
+      end
+      self.pages.each do |page|
+        page.write(self.dest)
+      end
+      self.static_files.each do |sf|
+        sf.write(self.dest)
+      end
+    end
+
+    # Constructs a Hash of Posts indexed by the specified Post attribute.
+    #
+    # post_attr - The String name of the Post attribute.
+    #
+    # Examples
+    #
+    #   post_attr_hash('categories')
+    #   # => { 'tech' => [<Post A>, <Post B>],
+    #   #      'ruby' => [<Post B>] }
+    #
+    # Returns the Hash: { attr => posts } where
+    #   attr  - One of the values for the requested attribute.
+    #   posts - The Array of Posts with the given attr value.
+    def post_attr_hash(post_attr)
+      # Build a hash map based on the specified post attribute ( post attr =>
+      # array of posts ) then sort each array in reverse order.
+      hash = Hash.new { |hsh, key| hsh[key] = Array.new }
+      self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
+      hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a } }
+      hash
+    end
+
+    # The Hash payload containing site-wide data.
+    #
+    # Returns the Hash: { "site" => data } where data is a Hash with keys:
+    #   "time"       - The Time as specified in the configuration or the
+    #                  current time if none was specified.
+    #   "posts"      - The Array of Posts, sorted chronologically by post date
+    #                  and then title.
+    #   "pages"      - The Array of all Pages.
+    #   "html_pages" - The Array of HTML Pages.
+    #   "categories" - The Hash of category values and Posts.
+    #                  See Site#post_attr_hash for type info.
+    #   "tags"       - The Hash of tag values and Posts.
+    #                  See Site#post_attr_hash for type info.
+    def site_payload
+      {"site" => self.config.merge({
+          "time"       => self.time,
+          "posts"      => self.posts.sort { |a, b| b <=> a },
+          "pages"      => self.pages,
+          "html_pages" => self.pages.reject { |page| !page.html? },
+          "categories" => post_attr_hash('categories'),
+          "tags"       => post_attr_hash('tags')})}
+    end
+
+    # Filter out any files/directories that are hidden or backup files (start
+    # with "." or "#" or end with "~"), or contain site content (start with "_"),
+    # or are excluded in the site configuration, unless they are web server
+    # files such as '.htaccess'.
+    #
+    # entries - The Array of file/directory entries to filter.
+    #
+    # Returns the Array of filtered entries.
+    def filter_entries(entries)
+      entries = entries.reject do |e|
+        unless self.include.include?(e)
+          ['.', '_', '#'].include?(e[0..0]) ||
+          e[-1..-1] == '~' ||
+          self.exclude.include?(e) ||
+          File.symlink?(e)
+        end
+      end
+    end
+
+    # Get the implementation class for the given Converter.
+    #
+    # klass - The Class of the Converter to fetch.
+    #
+    # Returns the Converter instance implementing the given Converter.
+    def getConverterImpl(klass)
+      matches = self.converters.select { |c| c.class == klass }
+      if impl = matches.first
+        impl
+      else
+        raise "Converter implementation not found for #{klass}"
+      end
+    end
+  end
+end

data/lib/jekyll/static_file.rb

@@ -0,0 +1,77 @@
+module Jekyll
+
+  class StaticFile
+    # The cache of last modification times [path] -> mtime.
+    @@mtimes = Hash.new
+
+    # Initialize a new StaticFile.
+    #
+    # site - The Site.
+    # base - The String path to the <source>.
+    # dir  - The String path between <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
+    end
+
+    # Returns source file path.
+    def path
+      File.join(@base, @dir, @name)
+    end
+    alias filename path
+
+    def inspect
+      "<StaticFile: #{self.path}>"
+    end
+
+    # Obtain destination path.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path.
+    def destination(dest)
+      File.join(dest, @dir, @name)
+    end
+
+    # Returns last modification time for this file.
+    def mtime
+      File.stat(path).mtime.to_i
+    end
+
+    # Is source path modified?
+    #
+    # Returns true if modified since last write.
+    def modified?
+      @@mtimes[path] != mtime
+    end
+
+    # Write the static file to the destination directory (if modified).
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns false if the file was not modified since last time (no-op).
+    def write(dest)
+      dest_path = destination(dest)
+
+      return false if File.exist?(dest_path) and !modified?
+      @@mtimes[path] = mtime
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.cp(path, dest_path)
+
+      true
+    end
+
+    # Reset the mtimes cache (for testing purposes).
+    #
+    # Returns nothing.
+    def self.reset_cache
+      @@mtimes = Hash.new
+      nil
+    end
+  end
+
+end