jekyll 1.5.1 → 2.0.0.alpha.1

data/lib/jekyll/post.rb

@@ -9,6 +9,7 @@ module Jekyll
     EXCERPT_ATTRIBUTES_FOR_LIQUID = %w[
       title
       url
+      dir
       date
       id
       categories
@@ -34,7 +35,7 @@ module Jekyll
 
     attr_accessor :site
     attr_accessor :data, :extracted_excerpt, :content, :output, :ext
-    attr_accessor :date, :slug, :published, :tags, :categories
+    attr_accessor :date, :slug, :tags, :categories
 
     attr_reader :name
 
@@ -59,20 +60,10 @@ module Jekyll
         self.date = Time.parse(self.data["date"].to_s)
       end
 
-      self.published = self.published?
-
       self.populate_categories
       self.populate_tags
     end
 
-    def published?
-      if self.data.has_key?('published') && self.data['published'] == false
-        false
-      else
-        true
-      end
-    end
-
     def populate_categories
       if self.categories.empty?
         self.categories = self.data.pluralized_array('category', 'categories').map {|c| c.to_s.downcase}
@@ -86,7 +77,7 @@ module Jekyll
 
     # Get the full path to the directory containing the post files
     def containing_dir(source, dir)
-      File.join(source, dir, '_posts')
+      return File.join(source, dir, '_posts')
     end
 
     # Read the YAML frontmatter.
@@ -132,7 +123,7 @@ module Jekyll
 
     # The path to the post source file, relative to the site source
     def relative_path
-      File.join(@dir, '_posts', @name)
+      File.join(*[@dir, "_posts", @name].map(&:to_s).reject(&:empty?))
     end
 
     # Compares Post objects. First compares the Post date. If the dates are
@@ -160,7 +151,10 @@ module Jekyll
       self.slug = slug
       self.ext = ext
     rescue ArgumentError
-      raise FatalException.new("Post #{name} does not have a valid date.")
+      path = File.join(@dir || "", name)
+      msg  =  "Post '#{path}' does not have a valid date.\n"
+      msg  << "Fix the date, or exclude the file or directory from being processed"
+      raise FatalException.new(msg)
     end
 
     # The generated directory into which the post will be placed
@@ -266,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 = File.join(dest, CGI.unescape(self.url))
       path = File.join(path, "index.html") if path[/\.html$/].nil?
       path
     end
@@ -277,8 +271,7 @@ module Jekyll
     end
 
     def next
-      pos = self.site.posts.index(self)
-
+      pos = self.site.posts.index {|post| post.equal?(self) }
       if pos && pos < self.site.posts.length-1
         self.site.posts[pos+1]
       else
@@ -287,7 +280,7 @@ module Jekyll
     end
 
     def previous
-      pos = self.site.posts.index(self)
+      pos = self.site.posts.index {|post| post.equal?(self) }
       if pos && pos > 0
         self.site.posts[pos-1]
       else

data/lib/jekyll/site.rb

@@ -1,7 +1,7 @@
 module Jekyll
   class Site
     attr_accessor :config, :layouts, :posts, :pages, :static_files,
-                  :categories, :exclude, :include, :source, :dest, :lsi, :pygments,
+                  :categories, :exclude, :include, :source, :dest, :lsi, :highlighter,
                   :permalink_style, :tags, :time, :future, :safe, :plugins, :limit_posts,
                   :show_drafts, :keep_files, :baseurl, :data, :file_read_opts, :gems
 
@@ -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 gems].each do |opt|
+      %w[safe lsi highlighter baseurl exclude include future show_drafts limit_posts keep_files gems].each do |opt|
         self.send("#{opt}=", config[opt])
       end
 
@@ -77,11 +77,10 @@ module Jekyll
               require f
             end
         end
-        self.gems.each do |gem|
-          require gem
-        end
       end
 
+      require_gems
+
       self.converters = instantiate_subclasses(Jekyll::Converter)
       self.generators = instantiate_subclasses(Jekyll::Generator)
     end
@@ -97,6 +96,22 @@ module Jekyll
       end
     end
 
+    def require_gems
+      self.gems.each do |gem|
+        if plugin_allowed?(gem)
+          require gem
+        end
+      end
+    end
+
+    def plugin_allowed?(gem_name)
+      whitelist.include?(gem_name) || !self.safe
+    end
+
+    def whitelist
+      @whitelist ||= Array[self.config['whitelist']].flatten || []
+    end
+
     # Internal: Setup the plugin search path
     #
     # Returns an Array of plugin search paths
@@ -112,27 +127,11 @@ module Jekyll
     #
     # Returns nothing.
     def read
-      self.read_layouts
+      self.layouts = LayoutReader.new(self).read
       self.read_directories
       self.read_data(config['data_source'])
     end
 
-    # Read all the files in <source>/<layouts> and create a new Layout object
-    # with each one.
-    #
-    # Returns nothing.
-    def read_layouts
-      base = File.join(self.source, self.config['layouts'])
-      return unless File.exists?(base)
-      entries = []
-      Dir.chdir(base) { entries = filter_entries(Dir['**/*.*']) }
-
-      entries.each do |f|
-        name = f.split(".")[0..-2].join(".")
-        self.layouts[name] = Layout.new(self, base, f)
-      end
-    end
-
     # Recursively traverse directories to find posts, pages and static files
     # that will become part of the site according to the rules in
     # filter_entries.
@@ -142,7 +141,7 @@ module Jekyll
     # Returns nothing.
     def read_directories(dir = '')
       base = File.join(self.source, dir)
-      entries = Dir.chdir(base) { filter_entries(Dir.entries('.')) }
+      entries = Dir.chdir(base) { filter_entries(Dir.entries('.'), base) }
 
       self.read_posts(dir)
       self.read_drafts(dir) if self.show_drafts
@@ -155,11 +154,14 @@ module Jekyll
           f_rel = File.join(dir, f)
           read_directories(f_rel) unless self.dest.sub(/\/$/, '') == f_abs
         elsif has_yaml_header?(f_abs)
-          pages << Page.new(self, self.source, dir, f)
+          page = Page.new(self, self.source, dir, f)
+          pages << page if page.published?
         else
           static_files << StaticFile.new(self, self.source, dir, f)
         end
       end
+
+      pages.sort_by!(&:name)
     end
 
     # Read all the files in <source>/<dir>/_posts and create a new Post
@@ -169,10 +171,10 @@ module Jekyll
     #
     # Returns nothing.
     def read_posts(dir)
-      posts = read_things(dir, '_posts', Post)
+      posts = read_content(dir, '_posts', Post)
 
       posts.each do |post|
-        if post.published && (self.future || post.date <= self.time)
+        if post.published? && (self.future || post.date <= self.time)
           aggregate_post_info(post)
         end
       end
@@ -185,14 +187,14 @@ module Jekyll
     #
     # Returns nothing.
     def read_drafts(dir)
-      drafts = read_things(dir, '_drafts', Draft)
+      drafts = read_content(dir, '_drafts', Draft)
 
       drafts.each do |draft|
         aggregate_post_info(draft)
       end
     end
 
-    def read_things(dir, magic_dir, klass)
+    def read_content(dir, magic_dir, klass)
       get_entries(dir, magic_dir).map do |entry|
         klass.new(self, self.source, dir, entry) if klass.valid?(entry)
       end.reject do |entry|
@@ -215,7 +217,7 @@ module Jekyll
         next if File.symlink?(path) && self.safe
 
         key = sanitize_filename(File.basename(entry, '.*'))
-        self.data[key] = YAML.safe_load_file(path)
+        self.data[key] = SafeYAML.load_file(path)
       end
     end
 
@@ -322,8 +324,8 @@ module Jekyll
     # entries - The Array of String file/directory entries to filter.
     #
     # Returns the Array of filtered entries.
-    def filter_entries(entries)
-      EntryFilter.new(self).filter(entries)
+    def filter_entries(entries, base_directory = nil)
+      EntryFilter.new(self, base_directory).filter(entries)
     end
 
     # Get the implementation class for the given Converter.
@@ -364,7 +366,7 @@ module Jekyll
     def get_entries(dir, subfolder)
       base = File.join(self.source, dir, subfolder)
       return [] unless File.exists?(base)
-      entries = Dir.chdir(base) { filter_entries(Dir['**/*']) }
+      entries = Dir.chdir(base) { filter_entries(Dir['**/*'], base) }
       entries.delete_if { |e| File.directory?(File.join(base, e)) }
     end
 

data/lib/jekyll/tags/highlight.rb

@@ -41,8 +41,11 @@ eos
       end
 
       def render(context)
-        if context.registers[:site].pygments
+        case context.registers[:site].highlighter
+        when 'pygments'
           render_pygments(context, super)
+        when 'rouge'
+          render_rouge(context, super)
         else
           render_codehighlighter(context, super)
         end
@@ -58,9 +61,28 @@ eos
           @lang
         )
 
-        output = context["pygments_prefix"] + output if context["pygments_prefix"]
-        output = output + context["pygments_suffix"] if context["pygments_suffix"]
-        output
+        output = context["highlighter_prefix"] + output if context["highlighter_prefix"]
+        output << context["highlighter_suffix"] if context["highlighter_suffix"]
+
+        return output
+      end
+
+      def render_rouge(context, code)
+        require 'rouge'
+
+        linenos = @options.keys.include?('linenos')
+        lexer = Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText
+        formatter = Rouge::Formatters::HTML.new(line_numbers: linenos, wrap: false)
+
+        pre = "<pre>#{formatter.format(lexer.lex(code))}</pre>"
+
+        output = context["highlighter_prefix"] || ""
+        output << "<div class=\"highlight\">"
+        output << add_code_tags(pre, @lang)
+        output << "</div>"
+        output << context["highlighter_suffix"] if context["highlighter_suffix"]
+
+        return output
       end
 
       def render_codehighlighter(context, code)

data/lib/jekyll/tags/include.rb

@@ -14,12 +14,19 @@ module Jekyll
       SYNTAX_EXAMPLE = "{% include file.ext param='value' param2='value' %}"
 
       VALID_SYNTAX = /([\w-]+)\s*=\s*(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))/
+      VARIABLE_SYNTAX = /(?<variable>\{\{\s*(?<name>[\w\-\.]+)\s*(\|.*)?\}\})(?<params>.*)/
 
       INCLUDES_DIR = '_includes'
 
       def initialize(tag_name, markup, tokens)
         super
-        @file, @params = markup.strip.split(' ', 2);
+        matched = markup.strip.match(VARIABLE_SYNTAX)
+        if matched
+          @file = matched['variable'].strip
+          @params = matched['params'].strip
+        else
+          @file, @params = markup.strip.split(' ', 2);
+        end
         validate_params if @params
       end
 
@@ -48,7 +55,7 @@ module Jekyll
             raise ArgumentError.new <<-eos
 Invalid syntax for include tag. File contains invalid characters or sequences:
 
-	#{@file}
+	#{file}
 
 Valid syntax:
 
@@ -79,21 +86,23 @@ eos
         context.registers[:site].file_read_opts
       end
 
-      def retrieve_variable(context)
-        if /\{\{([\w\-\.]+)\}\}/ =~ @file
-          raise ArgumentError.new("No variable #{$1} was found in include tag") if context[$1].nil?
-          context[$1]
+      # Render the variable if required
+      def render_variable(context)
+        if @file.match(VARIABLE_SYNTAX)
+          partial = Liquid::Template.parse(@file)
+          partial.render!(context)
         end
       end
 
       def render(context)
-        dir = File.join(File.realpath(context.registers[:site].source), INCLUDES_DIR)
+        dir = File.join(context.registers[:site].source, INCLUDES_DIR)
+        validate_dir(dir, context.registers[:site].safe)
 
-        file = retrieve_variable(context) || @file
+        file = render_variable(context) || @file
         validate_file_name(file)
 
         path = File.join(dir, file)
-        validate_path(path, dir, context.registers[:site].safe)
+        validate_file(context.registers[:site].source, path, context.registers[:site].safe)
 
         begin
           partial = Liquid::Template.parse(source(path, context))
@@ -107,16 +116,19 @@ eos
         end
       end
 
-      def validate_path(path, dir, safe)
-        if safe && !realpath_prefixed_with?(path, dir)
-          raise IOError.new "The included file '#{path}' should exist and should not be a symlink"
-        elsif !File.exist?(path)
-          raise IOError.new "Included file '#{path}' not found"
+      def validate_dir(dir, safe)
+        if File.symlink?(dir) && safe
+          raise IOError.new "Includes directory '#{dir}' cannot be a symlink"
         end
       end
 
-      def realpath_prefixed_with?(path, dir)
-        File.exist?(path) && File.realpath(path).start_with?(dir)
+      def validate_file(sourcedir, file, safe)
+        relative_file = Pathname.new(file).relative_path_from(Pathname.new(sourcedir))
+        if !File.exists?(file)
+          raise IOError.new "Included file '#{relative_file}' not found" 
+        elsif File.symlink?(file) && safe
+          raise IOError.new "The included file '#{relative_file}' should not be a symlink"
+        end
       end
 
       def blank?
@@ -125,7 +137,7 @@ eos
 
       # This method allows to modify the file content by inheriting from the class.
       def source(file, context)
-        File.read_with_options(file, file_read_opts(context))
+        File.read(file, file_read_opts(context))
       end
     end
   end

data/lib/jekyll/tags/post_url.rb

@@ -7,6 +7,7 @@ module Jekyll
 
       def initialize(name)
         all, path, date, slug = *name.sub(/^\//, "").match(MATCHER)
+        raise ArgumentError.new("'#{name}' does not contain valid date and/or title") unless all
         @slug = path ? path + slug : slug
         @date = Time.parse(date)
       end
@@ -38,7 +39,15 @@ module Jekyll
       def initialize(tag_name, post, tokens)
         super
         @orig_post = post.strip
-        @post = PostComparer.new(@orig_post)
+        begin
+          @post = PostComparer.new(@orig_post)
+        rescue
+          raise ArgumentError.new <<-eos
+Could not parse name of post "#{@orig_post}" in tag 'post_url'.
+
+Make sure the post exists and the name is correct.
+eos
+        end
       end
 
       def render(context)

data/lib/jekyll/url.rb

@@ -50,7 +50,6 @@ module Jekyll
 
     # Returns a sanitized String URL
     def sanitize_url(in_url)
-
       # Remove all double slashes
       url = in_url.gsub(/\/\//, "/")
 
@@ -62,7 +61,6 @@ module Jekyll
 
       # Always add a leading slash
       url.gsub!(/\A([^\/])/, '/\1')
-
       url
     end
   end

data/lib/site_template/_config.yml

@@ -1,3 +1,3 @@
 name: Your New Jekyll Site
 markdown: redcarpet
-pygments: true
+highlighter: pygments

data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb

@@ -20,5 +20,5 @@ print_hi('Tom')
 
 Check out the [Jekyll docs][jekyll] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll's GitHub repo][jekyll-gh].
 
-[jekyll-gh]: https://github.com/mojombo/jekyll
+[jekyll-gh]: https://github.com/jekyll/jekyll
 [jekyll]:    http://jekyllrb.com