jekyll 4.2.2 → 4.3.0

data/lib/jekyll/commands/new_theme.rb

@@ -10,8 +10,7 @@ module Jekyll
           prog.command(:"new-theme") do |c|
             c.syntax "new-theme NAME"
             c.description "Creates a new Jekyll theme scaffold"
-            c.option "code_of_conduct", \
-                     "-c", "--code-of-conduct", \
+            c.option "code_of_conduct", "-c", "--code-of-conduct",
                      "Include a Code of Conduct. (defaults to false)"
 
             c.action do |args, opts|
@@ -30,8 +29,8 @@ module Jekyll
           Jekyll.logger.abort_with "Conflict:", "#{theme.path} already exists." if theme.path.exist?
 
           theme.create!
-          Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}," \
-                             " is ready for you in #{theme.path.to_s.cyan}!"
+          Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}, " \
+                             "is ready for you in #{theme.path.to_s.cyan}!"
           Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
         end
       end

data/lib/jekyll/commands/serve/live_reload_reactor.rb

@@ -8,9 +8,7 @@ module Jekyll
   module Commands
     class Serve
       class LiveReloadReactor
-        attr_reader :started_event
-        attr_reader :stopped_event
-        attr_reader :thread
+        attr_reader :started_event, :stopped_event, :thread
 
         def initialize
           @websockets = []
@@ -74,8 +72,7 @@ module Jekyll
               :liveCSS => true
             )
 
-            Jekyll.logger.debug "LiveReload:", "Reloading #{p.url}"
-            Jekyll.logger.debug "", json_message
+            Jekyll.logger.debug "LiveReload:", "Reloading URL #{p.url.inspect}"
             @websockets.each { |ws| ws.send(json_message) }
           end
         end
@@ -113,7 +110,7 @@ module Jekyll
 
         def log_error(error)
           Jekyll.logger.error "LiveReload experienced an error. " \
-            "Run with --trace for more information."
+                              "Run with --trace for more information."
           raise error
         end
       end

data/lib/jekyll/commands/serve/mime_types_charset.json

@@ -0,0 +1,71 @@
+{
+  "application/javascript": "UTF-8",
+  "application/json": "UTF-8",
+  "application/manifest+json": "UTF-8",
+  "application/vnd.syncml+xml": "UTF-8",
+  "application/vnd.syncml.dm+wbxml": "UTF-8",
+  "application/vnd.syncml.dm+xml": "UTF-8",
+  "application/vnd.syncml.dmddf+xml": "UTF-8",
+  "application/vnd.wap.wbxml": "UTF-8",
+  "text/cache-manifest": "UTF-8",
+  "text/calendar": "UTF-8",
+  "text/coffeescript": "UTF-8",
+  "text/css": "UTF-8",
+  "text/csv": "UTF-8",
+  "text/html": "UTF-8",
+  "text/jade": "UTF-8",
+  "text/jsx": "UTF-8",
+  "text/less": "UTF-8",
+  "text/markdown": "UTF-8",
+  "text/mathml": "UTF-8",
+  "text/mdx": "UTF-8",
+  "text/n3": "UTF-8",
+  "text/plain": "UTF-8",
+  "text/prs.lines.tag": "UTF-8",
+  "text/richtext": "UTF-8",
+  "text/sgml": "UTF-8",
+  "text/shex": "UTF-8",
+  "text/slim": "UTF-8",
+  "text/spdx": "UTF-8",
+  "text/stylus": "UTF-8",
+  "text/tab-separated-values": "UTF-8",
+  "text/troff": "UTF-8",
+  "text/turtle": "UTF-8",
+  "text/uri-list": "UTF-8",
+  "text/vcard": "UTF-8",
+  "text/vnd.curl": "UTF-8",
+  "text/vnd.curl.dcurl": "UTF-8",
+  "text/vnd.curl.mcurl": "UTF-8",
+  "text/vnd.curl.scurl": "UTF-8",
+  "text/vnd.familysearch.gedcom": "UTF-8",
+  "text/vnd.fly": "UTF-8",
+  "text/vnd.fmi.flexstor": "UTF-8",
+  "text/vnd.graphviz": "UTF-8",
+  "text/vnd.in3d.3dml": "UTF-8",
+  "text/vnd.in3d.spot": "UTF-8",
+  "text/vnd.sun.j2me.app-descriptor": "UTF-8",
+  "text/vnd.wap.wml": "UTF-8",
+  "text/vnd.wap.wmlscript": "UTF-8",
+  "text/vtt": "UTF-8",
+  "text/x-asm": "UTF-8",
+  "text/x-c": "UTF-8",
+  "text/x-component": "UTF-8",
+  "text/x-fortran": "UTF-8",
+  "text/x-handlebars-template": "UTF-8",
+  "text/x-java-source": "UTF-8",
+  "text/x-lua": "UTF-8",
+  "text/x-markdown": "UTF-8",
+  "text/x-nfo": "UTF-8",
+  "text/x-opml": "UTF-8",
+  "text/x-pascal": "UTF-8",
+  "text/x-processing": "UTF-8",
+  "text/x-sass": "UTF-8",
+  "text/x-scss": "UTF-8",
+  "text/x-setext": "UTF-8",
+  "text/x-sfv": "UTF-8",
+  "text/x-suse-ymp": "UTF-8",
+  "text/x-uuencode": "UTF-8",
+  "text/x-vcalendar": "UTF-8",
+  "text/x-vcard": "UTF-8",
+  "text/yaml": "UTF-8"
+}

data/lib/jekyll/commands/serve/servlet.rb

@@ -101,7 +101,7 @@ module Jekyll
           @template ||= ERB.new(<<~TEMPLATE)
             <script>
               document.write(
-                '<script src="http://' +
+                '<script src="' + location.protocol + '//' +
                 (location.host || 'localhost').split(':')[0] +
                 ':<%=@options["livereload_port"] %>/livereload.js?snipver=1<%= livereload_args %>"' +
                 '></' +
@@ -128,12 +128,13 @@ module Jekyll
       class Servlet < WEBrick::HTTPServlet::FileHandler
         DEFAULTS = {
           "Cache-Control" => "private, max-age=0, proxy-revalidate, " \
-            "no-store, no-cache, must-revalidate",
+                             "no-store, no-cache, must-revalidate",
         }.freeze
 
         def initialize(server, root, callbacks)
           # So we can access them easily.
           @jekyll_opts = server.config[:JekyllOptions]
+          @mime_types_charset = server.config[:MimeTypesCharset]
           set_defaults
           super
         end
@@ -173,7 +174,7 @@ module Jekyll
             end
           end
 
-          validate_and_ensure_charset(req, res)
+          conditionally_inject_charset(res)
           res.header.merge!(@headers)
           rtn
         end
@@ -181,13 +182,16 @@ module Jekyll
 
         private
 
-        def validate_and_ensure_charset(_req, res)
-          key = res.header.keys.grep(%r!content-type!i).first
-          typ = res.header[key]
+        # Inject charset based on Jekyll config only if our mime-types database contains
+        # the charset metadata.
+        #
+        # Refer `script/vendor-mimes` in the repository for further details.
+        def conditionally_inject_charset(res)
+          typ = res.header["content-type"]
+          return unless @mime_types_charset.key?(typ)
+          return if %r!;\s*charset=!.match?(typ)
 
-          unless %r!;\s*charset=!.match?(typ)
-            res.header[key] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
-          end
+          res.header["content-type"] = "#{typ}; charset=#{@jekyll_opts["encoding"]}"
         end
 
         def set_defaults

data/lib/jekyll/commands/serve.rb

@@ -21,11 +21,11 @@ module Jekyll
           "ssl_key"              => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
           "port"                 => ["-P", "--port [PORT]", "Port to listen on"],
           "show_dir_listing"     => ["--show-dir-listing",
-                                     "Show a directory listing instead of loading" \
-                                     " your index file.",],
+                                     "Show a directory listing instead of loading " \
+                                     "your index file.",],
           "skip_initial_build"   => ["skip_initial_build", "--skip-initial-build",
-                                     "Skips the initial site build which occurs before" \
-                                     " the server is started.",],
+                                     "Skips the initial site build which occurs before " \
+                                     "the server is started.",],
           "livereload"           => ["-l", "--livereload",
                                      "Use LiveReload to automatically refresh browsers",],
           "livereload_ignore"    => ["--livereload-ignore ignore GLOB1[,GLOB2[,...]]",
@@ -113,8 +113,8 @@ module Jekyll
         def validate_options(opts)
           if opts["livereload"]
             if opts["detach"]
-              Jekyll.logger.warn "Warning:", "--detach and --livereload are mutually exclusive." \
-                                 " Choosing --livereload"
+              Jekyll.logger.warn "Warning:", "--detach and --livereload are mutually exclusive. " \
+                                             "Choosing --livereload"
               opts["detach"] = false
             end
             if opts["ssl_cert"] || opts["ssl_key"]
@@ -132,9 +132,9 @@ module Jekyll
                    livereload_max_delay
                    livereload_ignore
                    livereload_port).any? { |o| opts[o] }
-            Jekyll.logger.abort_with "--livereload-min-delay, "\
-               "--livereload-max-delay, --livereload-ignore, and "\
-               "--livereload-port require the --livereload option."
+            Jekyll.logger.abort_with "--livereload-min-delay, --livereload-max-delay, " \
+                                     "--livereload-ignore, and --livereload-port require " \
+                                     "the --livereload option."
           end
         end
 
@@ -144,9 +144,9 @@ module Jekyll
           @reload_reactor = LiveReloadReactor.new
 
           Jekyll::Hooks.register(:site, :post_render) do |site|
-            regenerator = Jekyll::Regenerator.new(site)
-            @changed_pages = site.pages.select do |p|
-              regenerator.regenerate?(p)
+            @changed_pages = []
+            site.each_site_file do |item|
+              @changed_pages << item if site.regenerator.regenerate?(item)
             end
           end
 
@@ -174,7 +174,8 @@ module Jekyll
         # Do a base pre-setup of WEBRick so that everything is in place
         # when we get ready to party, checking for an setting up an error page
         # and making sure our destination exists.
-
+        #
+        # rubocop:disable Security/IoMethods
         def setup(destination)
           require_relative "serve/servlet"
 
@@ -188,12 +189,14 @@ module Jekyll
             end
           end
         end
+        # rubocop:enable Security/IoMethods
 
         def webrick_opts(opts)
           opts = {
             :JekyllOptions      => opts,
             :DoNotReverseLookup => true,
             :MimeTypes          => mime_types,
+            :MimeTypesCharset   => mime_types_charset,
             :DocumentRoot       => opts["destination"],
             :StartCallback      => start_callback(opts["detach"]),
             :StopCallback       => stop_callback(opts["detach"]),
@@ -262,8 +265,7 @@ module Jekyll
           return system "xdg-open", address if Utils::Platforms.linux?
           return system "open", address if Utils::Platforms.osx?
 
-          Jekyll.logger.error "Refusing to launch browser; " \
-            "Platform launcher unknown."
+          Jekyll.logger.error "Refusing to launch browser. Platform launcher unknown."
         end
 
         # Keep in our area with a thread or detach the server as requested
@@ -276,9 +278,8 @@ module Jekyll
             end
 
             Process.detach(pid)
-            Jekyll.logger.info "Server detached with pid '#{pid}'.", \
-                               "Run `pkill -f jekyll' or `kill -9 #{pid}'" \
-                               " to stop the server."
+            Jekyll.logger.info "Server detached with pid '#{pid}'.",
+                               "Run `pkill -f jekyll' or `kill -9 #{pid}' to stop the server."
           else
             t = Thread.new { server.start }
             trap("INT") { server.shutdown }
@@ -353,6 +354,10 @@ module Jekyll
           WEBrick::HTTPUtils.load_mime_types(file)
         end
 
+        def mime_types_charset
+          SafeYAML.load_file(File.expand_path("serve/mime_types_charset.json", __dir__))
+        end
+
         def read_file(source_dir, file_path)
           File.read(Jekyll.sanitized_path(source_dir, file_path))
         end

data/lib/jekyll/configuration.rb

@@ -304,8 +304,8 @@ module Jekyll
       return if config["plugins"].is_a?(Array)
 
       Jekyll.logger.error "'plugins' should be set as an array of gem-names, but was: " \
-        "#{config["plugins"].inspect}. Use 'plugins_dir' instead to set the directory " \
-        "for your non-gemified Ruby plugins."
+                          "#{config["plugins"].inspect}. Use 'plugins_dir' instead to set " \
+                          "the directory for your non-gemified Ruby plugins."
       raise Jekyll::Errors::InvalidConfigurationError,
             "'plugins' should be set as an array, but was: #{config["plugins"].inspect}."
     end

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

@@ -1,4 +1,4 @@
-# Frozen-string-literal: true
+# frozen_string_literal: true
 
 module Kramdown
   # A Kramdown::Document subclass meant to optimize memory usage from initializing
@@ -125,14 +125,14 @@ module Jekyll
             Jekyll::External.require_with_graceful_fail("kramdown-syntax-coderay")
           end
 
-          # `mathjax` emgine is bundled within kramdown-2.x and will be handled by
+          # `mathjax` engine is bundled within kramdown-2.x and will be handled by
           # kramdown itself.
           if (math_engine = @config["math_engine"]) && math_engine != "mathjax"
             Jekyll::External.require_with_graceful_fail("kramdown-math-#{math_engine}")
           end
         end
 
-        # config[kramdown][syntax_higlighter] >
+        # config[kramdown][syntax_highlighter] >
         #   config[kramdown][enable_coderay] >
         #   config[highlighter]
         # Where `enable_coderay` is now deprecated because Kramdown
@@ -146,23 +146,21 @@ module Jekyll
             ]
           end
 
-          @highlighter = begin
-            if @config.key?("enable_coderay") && @config["enable_coderay"]
-              Jekyll::Deprecator.deprecation_message(
-                "You are using 'enable_coderay', " \
-                "use syntax_highlighter: coderay in your configuration file."
-              )
+          @highlighter = if @config.key?("enable_coderay") && @config["enable_coderay"]
+                           Jekyll::Deprecator.deprecation_message(
+                             "You are using 'enable_coderay', " \
+                             "use syntax_highlighter: coderay in your configuration file."
+                           )
 
-              "coderay"
-            else
-              @main_fallback_highlighter
-            end
-          end
+                           "coderay"
+                         else
+                           @main_fallback_highlighter
+                         end
         end
 
         def strip_coderay_prefix(hash)
           hash.each_with_object({}) do |(key, val), hsh|
-            cleaned_key = key.to_s.gsub(%r!\Acoderay_!, "")
+            cleaned_key = key.to_s.delete_prefix("coderay_")
 
             if key != cleaned_key
               Jekyll::Deprecator.deprecation_message(

data/lib/jekyll/data_entry.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Jekyll
+  class DataEntry
+    attr_accessor :context
+    attr_reader :data
+
+    # Create a Jekyll wrapper for given parsed data object.
+    #
+    #        site - The current Jekyll::Site instance.
+    #    abs_path - Absolute path to the data source file.
+    # parsed_data - Parsed representation of data source file contents.
+    #
+    # Returns nothing.
+    def initialize(site, abs_path, parsed_data)
+      @site = site
+      @path = abs_path
+      @data = parsed_data
+    end
+
+    # Liquid representation of current instance is the parsed data object.
+    #
+    # Mark as a dependency for regeneration here since every renderable object primarily uses the
+    # parsed data object while the parent resource is being rendered by Liquid. Accessing the data
+    # object directly via Ruby interface `#[]()` is outside the scope of regeneration.
+    #
+    # FIXME: Marking as dependency on every call is non-ideal. Optimize at later day.
+    #
+    # Returns the parsed data object.
+    def to_liquid
+      add_regenerator_dependencies if incremental_build?
+      @data
+    end
+
+    # -- Overrides to maintain backwards compatibility --
+
+    # Any missing method will be forwarded to the underlying data object stored in the instance
+    # variable `@data`.
+    def method_missing(method, *args, &block)
+      @data.respond_to?(method) ? @data.send(method, *args, &block) : super
+    end
+
+    def respond_to_missing?(method, *)
+      @data.respond_to?(method) || super
+    end
+
+    def <=>(other)
+      data <=> (other.is_a?(self.class) ? other.data : other)
+    end
+
+    def ==(other)
+      data == (other.is_a?(self.class) ? other.data : other)
+    end
+
+    # Explicitly defined to bypass re-routing from `method_missing` hook for greater performance.
+    #
+    # Returns string representation of parsed data object.
+    def inspect
+      @data.inspect
+    end
+
+    private
+
+    def incremental_build?
+      @incremental = @site.config["incremental"] if @incremental.nil?
+      @incremental
+    end
+
+    def add_regenerator_dependencies
+      page = context.registers[:page]
+      return unless page&.key?("path")
+
+      absolute_path = \
+        if page["collection"]
+          @site.in_source_dir(@site.config["collections_dir"], page["path"])
+        else
+          @site.in_source_dir(page["path"])
+        end
+
+      @site.regenerator.add_dependency(absolute_path, @path)
+    end
+  end
+end

data/lib/jekyll/data_hash.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jekyll
+  # A class that behaves very similar to Ruby's `Hash` class yet different in how it is handled by
+  # Liquid. This class emulates Hash by delegation instead of inheritance to minimize overridden
+  # methods especially since some Hash methods returns another Hash instance instead of the
+  # subclass instance.
+  class DataHash
+    #
+    # Delegate given (zero-arity) method(s) to the Hash object stored in instance variable
+    # `@registry`.
+    # NOTE: Avoiding the use of `Forwardable` module's `def_delegators` for preventing unnecessary
+    # creation of interim objects on multiple calls.
+    def self.delegate_to_registry(*symbols)
+      symbols.each { |sym| define_method(sym) { @registry.send(sym) } }
+    end
+    private_class_method :delegate_to_registry
+
+    # -- core instance methods --
+
+    attr_accessor :context
+
+    def initialize
+      @registry = {}
+    end
+
+    def [](key)
+      @registry[key].tap do |value|
+        value.context = context if value.respond_to?(:context=)
+      end
+    end
+
+    # `Hash#to_liquid` returns the Hash instance itself.
+    # Mimic that behavior by returning `self` instead of returning the `@registry` variable value.
+    def to_liquid
+      self
+    end
+
+    # -- supplementary instance methods to emulate Hash --
+
+    delegate_to_registry :freeze, :inspect
+
+    def merge(other, &block)
+      merged_registry = @registry.merge(other, &block)
+      dup.tap { |d| d.instance_variable_set(:@registry, merged_registry) }
+    end
+
+    def merge!(other, &block)
+      @registry.merge!(other, &block)
+      self
+    end
+
+    def method_missing(method, *args, &block)
+      @registry.send(method, *args, &block)
+    end
+
+    def respond_to_missing?(method, *)
+      @registry.respond_to?(method)
+    end
+  end
+end

data/lib/jekyll/deprecator.rb

@@ -15,7 +15,7 @@ module Jekyll
                           '--watch'."
       arg_is_present? args, "--no-auto", "To disable auto-replication, simply leave off \
                           the '--watch' switch."
-      arg_is_present? args, "--pygments", "The 'pygments'settings has been removed in \
+      arg_is_present? args, "--pygments", "The 'pygments' settings has been removed in \
                           favour of 'highlighter'."
       arg_is_present? args, "--paginate", "The 'paginate' setting can only be set in \
                           your config files."

data/lib/jekyll/document.rb

@@ -406,9 +406,8 @@ module Jekyll
     # Override of method_missing to check in @data for the key.
     def method_missing(method, *args, &blck)
       if data.key?(method.to_s)
-        Jekyll::Deprecator.deprecation_message "Document##{method} is now a key "\
-                           "in the #data hash."
-        Jekyll::Deprecator.deprecation_message "Called by #{caller(0..0)}."
+        Jekyll::Deprecator.deprecation_message "Document##{method} is now a key in the #data hash."
+        Jekyll.logger.warn "", "Called by #{caller(1..1)[0]}."
         data[method.to_s]
       else
         super

data/lib/jekyll/drops/document_drop.rb

@@ -12,6 +12,7 @@ module Jekyll
       mutable false
 
       delegate_method_as :relative_path, :path
+      delegate_method_as :basename, :name
       private delegate_method_as :data, :fallback_data
 
       delegate_methods :id, :output, :content, :to_s, :relative_path, :url, :date

data/lib/jekyll/drops/excerpt_drop.rb

@@ -14,6 +14,10 @@ module Jekyll
       def excerpt
         nil
       end
+
+      def name
+        @obj.doc.basename
+      end
     end
   end
 end

data/lib/jekyll/drops/site_drop.rb

@@ -7,7 +7,6 @@ module Jekyll
 
       mutable false
 
-      delegate_method_as :site_data, :data
       delegate_methods :time, :pages, :static_files, :tags, :categories
 
       private delegate_method_as :config, :fallback_data
@@ -24,6 +23,12 @@ module Jekyll
         (key != "posts" && @obj.collections.key?(key)) || super
       end
 
+      def data
+        @obj.site_data.tap do |value|
+          value.context = @context if value.respond_to?(:context=)
+        end
+      end
+
       def posts
         @site_posts ||= @obj.posts.docs.sort { |a, b| b <=> a }
       end

data/lib/jekyll/drops/theme_drop.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Drops
+    class ThemeDrop < Drop
+      delegate_methods   :root
+      delegate_method_as :runtime_dependencies, :dependencies
+
+      def authors
+        @authors ||= gemspec.authors.join(", ")
+      end
+
+      def version
+        @version ||= gemspec.version.to_s
+      end
+
+      def description
+        @description ||= gemspec.description || gemspec.summary
+      end
+
+      def metadata
+        @metadata ||= gemspec.metadata
+      end
+
+      private
+
+      def gemspec
+        @gemspec ||= @obj.send(:gemspec)
+      end
+
+      def fallback_data
+        @fallback_data ||= {}
+      end
+    end
+  end
+end

data/lib/jekyll/drops/unified_payload_drop.rb

@@ -5,8 +5,8 @@ module Jekyll
     class UnifiedPayloadDrop < Drop
       mutable true
 
-      attr_accessor :page, :layout, :content, :paginator
-      attr_accessor :highlighter_prefix, :highlighter_suffix
+      attr_accessor :content, :page, :layout, :paginator,
+                    :highlighter_prefix, :highlighter_suffix
 
       def jekyll
         JekyllDrop.global
@@ -16,6 +16,10 @@ module Jekyll
         @site_drop ||= SiteDrop.new(@obj)
       end
 
+      def theme
+        @theme_drop ||= ThemeDrop.new(@obj.theme) if @obj.theme
+      end
+
       private
 
       def fallback_data

data/lib/jekyll/entry_filter.rb

@@ -86,14 +86,10 @@ module Jekyll
     end
 
     # --
-    # NOTE: Pathutil#in_path? gets the realpath.
-    # @param [<Anything>] entry the entry you want to validate.
-    # Check if a path is outside of our given root.
+    # Check if given path is outside of current site's configured source directory.
     # --
     def symlink_outside_site_source?(entry)
-      !Pathutil.new(entry).in_path?(
-        site.in_source_dir
-      )
+      !File.realpath(entry).start_with?(site.in_source_dir)
     end
 
     # Check if an entry matches a specific pattern.