jroes-jekyll 0.5.1

data/History.txt

@@ -0,0 +1,127 @@
+== 0.5.1
+  * Major Enhancements
+    * Next/previous posts in site payload [github.com/pantulis, github.com/tomo]
+    * Permalink templating system
+    * Moved most of the README out to the GitHub wiki
+    * Exclude option in configuration so specified files won't be brought over with generated site [github.com/duritong]
+  * Bug Fixes
+    * Making sure config.yaml references are all gone, using only config.yml
+    * Fixed syntax highlighting breaking for UTF-8 code [github.com/henrik]
+    * Worked around RDiscount bug that prevents Markdown from getting parsed after highlight [github.com/henrik]
+    * CGI escaped post titles [github.com/Chrononaut]
+
+== 0.5.0 / 2009-04-07
+  * Minor Enhancements
+    * Ability to set post categories via YAML [github.com/qrush]
+    * Ability to set prevent a post from publishing via YAML [github.com/qrush]
+    * Add textilize filter [github.com/willcodeforfoo]
+    * Add 'pretty' permalink style for wordpress-like urls [github.com/dysinger]
+    * Made it possible to enter categories from YAML as an array [github.com/Chrononaut]
+    * Ignore Emacs autosave files [github.com/Chrononaut]
+  * Bug Fixes
+    * Use block syntax of popen4 to ensure that subprocesses are properly disposed [github.com/jqr]
+    * Close open4 streams to prevent zombies [github.com/rtomayko]
+    * Only query required fields from the WP Database [github.com/ariejan]
+    * Prevent _posts from being copied to the destination directory [github.com/bdimcheff]
+  * Refactors
+    * Factored the filtering code into a method [github.com/Chrononaut]
+    * Fix tests and convert to Shoulda [github.com/qrush, github.com/technicalpickles]
+    * Add Cucumber acceptance test suite [github.com/qrush, github.com/technicalpickles]
+
+== 0.4.1
+  * 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]
+  * Minor Enhancements
+    * Added post categories based on directories containing _posts [github.com/mreid]
+    * Added post topics based on directories underneath _posts
+    * Added new date filter that shows the full month name [github.com/mreid]
+    * Merge Post's YAML front matter into its to_liquid payload [github.com/remi]
+    * Restrict includes to regular files underneath _includes
+  * Bug Fixes
+    * Change YAML delimiter matcher so as to not chew up 2nd level markdown headers [github.com/mreid]
+    * Fix bug that meant page data (such as the date) was not available in templates [github.com/mreid]
+    * Properly reject directories in _layouts
+
+== 0.2.1 / 2008-12-15
+  * Major Changes
+    * Use Maruku (pure Ruby) for Markdown by default [github.com/mreid]
+    * Allow use of RDiscount with --rdiscount flag
+  * Minor Enhancements
+    * Don't load directory_watcher unless it's needed [github.com/pjhyett]
+
+== 0.2.0 / 2008-12-14
+  * Major Changes
+    * related_posts is now found in site.related_posts
+
+== 0.1.6 / 2008-12-13
+  * Major Features
+    * Include files in _includes with {% include x.textile %}
+
+== 0.1.5 / 2008-12-12
+  * Major Features
+    * Code highlighting with Pygments if --pygments is specified
+    * Disable true LSI by default, enable with --lsi
+  * Minor Enhancements
+    * Output informative message if RDiscount is not available [github.com/JackDanger]
+  * Bug Fixes
+    * Prevent Jekyll from picking up the output directory as a source [github.com/JackDanger]
+    * Skip related_posts when there is only one post [github.com/JackDanger]
+
+== 0.1.4 / 2008-12-08
+  * Bug Fixes
+    * DATA does not work properly with rubygems
+
+== 0.1.3 / 2008-12-06
+  * Major Features
+    * Markdown support [github.com/vanpelt]
+    * Mephisto and CSV converters [github.com/vanpelt]
+    * Code hilighting [github.com/vanpelt]
+    * Autobuild
+  * Bug Fixes
+    * Accept both \r\n and \n in YAML header [github.com/vanpelt]
+
+== 0.1.2 / 2008-11-22
+  * Major Features
+    * Add a real "related posts" implementation using Classifier
+  * Command Line Changes
+    * Allow cli to be called with 0, 1, or 2 args intuiting dir paths
+      if they are omitted
+
+== 0.1.1 / 2008-11-22
+  * Minor Additions
+    * Posts now support introspectional data e.g. {{ page.url }}
+
+== 0.1.0 / 2008-11-05
+  * First release
+    * Converts posts written in Textile
+    * Converts regular site pages
+    * Simple copy of binary files
+
+== 0.0.0 / 2008-10-19
+  * Birthday!
+

data/README.textile

@@ -0,0 +1,41 @@
+h1. Jekyll
+
+By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
+
+Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind "GitHub Pages":http://pages.github.com, which you can use to host your project's page or blog right here from GitHub.
+
+h2. Getting Started
+
+* "Install":http://wiki.github.com/mojombo/jekyll/install the gem
+* Read up about its "Usage":http://wiki.github.com/mojombo/jekyll/usage and "Configuration":http://wiki.github.com/mojombo/jekyll/configuration
+* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
+* Fork and "Contribute":http://wiki.github.com/mojombo/jekyll/contribute your own modifications
+
+h2. Diving In
+
+* "Migrate":http://wiki.github.com/mojombo/jekyll/blog-migrations from your previous system
+* Learn how the "YAML Front Matter":http://wiki.github.com/mojombo/jekyll/yaml-front-matter works
+* Put information on your site with "Template Data":http://wiki.github.com/mojombo/jekyll/template-data
+* Customize the "Permalinks":http://wiki.github.com/mojombo/jekyll/permalinks your posts are generated with
+* Use the built-in "Liquid Extensions":http://wiki.github.com/mojombo/jekyll/liquid-extensions to make your life easier
+
+h2. Dependencies
+
+* RedCloth 4.1.0: Textile support. This version obeys @<notextile>@ tags. The latest version will still work, but tests will fail.
+* Liquid: Templating system
+* Classifier: Generating related posts
+* Maruku: Default markdown engine
+* Directory Watcher: Auto-regeneration of sites
+* Open4: Talking to pygments for syntax highlighting
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2008 Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  gem 'jeweler', '>= 0.11.0'
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "jekyll"
+    s.summary = %Q{Jekyll is a simple, blog aware, static site generator.}
+    s.email = "tom@mojombo.com"
+    s.homepage = "http://github.com/mojombo/jekyll"
+    s.description = "Jekyll is a simple, blog aware, static site generator."
+    s.authors = ["Tom Preston-Werner"]
+    s.rubyforge_project = "jekyll"
+    s.files.exclude 'test/dest'
+    s.test_files.exclude 'test/dest'
+    s.add_dependency('RedCloth', '= 4.1.0')
+    s.add_dependency('liquid', '>= 1.9.0')
+    s.add_dependency('classifier', '>= 1.3.1')
+    s.add_dependency('maruku', '>= 0.5.9')
+    s.add_dependency('directory_watcher', '>= 1.1.1')
+    s.add_dependency('open4', '>= 0.9.6')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler --version '>= 0.11.0'"
+  exit(1)
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'jekyll'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/test_*.rb']
+    t.verbose = true
+  end
+rescue LoadError
+end
+
+task :default => [:test, :features]
+
+# console
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r jekyll.rb"
+end
+
+# converters
+
+namespace :convert do
+  desc "Migrate from mephisto in the current directory"
+  task :mephisto do
+    sh %q(ruby -r './lib/jekyll/converters/mephisto' -e 'Jekyll::Mephisto.postgres(:database => "#{ENV["DB"]}")')
+  end
+  desc "Migrate from Movable Type in the current directory"
+  task :mt do
+    sh %q(ruby -r './lib/jekyll/converters/mt' -e 'Jekyll::MT.process("#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")')
+  end
+  desc "Migrate from Typo in the current directory"
+  task :typo do
+    sh %q(ruby -r './lib/jekyll/converters/typo' -e 'Jekyll::Typo.process("#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")')
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format progress"
+  end
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end

data/VERSION.yml

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

data/bin/jekyll

@@ -0,0 +1,150 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+help = <<HELP
+Jekyll is a blog-aware, static site generator.
+
+Basic Command Line Usage:
+  jekyll                                                   # . -> ./_site
+  jekyll <path to write generated site>                    # . -> <path>
+  jekyll <path to source> <path to write generated site>   # <path> -> <path>
+
+  Configuration is read from '<source>/_config.yml' but can be overriden
+  using the following options:
+
+HELP
+
+require 'optparse'
+require 'jekyll'
+
+exec = {}
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--auto", "Auto-regenerate") do
+    options['auto'] = true
+  end
+
+  opts.on("--no-auto", "No auto-regenerate") do
+    options['auto'] = false
+  end
+
+  opts.on("--server [PORT]", "Start web server (default port 4000)") do |port|
+    options['server'] = true
+    options['server_port'] = port unless port.nil?
+  end
+
+  opts.on("--lsi", "Use LSI for better related posts") do
+    options['lsi'] = true
+  end
+
+  opts.on("--pygments", "Use pygments to highlight code") do
+    options['pygments'] = true
+  end
+
+  opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
+    options['markdown'] = 'rdiscount'
+  end
+
+  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style|
+    options['permalink'] = style unless style.nil?
+  end
+  
+  opts.on("--paginate [POSTS_PER_PAGE]", "Paginate a blog's posts") do |per_page|
+    begin
+      options['paginate'] = per_page.to_i
+      raise ArgumentError if options['paginate'] == 0
+    rescue
+      puts 'you must specify a number of posts by page bigger than 0'
+      exit 0
+    end
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "Jekyll " + Jekyll.version
+    exit 0
+  end
+end
+
+# Read command line options into `options` hash
+opts.parse!
+
+# Get source and destintation from command line
+case ARGV.size
+  when 0
+  when 1
+    options['destination'] = ARGV[0]
+  when 2
+    options['source']      = ARGV[0]
+    options['destination'] = ARGV[1]
+  else
+    puts "Invalid options. Run `jekyll --help` for assistance."
+    exit(1)
+end
+
+options = Jekyll.configuration(options)
+
+# Get source and destination directories (possibly set by config file)
+source      = options['source']
+destination = options['destination']
+
+# Files to watch
+def globs(source)
+  Dir.chdir(source) do
+    dirs = Dir['*'].select { |x| File.directory?(x) }
+    dirs -= ['_site']
+    dirs = dirs.map { |x| "#{x}/**/*" }
+    dirs += ['*']
+  end
+end
+
+# Create the Site
+site = Jekyll::Site.new(options)
+
+# Run the directory watcher for auto-generation, if required
+if options['auto']
+  require 'directory_watcher'
+
+  puts "Auto-regenerating enabled: #{source} -> #{destination}"
+
+  dw = DirectoryWatcher.new(source)
+  dw.interval = 1
+  dw.glob = globs(source)
+
+  dw.add_observer do |*args|
+    t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+    puts "[#{t}] regeneration: #{args.size} files changed"
+    site.process
+  end
+
+  dw.start
+
+  unless options['server']
+    loop { sleep 1000 }
+  end
+else
+  puts "Building site: #{source} -> #{destination}"
+  site.process
+  puts "Successfully generated site: #{source} -> #{destination}"
+end
+
+# Run the server on the specified port, if required
+if options['server']
+  require 'webrick'
+  include WEBrick
+
+  FileUtils.mkdir_p(destination)
+
+  s = HTTPServer.new(
+    :Port            => options['server_port'],
+    :DocumentRoot    => destination
+  )
+  t = Thread.new {
+    s.start
+  }
+
+  trap("INT") { s.shutdown }
+  t.join()
+end

data/lib/jekyll/albino.rb

@@ -0,0 +1,122 @@
+##
+# Wrapper for the Pygments command line tool, pygmentize.
+#
+# Pygments: http://pygments.org/
+#
+# Assumes pygmentize is in the path.  If not, set its location
+# with Albino.bin = '/path/to/pygmentize'
+#
+# Use like so:
+#
+#   @syntaxer = Albino.new('/some/file.rb', :ruby)
+#   puts @syntaxer.colorize
+#
+# This'll print out an HTMLized, Ruby-highlighted version
+# of '/some/file.rb'.
+#
+# To use another formatter, pass it as the third argument:
+#
+#   @syntaxer = Albino.new('/some/file.rb', :ruby, :bbcode)
+#   puts @syntaxer.colorize
+#
+# You can also use the #colorize class method:
+#
+#   puts Albino.colorize('/some/file.rb', :ruby)
+#
+# Another also: you get a #to_s, for somewhat nicer use in Rails views.
+#
+#   ... helper file ...
+#   def highlight(text)
+#     Albino.new(text, :ruby)
+#   end
+#
+#   ... view file ...
+#   <%= highlight text %>
+#
+# The default lexer is 'text'.  You need to specify a lexer yourself;
+# because we are using STDIN there is no auto-detect.
+#
+# To see all lexers and formatters available, run `pygmentize -L`.
+#
+# Chris Wanstrath // chris@ozmm.org
+#         GitHub // http://github.com
+#
+require 'open4'
+
+class Albino
+  @@bin = Rails.development? ? 'pygmentize' : '/usr/bin/pygmentize' rescue 'pygmentize'
+
+  def self.bin=(path)
+    @@bin = path
+  end
+
+  def self.colorize(*args)
+    new(*args).colorize
+  end
+
+  def initialize(target, lexer = :text, format = :html)
+    @target  = File.exists?(target) ? File.read(target) : target rescue target
+    @options = { :l => lexer, :f => format, :O => 'encoding=utf-8' }
+  end
+
+  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 }
+    end
+    output
+  end
+
+  def colorize(options = {})
+    html = execute(@@bin + convert_options(options))
+    # Work around an RDiscount bug: http://gist.github.com/97682
+    html.to_s.sub(%r{</pre></div>\Z}, "</pre>\n</div>")
+  end
+  alias_method :to_s, :colorize
+
+  def convert_options(options = {})
+    @options.merge(options).inject('') do |string, (flag, value)|
+      string + " -#{flag} #{value}"
+    end
+  end
+end
+
+if $0 == __FILE__
+  require 'rubygems'
+  require 'test/spec'
+  require 'mocha'
+  begin require 'redgreen'; rescue LoadError; end
+
+  context "Albino" do
+    setup do
+      @syntaxer = Albino.new(__FILE__, :ruby)
+    end
+
+    specify "defaults to text" do
+      syntaxer = Albino.new(__FILE__)
+      syntaxer.expects(:execute).with('pygmentize -f html -l text').returns(true)
+      syntaxer.colorize
+    end
+
+    specify "accepts options" do
+      @syntaxer.expects(:execute).with('pygmentize -f html -l ruby').returns(true)
+      @syntaxer.colorize
+    end
+
+    specify "works with strings" do
+      syntaxer = Albino.new('class New; end', :ruby)
+      assert_match %r(highlight), syntaxer.colorize
+    end
+
+    specify "aliases to_s" do
+      assert_equal @syntaxer.colorize, @syntaxer.to_s
+    end
+
+    specify "class method colorize" do
+      assert_equal @syntaxer.colorize, Albino.colorize(__FILE__, :ruby)
+    end
+  end
+end

data/lib/jekyll/converters/csv.rb

@@ -0,0 +1,26 @@
+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
+    def self.process(file = "posts.csv")
+      FileUtils.mkdir_p "_posts"
+      posts = 0
+      FasterCSV.foreach(file) do |row|
+        next if row[0] == "title"
+        posts += 1
+        name = row[3].split(" ")[0]+"-"+row[1]+(row[4] =~ /markdown/ ? ".markdown" : ".textile")
+        File.open("_posts/#{name}", "w") do |f|
+          f.puts <<-HEADER
+---
+layout: post
+title: #{row[0]}
+---
+
+          HEADER
+          f.puts row[2]
+        end
+      end
+      "Created #{posts} posts!"
+    end
+  end
+end

data/lib/jekyll/converters/mephisto.rb

@@ -0,0 +1,79 @@
+# 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
+    #export PGPASSWORD if you must
+    def self.postgres(c)
+      sql = <<-SQL
+      BEGIN;
+      CREATE TEMP TABLE jekyll AS
+        SELECT title, permalink, body, published_at, filter FROM contents
+        WHERE user_id = 1 AND type = 'Article' ORDER BY published_at;
+      COPY jekyll TO STDOUT WITH CSV HEADER;
+      ROLLBACK;
+      SQL
+      command = %Q(psql -h #{c[:host] || "localhost"} -c "#{sql.strip}" #{c[:database]} #{c[:username]} -o #{c[:filename] || "posts.csv"})
+      puts command
+      `#{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