jekyll 0.5.7 → 0.6.0

data/lib/jekyll.rb

@@ -1,44 +1,65 @@
-$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# Require all of the Ruby files in the given directory.
+#
+# path - The String relative path from here to the directory.
+#
+# Returns nothing.
+def require_all(path)
+  glob = File.join(File.dirname(__FILE__), path, '*.rb')
+  Dir[glob].each do |f|
+    require f
+  end
+end
 
 # rubygems
 require 'rubygems'
 
-# core
+# stdlib
 require 'fileutils'
 require 'time'
 require 'yaml'
 
-# stdlib
-
 # 3rd party
 require 'liquid'
-require 'redcloth'
+require 'maruku'
 
 # internal requires
 require 'jekyll/core_ext'
-require 'jekyll/pager'
 require 'jekyll/site'
 require 'jekyll/convertible'
 require 'jekyll/layout'
 require 'jekyll/page'
 require 'jekyll/post'
 require 'jekyll/filters'
-require 'jekyll/tags/highlight'
-require 'jekyll/tags/include'
 require 'jekyll/albino'
 require 'jekyll/static_file'
+require 'jekyll/errors'
+
+# extensions
+require 'jekyll/plugin'
+require 'jekyll/converter'
+require 'jekyll/generator'
+require_all 'jekyll/converters'
+require_all 'jekyll/generators'
+require_all 'jekyll/tags'
 
 module Jekyll
+  VERSION = '0.6.0'
+
   # Default options. Overriden by values in _config.yml or command-line opts.
-  # (Strings rather symbols used for compatability with YAML)
+  # (Strings rather symbols used for compatability with YAML).
   DEFAULTS = {
+    'safe'         => false,
     'auto'         => false,
     'server'       => false,
     'server_port'  => 4000,
 
-    'source'       => '.',
-    'destination'  => File.join('.', '_site'),
+    'source'       => Dir.pwd,
+    'destination'  => File.join(Dir.pwd, '_site'),
+    'plugins'      => File.join(Dir.pwd, '_plugins'),
 
+    'future'       => true,
     'lsi'          => false,
     'pygments'     => false,
     'markdown'     => 'maruku',
@@ -54,10 +75,13 @@ module Jekyll
   }
 
   # Generate a Jekyll configuration Hash by merging the default options
-  # with anything in _config.yml, and adding the given options on top
-  #   +override+ is a Hash of config directives
+  # with anything in _config.yml, and adding the given options on top.
+  #
+  # override - A Hash of config directives that override any options in both
+  #            the defaults and the config file. See Jekyll::DEFAULTS for a
+  #            list of option names and their defaults.
   #
-  # Returns Hash
+  # Returns the final configuration Hash.
   def self.configuration(override)
     # _config.yml may override default source location, but until
     # then, we need to know where to look for _config.yml
@@ -70,7 +94,8 @@ module Jekyll
       raise "Invalid configuration - #{config_file}" if !config.is_a?(Hash)
       $stdout.puts "Configuration from #{config_file}"
     rescue => err
-      $stderr.puts "WARNING: Could not read configuration. Using defaults (and options)."
+      $stderr.puts "WARNING: Could not read configuration. " +
+                   "Using defaults (and options)."
       $stderr.puts "\t" + err.to_s
       config = {}
     end
@@ -78,9 +103,4 @@ module Jekyll
     # Merge DEFAULTS < _config.yml < override
     Jekyll::DEFAULTS.deep_merge(config).deep_merge(override)
   end
-
-  def self.version
-    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
-    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
-  end
 end

data/lib/jekyll/albino.rb

@@ -41,7 +41,6 @@
 # Chris Wanstrath // chris@ozmm.org
 #         GitHub // http://github.com
 #
-require 'open4'
 
 class Albino
   @@bin = Rails.development? ? 'pygmentize' : '/usr/bin/pygmentize' rescue 'pygmentize'
@@ -61,11 +60,10 @@ class Albino
 
   def execute(command)
     output = ''
-    Open4.popen4(command) do |pid, stdin, stdout, stderr|
-      stdin.puts @target
-      stdin.close
-      output = stdout.read.strip
-      [stdout, stderr].each { |io| io.close }
+    IO.popen(command, mode='r+') do |p|
+      p.write @target
+      p.close_write
+      output = p.read.strip
     end
     output
   end
@@ -119,4 +117,4 @@ if $0 == __FILE__
       assert_equal @syntaxer.colorize, Albino.colorize(__FILE__, :ruby)
     end
   end
-end
+end

data/lib/jekyll/converter.rb

@@ -0,0 +1,50 @@
+module Jekyll
+
+  class Converter < Plugin
+    # Public: Get or set the pygments prefix. When an argument is specified,
+    # the prefix will be set. If no argument is specified, the current prefix
+    # will be returned.
+    #
+    # pygments_prefix - The String prefix (default: nil).
+    #
+    # Returns the String prefix.
+    def self.pygments_prefix(pygments_prefix = nil)
+      @pygments_prefix = pygments_prefix if pygments_prefix
+      @pygments_prefix
+    end
+
+    # Public: Get or set the pygments suffix. When an argument is specified,
+    # the suffix will be set. If no argument is specified, the current suffix
+    # will be returned.
+    #
+    # pygments_suffix - The String suffix (default: nil).
+    #
+    # Returns the String suffix.
+    def self.pygments_suffix(pygments_suffix = nil)
+      @pygments_suffix = pygments_suffix if pygments_suffix
+      @pygments_suffix
+    end
+
+    # Initialize the converter.
+    #
+    # Returns an initialized Converter.
+    def initialize(config = {})
+      @config = config
+    end
+
+    # Get the pygments prefix.
+    #
+    # Returns the String prefix.
+    def pygments_prefix
+      self.class.pygments_prefix
+    end
+
+    # Get the pygments suffix.
+    #
+    # Returns the String suffix.
+    def pygments_suffix
+      self.class.pygments_suffix
+    end
+  end
+
+end

data/lib/jekyll/converters/identity.rb

@@ -0,0 +1,22 @@
+module Jekyll
+
+  class IdentityConverter < Converter
+    safe true
+
+    priority :lowest
+
+    def matches(ext)
+      true
+    end
+
+    def output_ext(ext)
+      ext
+    end
+
+    def convert(content)
+      content
+    end
+
+  end
+
+end

data/lib/jekyll/converters/markdown.rb

@@ -0,0 +1,77 @@
+module Jekyll
+
+  class MarkdownConverter < Converter
+    safe true
+
+    pygments_prefix '\n'
+    pygments_suffix '\n'
+
+    def setup
+      return if @setup
+      # Set the Markdown interpreter (and Maruku self.config, if necessary)
+      case @config['markdown']
+        when 'rdiscount'
+          begin
+            require 'rdiscount'
+          rescue LoadError
+            STDERR.puts 'You are missing a library required for Markdown. Please run:'
+            STDERR.puts '  $ [sudo] gem install rdiscount'
+            raise FatalException.new("Missing dependency: rdiscount")
+          end
+        when 'maruku'
+          begin
+            require 'maruku'
+
+            if @config['maruku']['use_divs']
+              require 'maruku/ext/div'
+              STDERR.puts 'Maruku: Using extended syntax for div elements.'
+            end
+
+            if @config['maruku']['use_tex']
+              require 'maruku/ext/math'
+              STDERR.puts "Maruku: Using LaTeX extension. Images in `#{@config['maruku']['png_dir']}`."
+
+              # Switch off MathML output
+              MaRuKu::Globals[:html_math_output_mathml] = false
+              MaRuKu::Globals[:html_math_engine] = 'none'
+
+              # 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] =  @config['maruku']['png_engine']
+              MaRuKu::Globals[:html_png_dir] = @config['maruku']['png_dir']
+              MaRuKu::Globals[:html_png_url] = @config['maruku']['png_url']
+            end
+          rescue LoadError
+            STDERR.puts 'You are missing a library required for Markdown. Please run:'
+            STDERR.puts '  $ [sudo] gem install maruku'
+            raise FatalException.new("Missing dependency: maruku")
+          end
+        else
+          STDERR.puts "Invalid Markdown processor: #{@config['markdown']}"
+          STDERR.puts "  Valid options are [ maruku | rdiscount ]"
+          raise FatalException.new("Invalid Markdown process: #{@config['markdown']}")
+      end
+      @setup = true
+    end
+
+    def matches(ext)
+      ext =~ /(markdown|mkdn?|md)/i
+    end
+
+    def output_ext(ext)
+      ".html"
+    end
+
+    def convert(content)
+      setup
+      case @config['markdown']
+        when 'rdiscount'
+          RDiscount.new(content).to_html
+        when 'maruku'
+          Maruku.new(content).to_html
+      end
+    end
+  end
+
+end

data/lib/jekyll/converters/textile.rb

@@ -0,0 +1,33 @@
+module Jekyll
+
+  class TextileConverter < Converter
+    safe true
+
+    pygments_prefix '<notextile>'
+    pygments_suffix '</notextile>'
+
+    def setup
+      return if @setup
+      require 'redcloth'
+      @setup = true
+    rescue LoadError
+      STDERR.puts 'You are missing a library required for Textile. Please run:'
+      STDERR.puts '  $ [sudo] gem install RedCloth'
+      raise FatalException.new("Missing dependency: RedCloth")
+    end
+
+    def matches(ext)
+      ext =~ /textile/i
+    end
+
+    def output_ext(ext)
+      ".html"
+    end
+
+    def convert(content)
+      setup
+      RedCloth.new(content).to_html
+    end
+  end
+
+end

data/lib/jekyll/convertible.rb

@@ -3,6 +3,7 @@
 #
 # Requires
 #   self.site -> Jekyll::Site
+#   self.content
 #   self.content=
 #   self.data=
 #   self.ext=
@@ -21,42 +22,34 @@ module Jekyll
     # 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 + $2.size)..-1]
-      
+
         self.data = YAML.load($1)
       end
-      
+
       self.data ||= {}
     end
 
-    # Transform the contents based on the file extension.
+    # Transform the contents based on the content type.
     #
     # 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
+      self.content = converter.convert(self.content)
     end
 
-    # Determine which formatting engine to use based on this convertible's
-    # extension
+    # Determine the extension depending on content_type
     #
-    # 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, /mkd/i
-        return 'markdown'
-      end
-      return 'unknown'
+    # Returns the extensions for the output file
+    def output_ext
+      converter.output_ext(self.ext)
+    end
+
+    # Determine which converter to use based on this convertible's
+    # extension
+    def converter
+      @converter ||= self.site.converters.find { |c| c.matches(self.ext) }
     end
 
     # Add any necessary layouts to this convertible document
@@ -68,7 +61,8 @@ module Jekyll
       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
+      payload["pygments_prefix"] = converter.pygments_prefix
+      payload["pygments_suffix"] = converter.pygments_suffix
       self.content = Liquid::Template.parse(self.content).render(payload, info)
       self.transform
 

data/lib/jekyll/errors.rb

@@ -0,0 +1,6 @@
+module Jekyll
+
+  class FatalException < StandardError
+  end
+
+end

data/lib/jekyll/generator.rb

@@ -0,0 +1,7 @@
+module Jekyll
+
+  class Generator < Plugin
+
+  end
+
+end

data/lib/jekyll/generators/pagination.rb

@@ -0,0 +1,87 @@
+module Jekyll
+
+  class Pagination < Generator
+    safe true
+
+    def generate(site)
+      site.pages.dup.each do |page|
+        paginate(site, page) if Pager.pagination_enabled?(site.config, page.name)
+      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(site, page)
+      all_posts = site.site_payload['site']['posts']
+      pages = Pager.calculate_pages(all_posts, site.config['paginate'].to_i)
+      (1..pages).each do |num_page|
+        pager = Pager.new(site.config, num_page, all_posts, pages)
+        if num_page > 1
+          newpage = Page.new(site, site.source, page.dir, page.name)
+          newpage.pager = pager
+          newpage.dir = File.join(page.dir, "page#{num_page}")
+          site.pages << newpage
+        else
+          page.pager = pager
+        end
+      end
+    end
+
+  end
+
+  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 = num_pages + 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_liquid
+      {
+        '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