henrik-jekyll 0.5.0 → 0.5.1

data/README.textile

@@ -53,6 +53,12 @@ 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>.
 
+Jekyll also supports specifying the post time in the filename. The format is e.g.
+'2009-04-13_23-45-my-post.html'. Note that the time is prefixed by an underscore,
+not a dash, so post slugs starting with numbers won't be parsed incorrectly.
+Times in the filename must be on a 24-hour clock. Times and dates are treated by
+Jekyll as local time.
+
 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
@@ -135,6 +141,12 @@ use that to make your code blocks look pretty. To activate Pygments support
 during the conversion:
 
   $ jekyll --pygments
+  
+Highlighting a blog post can take a second or two, and with a lot of posts,
+it adds up. You can tell Jekyll to cache pygments output in a directory for
+faster re-rendering:
+
+  $ jekyll --pygments-cache [PATH]
 
 h3. Markdown Processor
 
@@ -144,6 +156,26 @@ compilation), you must install it (gem install rdiscount) and then you can
 have it used instead:
 
   $ jekyll --rdiscount
+  
+h3. Sass
+
+To transform all ".sass":http://github.com/nex3/haml/tree/master
+files anywhere in your file tree to CSS (e.g. '/css/site.sass' will
+generate '/css/site.css'):
+
+  $ jekyll --sass
+  
+h3. Haml
+
+To transform ".haml":http://github.com/nex3/haml/tree/master files to HTML
+(e.g. '/about.haml' will generate '/about.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.
+
+Haml content is intentionally not filtered, so you can use any Ruby code.
 
 h3. Local Server
 
@@ -173,6 +205,19 @@ 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.
+
+To customize this format, pass --permalink-date a strftime type format string.
+
+  $ jekyll --permalink-date [format string]
+  
+For example, to use only the year and month in the slug:
+
+  $ jekyll --permalink-date %Y/%m
 
 h2. Configuration File
 
@@ -211,12 +256,22 @@ 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.
 
+Additionally, you can set defaults for the post data blocks. For example, you
+can set the default layout for posts, so you don't have to specify it in every
+post:
+
+  post_defaults:
+    layout: post
+    
+Any values set in the actual post will override these defaults.
+
 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 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 (regular pages
+only) or the Liquid templating system. The following is a reference of the
+available data.
 
 h3. Global
 
@@ -239,6 +294,21 @@ h3. Site
 
   site.posts
     A reverse chronological list of all Posts.
+    
+  site.collated_posts
+    A nested hash by year, then month number, then day, then a list of Posts.
+    Suitable for post archives. You probably need to show these with Haml
+    since Liquid is too limited. For example:
+      - site.collated_posts.sort.reverse.each do |year,months|
+        %h2= year
+        - months.sort.reverse.each do |month,days|
+          %h3= Date::MONTHNAMES[month]
+          - days.sort.reverse.each do |day,posts|
+            %ol
+              - posts.each do |post|
+                %li
+                  %strong= "#{day}:"
+                  = link_to(h(post.title), post.url)
 
   site.related_posts
     If the page being processed is a Post, this contains a list of up to ten
@@ -249,6 +319,9 @@ h3. Site
   site.categories.CATEGORY
     The list of all Posts in category CATEGORY.
 
+  site.tags.TAG
+    The list of all Posts tagged TAG.
+
 h3. Post
 
   post.title
@@ -259,7 +332,7 @@ h3. Post
     e.g. /2008/12/14/my-post.html
 
   post.date
-    The Date assigned to the Post.
+    The Date (actually a Time object) assigned to the Post.
 
   post.id
     An identifier unique to the Post (useful in RSS feeds).
@@ -277,6 +350,10 @@ h3. Post
     /_posts/music/metal/2008-12-24-metalocalypse.textile would have this field
     set to ['music', 'metal'].
 
+  post.tags
+    The list of tags on this post. Tags are much like topics, but can only be
+    specified in the YAML part of a post, and are not reflected in the URL.
+
   post.content
     The content of the Post.
 
@@ -302,6 +379,9 @@ h3. Predefined Global Variables
     If set, this specifies the layout file to use. Use the layout file
     name without file extension. Layout files must be placed in the
     <code>_layouts</code> directory.
+    
+    A default layout for posts can be set in the configuration file.
+    See above.
 
 h3. Predefined Post Variables
 
@@ -313,12 +393,21 @@ h3. Predefined Post Variables
   published
     Set to false if you don't want a post to show up when the site is 
     generated.
+    
+  time
+    If you want posts to have a time, you can set this to e.g. '23:45' or
+    '11:45 pm'. This overrides any time specified in the filename like
+    '2009-04-12_23-44-my-post.html'. Note that you must quote the time:
+      time: "23:45"
 
   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.
 
+  tags
+    Similar to categories and topics but not reflected in the URL.
+
 h3. Custom Variables
 
 Any variables in the front matter that are not predefined are mixed into the
@@ -450,6 +539,10 @@ This would list all the posts in the category 'foo' by date and title.
 
 The posts within each category are sorted in reverse chronological order.
 
+h2. Tags
+
+Tags are like categories or topics but not reflected in the URL.
+
 h2. Blog migrations
 
 h3. Movable Type

data/bin/jekyll

@@ -43,6 +43,10 @@ opts = OptionParser.new do |opts|
   opts.on("--pygments", "Use pygments to highlight code") do
     options['pygments'] = true
   end
+  
+  opts.on("--pygments-cache", "Path to cache pygments output in, for faster re-rendering") do |path|
+    options['pygments_cache'] = path
+  end
 
   opts.on("--rdiscount", "Use rdiscount gem for Markdown") do
     options['markdown'] = 'rdiscount'
@@ -51,7 +55,19 @@ 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?
+  end
 
+  opts.on("--sass", "Use Sass from haml gem for CSS generation") do
+    options['sass'] = true
+  end
+  
+  opts.on("--haml", "Enable using Haml for posts and pages") do
+    options['haml'] = true
+  end
+  
   opts.on("--version", "Display current version") do
     puts "Jekyll " + Jekyll.version
     exit 0

data/lib/jekyll.rb

@@ -28,7 +28,7 @@ require 'jekyll/albino'
 
 module Jekyll
   # Default options. Overriden by values in _config.yaml or command-line opts.
-  # (Strings rather symbols used for compatability with YAML)
+  # Strings are used instead of symbols for YAML compatibility.
   DEFAULTS = {
     'auto'         => false,
     'server'       => false,
@@ -39,6 +39,7 @@ module Jekyll
 
     'lsi'          => false,
     'pygments'     => false,
+    'sass'         => false,
     'markdown'     => 'maruku',
     'permalink'    => 'date',
 

data/lib/jekyll/albino.rb

@@ -56,7 +56,7 @@ class Albino
 
   def initialize(target, lexer = :text, format = :html)
     @target  = File.exists?(target) ? File.read(target) : target rescue target
-    @options = { :l => lexer, :f => format }
+    @options = { :l => lexer, :f => format, :O => 'encoding=utf-8' }
   end
 
   def execute(command)

data/lib/jekyll/convertible.rb

@@ -21,7 +21,8 @@ module Jekyll
       if self.content =~ /^(---\s*\n.*?)\n---\s*\n/m
         self.content = self.content[($1.size + 5)..-1]
 
-        self.data = YAML.load($1)
+        self.data ||= {}
+        self.data = self.data.merge(YAML.load($1))
       end
     end
 
@@ -36,6 +37,10 @@ module Jekyll
       when 'markdown'
         self.ext = ".html"
         self.content = self.site.markdown(self.content)
+      when 'haml'
+        self.ext = ".html"
+        # Actually rendered in do_layout.
+        self.content = Haml::Engine.new(self.content, :attr_wrapper => %{"})
       end
     end
 
@@ -49,6 +54,8 @@ module Jekyll
         return 'textile'
       when /markdown/i, /mkdn/i, /md/i
         return 'markdown'
+      when /haml/i
+        return 'haml'
       end
       return 'unknown'
     end
@@ -63,8 +70,17 @@ module Jekyll
 
       # render and transform content (this becomes the final content of the object)
       payload["content_type"] = self.content_type
-      self.content = Liquid::Template.parse(self.content).render(payload, info)
-      self.transform
+      
+      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)
+      else
+        self.content = Liquid::Template.parse(self.content).render(payload, info)
+        self.transform
+      end
 
       # output keeps track of what will finally be written
       self.output = self.content

data/lib/jekyll/filters.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module Jekyll
 
   module Filters
@@ -17,14 +19,41 @@ 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)
-      input.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
+      CGI.escapeHTML(input)
     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/haml_helpers.rb

@@ -0,0 +1,15 @@
+require 'cgi'
+
+module Jekyll
+  module HamlHelpers
+    
+    def h(text)
+      CGI.escapeHTML(text)
+    end
+    
+    def link_to(text, url)
+      %{<a href="#{h url}">#{text}</a>}
+    end
+    
+  end
+end

data/lib/jekyll/post.rb

@@ -8,10 +8,12 @@ module Jekyll
       attr_accessor :lsi
     end
 
-    MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
+    MATCHER = /^(.+\/)*(\d+-\d+-\d+(?:_\d+-\d+)?)-(.*)(\.[^.]+)$/
 
     # Post name validator. Post filenames must be like:
     #   2008-11-05-my-awesome-post.textile
+    # or:
+    #   2008-11-05_12-45-my-awesome-post.textile
     #
     # Returns <Bool>
     def self.valid?(name)
@@ -19,7 +21,7 @@ module Jekyll
     end
 
     attr_accessor :site
-    attr_accessor :date, :slug, :ext, :categories, :topics, :published
+    attr_accessor :date, :slug, :ext, :categories, :tags, :topics, :published
     attr_accessor :data, :content, :output
 
     # Initialize this Post instance.
@@ -27,6 +29,7 @@ module Jekyll
     #   +base+ is the String path to the dir containing the post file
     #   +name+ is the String filename of the post file
     #   +categories+ is an Array of Strings for the categories for this post
+    #   +tags+ is an Array of Strings for the tags for this post
     #
     # Returns <Post>
     def initialize(site, source, dir, name)
@@ -40,8 +43,11 @@ module Jekyll
       self.topics = parts.size > 1 ? parts[0..-2] : []
 
       self.process(name)
+      self.data = self.site.post_defaults.dup
       self.read_yaml(@base, name)
 
+      extract_title_from_first_header_or_slug
+
       if self.data.has_key?('published') && self.data['published'] == false
         self.published = false
       else
@@ -61,6 +67,8 @@ module Jekyll
           end
         end
       end
+
+      self.tags = self.data['tags'] || []
     end
 
     # Spaceship is based on Post#date
@@ -76,6 +84,7 @@ module Jekyll
     # Returns nothing
     def process(name)
       m, cats, date, slug, ext = *name.match(MATCHER)
+      date = date.sub(/_(\d+)-(\d+)\Z/, ' \1:\2')  # Make optional time part parsable.
       self.date = Time.parse(date)
       self.slug = slug
       self.ext = ext
@@ -93,7 +102,7 @@ module Jekyll
       else
         prefix = self.categories.empty? ? '' : '/' + self.categories.join('/')
         if [:date, :pretty].include?(self.site.permalink_style)
-          prefix + date.strftime("/%Y/%m/%d/")
+          prefix + date.strftime(self.site.permalink_date || "/%Y/%m/%d/")
         else
           prefix + '/'
         end
@@ -125,6 +134,27 @@ module Jekyll
     def id
       self.dir + self.slug
     end
+    
+    # The post title
+    #
+    # Returns <String>
+    def title
+      self.data && self.data["title"]
+    end
+    
+    # The post date and time
+    #
+    # Returns <Time>
+    def date
+      @date_with_time ||= begin
+        if self.data && self.data.key?("time")
+          time = Time.parse(self.data["time"])
+          Time.mktime(@date.year, @date.month, @date.day, time.hour, time.min)
+        else
+          @date
+        end
+      end
+    end
 
     # Calculate related posts.
     #
@@ -183,17 +213,34 @@ module Jekyll
         f.write(self.output)
       end
     end
+    
+    # Attempt to extract title from topmost header or slug.
+    #
+    # Returns <String>
+    def extract_title_from_first_header_or_slug
+      # Done before the transformation to HTML, or it won't go into <title>s.
+      self.data["title"] ||=
+        case content_type
+        when 'textile'
+          self.content[/\A\s*h\d\.\s*(.+)/, 1]               # h1. Header
+        when 'markdown'
+          self.content[/\A\s*#+\s*(.+)\s*#*$/, 1] ||         # "# Header"
+          self.content[/\A\s*(\S.*)\r?\n\s*(-+|=+)\s*$/, 1]  # "Header\n====="
+        end
+      self.data["title"] ||= self.slug.split('-').select {|w| w.capitalize! || w }.join(' ')
+    end
 
     # Convert this post into a Hash for use in Liquid templates.
     #
     # Returns <Hash>
     def to_liquid
-      { "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+      { "title" => self.title,
         "url" => self.url,
         "date" => self.date,
         "id" => self.id,
         "topics" => self.topics,
         "categories" => self.categories,
+        "tags" => self.tags,
         "content" => self.content }.deep_merge(self.data)
     end
 

data/lib/jekyll/site.rb

@@ -1,8 +1,9 @@
 module Jekyll
 
   class Site
-    attr_accessor :config, :layouts, :posts, :categories
-    attr_accessor :source, :dest, :lsi, :pygments, :permalink_style
+    attr_accessor :config, :layouts, :posts, :collated_posts, :categories, :tags
+    attr_accessor :source, :dest, :lsi, :pygments, :pygments_cache, :permalink_style, :permalink_date,
+                  :sass, :post_defaults
 
     # Initialize the site
     #   +config+ is a Hash containing site configurations details
@@ -15,7 +16,10 @@ module Jekyll
       self.dest            = config['destination']
       self.lsi             = config['lsi']
       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
       self.setup
@@ -24,12 +28,41 @@ module Jekyll
     def reset
       self.layouts         = {}
       self.posts           = []
-      self.categories      = Hash.new { |hash, key| hash[key] = Array.new }
+      self.collated_posts  = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = Hash.new {|h,k| h[k] = [] } } }
+      self.categories      = Hash.new { |hash, key| hash[key] = [] }
+      self.tags            = Hash.new { |hash, key| hash[key] = [] }
     end
 
     def setup
       # Check to see if LSI is enabled.
       require 'classifier' if self.lsi
+      
+      if self.config['sass']
+        begin
+          require 'sass'
+          self.sass = true
+          puts 'Using Sass for CSS generation'
+        rescue LoadError
+          puts 'You must have the haml gem installed first'
+        end
+      end
+      
+      if self.config['haml']
+        begin
+          require 'haml'
+          require 'ostruct'
+          require 'jekyll/haml_helpers'
+          puts 'Enabled Haml'
+        rescue LoadError
+          puts 'You must have the haml gem installed first'
+        end
+      end
+      
+      if self.pygments_cache
+        require 'fileutils'
+        FileUtils.mkdir_p(pygments_cache)
+        require 'digest/md5'
+      end
 
       # Set the Markdown interpreter (and Maruku self.config, if necessary)
       case self.config['markdown']
@@ -91,6 +124,7 @@ module Jekyll
       self.reset
       self.read_layouts
       self.transform_pages
+      self.transform_sass if self.sass
       self.write_posts
     end
 
@@ -126,6 +160,7 @@ module Jekyll
           if post.published
             self.posts << post
             post.categories.each { |c| self.categories[c] << post }
+            post.tags.each { |c| self.tags[c] << post }
           end
         end
       end
@@ -136,7 +171,11 @@ module Jekyll
       end
 
       self.posts.sort!
-      self.categories.values.map { |cats| cats.sort! { |a, b| b <=> a} }
+      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
       # ignore missing layout dir
     end
@@ -194,6 +233,28 @@ module Jekyll
       end
     end
 
+    # Transform all *.sass files from <dest> to css with the same name
+    # and delete source sass files.
+    # Returns nothing
+    def transform_sass(dir = '')
+      base = File.join(self.source, dir)
+      entries = Dir.entries(base)
+      entries = entries.reject { |e| ['.', '_'].include?(e[0..0]) }
+      directories = entries.select { |e| File.directory?(File.join(base, e)) }
+      directories.each { |d| transform_sass(File.join(dir, d)) }
+      files = entries.reject { |e| File.directory?(File.join(base, e)) }
+      files = files.select { |f| File.extname(File.join(base, f)) == ".sass" }
+      files.each do |f|
+        input = File.open(File.join(base, f), "r")
+        result = Sass::Engine.new(input.read, :style => :compact, :load_paths => base).render
+        FileUtils.mkdir_p(File.join(self.dest, dir))
+        output = File.open(File.join(self.dest, dir, f).gsub(/.sass\Z/, ".css"), "w") do |o|
+          o.write(result)
+        end
+        FileUtils.rm(File.join(self.dest, dir, f))
+      end
+    end
+
     # Constructs a hash map of Posts indexed by the specified Post attribute
     #
     # Returns {post_attr => [<Post>]}
@@ -211,12 +272,14 @@ module Jekyll
     # Returns {"site" => {"time" => <Time>,
     #                     "posts" => [<Post>],
     #                     "categories" => [<Post>],
+    #                     "tags" => [<Post>],
     #                     "topics" => [<Post>] }}
     def site_payload
       {"site" => {
         "time" => Time.now,
         "posts" => self.posts.sort { |a,b| b <=> a },
         "categories" => post_attr_hash('categories'),
+        "tags" => post_attr_hash('tags'),
         "topics" => post_attr_hash('topics')
       }}
     end

data/lib/jekyll/tags/highlight.rb

@@ -30,12 +30,24 @@ module Jekyll
     end
 
     def render_pygments(context, code)
+      if cache_dir = context.registers[:site].pygments_cache
+        path = File.join(cache_dir, "#{@lang}-#{Digest::MD5.hexdigest(code)}.html")
+        if File.exist?(path)
+          highlighted_code = File.read(path)
+        else
+          highlighted_code = Albino.new(code, @lang).to_s(@options)
+          File.open(path, 'w') {|f| f.print(highlighted_code) }
+        end
+      else
+        highlighted_code = Albino.new(code, @lang).to_s(@options)
+      end
+        
       if context["content_type"] == :markdown
-        return "\n" + Albino.new(code, @lang).to_s(@options) + "\n"
+        return "\n" + highlighted_code + "\n"
       elsif context["content_type"] == :textile
-        return "<notextile>" + Albino.new(code, @lang).to_s(@options) + "</notextile>"
+        return "<notextile>" + highlighted_code + "</notextile>"
       else
-        return Albino.new(code, @lang).to_s(@options)
+        return highlighted_code
       end
     end
 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: henrik-jekyll
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Tom Preston-Werner
+- Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-07 00:00:00 -07:00
+date: 2009-04-15 00:00:00 -07:00
 default_executable: jekyll
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +98,7 @@ files:
 - lib/jekyll/convertible.rb
 - lib/jekyll/core_ext.rb
 - lib/jekyll/filters.rb
+- lib/jekyll/haml_helpers.rb
 - lib/jekyll/layout.rb
 - lib/jekyll/page.rb
 - lib/jekyll/post.rb