jekyll 4.2.2 → 4.3.0

data/lib/jekyll/page.rb

@@ -5,9 +5,7 @@ module Jekyll
     include Convertible
 
     attr_writer :dir
-    attr_accessor :site, :pager
-    attr_accessor :name, :ext, :basename
-    attr_accessor :data, :content, :output
+    attr_accessor :basename, :content, :data, :ext, :name, :output, :pager, :site
 
     alias_method :extname, :ext
 
@@ -144,7 +142,7 @@ module Jekyll
 
     # The path to the page source file, relative to the site source
     def relative_path
-      @relative_path ||= PathManager.join(@dir, @name).sub(%r!\A/!, "")
+      @relative_path ||= PathManager.join(@dir, @name).delete_prefix("/")
     end
 
     # Obtain destination path.

data/lib/jekyll/path_manager.rb

@@ -36,13 +36,13 @@ module Jekyll
       def sanitized_path(base_directory, questionable_path)
         @sanitized_path ||= {}
         @sanitized_path[base_directory] ||= {}
-        @sanitized_path[base_directory][questionable_path] ||= begin
-          if questionable_path.nil?
-            base_directory.freeze
-          else
-            sanitize_and_join(base_directory, questionable_path).freeze
-          end
-        end
+        @sanitized_path[base_directory][questionable_path] ||= if questionable_path.nil?
+                                                                 base_directory.freeze
+                                                               else
+                                                                 sanitize_and_join(
+                                                                   base_directory, questionable_path
+                                                                 ).freeze
+                                                               end
       end
 
       private

data/lib/jekyll/plugin_manager.rb

@@ -46,7 +46,7 @@ module Jekyll
     end
 
     def self.require_from_bundler
-      if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && File.file?("Gemfile")
+      if !ENV["JEKYLL_NO_BUNDLER_REQUIRE"] && gemfile_exists?
         require "bundler"
 
         Bundler.setup
@@ -61,6 +61,13 @@ module Jekyll
       end
     end
 
+    # Check for the existence of a Gemfile.
+    #
+    # Returns true if a Gemfile exists in the places bundler will look
+    def self.gemfile_exists?
+      File.file?("Gemfile") || (ENV["BUNDLE_GEMFILE"] && File.file?(ENV["BUNDLE_GEMFILE"]))
+    end
+
     # Check whether a gem plugin is allowed to be used during this build.
     #
     # plugin_name - the name of the plugin
@@ -106,9 +113,10 @@ module Jekyll
       pagination_included = (site.config["plugins"] || []).include?("jekyll-paginate") ||
         defined?(Jekyll::Paginate)
       if site.config["paginate"] && !pagination_included
-        Jekyll::Deprecator.deprecation_message "You appear to have pagination " \
-          "turned on, but you haven't included the `jekyll-paginate` gem. " \
-          "Ensure you have `plugins: [jekyll-paginate]` in your configuration file."
+        Jekyll::Deprecator.deprecation_message <<~MSG
+          You appear to have pagination turned on, but you haven't included the `jekyll-paginate`
+          gem. Ensure you have `plugins: [jekyll-paginate]` in your configuration file.
+        MSG
       end
     end
   end

data/lib/jekyll/profiler.rb

@@ -14,15 +14,12 @@ module Jekyll
 
       rows   = table_rows.dup
       header = rows.shift
-      footer = rows.pop
       output = +"\n"
 
       table = Terminal::Table.new do |t|
         t << header
         t << :separator
         rows.each { |row| t << row }
-        t << :separator
-        t << footer
         t.style = TERMINAL_TABLE_STYLES
         t.align_column(0, :left)
       end

data/lib/jekyll/reader.rb

@@ -16,9 +16,26 @@ module Jekyll
       read_directories
       read_included_excludes
       sort_files!
-      @site.data = DataReader.new(site).read(site.config["data_dir"])
       CollectionReader.new(site).read
       ThemeAssetsReader.new(site).read
+      read_data
+    end
+
+    # Read and merge the data files.
+    # If a theme is specified and it contains data, it will be read.
+    # Site data will overwrite theme data with the same key using the
+    # semantics of Utils.deep_merge_hashes.
+    #
+    # Returns nothing.
+    def read_data
+      @site.data = DataReader.new(site).read(site.config["data_dir"])
+      return unless site.theme&.data_path
+
+      theme_data = DataReader.new(
+        site,
+        :in_source_dir => site.method(:in_theme_dir)
+      ).read(site.theme.data_path)
+      @site.data = Jekyll::Utils.deep_merge_hashes(theme_data, @site.data)
     end
 
     # Sorts posts, pages, and static files.

data/lib/jekyll/readers/data_reader.rb

@@ -4,11 +4,12 @@ module Jekyll
   class DataReader
     attr_reader :site, :content
 
-    def initialize(site)
+    def initialize(site, in_source_dir: nil)
       @site = site
-      @content = {}
+      @content = DataHash.new
       @entry_filter = EntryFilter.new(site)
-      @source_dir = site.in_source_dir("/")
+      @in_source_dir = in_source_dir || @site.method(:in_source_dir)
+      @source_dir = @in_source_dir.call("/")
     end
 
     # Read all the files in <dir> and adds them to @content
@@ -18,11 +19,13 @@ module Jekyll
     # Returns @content, a Hash of the .yaml, .yml,
     # .json, and .csv files in the base directory
     def read(dir)
-      base = site.in_source_dir(dir)
+      base = @in_source_dir.call(dir)
       read_data_to(base, @content)
       @content
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     # Read and parse all .yaml, .yml, .json, .csv and .tsv
     # files under <dir> and add them to the <data> variable.
     #
@@ -38,17 +41,18 @@ module Jekyll
       end
 
       entries.each do |entry|
-        path = @site.in_source_dir(dir, entry)
+        path = @in_source_dir.call(dir, entry)
         next if @entry_filter.symlink?(path)
 
         if File.directory?(path)
-          read_data_to(path, data[sanitize_filename(entry)] = {})
+          read_data_to(path, data[sanitize_filename(entry)] = DataHash.new)
         else
           key = sanitize_filename(File.basename(entry, ".*"))
-          data[key] = read_data_file(path)
+          data[key] = DataEntry.new(site, path, read_data_file(path))
         end
       end
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Determines how to read a data file.
     #
@@ -58,14 +62,9 @@ module Jekyll
 
       case File.extname(path).downcase
       when ".csv"
-        CSV.read(path,
-                 :headers  => true,
-                 :encoding => site.config["encoding"]).map(&:to_hash)
+        CSV.read(path, **csv_config).map { |row| convert_row(row) }
       when ".tsv"
-        CSV.read(path,
-                 :col_sep  => "\t",
-                 :headers  => true,
-                 :encoding => site.config["encoding"]).map(&:to_hash)
+        CSV.read(path, **tsv_config).map { |row| convert_row(row) }
       else
         SafeYAML.load_file(path)
       end
@@ -75,5 +74,43 @@ module Jekyll
       name.gsub(%r![^\w\s-]+|(?<=^|\b\s)\s+(?=$|\s?\b)!, "")
         .gsub(%r!\s+!, "_")
     end
+
+    private
+
+    # @return [Hash]
+    def csv_config
+      @csv_config ||= read_config("csv_reader")
+    end
+
+    # @return [Hash]
+    def tsv_config
+      @tsv_config ||= read_config("tsv_reader", { :col_sep => "\t" })
+    end
+
+    # @param config_key [String]
+    # @param overrides [Hash]
+    # @return [Hash]
+    # @see https://ruby-doc.org/stdlib-2.5.0/libdoc/csv/rdoc/CSV.html#Converters
+    def read_config(config_key, overrides = {})
+      reader_config = config[config_key] || {}
+
+      defaults = {
+        :converters => reader_config.fetch("csv_converters", []).map(&:to_sym),
+        :headers    => reader_config.fetch("headers", true),
+        :encoding   => reader_config.fetch("encoding", config["encoding"]),
+      }
+
+      defaults.merge(overrides)
+    end
+
+    def config
+      @config ||= site.config
+    end
+
+    # @param row [Array, CSV::Row]
+    # @return [Array, Hash]
+    def convert_row(row)
+      row.instance_of?(CSV::Row) ? row.to_hash : row
+    end
   end
 end

data/lib/jekyll/renderer.rb

@@ -102,15 +102,13 @@ module Jekyll
     # Returns String the converted content.
     def convert(content)
       converters.reduce(content) do |output, converter|
-        begin
-          converter.convert output
-        rescue StandardError => e
-          Jekyll.logger.error "Conversion error:",
-                              "#{converter.class} encountered an error while "\
-                              "converting '#{document.relative_path}':"
-          Jekyll.logger.error("", e.to_s)
-          raise e
-        end
+        converter.convert output
+      rescue StandardError => e
+        Jekyll.logger.error "Conversion error:",
+                            "#{converter.class} encountered an error while " \
+                            "converting '#{document.relative_path}':"
+        Jekyll.logger.error("", e.to_s)
+        raise e
       end
     end
 
@@ -181,7 +179,7 @@ module Jekyll
       return unless invalid_layout?(layout)
 
       Jekyll.logger.warn "Build Warning:", "Layout '#{document.data["layout"]}' requested " \
-        "in #{document.relative_path} does not exist."
+                                           "in #{document.relative_path} does not exist."
     end
 
     # Render layout content into document.output

data/lib/jekyll/site.rb

@@ -2,15 +2,15 @@
 
 module Jekyll
   class Site
-    attr_reader   :source, :dest, :cache_dir, :config
-    attr_accessor :layouts, :pages, :static_files, :drafts, :inclusions,
-                  :exclude, :include, :lsi, :highlighter, :permalink_style,
-                  :time, :future, :unpublished, :safe, :plugins, :limit_posts,
-                  :show_drafts, :keep_files, :baseurl, :data, :file_read_opts,
-                  :gems, :plugin_manager, :theme
+    attr_accessor :baseurl, :converters, :data, :drafts, :exclude,
+                  :file_read_opts, :future, :gems, :generators, :highlighter,
+                  :include, :inclusions, :keep_files, :layouts, :limit_posts,
+                  :lsi, :pages, :permalink_style, :plugin_manager, :plugins,
+                  :reader, :safe, :show_drafts, :static_files, :theme, :time,
+                  :unpublished
 
-    attr_accessor :converters, :generators, :reader
-    attr_reader   :regenerator, :liquid_renderer, :includes_load_paths, :filter_cache, :profiler
+    attr_reader :cache_dir, :config, :dest, :filter_cache, :includes_load_paths,
+                :liquid_renderer, :profiler, :regenerator, :source
 
     # Public: Initialize a new Site.
     #
@@ -304,10 +304,10 @@ module Jekyll
     # klass - The Class of the Converter to fetch.
     def find_converter_instance(klass)
       @find_converter_instance ||= {}
-      @find_converter_instance[klass] ||= begin
-        converters.find { |converter| converter.instance_of?(klass) } || \
-          raise("No Converters found for #{klass}")
-      end
+      @find_converter_instance[klass] ||= converters.find do |converter|
+        converter.instance_of?(klass)
+      end || \
+        raise("No Converters found for #{klass}")
     end
 
     # klass - class or module containing the subclasses.
@@ -328,11 +328,11 @@ module Jekyll
     # Returns
     def relative_permalinks_are_deprecated
       if config["relative_permalinks"]
-        Jekyll.logger.abort_with "Since v3.0, permalinks for pages" \
-                                 " in subfolders must be relative to the" \
-                                 " site source directory, not the parent" \
-                                 " directory. Check https://jekyllrb.com/docs/upgrading/"\
-                                 " for more info."
+        Jekyll.logger.abort_with "Since v3.0, permalinks for pages " \
+                                 "in subfolders must be relative to the " \
+                                 "site source directory, not the parent " \
+                                 "directory. Check https://jekyllrb.com/docs/upgrading/ " \
+                                 "for more info."
       end
     end
 
@@ -343,6 +343,13 @@ module Jekyll
       documents.select(&:write?)
     end
 
+    # Get the to be written static files
+    #
+    # Returns an Array of StaticFiles which should be written
+    def static_files_to_write
+      static_files.select(&:write?)
+    end
+
     # Get all the documents
     #
     # Returns an Array of all Documents
@@ -353,9 +360,13 @@ module Jekyll
     end
 
     def each_site_file
-      %w(pages static_files docs_to_write).each do |type|
+      seen_files = []
+      %w(pages static_files_to_write docs_to_write).each do |type|
         send(type).each do |item|
+          next if seen_files.include?(item)
+
           yield item
+          seen_files << item
         end
       end
     end
@@ -469,7 +480,11 @@ module Jekyll
       theme_config.delete_if { |key, _| Configuration::DEFAULTS.key?(key) }
 
       # Override theme_config with existing config and return the result.
+      # Additionally ensure we return a `Jekyll::Configuration` instance instead of a Hash.
       Utils.deep_merge_hashes(theme_config, config)
+        .each_with_object(Jekyll::Configuration.new) do |(key, value), conf|
+          conf[key] = value
+        end
     end
 
     # Limits the current posts; removes the posts which exceed the limit_posts
@@ -490,10 +505,26 @@ module Jekyll
       @site_cleaner ||= Cleaner.new(self)
     end
 
+    def hide_cache_dir_from_git
+      @cache_gitignore_path ||= in_source_dir(config["cache_dir"], ".gitignore")
+      return if File.exist?(@cache_gitignore_path)
+
+      cache_dir_path = in_source_dir(config["cache_dir"])
+      FileUtils.mkdir_p(cache_dir_path) unless File.directory?(cache_dir_path)
+
+      File.open(@cache_gitignore_path, "wb") do |file|
+        file.puts("# ignore everything in this directory\n*")
+      end
+    end
+
     # Disable Marshaling cache to disk in Safe Mode
     def configure_cache
       Jekyll::Cache.cache_dir = in_source_dir(config["cache_dir"], "Jekyll/Cache")
-      Jekyll::Cache.disable_disk_cache! if safe || config["disable_disk_cache"]
+      if safe || config["disable_disk_cache"]
+        Jekyll::Cache.disable_disk_cache!
+      else
+        hide_cache_dir_from_git
+      end
     end
 
     def configure_plugins
@@ -509,8 +540,8 @@ module Jekyll
         if config["theme"].is_a?(String)
           Jekyll::Theme.new(config["theme"])
         else
-          Jekyll.logger.warn "Theme:", "value of 'theme' in config should be " \
-          "String to use gem-based themes, but got #{config["theme"].class}"
+          Jekyll.logger.warn "Theme:", "value of 'theme' in config should be String to use " \
+                                       "gem-based themes, but got #{config["theme"].class}"
           nil
         end
     end

data/lib/jekyll/static_file.rb

@@ -39,14 +39,11 @@ module Jekyll
 
     # Returns source file path.
     def path
-      @path ||= begin
-        # 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
+      @path ||= 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.
@@ -159,7 +156,7 @@ module Jekyll
 
     # Applies a similar URL-building technique as Jekyll::Document that takes
     # the collection's URL template into account. The default URL template can
-    # be overriden in the collection's configuration in _config.yml.
+    # be overridden in the collection's configuration in _config.yml.
     def url
       @url ||= begin
         base = if @collection.nil?

data/lib/jekyll/tags/highlight.rb

@@ -80,13 +80,17 @@ module Jekyll
 
       def render_rouge(code)
         require "rouge"
-        formatter = ::Rouge::Formatters::HTMLLegacy.new(
-          :line_numbers => @highlight_options[:linenos],
-          :wrap         => false,
-          :css_class    => "highlight",
-          :gutter_class => "gutter",
-          :code_class   => "code"
-        )
+        formatter = ::Rouge::Formatters::HTML.new
+        if @highlight_options[:linenos]
+          formatter = ::Rouge::Formatters::HTMLTable.new(
+            formatter,
+            {
+              :css_class    => "highlight",
+              :gutter_class => "gutter",
+              :code_class   => "code",
+            }
+          )
+        end
         lexer = ::Rouge::Lexer.find_fancy(@lang, code) || Rouge::Lexers::PlainText
         formatter.format(lexer.lex(code))
       end
@@ -100,8 +104,8 @@ module Jekyll
           "class=\"language-#{@lang.to_s.tr("+", "-")}\"",
           "data-lang=\"#{@lang}\"",
         ].join(" ")
-        "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
-        "#{code.chomp}</code></pre></figure>"
+        "<figure class=\"highlight\"><pre><code #{code_attributes}>" \
+          "#{code.chomp}</code></pre></figure>"
       end
     end
   end

data/lib/jekyll/tags/include.rb

@@ -13,7 +13,7 @@ module Jekyll
       !mx.freeze
 
       FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
-      VALID_FILENAME_CHARS = %r!^[\w/.-]+$!.freeze
+      VALID_FILENAME_CHARS = %r!^[\w/.\-()+~\#@]+$!.freeze
       INVALID_SEQUENCES = %r![./]{2,}!.freeze
 
       def initialize(tag_name, markup, tokens)
@@ -179,8 +179,8 @@ module Jekyll
       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 = "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
@@ -265,7 +265,7 @@ module Jekyll
       def resource_path(page, site)
         path = page["path"]
         path = File.join(site.config["collections_dir"], path) if page["collection"]
-        path.sub(%r!/#excerpt\z!, "")
+        path.delete_suffix("/#excerpt")
       end
     end
   end

data/lib/jekyll/tags/post_url.rb

@@ -86,11 +86,11 @@ module Jekyll
         site.posts.docs.each do |document|
           next unless @post.deprecated_equality document
 
-          Jekyll::Deprecator.deprecation_message "A call to "\
-            "'{% post_url #{@post.name} %}' did not match " \
-            "a post using the new matching method of checking name " \
-            "(path-date-slug) equality. Please make sure that you " \
-            "change this tag to match the post's name exactly."
+          Jekyll::Deprecator.deprecation_message(
+            "A call to '{% post_url #{@post.name} %}' did not match a post using the new " \
+            "matching method of checking name (path-date-slug) equality. Please make sure " \
+            "that you change this tag to match the post's name exactly."
+          )
           return relative_url(document)
         end
 

data/lib/jekyll/theme.rb

@@ -18,8 +18,8 @@ module Jekyll
       # Otherwise, Jekyll.sanitized path with prepend the unresolved root
       @root ||= File.realpath(gemspec.full_gem_path)
     rescue Errno::ENOENT, Errno::EACCES, Errno::ELOOP
-      raise "Path #{gemspec.full_gem_path} does not exist, is not accessible "\
-        "or includes a symbolic link loop"
+      raise "Path #{gemspec.full_gem_path} does not exist, is not accessible or includes " \
+            "a symbolic link loop"
     end
 
     # The name of theme directory
@@ -43,6 +43,10 @@ module Jekyll
       @assets_path ||= path_for "assets"
     end
 
+    def data_path
+      @data_path ||= path_for "_data"
+    end
+
     def runtime_dependencies
       gemspec.runtime_dependencies
     end

data/lib/jekyll/theme_builder.rb

@@ -3,7 +3,7 @@
 module Jekyll
   class ThemeBuilder
     SCAFFOLD_DIRECTORIES = %w(
-      assets _layouts _includes _sass
+      assets _data _layouts _includes _sass
     ).freeze
 
     attr_reader :name, :path, :code_of_conduct

data/lib/jekyll/url.rb

@@ -100,7 +100,7 @@ module Jekyll
         winner = pool.find { |key| @placeholders.key?(key) }
         if winner.nil?
           raise NoMethodError,
-                "The URL template doesn't have #{pool.join(" or ")} keys. "\
+                "The URL template doesn't have #{pool.join(" or ")} keys. " \
                 "Check your permalink template!"
         end
 

data/lib/jekyll/utils/ansi.rb

@@ -1,4 +1,4 @@
-# Frozen-string-literal: true
+# frozen_string_literal: true
 
 module Jekyll
   module Utils

data/lib/jekyll/utils/win_tz.rb

@@ -11,64 +11,35 @@ module Jekyll
       # timezone - the IANA Time Zone specified in "_config.yml"
       #
       # Returns a string that ultimately re-defines ENV["TZ"] in Windows
-      def calculate(timezone)
+      def calculate(timezone, now = Time.now)
         External.require_with_graceful_fail("tzinfo") unless defined?(TZInfo)
         tz = TZInfo::Timezone.get(timezone)
-        difference = Time.now.to_i - tz.now.to_i
+
+        #
+        # Use period_for_utc and utc_total_offset instead of
+        # period_for and observed_utc_offset for compatibility with tzinfo v1.
+        offset = tz.period_for_utc(now.getutc).utc_total_offset
+
         #
         # POSIX style definition reverses the offset sign.
         #   e.g. Eastern Standard Time (EST) that is 5Hrs. to the 'west' of Prime Meridian
         #   is denoted as:
         #     EST+5 (or) EST+05:00
-        # Reference: http://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html
-        sign = difference.negative? ? "-" : "+"
-        offset = sign == "-" ? "+" : "-" unless difference.zero?
-        #
-        # convert the difference (in seconds) to hours, as a rational number, and perform
-        # a modulo operation on it.
-        modulo = modulo_of(rational_hour(difference))
+        # Reference: https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html
+        sign = offset.positive? ? "-" : "+"
+
+        rational_hours = offset.abs.to_r / 3600
+        hours = rational_hours.to_i
+        minutes = ((rational_hours - hours) * 60).to_i
+
         #
-        # Format the hour as a two-digit number.
-        # Establish the minutes based on modulo expression.
-        hh = format("%<hour>02d", :hour => absolute_hour(difference).ceil)
-        mm = modulo.zero? ? "00" : "30"
+        # Format the hours and minutes as two-digit numbers.
+        time = format("%<hours>02d:%<minutes>02d", :hours => hours, :minutes => minutes)
 
-        Jekyll.logger.debug "Timezone:", "#{timezone} #{offset}#{hh}:#{mm}"
+        Jekyll.logger.debug "Timezone:", "#{timezone} #{sign}#{time}"
         #
         # Note: The 3-letter-word below doesn't have a particular significance.
-        "WTZ#{sign}#{hh}:#{mm}"
-      end
-
-      private
-
-      # Private: Convert given seconds to an hour as a rational number.
-      #
-      # seconds - supplied as an integer, it is converted to a rational number.
-      # 3600 - no. of seconds in an hour.
-      #
-      # Returns a rational number.
-      def rational_hour(seconds)
-        seconds.to_r / 3600
-      end
-
-      # Private: Convert given seconds to an hour as an absolute number.
-      #
-      # seconds - supplied as an integer, it is converted to its absolute.
-      # 3600 - no. of seconds in an hour.
-      #
-      # Returns an integer.
-      def absolute_hour(seconds)
-        seconds.abs / 3600
-      end
-
-      # Private: Perform a modulo operation on a given fraction.
-      #
-      # fraction - supplied as a rational number, its numerator is divided
-      #            by its denominator and the remainder returned.
-      #
-      # Returns an integer.
-      def modulo_of(fraction)
-        fraction.numerator % fraction.denominator
+        "WTZ#{sign}#{time}"
       end
     end
   end