gitdown 0.0.1

data/test/run_tests.rb

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009 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/>.
+#++
+#
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'kramdown'
+require 'test/unit/assertions'
+require 'yaml'
+
+include Test::Unit::Assertions
+
+arg = ARGV[0] || File.join(File.dirname(__FILE__), 'testcases')
+
+arg = if File.directory?(arg)
+        File.join(arg, '**/*.text')
+      else
+        arg + '.text'
+      end
+
+width = ((size = %x{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|
+  print(('Testing ' + file + ' ').ljust([fwidth, width].min))
+  $stdout.flush
+
+  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}
+  doc = Kramdown::Document.new(File.read(file), options)
+  begin
+    assert_equal(File.read(html_file), doc.to_html)
+    puts 'PASSED'
+  rescue Exception => e
+    puts '  FAILED'
+    puts $!.message if $VERBOSE
+    puts $!.backtrace if $DEBUG
+  end
+  puts "Warnings:\n" + doc.warnings.join("\n") if !doc.warnings.empty? && $VERBOSE
+end

data/test/test_files.rb

@@ -0,0 +1,197 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2009 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/>.
+#++
+#
+
+require 'test/unit'
+require 'kramdown'
+require 'yaml'
+require 'tmpdir'
+
+Encoding.default_external = 'utf-8' if RUBY_VERSION >= '1.9'
+
+class TestFiles < Test::Unit::TestCase
+
+  # Generate test methods for kramdown-to-xxx conversion
+  Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+    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])
+      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}
+        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
+  `tidy -v 2>&1`
+  if $?.exitstatus != 0
+    warn("Skipping html-to-html 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
+                         ]
+    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
+        doc = Kramdown::Document.new(File.read(html_file), :input => 'html', :auto_ids => false, :footnote_nr => 1)
+        assert_equal(tidy_output(File.read(out_file)), tidy_output(doc.to_html))
+      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"
+    end
+    result
+  end
+
+  # Generate test methods for text-to-latex conversion and compilation
+  `latex -v 2>&1`
+  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
+                          ]
+    Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+      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
+        end
+        assert($?.exitstatus == 0, result.scan(/^!(.*\n.*)/).join("\n"))
+      end
+    end
+  end
+
+  # Generate test methods for text->kramdown->html conversion
+  `tidy -v 2>&1`
+  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?)
+                         ]
+    Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+      next if EXCLUDE_TEXT_FILES.any? {|f| text_file =~ /#{f}$/}
+      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}
+        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))
+      end
+    end
+  end
+
+  # Generate test methods for html-to-kramdown-to-html conversion
+  `tidy -v 2>&1`
+  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
+                            ]
+    Dir[File.dirname(__FILE__) + '/testcases/**/*.html'].each do |html_file|
+      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
+        doc = Kramdown::Document.new(kd, :auto_ids => false, :footnote_nr => 1)
+        assert_equal(tidy_output(File.read(html_file)), tidy_output(doc.to_html))
+      end
+    end
+  end
+
+
+
+  # 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]).each do |conv_class|
+      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))
+        tree_before = Marshal.load(Marshal.dump(doc.root))
+        Kramdown::Converter.const_get(conv_class).convert(doc.root, doc.options)
+        assert_equal(options_before, doc.options)
+        assert_tree_not_changed(tree_before, doc.root)
+      end
+    end
+  end
+
+  def assert_tree_not_changed(old, new)
+    assert_equal(old.type, new.type, "type mismatch")
+    if old.value.kind_of?(Kramdown::Element)
+      assert_tree_not_changed(old.value, new.value)
+    else
+      assert_equal(old.value, new.value, "value mismatch")
+    end
+    assert_equal(old.attr, new.attr, "attr mismatch")
+    assert_equal(old.options, new.options, "options mismatch")
+    assert_equal(old.children.length, new.children.length, "children count mismatch")
+
+    old.children.each_with_index do |child, index|
+      assert_tree_not_changed(child, new.children[index])
+    end
+  end
+
+end

data/test/testcases/block/01_blank_line/spaces.html

@@ -0,0 +1 @@
+

data/test/testcases/block/01_blank_line/spaces.text

@@ -0,0 +1,3 @@
+
+             
+

data/test/testcases/block/01_blank_line/tabs.html

@@ -0,0 +1 @@
+

data/test/testcases/block/01_blank_line/tabs.text

@@ -0,0 +1,6 @@
+	
+			
+	
+		
+
+	

data/test/testcases/block/02_eob/beginning.html

@@ -0,0 +1 @@
+

data/test/testcases/block/02_eob/beginning.text

@@ -0,0 +1,3 @@
+^
+
+

data/test/testcases/block/02_eob/end.html

@@ -0,0 +1 @@
+

data/test/testcases/block/02_eob/end.text

@@ -0,0 +1,3 @@
+
+
+^

data/test/testcases/block/02_eob/middle.html

@@ -0,0 +1 @@
+

data/test/testcases/block/02_eob/middle.text

@@ -0,0 +1,5 @@
+
+
+^
+
+

data/test/testcases/block/03_paragraph/indented.html

@@ -0,0 +1,18 @@
+<p>This is a para.</p>
+
+<p>This is a para.</p>
+
+<p>This is a para.</p>
+
+<p>This is a para.</p>
+
+<pre><code>This is a code block.
+</code></pre>
+
+<p>And this is another.</p>
+
+<p>A para
+ with
+  mixed
+indents.
+   and with much indent</p>

data/test/testcases/block/03_paragraph/indented.text

@@ -0,0 +1,19 @@
+This is a para.
+
+ This is a para.
+
+  This is a para.
+
+   This is a para.
+
+    This is a code block.
+
+
+       
+And this is another.
+
+A para
+ with
+  mixed
+indents.
+   and with much indent

data/test/testcases/block/03_paragraph/no_newline_at_end.html

@@ -0,0 +1,5 @@
+<p>One paragraph
+over
+   multiple lines.</p>
+
+<p>Second one without newline.</p>

data/test/testcases/block/03_paragraph/no_newline_at_end.text

@@ -0,0 +1,5 @@
+  One paragraph
+over
+   multiple lines.
+
+Second one without newline.

data/test/testcases/block/03_paragraph/one_para.html

@@ -0,0 +1 @@
+<p>This is just a normal paragraph.</p>

data/test/testcases/block/03_paragraph/one_para.text

@@ -0,0 +1 @@
+This is just a normal paragraph.

data/test/testcases/block/03_paragraph/two_para.html

@@ -0,0 +1,4 @@
+<p>This is just a normal paragraph.
+That goes on to the second line.</p>
+
+<p>Another paragraph.</p>

data/test/testcases/block/03_paragraph/two_para.text

@@ -0,0 +1,4 @@
+This is just a normal paragraph.
+That goes on to the second line.
+
+Another paragraph.

data/test/testcases/block/04_header/atx_header.html

@@ -0,0 +1,37 @@
+<h1>This is a header</h1>
+
+<h2>This is a header</h2>
+
+<h3>This is a header</h3>
+
+<h4>This is a header</h4>
+
+<h5>This is a header</h5>
+
+<h6>This is a header</h6>
+
+<h1>Header</h1>
+<h1>Header</h1>
+
+<h2>Header</h2>
+<blockquote>
+  <p>blockquote</p>
+</blockquote>
+
+<h6>header</h6>
+<p>paragraph</p>
+
+<blockquote>
+  <p>blockquote
+### not a header</p>
+</blockquote>
+
+<h3 id="id">Header</h3>
+
+<h3 id="id">Header</h3>
+
+<h3>Header{#noid}</h3>
+
+<h3>Header ##{#noid}</h3>
+
+<h3>Last</h3>

data/test/testcases/block/04_header/atx_header.text

@@ -0,0 +1,34 @@
+# This is a header
+
+## This is a header
+
+### This is a header
+
+#### This is a header
+
+##### This is a header
+
+###### This is a header
+
+# Header
+^
+# Header
+
+##Header   #####
+> blockquote
+
+###### header 
+paragraph
+
+> blockquote
+### not a header
+
+### Header {#id}
+
+### Header ## {#id}
+
+### Header{#noid}
+
+### Header ##{#noid}
+
+### Last