jekyll 0.10.0 → 0.11.0

data/lib/jekyll/converters/textile.rb

@@ -17,7 +17,8 @@ module Jekyll
     end
 
     def matches(ext)
-      ext =~ /textile/i
+      rgx = '(' + @config['textile_ext'].gsub(',','|') +')'
+      ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
     end
 
     def output_ext(ext)

data/lib/jekyll/convertible.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 # Convertible provides methods for converting a pagelike item
 # from a certain type of markup into actual content
 #
@@ -10,26 +12,27 @@
 #   self.output=
 module Jekyll
   module Convertible
-    # Return the contents as a string
+    # Returns 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
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
     #
-    # Returns nothing
+    # 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.content = $POSTMATCH
 
         begin
           self.data = YAML.load($1)
         rescue => e
-          puts "YAML Exception: #{e.message}"
+          puts "YAML Exception reading #{name}: #{e.message}"
         end
       end
 
@@ -38,42 +41,46 @@ module Jekyll
 
     # Transform the contents based on the content type.
     #
-    # Returns nothing
+    # Returns nothing.
     def transform
       self.content = converter.convert(self.content)
     end
 
-    # Determine the extension depending on content_type
+    # Determine the extension depending on content_type.
     #
-    # Returns the extensions for the output file
+    # Returns the String extension for the output file.
+    #   e.g. ".html" for an HTML output file.
     def output_ext
       converter.output_ext(self.ext)
     end
 
     # Determine which converter to use based on this convertible's
-    # extension
+    # extension.
+    #
+    # Returns the Converter instance.
     def converter
       @converter ||= self.site.converters.find { |c| c.matches(self.ext) }
     end
 
-    # Add any necessary layouts to this convertible document
-    #   +layouts+ is a Hash of {"name" => "layout"}
-    #   +site_payload+ is the site payload hash
+    # Add any necessary layouts to this convertible document.
+    #
+    # payload - The site payload Hash.
+    # layouts - A Hash of {"name" => "layout"}.
     #
-    # Returns nothing
+    # 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["pygments_prefix"] = converter.pygments_prefix
       payload["pygments_suffix"] = converter.pygments_suffix
-      
+
       begin
         self.content = Liquid::Template.parse(self.content).render(payload, info)
       rescue => e
-        puts "Liquid Exception: #{e.message} in #{self.data["layout"]}"
+        puts "Liquid Exception: #{e.message} in #{self.name}"
       end
-      
+
       self.transform
 
       # output keeps track of what will finally be written
@@ -81,6 +88,8 @@ module Jekyll
 
       # recursively render layouts
       layout = layouts[self.data["layout"]]
+      used = Set.new([layout])
+
       while layout
         payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
 
@@ -90,7 +99,13 @@ module Jekyll
           puts "Liquid Exception: #{e.message} in #{self.data["layout"]}"
         end
 
-        layout = layouts[layout.data["layout"]]
+        if layout = layouts[layout.data["layout"]]
+          if used.include?(layout)
+            layout = nil # avoid recursive chain
+          else
+            used << layout
+          end
+        end
       end
     end
   end

data/lib/jekyll/filters.rb

@@ -3,18 +3,56 @@ require 'uri'
 module Jekyll
 
   module Filters
+    # Convert a Textile string into HTML output.
+    #
+    # input - The Textile String to convert.
+    #
+    # Returns the HTML formatted String.
     def textilize(input)
-      TextileConverter.new.convert(input)
+      site = @context.registers[:site]
+      converter = site.getConverterImpl(Jekyll::TextileConverter)
+      converter.convert(input)
     end
 
+    # Convert a Markdown string into HTML output.
+    #
+    # input - The Markdown String to convert.
+    #
+    # Returns the HTML formatted String.
+    def markdownify(input)
+      site = @context.registers[:site]
+      converter = site.getConverterImpl(Jekyll::MarkdownConverter)
+      converter.convert(input)
+    end
+
+    # Format a date in short format e.g. "27 Jan 2011".
+    #
+    # date - the Time to format.
+    #
+    # Returns the formatting String.
     def date_to_string(date)
       date.strftime("%d %b %Y")
     end
 
+    # Format a date in long format e.g. "27 January 2011".
+    #
+    # date - The Time to format.
+    #
+    # Returns the formatted String.
     def date_to_long_string(date)
       date.strftime("%d %B %Y")
     end
 
+    # Format a date for use in XML.
+    #
+    # date - The Time to format.
+    #
+    # Examples
+    #
+    #   date_to_xmlschema(Time.now)
+    #   # => "2011-04-24T20:34:46+08:00"
+    #
+    # Returns the formatted String.
     def date_to_xmlschema(date)
       date.xmlschema
     end
@@ -23,6 +61,17 @@ module Jekyll
       CGI.escapeHTML(input)
     end
 
+    # CGI escape a string for use in a URL. Replaces any special characters
+    # with appropriate %XX replacements.
+    #
+    # input - The String to escape.
+    #
+    # Examples
+    #
+    #   cgi_escape('foo,bar;baz?')
+    #   # => "foo%2Cbar%3Bbaz%3F"
+    #
+    # Returns the escaped String.
     def cgi_escape(input)
       CGI::escape(input)
     end
@@ -31,10 +80,26 @@ module Jekyll
       URI.escape(input)
     end
 
+    # Count the number of words in the input string.
+    #
+    # input - The String on which to operate.
+    #
+    # Returns the Integer word count.
     def number_of_words(input)
       input.split.length
     end
 
+    # Join an array of things into a string by separating with commes and the
+    # word "and" for the last one.
+    #
+    # array - The Array of Strings to join.
+    #
+    # Examples
+    #
+    #   array_to_sentence_string(["apples", "oranges", "grapes"])
+    #   # => "apples, oranges, and grapes"
+    #
+    # Returns the formatted String.
     def array_to_sentence_string(array)
       connector = "and"
       case array.length

data/lib/jekyll/generators/pagination.rb

@@ -1,8 +1,14 @@
 module Jekyll
 
   class Pagination < Generator
+    # This generator is safe from arbitrary code execution.
     safe true
 
+    # Generate paginated pages if necessary.
+    #
+    # site - The Site.
+    #
+    # Returns nothing.
     def generate(site)
       site.pages.dup.each do |page|
         paginate(site, page) if Pager.pagination_enabled?(site.config, page.name)
@@ -10,9 +16,11 @@ module Jekyll
     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
+    # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
     # site-wide data.
-    #   +page+ is the index.html Page that requires pagination
+    #
+    # site - The Site.
+    # page - The index.html Page that requires pagination.
     #
     # {"paginator" => { "page" => <Number>,
     #                   "per_page" => <Number>,
@@ -36,22 +44,38 @@ module Jekyll
         end
       end
     end
-
   end
 
   class Pager
     attr_reader :page, :per_page, :posts, :total_posts, :total_pages, :previous_page, :next_page
 
+    # Calculate the number of pages.
+    #
+    # all_posts - The Array of all Posts.
+    # per_page  - The Integer of entries per page.
+    #
+    # Returns the Integer number of pages.
     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
+      (all_posts.size.to_f / per_page.to_i).ceil
     end
 
+    # Determine if pagination is enabled for a given file.
+    #
+    # config - The configuration Hash.
+    # file   - The String filename of the file.
+    #
+    # Returns true if pagination is enabled, false otherwise.
     def self.pagination_enabled?(config, file)
       file == 'index.html' && !config['paginate'].nil?
     end
 
+    # Initialize a new Pager.
+    #
+    # config    - The Hash configuration of the site.
+    # page      - The Integer page number.
+    # all_posts - The Array of all the site's Posts.
+    # num_pages - The Integer number of pages or nil if you'd like the number
+    #             of pages calculated.
     def initialize(config, page, all_posts, num_pages = nil)
       @page = page
       @per_page = config['paginate'].to_i
@@ -70,6 +94,9 @@ module Jekyll
       @next_page = @page != @total_pages ? @page + 1 : nil
     end
 
+    # Convert this Pager's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Pager.
     def to_liquid
       {
         'page' => page,
@@ -83,5 +110,4 @@ module Jekyll
     end
   end
 
-
 end

data/lib/jekyll/layout.rb

@@ -3,16 +3,23 @@ module Jekyll
   class Layout
     include Convertible
 
-    attr_accessor :site
+    # Gets the Site object.
+    attr_reader :site
+
+    # Gets/Sets the extension of this layout.
     attr_accessor :ext
-    attr_accessor :data, :content
+
+    # Gets/Sets the Hash that holds the metadata for this layout.
+    attr_accessor :data
+
+    # Gets/Sets the content of this layout.
+    attr_accessor :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>
+    # site - The Site.
+    # base - The String path to the source.
+    # name - The String filename of the post file.
     def initialize(site, base, name)
       @site = site
       @base = base
@@ -24,13 +31,14 @@ module Jekyll
       self.read_yaml(base, name)
     end
 
-    # Extract information from the layout filename
-    #   +name+ is the String filename of the layout file
+    # Extract information from the layout filename.
+    #
+    # name - The String filename of the layout file.
     #
-    # Returns nothing
+    # Returns nothing.
     def process(name)
       self.ext = File.extname(name)
     end
   end
 
-end
+end

data/lib/jekyll/migrators/csv.rb

@@ -1,7 +1,7 @@
 module Jekyll
   module CSV
-    #Reads a csv with title, permalink, body, published_at, and filter.
-    #It creates a post file for each row in the csv
+    # Reads a csv with title, permalink, body, published_at, and filter.
+    # It creates a post file for each row in the csv
     def self.process(file = "posts.csv")
       FileUtils.mkdir_p "_posts"
       posts = 0
@@ -23,4 +23,4 @@ title: #{row[0]}
       "Created #{posts} posts!"
     end
   end
-end
+end

data/lib/jekyll/migrators/drupal.rb

@@ -11,12 +11,18 @@ require 'yaml'
 
 module Jekyll
   module Drupal
-
-    # Reads a MySQL database via Sequel and creates a post file for each
-    # post in wp_posts that has post_status = 'publish'.
-    # This restriction is made because 'draft' posts are not guaranteed to
-    # have valid dates.
-    QUERY = "SELECT node.nid, node.title, node_revisions.body, node.created, node.status FROM node, node_revisions WHERE (node.type = 'blog' OR node.type = 'story') AND node.vid = node_revisions.vid"
+    # Reads a MySQL database via Sequel and creates a post file for each post
+    # in wp_posts that has post_status = 'publish'. This restriction is made
+    # because 'draft' posts are not guaranteed to have valid dates.
+    QUERY = "SELECT node.nid, \
+                    node.title, \
+                    node_revisions.body, \
+                    node.created, \
+                    node.status \
+             FROM node, \
+                  node_revisions \
+             WHERE (node.type = 'blog' OR node.type = 'story') \
+             AND node.vid = node_revisions.vid"
 
     def self.process(dbname, user, pass, host = 'localhost')
       db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host, :encoding => 'utf8')

data/lib/jekyll/migrators/enki.rb

@@ -0,0 +1,49 @@
+# Adapted by Rodrigo Pinto <rodrigopqn@gmail.com>
+# Based on typo.rb by Toby DiPasquale
+
+require 'fileutils'
+require 'rubygems'
+require 'sequel'
+
+module Jekyll
+  module Enki
+    SQL = <<-EOS
+      SELECT p.id,
+             p.title,
+             p.slug,
+             p.body,
+             p.published_at as date,
+             p.cached_tag_list as tags
+      FROM posts p
+    EOS
+
+    # Just working with postgres, but can be easily adapted
+    # to work with both mysql and postgres.
+    def self.process(dbname, user, pass, host = 'localhost')
+      FileUtils.mkdir_p('_posts')
+      db = Sequel.postgres(:database => dbname,
+                           :user => user,
+                           :password => pass,
+                           :host => host,
+                           :encoding => 'utf8')
+
+      db[SQL].each do |post|
+        name = [ sprintf("%.04d", post[:date].year),
+                 sprintf("%.02d", post[:date].month),
+                 sprintf("%.02d", post[:date].day),
+                 post[:slug].strip ].join('-')
+        name += '.textile'
+
+        File.open("_posts/#{name}", 'w') do |f|
+          f.puts({ 'layout'   => 'post',
+                   'title'    => post[:title].to_s,
+                   'enki_id'  => post[:id],
+                   'categories'  => post[:tags]
+                 }.delete_if { |k, v| v.nil? || v == '' }.to_yaml)
+          f.puts '---'
+          f.puts post[:body].delete("\r")
+        end
+      end
+    end
+  end
+end