jekyll 0.3.0 → 0.4.1

data/History.txt

@@ -1,3 +1,28 @@
+==
+  * Minor Enhancements
+    * Changed date format on wordpress converter (zeropadding) [github.com/dysinger]
+  * Bug Fixes
+    * Add jekyll binary as executable to gemspec [github.com/dysinger]
+
+== 0.4.0 / 2009-02-03
+  * Major Enhancements
+    * Switch to Jeweler for packaging tasks
+  * Minor Enhancements
+    * Type importer [github.com/codeslinger]
+    * site.topics accessor [github.com/baz]
+    * Add array_to_sentence_string filter [github.com/mchung]
+    * Add a converter for textpattern [github.com/PerfectlyNormal]
+    * Add a working Mephisto / MySQL converter [github.com/ivey]
+    * Allowing .htaccess files to be copied over into the generated site [github.com/briandoll]
+    * Add option to not put file date in permalink URL [github.com/mreid]
+    * Add line number capabilities to highlight blocks [github.com/jcon]
+  * Bug Fixes
+    * Fix permalink behavior [github.com/cavalle]
+    * Fixed an issue with pygments, markdown, and newlines [github.com/zpinter]
+    * Ampersands need to be escaped [github.com/pufuwozu, github.com/ap]
+    * Test and fix the site.categories hash [github.com/zzot]
+    * Fix site payload available to files [github.com/matrix9180]
+
 == 0.3.0 / 2008-12-24
   * Major Enhancements
     * Added --server option to start a simple WEBrick server on destination directory [github.com/johnreilly and github.com/mchung]

data/README.textile

@@ -34,7 +34,7 @@ fields such as <code>title</code> and <code>date</code>.
 Jekyll gets the list of blog posts by parsing the files in any
 "_posts":http://github.com/mojombo/tpw/tree/master/_posts directory found in
 subdirectories below the root. 
-Each post's filename contains the publishing date and slug (what shows up in the
+Each post's filename contains (by default) the publishing date and slug (what shows up in the
 URL) that the final HTML file should have. Open up the file corresponding to a
 blog post:
 "2008-11-17-blogging-like-a-hacker.textile":http://github.com/mojombo/tpw/tree/master/_posts/2008-11-17-blogging-like-a-hacker.textile.
@@ -145,6 +145,17 @@ Default port is 4000:
 
   $ jekyll --server [PORT]
 
+By default, the permalink for each post begins with its date in 'YYYY/MM/DD'
+format. If you do not wish to have the date appear in the URL of each post, 
+you can change the permalink style to 'none' so that only the 'slug' part of
+the filename is used. For example, with the permalink style set to 'none' the
+file '2009-01-01-happy-new-year.markdown' will have a permalink like
+'http://yoursite.com/happy-new-year.html'. The date of the post will still be
+read from the filename (and is required!) to be used elsewhere in Jekyll.
+Example usage:
+
+  $ jekyll --permalink none
+
 h2. Data
 
 Jekyll traverses your site looking for files to process. Any files with YAML
@@ -286,6 +297,16 @@ becomes
 
   1337
 
+h3. Array to Sentence String
+
+Convert an array into a sentence.
+
+  {{ page.tags | array_to_sentence_string }}
+
+becomes
+
+  foo, bar, and baz
+
 h3. Include (Tag)
 
 If you have small page fragments that you wish to include in multiple places
@@ -321,17 +342,33 @@ The argument to <code>highlight</code> is the language identifier. To find the
 appropriate identifier to use for your favorite language, look for the "short
 name" on the "Lexers":http://pygments.org/docs/lexers/ page.
 
+There is a second argument to <code>highlight</code> called
+<code>linenos</code> that is optional. Including the <code>linenos</code>
+argument will force the highlighted code to include line numbers. For
+instance, the following code block would include line numbers next to each
+line:
+
+<pre>
+{% highlight ruby linenos %}
+def foo
+  puts 'foo'
+end
+{% endhighlight %}
+</pre>
+
 In order for the highlighting to show up, you'll need to include a
 highlighting stylesheet. For an example stylesheet you can look at
 "syntax.css":http://github.com/mojombo/tpw/tree/master/css/syntax.css. These
 are the same styles as used by GitHub and you are free to use them for your
-own site.
+own site. If you use linenos, you might want to include an additional CSS
+class definition for <code>lineno</code> in syntax.css to distinguish the line
+numbers from the highlighted code.
 
 h2. Categories
 
-Posts are placed into categories based on the directory structure they are found
-within (see above for an example). The categories can be accessed from within
-a Liquid template as follows:
+Posts are placed into categories based on the directory structure they are
+found within (see above for an example). The categories can be accessed from
+within a Liquid template as follows:
 
 <pre>
 {% for post in site.categories.foo %}
@@ -343,24 +380,6 @@ This would list all the posts in the category 'foo' by date and title.
 
 The posts within each category are sorted in reverse chronological order.
 
-h2. Contribute
-
-If you'd like to hack on Jekyll, grab the source from GitHub. To get
-all of the dependencies, install the gem first.
-
-  $ git clone git://github.com/mojombo/jekyll
-
-The best way to get your changes merged back into core is as follows:
-
-# Fork mojombo/jekyll on GitHub
-# Clone down your fork
-# Create a topic branch to contain your change
-# Hack away
-# Do not change the version number, I will do that on my end
-# If necessary, rebase your commits into logical chunks, without errors
-# Push the branch up to GitHub
-# Send me (mojombo) a pull request for your branch
-
 h2. Blog migrations
 
 h3. Movable Type
@@ -379,6 +398,57 @@ You may need to adjust the SQL query used to retrieve MT entries. Left alone,
 it will attempt to pull all entries across all blogs regardless of status.
 Please check the results and verify the posts before publishing.
 
+h3. Typo 4+
+
+To migrate your Typo blog into Jekyll, you'll need read access to the MySQL
+database. The lib/jekyll/converters/typo.rb module provides a simple convert 
+to create .html, .textile, or .markdown files in a _posts directory based on 
+the entries contained therein.
+
+  $ export DB=my_typo_db
+  $ export USER=dbuser
+  $ export PASS=dbpass
+  $ ruby -r './lib/jekyll/converters/typo' -e 'Jekyll::Typo.process( \
+    "#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")'
+
+You may need to adjust the code used to filter Typo entries. Left alone,
+it will attempt to pull all entries across all blogs that were published.
+This code also has only been tested with Typo version 4+. Previous versions
+of Typo may not convert correctly. Please check the results and verify the 
+posts before publishing.
+
+h3. TextPattern 4
+
+To migrate your TextPattern blog into Jekyll, you'll need read access to the MySQL
+database. The lib/jekyll/converters/textpattern.rb module provides a simple convert to create .textile files in a _posts directory based on 
+the entries contained therein.
+
+  $ ruby -r './lib/jekyll/converters/textpattern' -e 'Jekyll::TextPattern.process( \
+    "database_name", "username", "password", "hostname")'
+
+The hostname defaults to _localhost_, all other variables are needed
+You may need to adjust the code used to filter entries. Left alone,
+it will attempt to pull all entries that are live or sticky.
+
+h2. Contribute
+
+If you'd like to hack on Jekyll, start by forking my repo on GitHub:
+
+http://github.com/mojombo/jekyll
+
+To get all of the dependencies, install the gem first. The best way to get
+your changes merged back into core is as follows:
+
+# Clone down your fork
+# Create a topic branch to contain your change
+# Hack away
+# Add tests and make sure everything still passes by running `rake`
+# If you are adding new functionality, document it in README.textile
+# Do not change the version number, I will do that on my end
+# If necessary, rebase your commits into logical chunks, without errors
+# Push the branch up to GitHub
+# Send me (mojombo) a pull request for your branch
+
 h2. License
 
 (The MIT License)

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 4
+:patch: 1
+:major: 0

data/bin/jekyll

@@ -47,6 +47,15 @@ opts = OptionParser.new do |opts|
       puts 'You must have the rdiscount gem installed first'
     end
   end
+  
+  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style| 
+    Jekyll.permalink_style = (style || 'date').to_sym
+  end
+  
+  opts.on("--version", "Display current version") do
+    puts "Jekyll " + Jekyll.version
+    exit 0
+  end
 end
 
 opts.parse!

data/lib/jekyll.rb

@@ -43,15 +43,14 @@ require 'jekyll/tags/include'
 require 'jekyll/albino'
 
 module Jekyll
-  VERSION = '0.3.0'
-  
   class << self
-    attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc
+    attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc, :content_type, :permalink_style
   end
   
   Jekyll.lsi = false
   Jekyll.pygments = false
   Jekyll.markdown_proc = Proc.new { |x| Maruku.new(x).to_html }
+  Jekyll.permalink_style = :date
   
   def self.process(source, dest)
     require 'classifier' if Jekyll.lsi
@@ -60,4 +59,9 @@ module Jekyll
     Jekyll.dest = dest
     Jekyll::Site.new(source, dest).process
   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/converters/mephisto.rb

@@ -1,7 +1,19 @@
+# Quickly hacked together my Michael Ivey
+# Based on mt.rb by Nick Gerakines, open source and publically
+# available under the MIT license. Use this module at your own risk.
+
 require 'rubygems'
+require 'sequel'
 require 'fastercsv'
 require 'fileutils'
 require File.join(File.dirname(__FILE__),"csv.rb")
+
+# NOTE: This converter requires Sequel and the MySQL gems.
+# The MySQL gem can be difficult to install on OS X. Once you have MySQL
+# installed, running the following commands should work:
+# $ sudo gem install sequel
+# $ sudo gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
+ 
 module Jekyll
   module Mephisto
     #Accepts a hash with database config variables, exports mephisto posts into a csv
@@ -20,5 +32,48 @@ module Jekyll
       `#{command}`
       CSV.process
     end
+
+    # This query will pull blog posts from all entries across all blogs. If
+    # you've got unpublished, deleted or otherwise hidden posts please sift
+    # through the created posts to make sure nothing is accidently published.
+
+    QUERY = "SELECT id, permalink, body, published_at, title FROM contents WHERE user_id = 1 AND type = 'Article' AND published_at IS NOT NULL ORDER BY published_at"
+ 
+    def self.process(dbname, user, pass, host = 'localhost')
+      db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host)
+      
+      FileUtils.mkdir_p "_posts"
+            
+      db[QUERY].each do |post|
+        title = post[:title]
+        slug = post[:permalink]
+        date = post[:published_at]
+        content = post[:body]
+#         more_content = ''
+        
+        # Be sure to include the body and extended body.
+#         if more_content != nil
+#           content = content + " \n" + more_content
+#         end
+        
+        # Ideally, this script would determine the post format (markdown, html
+        # , etc) and create files with proper extensions. At this point it
+        # just assumes that markdown will be acceptable.
+        name = [date.year, date.month, date.day, slug].join('-') + ".markdown"
+
+        data = {
+           'layout' => 'post',
+           'title' => title.to_s,
+           'mt_id' => post[:entry_id],
+         }.delete_if { |k,v| v.nil? || v == ''}.to_yaml
+ 
+        File.open("_posts/#{name}", "w") do |f|
+          f.puts data
+          f.puts "---"
+          f.puts content
+        end
+      end
+ 
+    end
   end
-end
+end

data/lib/jekyll/converters/mt.rb

@@ -33,7 +33,7 @@ module Jekyll
         
         # Be sure to include the body and extended body.
         if more_content != nil
-          conent = content + " \n" + more_content
+          content = content + " \n" + more_content
         end
         
         # Ideally, this script would determine the post format (markdown, html

data/lib/jekyll/converters/textpattern.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'sequel'
+require 'fileutils'
+
+# NOTE: This converter requires Sequel and the MySQL gems.
+# The MySQL gem can be difficult to install on OS X. Once you have MySQL
+# installed, running the following commands should work:
+# $ sudo gem install sequel
+# $ sudo gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
+
+module Jekyll
+  module TextPattern
+    # Reads a MySQL database via Sequel and creates a post file for each post.
+    # The only posts selected are those with a status of 4 or 5, which means "live"
+    # and "sticky" respectively.
+    # Other statuses is 1 => draft, 2 => hidden and 3 => pending
+    QUERY = "select Title, url_title, Posted, Body, Keywords from textpattern where Status = '4' or Status = '5'"
+
+    def self.process(dbname, user, pass, host = 'localhost')
+      db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host)
+      
+      FileUtils.mkdir_p "_posts"
+            
+      db[QUERY].each do |post|
+        # Get required fields and construct Jekyll compatible name
+        title = post[:Title]
+        slug = post[:url_title]
+        date = post[:Posted]
+        content = post[:Body]
+        
+        name = [date.strftime("%Y-%m-%d"), slug].join('-') + ".textile"
+
+        # Get the relevant fields as a hash, delete empty fields and convert
+        # to YAML for the header        
+        data = {
+           'layout' => 'post',
+           'title' => title.to_s,
+           'tags' => post[:Keywords].split(',')
+         }.delete_if { |k,v| v.nil? || v == ''}.to_yaml
+
+        # Write out the data and content to file
+        File.open("_posts/#{name}", "w") do |f|
+          f.puts data
+          f.puts "---"
+          f.puts content
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/converters/typo.rb

@@ -0,0 +1,49 @@
+# Author: Toby DiPasquale <toby@cbcg.net>
+require 'fileutils'
+require 'rubygems'
+require 'sequel'
+ 
+module Jekyll
+  module Typo
+    # this SQL *should* work for both MySQL and PostgreSQL, but I haven't 
+    # tested PostgreSQL yet (as of 2008-12-16)
+    SQL = <<-EOS
+    SELECT c.id id,
+           c.title title, 
+           c.permalink slug, 
+           c.body body,
+           c.published_at date, 
+           c.state state,
+           COALESCE(tf.name, 'html') filter
+      FROM contents c 
+           LEFT OUTER JOIN text_filters tf
+                        ON c.text_filter_id = tf.id 
+    EOS
+
+    def self.process dbname, user, pass, host='localhost'
+      FileUtils.mkdir_p '_posts'
+      db = Sequel.mysql dbname, :user => user, :password => pass, :host => host
+      db[SQL].each do |post|
+        next unless post[:state] =~ /Published/
+
+        name = [ sprintf("%.04d", post[:date].year),
+                 sprintf("%.02d", post[:date].month),
+                 sprintf("%.02d", post[:date].day),
+                 post[:slug].strip ].join('-')
+        # Can have more than one text filter in this field, but we just want 
+        # the first one for this
+        name += '.' + post[:filter].split(' ')[0]
+
+        File.open("_posts/#{name}", 'w') do |f|
+          f.puts({ 'layout'   => 'post',
+                   'title'    => post[:title].to_s,
+                   'typo_id'  => post[:id]
+                 }.delete_if { |k, v| v.nil? || v == '' }.to_yaml)
+          f.puts '---'
+          f.puts post[:body].delete("\r")
+        end
+      end
+    end
+
+  end   # module Typo
+end   # module Jekyll

data/lib/jekyll/converters/wordpress.rb

@@ -10,8 +10,8 @@ require 'fileutils'
 
 module Jekyll
   module WordPress
-    
-    # Reads a MySQL database via Sequel and creates a post file for each 
+
+    # 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.
@@ -19,20 +19,21 @@ module Jekyll
 
     def self.process(dbname, user, pass, host = 'localhost')
       db = Sequel.mysql(dbname, :user => user, :password => pass, :host => host)
-      
+
       FileUtils.mkdir_p "_posts"
-            
+
       db[QUERY].each do |post|
         # Get required fields and construct Jekyll compatible name
         title = post[:post_title]
         slug = post[:post_name]
         date = post[:post_date]
         content = post[:post_content]
-        
-        name = [date.year, date.month, date.day, slug].join('-') + ".markdown"
+
+        name = "%02d-%02d-%02d-%s.markdown" % [date.year, date.month, date.day,
+                                               slug]
 
         # Get the relevant fields as a hash, delete empty fields and convert
-        # to YAML for the header        
+        # to YAML for the header
         data = {
            'layout' => 'post',
            'title' => title.to_s,
@@ -51,4 +52,4 @@ module Jekyll
 
     end
   end
-end
+end