codeslinger-jekyll 0.4.1 → 0.5.0

data/History.txt

@@ -1,4 +1,22 @@
-==
+== 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

data/README.textile

@@ -113,30 +113,40 @@ And if you don't want to be in the proto site root to run Jekyll:
 
 h2. Run Options
 
+h3. Autobuild
+
 There is an autobuild feature that will regenerate your site if any of the
 files change. The autobuild feature can be used on any of the invocations:
 
   $ jekyll --auto
 
+h3. Related Posts
+
 By default, the "related posts" functionality will produce crappy results.
 In order to get high quality results with a true LSI algorithm, you must
 enable it (it may take some time to run if you have many posts):
 
   $ jekyll --lsi
 
+h3. Code Highlighting
+
 For static code highlighting, you can install Pygments (see below) and then
 use that to make your code blocks look pretty. To activate Pygments support
 during the conversion:
 
   $ jekyll --pygments
 
+h3. Markdown Processor
+
 By default, Jekyll uses "Maruku":http://maruku.rubyforge.org (pure Ruby) for
 Markdown support. If you'd like to use RDiscount (faster, but requires
 compilation), you must install it (gem install rdiscount) and then you can
 have it used instead:
 
   $ jekyll --rdiscount
-  
+
+h3. Local Server
+
 When previewing complex sites locally, simply opening the site in a web 
 browser (using file://) can cause problems with links that are relative to
 the site root (e.g., "/stylesheets/style.css"). To get around this, Jekyll
@@ -145,16 +155,61 @@ Default port is 4000:
 
   $ jekyll --server [PORT]
 
+h3. Permalink Style
+
 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, 
+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
+If you want WordPress-style pretty URLs that leave off the .html, you can
+change the permalink style to 'pretty' and directories corresponding to the
+date parts and post name will be made and an index.html will be placed in the
+leaf directory resulting in URLs like 2008/11/17/blogging-like-a-hacker/.
+
+  $ jekyll --permalink [date|none|pretty]
+
+h2. Configuration File
+
+All of the options listed above can be specified on a site-by-site basis in
+a '_config.yml' file at the root of the site's source. As the filename
+suggests, the configuration is given in "YAML":http://www.yaml.org/. As
+well as all of the options discussed in the last section, there are a few
+additional options:
+
+  destination: [PATH]           # Specify where the site should be rendered
+  markdown: [maruku|rdiscount]  # Which markdown renderer to use?
+
+  maruku:               # This is a YAML hash for Maruku settings
+    use_divs: [BOOLEAN] # Use the div element Maruku extension
+    use_tex:  [BOOLEAN] # Use the LaTeX extension to Maruku
+    png_dir:  [PATH]    # Where should the math PNGs be stored?
+    png_url:  [URL]     # A relative URL for the PNGs
+
+The default configuration is shown below as in YAML format: 
+
+  destination: ./_site
+  auto:        false
+  lsi:         false
+  server_port: 4000
+  pygments:    false
+  markdown:    maruku
+  permalink:   date
+
+  maruku:
+    use_tex:    false
+    use_divs:   false
+    png_dir:    images/latex
+    png_url:    /images/latex
+
+Parameters set in a configuration file override the default values. Parameters
+set using command line options override both the default values and those set
+in a configuration file.
 
 h2. Data
 
@@ -255,6 +310,15 @@ h3. Predefined Post Variables
     /year/month/day/title.html then you can set this variable and it will
     be used as the final URL.
 
+  published
+    Set to false if you don't want a post to show up when the site is 
+    generated.
+
+  category/categories
+    Instead of placing posts inside of folders, you can specify one or more
+    categories that the post belongs to. When the site is generated the post
+    will act as though it had been set with these categories normally.
+
 h3. Custom Variables
 
 Any variables in the front matter that are not predefined are mixed into the
@@ -306,6 +370,12 @@ Convert an array into a sentence.
 becomes
 
   foo, bar, and baz
+  
+h3. Textilize
+
+Convert a Textile-formatted string into HTML, formatted via RedCloth
+
+  {{ page.excerpt | textilize }}
 
 h3. Include (Tag)
 
@@ -372,7 +442,7 @@ within a Liquid template as follows:
 
 <pre>
 {% for post in site.categories.foo %}
-	<li><span>{{ post.date | date_to_string }}</span> - {{ post.title }}</li>
+  <li><span>{{ post.date | date_to_string }}</span> - {{ post.title }}</li>
 {% endfor %}
 </pre>
 

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.0.4')
+    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 pretty"
+  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

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

data/bin/jekyll

@@ -9,62 +9,78 @@ Basic Command Line Usage:
   jekyll                                                   # . -> ./_site
   jekyll <path to write generated site>                    # . -> <path>
   jekyll <path to source> <path to write generated site>   # <path> -> <path>
-    
-  Options:
+
+  Configuration is read from '<source>/_config.yaml' 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
+    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 || 4000
+    options['server'] = true
+    options['server_port'] = port unless port.nil?
   end
-  
+
   opts.on("--lsi", "Use LSI for better related posts") do
-    Jekyll.lsi = true
+    options['lsi'] = true
   end
-  
+
   opts.on("--pygments", "Use pygments to highlight code") do
-    Jekyll.pygments = true
+    options['pygments'] = true
   end
-  
+
   opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
-    begin
-      require 'rdiscount'
-      Jekyll.markdown_proc = Proc.new { |x| RDiscount.new(x).to_html }
-      puts 'Using rdiscount for Markdown'
-    rescue LoadError
-      puts 'You must have the rdiscount gem installed first'
-    end
+    options['markdown'] = 'rdiscount'
   end
-  
-  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style| 
-    Jekyll.permalink_style = (style || 'date').to_sym
+
+  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style|
+    options['permalink'] = style unless style.nil?
   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!
 
-def clean(dest)
-  FileUtils.rm_rf(dest)
-  FileUtils.mkdir_p(dest)
+# 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) }
@@ -74,63 +90,51 @@ def globs(source)
   end
 end
 
-source = nil
-destination = nil
+# Create the Site
+site = Jekyll::Site.new(options)
 
-case ARGV.size
-  when 0
-    source = '.'
-    destination = File.join('.', '_site')
-  when 1
-    source = '.'
-    destination = ARGV[0]
-  when 2
-    source = ARGV[0]
-    destination = ARGV[1]
-  else
-    puts "Invalid options. Run `jekyll --help` for assistance."
-    exit(1)
-end
-
-if options[:auto]
+# 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"
-    Jekyll.process(source, destination)
+    site.process
   end
-  
+
   dw.start
-  
-  unless options[:server]
+
+  unless options['server']
     loop { sleep 1000 }
   end
 else
-  Jekyll.process(source, destination)
-  puts "Successfully generated site in #{destination}"
+  puts "Building site: #{source} -> #{destination}"
+  site.process
+  puts "Successfully generated site: #{source} -> #{destination}"
 end
 
-if options[:server]
+# 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],
+    :Port            => options['server_port'],
     :DocumentRoot    => destination
   )
   t = Thread.new {
     s.start
   }
-  
+
   trap("INT") { s.shutdown }
   t.join()
 end