jekyll 1.2.1 → 1.3.0.rc

data/lib/jekyll.rb

@@ -20,6 +20,7 @@ require 'fileutils'
 require 'time'
 require 'safe_yaml'
 require 'English'
+require 'pathname'
 
 # 3rd party
 require 'liquid'
@@ -60,7 +61,7 @@ require_all 'jekyll/tags'
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
-  VERSION = '1.2.1'
+  VERSION = '1.3.0.rc'
 
   # Public: Generate a Jekyll configuration Hash by merging the default
   # options with anything in _config.yml, and adding the given options on top.

data/lib/jekyll/cleaner.rb

@@ -2,7 +2,7 @@ require 'set'
 
 module Jekyll
   class Site
-    # Handles the cleanup of a site's destination before the site is built.
+    # Handles the cleanup of a site's destination before it is built.
     class Cleaner
       def initialize(site)
         @site = site
@@ -15,14 +15,14 @@ module Jekyll
 
       private
 
-      # Private: The list of files and directories to be deleted during the cleanup process
+      # Private: The list of files and directories to be deleted during cleanup process
       #
-      # Returns an Array with the file and directory paths
+      # Returns an Array of the file and directory paths
       def obsolete_files
         (existing_files - new_files - new_dirs + replaced_files).to_a
       end
 
-      # Private: The list of existing files, except those included in keep_files and hidden files.
+      # Private: The list of existing files, apart from those included in keep_files and hidden files.
       #
       # Returns a Set with the file paths
       def existing_files
@@ -33,7 +33,7 @@ module Jekyll
         files
       end
 
-      # Private: The list of files to be created when the site is built.
+      # Private: The list of files to be created when site is built.
       #
       # Returns a Set with the file paths
       def new_files
@@ -42,7 +42,7 @@ module Jekyll
         files
       end
 
-      # Private: The list of directories to be created when the site is built.
+      # Private: The list of directories to be created when site is built.
       # These are the parent directories of the files in #new_files.
       #
       # Returns a Set with the directory paths
@@ -57,7 +57,7 @@ module Jekyll
         new_dirs.select { |dir| File.file?(dir) }.to_set
       end
 
-      # Private: creates a regular expression from the config's keep_files array
+      # Private: Creates a regular expression from the config's keep_files array
       #
       # Examples
       #   ['.git','.svn'] creates the following regex: /\/(\.git|\/.svn)/
@@ -70,4 +70,4 @@ module Jekyll
       end
     end
   end
-end
+end

data/lib/jekyll/commands/build.rb

@@ -31,27 +31,33 @@ module Jekyll
       #
       # Returns nothing.
       def self.watch(site, options)
-        require 'directory_watcher'
+        require 'listen'
 
         source = options['source']
         destination = options['destination']
 
-        Jekyll.logger.info "Auto-regeneration:", "enabled"
+        begin
+          dest = Pathname.new(destination).relative_path_from(Pathname.new(source)).to_path
+          ignored = Regexp.new(Regexp.escape(dest))
+        rescue ArgumentError
+          # Destination is outside the source, no need to ignore it.
+          ignored = nil
+        end
 
-        dw = DirectoryWatcher.new(source, :glob => self.globs(source, destination), :pre_load => true)
-        dw.interval = 1
+        Jekyll.logger.info "Auto-regeneration:", "enabled"
 
-        dw.add_observer do |*args|
+        listener = Listen.to(source, :ignore => ignored) do |modified, added, removed|
           t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
-          print Jekyll.logger.formatted_topic("Regenerating:") + "#{args.size} files at #{t} "
+          n = modified.length + added.length + removed.length
+          print Jekyll.logger.formatted_topic("Regenerating:") + "#{n} files at #{t} "
           self.process_site(site)
           puts  "...done."
         end
-
-        dw.start
+        listener.start
 
         unless options['serving']
           trap("INT") do
+            listener.stop
             puts "     Halting auto-regeneration."
             exit 0
           end

data/lib/jekyll/commands/serve.rb

@@ -18,6 +18,8 @@ module Jekyll
 
         s.mount(options['baseurl'], HTTPServlet::FileHandler, destination, fh_option)
 
+        Jekyll.logger.info "Server address:", "http://#{s.config[:BindAddress]}:#{s.config[:Port]}"
+
         if options['detach'] # detach the server
           pid = Process.fork { s.start }
           Process.detach(pid)

data/lib/jekyll/configuration.rb

@@ -10,10 +10,14 @@ module Jekyll
       'destination'   => File.join(Dir.pwd, '_site'),
       'plugins'       => '_plugins',
       'layouts'       => '_layouts',
+      'data_source'   =>  '_data',
       'keep_files'    => ['.git','.svn'],
+      'gems'          => [],
 
       'timezone'      => nil,           # use the local timezone
 
+      'encoding'      => nil,           # use the system encoding
+
       'safe'          => false,
       'detach'        => false,          # default to not detaching the server
       'show_drafts'   => nil,
@@ -23,7 +27,7 @@ module Jekyll
       'pygments'      => true,
 
       'relative_permalinks' => true,     # backwards-compatibility with < 1.0
-                                         # will be set to false once 1.1 hits
+                                         # will be set to false once 2.0 hits
 
       'markdown'      => 'maruku',
       'permalink'     => 'date',

data/lib/jekyll/converters/markdown/kramdown_parser.rb

@@ -16,7 +16,7 @@ module Jekyll
           if @config['kramdown']['use_coderay']
             %w[wrap line_numbers line_numbers_start tab_width bold_every css default_lang].each do |opt|
               key = "coderay_#{opt}"
-              @config['kramdown'][key.to_sym] = @config['kramdown']['coderay'][key] unless @config['kramdown'].has_key?(key)
+              @config['kramdown'][key] = @config['kramdown']['coderay'][key] unless @config['kramdown'].has_key?(key)
             end
           end
 

data/lib/jekyll/convertible.rb

@@ -20,16 +20,23 @@ module Jekyll
       self.content || ''
     end
 
+    # Returns merged optin hash for File.read of self.site (if exists)
+    # and a given param
+    def merged_file_read_opts(opts)
+      (self.site ? self.site.file_read_opts : {}).merge(opts)
+    end
+
     # Read the YAML frontmatter.
     #
     # base - The String path to the dir containing the file.
     # name - The String filename of the file.
+    # opts - optional parameter to File.read, default at site configs
     #
     # Returns nothing.
-    def read_yaml(base, name)
+    def read_yaml(base, name, opts = {})
       begin
-        self.content = File.read(File.join(base, name))
-
+        self.content = File.read_with_options(File.join(base, name),
+                                              merged_file_read_opts(opts))
         if self.content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
           self.content = $POSTMATCH
           self.data = YAML.safe_load($1)
@@ -77,10 +84,13 @@ module Jekyll
     # info    - the info for Liquid
     #
     # Returns the converted content
-    def render_liquid(content, payload, info)
+    def render_liquid(content, payload, info, path = nil)
       Liquid::Template.parse(content).render!(payload, info)
+    rescue Tags::IncludeTagError => e
+      Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{e.path}"
+      raise e
     rescue Exception => e
-      Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{self.path}"
+      Jekyll.logger.error "Liquid Exception:", "#{e.message} in #{path || self.path}"
       raise e
     end
 
@@ -111,7 +121,8 @@ module Jekyll
 
         self.output = self.render_liquid(layout.content,
                                          payload,
-                                         info)
+                                         info,
+                                         File.join(self.site.config['layouts'], layout.name))
 
         if layout = layouts[layout.data["layout"]]
           if used.include?(layout)

data/lib/jekyll/core_ext.rb

@@ -69,3 +69,18 @@ module Enumerable
     any? { |exp| File.fnmatch?(exp, e) }
   end
 end
+
+# Ruby 1.8's File.read don't support option.
+# read_with_options ignore optional parameter for 1.8,
+# and act as alias for 1.9 or later.
+class File
+  if RUBY_VERSION < '1.9'
+    def self.read_with_options(path, opts = {})
+      self.read(path)
+    end
+  else
+    def self.read_with_options(path, opts = {})
+      self.read(path, opts)
+    end
+  end
+end

data/lib/jekyll/filters.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'json'
 
 module Jekyll
   module Filters
@@ -148,6 +149,15 @@ module Jekyll
       end
     end
 
+    # Convert the input into json string
+    #
+    # input - The Array or Hash to be converted
+    #
+    # Returns the converted json string
+    def jsonify(input)
+      input.to_json
+    end
+
     private
     def time(input)
       case input

data/lib/jekyll/post.rb

@@ -19,10 +19,10 @@ module Jekyll
     ]
 
     # Attributes for Liquid templates
-    ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID.concat(%w[
+    ATTRIBUTES_FOR_LIQUID = EXCERPT_ATTRIBUTES_FOR_LIQUID + %w[
       content
       excerpt
-    ])
+    ]
 
     # Post name validator. Post filenames must be like:
     # 2008-11-05-my-awesome-post.textile

data/lib/jekyll/site.rb

@@ -3,7 +3,7 @@ module Jekyll
     attr_accessor :config, :layouts, :posts, :pages, :static_files,
                   :categories, :exclude, :include, :source, :dest, :lsi, :pygments,
                   :permalink_style, :tags, :time, :future, :safe, :plugins, :limit_posts,
-                  :show_drafts, :keep_files, :baseurl
+                  :show_drafts, :keep_files, :baseurl, :data, :file_read_opts, :gems
 
     attr_accessor :converters, :generators
 
@@ -13,7 +13,7 @@ module Jekyll
     def initialize(config)
       self.config          = config.clone
 
-      %w[safe lsi pygments baseurl exclude include future show_drafts limit_posts keep_files].each do |opt|
+      %w[safe lsi pygments baseurl exclude include future show_drafts limit_posts keep_files gems].each do |opt|
         self.send("#{opt}=", config[opt])
       end
 
@@ -22,6 +22,9 @@ module Jekyll
       self.plugins         = plugins_path
       self.permalink_style = config['permalink'].to_sym
 
+      self.file_read_opts = {}
+      self.file_read_opts[:encoding] = config['encoding'] if config['encoding']
+
       self.reset
       self.setup
     end
@@ -53,6 +56,7 @@ module Jekyll
       self.static_files    = []
       self.categories      = Hash.new { |hash, key| hash[key] = [] }
       self.tags            = Hash.new { |hash, key| hash[key] = [] }
+      self.data            = {}
 
       if self.limit_posts < 0
         raise ArgumentError, "limit_posts must be a non-negative number"
@@ -63,11 +67,7 @@ module Jekyll
     #
     # Returns nothing.
     def setup
-      # 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
+      ensure_not_in_dest
 
       # If safe mode is off, load in any Ruby files under the plugins
       # directory.
@@ -77,12 +77,26 @@ module Jekyll
               require f
             end
         end
+        self.gems.each do |gem|
+          require gem
+        end
       end
 
       self.converters = instantiate_subclasses(Jekyll::Converter)
       self.generators = instantiate_subclasses(Jekyll::Generator)
     end
 
+    # Check that the destination dir isn't the source dir or a directory
+    # parent to the source dir.
+    def ensure_not_in_dest
+      dest = Pathname.new(self.dest)
+      Pathname.new(self.source).ascend do |path|
+        if path == dest
+          raise FatalException.new "Destination directory cannot be or contain the Source directory."
+        end
+      end
+    end
+
     # Internal: Setup the plugin search path
     #
     # Returns an Array of plugin search paths
@@ -100,6 +114,7 @@ module Jekyll
     def read
       self.read_layouts
       self.read_directories
+      self.read_data(config['data_source'])
     end
 
     # Read all the files in <source>/<layouts> and create a new Layout object
@@ -110,7 +125,7 @@ module Jekyll
       base = File.join(self.source, self.config['layouts'])
       return unless File.exists?(base)
       entries = []
-      Dir.chdir(base) { entries = filter_entries(Dir['*.*']) }
+      Dir.chdir(base) { entries = filter_entries(Dir['**/*.*']) }
 
       entries.each do |f|
         name = f.split(".")[0..-2].join(".")
@@ -187,6 +202,25 @@ module Jekyll
       end
     end
 
+    # Read and parse all yaml files under <source>/<dir>
+    #
+    # Returns nothing
+    def read_data(dir)
+      base = File.join(self.source, dir)
+      return unless File.directory?(base) && (!self.safe || !File.symlink?(base))
+
+      entries = Dir.chdir(base) { Dir['*.{yaml,yml}'] }
+      entries.delete_if { |e| File.directory?(File.join(base, e)) }
+
+      entries.each do |entry|
+        path = File.join(self.source, dir, entry)
+        next if File.symlink?(path) && self.safe
+
+        key = sanitize_filename(File.basename(entry, '.*'))
+        self.data[key] = YAML.safe_load_file(path)
+      end
+    end
+
     # Run each of the Generators.
     #
     # Returns nothing.
@@ -200,14 +234,11 @@ module Jekyll
     #
     # Returns nothing.
     def render
-      payload = site_payload
-      self.posts.each do |post|
-        post.render(self.layouts, payload)
-      end
+      relative_permalinks_deprecation_method
 
-      self.pages.each do |page|
-        relative_permalinks_deprecation_method if page.uses_relative_permalinks
-        page.render(self.layouts, payload)
+      payload = site_payload
+      [self.posts, self.pages].flatten.each do |page_or_post|
+        page_or_post.render(self.layouts, payload)
       end
 
       self.categories.values.map { |ps| ps.sort! { |a, b| b <=> a } }
@@ -252,6 +283,14 @@ module Jekyll
       hash
     end
 
+    # Prepare site data for site payload. The method maintains backward compatibility
+    # if the key 'data' is already used in _config.yml.
+    #
+    # Returns the Hash to be hooked to site.data.
+    def site_data
+      self.config['data'] || self.data
+    end
+
     # The Hash payload containing site-wide data.
     #
     # Returns the Hash: { "site" => data } where data is a Hash with keys:
@@ -273,7 +312,8 @@ module Jekyll
           "pages"      => self.pages,
           "html_pages" => self.pages.reject { |page| !page.html? },
           "categories" => post_attr_hash('categories'),
-          "tags"       => post_attr_hash('tags')})}
+          "tags"       => post_attr_hash('tags'),
+          "data"       => site_data})}
     end
 
     # Filter out any files/directories that are hidden or backup files (start
@@ -349,15 +389,14 @@ module Jekyll
     end
 
     def relative_permalinks_deprecation_method
-      if config['relative_permalinks'] && !@deprecated_relative_permalinks
+      if config['relative_permalinks'] && has_relative_page?
         $stderr.puts # Places newline after "Generating..."
-        Jekyll.logger.warn "Deprecation:", "Starting in 1.1, permalinks for pages" +
+        Jekyll.logger.warn "Deprecation:", "Starting in 2.0, permalinks for pages" +
                                             " in subfolders must be relative to the" +
                                             " site source directory, not the parent" +
                                             " directory. Check http://jekyllrb.com/docs/upgrading/"+
                                             " for more info."
         $stderr.print Jekyll.logger.formatted_topic("") + "..." # for "done."
-        @deprecated_relative_permalinks = true
       end
     end
 
@@ -371,6 +410,10 @@ module Jekyll
 
     private
 
+    def has_relative_page?
+      self.pages.any? { |page| page.uses_relative_permalinks }
+    end
+
     def has_yaml_header?(file)
       "---" == File.open(file) { |fd| fd.read(3) }
     end
@@ -383,5 +426,11 @@ module Jekyll
     def site_cleaner
       @site_cleaner ||= Cleaner.new(self)
     end
+
+    def sanitize_filename(name)
+      name = name.gsub(/[^\w\s_-]+/, '')
+      name = name.gsub(/(^|\b\s)\s+($|\s?\b)/, '\\1\\2')
+      name = name.gsub(/\s+/, '_')
+    end
   end
 end