jekyll 4.0.1 → 4.2.1

data/lib/jekyll/converter.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-
-module Jekyll
-  class Converter < Plugin
-    # Public: Get or set the highlighter prefix. When an argument is specified,
-    # the prefix will be set. If no argument is specified, the current prefix
-    # will be returned.
-    #
-    # highlighter_prefix - The String prefix (default: nil).
-    #
-    # Returns the String prefix.
-    def self.highlighter_prefix(highlighter_prefix = nil)
-      unless defined?(@highlighter_prefix) && highlighter_prefix.nil?
-        @highlighter_prefix = highlighter_prefix
-      end
-      @highlighter_prefix
-    end
-
-    # Public: Get or set the highlighter suffix. When an argument is specified,
-    # the suffix will be set. If no argument is specified, the current suffix
-    # will be returned.
-    #
-    # highlighter_suffix - The String suffix (default: nil).
-    #
-    # Returns the String suffix.
-    def self.highlighter_suffix(highlighter_suffix = nil)
-      unless defined?(@highlighter_suffix) && highlighter_suffix.nil?
-        @highlighter_suffix = highlighter_suffix
-      end
-      @highlighter_suffix
-    end
-
-    # Initialize the converter.
-    #
-    # Returns an initialized Converter.
-    def initialize(config = {})
-      @config = config
-    end
-
-    # Get the highlighter prefix.
-    #
-    # Returns the String prefix.
-    def highlighter_prefix
-      self.class.highlighter_prefix
-    end
-
-    # Get the highlighter suffix.
-    #
-    # Returns the String suffix.
-    def highlighter_suffix
-      self.class.highlighter_suffix
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  class Converter < Plugin
+    # Public: Get or set the highlighter prefix. When an argument is specified,
+    # the prefix will be set. If no argument is specified, the current prefix
+    # will be returned.
+    #
+    # highlighter_prefix - The String prefix (default: nil).
+    #
+    # Returns the String prefix.
+    def self.highlighter_prefix(highlighter_prefix = nil)
+      unless defined?(@highlighter_prefix) && highlighter_prefix.nil?
+        @highlighter_prefix = highlighter_prefix
+      end
+      @highlighter_prefix
+    end
+
+    # Public: Get or set the highlighter suffix. When an argument is specified,
+    # the suffix will be set. If no argument is specified, the current suffix
+    # will be returned.
+    #
+    # highlighter_suffix - The String suffix (default: nil).
+    #
+    # Returns the String suffix.
+    def self.highlighter_suffix(highlighter_suffix = nil)
+      unless defined?(@highlighter_suffix) && highlighter_suffix.nil?
+        @highlighter_suffix = highlighter_suffix
+      end
+      @highlighter_suffix
+    end
+
+    # Initialize the converter.
+    #
+    # Returns an initialized Converter.
+    def initialize(config = {})
+      @config = config
+    end
+
+    # Get the highlighter prefix.
+    #
+    # Returns the String prefix.
+    def highlighter_prefix
+      self.class.highlighter_prefix
+    end
+
+    # Get the highlighter suffix.
+    #
+    # Returns the String suffix.
+    def highlighter_suffix
+      self.class.highlighter_suffix
+    end
+  end
+end

data/lib/jekyll/converters/identity.rb

@@ -1,41 +1,41 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Converters
-    # Identify converter. Returns same content as given.
-    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
-    class Identity < Converter
-      safe true
-
-      priority :lowest
-
-      # Public: Does the given extension match this converter's list of acceptable extensions?
-      # Takes one argument: the file's extension (including the dot).
-      #
-      # ext - The String extension to check (not relevant here)
-      #
-      # Returns true since it always matches.
-      def matches(_ext)
-        true
-      end
-
-      # Public: The extension to be given to the output file (including the dot).
-      #
-      # ext - The String extension or original file.
-      #
-      # Returns The String output file extension.
-      def output_ext(ext)
-        ext
-      end
-
-      # Logic to do the content conversion.
-      #
-      # content - String content of file (without front matter).
-      #
-      # Returns a String of the converted content.
-      def convert(content)
-        content
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Jekyll
+  module Converters
+    # Identity converter. Returns same content as given.
+    # For more info on converters see https://jekyllrb.com/docs/plugins/converters/
+    class Identity < Converter
+      safe true
+
+      priority :lowest
+
+      # Public: Does the given extension match this converter's list of acceptable extensions?
+      # Takes one argument: the file's extension (including the dot).
+      #
+      # _ext - The String extension to check (not relevant here)
+      #
+      # Returns true since it always matches.
+      def matches(_ext)
+        true
+      end
+
+      # Public: The extension to be given to the output file (including the dot).
+      #
+      # ext - The String extension or original file.
+      #
+      # Returns The String output file extension.
+      def output_ext(ext)
+        ext
+      end
+
+      # Logic to do the content conversion.
+      #
+      # content - String content of file (without front matter).
+      #
+      # Returns a String of the converted content.
+      def convert(content)
+        content
+      end
+    end
+  end
+end

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

@@ -1,130 +1,199 @@
-# Frozen-string-literal: true
-
-module Jekyll
-  module Converters
-    class Markdown
-      class KramdownParser
-        CODERAY_DEFAULTS = {
-          "css"               => "style",
-          "bold_every"        => 10,
-          "line_numbers"      => "inline",
-          "line_number_start" => 1,
-          "tab_width"         => 4,
-          "wrap"              => "div",
-        }.freeze
-
-        def initialize(config)
-          @main_fallback_highlighter = config["highlighter"] || "rouge"
-          @config = config["kramdown"] || {}
-          @highlighter = nil
-          setup
-          load_dependencies
-        end
-
-        # Setup and normalize the configuration:
-        #   * Create Kramdown if it doesn't exist.
-        #   * Set syntax_highlighter, detecting enable_coderay and merging
-        #       highlighter if none.
-        #   * Merge kramdown[coderay] into syntax_highlighter_opts stripping coderay_.
-        #   * Make sure `syntax_highlighter_opts` exists.
-
-        def setup
-          @config["syntax_highlighter"] ||= highlighter
-          @config["syntax_highlighter_opts"] ||= {}
-          @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
-          @config["coderay"] ||= {} # XXX: Legacy.
-          modernize_coderay_config
-        end
-
-        def convert(content)
-          document = Kramdown::Document.new(content, @config)
-          html_output = document.to_html
-          if @config["show_warnings"]
-            document.warnings.each do |warning|
-              Jekyll.logger.warn "Kramdown warning:", warning
-            end
-          end
-          html_output
-        end
-
-        private
-
-        def load_dependencies
-          require "kramdown-parser-gfm" if @config["input"] == "GFM"
-
-          if highlighter == "coderay"
-            Jekyll::External.require_with_graceful_fail("kramdown-syntax-coderay")
-          end
-
-          # `mathjax` emgine 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][enable_coderay] >
-        #   config[highlighter]
-        # Where `enable_coderay` is now deprecated because Kramdown
-        # supports Rouge now too.
-        def highlighter
-          return @highlighter if @highlighter
-
-          if @config["syntax_highlighter"]
-            return @highlighter = @config[
-              "syntax_highlighter"
-            ]
-          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."
-              )
-
-              "coderay"
-            else
-              @main_fallback_highlighter
-            end
-          end
-        end
-
-        def strip_coderay_prefix(hash)
-          hash.each_with_object({}) do |(key, val), hsh|
-            cleaned_key = key.to_s.gsub(%r!\Acoderay_!, "")
-
-            if key != cleaned_key
-              Jekyll::Deprecator.deprecation_message(
-                "You are using '#{key}'. Normalizing to #{cleaned_key}."
-              )
-            end
-
-            hsh[cleaned_key] = val
-          end
-        end
-
-        # If our highlighter is CodeRay we go in to merge the CodeRay defaults
-        # with your "coderay" key if it's there, deprecating it in the
-        # process of you using it.
-        def modernize_coderay_config
-          unless @config["coderay"].empty?
-            Jekyll::Deprecator.deprecation_message(
-              "You are using 'kramdown.coderay' in your configuration, " \
-              "please use 'syntax_highlighter_opts' instead."
-            )
-
-            @config["syntax_highlighter_opts"] = begin
-              strip_coderay_prefix(
-                @config["syntax_highlighter_opts"] \
-                  .merge(CODERAY_DEFAULTS) \
-                  .merge(@config["coderay"])
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# Frozen-string-literal: true
+
+module Kramdown
+  # A Kramdown::Document subclass meant to optimize memory usage from initializing
+  # a kramdown document for parsing.
+  #
+  # The optimization is by using the same options Hash (and its derivatives) for
+  # converting all Markdown documents in a Jekyll site.
+  class JekyllDocument < Document
+    class << self
+      attr_reader :options, :parser
+
+      # The implementation is basically the core logic in +Kramdown::Document#initialize+
+      #
+      # rubocop:disable Naming/MemoizedInstanceVariableName
+      def setup(options)
+        @cache ||= {}
+
+        # reset variables on a subsequent set up with a different options Hash
+        unless @cache[:id] == options.hash
+          @options = @parser = nil
+          @cache[:id] = options.hash
+        end
+
+        @options ||= Options.merge(options).freeze
+        @parser  ||= begin
+          parser_name = (@options[:input] || "kramdown").to_s
+          parser_name = parser_name[0..0].upcase + parser_name[1..-1]
+          try_require("parser", parser_name)
+
+          if Parser.const_defined?(parser_name)
+            Parser.const_get(parser_name)
+          else
+            raise Kramdown::Error, "kramdown has no parser to handle the specified " \
+                                   "input format: #{@options[:input]}"
+          end
+        end
+      end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
+
+      private
+
+      def try_require(type, name)
+        require "kramdown/#{type}/#{Utils.snake_case(name)}"
+      rescue LoadError
+        false
+      end
+    end
+
+    def initialize(source, options = {})
+      JekyllDocument.setup(options)
+
+      @options = JekyllDocument.options
+      @root, @warnings = JekyllDocument.parser.parse(source, @options)
+    end
+
+    # Use Kramdown::Converter::Html class to convert this document into HTML.
+    #
+    # The implementation is basically an optimized version of core logic in
+    # +Kramdown::Document#method_missing+ from kramdown-2.1.0.
+    def to_html
+      output, warnings = Kramdown::Converter::Html.convert(@root, @options)
+      @warnings.concat(warnings)
+      output
+    end
+  end
+end
+
+#
+
+module Jekyll
+  module Converters
+    class Markdown
+      class KramdownParser
+        CODERAY_DEFAULTS = {
+          "css"               => "style",
+          "bold_every"        => 10,
+          "line_numbers"      => "inline",
+          "line_number_start" => 1,
+          "tab_width"         => 4,
+          "wrap"              => "div",
+        }.freeze
+
+        def initialize(config)
+          @main_fallback_highlighter = config["highlighter"] || "rouge"
+          @config = config["kramdown"] || {}
+          @highlighter = nil
+          setup
+          load_dependencies
+        end
+
+        # Setup and normalize the configuration:
+        #   * Create Kramdown if it doesn't exist.
+        #   * Set syntax_highlighter, detecting enable_coderay and merging
+        #       highlighter if none.
+        #   * Merge kramdown[coderay] into syntax_highlighter_opts stripping coderay_.
+        #   * Make sure `syntax_highlighter_opts` exists.
+
+        def setup
+          @config["syntax_highlighter"] ||= highlighter
+          @config["syntax_highlighter_opts"] ||= {}
+          @config["syntax_highlighter_opts"]["default_lang"] ||= "plaintext"
+          @config["syntax_highlighter_opts"]["guess_lang"] = @config["guess_lang"]
+          @config["coderay"] ||= {} # XXX: Legacy.
+          modernize_coderay_config
+        end
+
+        def convert(content)
+          document = Kramdown::JekyllDocument.new(content, @config)
+          html_output = document.to_html
+          if @config["show_warnings"]
+            document.warnings.each do |warning|
+              Jekyll.logger.warn "Kramdown warning:", warning
+            end
+          end
+          html_output
+        end
+
+        private
+
+        def load_dependencies
+          require "kramdown-parser-gfm" if @config["input"] == "GFM"
+
+          if highlighter == "coderay"
+            Jekyll::External.require_with_graceful_fail("kramdown-syntax-coderay")
+          end
+
+          # `mathjax` emgine 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][enable_coderay] >
+        #   config[highlighter]
+        # Where `enable_coderay` is now deprecated because Kramdown
+        # supports Rouge now too.
+        def highlighter
+          return @highlighter if @highlighter
+
+          if @config["syntax_highlighter"]
+            return @highlighter = @config[
+              "syntax_highlighter"
+            ]
+          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."
+              )
+
+              "coderay"
+            else
+              @main_fallback_highlighter
+            end
+          end
+        end
+
+        def strip_coderay_prefix(hash)
+          hash.each_with_object({}) do |(key, val), hsh|
+            cleaned_key = key.to_s.gsub(%r!\Acoderay_!, "")
+
+            if key != cleaned_key
+              Jekyll::Deprecator.deprecation_message(
+                "You are using '#{key}'. Normalizing to #{cleaned_key}."
+              )
+            end
+
+            hsh[cleaned_key] = val
+          end
+        end
+
+        # If our highlighter is CodeRay we go in to merge the CodeRay defaults
+        # with your "coderay" key if it's there, deprecating it in the
+        # process of you using it.
+        def modernize_coderay_config
+          unless @config["coderay"].empty?
+            Jekyll::Deprecator.deprecation_message(
+              "You are using 'kramdown.coderay' in your configuration, " \
+              "please use 'syntax_highlighter_opts' instead."
+            )
+
+            @config["syntax_highlighter_opts"] = begin
+              strip_coderay_prefix(
+                @config["syntax_highlighter_opts"] \
+                  .merge(CODERAY_DEFAULTS) \
+                  .merge(@config["coderay"])
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end