jekyll/test/test_kramdown.rb

# frozen_string_literal: true

require "helper"
require "rouge"

class TestKramdown < JekyllUnitTest
  def fixture_converter(config)
    site = fixture_site(
      Utils.deep_merge_hashes(
        {
          "markdown" => "kramdown",
        },
        config
      )
    )
    Jekyll::Cache.clear
    site.find_converter_instance(
      Jekyll::Converters::Markdown
    )
  end

  context "kramdown" do
    setup do
      @config = {
        "kramdown" => {
          "smart_quotes"            => "lsquo,rsquo,ldquo,rdquo",
          "entity_output"           => "as_char",
          "toc_levels"              => "1..6",
          "auto_ids"                => false,
          "footnote_nr"             => 1,
          "show_warnings"           => true,

          "syntax_highlighter"      => "rouge",
          "syntax_highlighter_opts" => {
            "bold_every" => 8,
            "css"        => :class,
            "css_class"  => "highlight",
            "formatter"  => ::Rouge::Formatters::HTMLLegacy,
            "foobar"     => "lipsum",
          },
        },
      }
      @kramdown_config_keys = @config["kramdown"].keys
      @syntax_highlighter_opts_config_keys = \
        @config["kramdown"]["syntax_highlighter_opts"].keys

      @config = Jekyll.configuration(@config)
      @converter = fixture_converter(@config)
    end

    should "not break kramdown" do
      kramdown_doc = Kramdown::Document.new("# Some Header #", @config["kramdown"])
      assert_equal :class, kramdown_doc.options[:syntax_highlighter_opts][:css]
      assert_equal "lipsum", kramdown_doc.options[:syntax_highlighter_opts][:foobar]
    end

    should "run Kramdown" do
      assert_equal "<h1>Some Header</h1>", @converter.convert("# Some Header #").strip
    end

    should "should log kramdown warnings" do
      allow_any_instance_of(Kramdown::Document).to receive(:warnings).and_return(["foo"])
      expect(Jekyll.logger).to receive(:warn).with("Kramdown warning:", "foo")
      @converter.convert("Something")
    end

    should "render fenced code blocks with syntax highlighting" do
      result = nokogiri_fragment(@converter.convert(<<~MARKDOWN))
        ~~~ruby
        puts "Hello World"
        ~~~
      MARKDOWN
      div_highlight = ">div.highlight"
      selector = "div.highlighter-rouge#{div_highlight}>pre.highlight>code"
      refute(result.css(selector).empty?, result.to_html)
    end

    context "when configured" do
      setup do
        @source = <<~TEXT
          ## Code Sample

              def ruby_fu
                "Hello"
              end
        TEXT
      end

      should "have 'plaintext' as the default syntax_highlighter language" do
        converter = fixture_converter(@config)
        parser = converter.setup && converter.instance_variable_get(:@parser)
        parser_config = parser.instance_variable_get(:@config)

        assert_equal "plaintext", parser_config.dig("syntax_highlighter_opts", "default_lang")
      end

      should "accept the specified default syntax_highlighter language" do
        override = {
          "kramdown" => {
            "syntax_highlighter_opts" => {
              "default_lang" => "yaml",
            },
          },
        }
        converter = fixture_converter(Utils.deep_merge_hashes(@config, override))
        parser = converter.setup && converter.instance_variable_get(:@parser)
        parser_config = parser.instance_variable_get(:@config)

        assert_equal "yaml", parser_config.dig("syntax_highlighter_opts", "default_lang")
        refute_match %r!<div class="language-plaintext!, converter.convert(@source)
        refute_match %r!<div class="language-html!, converter.convert(@source)
        assert_match %r!<div class="language-yaml!, converter.convert(@source)
      end
    end

    context "when asked to convert smart quotes" do
      should "convert" do
        converter = fixture_converter(@config)
        assert_match(
          %r!<p>(&#8220;|“)Pit(&#8217;|’)hy(&#8221;|”)</p>!,
          converter.convert(%("Pit'hy")).strip
        )
      end

      should "support custom types" do
        override = {
          "highlighter" => nil,
          "kramdown"    => {
            "smart_quotes" => "lsaquo,rsaquo,laquo,raquo",
          },
        }
        converter = fixture_converter(Utils.deep_merge_hashes(@config, override))
        assert_match %r!<p>(&#171;|«)Pit(&#8250;|›)hy(&#187;|»)</p>!, \
                     converter.convert(%("Pit'hy")).strip
      end
    end

    context "when a custom highlighter is chosen" do
      should "use the chosen highlighter if it's available" do
        override = {
          "highlighter" => nil,
          "kramdown"    => {
            "syntax_highlighter" => "coderay",
          },
        }
        converter = fixture_converter(Utils.deep_merge_hashes(@config, override))
        result = nokogiri_fragment(converter.convert(<<~MARKDOWN))
          ~~~ruby
          puts "Hello World"
          ~~~
        MARKDOWN

        selector = "div.highlighter-coderay>div.CodeRay>div.code>pre"
        refute result.css(selector).empty?
      end

      should "support legacy enable_coderay... for now" do
        override = {
          "kramdown" => {
            "enable_coderay" => true,
          },
        }

        @config.delete("highlighter")
        @config["kramdown"].delete("syntax_highlighter")

        converter = fixture_converter(Utils.deep_merge_hashes(@config, override))
        result = nokogiri_fragment(converter.convert(<<~MARKDOWN))
          ~~~ruby
          puts "Hello World"
          ~~~
        MARKDOWN

        selector = "div.highlighter-coderay>div.CodeRay>div.code>pre"
        refute result.css(selector).empty?, "pre tag should exist"
      end
    end

    should "move coderay to syntax_highlighter_opts" do
      override = {
        "higlighter" => nil,
        "kramdown"   => {
          "syntax_highlighter" => "coderay",
          "coderay"            => {
            "hello" => "world",
          },
        },
      }
      original = Kramdown::Document.method(:new)
      converter = fixture_converter(
        Utils.deep_merge_hashes(@config, override)
      )

      expect(Kramdown::Document).to receive(:new) do |arg1, hash|
        assert_equal "world", hash["syntax_highlighter_opts"]["hello"]
        original.call(arg1, hash)
      end

      converter.convert("hello world")
    end
  end
end