jekyll 3.9.3 → 4.4.1

data/lib/jekyll/utils.rb

@@ -7,25 +7,17 @@ module Jekyll
     autoload :Exec, "jekyll/utils/exec"
     autoload :Internet, "jekyll/utils/internet"
     autoload :Platforms, "jekyll/utils/platforms"
-    autoload :Rouge, "jekyll/utils/rouge"
     autoload :ThreadEvent, "jekyll/utils/thread_event"
     autoload :WinTZ, "jekyll/utils/win_tz"
 
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty ascii latin).freeze
     SLUGIFY_RAW_REGEXP = Regexp.new('\\s+').freeze
-    SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^[:alnum:]]+").freeze
-    SLUGIFY_PRETTY_REGEXP = Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
+    SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}]+").freeze
+    SLUGIFY_PRETTY_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}._~!$&'()+,;=@]+").freeze
     SLUGIFY_ASCII_REGEXP = Regexp.new("[^[A-Za-z0-9]]+").freeze
 
-    # Takes an indented string and removes the preceding spaces on each line
-
-    def strip_heredoc(str)
-      str.gsub(%r!^[ \t]{#{(str.scan(%r!^[ \t]*(?=\S)!).min || "").size}}!, "")
-    end
-
     # Takes a slug and turns it into a simple title.
-
     def titleize_slug(slug)
       slug.split("-").map!(&:capitalize).join(" ")
     end
@@ -76,11 +68,14 @@ module Jekyll
     #
     # Returns an array
     def pluralized_array_from_hash(hash, singular_key, plural_key)
-      [].tap do |array|
-        value = value_from_singular_key(hash, singular_key)
-        value ||= value_from_plural_key(hash, plural_key)
-        array << value
-      end.flatten.compact
+      array = []
+      value = value_from_singular_key(hash, singular_key)
+      value ||= value_from_plural_key(hash, plural_key)
+
+      array << value
+      array.flatten!
+      array.compact!
+      array
     end
 
     def value_from_singular_key(hash, key)
@@ -133,7 +128,8 @@ module Jekyll
     # Returns the parsed date if successful, throws a FatalException
     # if not
     def parse_date(input, msg = "Input could not be parsed.")
-      Time.parse(input).localtime
+      @parse_date_cache ||= {}
+      @parse_date_cache[input] ||= Time.parse(input).localtime
     rescue ArgumentError
       raise Errors::InvalidDateError, "Invalid date '#{input}': #{msg}"
     end
@@ -141,21 +137,22 @@ module Jekyll
     # Determines whether a given file has
     #
     # Returns true if the YAML front matter is present.
-    # rubocop: disable PredicateName
+    # rubocop: disable Naming/PredicateName
     def has_yaml_header?(file)
-      !!(File.open(file, "rb", &:readline) =~ %r!\A---\s*\r?\n!)
+      File.open(file, "rb", &:readline).match? %r!\A---\s*\r?\n!
     rescue EOFError
       false
     end
 
-    # Determine whether the given content string contains Liquid Tags or Vaiables
+    # Determine whether the given content string contains Liquid Tags or Variables
     #
     # Returns true is the string contains sequences of `{%` or `{{`
     def has_liquid_construct?(content)
       return false if content.nil? || content.empty?
+
       content.include?("{%") || content.include?("{{")
     end
-    # rubocop: enable PredicateName
+    # rubocop: enable Naming/PredicateName
 
     # Slugify a filename or title.
     #
@@ -219,9 +216,10 @@ module Jekyll
       slug = replace_character_sequence_with_hyphen(string, :mode => mode)
 
       # Remove leading/trailing hyphen
-      slug.gsub!(%r!^\-|\-$!i, "")
+      slug.gsub!(%r!^-|-$!i, "")
 
       slug.downcase! unless cased
+      Jekyll.logger.warn("Warning:", "Empty `slug` generated for '#{string}'.") if slug.empty?
       slug
     end
 
@@ -268,7 +266,7 @@ module Jekyll
       template
     end
 
-    # Work the same way as Dir.glob but seperating the input into two parts
+    # Work the same way as Dir.glob but separating the input into two parts
     # ('dir' + '/' + 'pattern') to make sure the first part('dir') does not act
     # as a pattern.
     #
@@ -290,11 +288,13 @@ module Jekyll
     # patterns - the patterns (or the pattern) which will be applied under the dir
     # flags    - the flags which will be applied to the pattern
     #
-    # Returns matched pathes
+    # Returns matched paths
     def safe_glob(dir, patterns, flags = 0)
       return [] unless Dir.exist?(dir)
+
       pattern = File.join(Array(patterns))
       return [dir] if pattern.empty?
+
       Dir.chdir(dir) do
         Dir.glob(pattern, flags).map { |f| File.join(dir, f) }
       end
@@ -304,16 +304,20 @@ module Jekyll
     # and a given param
     def merged_file_read_opts(site, opts)
       merged = (site ? site.file_read_opts : {}).merge(opts)
-      if merged[:encoding] && !merged[:encoding].start_with?("bom|")
+
+      # always use BOM when reading UTF-encoded files
+      if merged[:encoding]&.downcase&.start_with?("utf-")
         merged[:encoding] = "bom|#{merged[:encoding]}"
       end
-      if merged["encoding"] && !merged["encoding"].start_with?("bom|")
+      if merged["encoding"]&.downcase&.start_with?("utf-")
         merged["encoding"] = "bom|#{merged["encoding"]}"
       end
+
       merged
     end
 
     private
+
     def merge_values(target, overwrite)
       target.merge!(overwrite) do |_key, old_val, new_val|
         if new_val.nil?
@@ -326,14 +330,12 @@ module Jekyll
       end
     end
 
-    private
     def merge_default_proc(target, overwrite)
       if target.is_a?(Hash) && overwrite.is_a?(Hash) && target.default_proc.nil?
         target.default_proc = overwrite.default_proc
       end
     end
 
-    private
     def duplicate_frozen_values(target)
       target.each do |key, val|
         target[key] = val.dup if val.frozen? && duplicable?(val)
@@ -344,7 +346,6 @@ module Jekyll
     #
     # See Utils#slugify for a description of the character sequence specified
     # by each mode.
-    private
     def replace_character_sequence_with_hyphen(string, mode: "default")
       replaceable_char =
         case mode

data/lib/jekyll/version.rb

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

data/lib/jekyll.rb

@@ -50,10 +50,13 @@ module Jekyll
   autoload :EntryFilter,         "jekyll/entry_filter"
   autoload :Errors,              "jekyll/errors"
   autoload :Excerpt,             "jekyll/excerpt"
+  autoload :PageExcerpt,         "jekyll/page_excerpt"
   autoload :External,            "jekyll/external"
   autoload :FrontmatterDefaults, "jekyll/frontmatter_defaults"
   autoload :Hooks,               "jekyll/hooks"
   autoload :Layout,              "jekyll/layout"
+  autoload :Inclusion,           "jekyll/inclusion"
+  autoload :Cache,               "jekyll/cache"
   autoload :CollectionReader,    "jekyll/readers/collection_reader"
   autoload :DataReader,          "jekyll/readers/data_reader"
   autoload :LayoutReader,        "jekyll/readers/layout_reader"
@@ -64,8 +67,10 @@ module Jekyll
   autoload :LogAdapter,          "jekyll/log_adapter"
   autoload :Page,                "jekyll/page"
   autoload :PageWithoutAFile,    "jekyll/page_without_a_file"
+  autoload :PathManager,         "jekyll/path_manager"
   autoload :PluginManager,       "jekyll/plugin_manager"
   autoload :Publisher,           "jekyll/publisher"
+  autoload :Profiler,            "jekyll/profiler"
   autoload :Reader,              "jekyll/reader"
   autoload :Regenerator,         "jekyll/regenerator"
   autoload :RelatedPosts,        "jekyll/related_posts"
@@ -143,7 +148,7 @@ module Jekyll
 
     # Public: Set the log writer.
     #         New log writer must respond to the same methods
-    #         as Ruby's interal Logger.
+    #         as Ruby's internal Logger.
     #
     # writer - the new Logger-compatible log transport
     #
@@ -168,23 +173,13 @@ module Jekyll
     # Returns the sanitized path.
     def sanitized_path(base_directory, questionable_path)
       return base_directory if base_directory.eql?(questionable_path)
+      return base_directory if questionable_path.nil?
 
-      clean_path = questionable_path.dup
-      clean_path.insert(0, "/") if clean_path.start_with?("~")
-      clean_path = File.expand_path(clean_path, "/")
-
-      return clean_path if clean_path.eql?(base_directory)
-
-      if clean_path.start_with?(base_directory.sub(%r!\z!, "/"))
-        clean_path
-      else
-        clean_path.sub!(%r!\A\w:/!, "/")
-        File.join(base_directory, clean_path)
-      end
+      +Jekyll::PathManager.sanitized_path(base_directory, questionable_path)
     end
 
     # Conditional optimizations
-    Jekyll::External.require_if_present("liquid-c")
+    Jekyll::External.require_if_present("liquid/c")
   end
 end
 

data/lib/site_template/.gitignore

@@ -1,3 +1,5 @@
 _site
 .sass-cache
+.jekyll-cache
 .jekyll-metadata
+vendor

data/lib/site_template/404.html

@@ -1,5 +1,6 @@
 ---
-layout: default
+permalink: /404.html
+layout: page
 ---
 
 <style type="text/css" media="screen">

data/lib/site_template/_config.yml

@@ -7,12 +7,17 @@
 #
 # For technical reasons, this file is *NOT* reloaded automatically when you use
 # 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
+#
+# If you need help with YAML syntax, here are some quick references for you:
+# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
+# https://learnxinyminutes.com/docs/yaml/
+#
 # Site settings
 # These are used to personalize your new site. If you look in the HTML files,
 # you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
+
 title: Your awesome title
 email: your-email@example.com
 description: >- # this means to ignore newlines until "baseurl:"
@@ -25,18 +30,25 @@ twitter_username: jekyllrb
 github_username:  jekyll
 
 # Build settings
-markdown: kramdown
 theme: minima
 plugins:
   - jekyll-feed
 
 # Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
+# The following items will not be processed, by default.
+# Any item listed under the `exclude:` key here will be automatically added to
+# the internal "default list".
+#
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+#
 # exclude:
+#   - .sass-cache/
+#   - .jekyll-cache/
+#   - gemfiles/
 #   - Gemfile
 #   - Gemfile.lock
-#   - node_modules
+#   - node_modules/
 #   - vendor/bundle/
 #   - vendor/cache/
 #   - vendor/gems/

data/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb

@@ -6,7 +6,11 @@ categories: jekyll update
 ---
 You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
 
-To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
+Jekyll requires blog post files to be named according to the following format:
+
+`YEAR-MONTH-DAY-title.MARKUP`
+
+Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works.
 
 Jekyll also offers powerful support for code snippets:
 

data/lib/theme_template/README.md.erb

@@ -6,7 +6,6 @@ To experiment with this code, add some sample content and run `bundle exec jekyl
 
 TODO: Delete this and the text above, and describe your gem
 
-
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
@@ -35,7 +34,7 @@ TODO: Write usage instructions here. Describe your available layouts, includes,
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/<%= theme_name %>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 ## Development
 
@@ -49,4 +48,3 @@ To add a custom directory to your theme-gem, please edit the regexp in `<%= them
 ## License
 
 The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/lib/theme_template/gitignore.erb

@@ -1,5 +1,6 @@
 *.gem
 .bundle
+.jekyll-cache
 .sass-cache
 _site
 Gemfile.lock

data/lib/theme_template/theme.gemspec.erb

@@ -10,10 +10,7 @@ Gem::Specification.new do |spec|
   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|_config\.yml)!i) }
 
   spec.add_runtime_dependency "jekyll", "~> <%= jekyll_version_with_minor %>"
-
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.0"
 end

data/rubocop/jekyll/assert_equal_literal_actual.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Jekyll
+      # Checks for `assert_equal(exp, act, msg = nil)` calls containing literal values as
+      # second argument. The second argument should ideally be a method called on the tested
+      # instance.
+      #
+      # @example
+      #   # bad
+      #   assert_equal @foo.bar, "foobar"
+      #   assert_equal @alpha.beta, { "foo" => "bar", "lorem" => "ipsum" }
+      #   assert_equal @alpha.omega, ["foobar", "lipsum"]
+      #
+      #   # good
+      #   assert_equal "foobar", @foo.bar
+      #
+      #   assert_equal(
+      #     { "foo" => "bar", "lorem" => "ipsum" },
+      #     @alpha.beta
+      #   )
+      #
+      #   assert_equal(
+      #     ["foobar", "lipsum"],
+      #     @alpha.omega
+      #   )
+      #
+      class AssertEqualLiteralActual < Base
+        extend AutoCorrector
+
+        MSG = "Provide the 'expected value' as the first argument to `assert_equal`."
+        RESTRICT_ON_SEND = %i[assert_equal].freeze
+
+        SIMPLE_LITERALS = %i(
+          true
+          false
+          nil
+          int
+          float
+          str
+          sym
+          complex
+          rational
+          regopt
+        ).freeze
+
+        COMPLEX_LITERALS = %i(
+          array
+          hash
+          pair
+          irange
+          erange
+          regexp
+        ).freeze
+
+        def_node_matcher :literal_actual?, <<-PATTERN
+          (send nil? :assert_equal $(send ...) $#literal?)
+        PATTERN
+
+        def_node_matcher :literal_actual_with_msg?, <<-PATTERN
+          (send nil? :assert_equal $(send ...) $#literal? $#opt_msg?)
+        PATTERN
+
+        def on_send(node)
+          return unless literal_actual?(node) || literal_actual_with_msg?(node)
+
+          range = node.loc.expression
+          add_offense(range) do |corrector|
+            corrector.replace(range, replacement(node))
+          end
+        end
+
+        private
+
+        def opt_msg?(node)
+          node&.source
+        end
+
+        # This is not implement using a NodePattern because it seems
+        # to not be able to match against an explicit (nil) sexp
+        def literal?(node)
+          node && (simple_literal?(node) || complex_literal?(node))
+        end
+
+        def simple_literal?(node)
+          SIMPLE_LITERALS.include?(node.type)
+        end
+
+        def complex_literal?(node)
+          COMPLEX_LITERALS.include?(node.type) &&
+            node.each_child_node.all?(&method(:literal?))
+        end
+
+        def replacement(node)
+          _, _, first_param, second_param, optional_param = *node
+
+          replaced_text = \
+            if second_param.type == :hash
+              replace_hash_with_variable(first_param.source, second_param.source)
+            elsif second_param.type == :array && second_param.source != "[]"
+              replace_array_with_variable(first_param.source, second_param.source)
+            else
+              replace_based_on_line_length(first_param.source, second_param.source)
+            end
+
+          return "#{replaced_text}, #{optional_param.source}" if optional_param
+          replaced_text
+        end
+
+        def replace_based_on_line_length(first_expression, second_expression)
+          result = "assert_equal #{second_expression}, #{first_expression}"
+          return result if result.length < 80
+
+          # fold long lines independent of Rubocop configuration for better readability
+          <<~TEXT
+            assert_equal(
+              #{second_expression},
+              #{first_expression}
+            )
+          TEXT
+        end
+
+        def replace_hash_with_variable(first_expression, second_expression)
+          expect_expression = if second_expression.start_with?("{")
+                                second_expression
+                              else
+                                "{#{second_expression}}"
+                              end
+          <<~TEXT
+            expected = #{expect_expression}
+            assert_equal expected, #{first_expression}
+          TEXT
+        end
+
+        def replace_array_with_variable(first_expression, second_expression)
+          expect_expression = if second_expression.start_with?("%")
+                                second_expression
+                              else
+                                Array(second_expression)
+                              end
+          <<~TEXT
+            expected = #{expect_expression}
+            assert_equal expected, #{first_expression}
+          TEXT
+        end
+      end
+    end
+  end
+end

data/rubocop/jekyll/no_p_allowed.rb

@@ -1,20 +1,19 @@
 # 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
+      class NoPAllowed < Base
+        MSG = "Avoid using `p` to print things. Use `Jekyll.logger` instead."
+        RESTRICT_ON_SEND = %i[p].freeze
 
         def_node_search :p_called?, <<-PATTERN
-        (send _ :p _)
+          (send _ :p _)
         PATTERN
 
         def on_send(node)
           if p_called?(node)
-            add_offense(node, :location => :selector)
+            add_offense(node.loc.selector)
           end
         end
       end

data/rubocop/jekyll/no_puts_allowed.rb

@@ -1,20 +1,19 @@
 # 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
+      class NoPutsAllowed < Base
+        MSG = "Avoid using `puts` to print things. Use `Jekyll.logger` instead."
+        RESTRICT_ON_SEND = %i[puts].freeze
 
         def_node_search :puts_called?, <<-PATTERN
-        (send nil? :puts _)
+          (send nil? :puts _)
         PATTERN
 
         def on_send(node)
           if puts_called?(node)
-            add_offense(node, :location => :selector)
+            add_offense(node.loc.selector)
           end
         end
       end