sixones-jekyll 0.4.1 → 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,44 @@ 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
+  custom_filters: false
+
+  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
@@ -333,12 +371,6 @@ 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. Custom Filters
 
@@ -367,9 +399,17 @@ You would then be able to use the filter inside your templates:
 
 	{{ "arg" | my_filter }}
 
-Custom filters can be disabled by running Jekyll with the disable flag:
+Custom filters can be enable by running Jekyll with the flag:
 
-	$ jekyll --disable-custom-filters
+	$ jekyll --custom-filters
+	
+You can also use the <code>custom_filters</code> property in the YML config.
+  
+h3. Textilize
+
+Convert a Textile-formatted string into HTML, formatted via RedCloth
+
+  {{ page.excerpt | textilize }}
 
 h3. Include (Tag)
 

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,66 +9,82 @@ 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
+  opts.on("--custom-filters", "Use custom filters in the _filters dir") do
+    options['custom_filters'] = true
   end
-  
-  opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style| 
-    Jekyll.permalink_style = (style || 'date').to_sym
+
+  opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
+    options['markdown'] = 'rdiscount'
   end
-  
-  opts.on("--disable-custom-filters", "Disable's custom filters") do
-    Jekyll.custom_filters = false
+
+  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) }
@@ -78,63 +94,51 @@ def globs(source)
   end
 end
 
-source = nil
-destination = nil
-
-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
+# Create the Site
+site = Jekyll::Site.new(options)
 
-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/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'

data/lib/jekyll/converters/mephisto.rb

@@ -13,7 +13,7 @@ require File.join(File.dirname(__FILE__),"csv.rb")
 # 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
@@ -38,24 +38,24 @@ module Jekyll
     # 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.
@@ -66,14 +66,14 @@ module Jekyll
            '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

data/lib/jekyll/converters/mt.rb

@@ -11,31 +11,31 @@ require 'fileutils'
 # 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 MT
     # 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 entry_id, entry_basename, entry_text, entry_text_more, entry_created_on, entry_title FROM mt_entry"
- 
+
     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[:entry_title]
         slug = post[:entry_basename]
         date = post[:entry_created_on]
         content = post[:entry_text]
         more_content = post[:entry_text_more]
-        
+
         # 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.
@@ -46,14 +46,14 @@ module Jekyll
            '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

data/lib/jekyll/converters/textpattern.rb

@@ -18,20 +18,20 @@ 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[: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        
+        # to YAML for the header
         data = {
            'layout' => 'post',
            'title' => title.to_s,

data/lib/jekyll/converters/typo.rb

@@ -2,22 +2,22 @@
 require 'fileutils'
 require 'rubygems'
 require 'sequel'
- 
+
 module Jekyll
   module Typo
-    # this SQL *should* work for both MySQL and PostgreSQL, but I haven't 
+    # 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.title title,
+           c.permalink slug,
            c.body body,
-           c.published_at date, 
+           c.published_at date,
            c.state state,
            COALESCE(tf.name, 'html') filter
-      FROM contents c 
+      FROM contents c
            LEFT OUTER JOIN text_filters tf
-                        ON c.text_filter_id = tf.id 
+                        ON c.text_filter_id = tf.id
     EOS
 
     def self.process dbname, user, pass, host='localhost'
@@ -30,7 +30,7 @@ module Jekyll
                  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 
+        # Can have more than one text filter in this field, but we just want
         # the first one for this
         name += '.' + post[:filter].split(' ')[0]
 

data/lib/jekyll/converters/wordpress.rb

@@ -28,7 +28,6 @@ module Jekyll
         slug = post[:post_name]
         date = post[:post_date]
         content = post[:post_content]
-
         name = "%02d-%02d-%02d-%s.markdown" % [date.year, date.month, date.day,
                                                slug]
 

data/lib/jekyll/convertible.rb

@@ -1,10 +1,15 @@
+# Convertible provides methods for converting a pagelike item
+# from a certain type of markup into actual content
+#
+# Requires
+#   self.site -> Jekyll::Site
 module Jekyll
   module Convertible
     # Return 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
@@ -12,58 +17,64 @@ module Jekyll
     # 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 + 5)..-1]
-        
+
         self.data = YAML.load($1)
       end
     end
-    
+
     # Transform the contents based on the file extension.
     #
     # Returns nothing
     def transform
-      case Jekyll.content_type
-      when :textile
+      case self.content_type
+      when 'textile'
         self.ext = ".html"
-        self.content = RedCloth.new(self.content).to_html
-      when :markdown
+        self.content = self.site.textile(self.content)
+      when 'markdown'
         self.ext = ".html"
-        self.content = Jekyll.markdown_proc.call(self.content)
+        self.content = self.site.markdown(self.content)
       end
     end
-    
-    def determine_content_type
+
+    # Determine which formatting engine to use based on this convertible's
+    # extension
+    #
+    # Returns one of :textile, :markdown or :unknown
+    def content_type
       case self.ext[1..-1]
       when /textile/i
-        return :textile
+        return 'textile'
       when /markdown/i, /mkdn/i, /md/i
-        return :markdown
-      end      
-      return :unknown
+        return 'markdown'
+      end
+      return 'unknown'
     end
-    
+
     # Add any necessary layouts to this convertible document
     #   +layouts+ is a Hash of {"name" => "layout"}
     #   +site_payload+ is the site payload hash
     #
     # Returns nothing
     def do_layout(payload, layouts)
+      info = { :filters => [Jekyll::Filters, Jekyll::Filters::Custom.extensions], :registers => { :site => self.site } }
+
       # render and transform content (this becomes the final content of the object)
-      Jekyll.content_type = self.determine_content_type
-      self.content = Liquid::Template.parse(self.content).render(payload, [Jekyll::Filters, Jekyll::Filters::Custom.extensions])
+      payload["content_type"] = self.content_type
+      self.content = Liquid::Template.parse(self.content).render(payload, info)
       self.transform
-      
+
       # output keeps track of what will finally be written
       self.output = self.content
-      
+
       # recursively render layouts
       layout = layouts[self.data["layout"]]
       while layout
         payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
-        self.output = Liquid::Template.parse(layout.content).render(payload, [Jekyll::Filters, Jekyll::Filters::Custom.extensions])
-        
+        self.output = Liquid::Template.parse(layout.content).render(payload, info)
+
         layout = layouts[layout.data["layout"]]
       end
     end