jekyll 0.12.1 → 1.0.0.beta1

data/lib/jekyll/page.rb

@@ -1,5 +1,4 @@
 module Jekyll
-
   class Page
     include Convertible
 
@@ -24,6 +23,18 @@ module Jekyll
       self.read_yaml(File.join(base, dir), name)
     end
 
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      super(base, name)
+      self.data['layout'] = 'page' unless self.data.has_key?('layout')
+      self.data
+    end
+
     # The generated directory into which the page will be placed
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, we be '/'
@@ -45,10 +56,16 @@ module Jekyll
     #
     # Returns the template String.
     def template
-      if self.site.permalink_style == :pretty && !index? && html?
-        "/:basename/"
+      if self.site.permalink_style == :pretty
+        if index? && html?
+          "/:path/"
+        elsif html?
+          "/:path/:basename/"
+        else
+          "/:path/:basename:output_ext"
+        end
       else
-        "/:basename:output_ext"
+        "/:path/:basename:output_ext"
       end
     end
 
@@ -62,6 +79,7 @@ module Jekyll
         permalink
       else
         {
+          "path"       => @dir,
           "basename"   => self.basename,
           "output_ext" => self.output_ext,
         }.inject(template) { |result, token|
@@ -105,7 +123,7 @@ module Jekyll
     # Returns the Hash representation of this Page.
     def to_liquid
       self.data.deep_merge({
-        "url"        => File.join(@dir, self.url),
+        "url"        => self.url,
         "content"    => self.content })
     end
 
@@ -117,7 +135,7 @@ module Jekyll
     def destination(dest)
       # The url needs to be unescaped in order to preserve the correct
       # filename.
-      path = File.join(dest, @dir, CGI.unescape(self.url))
+      path = File.join(dest, CGI.unescape(self.url))
       path = File.join(path, "index.html") if self.url =~ /\/$/
       path
     end
@@ -149,7 +167,5 @@ module Jekyll
     def index?
       basename == 'index'
     end
-
   end
-
 end

data/lib/jekyll/plugin.rb

@@ -1,5 +1,4 @@
 module Jekyll
-
   class Plugin
     PRIORITIES = { :lowest => -100,
                    :low => -10,
@@ -73,5 +72,4 @@ module Jekyll
       # no-op for default
     end
   end
-
 end

data/lib/jekyll/post.rb

@@ -1,5 +1,4 @@
 module Jekyll
-
   class Post
     include Comparable
     include Convertible
@@ -8,12 +7,13 @@ module Jekyll
       attr_accessor :lsi
     end
 
+    # Valid post name regex.
     MATCHER = /^(.+\/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$/
 
     # Post name validator. Post filenames must be like:
-    #   2008-11-05-my-awesome-post.textile
+    # 2008-11-05-my-awesome-post.textile
     #
-    # Returns <Bool>
+    # Returns true if valid, false if not.
     def self.valid?(name)
       name =~ MATCHER
     end
@@ -25,15 +25,15 @@ module Jekyll
     attr_reader :name
 
     # Initialize this Post instance.
-    #   +site+ is the Site
-    #   +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
     #
-    # Returns <Post>
+    # site       - The Site.
+    # base       - The String path to the dir containing the post file.
+    # name       - The String filename of the post file.
+    #
+    # Returns the new Post.
     def initialize(site, source, dir, name)
       @site = site
-      @base = File.join(source, dir, '_posts')
+      @base = self.containing_dir(source, dir)
       @name = name
 
       self.categories = dir.split('/').reject { |x| x.empty? }
@@ -41,11 +41,11 @@ module Jekyll
       begin 
         self.read_yaml(@base, name)
       rescue Exception => msg
-        raise FatalException.new("#{msg} in #{@base}/#{name}")        
+        raise FatalException.new("#{msg} in #{@base}/#{name}")
       end
 
-      #If we've added a date and time to the yaml, use that instead of the filename date
-      #Means we'll sort correctly.
+      # If we've added a date and time to the YAML, use that instead of the
+      # filename date. Means we'll sort correctly.
       if self.data.has_key?('date')
         # ensure Time via to_s and reparse
         self.date = Time.parse(self.data["date"].to_s)
@@ -64,7 +64,27 @@ module Jekyll
       end
     end
 
-    # Spaceship is based on Post#date, slug
+    # Get the full path to the directory containing the post files
+    def containing_dir(source, dir)
+      return File.join(source, dir, '_posts')
+    end
+
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      super(base, name)
+      self.data['layout'] = 'post' unless self.data.has_key?('layout')
+      self.data
+    end
+
+    # Compares Post objects. First compares the Post date. If the dates are
+    # equal, it compares the Post slugs.
+    #
+    # other - The other Post we are comparing to.
     #
     # Returns -1, 0, 1
     def <=>(other)
@@ -75,10 +95,11 @@ module Jekyll
       return cmp
     end
 
-    # Extract information from the post filename
-    #   +name+ is the String filename of the post file
+    # Extract information from the post filename.
     #
-    # Returns nothing
+    # name - The String filename of the post file.
+    #
+    # Returns nothing.
     def process(name)
       m, cats, date, slug, ext = *name.match(MATCHER)
       self.date = Time.parse(date)
@@ -91,18 +112,17 @@ module Jekyll
     # The generated directory into which the post will be placed
     # upon generation. This is derived from the permalink or, if
     # permalink is absent, set to the default date
-    # e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing
+    # e.g. "/2008/11/05/" if the permalink style is :date, otherwise nothing.
     #
-    # Returns <String>
+    # Returns the String directory.
     def dir
       File.dirname(url)
     end
 
-    # The full path and filename of the post.
-    # Defined in the YAML of the post body
-    # (Optional)
+    # The full path and filename of the post. Defined in the YAML of the post
+    # body (optional).
     #
-    # Returns <String>
+    # Returns the String permalink.
     def permalink
       self.data && self.data['permalink']
     end
@@ -120,10 +140,10 @@ module Jekyll
       end
     end
 
-    # The generated relative url of this post
+    # The generated relative url of this post.
     # e.g. /2008/11/05/my-awesome-post.html
     #
-    # Returns <String>
+    # Returns the String URL.
     def url
       return @url if @url
 
@@ -137,7 +157,7 @@ module Jekyll
           "title"      => CGI.escape(slug),
           "i_day"      => date.strftime("%d").to_i.to_s,
           "i_month"    => date.strftime("%m").to_i.to_s,
-          "categories" => categories.map { |c| URI.escape(c) }.join('/'),
+          "categories" => categories.map { |c| URI.escape(c.to_s) }.join('/'),
           "output_ext" => self.output_ext
         }.inject(template) { |result, token|
           result.gsub(/:#{Regexp.escape token.first}/, token.last)
@@ -150,25 +170,28 @@ module Jekyll
       @url
     end
 
-    # The UID for this post (useful in feeds)
+    # The UID for this post (useful in feeds).
     # e.g. /2008/11/05/my-awesome-post
     #
-    # Returns <String>
+    # Returns the String UID.
     def id
       File.join(self.dir, self.slug)
     end
 
     # Calculate related posts.
     #
-    # Returns [<Post>]
+    # Returns an Array of related Posts.
     def related_posts(posts)
       return [] unless posts.size > 1
 
       if self.site.lsi
         self.class.lsi ||= begin
-          puts "Running the classifier... this could take a while."
-          lsi = Classifier::LSI.new
+          puts "Starting the classifier..."
+          lsi = Classifier::LSI.new(:auto_rebuild => false)
+          $stdout.print("  Populating LSI... ");$stdout.flush
           posts.each { |x| $stdout.print(".");$stdout.flush;lsi.add_item(x) }
+          $stdout.print("\n  Rebuilding LSI index... ")
+          lsi.build_index
           puts ""
           lsi
         end
@@ -180,11 +203,12 @@ module Jekyll
       end
     end
 
-    # Add any necessary layouts to this post
-    #   +layouts+ is a Hash of {"name" => "layout"}
-    #   +site_payload+ is the site payload hash
+    # Add any necessary layouts to this post.
+    #
+    # layouts      - A Hash of {"name" => "layout"}.
+    # site_payload - The site payload hash.
     #
-    # Returns nothing
+    # Returns nothing.
     def render(layouts, site_payload)
       # construct payload
       payload = {
@@ -196,9 +220,10 @@ module Jekyll
     end
     
     # Obtain destination path.
-    #   +dest+ is the String path to the destination dir
     #
-    # Returns destination file path.
+    # dest - The String path to the destination dir.
+    #
+    # Returns destination file path String.
     def destination(dest)
       # The url needs to be unescaped in order to preserve the correct filename
       path = File.join(dest, CGI.unescape(self.url))
@@ -207,9 +232,10 @@ module Jekyll
     end
 
     # Write the generated post file to the destination directory.
-    #   +dest+ is the String path to the destination dir
     #
-    # Returns nothing
+    # dest - The String path to the destination dir.
+    #
+    # Returns nothing.
     def write(dest)
       path = destination(dest)
       FileUtils.mkdir_p(File.dirname(path))
@@ -220,7 +246,7 @@ module Jekyll
 
     # Convert this post into a Hash for use in Liquid templates.
     #
-    # Returns <Hash>
+    # Returns the representative Hash.
     def to_liquid
       self.data.deep_merge({
         "title"      => self.data["title"] || self.slug.split('-').select {|w| w.capitalize! || w }.join(' '),
@@ -234,6 +260,7 @@ module Jekyll
         "content"    => self.content })
     end
 
+    # Returns the shorthand String identifier of this Post.
     def inspect
       "<Post: #{self.id}>"
     end
@@ -257,5 +284,4 @@ module Jekyll
       end
     end
   end
-
 end

data/lib/jekyll/site.rb

@@ -1,11 +1,11 @@
 require 'set'
 
 module Jekyll
-
   class Site
     attr_accessor :config, :layouts, :posts, :pages, :static_files,
                   :categories, :exclude, :include, :source, :dest, :lsi, :pygments,
-                  :permalink_style, :tags, :time, :future, :safe, :plugins, :limit_posts
+                  :permalink_style, :tags, :time, :future, :safe, :plugins, :limit_posts,
+                  :show_drafts, :keep_files
 
     attr_accessor :converters, :generators
 
@@ -18,14 +18,16 @@ module Jekyll
       self.safe            = config['safe']
       self.source          = File.expand_path(config['source'])
       self.dest            = File.expand_path(config['destination'])
-      self.plugins         = Array(config['plugins']).map { |d| File.expand_path(d) }
+      self.plugins         = plugins_path
       self.lsi             = config['lsi']
       self.pygments        = config['pygments']
       self.permalink_style = config['permalink'].to_sym
       self.exclude         = config['exclude'] || []
       self.include         = config['include'] || []
       self.future          = config['future']
+      self.show_drafts     = config['show_drafts'] || nil
       self.limit_posts     = config['limit_posts'] || nil
+      self.keep_files      = config['keep_files'] || []
 
       self.reset
       self.setup
@@ -70,6 +72,12 @@ module Jekyll
     def setup
       require 'classifier' if self.lsi
 
+      # Check that the destination dir isn't the source dir or a directory
+      # parent to the source dir.
+      if self.source =~ /^#{self.dest}/
+        raise FatalException.new "Destination directory cannot be or contain the Source directory."
+      end
+
       # If safe mode is off, load in any Ruby files under the plugins
       # directory.
       unless self.safe
@@ -93,6 +101,17 @@ module Jekyll
       end
     end
 
+    # Internal: Setup the plugin search path
+    #
+    # Returns an Array of plugin search paths
+    def plugins_path
+      if (config['plugins'] == Jekyll::DEFAULTS['plugins'])
+        [File.join(self.source, config['plugins'])]
+      else
+        Array(config['plugins']).map { |d| File.expand_path(d) }
+      end
+    end
+
     # Read Site data from disk and load it into internal data structures.
     #
     # Returns nothing.
@@ -130,6 +149,18 @@ module Jekyll
 
       self.read_posts(dir)
 
+      if self.show_drafts
+        self.read_drafts(dir)
+      end
+
+      self.posts.sort!
+
+      # limit the posts if :limit_posts option is set
+      if limit_posts
+        limit = self.posts.length < limit_posts ? self.posts.length : limit_posts
+        self.posts = self.posts[-limit, limit]
+      end
+
       entries.each do |f|
         f_abs = File.join(base, f)
         f_rel = File.join(dir, f)
@@ -156,9 +187,7 @@ module Jekyll
     #
     # Returns nothing.
     def read_posts(dir)
-      base = File.join(self.source, dir, '_posts')
-      return unless File.exists?(base)
-      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+      entries = get_entries(dir, '_posts')
 
       # first pass processes, but does not yet render post content
       entries.each do |f|
@@ -166,19 +195,28 @@ module Jekyll
           post = Post.new(self, self.source, dir, f)
 
           if post.published && (self.future || post.date <= self.time)
-            self.posts << post
-            post.categories.each { |c| self.categories[c] << post }
-            post.tags.each { |c| self.tags[c] << post }
+            aggregate_post_info(post)
           end
         end
       end
+    end
 
-      self.posts.sort!
+    # Read all the files in <source>/<dir>/_drafts and create a new Post
+    # object with each one.
+    #
+    # dir - The String relative path of the directory to read.
+    #
+    # Returns nothing.
+    def read_drafts(dir)
+      entries = get_entries(dir, '_drafts')
 
-      # limit the posts if :limit_posts option is set
-      if limit_posts
-        limit = self.posts.length < limit_posts ? self.posts.length : limit_posts
-        self.posts = self.posts[-limit, limit]
+      # first pass processes, but does not yet render draft content
+      entries.each do |f|
+        if Draft.valid?(f)
+          draft = Draft.new(self, self.source, dir, f)
+
+          aggregate_post_info(draft)
+        end
       end
     end
 
@@ -217,7 +255,11 @@ module Jekyll
       # all files and directories in destination, including hidden ones
       dest_files = Set.new
       Dir.glob(File.join(self.dest, "**", "*"), File::FNM_DOTMATCH) do |file|
-        dest_files << file unless file =~ /\/\.{1,2}$/
+        if self.keep_files.length > 0
+          dest_files << file unless file =~ /\/\.{1,2}$/ || file =~ keep_file_regex
+        else
+          dest_files << file unless file =~ /\/\.{1,2}$/
+        end
       end
 
       # files to be written
@@ -238,10 +280,21 @@ module Jekyll
       files.merge(dirs)
 
       obsolete_files = dest_files - files
-
       FileUtils.rm_rf(obsolete_files.to_a)
     end
 
+    # Private: creates a regular expression from the keep_files array
+    #
+    # Examples
+    #   ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/
+    #
+    # Returns the regular expression
+    def keep_file_regex
+      or_list = self.keep_files.join("|")
+      pattern = "\/(#{or_list.gsub(".", "\.")})"
+      Regexp.new pattern
+    end
+
     # Write static files, pages, and posts.
     #
     # Returns nothing.
@@ -311,12 +364,12 @@ module Jekyll
     #
     # Returns the Array of filtered entries.
     def filter_entries(entries)
-      entries = entries.reject do |e|
-        unless self.include.include?(e)
+      entries.reject do |e|
+        unless self.include.glob_include?(e)
           ['.', '_', '#'].include?(e[0..0]) ||
           e[-1..-1] == '~' ||
-          self.exclude.include?(e) ||
-          File.symlink?(e)
+          self.exclude.glob_include?(e) ||
+          (File.symlink?(e) && self.safe)
         end
       end
     end
@@ -334,5 +387,28 @@ module Jekyll
         raise "Converter implementation not found for #{klass}"
       end
     end
+
+    # Read the entries from a particular directory for processing
+    #
+    # dir - The String relative path of the directory to read
+    # subfolder - The String directory to read
+    #
+    # Returns the list of entries to process
+    def get_entries(dir, subfolder)
+      base = File.join(self.source, dir, subfolder)
+      return [] unless File.exists?(base)
+      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+    end
+
+    # Aggregate post information
+    #
+    # post - The Post object to aggregate information for
+    #
+    # Returns nothing
+    def aggregate_post_info(post)
+      self.posts << post
+      post.categories.each { |c| self.categories[c] << post }
+      post.tags.each { |c| self.tags[c] << post }
+    end
   end
 end