jekyll 3.4.5 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 007cff0a1a4dacb861f9f524753b03e1c1d4fce6
-  data.tar.gz: 6305426138e9a83b6d494a8276372f7e0b15223d
+  metadata.gz: a657dd9fc0fec7b9b0a13e9eb30aadd5a4c4f36c
+  data.tar.gz: b7012ba4c8d92eb11118adc0869d10dbb3e425a0
 SHA512:
-  metadata.gz: 69fd494dfb64377969bf53956593309e92c2a3f7ccfaa980c242219d96e8393352adf84622922b46bd5b82df778a2c7075fe0487ea22cbddd74a8c282ad364d2
-  data.tar.gz: d49b0d988f0223390b3a3f07697d6c73a369feda12e7065636fa83249e3e18297bb85cedbfde218d2b53c11285a554368e89e7268c66d48f1213615e0b024ad7
+  metadata.gz: 351307bc6003b80a90335b757e25655fbf47c578fbabfb93b85774dc74a66c967b814949e8c9c8cd91c2a615ee2d83787f287f5cc59d986b7717a6bff4d5a603
+  data.tar.gz: 90066e7822209f3ce5c62c29ba375de469260551b78363951c6907a5f1231510a2b1e72b8fc808be404a4b3bad1b5119334d270ad0c33e014b10a94d6e014f43

data/.rubocop.yml

@@ -4,12 +4,43 @@ AllCops:
   Include:
     - lib/**/*.rb
   Exclude:
-    - lib/jekyll/renderer.rb
     - bin/**/*
     - exe/**/*
     - benchmark/**/*
     - script/**/*
     - vendor/**/*
+Layout/AlignArray:
+  Enabled: false
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+Layout/AlignParameters:
+  Enabled: false
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+Layout/IndentationWidth:
+  Severity: error
+Layout/IndentArray:
+  EnforcedStyle: consistent
+Layout/IndentHash:
+  EnforcedStyle: consistent
+Layout/IndentHeredoc:
+  Enabled: false
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+Layout/SpaceAroundOperators:
+  Enabled: true
+Layout/SpaceInsideBrackets:
+  Enabled: false
 Lint/EndAlignment:
   Severity: error
 Lint/UnreachableCode:
@@ -36,6 +67,8 @@ Metrics/LineLength:
     - !ruby/regexp /features\/.*.rb/
     - Rakefile
     - rake/*.rake
+    - Gemfile
+    - jekyll.gemspec
   Max: 90
   Severity: warning
 Metrics/MethodLength:
@@ -58,13 +91,6 @@ Security/YAMLLoad:
     - !ruby/regexp /test\/.*.rb$/
 Style/Alias:
   Enabled: false
-Style/AlignArray:
-  Enabled: false
-Style/AlignHash:
-  EnforcedHashRocketStyle: table
-Style/AlignParameters:
-  Enabled: false
-  EnforcedStyle: with_fixed_indentation
 Style/AndOr:
   Severity: error
 Style/Attr:
@@ -79,16 +105,8 @@ Style/Documentation:
     - !ruby/regexp /features\/.*.rb$/
 Style/DoubleNegation:
   Enabled: false
-Style/EmptyLinesAroundAccessModifier:
-  Enabled: false
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-Style/ExtraSpacing:
-  AllowForAlignment: true
 Style/FileName:
   Enabled: false
-Style/FirstParameterIndentation:
-  EnforcedStyle: consistent
 Style/GuardClause:
   Enabled: false
 Style/HashSyntax:
@@ -96,18 +114,10 @@ Style/HashSyntax:
   Severity: error
 Style/IfUnlessModifier:
   Enabled: false
-Style/IndentArray:
-  EnforcedStyle: consistent
-Style/IndentHash:
-  EnforcedStyle: consistent
-Style/IndentationWidth:
-  Severity: error
+Style/InverseMethods:
+  Enabled: false
 Style/ModuleFunction:
   Enabled: false
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
 Style/MultilineTernaryOperator:
   Severity: error
 Style/PercentLiteralDelimiters:
@@ -131,14 +141,12 @@ Style/SignalException:
   EnforcedStyle: only_raise
 Style/SingleLineMethods:
   Enabled: false
-Style/SpaceAroundOperators:
-  Enabled: false
-Style/SpaceInsideBrackets:
-  Enabled: false
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false
 Style/TrailingCommaInLiteral:
   EnforcedStyleForMultiline: consistent_comma
 Style/UnneededCapitalW:

data/exe/jekyll

@@ -25,13 +25,13 @@ Mercenary.program(:jekyll) do |p|
     "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|
+  Jekyll::External.require_if_present(Jekyll::External.blessed_gems) do |g, ver_constraint|
     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."
+          " version #{ver_constraint} to use the 'jekyll #{cmd}' command."
       end
     end
   end

data/lib/jekyll/collection.rb

@@ -34,7 +34,7 @@ module Jekyll
       if docs.respond_to?(method.to_sym)
         Jekyll.logger.warn "Deprecation:",
           "#{label}.#{method} should be changed to #{label}.docs.#{method}."
-        Jekyll.logger.warn "", "Called by #{caller.first}."
+        Jekyll.logger.warn "", "Called by #{caller(0..0)}."
         docs.public_send(method.to_sym, *args, &blck)
       else
         super
@@ -72,7 +72,7 @@ module Jekyll
     def entries
       return [] unless exists?
       @entries ||=
-        Utils.safe_glob(collection_dir, ["**", "*"]).map do |entry|
+        Utils.safe_glob(collection_dir, ["**", "*"], File::FNM_DOTMATCH).map do |entry|
           entry["#{collection_dir}/"] = ""
           entry
         end

data/lib/jekyll/command.rb

@@ -37,6 +37,7 @@ module Jekyll
       #
       # Returns a full Jekyll configuration
       def configuration_from_options(options)
+        return options if options.is_a?(Jekyll::Configuration)
         Jekyll.configuration(options)
       end
 
@@ -45,6 +46,7 @@ module Jekyll
       # c - the Jekyll::Command to add these options to
       #
       # Returns nothing
+      # rubocop:disable Metrics/MethodLength
       def add_build_options(c)
         c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
           Array, "Custom configuration file"
@@ -65,7 +67,10 @@ module Jekyll
         c.option "quiet", "-q", "--quiet", "Silence output."
         c.option "verbose", "-V", "--verbose", "Print verbose output."
         c.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
+        c.option "strict_front_matter", "--strict_front_matter",
+          "Fail if errors are present in front matter"
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/jekyll/commands/new.rb

@@ -61,7 +61,6 @@ module Jekyll
         def gemfile_contents
           <<-RUBY
 source "https://rubygems.org"
-ruby RUBY_VERSION
 
 # Hello! This is where you manage which Jekyll version is used to run.
 # When you want to use a different version, change it below, save the
@@ -109,6 +108,7 @@ RUBY
 
         def create_sample_files(path)
           FileUtils.cp_r site_template + "/.", path
+          FileUtils.chmod_R "u+w", path
           FileUtils.rm File.expand_path(scaffold_path, path)
         end
 

data/lib/jekyll/commands/serve.rb

@@ -32,11 +32,12 @@ module Jekyll
             cmd.action do |_, opts|
               opts["serving"] = true
               opts["watch"  ] = true unless opts.key?("watch")
-              config = opts["config"]
-              opts["url"] = default_url(opts) if Jekyll.env == "development"
-              Build.process(opts)
-              opts["config"] = config
-              Serve.process(opts)
+
+              config = configuration_from_options(opts)
+              if Jekyll.env == "development"
+                config["url"] = default_url(config)
+              end
+              [Build, Serve].each { |klass| klass.process(config) }
             end
           end
         end
@@ -135,7 +136,7 @@ module Jekyll
 
         private
         def format_url(ssl_enabled, address, port, baseurl = nil)
-          format("%{prefix}://%{address}:%{port}%{baseurl}", {
+          format("%<prefix>s://%<address>s:%<port>i%<baseurl>s", {
             :prefix  => ssl_enabled ? "https" : "http",
             :address => address,
             :port    => port,

data/lib/jekyll/configuration.rb

@@ -6,70 +6,72 @@ module Jekyll
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = Configuration[{
       # Where things are
-      "source"            => Dir.pwd,
-      "destination"       => File.join(Dir.pwd, "_site"),
-      "plugins_dir"       => "_plugins",
-      "layouts_dir"       => "_layouts",
-      "data_dir"          => "_data",
-      "includes_dir"      => "_includes",
-      "collections"       => {},
+      "source"              => Dir.pwd,
+      "destination"         => File.join(Dir.pwd, "_site"),
+      "plugins_dir"         => "_plugins",
+      "layouts_dir"         => "_layouts",
+      "data_dir"            => "_data",
+      "includes_dir"        => "_includes",
+      "collections"         => {},
 
       # Handling Reading
-      "safe"              => false,
-      "include"           => [".htaccess"],
-      "exclude"           => %w(
-        node_modules vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
+      "safe"                => false,
+      "include"             => [".htaccess"],
+      "exclude"             => %w(
+        Gemfile Gemfile.lock node_modules vendor/bundle/ vendor/cache/ vendor/gems/
+        vendor/ruby/
       ),
-      "keep_files"        => [".git", ".svn"],
-      "encoding"          => "utf-8",
-      "markdown_ext"      => "markdown,mkdown,mkdn,mkd,md",
+      "keep_files"          => [".git", ".svn"],
+      "encoding"            => "utf-8",
+      "markdown_ext"        => "markdown,mkdown,mkdn,mkd,md",
+      "strict_front_matter" => false,
 
       # Filtering Content
-      "show_drafts"       => nil,
-      "limit_posts"       => 0,
-      "future"            => false,
-      "unpublished"       => false,
+      "show_drafts"         => nil,
+      "limit_posts"         => 0,
+      "future"              => false,
+      "unpublished"         => false,
 
       # Plugins
-      "whitelist"         => [],
-      "gems"              => [],
+      "whitelist"           => [],
+      "plugins"             => [],
 
       # Conversion
-      "markdown"          => "kramdown",
-      "highlighter"       => "rouge",
-      "lsi"               => false,
-      "excerpt_separator" => "\n\n",
-      "incremental"       => false,
+      "markdown"            => "kramdown",
+      "highlighter"         => "rouge",
+      "lsi"                 => false,
+      "excerpt_separator"   => "\n\n",
+      "incremental"         => false,
 
       # Serving
-      "detach"            => false, # default to not detaching the server
-      "port"              => "4000",
-      "host"              => "127.0.0.1",
-      "baseurl"           => nil, # this mounts at /, i.e. no subdirectory
-      "show_dir_listing"  => false,
+      "detach"              => false, # default to not detaching the server
+      "port"                => "4000",
+      "host"                => "127.0.0.1",
+      "baseurl"             => nil, # this mounts at /, i.e. no subdirectory
+      "show_dir_listing"    => false,
 
       # Output Configuration
-      "permalink"         => "date",
-      "paginate_path"     => "/page:num",
-      "timezone"          => nil, # use the local timezone
+      "permalink"           => "date",
+      "paginate_path"       => "/page:num",
+      "timezone"            => nil, # use the local timezone
 
-      "quiet"             => false,
-      "verbose"           => false,
-      "defaults"          => [],
+      "quiet"               => false,
+      "verbose"             => false,
+      "defaults"            => [],
 
-      "liquid"            => {
+      "liquid"              => {
         "error_mode" => "warn",
       },
 
-      "rdiscount"         => {
+      "rdiscount"           => {
         "extensions" => [],
       },
 
-      "redcarpet"         => {
+      "redcarpet"           => {
         "extensions" => [],
       },
 
-      "kramdown"          => {
+      "kramdown"            => {
         "auto_ids"      => true,
         "toc_levels"    => "1..6",
         "entity_output" => "as_char",
@@ -136,7 +138,7 @@ module Jekyll
         SafeYAML.load_file(filename) || {}
       else
         raise ArgumentError, "No parser for '#{filename}' is available.
-          Use a .toml or .y(a)ml file instead."
+          Use a .y(a)ml or .toml file instead."
       end
     end
 
@@ -228,9 +230,10 @@ module Jekyll
       # Provide backwards-compatibility
       check_auto(config)
       check_server(config)
+      check_plugins(config)
 
       renamed_key "server_port", "port", config
-      renamed_key "plugins", "plugins_dir", config
+      renamed_key "gems", "plugins", config
       renamed_key "layouts", "layouts_dir", config
       renamed_key "data_source", "data_dir", config
 
@@ -384,5 +387,24 @@ module Jekyll
           "`_config.yml` file."
       end
     end
+
+    # Private: Checks if the `plugins` config is a String
+    #
+    # config - the config hash
+    #
+    # Raises a Jekyll::Errors::InvalidConfigurationError if the config `plugins`
+    # is a string
+    private
+    def check_plugins(config)
+      if config.key?("plugins") && config["plugins"].is_a?(String)
+        Jekyll.logger.error "Configuration Error:", "You specified the" \
+          " `plugins` config in your configuration file as a string, please" \
+          " use an array instead. If you wanted to set the directory of your" \
+          " plugins, use the config key `plugins_dir` instead."
+        raise Jekyll::Errors::InvalidConfigurationError,
+          "'plugins' should not be a string, but was: " \
+          "#{config["plugins"].inspect}. Use 'plugins_dir' instead."
+      end
+    end
   end
 end

data/lib/jekyll/converter.rb

@@ -8,7 +8,7 @@ module Jekyll
     #
     # Returns the String prefix.
     def self.highlighter_prefix(highlighter_prefix = nil)
-      if !defined?(@highlighter_prefix) || !highlighter_prefix.nil?
+      unless defined?(@highlighter_prefix) && highlighter_prefix.nil?
         @highlighter_prefix = highlighter_prefix
       end
       @highlighter_prefix
@@ -22,7 +22,7 @@ module Jekyll
     #
     # Returns the String suffix.
     def self.highlighter_suffix(highlighter_suffix = nil)
-      if !defined?(@highlighter_suffix) || !highlighter_suffix.nil?
+      unless defined?(@highlighter_suffix) && highlighter_suffix.nil?
         @highlighter_suffix = highlighter_suffix
       end
       @highlighter_suffix

data/lib/jekyll/convertible.rb

@@ -48,8 +48,10 @@ module Jekyll
         end
       rescue SyntaxError => e
         Jekyll.logger.warn "YAML Exception reading #{filename}: #{e.message}"
+        raise e if self.site.config["strict_front_matter"]
       rescue => e
         Jekyll.logger.warn "Error reading file #{filename}: #{e.message}"
+        raise e if self.site.config["strict_front_matter"]
       end
 
       self.data ||= {}
@@ -69,7 +71,7 @@ module Jekyll
     end
 
     def validate_permalink!(filename)
-      if self.data["permalink"] && self.data["permalink"].empty?
+      if self.data["permalink"] && self.data["permalink"].to_s.empty?
         raise Errors::InvalidPermalinkError, "Invalid permalink in #{filename}"
       end
     end
@@ -78,7 +80,7 @@ module Jekyll
     #
     # Returns the transformed contents.
     def transform
-      _renderer.transform
+      _renderer.convert(content)
     end
 
     # Determine the extension depending on content_type.
@@ -158,7 +160,7 @@ module Jekyll
     #
     # Returns true if extname == .coffee, false otherwise.
     def coffeescript_file?
-      ".coffee" == ext
+      ext == ".coffee"
     end
 
     # Determine whether the file should be rendered with Liquid.