matflores-jekyll 0.4.3 → 0.5.0

data/History.txt

@@ -1,4 +1,4 @@
-==
+== 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]
@@ -13,6 +13,8 @@
     * 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

data/README.textile

@@ -174,6 +174,43 @@ 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
 
 Jekyll traverses your site looking for files to process. Any files with YAML

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

data/lib/jekyll.rb

@@ -13,22 +13,6 @@ require 'yaml'
 # 3rd party
 require 'liquid'
 require 'redcloth'
-begin
-  require 'maruku'
-  require 'maruku/ext/math'
-  # 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] =  'blahtex'
-  MaRuKu::Globals[:html_png_dir] = 'images/latex'
-  MaRuKu::Globals[:html_png_url] = '/images/latex/'
-rescue LoadError
-  puts "The maruku gem is required for markdown support!"
-end
 
 # internal requires
 require 'jekyll/core_ext'
@@ -45,23 +29,55 @@ require 'jekyll/tags/include'
 require 'jekyll/albino'
 
 module Jekyll
-  class << self
-    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
-    
-    Jekyll.source = source
-    Jekyll.dest = dest
-    Jekyll::Site.new(source, dest).process
+  # Default options. Overriden by values in _config.yaml or command-line opts.
+  # (Strings rather symbols used for compatability with YAML)
+  DEFAULTS = {
+    'auto'         => false,
+    'server'       => false,
+    'server_port'  => 4000,
+
+    'source'       => '.',
+    'destination'  => File.join('.', '_site'),
+
+    'lsi'          => false,
+    'pygments'     => false,
+    'markdown'     => 'maruku',
+    'permalink'    => 'date',
+
+    'maruku'       => {
+      'use_tex'    => false,
+      'use_divs'   => false,
+      'png_engine' => 'blahtex',
+      'png_dir'    => 'images/latex',
+      'png_url'    => '/images/latex'
+    }
+  }
+
+  # 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
+  #
+  # Returns 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
+    source = override['source'] || Jekyll::DEFAULTS['source']
+
+    # Get configuration from <source>/_config.yaml
+    config = {}
+    config_file = File.join(source, '_config.yml')
+    begin
+      config = YAML.load_file(config_file)
+      puts "Configuration from #{config_file}"
+    rescue => err
+      puts "WARNING: Could not read configuration. Using defaults (and options)."
+      puts "\t" + err
+    end
+
+    # 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]}"

data/lib/jekyll/albino.rb

@@ -38,7 +38,7 @@
 #
 # To see all lexers and formatters available, run `pygmentize -L`.
 #
-# Chris Wanstrath // chris@ozmm.org 
+# Chris Wanstrath // chris@ozmm.org
 #         GitHub // http://github.com
 #
 require 'open4'