jekyll 3.1.0.pre.beta1 → 3.1.0.pre.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1829f10339d166e837fcab131e2a71f8b7354ef
-  data.tar.gz: 9e9401c86a39df7af91aa72ce6f427fcbbff3c48
+  metadata.gz: 5da26c7d190e158f8259ccab996f37dbdeab27f6
+  data.tar.gz: 78d017c3d93a9a91ba2ada36ab1f3522c72d7b16
 SHA512:
-  metadata.gz: 57d2d84faf740f163963b8649ae08b1dc27f84352e4f9e6539bef4ce0eb20582efe75a15b16b05aab41369f2cdcab7b0d3f371bd6ab1b2cdeabcd31d0dfe504c
-  data.tar.gz: 440f77af890b49b98f74f389b204c0f3c920215ad366fab6727fcea45c562113a8decd99de82c5ce1fe5fb32ad8755727d5705ee60ffe663bb213de7cf2354be
+  metadata.gz: cd566922d0e9b2f8e6e5cba893ed419d304b0e250145800d455a5e3eac66dfb6de3ce123535f76bc68600e7dfa999ab9f4759af207181b1a82c918f7b2db3d6f
+  data.tar.gz: 0d0d806095422d586cc4775197b897130ae36e0eb550d0d5b71c5503b1c2e34004d1530f9a5fbebf3a53837b7a4571494c2665ed98a786416e1d1c22a27be10e

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2008-2015 Tom Preston-Werner
+Copyright (c) 2008-2016 Tom Preston-Werner
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -3,6 +3,7 @@
 [![Gem Version](https://img.shields.io/gem/v/jekyll.svg)](https://rubygems.org/gems/jekyll)
 [![Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg)](https://travis-ci.org/jekyll/jekyll)
 [![Code Climate](https://img.shields.io/codeclimate/github/jekyll/jekyll.svg)](https://codeclimate.com/github/jekyll/jekyll)
+[![Test Coverage](https://codeclimate.com/github/jekyll/jekyll/badges/coverage.svg)](https://codeclimate.com/github/jekyll/jekyll/coverage)
 [![Dependency Status](https://gemnasium.com/jekyll/jekyll.svg)](https://gemnasium.com/jekyll/jekyll)
 [![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)](https://hakiri.io/github/jekyll/jekyll/master)
 

data/bin/jekyll

@@ -1,15 +1,11 @@
 #!/usr/bin/env ruby
 STDOUT.sync = true
 
-$:.unshift File.join(File.dirname(__FILE__), *%w{ .. lib })
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w( .. lib ))
 
 require 'jekyll'
 require 'mercenary'
 
-Jekyll::External.require_if_present(
-  Jekyll::External.blessed_gems
-)
-
 Jekyll::PluginManager.require_from_bundler
 
 Jekyll::Deprecator.process(ARGV)
@@ -26,16 +22,29 @@ Mercenary.program(:jekyll) do |p|
   p.option 'layouts_dir', '--layouts DIR', String, 'Layouts directory (defaults to ./_layouts)'
   p.option 'profile', '--profile', 'Generate a Liquid rendering profile'
 
+  Jekyll::External.require_if_present(Jekyll::External.blessed_gems) do |g|
+    cmd = g.split('-').last
+    p.command(cmd.to_sym) do |c|
+      c.syntax cmd
+      c.action do
+        Jekyll.logger.abort_with "You must install the '#{g}' gem to use the 'jekyll #{cmd}' command."
+      end
+    end
+  end
+
   Jekyll::Command.subclasses.each { |c| c.init_with_program(p) }
 
-  p.action do |args, options|
+  p.action do |args, _|
     if args.empty?
       Jekyll.logger.error "A subcommand is required."
       puts p
       abort
     else
-      unless p.has_command?(args.first)
-        Jekyll.logger.abort_with "Invalid command. Use --help for more information"
+      subcommand = args.first
+      unless p.has_command? subcommand
+        Jekyll.logger.abort_with "fatal: 'jekyll #{args.first}' could not" \
+          " be found. You may need to install the jekyll-#{args.first} gem" \
+          " or a related gem to be able to use this subcommand."
       end
     end
   end

data/lib/jekyll.rb

@@ -1,4 +1,4 @@
-$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+$LOAD_PATH.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
 
 # Require all of the Ruby files in the given directory.
 #
@@ -95,7 +95,7 @@ module Jekyll
     #            list of option names and their defaults.
     #
     # Returns the final configuration Hash.
-    def configuration(override = Hash.new)
+    def configuration(override = {})
       config = Configuration[Configuration::DEFAULTS]
       override = Configuration[override].stringify_keys
       unless override.delete('skip_config_files')
@@ -156,19 +156,19 @@ module Jekyll
       clean_path = File.expand_path(questionable_path, "/")
       clean_path = clean_path.sub(/\A\w\:\//, '/')
 
-      unless clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
-        File.join(base_directory, clean_path)
-      else
+      if clean_path.start_with?(base_directory.sub(/\A\w\:\//, '/'))
         clean_path
+      else
+        File.join(base_directory, clean_path)
       end
     end
 
     # Conditional optimizations
     Jekyll::External.require_if_present('liquid-c')
-
   end
 end
 
+require "jekyll/drops/drop"
 require_all 'jekyll/commands'
 require_all 'jekyll/converters'
 require_all 'jekyll/converters/markdown'

data/lib/jekyll/cleaner.rb

@@ -13,7 +13,7 @@ module Jekyll
     # Cleans up the site's destination directory
     def cleanup!
       FileUtils.rm_rf(obsolete_files)
-      FileUtils.rm_rf(metadata_file) if !@site.incremental?
+      FileUtils.rm_rf(metadata_file) unless @site.incremental?
     end
 
     private

data/lib/jekyll/collection.rb

@@ -56,7 +56,7 @@ module Jekyll
         full_path = collection_dir(file_path)
         next if File.directory?(full_path)
         if Utils.has_yaml_header? full_path
-          doc = Jekyll::Document.new(full_path, { site: site, collection: self })
+          doc = Jekyll::Document.new(full_path, { :site => site, :collection => self })
           doc.read
           if site.publisher.publish?(doc) || !write?
             docs << doc
@@ -76,10 +76,11 @@ module Jekyll
     # Returns an Array of file paths to the documents in this collection
     #   relative to the collection's directory
     def entries
-      return Array.new unless exists?
+      return [] unless exists?
       @entries ||=
         Utils.safe_glob(collection_dir, ["**", "*.*"]).map do |entry|
-          entry["#{collection_dir}/"] = ''; entry
+          entry["#{collection_dir}/"] = ''
+          entry
         end
     end
 
@@ -88,7 +89,7 @@ module Jekyll
     #
     # Returns a list of filtered entry paths.
     def filtered_entries
-      return Array.new unless exists?
+      return [] unless exists?
       @filtered_entries ||=
         Dir.chdir(directory) do
           entry_filter.filter(entries).reject do |f|
@@ -185,8 +186,8 @@ module Jekyll
     #
     # Returns the URL template to render collection's documents at.
     def url_template
-      metadata.fetch('permalink') do
-          Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
+      @url_template ||= metadata.fetch('permalink') do
+        Utils.add_permalink_suffix("/:collection/:path", site.permalink_style)
       end
     end
 
@@ -195,7 +196,7 @@ module Jekyll
     # Returns the metadata for this collection
     def extract_metadata
       if site.config['collections'].is_a?(Hash)
-        site.config['collections'][label] || Hash.new
+        site.config['collections'][label] || {}
       else
         {}
       end

data/lib/jekyll/command.rb

@@ -1,8 +1,6 @@
 module Jekyll
   class Command
-
     class << self
-
       # A list of subclasses of Jekyll::Command
       def subclasses
         @subclasses ||= []
@@ -62,8 +60,6 @@ module Jekyll
         c.option 'verbose', '-V', '--verbose', 'Print verbose output.'
         c.option 'incremental', '-I', '--incremental', 'Enable incremental rebuild.'
       end
-
     end
-
   end
 end

data/lib/jekyll/commands/build.rb

@@ -1,9 +1,7 @@
 module Jekyll
   module Commands
     class Build < Command
-
       class << self
-
         # Create the Mercenary command for the Jekyll CLI for this Command
         def init_with_program(prog)
           prog.command(:build) do |c|
@@ -13,7 +11,7 @@ module Jekyll
 
             add_build_options(c)
 
-            c.action do |args, options|
+            c.action do |_, options|
               options["serving"] = false
               Jekyll::Commands::Build.process(options)
             end
@@ -67,13 +65,11 @@ module Jekyll
         # options - A Hash of options passed to the command
         #
         # Returns nothing.
-        def watch(site, options)
+        def watch(_site, options)
           External.require_with_graceful_fail 'jekyll-watch'
           Jekyll::Watcher.watch(options)
         end
-
       end # end of class << self
-
     end
   end
 end

data/lib/jekyll/commands/clean.rb

@@ -2,7 +2,6 @@ module Jekyll
   module Commands
     class Clean < Command
       class << self
-
         def init_with_program(prog)
           prog.command(:clean) do |c|
             c.syntax 'clean [subcommand]'
@@ -10,7 +9,7 @@ module Jekyll
 
             add_build_options(c)
 
-            c.action do |args, options|
+            c.action do |_, options|
               Jekyll::Commands::Clean.process(options)
             end
           end
@@ -37,7 +36,6 @@ module Jekyll
             Jekyll.logger.info "Nothing to do for #{metadata_file}."
           end
         end
-
       end
     end
   end

data/lib/jekyll/commands/doctor.rb

@@ -2,7 +2,6 @@ module Jekyll
   module Commands
     class Doctor < Command
       class << self
-
         def init_with_program(prog)
           prog.command(:doctor) do |c|
             c.syntax 'doctor'
@@ -11,7 +10,7 @@ module Jekyll
 
             c.option '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
 
-            c.action do |args, options|
+            c.action do |_, options|
               Jekyll::Commands::Doctor.process(options)
             end
           end
@@ -39,8 +38,8 @@ module Jekyll
 
         def deprecated_relative_permalinks(site)
           if site.config['relative_permalinks']
-            Jekyll::Deprecator.deprecation_message "Your site still uses relative" +
-                                " permalinks, which was removed in" +
+            Jekyll::Deprecator.deprecation_message "Your site still uses relative" \
+                                " permalinks, which was removed in" \
                                 " Jekyll v3.0.0."
             return true
           end
@@ -52,17 +51,16 @@ module Jekyll
           urls = collect_urls(urls, site.pages, site.dest)
           urls = collect_urls(urls, site.posts.docs, site.dest)
           urls.each do |url, paths|
-            if paths.size > 1
-              conflicting_urls = true
-              Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" +
-                " for the following pages: #{paths.join(", ")}"
-            end
+            next unless paths.size > 1
+            conflicting_urls = true
+            Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
+              " for the following pages: #{paths.join(", ")}"
           end
           conflicting_urls
         end
 
-        def fsnotify_buggy?(site)
-          return true if !Utils::Platforms.osx?
+        def fsnotify_buggy?(_site)
+          return true unless Utils::Platforms.osx?
           if Dir.pwd != `pwd`.strip
             Jekyll.logger.error "  " + <<-STR.strip.gsub(/\n\s+/, "\n  ")
               We have detected that there might be trouble using fsevent on your
@@ -81,12 +79,11 @@ module Jekyll
           urls_only_differ_by_case = false
           urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
           urls.each do |case_insensitive_url, real_urls|
-            if real_urls.uniq.size > 1
-              urls_only_differ_by_case = true
-              Jekyll.logger.warn "Warning:", "The following URLs only differ" +
-                " by case. On a case-insensitive file system one of the URLs" +
-                " will be overwritten by the other: #{real_urls.join(", ")}"
-            end
+            next unless real_urls.uniq.size > 1
+            urls_only_differ_by_case = true
+            Jekyll.logger.warn "Warning:", "The following URLs only differ" \
+              " by case. On a case-insensitive file system one of the URLs" \
+              " will be overwritten by the other: #{real_urls.join(", ")}"
           end
           urls_only_differ_by_case
         end
@@ -105,14 +102,13 @@ module Jekyll
         end
 
         def case_insensitive_urls(things, destination)
-          things.inject(Hash.new) do |memo, thing|
+          things.inject({}) do |memo, thing|
             dest = thing.destination(destination)
             (memo[dest.downcase] ||= []) << dest
             memo
           end
         end
       end
-
     end
   end
 end

data/lib/jekyll/commands/help.rb

@@ -2,7 +2,6 @@ module Jekyll
   module Commands
     class Help < Command
       class << self
-
         def init_with_program(prog)
           prog.command(:help) do |c|
             c.syntax 'help [subcommand]'
@@ -26,7 +25,6 @@ module Jekyll
           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

data/lib/jekyll/commands/serve.rb

@@ -103,7 +103,7 @@ module Jekyll
           WEBrick::Config::FileHandler.merge({
             :FancyIndexing     => true,
             :NondisclosureName => [
-              '.ht*','~*'
+              '.ht*', '~*'
             ]
           })
         end
@@ -123,7 +123,14 @@ module Jekyll
 
         private
         def launch_browser(server, opts)
-          command = Utils::Platforms.windows?? "start" : Utils::Platforms.osx?? "open" : "xdg-open"
+          command =
+            if Utils::Platforms.windows?
+              "start"
+            elsif Utils::Platforms.osx?
+              "open"
+            else
+              "xdg-open"
+            end
           system command, server_address(server, opts)
         end
 
@@ -168,7 +175,8 @@ module Jekyll
             raise RuntimeError, "--ssl-cert or --ssl-key missing."
           end
 
-          require "openssl"; require "webrick/https"
+          require "openssl"
+          require "webrick/https"
           source_key = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_key" ])
           source_certificate = Jekyll.sanitized_path(opts[:JekyllOptions]["source"], opts[:JekyllOptions]["ssl_cert"])
           opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(source_certificate))

data/lib/jekyll/commands/serve/servlet.rb

@@ -17,7 +17,7 @@ module Jekyll
         end
 
         # Add the ability to tap file.html the same way that Nginx does on our
-        # Docker images (or on Github pages.) The difference is that we might end
+        # Docker images (or on GitHub Pages.) The difference is that we might end
         # up with a different preference on which comes first.
 
         def search_file(req, res, basename)
@@ -37,7 +37,7 @@ module Jekyll
         #
 
         private
-        def validate_and_ensure_charset(req, res)
+        def validate_and_ensure_charset(_req, res)
           key = res.header.keys.grep(/content-type/i).first
           typ = res.header[key]
 
@@ -52,7 +52,7 @@ module Jekyll
         def set_defaults
           hash_ = @jekyll_opts.fetch("webrick", {}).fetch("headers", {})
           DEFAULTS.each_with_object(@headers = hash_) do |(key, val), hash|
-            hash[key] = val if !hash.key?(key)
+            hash[key] = val unless hash.key?(key)
           end
         end
       end

data/lib/jekyll/configuration.rb

@@ -2,7 +2,6 @@
 
 module Jekyll
   class Configuration < Hash
-
     # Default options. Overridden by values in _config.yml.
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = Configuration[{
@@ -19,7 +18,7 @@ module Jekyll
       'safe'          => false,
       'include'       => ['.htaccess'],
       'exclude'       => [],
-      'keep_files'    => ['.git','.svn'],
+      'keep_files'    => ['.git', '.svn'],
       'encoding'      => 'utf-8',
       'markdown_ext'  => 'markdown,mkdown,mkdn,mkd,md',
 
@@ -78,7 +77,7 @@ module Jekyll
     #
     # Return a copy of the hash where all its keys are strings
     def stringify_keys
-      reduce({}) { |hsh,(k,v)| hsh.merge(k.to_s => v) }
+      reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
     end
 
     def get_config_value_with_override(config_key, override)
@@ -128,7 +127,7 @@ module Jekyll
       # Get configuration from <source>/_config.yml or <source>/<config_file>
       config_files = override.delete('config')
       if config_files.to_s.empty?
-        default = %w[yml yaml].find(Proc.new { 'yml' }) do |ext|
+        default = %w(yml yaml).find(-> { 'yml' }) do |ext|
           File.exist?(Jekyll.sanitized_path(source(override), "_config.#{ext}"))
         end
         config_files = Jekyll.sanitized_path(source(override), "_config.#{default}")
@@ -173,7 +172,7 @@ module Jekyll
           configuration = Utils.deep_merge_hashes(configuration, new_config)
         end
       rescue ArgumentError => err
-        Jekyll.logger.warn "WARNING:", "Error reading configuration. " +
+        Jekyll.logger.warn "WARNING:", "Error reading configuration. " \
                      "Using defaults (and options)."
         $stderr.puts "#{err}"
       end
@@ -198,16 +197,16 @@ module Jekyll
       config = clone
       # Provide backwards-compatibility
       if config.key?('auto') || config.key?('watch')
-        Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" +
-                            " be set from your configuration file(s). Use the"+
+        Jekyll::Deprecator.deprecation_message "Auto-regeneration can no longer" \
+                            " be set from your configuration file(s). Use the"\
                             " --[no-]watch/-w command-line option instead."
         config.delete('auto')
         config.delete('watch')
       end
 
       if config.key? 'server'
-        Jekyll::Deprecator.deprecation_message "The 'server' configuration option" +
-                            " is no longer accepted. Use the 'jekyll serve'" +
+        Jekyll::Deprecator.deprecation_message "The 'server' configuration option" \
+                            " is no longer accepted. Use the 'jekyll serve'" \
                             " subcommand to serve your site with WEBrick."
         config.delete('server')
       end
@@ -218,21 +217,21 @@ module Jekyll
       renamed_key 'data_source', 'data_dir', config
 
       if config.key? 'pygments'
-        Jekyll::Deprecator.deprecation_message "The 'pygments' configuration option" +
-                            " has been renamed to 'highlighter'. Please update your" +
-                            " config file accordingly. The allowed values are 'rouge', " +
+        Jekyll::Deprecator.deprecation_message "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|
+      %w(include exclude).each do |option|
         config[option] ||= []
         if config[option].is_a?(String)
-          Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" +
-            " must now be specified as an array, but you specified" +
-            " a string. For now, we've treated the string you provided" +
+          Jekyll::Deprecator.deprecation_message "The '#{option}' configuration option" \
+            " must now be specified as an array, but you specified" \
+            " a string. For now, we've treated the string you provided" \
             " as a list of comma-separated values."
           config[option] = csv_to_array(config[option])
         end
@@ -240,16 +239,16 @@ module Jekyll
       end
 
       if (config['kramdown'] || {}).key?('use_coderay')
-        Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" +
+        Jekyll::Deprecator.deprecation_message "Please change 'use_coderay'" \
           " to 'enable_coderay' in your configuration file."
         config['kramdown']['use_coderay'] = config['kramdown'].delete('enable_coderay')
       end
 
       if config.fetch('markdown', 'kramdown').to_s.downcase.eql?("maruku")
-        Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " +
-          "Markdown processor, which has been removed as of 3.0.0. " +
-          "We recommend you switch to Kramdown. To do this, replace " +
-          "`markdown: maruku` with `markdown: kramdown` in your " +
+        Jekyll.logger.abort_with "Error:", "You're using the 'maruku' " \
+          "Markdown processor, which has been removed as of 3.0.0. " \
+          "We recommend you switch to Kramdown. To do this, replace " \
+          "`markdown: maruku` with `markdown: kramdown` in your " \
           "`_config.yml` file."
       end
 
@@ -260,7 +259,7 @@ module Jekyll
       config = clone
 
       if config.key?('paginate') && (!config['paginate'].is_a?(Integer) || config['paginate'] < 1)
-        Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a" +
+        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
       end
@@ -274,7 +273,7 @@ module Jekyll
       return config if config['collections'].nil?
 
       if config['collections'].is_a?(Array)
-        config['collections'] = Hash[config['collections'].map{|c| [c, {}]}]
+        config['collections'] = Hash[config['collections'].map { |c| [c, {}] }]
       end
       config['collections']['posts'] ||= {}
       config['collections']['posts']['output'] = true
@@ -283,10 +282,10 @@ module Jekyll
       config
     end
 
-    def renamed_key(old, new, config, allowed_values = nil)
+    def renamed_key(old, new, config, _ = nil)
       if config.key?(old)
-        Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" +
-          "option has been renamed to '#{new}'. Please update your config " +
+        Jekyll::Deprecator.deprecation_message "The '#{old}' configuration" \
+          "option has been renamed to '#{new}'. Please update your config " \
           "file accordingly."
         config[new] = config.delete(old)
       end
@@ -299,11 +298,11 @@ module Jekyll
       when :pretty
         "/:categories/:year/:month/:day/:title/"
       when :none
-        "/:categories/:title.html"
+        "/:categories/:title:output_ext"
       when :date
-        "/:categories/:year/:month/:day/:title.html"
+        "/:categories/:year/:month/:day/:title:output_ext"
       when :ordinal
-        "/:categories/:year/:y_day/:title.html"
+        "/:categories/:year/:y_day/:title:output_ext"
       else
         permalink_style.to_s
       end