jekyll 2.0.0.alpha.2 → 2.0.0.alpha.3

data/lib/jekyll/configuration.rb

@@ -13,6 +13,7 @@ module Jekyll
       'data_source'   =>  '_data',
       'keep_files'    => ['.git','.svn'],
       'gems'          => [],
+      'collections'   => nil,
 
       'timezone'      => nil,           # use the local timezone
 
@@ -24,6 +25,7 @@ module Jekyll
       'limit_posts'   => 0,
       'lsi'           => false,
       'future'        => true,           # remove and make true just default
+      'unpublished'   => false,
 
       'relative_permalinks' => true,     # backwards-compatibility with < 1.0
                                          # will be set to false once 2.0 hits

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

@@ -16,7 +16,7 @@ module Jekyll
           def block_code(code, lang)
             require 'pygments'
             lang = lang && lang.split.first || "text"
-            output = add_code_tags(
+            add_code_tags(
               Pygments.highlight(code, :lexer => lang, :options => { :encoding => 'utf-8' }),
               lang
             )
@@ -34,21 +34,11 @@ module Jekyll
 
           def block_code(code, lang)
             lang = lang && lang.split.first || "text"
-            output = add_code_tags(code_wrap(code), lang)
+            add_code_tags(code_wrap(code), lang)
           end
         end
 
         module WithRouge
-          require 'rouge'
-          require 'rouge/plugins/redcarpet'
-
-          if Rouge.version < '1.3.0'
-            abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
-          end
-
-          include Rouge::Plugins::Redcarpet
-          include CommonMethods
-
           def block_code(code, lang)
             code = "<pre>#{super}</pre>"
 
@@ -77,6 +67,15 @@ module Jekyll
                           end
                         when 'rouge'
                           Class.new(Redcarpet::Render::HTML) do
+                            require 'rouge'
+                            require 'rouge/plugins/redcarpet'
+
+                            if Rouge.version < '1.3.0'
+                              abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
+                            end
+
+                            include Rouge::Plugins::Redcarpet
+                            include CommonMethods
                             include WithRouge
                           end
                         else

data/lib/jekyll/convertible.rb

@@ -43,7 +43,7 @@ module Jekyll
       begin
         self.content = File.read(File.join(base, name),
                                  merged_file_read_opts(opts))
-        if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
           self.content = $POSTMATCH
           self.data = SafeYAML.load($1)
         end

data/lib/jekyll/document.rb

@@ -0,0 +1,228 @@
+module Jekyll
+  class Document
+    include Comparable
+
+    attr_reader   :path, :site
+    attr_accessor :content, :collection, :output
+
+    # Create a new Document.
+    #
+    # site - the Jekyll::Site instance to which this Document belongs
+    # path - the path to the file
+    #
+    # Returns nothing.
+    def initialize(path, relations)
+      @site = relations[:site]
+      @path = path
+      @collection = relations[:collection]
+    end
+
+    # Fetch the Document's data.
+    #
+    # Returns a Hash containing the data. An empty hash is returned if
+    #   no data was read.
+    def data
+      @data ||= Hash.new
+    end
+
+    # The path to the document, relative to the site source.
+    #
+    # Returns a String path which represents the relative path
+    #   from the site source to this document
+    def relative_path
+      Pathname.new(path).relative_path_from(Pathname.new(site.source)).to_s
+    end
+
+    # The base filename of the document.
+    #
+    # suffix - (optional) the suffix to be removed from the end of the filename
+    #
+    # Returns the base filename of the document.
+    def basename(suffix = "")
+      File.basename(path, suffix)
+    end
+
+    # The extension name of the document.
+    #
+    # Returns the extension name of the document.
+    def extname
+      File.extname(path)
+    end
+
+    # Produces a "cleaned" relative path.
+    # The "cleaned" relative path is the relative path without the extname
+    #   and with the collection's directory removed as well.
+    # This method is useful when building the URL of the document.
+    #
+    # Examples:
+    #   When relative_path is "_methods/site/generate.md":
+    #     cleaned_relative_path
+    #     # => "/site/generate"
+    #
+    # Returns the cleaned relative path of the document.
+    def cleaned_relative_path
+      relative_path[0 .. -extname.length - 1].sub(collection.relative_directory, "")
+    end
+
+    # Determine whether the document is a YAML file.
+    #
+    # Returns true if the extname is either .yml or .yaml, false otherwise.
+    def yaml_file?
+      %w[.yaml .yml].include?(extname)
+    end
+
+    # Determine whether the document is an asset file.
+    # Asset files include CoffeeScript files and Sass/SCSS files.
+    #
+    # Returns true if the extname belongs to the set of extensions
+    #   that asset files use.
+    def asset_file?
+      %w[.sass .scss .coffee].include?(extname)
+    end
+
+    # Determine whether the file should be rendered with Liquid.
+    #
+    # Returns false if the document is either an asset file or a yaml file,
+    #   true otherwise.
+    def render_with_liquid?
+      !(asset_file? || yaml_file?)
+    end
+
+    # The URL template where the document would be accessible.
+    #
+    # Returns the URL template for the document.
+    def url_template
+      "/:collection/:path:output_ext"
+    end
+
+    # Construct a Hash of key-value pairs which contain a mapping between
+    #   a key in the URL template and the corresponding value for this document.
+    #
+    # Returns the Hash of key-value pairs for replacement in the URL.
+    def url_placeholders
+      {
+        collection: collection.label,
+        path:       cleaned_relative_path,
+        output_ext: Jekyll::Renderer.new(site, self).output_ext
+      }
+    end
+
+    # The permalink for this Document.
+    # Permalink is set via the data Hash.
+    #
+    # Returns the permalink or nil if no permalink was set in the data.
+    def permalink
+      data && data['permalink']
+    end
+
+    # The computed URL for the document. See `Jekyll::URL#to_s` for more details.
+    #
+    # Returns the computed URL for the document.
+    def url
+      @url ||= URL.new({
+        template:     url_template,
+        placeholders: url_placeholders,
+        permalink:    permalink
+      }).to_s
+    end
+
+    # The full path to the output file.
+    #
+    # base_directory - the base path of the output directory
+    #
+    # Returns the full path to the output file of this document.
+    def destination(base_directory)
+      path = Jekyll.sanitized_path(base_directory, url)
+      path = File.join(path, "index.html") if url =~ /\/$/
+      path
+    end
+
+    # Write the generated Document file to the destination directory.
+    #
+    # dest - The String path to the destination dir.
+    #
+    # Returns nothing.
+    def write(dest)
+      path = destination(dest)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'wb') do |f|
+        f.write(output)
+      end
+    end
+
+    # Returns merged option hash for File.read of self.site (if exists)
+    # and a given param
+    #
+    # opts - override options
+    #
+    # Return the file read options hash.
+    def merged_file_read_opts(opts)
+      site ? site.file_read_opts.merge(opts) : opts
+    end
+
+    # Whether the file is published or not, as indicated in YAML front-matter
+    #
+    # Returns true if the 'published' key is specified in the YAML front-matter and not `false`.
+    def published?
+      !(data.has_key?('published') && data['published'] == false)
+    end
+
+    # Read in the file and assign the content and data based on the file contents.
+    #
+    # Returns nothing.
+    def read(opts = {})
+      if yaml_file?
+        @data = SafeYAML.load_file(path)
+      else
+        begin
+          @content = File.read(path, merged_file_read_opts(opts))
+          if content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+            @content = $POSTMATCH
+            @data    = SafeYAML.load($1)
+          end
+        rescue SyntaxError => e
+          puts "YAML Exception reading #{path}: #{e.message}"
+        rescue Exception => e
+          puts "Error reading file #{path}: #{e.message}"
+        end
+      end
+    end
+
+    # Create a Liquid-understandable version of this Document.
+    #
+    # Returns a Hash representing this Document's data.
+    def to_liquid
+      Utils.deep_merge_hashes data, {
+        "content"       => content,
+        "path"          => path,
+        "relative_path" => relative_path,
+        "url"           => url
+      }
+    end
+
+    # The inspect string for this document.
+    # Includes the relative path and the collection label.
+    #
+    # Returns the inspect string for this document.
+    def inspect
+      "#<Jekyll::Document #{relative_path} collection=#{collection.label}>"
+    end
+
+    # The string representation for this document.
+    #
+    # Returns the content of the document
+    def to_s
+      output || content
+    end
+
+    # Compare this document against another document.
+    # Comparison is a comparison between the 2 paths of the documents.
+    #
+    # Returns -1, 0, +1 or nil depending on whether this doc's path is less than,
+    #   equal or greater than the other doc's path. See String#<=> for more details.
+    def <=>(anotherDocument)
+      path <=> anotherDocument.path
+    end
+
+  end
+end

data/lib/jekyll/entry_filter.rb

@@ -1,5 +1,7 @@
 module Jekyll
   class EntryFilter
+    SPECIAL_LEADING_CHARACTERS = ['.', '_', '#'].freeze
+
     attr_reader :site
 
     def initialize(site, base_directory = nil)
@@ -35,7 +37,8 @@ module Jekyll
     end
 
     def special?(entry)
-      ['.', '_', '#'].include?(entry[0..0])
+      SPECIAL_LEADING_CHARACTERS.include?(entry[0..0]) ||
+        SPECIAL_LEADING_CHARACTERS.include?(File.basename(entry)[0..0])
     end
 
     def backup?(entry)

data/lib/jekyll/layout_reader.rb

@@ -33,7 +33,7 @@ module Jekyll
     end
 
     def within(directory)
-      return unless File.exists?(directory)
+      return unless File.exist?(directory)
       Dir.chdir(directory) { yield }
     end
 

data/lib/jekyll/page.rb

@@ -135,7 +135,7 @@ module Jekyll
     #
     # Returns the destination file path String.
     def destination(dest)
-      path = Jekyll.sanitized_path(dest, url)
+      path = Jekyll.sanitized_path(dest, URL.unescape_path(url))
       path = File.join(path, "index.html") if url =~ /\/$/
       path
     end

data/lib/jekyll/plugin_manager.rb

@@ -0,0 +1,76 @@
+module Jekyll
+  class PluginManager
+    attr_reader :site
+
+    # Create an instance of this class.
+    #
+    # site - the instance of Jekyll::Site we're concerned with
+    #
+    # Returns nothing
+    def initialize(site)
+      @site = site
+    end
+
+    # Require all the plugins which are allowed.
+    #
+    # Returns nothing
+    def conscientious_require
+      require_plugin_files
+      require_gems
+    end
+
+    # Require each of the gem plugins specified.
+    #
+    # Returns nothing.
+    def require_gems
+      site.gems.each do |gem|
+        if plugin_allowed?(gem)
+          require gem
+        end
+      end
+    end
+
+    # Check whether a gem plugin is allowed to be used during this build.
+    #
+    # gem_name - the name of the gem
+    #
+    # Returns true if the gem name is in the whitelist or if the site is not
+    #   in safe mode.
+    def plugin_allowed?(gem_name)
+      !site.safe || whitelist.include?(gem_name)
+    end
+
+    # Build an array of allowed plugin gem names.
+    #
+    # Returns an array of strings, each string being the name of a gem name
+    #   that is allowed to be used.
+    def whitelist
+      @whitelist ||= Array[site.config['whitelist']].flatten
+    end
+
+    # Require all .rb files if safe mode is off
+    #
+    # Returns nothing.
+    def require_plugin_files
+      unless site.safe
+        plugins_path.each do |plugins|
+          Dir[File.join(plugins, "**", "*.rb")].sort.each do |f|
+            require f
+          end
+        end
+      end
+    end
+
+    # Public: Setup the plugin search path
+    #
+    # Returns an Array of plugin search paths
+    def plugins_path
+      if (site.config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins'])
+        [Jekyll.sanitized_path(site.source, site.config['plugins'])]
+      else
+        Array(site.config['plugins']).map { |d| File.expand_path(d) }
+      end
+    end
+
+  end
+end

data/lib/jekyll/post.rb

@@ -208,10 +208,10 @@ module Jekyll
         :year        => date.strftime("%Y"),
         :month       => date.strftime("%m"),
         :day         => date.strftime("%d"),
-        :title       => CGI.escape(slug),
+        :title       => 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.to_s) }.join('/'),
+        :categories  => (categories || []).map { |c| c.to_s }.join('/'),
         :short_month => date.strftime("%b"),
         :y_day       => date.strftime("%j"),
         :output_ext  => output_ext
@@ -260,7 +260,7 @@ module Jekyll
     # Returns destination file path String.
     def destination(dest)
       # The url needs to be unescaped in order to preserve the correct filename
-      path = Jekyll.sanitized_path(dest, CGI.unescape(url))
+      path = Jekyll.sanitized_path(dest, URL.unescape_path(url))
       path = File.join(path, "index.html") if path[/\.html$/].nil?
       path
     end

data/lib/jekyll/publisher.rb

@@ -0,0 +1,21 @@
+module Jekyll
+  class Publisher
+    def initialize(site)
+      @site = site
+    end
+
+    def publish?(thing)
+      can_be_published?(thing) && !hidden_in_the_future?(thing)
+    end
+
+    private
+
+    def can_be_published?(thing)
+      thing.data.fetch('published', true) || @site.unpublished
+    end
+
+    def hidden_in_the_future?(thing)
+      thing.is_a?(Post) && !@site.future && thing.date > @site.time
+    end
+  end
+end