henrik-jekyll 0.5.1 → 0.5.2

data/README.textile

@@ -1,5 +1,9 @@
 h1. Jekyll
 
+By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
+
+h2. Description
+
 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
@@ -172,11 +176,23 @@ To transform ".haml":http://github.com/nex3/haml/tree/master files to HTML
 
   $ jekyll --haml
 
-Note that files must have a YAML metadata block at the top to be converted,
-and that Haml cannot currently be used for layouts -- only posts and pages.
+Note that pages and posts must have a YAML metadata block at the top to be
+converted. Layouts don't need to.
 
 Haml content is intentionally not filtered, so you can use any Ruby code.
 
+If you want to define methods you can call from your Haml files, create
+a _helpers.rb file in the root of your blog and put the methods there,
+inside a module named Helpers.
+
+Jekyll provides some helpers out of the box:
+
+  h(string)
+    HTML entity-escapes the input string.
+    
+  link_to(text, url)
+    Creates a link to the URL with the linked text (or markup).
+
 h3. Local Server
 
 When previewing complex sites locally, simply opening the site in a web 
@@ -205,19 +221,15 @@ 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]
-  
-h3. Permalink Date Format
 
-By default, unless you set the --permalink option to 'none', permalinks begin
-with the date in a 'YYYY/MM/DD' format.
+Another way to leave off the .html is to configure Apache with 'Options +MultiViews'.
+Just link to pages without the extension (and without a trailing slash, like '/about').
+Then tell Jekyll not to add '.html' when linking to blog posts, like so:
 
-To customize this format, pass --permalink-date a strftime type format string.
-
-  $ jekyll --permalink-date [format string]
+  $ jekyll --multiviews
   
-For example, to use only the year and month in the slug:
-
-  $ jekyll --permalink-date %Y/%m
+Note that this has no effect with '--permalink pretty' since that makes an index.html
+file in a directory.
 
 h2. Configuration File
 
@@ -269,9 +281,8 @@ h2. Data
 
 Jekyll traverses your site looking for files to process. Any files with YAML
 front matter (see below) are subject to processing. For each of these files,
-Jekyll makes a variety of data available to the pages via Haml (regular pages
-only) or the Liquid templating system. The following is a reference of the
-available data.
+Jekyll makes a variety of data available to the pages via Haml or the Liquid
+Liquid templating system. The following is a reference of the available data.
 
 h3. Global
 
@@ -610,7 +621,7 @@ your changes merged back into core is as follows:
 # 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
+# Create an issue on mojombo/grit with a description and link to your branch
 
 h2. License
 

data/bin/jekyll

@@ -10,7 +10,7 @@ Basic Command Line Usage:
   jekyll <path to write generated site>                    # . -> <path>
   jekyll <path to source> <path to write generated site>   # <path> -> <path>
 
-  Configuration is read from '<source>/_config.yaml' but can be overriden
+  Configuration is read from '<source>/_config.yml' but can be overriden
   using the following options:
 
 HELP
@@ -55,9 +55,9 @@ opts = OptionParser.new do |opts|
   opts.on("--permalink [TYPE]", "Use 'date' (default) for YYYY/MM/DD") do |style|
     options['permalink'] = style unless style.nil?
   end
-  
-  opts.on("--permalink-date [FORMAT]", 'A strftime type format string. No times. (default format %Y/%m/%d)') do |format|
-    options['permalink_date'] = format unless format.nil?
+
+  opts.on("--multiviews", "Don't use .html in links since Apache has 'Options +MultiViews'") do |style|
+    options['multiviews'] = true
   end
 
   opts.on("--sass", "Use Sass from haml gem for CSS generation") do
@@ -153,4 +153,4 @@ if options['server']
 
   trap("INT") { s.shutdown }
   t.join()
-end
+end

data/lib/jekyll.rb

@@ -27,7 +27,7 @@ require 'jekyll/tags/include'
 require 'jekyll/albino'
 
 module Jekyll
-  # Default options. Overriden by values in _config.yaml or command-line opts.
+  # Default options. Overriden by values in _config.yml or command-line opts.
   # Strings are used instead of symbols for YAML compatibility.
   DEFAULTS = {
     'auto'         => false,
@@ -62,7 +62,7 @@ module Jekyll
     # then, we need to know where to look for _config.yml
     source = override['source'] || Jekyll::DEFAULTS['source']
 
-    # Get configuration from <source>/_config.yaml
+    # Get configuration from <source>/_config.yml
     config = {}
     config_file = File.join(source, '_config.yml')
     begin

data/lib/jekyll/albino.rb

@@ -71,7 +71,9 @@ class Albino
   end
 
   def colorize(options = {})
-    execute @@bin + convert_options(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
 

data/lib/jekyll/convertible.rb

@@ -59,6 +59,18 @@ module Jekyll
       end
       return 'unknown'
     end
+    
+    # Sets up a context for Haml and renders in it. The context has accessors
+    # matching the passed-in hash, e.g. "site", "page" and "content", and has
+    # helper modules mixed in.
+    #
+    # Returns String.
+    def render_haml_in_context(haml_engine, params={})
+      context = ClosedStruct.new(params)
+      context.extend(HamlHelpers)
+      context.extend(::Helpers) if defined?(::Helpers)
+      haml_engine.render(context)
+    end
 
     # Add any necessary layouts to this convertible document
     #   +layouts+ is a Hash of {"name" => "layout"}
@@ -72,11 +84,10 @@ module Jekyll
       payload["content_type"] = self.content_type
       
       if self.content_type == "haml"
-        context = OpenStruct.new(:site => self.site, :page => OpenStruct.new(payload["page"]))
-        context.extend(HamlHelpers)
-        
         self.transform
-        self.content = self.content.render(context)
+        self.content = render_haml_in_context(self.content,
+          :site => self.site,
+          :page => ClosedStruct.new(payload["page"]))
       else
         self.content = Liquid::Template.parse(self.content).render(payload, info)
         self.transform
@@ -89,7 +100,15 @@ module Jekyll
       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, info)
+        
+        if site.config['haml'] && layout.content.is_a?(Haml::Engine)
+          self.output = render_haml_in_context(layout.content, 
+            :site => ClosedStruct.new(payload["site"]),
+            :page => ClosedStruct.new(payload["page"]),
+            :content => payload["content"])
+        else
+          self.output = Liquid::Template.parse(layout.content).render(payload, info)
+        end
 
         layout = layouts[layout.data["layout"]]
       end

data/lib/jekyll/core_ext.rb

@@ -19,4 +19,11 @@ class Hash
 
     target
   end
-end
+end
+
+require 'ostruct'
+class ClosedStruct < OpenStruct
+  def method_missing(symbol, *args)
+    raise(NoMethodError, "undefined method `#{symbol}' for #{self}")
+  end
+end

data/lib/jekyll/filters.rb

@@ -1,5 +1,3 @@
-require 'cgi'
-
 module Jekyll
 
   module Filters
@@ -19,41 +17,18 @@ module Jekyll
       date.xmlschema
     end
 
-    def time_to_string(date)
-      date.strftime("%d %b %Y, %H:%M")
-    end
-
     def date_to_utc(date)
       date.utc
     end
 
-    def url_escape(input)
-      CGI.escape(input)
-    end
-
     def xml_escape(input)
-      CGI.escapeHTML(input)
+      input.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
     end
 
     def number_of_words(input)
       input.split.length
     end
 
-    # Example:
-    #
-    #   Posted in <span class="tags">{{ page.tags | tag_links: "example.com" }}</span>.
-    #
-    # Then style '.tags span { display: none; }' so the "tag:" bits don't show.
-    # You can provide 'tags' as a YAML array in the post's front matter.
-    def tag_links(array, domain)
-      links = array.map { |tag|
-        qs = %{site:#{domain} "tag: #{tag}"}
-        url = "http://www.google.com/search?q=#{url_escape qs}"
-        %{<a href="#{xml_escape url}"><span>tag:</span> #{xml_escape tag}</a>}
-      }
-      array_to_sentence_string(links)
-    end
-
     def array_to_sentence_string(array)
       connector = "and"
       case array.length

data/lib/jekyll/layout.rb

@@ -22,6 +22,7 @@ module Jekyll
 
       self.process(name)
       self.read_yaml(base, name)
+      self.transform
     end
 
     # Extract information from the layout filename

data/lib/jekyll/post.rb

@@ -20,9 +20,12 @@ module Jekyll
       name =~ MATCHER
     end
 
-    attr_accessor :site
-    attr_accessor :date, :slug, :ext, :categories, :tags, :topics, :published
-    attr_accessor :data, :content, :output
+    attr_accessor :site, :date, :slug, :ext, :topics, :tags, :published, :data, :content, :output
+    attr_writer :categories
+    
+    def categories
+      @categories ||= []
+    end
 
     # Initialize this Post instance.
     #   +site+ is the Site
@@ -97,16 +100,7 @@ module Jekyll
     #
     # Returns <String>
     def dir
-      if permalink
-        permalink.to_s.split("/")[0..-2].join("/") + '/'
-      else
-        prefix = self.categories.empty? ? '' : '/' + self.categories.join('/')
-        if [:date, :pretty].include?(self.site.permalink_style)
-          prefix + date.strftime(self.site.permalink_date || "/%Y/%m/%d/")
-        else
-          prefix + '/'
-        end
-      end
+      File.dirname(generated_path)
     end
 
     # The full path and filename of the post.
@@ -118,13 +112,43 @@ module Jekyll
       self.data && self.data['permalink']
     end
 
-    # The generated relative url of this post
+    def template
+      case self.site.permalink_style
+      when :pretty
+        "/:categories/:year/:month/:day/:title"
+      when :none
+        "/:categories/:title.html"
+      when :date
+        "/:categories/:year/:month/:day/:title.html"
+      else
+        self.site.permalink_style.to_s
+      end
+    end
+
+    # The generated relative path of this post
     # e.g. /2008/11/05/my-awesome-post.html
     #
     # Returns <String>
+    def generated_path
+      return permalink if permalink
+
+      @generated_path ||= {
+        "year"       => date.strftime("%Y"),
+        "month"      => date.strftime("%m"),
+        "day"        => date.strftime("%d"),
+        "title"      => slug,
+        "categories" => categories.sort.join('/')
+      }.inject(template) { |result, token|
+        result.gsub(/:#{token.first}/, token.last)
+      }.gsub("//", "/")
+    end
+    
+    # The generated relative url of this post
+    # e.g. /2008/11/05/my-awesome-post
+    #
+    # Returns <String>
     def url
-      ext = self.site.permalink_style == :pretty ? '' : '.html'
-      permalink || self.id + ext
+      site.config['multiviews'] ? generated_path.sub(/\.html$/, '') : generated_path
     end
 
     # The UID for this post (useful in feeds)
@@ -132,7 +156,7 @@ module Jekyll
     #
     # Returns <String>
     def id
-      self.dir + self.slug
+      File.join(self.dir, self.slug)
     end
     
     # The post title
@@ -155,6 +179,13 @@ module Jekyll
         end
       end
     end
+    
+    # The path to the post file.
+    #
+    # Returns <String>
+    def path
+      File.expand_path(File.join(@base, @name))
+    end
 
     # Calculate related posts.
     #
@@ -202,9 +233,9 @@ module Jekyll
     def write(dest)
       FileUtils.mkdir_p(File.join(dest, dir))
 
-      path = File.join(dest, self.url)
+      path = File.join(dest, self.generated_path)
 
-      if self.site.permalink_style == :pretty
+      if template[/\.html$/].nil?
         FileUtils.mkdir_p(path)
         path = File.join(path, "index.html")
       end
@@ -238,15 +269,37 @@ module Jekyll
         "url" => self.url,
         "date" => self.date,
         "id" => self.id,
+        "path" => self.path,
         "topics" => self.topics,
         "categories" => self.categories,
         "tags" => self.tags,
+        "next" => self.next,
+        "previous" => self.previous,
         "content" => self.content }.deep_merge(self.data)
     end
 
     def inspect
       "<Post: #{self.id}>"
     end
+
+    def next
+      pos = self.site.posts.index(self)
+
+      if pos && pos < self.site.posts.length-1
+        self.site.posts[pos+1]
+      else
+        nil
+      end
+    end
+
+    def previous
+      pos = self.site.posts.index(self)
+      if pos && pos > 0
+        self.site.posts[pos-1]
+      else
+        nil
+      end
+    end
   end
 
 end

data/lib/jekyll/site.rb

@@ -2,7 +2,7 @@ module Jekyll
 
   class Site
     attr_accessor :config, :layouts, :posts, :collated_posts, :categories, :tags
-    attr_accessor :source, :dest, :lsi, :pygments, :pygments_cache, :permalink_style, :permalink_date,
+    attr_accessor :source, :dest, :lsi, :pygments, :pygments_cache, :permalink_style,
                   :sass, :post_defaults
 
     # Initialize the site
@@ -18,7 +18,6 @@ module Jekyll
       self.pygments        = config['pygments']
       self.pygments_cache  = config['pygments_cache']
       self.permalink_style = config['permalink'].to_sym
-      self.permalink_date  = config['permalink_date'] && config['permalink_date'].sub(%r{\A/?(.*)/?\Z}, '/\1/')
       self.post_defaults   = config['post_defaults'] || {}
 
       self.reset
@@ -50,8 +49,9 @@ module Jekyll
       if self.config['haml']
         begin
           require 'haml'
-          require 'ostruct'
           require 'jekyll/haml_helpers'
+          helpers = File.join(source, '_helpers.rb')
+          require helpers if File.exist?(helpers)
           puts 'Enabled Haml'
         rescue LoadError
           puts 'You must have the haml gem installed first'
@@ -165,15 +165,14 @@ module Jekyll
         end
       end
 
+      self.posts.sort!
+
       # 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!
-      self.posts.each do |post|
         self.collated_posts[post.date.year][post.date.month][post.date.day].unshift(post)
       end
+
       self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a} }
       self.tags.values.map { |ps| ps.sort! { |a, b| b <=> a} }
     rescue Errno::ENOENT => e

data/test/test_generated_site.rb

@@ -18,7 +18,7 @@ class TestGeneratedSite < Test::Unit::TestCase
     end
 
     should "render post.content" do
-      latest_post = Dir[source_dir('_posts', '*')].last
+      latest_post = Dir[source_dir('_posts', '*')].sort.last
       post = Post.new(@site, source_dir, '', File.basename(latest_post))
       post.transform
       assert @index.include?(post.content)

data/test/test_post.rb

@@ -25,6 +25,7 @@ class TestPost < Test::Unit::TestCase
       assert !Post.valid?("blah")
     end
 
+
     context "processing posts" do
       setup do
         @post = Post.allocate
@@ -41,6 +42,8 @@ class TestPost < Test::Unit::TestCase
         assert_equal Time.parse("2008-10-19"), @post.date
         assert_equal "foo-bar", @post.slug
         assert_equal ".textile", @post.ext
+        assert_equal "/2008/10/19", @post.dir
+        assert_equal "/2008/10/19/foo-bar", @post.id
       end
 
       should "create url based on date and title" do
@@ -49,16 +52,94 @@ class TestPost < Test::Unit::TestCase
         assert_equal "/2008/10/19/foo-bar.html", @post.url
       end
 
-      should "respect permalink" do
+      should "respect permalink in yaml front matter" do
         file = "2008-12-03-permalinked-post.textile"
         @post.process(file)
         @post.read_yaml(@source, file)
 
         assert_equal "my_category/permalinked-post", @post.permalink
-        assert_equal "my_category/", @post.dir
+        assert_equal "my_category", @post.dir
         assert_equal "my_category/permalinked-post", @post.url
       end
 
+      context "with site wide permalink" do
+        setup do
+          @post.categories = []
+        end
+
+        context "with unspecified (date) style" do
+          setup do
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/:categories/:year/:month/:day/:title.html", @post.template
+            assert_equal "/2008/10/19/foo-bar.html", @post.url
+          end
+        end
+
+        context "with unspecified (date) style and a category" do
+          setup do
+            @post.categories << "beer"
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/:categories/:year/:month/:day/:title.html", @post.template
+            assert_equal "/beer/2008/10/19/foo-bar.html", @post.url
+          end
+        end
+
+        context "with unspecified (date) style and categories" do
+          setup do
+            @post.categories << "food"
+            @post.categories << "beer"
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/:categories/:year/:month/:day/:title.html", @post.template
+            assert_equal "/beer/food/2008/10/19/foo-bar.html", @post.url
+          end
+        end
+
+        context "with none style" do
+          setup do
+            @post.site.permalink_style = :none
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/:categories/:title.html", @post.template
+            assert_equal "/foo-bar.html", @post.url
+          end
+        end
+
+        context "with pretty style" do
+          setup do
+            @post.site.permalink_style = :pretty
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/:categories/:year/:month/:day/:title", @post.template
+            assert_equal "/2008/10/19/foo-bar", @post.url
+          end
+        end
+
+        context "with prefix style and no extension" do
+          setup do
+            @post.site.permalink_style = "/prefix/:title"
+            @post.process(@fake_file)
+          end
+
+          should "process the url correctly" do
+            assert_equal "/prefix/:title", @post.template
+            assert_equal "/prefix/foo-bar", @post.url
+          end
+        end
+      end
+
       should "read yaml front-matter" do
         @post.read_yaml(@source, @real_file)
 
@@ -75,6 +156,32 @@ class TestPost < Test::Unit::TestCase
       end
     end
 
+    context "when in a site" do
+      setup do
+        clear_dest
+        stub(Jekyll).configuration { Jekyll::DEFAULTS }
+        @site = Site.new(Jekyll.configuration)
+        @site.posts = [setup_post('2008-02-02-published.textile'),
+                       setup_post('2009-01-27-categories.textile')]
+      end
+
+      should "have next post" do
+        assert_equal(@site.posts.last, @site.posts.first.next)
+      end
+
+      should "have previous post" do
+        assert_equal(@site.posts.first, @site.posts.last.previous)
+      end
+
+      should "not have previous post if first" do
+        assert_equal(nil, @site.posts.first.previous)
+      end
+
+      should "not have next post if last" do
+        assert_equal(nil, @site.posts.last.next)
+      end
+    end
+
     context "initializing posts" do
       should "publish when published yaml is no specified" do
         post = setup_post("2008-02-02-published.textile")
@@ -118,6 +225,16 @@ class TestPost < Test::Unit::TestCase
           assert File.exists?(File.join(dest_dir, '2008', '10', '18', 'foo-bar.html'))
         end
 
+        should "write properly without html extension" do
+          post = setup_post("2008-10-18-foo-bar.textile")
+          post.site.permalink_style = ":title"
+          do_render(post)
+          post.write(dest_dir)
+
+          assert File.directory?(dest_dir)
+          assert File.exists?(File.join(dest_dir, 'foo-bar', 'index.html'))
+        end
+
         should "insert data" do
           post = setup_post("2008-11-21-complex.textile")
           do_render(post)

data/test/test_tags.rb

@@ -1,35 +1,51 @@
 require File.dirname(__FILE__) + '/helper'
 
 class TestTags < Test::Unit::TestCase
-  context "tagging" do
-    setup do
-      @content = <<CONTENT
+
+  def create_post(code)
+    stub(Jekyll).configuration do
+      Jekyll::DEFAULTS.merge({'pygments' => true})
+    end
+    site = Site.new(Jekyll.configuration)
+    info = { :filters => [Jekyll::Filters], :registers => { :site => site } }
+
+    content = <<CONTENT
 ---
-layout: post
 title: This is a test
-
 ---
-This document results in a markdown error with maruku
 
-{% highlight ruby %}
-puts "hi"
+This document results in a markdown error with maruku
 
-puts "bye"
+{% highlight text %}
+#{code}
 {% endhighlight %}
-
 CONTENT
+
+    @result = Liquid::Template.parse(content).render({}, info)
+    @result = site.markdown(@result)
+  end
+
+  context "post content has highlight tag" do
+    setup do
+      create_post("test")
+    end
+
+    should "not cause a markdown error" do
+      assert_no_match /markdown\-html\-error/, @result
+    end
+
+    should "render markdown with pygments line handling" do
+      assert_match %{<pre>test\n</pre>}, @result
+    end
+  end
+
+  context "post content has highlight tag with UTF character" do
+    setup do
+      create_post("Æ")
     end
 
     should "render markdown with pygments line handling" do
-      stub(Jekyll).configuration do
-        Jekyll::DEFAULTS.merge({'pygments' => true})
-      end
-      site = Site.new(Jekyll.configuration)
-      info = { :filters => [Jekyll::Filters], :registers => { :site => site } }
-
-      result = Liquid::Template.parse(@content).render({}, info)
-      result = site.markdown(result)
-      assert_no_match(/markdown\-html\-error/,result)
+      assert_match %{<pre>Æ\n</pre>}, @result
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: henrik-jekyll
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-15 00:00:00 -07:00
+date: 2009-04-27 00:00:00 -07:00
 default_executable: jekyll
 dependencies: 
 - !ruby/object:Gem::Dependency