sixones-jekyll 0.5.1 → 0.5.2

data/jekyll.gemspec

@@ -0,0 +1,134 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jekyll}
+  s.version = "0.5.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Preston-Werner"]
+  s.date = %q{2009-06-24}
+  s.default_executable = %q{jekyll}
+  s.description = %q{Jekyll is a simple, blog aware, static site generator.}
+  s.email = %q{tom@mojombo.com}
+  s.executables = ["jekyll"]
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/jekyll",
+     "features/create_sites.feature",
+     "features/embed_filters.feature",
+     "features/pagination.feature",
+     "features/permalinks.feature",
+     "features/post_data.feature",
+     "features/site_configuration.feature",
+     "features/site_data.feature",
+     "features/step_definitions/jekyll_steps.rb",
+     "features/support/env.rb",
+     "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/textpattern.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",
+     "lib/jekyll/pager.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-02-02-not-published.textile",
+     "test/source/_posts/2008-02-02-published.textile",
+     "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/_posts/2009-01-27-array-categories.textile",
+     "test/source/_posts/2009-01-27-categories.textile",
+     "test/source/_posts/2009-01-27-category.textile",
+     "test/source/_posts/2009-03-12-hash-#1.markdown",
+     "test/source/_posts/2009-05-18-tag.textile",
+     "test/source/_posts/2009-05-18-tags.textile",
+     "test/source/_posts/2009-06-22-empty-yaml.textile",
+     "test/source/_posts/2009-06-22-no-yaml.textile",
+     "test/source/about.html",
+     "test/source/category/_posts/2008-9-23-categories.textile",
+     "test/source/contacts.html",
+     "test/source/css/screen.css",
+     "test/source/foo/_posts/bar/2008-12-12-topical-post.textile",
+     "test/source/index.html",
+     "test/source/win/_posts/2009-05-24-yaml-linebreak.markdown",
+     "test/source/z_category/_posts/2008-9-23-categories.textile",
+     "test/suite.rb",
+     "test/test_configuration.rb",
+     "test/test_filters.rb",
+     "test/test_generated_site.rb",
+     "test/test_page.rb",
+     "test/test_pager.rb",
+     "test/test_post.rb",
+     "test/test_site.rb",
+     "test/test_tags.rb"
+  ]
+  s.homepage = %q{http://github.com/mojombo/jekyll}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{jekyll}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Jekyll is a simple, blog aware, static site generator.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/suite.rb",
+     "test/test_configuration.rb",
+     "test/test_filters.rb",
+     "test/test_generated_site.rb",
+     "test/test_page.rb",
+     "test/test_pager.rb",
+     "test/test_post.rb",
+     "test/test_site.rb",
+     "test/test_tags.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<RedCloth>, [">= 4.2.1"])
+      s.add_runtime_dependency(%q<liquid>, [">= 1.9.0"])
+      s.add_runtime_dependency(%q<classifier>, [">= 1.3.1"])
+      s.add_runtime_dependency(%q<maruku>, [">= 0.5.9"])
+      s.add_runtime_dependency(%q<directory_watcher>, [">= 1.1.1"])
+      s.add_runtime_dependency(%q<open4>, [">= 0.9.6"])
+    else
+      s.add_dependency(%q<RedCloth>, [">= 4.2.1"])
+      s.add_dependency(%q<liquid>, [">= 1.9.0"])
+      s.add_dependency(%q<classifier>, [">= 1.3.1"])
+      s.add_dependency(%q<maruku>, [">= 0.5.9"])
+      s.add_dependency(%q<directory_watcher>, [">= 1.1.1"])
+      s.add_dependency(%q<open4>, [">= 0.9.6"])
+    end
+  else
+    s.add_dependency(%q<RedCloth>, [">= 4.2.1"])
+    s.add_dependency(%q<liquid>, [">= 1.9.0"])
+    s.add_dependency(%q<classifier>, [">= 1.3.1"])
+    s.add_dependency(%q<maruku>, [">= 0.5.9"])
+    s.add_dependency(%q<directory_watcher>, [">= 1.1.1"])
+    s.add_dependency(%q<open4>, [">= 0.9.6"])
+  end
+end

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

@@ -17,12 +17,14 @@ 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]
-
+      
+      if self.content =~ /^(---\s*\n.*?\n?)(---.*?\n)/m
+        self.content = self.content[($1.size + $2.size)..-1]
+      
         self.data = YAML.load($1)
       end
+      
+      self.data ||= {}
     end
 
     # Transform the contents based on the file extension.

data/lib/jekyll/core_ext.rb

@@ -19,4 +19,12 @@ class Hash
 
     target
   end
-end
+end
+
+# Thanks, ActiveSupport!
+class Date
+  # Converts datetime to an appropriate format for use in XML
+  def xmlschema
+    strftime("%Y-%m-%dT%H:%M:%S%Z")
+  end if RUBY_VERSION < '1.9'
+end

data/lib/jekyll/filters.rb

@@ -18,7 +18,11 @@ module Jekyll
     end
 
     def xml_escape(input)
-      input.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
+      CGI.escapeHTML(input)
+    end
+
+    def cgi_escape(input)
+      CGI::escape(input)
     end
 
     def number_of_words(input)

data/lib/jekyll/page.rb

@@ -4,7 +4,7 @@ module Jekyll
     include Convertible
 
     attr_accessor :site
-    attr_accessor :ext
+    attr_accessor :name, :ext, :basename
     attr_accessor :data, :content, :output
 
     # Initialize a new Page.
@@ -17,14 +17,47 @@ module Jekyll
     def initialize(site, base, dir, name)
       @site = site
       @base = base
-      @dir = dir
+      @dir  = dir
       @name = name
 
-      self.data = {}
-
       self.process(name)
       self.read_yaml(File.join(base, dir), name)
-      #self.transform
+    end
+
+    # The generated directory into which the page will be placed
+    # upon generation. This is derived from the permalink or, if
+    # permalink is absent, set to '/'
+    #
+    # Returns <String>
+    def dir
+      url[-1, 1] == '/' ? url : File.dirname(url)
+    end
+
+    # The full path and filename of the post.
+    # Defined in the YAML of the post body
+    # (Optional)
+    #
+    # Returns <String>
+    def permalink
+      self.data && self.data['permalink']
+    end
+
+    def template
+      if self.site.permalink_style == :pretty && !index?
+        "/:name/"
+      else
+        "/:name.html"
+      end
+    end
+
+    # The generated relative url of this page
+    # e.g. /about.html
+    #
+    # Returns <String>
+    def url
+      return permalink if permalink
+
+      @url ||= template.gsub(':name', basename)
     end
 
     # Extract information from the page filename
@@ -33,6 +66,7 @@ module Jekyll
     # Returns nothing
     def process(name)
       self.ext = File.extname(name)
+      self.basename = name.split('.')[0..-2].first
     end
 
     # Add any necessary layouts to this post
@@ -46,22 +80,33 @@ module Jekyll
     end
 
     # Write the generated page file to the destination directory.
-    #   +dest+ is the String path to the destination dir
+    #   +dest_prefix+ is the String path to the destination dir
+    #   +dest_suffix+ is a suffix path to the destination dir
     #
     # Returns nothing
-    def write(dest)
-      FileUtils.mkdir_p(File.join(dest, @dir))
+    def write(dest_prefix, dest_suffix = nil)
+      dest = File.join(dest_prefix, @dir)
+      dest = File.join(dest, dest_suffix) if dest_suffix
+      FileUtils.mkdir_p(dest)
 
-      name = @name
-      if self.ext != ""
-        name = @name.split(".")[0..-2].join('.') + self.ext
+      # The url needs to be unescaped in order to preserve the correct filename
+      path = File.join(dest, CGI.unescape(self.url))
+      if self.url[/\.html$/].nil?
+        FileUtils.mkdir_p(path)
+        path = File.join(path, "index.html")
       end
 
-      path = File.join(dest, @dir, name)
       File.open(path, 'w') do |f|
         f.write(self.output)
       end
     end
+
+    private
+
+      def index?
+        basename == 'index'
+      end
+
   end
 
-end
+end

data/lib/jekyll/pager.rb

@@ -0,0 +1,45 @@
+module Jekyll
+  class Pager
+    attr_reader :page, :per_page, :posts, :total_posts, :total_pages, :previous_page, :next_page
+    
+    def self.calculate_pages(all_posts, per_page)
+      num_pages = all_posts.size / per_page.to_i
+      num_pages.abs + 1 if all_posts.size % per_page.to_i != 0
+      num_pages
+    end
+    
+    def self.pagination_enabled?(config, file)
+      file == 'index.html' && !config['paginate'].nil?
+    end
+    
+    def initialize(config, page, all_posts, num_pages = nil)
+      @page = page
+      @per_page = config['paginate'].to_i
+      @total_pages = num_pages || Pager.calculate_pages(all_posts, @per_page)
+      
+      if @page > @total_pages
+        raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
+      end
+      
+      init = (@page - 1) * @per_page
+      offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
+      
+      @total_posts = all_posts.size
+      @posts = all_posts[init..offset]
+      @previous_page = @page != 1 ? @page - 1 : nil
+      @next_page = @page != @total_pages ? @page + 1 : nil
+    end
+    
+    def to_hash
+      {
+        'page' => page, 
+        'per_page' => per_page, 
+        'posts' => posts, 
+        'total_posts' => total_posts,
+        'total_pages' => total_pages,
+        'previous_page' => previous_page,
+        'next_page' => next_page
+      }
+    end
+  end
+end

data/lib/jekyll/post.rb

@@ -18,9 +18,12 @@ module Jekyll
       name =~ MATCHER
     end
 
-    attr_accessor :site
-    attr_accessor :date, :slug, :ext, :categories, :topics, :published
-    attr_accessor :data, :content, :output
+    attr_accessor :site, :date, :slug, :ext, :published, :data, :content, :output, :tags
+    attr_writer :categories
+
+    def categories
+      @categories ||= []
+    end
 
     # Initialize this Post instance.
     #   +site+ is the Site
@@ -35,10 +38,6 @@ module Jekyll
       @name = name
 
       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)
 
@@ -48,6 +47,14 @@ module Jekyll
         self.published = true
       end
 
+      if self.data.has_key?("tag")
+        self.tags = [self.data["tag"]]
+      elsif self.data.has_key?("tags")
+        self.tags = self.data['tags']
+      else
+        self.tags = []
+      end
+
       if self.categories.empty?
         if self.data.has_key?('category')
           self.categories << self.data['category']
@@ -63,11 +70,15 @@ module Jekyll
       end
     end
 
-    # Spaceship is based on Post#date
+    # Spaceship is based on Post#date, slug
     #
     # Returns -1, 0, 1
     def <=>(other)
-      self.date <=> other.date
+      cmp = self.date <=> other.date
+      if 0 == cmp
+       cmp = self.slug <=> other.slug
+      end
+      return cmp
     end
 
     # Extract information from the post filename
@@ -88,16 +99,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("/%Y/%m/%d/")
-        else
-          prefix + '/'
-        end
-      end
+      File.dirname(url)
     end
 
     # The full path and filename of the post.
@@ -109,13 +111,35 @@ module Jekyll
       self.data && self.data['permalink']
     end
 
+    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 url of this post
     # e.g. /2008/11/05/my-awesome-post.html
     #
     # Returns <String>
     def url
-      ext = self.site.permalink_style == :pretty ? '' : '.html'
-      permalink || self.id + ext
+      return permalink if permalink
+
+      @url ||= {
+        "year"       => date.strftime("%Y"),
+        "month"      => date.strftime("%m"),
+        "day"        => date.strftime("%d"),
+        "title"      => CGI.escape(slug),
+        "categories" => categories.sort.join('/')
+      }.inject(template) { |result, token|
+        result.gsub(/:#{token.first}/, token.last)
+      }.gsub(/\/\//, "/")
     end
 
     # The UID for this post (useful in feeds)
@@ -123,7 +147,7 @@ module Jekyll
     #
     # Returns <String>
     def id
-      self.dir + self.slug
+      File.join(self.dir, self.slug)
     end
 
     # Calculate related posts.
@@ -172,9 +196,10 @@ module Jekyll
     def write(dest)
       FileUtils.mkdir_p(File.join(dest, dir))
 
-      path = File.join(dest, self.url)
+      # The url needs to be unescaped in order to preserve the correct filename
+      path = File.join(dest, CGI.unescape(self.url))
 
-      if self.site.permalink_style == :pretty
+      if template[/\.html$/].nil?
         FileUtils.mkdir_p(path)
         path = File.join(path, "index.html")
       end
@@ -188,18 +213,39 @@ module Jekyll
     #
     # Returns <Hash>
     def to_liquid
-      { "title" => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
-        "url" => self.url,
-        "date" => self.date,
-        "id" => self.id,
-        "topics" => self.topics,
+      { "title"      => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
+        "url"        => self.url,
+        "date"       => self.date,
+        "id"         => self.id,
         "categories" => self.categories,
-        "content" => self.content }.deep_merge(self.data)
+        "next"       => self.next,
+        "previous"   => self.previous,
+        "tags"       => self.tags,
+        "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

@@ -1,8 +1,8 @@
 module Jekyll
 
   class Site
-    attr_accessor :config, :layouts, :posts, :categories
-    attr_accessor :source, :dest, :lsi, :pygments, :permalink_style
+    attr_accessor :config, :layouts, :posts, :categories, :exclude,
+                  :source, :dest, :lsi, :pygments, :permalink_style, :tags
 
     # Initialize the site
     #   +config+ is a Hash containing site configurations details
@@ -16,6 +16,7 @@ module Jekyll
       self.lsi             = config['lsi']
       self.pygments        = config['pygments']
       self.permalink_style = config['permalink'].to_sym
+      self.exclude         = config['exclude'] || []
 
       self.reset
       self.setup
@@ -24,7 +25,8 @@ module Jekyll
     def reset
       self.layouts         = {}
       self.posts           = []
-      self.categories      = Hash.new { |hash, key| hash[key] = Array.new }
+      self.categories      = Hash.new { |hash, key| hash[key] = [] }
+      self.tags            = Hash.new { |hash, key| hash[key] = [] }
     end
 
     def setup
@@ -41,7 +43,6 @@ module Jekyll
               RDiscount.new(content).to_html
             end
 
-            puts 'Using rdiscount for Markdown'
           rescue LoadError
             puts 'You must have the rdiscount gem installed first'
           end
@@ -76,6 +77,8 @@ module Jekyll
           rescue LoadError
             puts "The maruku gem is required for markdown support!"
           end
+        else
+          raise "Invalid Markdown processor: '#{self.config['markdown']}' -- did you mean 'maruku' or 'rdiscount'?"
       end
       
       if self.config['custom_filters']
@@ -140,17 +143,20 @@ 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
 
+      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.categories.values.map { |cats| cats.sort! { |a, b| b <=> a} }
+      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
@@ -185,11 +191,14 @@ module Jekyll
         directories.delete('_posts')
         read_posts(dir)
       end
+      
       [directories, files].each do |entries|
         entries.each do |f|
           if File.directory?(File.join(base, f))
             next if self.dest.sub(/\/$/, '') == File.join(base, f)
             transform_pages(File.join(dir, f))
+          elsif Pager.pagination_enabled?(self.config, f)
+            paginate_posts(f, dir)
           else
             first3 = File.open(File.join(self.source, dir, f)) { |fd| fd.read(3) }
 
@@ -224,15 +233,13 @@ module Jekyll
     #
     # Returns {"site" => {"time" => <Time>,
     #                     "posts" => [<Post>],
-    #                     "categories" => [<Post>],
-    #                     "topics" => [<Post>] }}
+    #                     "categories" => [<Post>]}
     def site_payload
-      {"site" => {
-        "time" => Time.now,
-        "posts" => self.posts.sort { |a,b| b <=> a },
-        "categories" => post_attr_hash('categories'),
-        "topics" => post_attr_hash('topics')
-      }}
+      {"site" => self.config.merge({
+          "time"       => Time.now,
+          "posts"      => self.posts.sort { |a,b| b <=> a },
+          "categories" => post_attr_hash('categories'),
+          "tags"       => post_attr_hash('tags')})}
     end
 
     # Filter out any files/directories that are hidden or backup files (start
@@ -242,11 +249,32 @@ module Jekyll
     def filter_entries(entries)
       entries = entries.reject do |e|
         unless ['_posts', '.htaccess'].include?(e)
-          # Reject backup/hidden
-          ['.', '_', '#'].include?(e[0..0]) or e[-1..-1] == '~'
+          ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || self.exclude.include?(e)
         end
       end
     end
 
+    # Paginates the blog's posts. Renders the index.html file into paginated directories, ie: page2, page3...
+    # and adds more wite-wide data
+    #
+    # {"paginator" => { "page" => <Number>,
+    #                   "per_page" => <Number>,
+    #                   "posts" => [<Post>],
+    #                   "total_posts" => <Number>,
+    #                   "total_pages" => <Number>,
+    #                   "previous_page" => <Number>,
+    #                   "next_page" => <Number> }}
+    def paginate_posts(file, dir)
+      all_posts = self.posts.sort { |a,b| b <=> a }
+      pages = Pager.calculate_pages(all_posts, self.config['paginate'].to_i)
+      pages += 1
+      (1..pages).each do |num_page|
+        pager = Pager.new(self.config, num_page, all_posts, pages)
+        page = Page.new(self, self.source, dir, file)
+        page.render(self.layouts, site_payload.merge({'paginator' => pager.to_hash}))
+        suffix = "page#{num_page}" if num_page > 1
+        page.write(self.dest, suffix)
+      end
+    end
   end
 end