jekyll 3.7.0 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: dc90aec85835d915ea7cb5f56a489a923d0bc78681a23ea5ee0b1df2c1382a6b
-  data.tar.gz: e0131966b4f2abf57be7744559b7e5ff207ec6c200615dc2646c96847d92af7b
+SHA1:
+  metadata.gz: c29669117e5c63987bdce5016721d179f9d7cc0e
+  data.tar.gz: 4749002283952250c8e2c51e38b34598cd77dfcd
 SHA512:
-  metadata.gz: 6baa34eeb5717fbbc2919bb03b54a21857785167c1f178a0add5d301bd9f56735a8e14948b69966b65498555f1002460ae8972c76ebac6b28ccada1447e660cc
-  data.tar.gz: 4b36b7255f94a8221cae77714214711fc3909ddc9bb984ab4e852e0c3cde915a2dc2756a7c92b2ead11e0b86cf0e3cbf500eabeeb4680fc5a96c6083d2d16cce
+  metadata.gz: a6fad55711b6be2ad22def22a70e5b5b050e59aa196730446fdcdcbbe7780069da2ac910af369c28bc3a85ef9281f5337c1eccb9d50270a741531e1a58eb09ad
+  data.tar.gz: de5af54a0c8a33c89daa830b5d91c9c1609c7aa64abcf9e7e67481dfc19a2b0f79ac20b640f4b30c5cb121c5f4f2ceb077fe57519929043c86ae50f7d06db75a

data/.rubocop.yml

@@ -1,4 +1,12 @@
 ---
+
+require:
+  - ./rubocop/jekyll
+
+Jekyll/NoPutsAllowed:
+  Exclude:
+    - rake/*.rake
+
 AllCops:
   TargetRubyVersion: 2.1
   Include:

data/lib/jekyll/collection.rb

@@ -95,14 +95,13 @@ module Jekyll
         end
     end
 
-    # The directory for this Collection, relative to the site source.
+    # The directory for this Collection, relative to the site source or the directory
+    # containing the collection.
     #
     # Returns a String containing the directory name where the collection
     #   is stored on the filesystem.
     def relative_directory
-      @relative_directory ||= Pathname.new(directory).relative_path_from(
-        Pathname.new(site.source)
-      ).to_s
+      @relative_directory ||= "_#{label}"
     end
 
     # The full path to the directory containing the collection.
@@ -111,7 +110,7 @@ module Jekyll
     #   is stored on the filesystem.
     def directory
       @directory ||= site.in_source_dir(
-        File.join(site.config["collections_dir"], "_#{label}")
+        File.join(container, relative_directory)
       )
     end
 
@@ -125,7 +124,7 @@ module Jekyll
     #   is stored on the filesystem.
     def collection_dir(*files)
       return directory if files.empty?
-      site.in_source_dir(relative_directory, *files)
+      site.in_source_dir(container, relative_directory, *files)
     end
 
     # Checks whether the directory "exists" for this collection.
@@ -204,6 +203,12 @@ module Jekyll
 
     private
 
+    def container
+      @container ||= site.config["collections_dir"]
+    end
+
+    private
+
     def read_document(full_path)
       doc = Jekyll::Document.new(full_path, :site => site, :collection => self)
       doc.read

data/lib/jekyll/commands/help.rb

@@ -12,9 +12,9 @@ module Jekyll
             c.action do |args, _|
               cmd = (args.first || "").to_sym
               if args.empty?
-                puts prog
+                Jekyll.logger.info prog.to_s
               elsif prog.has_command? cmd
-                puts prog.commands[cmd]
+                Jekyll.logger.info prog.commands[cmd].to_s
               else
                 invalid_command(prog, cmd)
                 abort

data/lib/jekyll/commands/new.rb

@@ -89,6 +89,9 @@ end
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
 
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0" if Gem.win_platform?
+
 RUBY
         end
 

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

@@ -14,7 +14,9 @@ module Jekyll
         }.freeze
 
         def initialize(config)
-          Jekyll::External.require_with_graceful_fail "kramdown"
+          unless defined?(Kramdown)
+            Jekyll::External.require_with_graceful_fail "kramdown"
+          end
           @main_fallback_highlighter = config["highlighter"] || "rouge"
           @config = config["kramdown"] || {}
           @highlighter = nil

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

@@ -5,7 +5,9 @@ module Jekyll
     class Markdown
       class RDiscountParser
         def initialize(config)
-          Jekyll::External.require_with_graceful_fail "rdiscount"
+          unless defined?(RDiscount)
+            Jekyll::External.require_with_graceful_fail "rdiscount"
+          end
           @config = config
           @rdiscount_extensions = @config["rdiscount"]["extensions"].map(&:to_sym)
         end

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

@@ -16,7 +16,9 @@ class Jekyll::Converters::Markdown::RedcarpetParser
   module WithPygments
     include CommonMethods
     def block_code(code, lang)
-      Jekyll::External.require_with_graceful_fail("pygments")
+      unless defined?(Pygments)
+        Jekyll::External.require_with_graceful_fail("pygments")
+      end
       lang = lang && lang.split.first || "text"
       add_code_tags(
         Pygments.highlight(
@@ -60,7 +62,9 @@ class Jekyll::Converters::Markdown::RedcarpetParser
   end
 
   def initialize(config)
-    Jekyll::External.require_with_graceful_fail("redcarpet")
+    unless defined?(Redcarpet)
+      Jekyll::External.require_with_graceful_fail("redcarpet")
+    end
     @config = config
     @redcarpet_extensions = {}
     @config["redcarpet"]["extensions"].each do |e|

data/lib/jekyll/converters/smartypants.rb

@@ -20,7 +20,9 @@ module Jekyll
       priority :low
 
       def initialize(config)
-        Jekyll::External.require_with_graceful_fail "kramdown"
+        unless defined?(Kramdown)
+          Jekyll::External.require_with_graceful_fail "kramdown"
+        end
         @config = config["kramdown"].dup || {}
         @config[:input] = :SmartyPants
       end

data/lib/jekyll/document.rb

@@ -78,12 +78,13 @@ module Jekyll
         collection.label == "posts"
     end
 
-    # The path to the document, relative to the site source.
+    # The path to the document, relative to the collections_dir.
     #
-    # Returns a String path which represents the relative path
-    #   from the site source to this document
+    # Returns a String path which represents the relative path from the collections_dir
+    # to this document.
     def relative_path
-      @relative_path ||= Pathutil.new(path).relative_path_from(site.source).to_s
+      @relative_path ||=
+        Pathutil.new(path).relative_path_from(site.collections_path).to_s
     end
 
     # The output extension of the document.
@@ -399,11 +400,9 @@ module Jekyll
     def populate_categories
       merge_data!({
         "categories" => (
-        Array(data["categories"]) + Utils.pluralized_array_from_hash(
-          data,
-          "category",
-          "categories"
-        )
+          Array(data["categories"]) + Utils.pluralized_array_from_hash(
+            data, "category", "categories"
+          )
         ).map(&:to_s).flatten.uniq,
       })
     end
@@ -426,7 +425,7 @@ module Jekyll
 
     private
     def merge_date!(source)
-      if data.key?("date") && !data["date"].is_a?(Time)
+      if data.key?("date")
         data["date"] = Utils.parse_date(
           data["date"].to_s,
           "Document '#{relative_path}' does not have a valid date in the #{source}."

data/lib/jekyll/frontmatter_defaults.rb

@@ -97,21 +97,27 @@ module Jekyll
       applies_path?(scope, path) && applies_type?(scope, type)
     end
 
+    # rubocop:disable Metrics/AbcSize
     def applies_path?(scope, path)
       return true if !scope.key?("path") || scope["path"].empty?
 
       sanitized_path = Pathname.new(sanitize_path(path))
-
-      site_path = Pathname.new(@site.source)
+      site_path      = Pathname.new(@site.source)
       rel_scope_path = Pathname.new(scope["path"])
       abs_scope_path = File.join(@site.source, rel_scope_path)
-      Dir.glob(abs_scope_path).each do |scope_path|
-        scope_path = Pathname.new(scope_path).relative_path_from site_path
-        return true if path_is_subpath?(sanitized_path, scope_path)
-      end
 
-      path_is_subpath?(sanitized_path, rel_scope_path)
+      if scope["path"].to_s.include?("*")
+        Dir.glob(abs_scope_path).each do |scope_path|
+          scope_path = Pathname.new(scope_path).relative_path_from site_path
+          Jekyll.logger.debug "Globbed Scope Path:", scope_path
+          return true if path_is_subpath?(sanitized_path, scope_path)
+        end
+        false
+      else
+        path_is_subpath?(sanitized_path, rel_scope_path)
+      end
     end
+    # rubocop:enable Metrics/AbcSize
 
     def path_is_subpath?(path, parent_path)
       path.ascend do |ascended_path|

data/lib/jekyll/reader.rb

@@ -62,6 +62,7 @@ module Jekyll
     #
     # Returns nothing.
     def retrieve_posts(dir)
+      return if outside_configured_directory?(dir)
       site.posts.docs.concat(PostReader.new(site).read_posts(dir))
       site.posts.docs.concat(PostReader.new(site).read_drafts(dir)) if site.show_drafts
     end
@@ -130,5 +131,20 @@ module Jekyll
       entries = Dir.chdir(base) { filter_entries(Dir["**/*"], base) }
       entries.delete_if { |e| File.directory?(site.in_source_dir(base, e)) }
     end
+
+    private
+
+    # Internal
+    #
+    # Determine if the directory is supposed to contain posts and drafts.
+    # If the user has defined a custom collections_dir, then attempt to read
+    # posts and drafts only from within that directory.
+    #
+    # Returns true if a custom collections_dir has been set but current directory lies
+    # outside that directory.
+    def outside_configured_directory?(dir)
+      collections_dir = site.config["collections_dir"]
+      !collections_dir.empty? && !dir.start_with?("/#{collections_dir}")
+    end
   end
 end

data/lib/jekyll/site.rb

@@ -77,7 +77,7 @@ module Jekyll
     end
 
     def print_stats
-      puts @liquid_renderer.stats_table
+      Jekyll.logger.info @liquid_renderer.stats_table
     end
 
     # Reset Site details.
@@ -391,6 +391,15 @@ module Jekyll
       end
     end
 
+    # Public: The full path to the directory that houses all the collections registered
+    # with the current site.
+    #
+    # Returns the source directory or the absolute path to the custom collections_dir
+    def collections_path
+      dir_str = config["collections_dir"]
+      @collections_path ||= dir_str.empty? ? source : in_source_dir(dir_str)
+    end
+
     # Limits the current posts; removes the posts which exceed the limit_posts
     #
     # Returns nothing

data/lib/jekyll/static_file.rb

@@ -40,7 +40,12 @@ module Jekyll
 
     # Returns source file path.
     def path
-      File.join(*[@base, @dir, @name].compact)
+      # Static file is from a collection inside custom collections directory
+      if !@collection.nil? && !@site.config["collections_dir"].empty?
+        File.join(*[@base, @site.config["collections_dir"], @dir, @name].compact)
+      else
+        File.join(*[@base, @dir, @name].compact)
+      end
     end
 
     # Obtain destination path.

data/lib/jekyll/tags/include.rb

@@ -115,9 +115,7 @@ MSG
           path = File.join(dir.to_s, file.to_s)
           return path if valid_include_file?(path, dir.to_s, safe)
         end
-        raise IOError, "Could not locate the included file '#{file}' in any of "\
-          "#{includes_dirs}. Ensure it exists in one of those directories and, "\
-          "if it is a symlink, does not point outside your site source."
+        raise IOError, could_not_locate_message(file, includes_dirs, safe)
       end
 
       def render(context)
@@ -192,6 +190,18 @@ MSG
       def read_file(file, context)
         File.read(file, file_read_opts(context))
       end
+
+      private
+
+      def could_not_locate_message(file, includes_dirs, safe)
+        message = "Could not locate the included file '#{file}' in any of "\
+          "#{includes_dirs}. Ensure it exists in one of those directories and"
+        message + if safe
+                    " is not a symlink as those are not allowed in safe mode."
+                  else
+                    ", if it is a symlink, does not point outside your site source."
+                  end
+      end
     end
 
     class IncludeRelativeTag < IncludeTag

data/lib/jekyll/theme.rb

@@ -38,7 +38,7 @@ module Jekyll
 
     def configure_sass
       return unless sass_path
-      Jekyll::External.require_with_graceful_fail "sass"
+      External.require_with_graceful_fail("sass") unless defined?(Sass)
       Sass.load_paths << sass_path
     end
 

data/lib/jekyll/utils/rouge.rb

@@ -5,7 +5,7 @@ module Jekyll
     module Rouge
 
       def self.html_formatter(*args)
-        Jekyll::External.require_with_graceful_fail("rouge")
+        Jekyll::External.require_with_graceful_fail("rouge") unless defined?(::Rouge)
         if old_api?
           ::Rouge::Formatters::HTML.new(*args)
         else

data/lib/jekyll/utils/win_tz.rb

@@ -12,7 +12,7 @@ module Jekyll
       #
       # Returns a string that ultimately re-defines ENV["TZ"] in Windows
       def calculate(timezone)
-        External.require_with_graceful_fail("tzinfo")
+        External.require_with_graceful_fail("tzinfo") unless defined?(TZInfo)
         tz = TZInfo::Timezone.get(timezone)
         difference = Time.now.to_i - tz.now.to_i
         #

data/lib/jekyll/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jekyll
-  VERSION = "3.7.0".freeze
+  VERSION = "3.7.2".freeze
 end

data/lib/theme_template/theme.gemspec.erb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
   spec.name          = <%= theme_name.inspect %>
@@ -6,14 +6,14 @@ Gem::Specification.new do |spec|
   spec.authors       = [<%= user_name.inspect %>]
   spec.email         = [<%= user_email.inspect %>]
 
-  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.summary       = "TODO: Write a short summary, because Rubygems requires one."
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(<%= theme_directories.join("|") %>|LICENSE|README)}i) }
+  spec.files         = `git ls-files -z`.split("\x0").select { |f| f.match(%r!^(<%= theme_directories.join("|") %>|LICENSE|README)!i) }
 
   spec.add_runtime_dependency "jekyll", "~> <%= jekyll_version_with_minor %>"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.0"
 end

data/rubocop/jekyll.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir[File.join(File.expand_path("jekyll", __dir__), "*.rb")].each do |ruby_file|
+  require ruby_file
+end

data/rubocop/jekyll/no_p_allowed.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Jekyll
+      class NoPAllowed < Cop
+        MSG = "Avoid using `p` to print things. Use `Jekyll.logger` instead.".freeze
+
+        def_node_search :p_called?, <<-PATTERN
+        (send _ :p _)
+        PATTERN
+
+        def on_send(node)
+          if p_called?(node)
+            add_offense(node, :location => :selector)
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop/jekyll/no_puts_allowed.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module Jekyll
+      class NoPutsAllowed < Cop
+        MSG = "Avoid using `puts` to print things. Use `Jekyll.logger` instead.".freeze
+
+        def_node_search :puts_called?, <<-PATTERN
+        (send nil? :puts _)
+        PATTERN
+
+        def on_send(node)
+          if puts_called?(node)
+            add_offense(node, :location => :selector)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.2
 platform: ruby
 authors:
 - Tom Preston-Werner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-02 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -303,6 +303,9 @@ files:
 - lib/theme_template/example/style.scss
 - lib/theme_template/gitignore.erb
 - lib/theme_template/theme.gemspec.erb
+- rubocop/jekyll.rb
+- rubocop/jekyll/no_p_allowed.rb
+- rubocop/jekyll/no_puts_allowed.rb
 homepage: https://github.com/jekyll/jekyll
 licenses:
 - MIT
@@ -324,7 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 2
 summary: A simple, blog aware, static site generator.