jekyll 1.5.1 → 2.0.0.alpha.1

data/lib/jekyll.rb

@@ -18,7 +18,7 @@ require 'rubygems'
 # stdlib
 require 'fileutils'
 require 'time'
-require 'safe_yaml'
+require 'safe_yaml/load'
 require 'English'
 require 'pathname'
 
@@ -27,6 +27,7 @@ require 'liquid'
 require 'maruku'
 require 'colorator'
 require 'toml'
+require 'sass'
 
 # internal requires
 require 'jekyll/core_ext'
@@ -47,6 +48,7 @@ require 'jekyll/errors'
 require 'jekyll/related_posts'
 require 'jekyll/cleaner'
 require 'jekyll/entry_filter'
+require 'jekyll/layout_reader'
 
 # extensions
 require 'jekyll/plugin'
@@ -60,10 +62,13 @@ require_all 'jekyll/converters/markdown'
 require_all 'jekyll/generators'
 require_all 'jekyll/tags'
 
+# plugins
+require 'jekyll-coffeescript'
+
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
 module Jekyll
-  VERSION = '1.5.1'
+  VERSION = '2.0.0.alpha.1'
 
   # Public: Generate a Jekyll configuration Hash by merging the default
   # options with anything in _config.yml, and adding the given options on top.
@@ -97,17 +102,4 @@ module Jekyll
   def self.logger
     @logger ||= Stevenson.new
   end
-
-  # Get a subpath without any of the traversal nonsense.
-  #
-  # Returns a pure and clean path
-  def self.sanitized_path(base_directory, questionable_path)
-    clean_path = File.expand_path(questionable_path, "/")
-    clean_path.gsub!(/\A\w\:\//, '/')
-    unless clean_path.start_with?(base_directory)
-      File.join(base_directory, clean_path)
-    else
-      clean_path
-    end
-  end
 end

data/lib/jekyll/commands/build.rb

@@ -4,6 +4,8 @@ module Jekyll
       def self.process(options)
         site = Jekyll::Site.new(options)
 
+        Jekyll.logger.log_level = Jekyll::Stevenson::ERROR if options['quiet']
+
         self.build(site, options)
         self.watch(site, options) if options['watch']
       end

data/lib/jekyll/commands/serve.rb

@@ -10,6 +10,15 @@ module Jekyll
 
         FileUtils.mkdir_p(destination)
 
+        # monkey patch WEBrick using custom 404 page (/404.html)
+        if File.exists?(File.join(destination, '404.html'))
+          WEBrick::HTTPResponse.class_eval do
+            def create_error_page
+              @body = IO.read(File.join(@config[:DocumentRoot], '404.html'))
+            end
+          end
+        end
+
         # recreate NondisclosureName under utf-8 circumstance
         fh_option = WEBrick::Config::FileHandler
         fh_option[:NondisclosureName] = ['.ht*','~*']
@@ -23,7 +32,7 @@ module Jekyll
         if options['detach'] # detach the server
           pid = Process.fork { s.start }
           Process.detach(pid)
-          Jekyll.logger.info "Server detatched with pid '#{pid}'.", "Run `kill -9 #{pid}' to stop the server."
+          Jekyll.logger.info "Server detached with pid '#{pid}'.", "Run `kill -9 #{pid}' to stop the server."
         else # create a new server thread, then join it with current terminal
           t = Thread.new { s.start }
           trap("INT") { s.shutdown }
@@ -33,6 +42,7 @@ module Jekyll
 
       def self.webrick_options(config)
         opts = {
+          :DocumentRoot => config['destination'],
           :Port => config['port'],
           :BindAddress => config['host'],
           :MimeTypes => self.mime_types,

data/lib/jekyll/configuration.rb

@@ -16,7 +16,7 @@ module Jekyll
 
       'timezone'      => nil,           # use the local timezone
 
-      'encoding'      => nil,           # use the system encoding
+      'encoding'      => 'utf-8',       # always use utf-8 encoding. NEVER FORGET
 
       'safe'          => false,
       'detach'        => false,          # default to not detaching the server
@@ -24,12 +24,12 @@ module Jekyll
       'limit_posts'   => 0,
       'lsi'           => false,
       'future'        => true,           # remove and make true just default
-      'pygments'      => true,
 
       'relative_permalinks' => true,     # backwards-compatibility with < 1.0
                                          # will be set to false once 2.0 hits
 
-      'markdown'      => 'maruku',
+      'markdown'      => 'kramdown',
+      'highlighter'   => 'pygments',
       'permalink'     => 'date',
       'baseurl'       => '/',
       'include'       => ['.htaccess'],
@@ -45,12 +45,12 @@ module Jekyll
       'excerpt_separator' => "\n\n",
 
       'maruku' => {
-        'fenced_code_blocks' => true,
         'use_tex'    => false,
         'use_divs'   => false,
         'png_engine' => 'blahtex',
         'png_dir'    => 'images/latex',
-        'png_url'    => '/images/latex'
+        'png_url'    => '/images/latex',
+        'fenced_code_blocks' => true
       },
 
       'rdiscount' => {
@@ -105,7 +105,7 @@ module Jekyll
       when '.toml'
         TOML.load_file(filename)
       when /\.y(a)?ml/
-        YAML.safe_load_file(filename)
+        SafeYAML.load_file(filename)
       else
         raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
       end
@@ -210,6 +210,16 @@ module Jekyll
         config.delete('server_port')
       end
 
+      if config.has_key? 'pygments'
+        Jekyll.logger.warn "Deprecation:", "The 'pygments' configuration option" +
+                            " has been renamed to 'highlighter'. Please update your" +
+                            " config file accordingly. The allowed values are 'rouge', " +
+                            "'pygments' or null."
+
+        config['highlighter'] = 'pygments' if config['pygments']
+        config.delete('pygments')
+      end
+
       %w[include exclude].each do |option|
         if config.fetch(option, []).is_a?(String)
           Jekyll.logger.warn "Deprecation:", "The '#{option}' configuration option" +
@@ -219,6 +229,12 @@ module Jekyll
           config[option] = csv_to_array(config[option])
         end
       end
+      
+      if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
+        Jekyll::Deprecator.deprecation_message "You're using the 'maruku' " +
+          "Markdown processor. Maruku support has been deprecated and will " +
+          "be removed in 3.0.0. We recommend you switch to Kramdown."
+      end
       config
     end
 

data/lib/jekyll/converter.rb

@@ -1,27 +1,27 @@
 module Jekyll
   class Converter < Plugin
-    # Public: Get or set the pygments prefix. When an argument is specified,
+    # Public: Get or set the highlighter prefix. When an argument is specified,
     # the prefix will be set. If no argument is specified, the current prefix
     # will be returned.
     #
-    # pygments_prefix - The String prefix (default: nil).
+    # highlighter_prefix - The String prefix (default: nil).
     #
     # Returns the String prefix.
-    def self.pygments_prefix(pygments_prefix = nil)
-      @pygments_prefix = pygments_prefix if pygments_prefix
-      @pygments_prefix
+    def self.highlighter_prefix(highlighter_prefix = nil)
+      @highlighter_prefix = highlighter_prefix if highlighter_prefix
+      @highlighter_prefix
     end
 
-    # Public: Get or set the pygments suffix. When an argument is specified,
+    # Public: Get or set the highlighter suffix. When an argument is specified,
     # the suffix will be set. If no argument is specified, the current suffix
     # will be returned.
     #
-    # pygments_suffix - The String suffix (default: nil).
+    # highlighter_suffix - The String suffix (default: nil).
     #
     # Returns the String suffix.
-    def self.pygments_suffix(pygments_suffix = nil)
-      @pygments_suffix = pygments_suffix if pygments_suffix
-      @pygments_suffix
+    def self.highlighter_suffix(highlighter_suffix = nil)
+      @highlighter_suffix = highlighter_suffix if highlighter_suffix
+      @highlighter_suffix
     end
 
     # Initialize the converter.
@@ -31,18 +31,18 @@ module Jekyll
       @config = config
     end
 
-    # Get the pygments prefix.
+    # Get the highlighter prefix.
     #
     # Returns the String prefix.
-    def pygments_prefix
-      self.class.pygments_prefix
+    def highlighter_prefix
+      self.class.highlighter_prefix
     end
 
-    # Get the pygments suffix.
+    # Get the highlighter suffix.
     #
     # Returns the String suffix.
-    def pygments_suffix
-      self.class.pygments_suffix
+    def highlighter_suffix
+      self.class.highlighter_suffix
     end
   end
 end

data/lib/jekyll/converters/markdown.rb

@@ -3,25 +3,27 @@ module Jekyll
     class Markdown < Converter
       safe true
 
-      pygments_prefix "\n"
-      pygments_suffix "\n"
+      highlighter_prefix "\n"
+      highlighter_suffix "\n"
 
       def setup
         return if @setup
-        @parser = case @config['markdown']
-          when 'redcarpet'
-            RedcarpetParser.new @config
-          when 'kramdown'
-            KramdownParser.new @config
-          when 'rdiscount'
-            RDiscountParser.new @config
-          when 'maruku'
-            MarukuParser.new @config
+        @parser =
+          case @config['markdown'].downcase
+            when 'redcarpet' then RedcarpetParser.new(@config)
+            when 'kramdown' then KramdownParser.new(@config)
+            when 'rdiscount' then RDiscountParser.new(@config)
+            when 'maruku' then MarukuParser.new(@config)
           else
-            STDERR.puts "Invalid Markdown processor: #{@config['markdown']}"
-            STDERR.puts "  Valid options are [ maruku | rdiscount | kramdown | redcarpet ]"
-            raise FatalException.new("Invalid Markdown process: #{@config['markdown']}")
-        end
+            # So they can't try some tricky bullshit or go down the ancestor chain, I hope.
+            if allowed_custom_class?(@config['markdown'])
+              self.class.const_get(@config['markdown']).new(@config)
+            else
+              Jekyll.logger.error "Invalid Markdown Processor:", "#{@config['markdown']}"
+              Jekyll.logger.error "", "Valid options are [ maruku | rdiscount | kramdown | redcarpet ]"
+              raise FatalException, "Invalid Markdown Processor: #{@config['markdown']}"
+            end
+          end
         @setup = true
       end
 
@@ -38,6 +40,19 @@ module Jekyll
         setup
         @parser.convert(content)
       end
+
+      private
+
+      # Private: Determine whether a class name is an allowed custom markdown
+      # class name
+      #
+      # parser_name - the name of the parser class
+      #
+      # Returns true if the parser name contains only alphanumeric characters
+      # and is defined within Jekyll::Converters::Markdown
+      def allowed_custom_class?(parser_name)
+        parser_name !~ /[^A-Za-z0-9]/ && self.class.constants.include?(parser_name.to_sym)
+      end
     end
   end
 end

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

@@ -8,7 +8,10 @@ module Jekyll
           @errors = []
           load_divs_library if @config['maruku']['use_divs']
           load_blahtext_library if @config['maruku']['use_tex']
-          enable_fenced_code_blocks if @config['maruku']['fenced_code_blocks']
+
+          # allow fenced code blocks (new in Maruku 0.7.0)
+          MaRuKu::Globals[:fenced_code_blocks] = !!@config['maruku']['fenced_code_blocks']
+
         rescue LoadError
           STDERR.puts 'You are missing a library required for Markdown. Please run:'
           STDERR.puts '  $ [sudo] gem install maruku'
@@ -36,10 +39,6 @@ module Jekyll
           MaRuKu::Globals[:html_png_url] = @config['maruku']['png_url']
         end
 
-        def enable_fenced_code_blocks
-          MaRuKu::Globals[:fenced_code_blocks] = true
-        end
-
         def print_errors_and_fail
           print @errors.join
           raise MaRuKu::Exception, "MaRuKu encountered problem(s) while converting your markup."

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

@@ -22,7 +22,7 @@ module Jekyll
           end
         end
 
-        module WithoutPygments
+        module WithoutHighlighting
           require 'cgi'
 
           include CommonMethods
@@ -37,19 +37,50 @@ module Jekyll
           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>"
+
+            output = "<div class=\"highlight\">"
+            output << add_code_tags(code, lang)
+            output << "</div>"
+          end
+
+          protected
+          def rouge_formatter(opts = {})
+            Rouge::Formatters::HTML.new(opts.merge(wrap: false))
+          end
+        end
+
+
         def initialize(config)
           require 'redcarpet'
           @config = config
           @redcarpet_extensions = {}
           @config['redcarpet']['extensions'].each { |e| @redcarpet_extensions[e.to_sym] = true }
 
-          @renderer ||= if @config['pygments']
+          @renderer ||= case @config['highlighter']
+                        when 'pygments'
                           Class.new(Redcarpet::Render::HTML) do
                             include WithPygments
                           end
+                        when 'rouge'
+                          Class.new(Redcarpet::Render::HTML) do
+                            include WithRouge
+                          end
                         else
                           Class.new(Redcarpet::Render::HTML) do
-                            include WithoutPygments
+                            include WithoutHighlighting
                           end
                         end
         rescue LoadError

data/lib/jekyll/converters/sass.rb

@@ -0,0 +1,58 @@
+module Jekyll
+  class Sass < Converter
+    safe true
+    priority :low
+
+    def matches(ext)
+      ext =~ /^\.s(a|c)ss$/i
+    end
+
+    def output_ext(ext)
+      ".css"
+    end
+
+    def jekyll_sass_configuration
+      @config["sass"] || {}
+    end
+
+    def sass_build_configuration_options(overrides)
+      jekyll_sass_configuration.deep_merge(overrides).symbolize_keys
+    end
+
+    def syntax_type_of_content(content)
+      if content.include?(";") || content.include?("{")
+        :scss
+      else
+        :sass
+      end
+    end
+
+    def sass_dir
+      return "_sass" if jekyll_sass_configuration["sass_dir"].to_s.empty?
+      jekyll_sass_configuration["sass_dir"]
+    end
+
+    def sass_dir_relative_to_site_source
+      File.join(
+        @config["source"],
+        File.expand_path(sass_dir, "/") # FIXME: Not windows-compatible
+      )
+    end
+
+    def allow_caching?
+      !@config["safe"]
+    end
+
+    def sass_configs(content = "")
+      sass_build_configuration_options({
+        "syntax" => syntax_type_of_content(content),
+        "cache"  => allow_caching?,
+        "load_paths" => [sass_dir_relative_to_site_source]
+      })
+    end
+
+    def convert(content)
+      ::Sass.compile(content, sass_configs(content))
+    end
+  end
+end

data/lib/jekyll/converters/textile.rb

@@ -3,8 +3,8 @@ module Jekyll
     class Textile < Converter
       safe true
 
-      pygments_prefix '<notextile>'
-      pygments_suffix '</notextile>'
+      highlighter_prefix '<notextile>'
+      highlighter_suffix '</notextile>'
 
       def setup
         return if @setup