jekyll 4.1.1 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b74631944252558b9ad068a1df651f0890577d11c6ac24d06050fe76e9a41d60
-  data.tar.gz: c34826fe92efe4fe968692fa3517c4f8ddf600b9c99af1776d305804e313a1fe
+  metadata.gz: 6f122205829d592889ffa17acbd3356da8f0de5a0ea22eb5e81fe52ec5751c02
+  data.tar.gz: fe9218747458a630880fa1b359141b07e34ad412f8ca0c4916b48060086c1814
 SHA512:
-  metadata.gz: d89ea1ca35864a53aa21d21847ef357d33a28f8e094bc4c39bc519c2895ea6e8a87d86669252af4b9431a23634209bf38e909ea7b0686ba22bcac898a43488cc
-  data.tar.gz: 950488593a4b255d8196baf07dfdd04a85bd062cf7b612531b6253eb4118d77ab8209290f535621dd2dc6aec2a73f8079092d243aaa002411e855b6264a5c33a
+  metadata.gz: ac4e6dff52be311677418ea2bf0e84d709fed2fb652f88aaf0fb42ec034702ea50f5f4b84876c79db6f0e801f0c9c3059ff011f10654f8274c39108c2b98ed25
+  data.tar.gz: e570481ff2b899ba49c2cbd61a94f0ccd7ae9799f487251ca0eb72200edcf3df7e3aa528036fb873f842c0ca816ad640fb129a08a6cfedec7e4e7d9a40fa3151

data/.rubocop.yml

@@ -10,6 +10,7 @@ Jekyll/NoPutsAllowed:
     - rake/*.rake
 
 AllCops:
+  SuggestExtensions: false
   TargetRubyVersion: 2.4
   Include:
     - lib/**/*.rb
@@ -22,6 +23,8 @@ AllCops:
     - vendor/**/*
     - tmp/**/*
 
+Layout/BeginEndAlignment:
+  Enabled: true
 Layout/EmptyComment:
   Enabled: false
 Layout/EmptyLinesAroundAttributeAccessor:
@@ -50,26 +53,84 @@ Layout/MultilineOperationIndentation:
   EnforcedStyle: indented
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  Exclude:
+    - test/**/*.rb
 
-Lint/NestedPercentLiteral:
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/ConstantDefinitionInBlock:
+  Enabled: true
   Exclude:
-    - test/test_site.rb
+    - test/**/*.rb
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
+Lint/DuplicateBranch:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/DuplicateRequire:
+  Enabled: true
+Lint/EmptyBlock:
+  Enabled: true
+Lint/EmptyClass:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/EmptyFile:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/HashCompareByIdentity:
+  Enabled: true
+Lint/IdentityComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: false
 Lint/MixedRegexpCaptureTypes:
   Enabled: false
+Lint/NestedPercentLiteral:
+  Exclude:
+    - test/test_site.rb
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
 Lint/RaiseException:
   Enabled: true
+Lint/RedundantSafeNavigation:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
 Lint/StructNewOverride:
   Enabled: true
+Lint/ToEnumArguments:
+  Enabled: false
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration:
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
 Lint/UnreachableCode:
   Severity: error
+Lint/UnreachableLoop:
+  Enabled: true
+Lint/UselessMethodDefinition:
+  Enabled: true
+Lint/UselessTimes:
+  Enabled: true
 Lint/Void:
   Exclude:
     - lib/jekyll/site.rb
 
 Metrics/AbcSize:
-  Max: 21
+  Max: 23
 Metrics/BlockLength:
   Exclude:
     - test/**/*.rb
@@ -100,7 +161,7 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   Max: 4
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 13
 
 Naming/FileName:
   Enabled: false
@@ -114,6 +175,39 @@ Naming/MemoizedInstanceVariableName:
     - lib/jekyll/drops/unified_payload_drop.rb
     - lib/jekyll/page_without_a_file.rb
 
+Performance/AncestorsInclude:
+  Enabled: false
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: true
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+Performance/ChainArrayAllocation:
+  Enabled: true
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+Performance/ConstantRegexp:
+  Enabled: true
+Performance/MethodObjectAsBlock:
+  Enabled: true
+Performance/RedundantSortBlock:
+  Enabled: true
+Performance/RedundantStringChars:
+  Enabled: true
+Performance/ReverseFirst:
+  Enabled: true
+Performance/SortReverse:
+  Enabled: false
+Performance/Squeeze:
+  Enabled: true
+Performance/StringInclude:
+  Enabled: true
+  Exclude:
+    - lib/jekyll/utils/platforms.rb
+Performance/Sum:
+  Enabled: true
+
 Security/MarshalLoad:
   Exclude:
     - !ruby/regexp /test\/.*.rb$/
@@ -123,21 +217,41 @@ Security/YAMLLoad:
     - !ruby/regexp /features\/.*.rb/
     - !ruby/regexp /test\/.*.rb$/
 
+Style/ArgumentsForwarding:
+  Enabled: false
+Style/ArrayCoercion:
+  Enabled: true
 Style/AccessModifierDeclarations:
   Enabled: false
+Style/AccessorGrouping:
+  Enabled: false
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 Style/AndOr:
   Severity: error
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
 Style/ClassAndModuleChildren:
   Exclude:
     - test/**/*.rb
+Style/ClassEqualityComparison:
+  Enabled: true
+Style/CollectionCompact:
+  Enabled: true
+Style/CombinableLoops:
+  Enabled: true
 Style/Documentation:
   Enabled: false
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
 Style/DoubleNegation:
   Enabled: false
 Style/ExponentialNotation:
   Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: false
 Style/FormatStringToken:
   Exclude:
     - lib/jekyll/utils/ansi.rb
@@ -145,10 +259,16 @@ Style/FormatStringToken:
     - lib/jekyll/profiler.rb
 Style/FrozenStringLiteralComment:
   EnforcedStyle: always
+Style/GlobalStdStream:
+  Enabled: true
 Style/GuardClause:
   Enabled: false
+Style/HashAsLastArrayItem:
+  Enabled: true
 Style/HashEachMethods:
   Enabled: true
+Style/HashLikeCase:
+  Enabled: true
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
   Severity: error
@@ -156,6 +276,8 @@ Style/HashTransformKeys:
   Enabled: false
 Style/HashTransformValues:
   Enabled: true
+Style/KeywordParametersOrder:
+  Enabled: true
 Style/MixinUsage:
   Exclude:
     - test/helper.rb
@@ -163,6 +285,12 @@ Style/ModuleFunction:
   Enabled: false
 Style/MultilineTernaryOperator:
   Severity: error
+Style/NegatedIfElseCondition:
+  Enabled: true
+Style/NilLambda:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
 Style/PercentLiteralDelimiters:
   PreferredDelimiters:
     "%q": "{}"
@@ -172,12 +300,22 @@ Style/PercentLiteralDelimiters:
     "%w": "()"
     "%W": "()"
     "%x": "()"
+Style/RedundantArgument:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantBegin:
+  Enabled: false
 Style/RedundantFetchBlock:
   Enabled: false
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
 Style/RedundantRegexpCharacterClass:
   Enabled: true
 Style/RedundantRegexpEscape:
   Enabled: true
+Style/RedundantSelfAssignment:
+  Enabled: true
 Style/RegexpLiteral:
   EnforcedStyle: percent_r
 Style/RescueModifier:
@@ -187,12 +325,23 @@ Style/SafeNavigation:
     - lib/jekyll/document.rb
 Style/SignalException:
   EnforcedStyle: only_raise
+Style/SingleArgumentDig:
+  Enabled: true
 Style/SlicingWithRange:
   Enabled: false
+Style/SoleNestedConditional:
+  Enabled: true
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+Style/StringConcatenation:
+  Enabled: true
+  Exclude:
+    - lib/jekyll/commands/*.rb
+    - test/**/*.rb
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+Style/SwapValues:
+  Enabled: true
 Style/SymbolArray:
   EnforcedStyle: brackets
 Style/TrailingCommaInArrayLiteral:

data/README.markdown

@@ -1,19 +1,15 @@
 # [Jekyll](https://jekyllrb.com/)
 
 [![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
-[![Linux Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg?label=Linux%20build)][travis]
+[![Linux Build Status](https://github.com/jekyll/jekyll/workflows/Continuous%20Integration/badge.svg)][ci-workflow]
 [![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/jekyll/master.svg?label=Windows%20build)][appveyor]
-[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)][codeclimate]
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)][coverage]
 [![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
 [![Backers on Open Collective](https://opencollective.com/jekyll/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/jekyll/sponsors/badge.svg)](#sponsors)
 
 [ruby-gems]: https://rubygems.org/gems/jekyll
-[codeclimate]: https://codeclimate.com/github/jekyll/jekyll
-[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
 [hakiri]: https://hakiri.io/github/jekyll/jekyll/master
-[travis]: https://travis-ci.org/jekyll/jekyll
+[ci-workflow]: https://github.com/jekyll/jekyll/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Amaster
 [appveyor]: https://ci.appveyor.com/project/jekyll/jekyll/branch/master
 
 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](https://pages.github.com), which you can use to host sites right from your GitHub repositories.

data/lib/blank_template/_layouts/default.html

@@ -7,6 +7,6 @@
     <link rel="stylesheet" href="{{ "/assets/css/main.css" | relative_url }}">
   </head>
   <body>
-    {{ content}}
+    {{ content }}
   </body>
 </html>

data/lib/jekyll/cleaner.rb

@@ -44,7 +44,7 @@ module Jekyll
       dirs = keep_dirs
 
       Utils.safe_glob(site.in_dest_dir, ["**", "*"], File::FNM_DOTMATCH).each do |file|
-        next if file =~ HIDDEN_FILE_REGEX || file =~ regex || dirs.include?(file)
+        next if HIDDEN_FILE_REGEX.match?(file) || regex.match?(file) || dirs.include?(file)
 
         files << file
       end

data/lib/jekyll/commands/doctor.rb

@@ -67,15 +67,16 @@ module Jekyll
 
         def conflicting_urls(site)
           conflicting_urls = false
-          urls = {}
-          urls = collect_urls(urls, site.pages, site.dest)
-          urls = collect_urls(urls, site.posts.docs, site.dest)
-          urls.each do |url, paths|
+          destination_map(site).each do |dest, paths|
             next unless paths.size > 1
 
             conflicting_urls = true
-            Jekyll.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
-              " for the following pages: #{paths.join(", ")}"
+            Jekyll.logger.warn "Conflict:",
+                               "The following destination is shared by multiple files."
+            Jekyll.logger.warn "", "The written file may end up with unexpected contents."
+            Jekyll.logger.warn "", dest.to_s.cyan
+            paths.each { |path| Jekyll.logger.warn "", " - #{path}" }
+            Jekyll.logger.warn ""
           end
           conflicting_urls
         end
@@ -84,7 +85,7 @@ module Jekyll
           return true unless Utils::Platforms.osx?
 
           if Dir.pwd != `pwd`.strip
-            Jekyll.logger.error "  " + <<-STR.strip.gsub(%r!\n\s+!, "\n  ")
+            Jekyll.logger.error <<~STR
               We have detected that there might be trouble using fsevent on your
               operating system, you can read https://github.com/thibaudgg/rb-fsevent/wiki/no-fsevents-fired-(OSX-bug)
               for possible work arounds or you can work around it immediately
@@ -122,16 +123,19 @@ module Jekyll
 
         private
 
-        def collect_urls(urls, things, destination)
-          things.each do |thing|
-            dest = thing.destination(destination)
-            if urls[dest]
-              urls[dest] << thing.path
-            else
-              urls[dest] = [thing.path]
+        def destination_map(site)
+          {}.tap do |result|
+            site.each_site_file do |thing|
+              next if allow_used_permalink?(thing)
+
+              dest_path = thing.destination(site.dest)
+              (result[dest_path] ||= []) << thing.path
             end
           end
-          urls
+        end
+
+        def allow_used_permalink?(item)
+          defined?(JekyllRedirectFrom) && item.is_a?(JekyllRedirectFrom::RedirectPage)
         end
 
         def case_insensitive_urls(things, destination)

data/lib/jekyll/commands/new.rb

@@ -99,6 +99,9 @@ module Jekyll
             # Performance-booster for watching directories on Windows
             gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
 
+            # Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+            # do not have a Java counterpart.
+            gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
           RUBY
         end
 

data/lib/jekyll/commands/new_theme.rb

@@ -20,7 +20,6 @@ module Jekyll
           end
         end
 
-        # rubocop:disable Metrics/AbcSize
         def process(args, opts)
           if !args || args.empty?
             raise Jekyll::Errors::InvalidThemeName, "You must specify a theme name."
@@ -35,7 +34,6 @@ module Jekyll
                              " is ready for you in #{theme.path.to_s.cyan}!"
           Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
         end
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/jekyll/configuration.rb

@@ -269,21 +269,18 @@ module Jekyll
 
     private
 
+    STYLE_TO_PERMALINK = {
+      :none     => "/:categories/:title:output_ext",
+      :date     => "/:categories/:year/:month/:day/:title:output_ext",
+      :ordinal  => "/:categories/:year/:y_day/:title:output_ext",
+      :pretty   => "/:categories/:year/:month/:day/:title/",
+      :weekdate => "/:categories/:year/W:week/:short_day/:title:output_ext",
+    }.freeze
+
+    private_constant :STYLE_TO_PERMALINK
+
     def style_to_permalink(permalink_style)
-      case permalink_style.to_sym
-      when :pretty
-        "/:categories/:year/:month/:day/:title/"
-      when :none
-        "/:categories/:title:output_ext"
-      when :date
-        "/:categories/:year/:month/:day/:title:output_ext"
-      when :ordinal
-        "/:categories/:year/:y_day/:title:output_ext"
-      when :weekdate
-        "/:categories/:year/W:week/:short_day/:title:output_ext"
-      else
-        permalink_style.to_s
-      end
+      STYLE_TO_PERMALINK[permalink_style.to_sym] || permalink_style.to_s
     end
 
     def check_include_exclude(config)

data/lib/jekyll/convertible.rb

@@ -35,13 +35,13 @@ module Jekyll
     # Returns nothing.
     # rubocop:disable Metrics/AbcSize
     def read_yaml(base, name, opts = {})
-      filename = File.join(base, name)
+      filename = @path || site.in_source_dir(base, name)
+      Jekyll.logger.debug "Reading:", relative_path
 
       begin
-        self.content = File.read(@path || site.in_source_dir(base, name),
-                                 **Utils.merged_file_read_opts(site, opts))
+        self.content = File.read(filename, **Utils.merged_file_read_opts(site, opts))
         if content =~ Document::YAML_FRONT_MATTER_REGEXP
-          self.content = $POSTMATCH
+          self.content = Regexp.last_match.post_match
           self.data = SafeYAML.load(Regexp.last_match(1))
         end
       rescue Psych::SyntaxError => e
@@ -69,7 +69,7 @@ module Jekyll
     end
 
     def validate_permalink!(filename)
-      if self.data["permalink"]&.to_s&.empty?
+      if self.data["permalink"] == ""
         raise Errors::InvalidPermalinkError, "Invalid permalink in #{filename}"
       end
     end
@@ -117,7 +117,6 @@ module Jekyll
           hsh[attribute] = send(attribute)
         end
 
-      defaults = site.frontmatter_defaults.all(relative_path, type)
       Utils.deep_merge_hashes defaults, Utils.deep_merge_hashes(data, further_data)
     end
 
@@ -247,6 +246,10 @@ module Jekyll
 
     private
 
+    def defaults
+      @defaults ||= site.frontmatter_defaults.all(relative_path, type)
+    end
+
     def no_layout?
       data["layout"] == "none"
     end

data/lib/jekyll/document.rb

@@ -257,14 +257,16 @@ module Jekyll
     #
     # Returns the full path to the output file of this document.
     def destination(base_directory)
-      dest = site.in_dest_dir(base_directory)
-      path = site.in_dest_dir(dest, URL.unescape_path(url))
-      if url.end_with? "/"
-        path = File.join(path, "index.html")
-      else
-        path << output_ext unless path.end_with? output_ext
+      @destination ||= {}
+      @destination[base_directory] ||= begin
+        path = site.in_dest_dir(base_directory, URL.unescape_path(url))
+        if url.end_with? "/"
+          path = File.join(path, "index.html")
+        else
+          path << output_ext unless path.end_with? output_ext
+        end
+        path
       end
-      path
     end
 
     # Write the generated Document file to the destination directory.
@@ -351,9 +353,14 @@ module Jekyll
     # True if the document has a collection and if that collection's #write?
     # method returns true, and if the site's Publisher will publish the document.
     # False otherwise.
+    #
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def write?
-      collection&.write? && site.publisher.publish?(self)
+      return @write_p if defined?(@write_p)
+
+      @write_p = collection&.write? && site.publisher.publish?(self)
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # The Document excerpt_separator, from the YAML Front-Matter or site
     # default excerpt_separator value
@@ -452,7 +459,10 @@ module Jekyll
     def merge_categories!(other)
       if other.key?("categories") && !other["categories"].nil?
         other["categories"] = other["categories"].split if other["categories"].is_a?(String)
-        other["categories"] = (data["categories"] || []) | other["categories"]
+
+        if data["categories"].is_a?(Array)
+          other["categories"] = data["categories"] | other["categories"]
+        end
       end
     end
 
@@ -473,7 +483,7 @@ module Jekyll
     def read_content(**opts)
       self.content = File.read(path, **Utils.merged_file_read_opts(site, opts))
       if content =~ YAML_FRONT_MATTER_REGEXP
-        self.content = $POSTMATCH
+        self.content = Regexp.last_match.post_match
         data_file = SafeYAML.load(Regexp.last_match(1))
         merge_data!(data_file, :source => "YAML front matter") if data_file
       end
@@ -498,7 +508,6 @@ module Jekyll
       end
     end
 
-    # rubocop:disable Metrics/AbcSize
     def populate_title
       if relative_path =~ DATE_FILENAME_MATCHER
         date, slug, ext = Regexp.last_match.captures
@@ -521,7 +530,6 @@ module Jekyll
       data["slug"]  ||= slug
       data["ext"]   ||= ext
     end
-    # rubocop:enable Metrics/AbcSize
 
     def modify_date(date)
       if !data["date"] || data["date"].to_i == site.time.to_i

data/lib/jekyll/drops/collection_drop.rb

@@ -7,10 +7,10 @@ module Jekyll
 
       mutable false
 
-      def_delegator  :@obj, :write?, :output
-      def_delegators :@obj, :label, :docs, :files, :directory, :relative_directory
+      delegate_method_as :write?, :output
+      delegate_methods :label, :docs, :files, :directory, :relative_directory
 
-      private def_delegator :@obj, :metadata, :fallback_data
+      private delegate_method_as :metadata, :fallback_data
 
       def to_s
         docs.to_s

data/lib/jekyll/drops/document_drop.rb

@@ -11,10 +11,11 @@ module Jekyll
 
       mutable false
 
-      def_delegator :@obj, :relative_path, :path
-      def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url, :date
+      delegate_method_as :relative_path, :path
+      private delegate_method_as :data, :fallback_data
 
-      private def_delegator :@obj, :data, :fallback_data
+      delegate_methods :id, :output, :content, :to_s, :relative_path, :url, :date
+      data_delegators "title", "categories", "tags"
 
       def collection
         @obj.collection.label
@@ -64,18 +65,6 @@ module Jekyll
           result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
         end
       end
-
-      def title
-        @obj.data["title"]
-      end
-
-      def categories
-        @obj.data["categories"]
-      end
-
-      def tags
-        @obj.data["tags"]
-      end
     end
   end
 end