dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge commit 'mojombo/master'

This commit is contained in:
mreid 2009-01-04 21:03:18 +11:00
parent fa689bfd92 94c06d0100
commit eb70d75d44
26 changed files with 537 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
History.txt
View File

@ -1,3 +1,30 @@
==
* Minor Enhancements
* Type importer [github.com/codeslinger]
* site.topics accessor [github.com/baz]
* Add array_to_sentence_string filter [github.com/mchung]
== 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

12
Manifest.txt
View File

@ -8,7 +8,11 @@ lib/jekyll.rb
lib/jekyll/albino.rb
lib/jekyll/converters/csv.rb
lib/jekyll/converters/mephisto.rb
lib/jekyll/converters/mt.rb
lib/jekyll/converters/typo.rb
lib/jekyll/converters/wordpress.rb
lib/jekyll/convertible.rb
lib/jekyll/core_ext.rb
lib/jekyll/filters.rb
lib/jekyll/layout.rb
lib/jekyll/page.rb
@ -17,16 +21,18 @@ lib/jekyll/site.rb
lib/jekyll/tags/highlight.rb
lib/jekyll/tags/include.rb
test/helper.rb
test/source/_includes/sig.textile
test/source/_includes/sig.markdown
test/source/_layouts/default.html
test/source/_layouts/simple.html
test/source/_posts/2008-10-18-foo-bar.textile
test/source/_posts/2008-11-21-complex.textile
test/source/_posts/2008-12-13-include.textile
test/source/_posts/2008-12-03-permalinked-post.textile
test/source/_posts/2008-12-13-include.markdown
test/source/css/screen.css
test/source/index.html
test/source/posts/2008-12-03-permalinked-post.textile
test/suite.rb
test/test_filters.rb
test/test_generated_site.rb
test/test_jekyll.rb
test/test_post.rb
test/test_site.rb

98
README.textile
View File

@ -53,12 +53,11 @@ filename is used to construct the URL in the generated site. The example post,
for instance, ends up at
<code>http://tom.preston-werner.com/2008/11/17/blogging-like-a-hacker.html</code>.
Categories for posts are derived from the directory structure the posts were
found within.
A post that appears in the directory foo/bar/_posts is placed in the categories
'foo' and 'bar'.
By selecting posts from particular categories in your Liquid templates, you will
be able to host multiple blogs within a site.
Categories for posts are derived from the directory structure the posts were
found within. A post that appears in the directory foo/bar/_posts is placed in
the categories 'foo' and 'bar'. By selecting posts from particular categories
in your Liquid templates, you will be able to host multiple blogs within a
site.
Files that do not reside in directories prefixed with an underscore are
mirrored into a corresponding directory structure in the generated site. If a
@ -88,7 +87,7 @@ The best way to install Jekyll is via RubyGems:
$ sudo gem install mojombo-jekyll -s http://gems.github.com/
Jekyll requires the gems `directory_watcher`, `liquid`, `open4`,
and `maruku` for markdown support. These are automatically
and `maruku` (for markdown support). These are automatically
installed by the gem install command.
Maruku comes with optional support for LaTeX to PNG rendering via
@ -131,6 +130,21 @@ during the conversion:
$ jekyll --pygments
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
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
can launch a simple WEBrick server (works well in conjunction with --auto).
Default port is 4000:
$ jekyll --server [PORT]
h2. Data
Jekyll traverses your site looking for files to process. Any files with YAML
@ -150,7 +164,7 @@ h3. Global
content
In layout files, this contains the content of the subview(s). In Posts or
pages, this is undefined.
Pages, this is undefined.
h3. Site
@ -167,7 +181,7 @@ h3. Site
--lsi (latent semantic indexing) option.
site.categories.CATEGORY
The list of all posts in category CATEGORY.
The list of all Posts in category CATEGORY.
h3. Post
@ -185,12 +199,21 @@ h3. Post
An identifier unique to the Post (useful in RSS feeds).
e.g. /2008/12/14/my-post
post.categories
The list of categories to which this post belongs. Categories are
derived from the directory structure above the _posts directory. For
example, a post at /work/code/_posts/2008-12-24-closures.textile
would have this field set to ['work', 'code'].
post.topics
The list of topics for this Post. Topics are derived from the directory
structure beneath the _posts directory. For example, a post at
/_posts/music/metal/2008-12-24-metalocalypse.textile would have this field
set to ['music', 'metal'].
post.content
The content of the Post.
post.categories
The list of categories to which this post belongs.
h2. YAML Front Matter
Any files that contain a YAML front matter block will be processed by Jekyll
@ -263,9 +286,20 @@ 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 on your site, you can use the <code>include</code> tag.
If you have small page fragments that you wish to include in multiple places
on your site, you can use the <code>include</code> tag.
<pre>{% include sig.textile %}</pre>
@ -332,11 +366,49 @@ 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
# 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. Blog migrations
h3. Movable Type
To migrate your MT blog into Jekyll, you'll need read access to the database.
The lib/jekyll/converters/mt.rb module provides a simple convert to create
.markdown files in a _posts directory based on the entries contained therein.
$ export DB=my_mtdb
$ export USER=dbuser
$ export PASS=dbpass
$ ruby -r './lib/jekyll/converters/mt' -e 'Jekyll::MT.process( \
"#{ENV["DB"]}", "#{ENV["USER"]}", "#{ENV["PASS"]}")'
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.
h2. License
(The MIT License)

8
Rakefile
View File

@ -18,4 +18,12 @@ namespace :convert do
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

40
bin/jekyll
View File

@ -25,6 +25,11 @@ opts = OptionParser.new do |opts|
options[:auto] = true
end
opts.on("--server [PORT]", "Start web server (default port 4000)") do |port|
options[:server] = true
options[:server_port] = port || 4000
end
opts.on("--lsi", "Use LSI for better related posts") do
Jekyll.lsi = true
end
@ -32,6 +37,16 @@ opts = OptionParser.new do |opts|
opts.on("--pygments", "Use pygments to highlight code") do
Jekyll.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
end
end
opts.parse!
@ -69,6 +84,8 @@ case ARGV.size
end
if options[:auto]
require 'directory_watcher'
puts "Auto-regenerating enabled: #{source} -> #{destination}"
dw = DirectoryWatcher.new(source)
@ -83,7 +100,28 @@ if options[:auto]
dw.start
loop { sleep 1000 }
unless options[:server]
loop { sleep 1000 }
end
else
Jekyll.process(source, destination)
puts "Successfully generated site in #{destination}"
end
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

8
jekyll.gemspec
View File

@ -1,22 +1,22 @@
Gem::Specification.new do |s|
s.name = %q{jekyll}
s.version = "0.2.0"
s.version = "0.3.0"
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Tom Preston-Werner"]
s.date = %q{2008-12-14}
s.date = %q{2008-12-24}
s.default_executable = %q{jekyll}
s.email = ["tom@mojombo.com"]
s.executables = ["jekyll"]
s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/albino.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/convertible.rb", "lib/jekyll/filters.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "lib/jekyll/tags/highlight.rb", "lib/jekyll/tags/include.rb", "test/helper.rb", "test/source/_includes/sig.textile", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/_posts/2008-12-13-include.textile", "test/source/css/screen.css", "test/source/index.html", "test/source/posts/2008-12-03-permalinked-post.textile", "test/suite.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
s.files = ["History.txt", "Manifest.txt", "README.textile", "Rakefile", "bin/jekyll", "jekyll.gemspec", "lib/jekyll.rb", "lib/jekyll/albino.rb", "lib/jekyll/converters/csv.rb", "lib/jekyll/converters/mephisto.rb", "lib/jekyll/converters/mt.rb", "lib/jekyll/converters/wordpress.rb", "lib/jekyll/convertible.rb", "lib/jekyll/core_ext.rb", "lib/jekyll/filters.rb", "lib/jekyll/layout.rb", "lib/jekyll/page.rb", "lib/jekyll/post.rb", "lib/jekyll/site.rb", "lib/jekyll/tags/highlight.rb", "lib/jekyll/tags/include.rb", "test/helper.rb", "test/source/_includes/sig.markdown", "test/source/_layouts/default.html", "test/source/_layouts/simple.html", "test/source/_posts/2008-10-18-foo-bar.textile", "test/source/_posts/2008-11-21-complex.textile", "test/source/_posts/2008-12-03-permalinked-post.textile", "test/source/_posts/2008-12-13-include.markdown", "test/source/css/screen.css", "test/source/index.html", "test/suite.rb", "test/test_generated_site.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
s.has_rdoc = true
s.rdoc_options = ["--main", "README.txt"]
s.require_paths = ["lib"]
s.rubyforge_project = %q{jekyll}
s.rubygems_version = %q{1.3.0}
s.summary = %q{Jekyll is a simple, blog aware, static site generator.}
s.test_files = ["test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
s.test_files = ["test/test_generated_site.rb", "test/test_jekyll.rb", "test/test_post.rb", "test/test_site.rb"]
if s.respond_to? :specification_version then
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

7
lib/jekyll.rb
View File

@ -29,9 +29,9 @@ begin
rescue LoadError
puts "The maruku gem is required for markdown support!"
end
require 'directory_watcher'
# internal requires
require 'jekyll/core_ext'
require 'jekyll/site'
require 'jekyll/convertible'
require 'jekyll/layout'
@ -43,14 +43,15 @@ require 'jekyll/tags/include'
require 'jekyll/albino'
module Jekyll
VERSION = '0.2.0'
VERSION = '0.3.0'
class << self
attr_accessor :source, :dest, :lsi, :pygments
attr_accessor :source, :dest, :lsi, :pygments, :markdown_proc
end
Jekyll.lsi = false
Jekyll.pygments = false
Jekyll.markdown_proc = Proc.new { |x| Maruku.new(x).to_html }
def self.process(source, dest)
require 'classifier' if Jekyll.lsi

59
lib/jekyll/converters/mt.rb Normal file
View File

@ -0,0 +1,59 @@
# Created by Nick Gerakines, open source and publically available under the
# MIT license. Use this module at your own risk.
# I'm an Erlang/Perl/C++ guy so please forgive my dirty ruby.
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 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.
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

49
lib/jekyll/converters/typo.rb Normal file
View File

@ -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

18
lib/jekyll/convertible.rb
View File

@ -19,18 +19,18 @@ module Jekyll
self.data = YAML.load($1)
end
end
# Transform the contents based on the file extension.
#
# Returns nothing
def transform
case self.ext
when ".textile":
case self.ext[1..-1]
when /textile/i
self.ext = ".html"
self.content = RedCloth.new(self.content).to_html
when ".markdown":
when /markdown/i, /mkdn/i, /md/i
self.ext = ".html"
self.content = Maruku.new(self.content).to_html
self.content = Jekyll.markdown_proc.call(self.content)
end
end
@ -39,10 +39,8 @@ module Jekyll
# +site_payload+ is the site payload hash
#
# Returns nothing
def do_layout(payload, layouts, site_payload)
# construct payload
payload = payload.merge(site_payload)
# render content
def do_layout(payload, layouts)
# render and transform content (this becomes the final content of the object)
self.content = Liquid::Template.parse(self.content).render(payload, [Jekyll::Filters])
self.transform
@ -52,7 +50,7 @@ module Jekyll
# recursively render layouts
layout = layouts[self.data["layout"]]
while layout
payload = payload.merge({"content" => self.output, "page" => payload['page']})
payload = payload.deep_merge({"content" => self.output, "page" => layout.data})
self.output = Liquid::Template.parse(layout.content).render(payload, [Jekyll::Filters])
layout = layouts[layout.data["layout"]]

22
lib/jekyll/core_ext.rb Normal file
View File

@ -0,0 +1,22 @@
class Hash
# Merges self with another hash, recursively.
#
# This code was lovingly stolen from some random gem:
# http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
#
# Thanks to whoever made it.
def deep_merge(hash)
target = dup
hash.keys.each do |key|
if hash[key].is_a? Hash and self[key].is_a? Hash
target[key] = target[key].deep_merge(hash[key])
next
end
target[key] = hash[key]
end
target
end
end

17
lib/jekyll/filters.rb
View File

@ -19,6 +19,21 @@ module Jekyll
def number_of_words(input)
input.split.length
end
end
def array_to_sentence_string(array)
connector = "and"
case array.length
when 0
""
when 1
array[0].to_s
when 2
"#{array[0]} #{connector} #{array[1]}"
else
"#{array[0...-1].join(', ')}, #{connector} #{array[-1]}"
end
end
end
end

15
lib/jekyll/layout.rb
View File

@ -28,21 +28,6 @@ module Jekyll
def process(name)
self.ext = File.extname(name)
end
# Add any necessary layouts to this post
# +layouts+ is a Hash of {"name" => "layout"}
# +site_payload+ is the site payload hash
#
# Returns nothing
def add_layout(layouts, site_payload)
payload = {"page" => self.data}.merge(site_payload)
self.content = Liquid::Template.parse(self.content).render(payload, [Jekyll::Filters])
layout = layouts[self.data["layout"]] || self.content
payload = {"content" => self.content, "page" => self.data}
self.content = Liquid::Template.parse(layout).render(payload, [Jekyll::Filters])
end
end
end

6
lib/jekyll/page.rb
View File

@ -37,9 +37,9 @@ module Jekyll
# +site_payload+ is the site payload hash
#
# Returns nothing
def add_layout(layouts, site_payload)
payload = {"page" => self.data}
do_layout(payload, layouts, site_payload)
def render(layouts, site_payload)
payload = {"page" => self.data}.deep_merge(site_payload)
do_layout(payload, layouts)
end
# Write the generated page file to the destination directory.

54
lib/jekyll/post.rb
View File

@ -8,7 +8,7 @@ module Jekyll
attr_accessor :lsi
end
MATCHER = /^(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
# Post name validator. Post filenames must be like:
# 2008-11-05-my-awesome-post.textile
@ -18,7 +18,7 @@ module Jekyll
name =~ MATCHER
end
attr_accessor :date, :slug, :ext, :categories
attr_accessor :date, :slug, :ext, :categories, :topics
attr_accessor :data, :content, :output
# Initialize this Post instance.
@ -27,15 +27,17 @@ module Jekyll
# +categories+ is an Array of Strings for the categories for this post
#
# Returns <Post>
def initialize(base, name)
@base = base
def initialize(source, dir, name)
@base = File.join(source, dir, '_posts')
@name = name
@categories = base.split('/').reject { |p| ['.', '_posts'].include? p }
self.categories = dir.split('/').reject { |x| x.empty? }
parts = name.split('/')
self.topics = parts.size > 1 ? parts[0..-2] : []
self.process(name)
self.read_yaml(base, name)
#Removed to avoid munging of liquid tags, replaced in convertible.rb#48
#self.transform
self.read_yaml(@base, name)
end
# Spaceship is based on Post#date
@ -50,7 +52,7 @@ module Jekyll
#
# Returns nothing
def process(name)
m, date, slug, ext = *name.match(MATCHER)
m, cats, date, slug, ext = *name.match(MATCHER)
self.date = Time.parse(date)
self.slug = slug
self.ext = ext
@ -63,10 +65,12 @@ module Jekyll
#
# Returns <String>
def dir
path = @categories ? '/' + @categories.join('/') : ''
permalink ?
permalink.to_s.split("/")[0..-2].join("/") :
"#{path}" + date.strftime("/%Y/%m/%d/")
if permalink
permalink.to_s.split("/")[0..-2].join("/")
else
prefix = self.categories.empty? ? '' : '/' + self.categories.join('/')
prefix + date.strftime("/%Y/%m/%d/")
end
end
# The full path and filename of the post.
@ -121,11 +125,16 @@ module Jekyll
# +site_payload+ is the site payload hash
#
# Returns nothing
def add_layout(layouts, site_payload)
# construct post payload
related = related_posts(site_payload["site"]["posts"])
payload = {"page" => self.to_liquid.merge(self.data)}
do_layout(payload, layouts, site_payload.merge({"site" => {"related_posts" => related}}))
def render(layouts, site_payload)
# construct payload
payload =
{
"site" => { "related_posts" => related_posts(site_payload["site"]["posts"]) },
"page" => self.to_liquid
}
payload = payload.deep_merge(site_payload)
do_layout(payload, layouts)
end
# Write the generated post file to the destination directory.
@ -145,11 +154,16 @@ module Jekyll
#
# Returns <Hash>
def to_liquid
{ "title" => self.data["title"] || "",
{ "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
"url" => self.url,
"date" => self.date,
"id" => self.id,
"content" => self.content }
"topics" => self.topics,
"content" => self.content }.deep_merge(self.data)
end
def inspect
"<Post: #{self.id}>"
end
end

92
lib/jekyll/site.rb
View File

@ -28,14 +28,15 @@ module Jekyll
self.write_posts
end
# Read all the files in <source>/_layouts into memory for
# later use.
# Read all the files in <source>/_layouts except backup files
# (end with "~") into memory for later use.
#
# Returns nothing
def read_layouts
base = File.join(self.source, "_layouts")
entries = Dir.entries(base)
entries = entries.reject { |e| File.directory?(e) }
entries = entries.reject { |e| e[-1..-1] == '~' }
entries = entries.reject { |e| File.directory?(File.join(base, e)) }
entries.each do |f|
name = f.split(".")[0..-2].join(".")
@ -45,16 +46,29 @@ module Jekyll
# ignore missing layout dir
end
# Read all the files in <base>/_posts and create a new Post
# object with each one.
# Read all the files in <base>/_posts except backup files (end with "~")
# and create a new Post object with each one.
#
# Returns nothing
def read_posts(base)
entries = Dir.entries(base)
entries = entries.reject { |e| File.directory?(e) }
def read_posts(dir)
base = File.join(self.source, dir, '_posts')
entries = []
Dir.chdir(base) { entries = Dir['**/*'] }
entries = entries.reject { |e| e[-1..-1] == '~' }
entries = entries.reject { |e| File.directory?(File.join(base, e)) }
# first pass processes, but does not yet render post content
entries.each do |f|
self.posts << Post.new(base, f) if Post.valid?(f)
if Post.valid?(f)
post = Post.new(self.source, dir, f)
self.posts << post
end
end
# second pass renders each post now that full site payload is available
self.posts.each do |post|
post.render(self.layouts, site_payload)
end
self.posts.sort!
@ -67,14 +81,14 @@ module Jekyll
# Returns nothing
def write_posts
self.posts.each do |post|
post.add_layout(self.layouts, site_payload)
post.write(self.dest)
end
end
# Copy all regular files from <source> to <dest>/ ignoring
# any files/directories that are hidden (start with ".") or contain
# site content (start with "_") unless they are "_posts" directories
# any files/directories that are hidden or backup files (start
# with "." or end with "~") or contain site content (start with "_")
# unless they are "_posts" directories
# The +dir+ String is a relative path used to call this method
# recursively as it descends through directories
#
@ -82,47 +96,63 @@ module Jekyll
def transform_pages(dir = '')
base = File.join(self.source, dir)
entries = Dir.entries(base)
entries = entries.reject { |e|
(e != '_posts') and ['.', '_'].include?(e[0..0])
}
entries = entries.reject { |e| e[-1..-1] == '~' }
entries = entries.reject do |e|
(e != '_posts') and ['.', '_'].include?(e[0..0])
end
# we need to make sure to process _posts *first* otherwise they
# might not be available yet to other templates as {{ site.posts }}
if entries.include?('_posts')
entries.delete('_posts')
read_posts(dir)
end
entries.each do |f|
if f == '_posts'
read_posts(File.join(base, f))
elsif File.directory?(File.join(base, f))
if File.directory?(File.join(base, f))
next if self.dest.sub(/\/$/, '') == File.join(base, f)
transform_pages(File.join(dir, f))
else
first3 = File.open(File.join(self.source, dir, f)) { |fd| fd.read(3) }
# if the file appears to have a YAML header then process it as a page
if first3 == "---"
# file appears to have a YAML header so process it as a page
page = Page.new(self.source, dir, f)
page.add_layout(self.layouts, site_payload)
page.render(self.layouts, site_payload)
page.write(self.dest)
# otherwise copy the file without transforming it
else
# otherwise copy the file without transforming it
FileUtils.mkdir_p(File.join(self.dest, dir))
FileUtils.cp(File.join(self.source, dir, f), File.join(self.dest, dir, f))
end
end
end
end
# Constructs a hash map of Posts indexed by the specified Post attribute
#
# Returns {post_attr => [<Post>]}
def post_attr_hash(post_attr)
# Build a hash map based on the specified post attribute ( post attr => array of posts )
# then sort each array in reverse order
hash = Hash.new { |hash, key| hash[key] = Array.new }
self.posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
hash.values.map { |sortme| sortme.sort! { |a, b| b <=> a} }
return hash
end
# The Hash payload containing site-wide data
#
# Returns {"site" => {"time" => <Time>, "posts" => [<Post>]}}
# Returns {"site" => {"time" => <Time>,
# "posts" => [<Post>],
# "categories" => [<Post>],
# "topics" => [<Post>] }}
def site_payload
# Build the category hash map of category ( names => arrays of posts )
# then sort each array in reverse order
categories = Hash.new { |hash,key| hash[key] = Array.new }
self.posts.each { |p| p.categories.each { |c| categories[c] << p } }
categories.values.map { |cats| cats.sort! { |a,b| b <=> a} }
{"site" => {
"time" => Time.now,
"posts" => self.posts.sort { |a,b| b <=> a },
"categories" => categories
"categories" => post_attr_hash('categories'),
"topics" => post_attr_hash('topics')
}}
end
end

19
lib/jekyll/tags/include.rb
View File

@ -7,10 +7,25 @@ module Jekyll
end
def render(context)
File.read(File.join(Jekyll.source, '_includes', @file))
if @file !~ /^[a-zA-Z0-9_\/\.-]+$/ || @file =~ /\.\// || @file =~ /\/\./
return "Include file '#{@file}' contains invalid characters or sequences"
end
Dir.chdir(File.join(Jekyll.source, '_includes')) do
choices = Dir['**/*'].reject { |x| File.symlink?(x) }
if choices.include?(@file)
source = File.read(@file)
partial = Liquid::Template.parse(source)
context.stack do
partial.render(context)
end
else
"Included file '#{@file}' not found in _includes directory"
end
end
end
end
end
Liquid::Template.register_tag('include', Jekyll::IncludeTag)
Liquid::Template.register_tag('include', Jekyll::IncludeTag)

0
test/source/_includes/sig.textile → test/source/_includes/sig.markdown
View File

0
test/source/posts/2008-12-03-permalinked-post.textile → test/source/_posts/2008-12-03-permalinked-post.textile
View File

8
test/source/_posts/2008-12-13-include.markdown Normal file
View File

@ -0,0 +1,8 @@
---
layout: default
title: Include
---
{% include sig.markdown %}
This _is_ cool

6
test/source/_posts/2008-12-13-include.textile
View File

@ -1,6 +0,0 @@
---
layout: default
title: Include
---
{% include sig.textile %}

12
test/source/index.html
View File

@ -5,8 +5,18 @@ title: Tom Preston-Werner
h1. Welcome to my site
h2. Please read our {{ site.posts | size }} Posts
<ul>
{% for post in site.posts %}
<li>{{ post.date }} <a href="{{ post.url }}">{{ post.title }}</a></li>
{% endfor %}
</ul>
</ul>
{% assign first_post = site.posts.first %}
<div id="first_post">
<h1>{{ first_post.title }}</h1>
<div>
{{ first_post.content }}
</div>
</div>

32
test/test_filters.rb Normal file
View File

@ -0,0 +1,32 @@
require File.dirname(__FILE__) + '/helper'
class TestFilters < Test::Unit::TestCase
class JekyllFilter
include Jekyll::Filters
end
def setup
@filter = JekyllFilter.new
end
def test_array_to_sentence_string_with_no_args
assert_equal "", @filter.array_to_sentence_string([])
end
def test_array_to_sentence_string_with_one_arg
assert_equal "1", @filter.array_to_sentence_string([1])
assert_equal "chunky", @filter.array_to_sentence_string(["chunky"])
end
def test_array_to_sentence_string_with_two_args
assert_equal "1 and 2", @filter.array_to_sentence_string([1, 2])
assert_equal "chunky and bacon", @filter.array_to_sentence_string(["chunky", "bacon"])
end
def test_array_to_sentence_string_with_multiple_args
assert_equal "1, 2, 3, and 4", @filter.array_to_sentence_string([1, 2, 3, 4])
assert_equal "chunky, bacon, bits, and pieces", @filter.array_to_sentence_string(["chunky", "bacon", "bits", "pieces"])
end
end

21
test/test_generated_site.rb Normal file
View File

@ -0,0 +1,21 @@
require File.dirname(__FILE__) + '/helper'
class TestGeneratedSite < Test::Unit::TestCase
def setup
clear_dest
source = File.join(File.dirname(__FILE__), *%w[source])
@s = Site.new(source, dest_dir)
@s.process
@index = File.read(File.join(dest_dir, 'index.html'))
end
def test_site_posts_in_index
# confirm that {{ site.posts }} is working
assert @index.include?("#{@s.posts.size} Posts")
end
def test_post_content_in_index
# confirm that the {{ post.content }} is rendered OK
assert @index.include?('<p>This <em>is</em> cool</p>')
end
end

30
test/test_post.rb
View File

@ -7,6 +7,9 @@ class TestPost < Test::Unit::TestCase
def test_valid
assert Post.valid?("2008-10-19-foo-bar.textile")
assert Post.valid?("foo/bar/2008-10-19-foo-bar.textile")
assert !Post.valid?("lol2008-10-19-foo-bar.textile")
assert !Post.valid?("blah")
end
@ -21,6 +24,7 @@ class TestPost < Test::Unit::TestCase
def test_url
p = Post.allocate
p.categories = []
p.process("2008-10-19-foo-bar.textile")
assert_equal "/2008/10/19/foo-bar.html", p.url
@ -29,7 +33,7 @@ class TestPost < Test::Unit::TestCase
def test_permalink
p = Post.allocate
p.process("2008-12-03-permalinked-post.textile")
p.read_yaml(File.join(File.dirname(__FILE__), *%w[source posts]), "2008-12-03-permalinked-post.textile")
p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-03-permalinked-post.textile")
assert_equal "my_category/permalinked-post", p.permalink
end
@ -37,7 +41,7 @@ class TestPost < Test::Unit::TestCase
def test_dir_respects_permalink
p = Post.allocate
p.process("2008-12-03-permalinked-post.textile")
p.read_yaml(File.join(File.dirname(__FILE__), *%w[source posts]), "2008-12-03-permalinked-post.textile")
p.read_yaml(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-03-permalinked-post.textile")
assert_equal "my_category", p.dir
end
@ -59,10 +63,10 @@ class TestPost < Test::Unit::TestCase
assert_equal "<h1>{{ page.title }}</h1>\n<p>Best <strong>post</strong> ever</p>", p.content
end
def test_add_layout
p = Post.new(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-10-18-foo-bar.textile")
def test_render
p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-10-18-foo-bar.textile")
layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
p.add_layout(layouts, {"site" => {"posts" => []}})
p.render(layouts, {"site" => {"posts" => []}})
assert_equal "<<< <h1>Foo Bar</h1>\n<p>Best <strong>post</strong> ever</p> >>>", p.output
end
@ -70,26 +74,26 @@ class TestPost < Test::Unit::TestCase
def test_write
clear_dest
p = Post.new(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-10-18-foo-bar.textile")
p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-10-18-foo-bar.textile")
layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
p.add_layout(layouts, {"site" => {"posts" => []}})
p.render(layouts, {"site" => {"posts" => []}})
p.write(dest_dir)
end
def test_data
p = Post.new(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-11-21-complex.textile")
p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-11-21-complex.textile")
layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
p.add_layout(layouts, {"site" => {"posts" => []}})
p.render(layouts, {"site" => {"posts" => []}})
assert_equal "<<< <p>url: /test/source/2008/11/21/complex.html<br />\ndate: #{Time.parse("2008-11-21")}<br />\nid: /test/source/2008/11/21/complex</p> >>>", p.output
assert_equal "<<< <p>url: /2008/11/21/complex.html<br />\ndate: #{Time.parse("2008-11-21")}<br />\nid: /2008/11/21/complex</p> >>>", p.output
end
def test_include
Jekyll.source = File.join(File.dirname(__FILE__), *%w[source])
p = Post.new(File.join(File.dirname(__FILE__), *%w[source _posts]), "2008-12-13-include.textile")
p = Post.new(File.join(File.dirname(__FILE__), *%w[source]), '', "2008-12-13-include.markdown")
layouts = {"default" => Layout.new(File.join(File.dirname(__FILE__), *%w[source _layouts]), "simple.html")}
p.add_layout(layouts, {"site" => {"posts" => []}})
p.render(layouts, {"site" => {"posts" => []}})
assert_equal "<<< <p>&#8212;<br />\nTom Preston-Werner<br />\ngithub.com/mojombo</p> >>>", p.output
assert_equal "<<< <hr />\n<p>Tom Preston-Werner github.com/mojombo</p>\n\n<p>This <em>is</em> cool</p> >>>", p.output
end
end

6
test/test_site.rb
View File

@ -17,9 +17,9 @@ class TestSite < Test::Unit::TestCase
end
def test_read_posts
@s.read_posts(File.join(@s.source, '_posts'))
@s.read_posts('')
assert_equal 3, @s.posts.size
assert_equal 4, @s.posts.size
end
def test_write_posts
@ -27,4 +27,4 @@ class TestSite < Test::Unit::TestCase
@s.process
end
end
end