jekyll 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a31f65d756e5aebe4d34d37dfa1a94f6d1ca51bf
-  data.tar.gz: 20cc0c111cf0f43655be2e14ec523709606d8ff8
+  metadata.gz: 1bd7e49f4d0c08e3a671d21444bc80a53ef6c4a0
+  data.tar.gz: 8eec4bc8581b8abd01c7bf077b79980af61537b7
 SHA512:
-  metadata.gz: 7bf6846863ee71fd92d708c9bfc5f86227a411b529b2e5f3028bcd6788991823cdd8dceb54cd7d76369f27c0c27e694de998da8a7da6d7036c52d09ede9e9789
-  data.tar.gz: 5a10ab501a2df020e5f2fbdacf614a3512f50f9bbe963a70c58b046a8dc3cdb78c55224f1e646950c4b56df6b99863ef4c04d215ba805c2d7372ad34835fd93b
+  metadata.gz: 6688a5be7d34576575ec1098fe5f80c2f625c6a4eefa5869bcb64a9ce41fe8d5c05424c9105fbcdc88f44512fa663aafd458da75e0672b1bd97b328c42af65a0
+  data.tar.gz: 0ce421c5435ad40f8cf231e38891a6949a827a75964b7c2c426654f2746507ed1f77a1cba06be22f709bc77cd7949a81cedf6510c629d3ee463fb41d957cefde

data/README.markdown

@@ -5,7 +5,7 @@
 [![Code Climate](http://img.shields.io/codeclimate/github/jekyll/jekyll.svg)](https://codeclimate.com/github/jekyll/jekyll)
 [![Dependency Status](https://gemnasium.com/jekyll/jekyll.svg)](https://gemnasium.com/jekyll/jekyll)
 
-By Tom Preston-Werner, Nick Quaranto, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)!
+By Tom Preston-Werner, Nick Quaranto, Parker Moore, and many [awesome contributors](https://github.com/jekyll/jekyll/graphs/contributors)!
 
 Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](http://pages.github.com), which you can use to host sites right from your GitHub repositories.
 

data/lib/jekyll.rb

@@ -139,7 +139,6 @@ require_all 'jekyll/tags'
 
 # Eventually remove these for 3.0 as non-core
 Jekyll::Deprecator.gracefully_require(%w[
-  classifier
   toml
   jekyll-paginate
   jekyll-gist

data/lib/jekyll/collection.rb

@@ -22,14 +22,28 @@ module Jekyll
       @docs ||= []
     end
 
+    # Fetch the static files in this collection.
+    # Defaults to an empty array if no static files have been read in.
+    #
+    # Returns an array of Jekyll::StaticFile objects.
+    def files
+      @files ||= []
+    end
+
     # Read the allowed documents into the collection's array of docs.
     #
     # Returns the sorted array of docs.
     def read
       filtered_entries.each do |file_path|
-        doc = Jekyll::Document.new(Jekyll.sanitized_path(directory, file_path), { site: site, collection: self })
-        doc.read
-        docs << doc
+        full_path = Jekyll.sanitized_path(directory, file_path)
+        if Utils.has_yaml_header? full_path
+          doc = Jekyll::Document.new(full_path, { site: site, collection: self })
+          doc.read
+          docs << doc
+        else
+          relative_dir = File.join(relative_directory, File.dirname(file_path)).chomp("/.")
+          files << StaticFile.new(site, site.source, relative_dir, File.basename(full_path), self)
+        end
       end
       docs.sort!
     end
@@ -118,6 +132,7 @@ module Jekyll
       metadata.merge({
         "label"     => label,
         "docs"      => docs,
+        "files"     => files,
         "directory" => directory,
         "output"    => write?,
         "relative_directory" => relative_directory

data/lib/jekyll/command.rb

@@ -19,31 +19,6 @@ module Jekyll
         super(base)
       end
 
-      # Paths to ignore for the watch option
-      #
-      # options - A Hash of options passed to the command
-      #
-      # Returns a list of relative paths from source that should be ignored
-      def ignore_paths(options)
-        source      = options['source']
-        destination = options['destination']
-        config_files = Configuration[options].config_files(options)
-        paths = config_files + Array(destination)
-        ignored = []
-
-        source_abs = Pathname.new(source).expand_path
-        paths.each do |p|
-          path_abs = Pathname.new(p).expand_path
-          begin
-            rel_path = path_abs.relative_path_from(source_abs).to_s
-            ignored << Regexp.new(Regexp.escape(rel_path)) unless rel_path.start_with?('../')
-          rescue ArgumentError
-            # Could not find a relative path
-          end
-        end
-        ignored
-      end
-
       # Run Site#process and catch errors
       #
       # site - the Jekyll::Site object

data/lib/jekyll/commands/build.rb

@@ -32,7 +32,12 @@ module Jekyll
           else
             build(site, options)
           end
-          watch(site, options) if options['watch']
+
+          if options.fetch('watch', false)
+            watch(site, options)
+          else
+            Jekyll.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
+          end
         end
 
         # Build your Jekyll site.
@@ -59,7 +64,7 @@ module Jekyll
         # Returns nothing.
         def watch(site, options)
           Deprecator.gracefully_require 'jekyll-watch'
-          Jekyll::Commands::Watch.watch(site, options)
+          Jekyll::Watcher.watch(options)
         end
 
       end # end of class << self

data/lib/jekyll/commands/help.rb

@@ -0,0 +1,33 @@
+module Jekyll
+  module Commands
+    class Help < Command
+      class << self
+
+        def init_with_program(prog)
+          prog.command(:help) do |c|
+            c.syntax 'help [subcommand]'
+            c.description 'Show the help message, optionally for a given subcommand.'
+
+            c.action do |args, _|
+              cmd = (args.first || "").to_sym
+              if args.empty?
+                puts prog
+              elsif prog.has_command? cmd
+                puts prog.commands[cmd]
+              else
+                invalid_command(prog, cmd)
+                abort
+              end
+            end
+          end
+        end
+
+        def invalid_command(prog, cmd)
+          Jekyll.logger.error "Error:", "Hmm... we don't know what the '#{cmd}' command is."
+          Jekyll.logger.info  "Valid commands:", prog.commands.keys.join(", ")
+        end
+
+      end
+    end
+  end
+end

data/lib/jekyll/configuration.rb

@@ -6,47 +6,55 @@ module Jekyll
     # Default options. Overridden by values in _config.yml.
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = {
+      # Where things are
       'source'        => Dir.pwd,
       'destination'   => File.join(Dir.pwd, '_site'),
       'plugins'       => '_plugins',
       'layouts'       => '_layouts',
       'data_source'   =>  '_data',
-      'keep_files'    => ['.git','.svn'],
-      'gems'          => [],
       'collections'   => nil,
 
-      'timezone'      => nil,           # use the local timezone
-
-      'encoding'      => 'utf-8',       # always use utf-8 encoding. NEVER FORGET
-
+      # Handling Reading
       'safe'          => false,
-      'detach'        => false,          # default to not detaching the server
+      'include'       => ['.htaccess'],
+      'exclude'       => [],
+      'keep_files'    => ['.git','.svn'],
+      'encoding'      => 'utf-8',
+      'markdown_ext'  => 'markdown,mkdown,mkdn,mkd,md',
+      'textile_ext'   => 'textile',
+
+      # Filtering Content
       'show_drafts'   => nil,
       'limit_posts'   => 0,
-      'lsi'           => false,
       'future'        => true,           # remove and make true just default
       'unpublished'   => false,
 
-      'relative_permalinks' => false,
+      # Plugins
+      'whitelist'     => [],
+      'gems'          => [],
 
+      # Conversion
       'markdown'      => 'kramdown',
       'highlighter'   => 'pygments',
-      'permalink'     => 'date',
-      'baseurl'       => '',
-      'include'       => ['.htaccess'],
-      'exclude'       => [],
-      'paginate_path' => '/page:num',
-
-      'markdown_ext'  => 'markdown,mkdown,mkdn,mkd,md',
-      'textile_ext'   => 'textile',
+      'lsi'           => false,
+      'excerpt_separator' => "\n\n",
 
-      'quiet'         => false,
+      # Serving
+      'detach'        => false,          # default to not detaching the server
       'port'          => '4000',
       'host'          => '0.0.0.0',
+      'baseurl'       => '',
 
-      'excerpt_separator' => "\n\n",
+      # Backwards-compatibility options
+      'relative_permalinks' => false,
+
+      # Output Configuration
+      'permalink'     => 'date',
+      'paginate_path' => '/page:num',
+      'timezone'      => nil,           # use the local timezone
 
-      'defaults'     => [],
+      'quiet'         => false,
+      'defaults'      => [],
 
       'maruku' => {
         'use_tex'    => false,
@@ -110,9 +118,9 @@ module Jekyll
 
     def safe_load_file(filename)
       case File.extname(filename)
-      when '.toml'
+      when /\.toml/i
         TOML.load_file(filename)
-      when /\.y(a)?ml/
+      when /\.ya?ml/i
         SafeYAML.load_file(filename)
       else
         raise ArgumentError, "No parser for '#{filename}' is available. Use a .toml or .y(a)ml file instead."
@@ -200,7 +208,7 @@ module Jekyll
     def backwards_compatibilize
       config = clone
       # Provide backwards-compatibility
-      if config.has_key?('auto') || config.has_key?('watch')
+      if config.key?('auto') || config.key?('watch')
         Jekyll.logger.warn "Deprecation:", "Auto-regeneration can no longer" +
                             " be set from your configuration file(s). Use the"+
                             " --watch/-w command-line option instead."
@@ -208,23 +216,23 @@ module Jekyll
         config.delete('watch')
       end
 
-      if config.has_key? 'server'
+      if config.key? 'server'
         Jekyll.logger.warn "Deprecation:", "The 'server' configuration option" +
                             " is no longer accepted. Use the 'jekyll serve'" +
                             " subcommand to serve your site with WEBrick."
         config.delete('server')
       end
 
-      if config.has_key? 'server_port'
+      if config.key? 'server_port'
         Jekyll.logger.warn "Deprecation:", "The 'server_port' configuration option" +
                             " has been renamed to 'port'. Please update your config" +
                             " file accordingly."
         # copy but don't overwrite:
-        config['port'] = config['server_port'] unless config.has_key?('port')
+        config['port'] = config['server_port'] unless config.key?('port')
         config.delete('server_port')
       end
 
-      if config.has_key? 'pygments'
+      if config.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', " +
@@ -256,7 +264,7 @@ module Jekyll
     def fix_common_issues
       config = clone
 
-      if config.has_key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
+      if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
         Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" +
           " positive integer or nil. It's currently set to '#{config['paginate'].inspect}'."
         config['paginate'] = nil

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] = @config['kramdown']['coderay'][key] unless @config['kramdown'].has_key?(key)
+              @config['kramdown'][key] = @config['kramdown']['coderay'][key] unless @config['kramdown'].key?(key)
             end
           end
 

data/lib/jekyll/convertible.rb

@@ -25,7 +25,7 @@ module Jekyll
 
     # Whether the file is published or not, as indicated in YAML front-matter
     def published?
-      !(data.has_key?('published') && data['published'] == false)
+      !(data.key?('published') && data['published'] == false)
     end
 
     # Returns merged option hash for File.read of self.site (if exists)
@@ -62,11 +62,14 @@ module Jekyll
     #
     # Returns nothing.
     def transform
-      self.content = converter.convert(content)
-    rescue => e
-      Jekyll.logger.error "Conversion error:", "There was an error converting" +
-        " '#{path}'."
-      raise e
+      converters.reduce(content) do |output, converter|
+        begin
+          converter.convert output
+        rescue => e
+          Jekyll.logger.error "Conversion error:", "#{converter.class} encountered an error converting '#{path}'."
+          raise e
+        end
+      end
     end
 
     # Determine the extension depending on content_type.
@@ -74,15 +77,21 @@ module Jekyll
     # Returns the String extension for the output file.
     #   e.g. ".html" for an HTML output file.
     def output_ext
-      converter.output_ext(ext)
+      if converters.all? { |c| c.is_a?(Jekyll::Converters::Identity) }
+        ext
+      else
+        converters.map { |c|
+          c.output_ext(ext) unless c.is_a?(Jekyll::Converters::Identity)
+        }.compact.last
+      end
     end
 
     # Determine which converter to use based on this convertible's
     # extension.
     #
     # Returns the Converter instance.
-    def converter
-      @converter ||= site.converters.find { |c| c.matches(ext) }
+    def converters
+      @converters ||= site.converters.select { |c| c.matches(ext) }.sort
     end
 
     # Render Liquid in the content
@@ -119,12 +128,12 @@ module Jekyll
     #
     # Returns the type of self.
     def type
-      if is_a?(Post)
-        :post
+      if is_a?(Draft)
+        :drafts
+      elsif is_a?(Post)
+        :posts
       elsif is_a?(Page)
-        :page
-      elsif is_a?(Draft)
-        :draft
+        :pages
       end
     end
 
@@ -134,7 +143,21 @@ module Jekyll
     # Returns true if the extname belongs to the set of extensions
     #   that asset files use.
     def asset_file?
-      %w[.sass .scss .coffee].include?(ext)
+      sass_file? || coffeescript_file?
+    end
+
+    # Determine whether the document is a Sass file.
+    #
+    # Returns true if extname == .sass or .scss, false otherwise.
+    def sass_file?
+      %w[.sass .scss].include?(ext)
+    end
+
+    # Determine whether the document is a CoffeeScript file.
+    #
+    # Returns true if extname == .coffee, false otherwise.
+    def coffeescript_file?
+      '.coffee'.eql?(ext)
     end
 
     # Determine whether the file should be rendered with Liquid.
@@ -142,7 +165,7 @@ module Jekyll
     # Returns false if the document is either an asset file or a yaml file,
     #   true otherwise.
     def render_with_liquid?
-      !asset_file?
+      !coffeescript_file?
     end
 
     # Determine whether the file should be placed into layouts.
@@ -159,7 +182,7 @@ module Jekyll
     #
     # Returns true if the layout is invalid, false if otherwise
     def invalid_layout?(layout)
-      !data["layout"].nil? && data["layout"] != "none" && layout.nil? && !(self.is_a? Jekyll::Excerpt)
+      !data["layout"].nil? && layout.nil? && !(self.is_a? Jekyll::Excerpt)
     end
 
     # Recursively render layouts
@@ -205,11 +228,11 @@ module Jekyll
       info = { :filters => [Jekyll::Filters], :registers => { :site => site, :page => payload['page'] } }
 
       # render and transform content (this becomes the final content of the object)
-      payload["highlighter_prefix"] = converter.highlighter_prefix
-      payload["highlighter_suffix"] = converter.highlighter_suffix
+      payload["highlighter_prefix"] = converters.first.highlighter_prefix
+      payload["highlighter_suffix"] = converters.first.highlighter_suffix
 
       self.content = render_liquid(content, payload, info) if render_with_liquid?
-      transform
+      self.content = transform
 
       # output keeps track of what will finally be written
       self.output = content

data/lib/jekyll/deprecator.rb

@@ -1,6 +1,8 @@
 module Jekyll
   module Deprecator
-    def self.process(args)
+    extend self
+
+    def process(args)
       no_subcommand(args)
       arg_is_present? args, "--server", "The --server command has been replaced by the \
                           'serve' subcommand."
@@ -16,36 +18,41 @@ module Jekyll
       arg_is_present? args, "--url", "The 'url' setting can only be set in your config files."
     end
 
-    def self.no_subcommand(args)
+    def no_subcommand(args)
       if args.size > 0 && args.first =~ /^--/ && !%w[--help --version].include?(args.first)
-        Jekyll.logger.error "Deprecation:", "Jekyll now uses subcommands instead of just \
+        deprecation_message "Jekyll now uses subcommands instead of just \
                             switches. Run `jekyll --help' to find out more."
       end
     end
 
-    def self.arg_is_present?(args, deprecated_argument, message)
+    def arg_is_present?(args, deprecated_argument, message)
       if args.include?(deprecated_argument)
         deprecation_message(message)
       end
     end
 
-    def self.deprecation_message(message)
+    def deprecation_message(message)
       Jekyll.logger.error "Deprecation:", message
     end
 
-    def self.gracefully_require(gem_name)
+    def defaults_deprecate_type(old, current)
+      Jekyll.logger.warn "Defaults:", "The '#{old}' type has become '#{current}'."
+      Jekyll.logger.warn "Defaults:", "Please update your front-matter defaults to use 'type: #{current}'."
+    end
+
+    def gracefully_require(gem_name)
       Array(gem_name).each do |name|
         begin
           require name
         rescue LoadError => e
           Jekyll.logger.error "Dependency Error:", <<-MSG
   Yikes! It looks like you don't have #{name} or one of its dependencies installed.
-  In order to use Jekyll as currently contfigured, you'll need to install this gem.
+  In order to use Jekyll as currently configured, you'll need to install this gem.
 
   The full error message from Ruby is: '#{e.message}'
 
   If you run into trouble, you can find helpful resources at http://jekyllrb.com/help/!
-  MSG
+MSG
           raise Errors::MissingDependencyException.new(name)
         end
       end