kramdown 0.14.2 → 2.3.0

data/test/run_tests.rb

@@ -1,22 +1,9 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
@@ -35,7 +22,7 @@ arg = if File.directory?(arg)
         arg + '.text'
       end
 
-width = ((size = %x{stty size 2>/dev/null}).length > 0 ? size.split.last.to_i : 72) rescue 72
+width = ((size = `stty size 2>/dev/null`).length > 0 ? size.split.last.to_i : 72) rescue 72
 width -= 8
 fwidth = 0
 Dir[arg].each {|f| fwidth = [fwidth, f.length + 10].max }.each do |file|
@@ -44,13 +31,13 @@ Dir[arg].each {|f| fwidth = [fwidth, f.length + 10].max }.each do |file|
 
   html_file = file.sub('.text', '.html')
   opts_file = file.sub('.text', '.options')
-  opts_file = File.join(File.dirname(file), 'options') if !File.exist?(opts_file)
-  options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
+  opts_file = File.join(File.dirname(file), 'options') unless File.exist?(opts_file)
+  options = File.exist?(opts_file) ? YAML.safe_load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
   doc = Kramdown::Document.new(File.read(file), options)
   begin
     assert_equal(File.read(html_file), doc.to_html)
     puts 'PASSED'
-  rescue Exception => e
+  rescue StandardError
     puts '  FAILED'
     puts $!.message if $VERBOSE
     puts $!.backtrace if $DEBUG

data/test/test_files.rb

@@ -1,85 +1,121 @@
-# -*- coding: utf-8 -*-
+# -*- coding: utf-8; frozen_string_literal: true -*-
 #
 #--
-# Copyright (C) 2009-2012 Thomas Leitner <t_leitner@gmx.at>
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
 #
-# This file is part of kramdown.
-#
-# kramdown is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# This file is part of kramdown which is licensed under the MIT.
 #++
 #
 
-require 'test/unit'
+require 'minitest/autorun'
 require 'kramdown'
 require 'yaml'
 require 'tmpdir'
+require 'open3'
+
+begin
+  require 'kramdown/converter/syntax_highlighter/rouge'
+
+  Kramdown::Converter::SyntaxHighlighter::Rouge.formatter_class.send(:define_method, :format) do |tokens, &b|
+    super(tokens, &b).sub(/<\/code><\/pre>\n?/, "</code></pre>\n")
+  end
 
-Encoding.default_external = 'utf-8' if RUBY_VERSION >= '1.9'
+  # custom formatter for tests
+  class RougeHTMLFormatters < Kramdown::Converter::SyntaxHighlighter::Rouge.formatter_class
 
-class TestFiles < Test::Unit::TestCase
+    tag 'rouge_html_formatters'
+
+    def stream(tokens, &b)
+      yield %(<div class="custom-class">)
+      super
+      yield %(</div>)
+    end
+
+  end
+rescue LoadError, SyntaxError, NameError
+end
+
+Encoding.default_external = 'utf-8'
+
+class TestFiles < Minitest::Test
+
+  EXCLUDE_KD_FILES = [].compact
 
   # Generate test methods for kramdown-to-xxx conversion
   Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+    next if EXCLUDE_KD_FILES.any? {|f| text_file =~ /#{f}/ }
     basename = text_file.sub(/\.text$/, '')
     opts_file = text_file.sub(/\.text$/, '.options')
     (Dir[basename + ".*"] - [text_file, opts_file]).each do |output_file|
-      next if (RUBY_VERSION >= '1.9' && File.exist?(output_file + '.19')) ||
-        (RUBY_VERSION < '1.9' && output_file =~ /\.19$/)
-      output_format = File.extname(output_file.sub(/\.19$/, ''))[1..-1]
-      next if !Kramdown::Converter.const_defined?(output_format[0..0].upcase + output_format[1..-1])
+      output_format = File.extname(output_file)[1..-1]
+      next unless Kramdown::Converter.const_defined?(output_format[0..0].upcase + output_format[1..-1])
       define_method('test_' + text_file.tr('.', '_') + "_to_#{output_format}") do
-        opts_file = File.join(File.dirname(text_file), 'options') if !File.exist?(opts_file)
-        options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
+        opts_file = File.join(File.dirname(text_file), 'options') unless File.exist?(opts_file)
+        options = File.exist?(opts_file) ? YAML.load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
         doc = Kramdown::Document.new(File.read(text_file), options)
         assert_equal(File.read(output_file), doc.send("to_#{output_format}"))
       end
     end
   end
 
-  # Generate test methods for html-to-html conversion
+  # Generate test methods for html-to-{html,kramdown} conversion
   `tidy -v 2>&1`
   if $?.exitstatus != 0
-    warn("Skipping html-to-html tests because tidy executable is missing")
+    warn("Skipping html-to-{html,kramdown} tests because tidy executable is missing")
   else
-    EXCLUDE_HTML_FILES = ['test/testcases/block/06_codeblock/whitespace.html', # bc of span inside pre
-                          'test/testcases/block/09_html/simple.html', # bc of xml elements
-                          'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
-                          'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
-                          'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
-                         ]
-    Dir[File.dirname(__FILE__) + '/testcases/**/*.{html, htmlinput}'].each do |html_file|
-      next if EXCLUDE_HTML_FILES.any? {|f| html_file =~ /#{f}$/}
-      out_file = (html_file =~ /\.htmlinput$/ ? html_file.sub(/input$/, '') : html_file)
-      define_method('test_' + html_file.tr('.', '_') + "_to_html") do
-        opts_file = html_file.sub(/\.html$/, '.options')
-        opts_file = File.join(File.dirname(html_file), 'options') if !File.exist?(opts_file)
-        options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
-        doc = Kramdown::Document.new(File.read(html_file), options.merge(:input => 'html'))
-        assert_equal(tidy_output(File.read(out_file)), tidy_output(doc.to_html))
+    EXCLUDE_HTML_FILES = [
+      'test/testcases/block/06_codeblock/whitespace.html', # bc of span inside pre
+      'test/testcases/block/09_html/simple.html', # bc of xml elements
+      'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
+      'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
+      'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
+      'test/testcases/block/06_codeblock/rouge/simple.html', # bc of double surrounding <div>
+      'test/testcases/block/06_codeblock/rouge/multiple.html', # bc of double surrounding <div>
+      'test/testcases/block/06_codeblock/highlighting.html', # bc of span elements inside code element
+      'test/testcases/block/06_codeblock/highlighting-opts.html', # bc of span elements inside code element
+      'test/testcases/block/06_codeblock/guess_lang_css_class.html', # bc of double surrounding <div>
+      'test/testcases/block/12_extension/options3.html', # bc of rouge
+      'test/testcases/block/14_table/empty_tag_in_cell.html', # bc of tidy
+      'test/testcases/block/15_math/mathjax_preview.html', # bc of mathjax preview
+      'test/testcases/block/15_math/mathjax_preview_simple.html', # bc of mathjax preview
+      'test/testcases/block/15_math/mathjax_preview_as_code.html', # bc of mathjax preview
+      'test/testcases/span/05_html/mark_element.html', # bc of tidy
+      'test/testcases/block/09_html/xml.html', # bc of tidy
+      'test/testcases/span/05_html/xml.html', # bc of tidy
+    ].compact
+    EXCLUDE_HTML_TEXT_FILES = [
+      'test/testcases/block/09_html/parse_as_span.htmlinput',
+      'test/testcases/block/09_html/parse_as_raw.htmlinput',
+    ].compact
+    Dir[File.dirname(__FILE__) + '/testcases/**/*.{html,htmlinput}'].each do |html_file|
+      next if EXCLUDE_HTML_FILES.any? {|f| html_file =~ /#{f}/ }
+
+      out_files = []
+      out_files << [(html_file =~ /\.htmlinput$/ ? html_file.sub(/input$/, '') : html_file), :to_html]
+      if html_file =~ /\.htmlinput$/ && EXCLUDE_HTML_TEXT_FILES.none? {|f| html_file =~ /#{f}/ }
+        out_files << [html_file.sub(/htmlinput$/, 'text'), :to_kramdown]
+      end
+      out_files.select {|f, _| File.exist?(f) }.each do |out_file, out_method|
+        define_method('test_' + html_file.tr('.', '_') + "_to_#{File.extname(out_file)}") do
+          opts_file = html_file.sub(/\.html(input)?$/, '.options')
+          opts_file = File.join(File.dirname(html_file), 'options') unless File.exist?(opts_file)
+          options = File.exist?(opts_file) ? YAML.load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
+          doc = Kramdown::Document.new(File.read(html_file), options.merge(input: 'html'))
+          if out_method == :to_html
+            assert_equal(tidy_output(File.read(out_file)), tidy_output(doc.send(out_method)))
+          else
+            assert_equal(File.read(out_file), doc.send(out_method))
+          end
+        end
       end
     end
   end
 
   def tidy_output(out)
-    cmd = "tidy -q --doctype omit #{RUBY_VERSION >= '1.9' ? '-utf8' : '-raw'} 2>/dev/null"
-    result = IO.popen(cmd, 'r+') do |io|
-      io.write(out)
-      io.close_write
-      io.read
-    end
-    if $?.exitstatus == 2
-      raise "Problem using tidy"
+    cmd = "tidy -q --doctype omit -utf8"
+    result, error, status = Open3.capture3(cmd, stdin_data: out)
+    if status.exitstatus == 2
+      raise "Problem using tidy: #{error}"
     end
     result
   end
@@ -89,22 +125,29 @@ class TestFiles < Test::Unit::TestCase
   if $?.exitstatus != 0
     warn("Skipping latex compilation tests because latex executable is missing")
   else
-    EXCLUDE_LATEX_FILES = ['test/testcases/span/01_link/image_in_a.text', # bc of image link
-                           'test/testcases/span/01_link/imagelinks.text', # bc of image links
-                           'test/testcases/span/04_footnote/markers.text', # bc of footnote in header
-                          ]
+    EXCLUDE_LATEX_FILES = [
+      'test/testcases/span/01_link/image_in_a.text', # bc of image link
+      'test/testcases/span/01_link/imagelinks.text', # bc of image links
+      'test/testcases/span/01_link/empty_title.text',
+      'test/testcases/span/04_footnote/markers.text', # bc of footnote in header
+      'test/testcases/block/06_codeblock/with_lang_in_fenced_block_name_with_dash.text',
+      'test/testcases/block/06_codeblock/with_lang_in_fenced_block_any_char.text',
+      'test/testcases/block/03_paragraph/standalone_image.text', # bc of standalone image
+      'test/testcases/cjk-line-break.text', # latex unicode support
+    ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
-      next if EXCLUDE_LATEX_FILES.any? {|f| text_file =~ /#{f}$/}
+      next if EXCLUDE_LATEX_FILES.any? {|f| text_file =~ /#{f}$/ }
       define_method('test_' + text_file.tr('.', '_') + "_to_latex_compilation") do
-        latex =  Kramdown::Document.new(File.read(text_file),
-                                                          :auto_ids => false, :footnote_nr => 1,
-                                                          :template => 'document').to_latex
-        result = IO.popen("latex -output-directory='#{Dir.tmpdir}' 2>/dev/null", 'r+') do |io|
-          io.write(latex)
-          io.close_write
-          io.read
+        latex = Kramdown::Document.new(File.read(text_file), auto_ids: false, footnote_nr: 1,
+                                       template: 'document').to_latex
+        Dir.mktmpdir do |tmpdir|
+          result = IO.popen("latex -output-directory='#{tmpdir}' 2>/dev/null", 'r+') do |io|
+            io.write(latex)
+            io.close_write
+            io.read
+          end
+          assert($?.exitstatus == 0, result.scan(/^!(.*\n.*)/).join("\n"))
         end
-        assert($?.exitstatus == 0, result.scan(/^!(.*\n.*)/).join("\n"))
       end
     end
   end
@@ -114,26 +157,38 @@ class TestFiles < Test::Unit::TestCase
   if $?.exitstatus != 0
     warn("Skipping text->kramdown->html tests because tidy executable is missing")
   else
-    EXCLUDE_TEXT_FILES = ['test/testcases/span/05_html/markdown_attr.text',  # bc of markdown attr
-                          'test/testcases/block/09_html/markdown_attr.text', # bc of markdown attr
-                          'test/testcases/span/extension/options.text',      # bc of parse_span_html option
-                          'test/testcases/block/12_extension/options.text',  # bc of options option
-                          'test/testcases/block/12_extension/options3.text', # bc of options option
-                          'test/testcases/block/09_html/content_model/tables.text',  # bc of parse_block_html option
-                          'test/testcases/block/09_html/html_to_native/header.text', # bc of auto_ids option that interferes
-                          'test/testcases/block/09_html/simple.text',        # bc of webgen:block elements
-                          'test/testcases/block/11_ial/simple.text',         # bc of change of ordering of attributes in header
-                          'test/testcases/span/extension/comment.text',      # bc of comment text modifications (can this be avoided?)
-                          'test/testcases/block/04_header/header_type_offset.text', # bc of header_offset being applied twice
-                         ]
+    EXCLUDE_TEXT_FILES = [
+      'test/testcases/span/05_html/markdown_attr.text',  # bc of markdown attr
+      'test/testcases/block/09_html/markdown_attr.text', # bc of markdown attr
+      'test/testcases/span/extension/options.text',      # bc of parse_span_html option
+      'test/testcases/block/12_extension/options.text',  # bc of options option
+      'test/testcases/block/12_extension/options3.text', # bc of options option
+      'test/testcases/block/09_html/content_model/tables.text',  # bc of parse_block_html option
+      'test/testcases/block/09_html/html_to_native/header.text', # bc of auto_ids option that interferes
+      'test/testcases/block/09_html/html_to_native/table_simple.text', # bc of tr style attr getting removed
+      'test/testcases/block/09_html/simple.text',        # bc of webgen:block elements
+      'test/testcases/block/11_ial/simple.text',         # bc of change of ordering of attributes in header
+      'test/testcases/span/extension/comment.text',      # bc of comment text modifications (can this be avoided?)
+      'test/testcases/block/04_header/header_type_offset.text', # bc of header_offset being applied twice
+      'test/testcases/block/06_codeblock/rouge/simple.text',
+      'test/testcases/block/06_codeblock/rouge/multiple.text', # check, what document contain more, than one code block
+      'test/testcases/block/14_table/empty_tag_in_cell.text', # bc of tidy
+      'test/testcases/span/01_link/link_defs_with_ial.text', # bc of attribute ordering
+      'test/testcases/span/05_html/mark_element.text', # bc of tidy
+      'test/testcases/block/09_html/xml.text', # bc of tidy
+      'test/testcases/span/05_html/xml.text', # bc of tidy
+      'test/testcases/block/03_paragraph/standalone_image.text', # bc of standalone image
+      'test/testcases/cjk-line-break.text',
+      'test/testcases/block/09_html/standalone_image_in_div.html', # bc of standalone image
+    ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
-      next if EXCLUDE_TEXT_FILES.any? {|f| text_file =~ /#{f}$/}
+      next if EXCLUDE_TEXT_FILES.any? {|f| text_file =~ /#{f}$/ }
+      html_file = text_file.sub(/\.text$/, '.html')
+      next unless File.exist?(html_file)
       define_method('test_' + text_file.tr('.', '_') + "_to_kramdown_to_html") do
-        html_file = text_file.sub(/\.text$/, '.html')
-        html_file += '.19' if RUBY_VERSION >= '1.9' && File.exist?(html_file + '.19')
         opts_file = text_file.sub(/\.text$/, '.options')
-        opts_file = File.join(File.dirname(text_file), 'options') if !File.exist?(opts_file)
-        options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
+        opts_file = File.join(File.dirname(text_file), 'options') unless File.exist?(opts_file)
+        options = File.exist?(opts_file) ? YAML.load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
         kdtext = Kramdown::Document.new(File.read(text_file), options).to_kramdown
         html = Kramdown::Document.new(kdtext, options).to_html
         assert_equal(tidy_output(File.read(html_file)), tidy_output(html))
@@ -146,39 +201,72 @@ class TestFiles < Test::Unit::TestCase
   if $?.exitstatus != 0
     warn("Skipping html-to-kramdown-to-html tests because tidy executable is missing")
   else
-    EXCLUDE_HTML_KD_FILES = ['test/testcases/span/extension/options.html',        # bc of parse_span_html option
-                             'test/testcases/span/05_html/normal.html',           # bc of br tag before closing p tag
-                             'test/testcases/block/12_extension/nomarkdown.html', # bc of nomarkdown extension
-                             'test/testcases/block/09_html/simple.html',          # bc of webgen:block elements
-                             'test/testcases/block/09_html/markdown_attr.html',   # bc of markdown attr
-                             'test/testcases/block/09_html/html_to_native/table_simple.html', # bc of invalidly converted simple table
-                             'test/testcases/block/06_codeblock/whitespace.html', # bc of entity to char conversion
-                             'test/testcases/block/11_ial/simple.html',           # bc of change of ordering of attributes in header
-                             'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
-                             'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
-                             'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
-                             'test/testcases/block/16_toc/toc_exclude.html',      # bc of different attribute ordering
-                            ]
+    EXCLUDE_HTML_KD_FILES = [
+      'test/testcases/span/extension/options.html',        # bc of parse_span_html option
+      'test/testcases/span/05_html/normal.html',           # bc of br tag before closing p tag
+      'test/testcases/block/12_extension/nomarkdown.html', # bc of nomarkdown extension
+      'test/testcases/block/12_extension/options3.html', # bc of rouge
+      'test/testcases/block/09_html/simple.html',          # bc of webgen:block elements
+      'test/testcases/block/09_html/markdown_attr.html',   # bc of markdown attr
+      'test/testcases/block/09_html/html_to_native/table_simple.html', # bc of invalidly converted simple table
+      'test/testcases/block/06_codeblock/whitespace.html', # bc of entity to char conversion
+      'test/testcases/block/06_codeblock/rouge/simple.html', # bc of double surrounding <div>
+      'test/testcases/block/06_codeblock/rouge/multiple.html', # bc of double surrounding <div>
+      'test/testcases/block/06_codeblock/guess_lang_css_class.html', # bc of double surrounding <div>
+      'test/testcases/block/06_codeblock/highlighting.html', # bc of span elements inside code element
+      'test/testcases/block/06_codeblock/highlighting-opts.html', # bc of span elements inside code element
+      'test/testcases/block/11_ial/simple.html',           # bc of change of ordering of attributes in header
+      'test/testcases/span/03_codespan/highlighting.html', # bc of span elements inside code element
+      'test/testcases/block/04_header/with_auto_ids.html', # bc of auto_ids=true option
+      'test/testcases/block/04_header/header_type_offset.html', # bc of header_offset option
+      'test/testcases/block/16_toc/toc_exclude.html',      # bc of different attribute ordering
+      'test/testcases/span/autolinks/url_links.html',      # bc of quot entity being converted to char
+      'test/testcases/block/14_table/empty_tag_in_cell.html', # bc of tidy
+      'test/testcases/span/01_link/link_defs_with_ial.html', # bc of attribute ordering
+      'test/testcases/span/05_html/mark_element.html', # bc of tidy
+      'test/testcases/block/09_html/xml.html', # bc of tidy
+      'test/testcases/span/05_html/xml.html', # bc of tidy
+      'test/testcases/block/03_paragraph/standalone_image.html', # bc of standalone image
+      'test/testcases/block/15_math/normal.html', # bc of mathjax and HTML parser
+      'test/testcases/block/15_math/gh_128.html', # bc of mathjax and HTML parser
+      'test/testcases/span/04_footnote/backlink_inline.html', # bc of mathjax
+      'test/testcases/block/09_html/standalone_image_in_div.html', # bc of standalone image
+      'test/testcases/block/09_html/processing_instruction.html', # bc of PI
+    ].compact
     Dir[File.dirname(__FILE__) + '/testcases/**/*.html'].each do |html_file|
-      next if EXCLUDE_HTML_KD_FILES.any? {|f| html_file =~ /#{f}$/}
+      next if EXCLUDE_HTML_KD_FILES.any? {|f| html_file =~ /#{f}$/ }
       define_method('test_' + html_file.tr('.', '_') + "_to_kramdown_to_html") do
-        kd = Kramdown::Document.new(File.read(html_file), :input => 'html', :auto_ids => false, :footnote_nr => 1).to_kramdown
+        kd = Kramdown::Document.new(File.read(html_file), input: 'html',
+                                    auto_ids: false, footnote_nr: 1).to_kramdown
         opts_file = html_file.sub(/\.html$/, '.options')
-        opts_file = File.join(File.dirname(html_file), 'options') if !File.exist?(opts_file)
-        options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
+        opts_file = File.join(File.dirname(html_file), 'options') unless File.exist?(opts_file)
+        options = File.exist?(opts_file) ? YAML.load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
         doc = Kramdown::Document.new(kd, options)
         assert_equal(tidy_output(File.read(html_file)), tidy_output(doc.to_html))
       end
     end
   end
 
+  # Generate test methods for text-manpage conversion
+  Dir[File.dirname(__FILE__) + '/testcases/man/**/*.text'].each do |text_file|
+    define_method('test_' + text_file.tr('.', '_') + "_to_man") do
+      man_file = text_file.sub(/\.text$/, '.man')
+      doc = Kramdown::Document.new(File.read(text_file))
+      assert_equal(File.read(man_file), doc.to_man)
+    end
+  end
 
+  EXCLUDE_MODIFY = [
+    'test/testcases/block/06_codeblock/rouge/multiple.text', # bc of HTMLFormater in options
+  ].compact
 
   # Generate test methods for asserting that converters don't modify the document tree.
   Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
     opts_file = text_file.sub(/\.text$/, '.options')
-    options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {:auto_ids => false, :footnote_nr => 1}
-    (Kramdown::Converter.constants.map {|c| c.to_sym} - [:Base, :RemoveHtmlTags]).each do |conv_class|
+    options = File.exist?(opts_file) ? YAML.load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
+    (Kramdown::Converter.constants.map(&:to_sym) -
+     [:Base, :RemoveHtmlTags, :MathEngine, :SyntaxHighlighter]).each do |conv_class|
+      next if EXCLUDE_MODIFY.any? {|f| text_file =~ /#{f}$/ }
       define_method("test_whether_#{conv_class}_modifies_tree_with_file_#{text_file.tr('.', '_')}") do
         doc = Kramdown::Document.new(File.read(text_file), options)
         options_before = Marshal.load(Marshal.dump(doc.options))
@@ -195,7 +283,7 @@ class TestFiles < Test::Unit::TestCase
     if old.value.kind_of?(Kramdown::Element)
       assert_tree_not_changed(old.value, new.value)
     else
-      assert_equal(old.value, new.value, "value mismatch")
+      assert(old.value == new.value, "value mismatch")
     end
     assert_equal(old.attr, new.attr, "attr mismatch")
     assert_equal(old.options, new.options, "options mismatch")

data/test/test_location.rb

@@ -0,0 +1,216 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2009-2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown which is licensed under the MIT.
+#++
+#
+
+require 'minitest/autorun'
+require 'kramdown'
+
+Encoding.default_external = 'utf-8'
+
+describe 'location' do
+  # checks that +element+'s :location option corresponds to the location stored
+  # in the element.attr['class']
+  def check_element_for_location(element)
+    if (match = /^line-(\d+)/.match(element.attr['class'] || ''))
+      expected_line = match[1].to_i
+      assert_equal(expected_line, element.options[:location])
+    end
+    element.children.each do |child|
+      check_element_for_location(child)
+    end
+  end
+
+  # Test cases consist of a kramdown string that uses IALs to specify the expected
+  # line numbers for a given element.
+  test_cases = {
+    'autolink' => %(testing autolinks\n\n<http://kramdown.org>{:.line-3}),
+    'blockquote' => %(
+      > block quote1
+      >
+      > * {:.line-3} list item in block quote
+      > * {:.line-4} list item in block quote
+      > {:.line-3}
+      {:.line-1}
+
+      > block quote2
+      {:.line-8}
+    ),
+    'codeblock' => %(\na para\n\n~~~~\ntest code 1\n~~~~\n{:.line-3}\n\n    test code 2\n{:.line-8}\n),
+    'codespan' => %(a para\n\nanother para `<code>`{:.line-3} with code\n),
+    'emphasis' => %(
+      para *span*{:.line-1}
+      {:.line-1}
+
+      ## header *span*{:.line-4}
+      {:.line-4}
+
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+      quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+      consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+      cillum *short span on single line*{:.line-11}
+      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+      *long span over multiple lines - proident, sunt in culpa qui officia deserunt
+      mollit anim id est laborum.*{:.line-13}
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+      quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+      `code span`{:.line-18}
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+      quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+      {:.line-7}
+    ),
+    'header' => %(
+      # header1
+      {:.line-1}
+
+      ## header2
+      {:.line-4}
+
+      ## header3
+      {:.line-7}
+
+      header4
+      =======
+      {:.line-10}
+
+      ^
+
+      header5
+      -------
+      {:.line-16}
+    ),
+    'horizontal_rule' => %(\na para\n\n----\n{:.line-3}\n),
+    'html_entity' => "a para\n\nanother para with &amp;{:.line-3} html entity.\n",
+    'link' => %(
+      a para
+
+      This is [a link](http://rubyforge.org){:.line-3} to a page.
+
+      Here comes a ![smiley](../images/smiley.png){:.line-5}
+    ),
+    'list' => %(
+      * {:.line-1} list item
+      * {:.line-2} list item
+      * {:.line-3} list item
+      {:.line-1}
+
+      {:.line-7}
+      1. {:.line-7} list item
+      2. {:.line-8} list item
+      3. {:.line-9} list item
+
+      {:.line-12}
+      definition term 1
+      : {:.line-13} definition definition 1
+      definition term 2
+      : {:.line-15} definition definition 2
+    ),
+    'math_block' => %(\na para\n\n$$5+5$$\n{:.line-3}\n),
+    'math_inline' => %(\na para\n\nanother para with inline math $$5+5$${:.line-3}\n),
+    'paragraph' => %(
+      para1
+      {:.line-1}
+
+      para2
+      {:.line-4}
+
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+      quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+      consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+      {:.line-7}
+
+      {:.line-14}
+      para with leading IAL
+    ),
+    'table' => %(
+      a para
+
+      |first|second|third|
+      |-----|------|-----|
+      |a    |b     |c    |
+      {:.line-3}
+    ),
+    'typographic_symbol' => %(
+      a para
+
+      another para ---{:.line-3}
+
+      another para ...{:.line-5}
+    ),
+    'gh issue 129' => %(
+      `|`
+      {:.line-1}
+    ),
+    'gh issue 131' => %(
+      * {:.line-1} test
+        line 2
+        * {:.line-3} second
+        * {:.line-4} third
+      * {:.line-5} * {:.line-5} one
+        * {:.line-6} two
+    ),
+    'gh issue 158' => %(
+      😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁😁
+      {:.line-1}
+
+      - {:.line-4} T
+      {:.line-4}
+
+      # T
+      {:.line-7}
+    ),
+    'gh issue 243 - HTML raw elements' => %(
+      <ul class="line-1">
+        <li class="line-2">Test</li>
+      </ul>
+    ),
+  }
+  test_cases.each do |name, test_string|
+    it "Handles #{name}" do
+      doc = Kramdown::Document.new(test_string.gsub(/^      /, '').strip)
+      check_element_for_location(doc.root)
+    end
+  end
+
+  it 'adds location info to duplicate abbreviation definition warnings' do
+    test_string = %(This snippet contains a duplicate abbreviation definition
+
+*[duplicate]: The first definition
+*[duplicate]: The second definition
+    )
+    doc = Kramdown::Document.new(test_string.strip)
+    assert_equal(["Duplicate abbreviation ID 'duplicate' on line 4 - overwriting"], doc.warnings)
+  end
+
+  it 'handles abbreviations' do
+    str = "This *is* ABC and\n**and** ABC second\nanother ABC\nas ABC as\nABC at the end.\n\n*[ABC]: ABC"
+    doc = Kramdown::Document.new(str)
+    doc.root.children.first.children.select {|e| e.type == :abbreviation }.each_with_index do |e, i|
+      assert_equal(i + 1, e.options[:location])
+    end
+  end
+
+  it 'handles line breaks' do
+    str = "First  \nsecond\\\\\nthird  \n"
+    doc = Kramdown::Document.new(str)
+    doc.root.children.first.children.select {|e| e.type == :br }.each_with_index do |e, i|
+      assert_equal(i + 1, e.options[:location])
+    end
+  end
+
+  it 'handles smart quotes' do
+    str = "This is 'first'\nand 'second' and\n'third'"
+    doc = Kramdown::Document.new(str)
+    doc.root.children.first.children.select {|e| e.type == :smart_quote }.each_with_index do |e, i|
+      assert_equal(((i + 1) / 2.0).ceil, e.options[:location])
+    end
+  end
+end