jekyll 0.5.7 → 0.6.0

data/lib/jekyll/{converters → migrators}/wordpress.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'sequel'
 require 'fileutils'
+require 'yaml'
 
 # NOTE: This converter requires Sequel and the MySQL gems.
 # The MySQL gem can be difficult to install on OS X. Once you have MySQL

data/lib/jekyll/page.rb

@@ -3,7 +3,7 @@ module Jekyll
   class Page
     include Convertible
 
-    attr_accessor :site
+    attr_accessor :site, :pager
     attr_accessor :name, :ext, :basename, :dir
     attr_accessor :data, :content, :output
 
@@ -43,10 +43,10 @@ module Jekyll
     end
 
     def template
-      if self.site.permalink_style == :pretty && !index?
-        "/:name/"
+      if self.site.permalink_style == :pretty && !index? && html?
+        "/:basename/"
       else
-        "/:name.html"
+        "/:basename:output_ext"
       end
     end
 
@@ -57,7 +57,12 @@ module Jekyll
     def url
       return permalink if permalink
 
-      @url ||= (ext == '.html') ? template.gsub(':name', basename) : "/#{name}"
+      @url ||= {
+        "basename"   => self.basename,
+        "output_ext" => self.output_ext,
+      }.inject(template) { |result, token|
+        result.gsub(/:#{token.first}/, token.last)
+      }.gsub(/\/\//, "/")
     end
 
     # Extract information from the page filename
@@ -75,10 +80,20 @@ module Jekyll
     #
     # Returns nothing
     def render(layouts, site_payload)
-      payload = {"page" => self.data}.deep_merge(site_payload)
+      payload = {
+        "page" => self.to_liquid,
+        'paginator' => pager.to_liquid
+      }.deep_merge(site_payload)
+
       do_layout(payload, layouts)
     end
 
+    def to_liquid
+      self.data.deep_merge({
+        "url"        => self.url,
+        "content"    => self.content })
+    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
@@ -91,7 +106,7 @@ module Jekyll
 
       # The url needs to be unescaped in order to preserve the correct filename
       path = File.join(dest, CGI.unescape(self.url))
-      if self.ext == '.html' && self.url[/\.html$/].nil?
+      if self.url =~ /\/$/
         FileUtils.mkdir_p(path)
         path = File.join(path, "index.html")
       end
@@ -105,11 +120,13 @@ module Jekyll
       "#<Jekyll:Page @name=#{self.name.inspect}>"
     end
 
-    private
+    def html?
+      output_ext == '.html'
+    end
 
-      def index?
-        basename == 'index'
-      end
+    def index?
+      basename == 'index'
+    end
 
   end
 

data/lib/jekyll/plugin.rb

@@ -0,0 +1,76 @@
+module Jekyll
+
+  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)
+      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/jekyll/post.rb

@@ -124,9 +124,12 @@ module Jekyll
         "month"      => date.strftime("%m"),
         "day"        => date.strftime("%d"),
         "title"      => CGI.escape(slug),
-        "categories" => categories.sort.join('/')
+        "i_day"      => date.strftime("%d").to_i.to_s,
+        "i_month"    => date.strftime("%m").to_i.to_s,
+        "categories" => categories.join('/'),
+        "output_ext" => self.output_ext
       }.inject(template) { |result, token|
-        result.gsub(/:#{token.first}/, token.last)
+        result.gsub(/:#{Regexp.escape token.first}/, token.last)
       }.gsub(/\/\//, "/")
     end
 
@@ -167,12 +170,10 @@ module Jekyll
     # Returns nothing
     def render(layouts, site_payload)
       # construct payload
-      payload =
-      {
+      payload = {
         "site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
         "page" => self.to_liquid
-      }
-      payload = payload.deep_merge(site_payload)
+      }.deep_merge(site_payload)
 
       do_layout(payload, layouts)
     end
@@ -201,7 +202,8 @@ module Jekyll
     #
     # Returns <Hash>
     def to_liquid
-      { "title"      => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+      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,
@@ -209,7 +211,7 @@ module Jekyll
         "next"       => self.next,
         "previous"   => self.previous,
         "tags"       => self.tags,
-        "content"    => self.content }.deep_merge(self.data)
+        "content"    => self.content })
     end
 
     def inspect

data/lib/jekyll/site.rb

@@ -1,8 +1,10 @@
 module Jekyll
 
   class Site
-    attr_accessor :config, :layouts, :posts, :pages, :static_files, :categories, :exclude,
-                  :source, :dest, :lsi, :pygments, :permalink_style, :tags
+    attr_accessor :config, :layouts, :posts, :pages, :static_files,
+                  :categories, :exclude, :source, :dest, :lsi, :pygments,
+                  :permalink_style, :tags, :time, :future, :safe, :plugins
+    attr_accessor :converters, :generators
 
     # Initialize the site
     #   +config+ is a Hash containing site configurations details
@@ -11,18 +13,22 @@ module Jekyll
     def initialize(config)
       self.config          = config.clone
 
+      self.safe            = config['safe']
       self.source          = config['source']
       self.dest            = config['destination']
+      self.plugins         = config['plugins']
       self.lsi             = config['lsi']
       self.pygments        = config['pygments']
       self.permalink_style = config['permalink'].to_sym
       self.exclude         = config['exclude'] || []
+      self.future          = config['future']
 
       self.reset
       self.setup
     end
 
     def reset
+      self.time            = Time.parse(self.config['time'].to_s) || Time.now
       self.layouts         = {}
       self.posts           = []
       self.pages           = []
@@ -32,70 +38,38 @@ module Jekyll
     end
 
     def setup
-      # Check to see if LSI is enabled.
       require 'classifier' if self.lsi
 
-      # Set the Markdown interpreter (and Maruku self.config, if necessary)
-      case self.config['markdown']
-        when 'rdiscount'
-          begin
-            require 'rdiscount'
-
-            def markdown(content)
-              RDiscount.new(content).to_html
-            end
-
-          rescue LoadError
-            puts 'You must have the rdiscount gem installed first'
-          end
-        when 'maruku'
-          begin
-            require 'maruku'
-
-            def markdown(content)
-              Maruku.new(content).to_html
-            end
-
-            if self.config['maruku']['use_divs']
-              require 'maruku/ext/div'
-              puts 'Maruku: Using extended syntax for div elements.'
-            end
-
-            if self.config['maruku']['use_tex']
-              require 'maruku/ext/math'
-              puts "Maruku: Using LaTeX extension. Images in `#{self.config['maruku']['png_dir']}`."
-
-              # Switch off MathML output
-              MaRuKu::Globals[:html_math_output_mathml] = false
-              MaRuKu::Globals[:html_math_engine] = 'none'
+      # If safe mode is off, load in any ruby files under the plugins
+      # directory.
+      unless self.safe
+        Dir[File.join(self.plugins, "**/*.rb")].each do |f|
+          require f
+        end
+      end
 
-              # Turn on math to PNG support with blahtex
-              # Resulting PNGs stored in `images/latex`
-              MaRuKu::Globals[:html_math_output_png] = true
-              MaRuKu::Globals[:html_png_engine] =  self.config['maruku']['png_engine']
-              MaRuKu::Globals[:html_png_dir] = self.config['maruku']['png_dir']
-              MaRuKu::Globals[:html_png_url] = self.config['maruku']['png_url']
-            end
-          rescue LoadError
-            puts "The maruku gem is required for markdown support!"
-          end
-        else
-          raise "Invalid Markdown processor: '#{self.config['markdown']}' -- did you mean 'maruku' or 'rdiscount'?"
+      self.converters = Jekyll::Converter.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
       end
-    end
 
-    def textile(content)
-      RedCloth.new(content).to_html
+      self.generators = Jekyll::Generator.subclasses.select do |c|
+        !self.safe || c.safe
+      end.map do |c|
+        c.new(self.config)
+      end
     end
 
     # Do the actual work of processing the site and generating the
-    # real deal.  Now has 4 phases; reset, read, render, write.  This allows
+    # real deal.  5 phases; reset, read, generate, render, write.  This allows
     # rendering to have full site payload available.
     #
     # Returns nothing
     def process
       self.reset
       self.read
+      self.generate
       self.render
       self.write
     end
@@ -135,7 +109,7 @@ module Jekyll
         if Post.valid?(f)
           post = Post.new(self, self.source, dir, f)
 
-          if post.published
+          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 }
@@ -146,17 +120,19 @@ module Jekyll
       self.posts.sort!
     end
 
+    def generate
+      self.generators.each do |generator|
+        generator.generate(self)
+      end
+    end
+
     def render
       self.posts.each do |post|
         post.render(self.layouts, site_payload)
       end
 
-      self.pages.dup.each do |page|
-        if Pager.pagination_enabled?(self.config, page.name)
-          paginate(page)
-        else
-          page.render(self.layouts, site_payload)
-        end
+      self.pages.each do |page|
+        page.render(self.layouts, site_payload)
       end
 
       self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a} }
@@ -180,7 +156,7 @@ module Jekyll
       end
     end
 
-    # Reads the directories and finds posts, pages and static files that will 
+    # Reads the directories and finds posts, pages and static files that will
     # become part of the valid site according to the rules in +filter_entries+.
     #   The +dir+ String is a relative path used to call this method
     #            recursively as it descends through directories
@@ -227,11 +203,14 @@ module Jekyll
     #
     # Returns {"site" => {"time" => <Time>,
     #                     "posts" => [<Post>],
+    #                     "pages" => [<Page>],
     #                     "categories" => [<Post>]}
     def site_payload
       {"site" => self.config.merge({
-          "time"       => Time.now,
+          "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
@@ -248,32 +227,5 @@ module Jekyll
       end
     end
 
-    # Paginates the blog's posts. Renders the index.html file into paginated
-    # directories, ie: page2/index.html, page3/index.html, etc and adds more
-    # site-wide data.
-    #   +page+ is the index.html Page that requires pagination
-    #
-    # {"paginator" => { "page" => <Number>,
-    #                   "per_page" => <Number>,
-    #                   "posts" => [<Post>],
-    #                   "total_posts" => <Number>,
-    #                   "total_pages" => <Number>,
-    #                   "previous_page" => <Number>,
-    #                   "next_page" => <Number> }}
-    def paginate(page)
-      all_posts = site_payload['site']['posts']
-      pages = Pager.calculate_pages(all_posts, self.config['paginate'].to_i)
-      (1..pages).each do |num_page|
-        pager = Pager.new(self.config, num_page, all_posts, pages)
-        if num_page > 1
-          newpage = Page.new(self, self.source, page.dir, page.name)
-          newpage.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash}))
-          newpage.dir = File.join(page.dir, "page#{num_page}")
-          self.pages << newpage
-        else
-          page.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash}))
-        end
-      end
-    end
   end
 end

data/lib/jekyll/static_file.rb

@@ -1,6 +1,8 @@
 module Jekyll
 
   class StaticFile
+    @@mtimes = Hash.new # the cache of last modification times [path] -> mtime
+
     # Initialize a new StaticFile.
     #   +site+ is the Site
     #   +base+ is the String path to the <source>
@@ -15,13 +17,59 @@ module Jekyll
       @name = name
     end
 
-    # Write the static file to the destination directory.
+    # Obtains source file path.
+    #
+    # Returns source file path.
+    def path
+      File.join(@base, @dir, @name)
+    end
+
+    # Obtain destination path.
     #   +dest+ is the String path to the destination dir
     #
-    # Returns nothing
+    # Returns destination file path.
+    def destination(dest)
+      File.join(dest, @dir, @name)
+    end
+
+    # Obtain mtime of the source path.
+    #
+    # Returns last modifiaction 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+ is the String path to the destination dir
+    #
+    # Returns false if the file was not modified since last time (no-op).
     def write(dest)
-      FileUtils.mkdir_p(File.join(dest, @dir))
-      FileUtils.cp(File.join(@base, @dir, @name), File.join(dest, @dir, @name))
+      dest_path = destination(dest)
+      dest_dir = File.join(dest, @dir)
+
+      return false if File.exist? dest_path and !modified?
+      @@mtimes[path] = mtime
+
+      FileUtils.mkdir_p(dest_dir)
+      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