kramdown 0.8.0 → 0.9.0

data/lib/kramdown/version.rb

@@ -23,6 +23,6 @@
 module Kramdown
 
   # The kramdown version.
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 
 end

data/man/man1/kramdown.1

@@ -133,23 +133,6 @@ Default: 1
 Used by: HTML converter
 
 
-.TP
-.B \-\-filter_html ARG
-
-NOTE: This option is deprecated and will be removed in a future release!
-
-An array of HTML tags that should be filtered from the output
-
-The value can either be specified as array or as a space separated
-string (which will be converted to an array). All HTML tags that are
-listed in the array will be filtered from the output, i.e. only their
-contents is used. This applies only to HTML tags found in the initial
-document.
-
-Default: []
-Used by: HTML converter
-
-
 .TP
 .B \-\-coderay_wrap ARG
 
@@ -212,6 +195,26 @@ Default: style
 Used by: HTML converter
 
 
+.TP
+.B \-\-[no\-]numeric_entities
+
+Defines whether entities are output using names or numeric values
+
+Default: false
+Used by: HTML converter, kramdown converter
+
+
+.TP
+.B \-\-toc_depth ARG
+
+Defines the maximum level of headers which will be used to generate the table of
+contents. For instance, with a value of 2, toc entries will be generated for h1
+and h2 headers but not for h3, h4, etc. A value of 0 uses all header levels.
+
+Default: 0
+Used by: HTML/Latex converter
+
+
 .SH SEE ALSO
 The kramdown website, http://kramdown.rubyforge.org/ for more information, especially on the support
 input syntax.

data/test/run_tests.rb

@@ -45,7 +45,7 @@ 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, :filter_html => [], :footnote_nr => 1}
+  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)

data/test/test_files.rb

@@ -25,6 +25,8 @@ 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
@@ -32,11 +34,13 @@ class TestFiles < Test::Unit::TestCase
     basename = text_file.sub(/\.text$/, '')
     opts_file = text_file.sub(/\.text$/, '.options')
     (Dir[basename + ".*"] - [text_file, opts_file]).each do |output_file|
-      output_format = File.extname(output_file)[1..-1]
+      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, :filter_html => [], :footnote_nr => 1}
+        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
@@ -61,7 +65,8 @@ class TestFiles < Test::Unit::TestCase
   end
 
   def tidy_output(out)
-    result = IO.popen("tidy -q -raw 2>/dev/null", 'r+') do |io|
+    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
@@ -97,4 +102,56 @@ class TestFiles < Test::Unit::TestCase
     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
+                         ]
+    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
+                            ]
+    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
+
 end

data/test/testcases/block/06_codeblock/whitespace.html

@@ -1,3 +1,3 @@
-<pre class="show-whitespaces"><code>This<span class="ws-tab">	</span>is<span class="ws-space">&sdot;</span>some<span class="ws-space-r">&sdot;</span><span class="ws-space-r">&sdot;</span>
-<span class="ws-space-l">&sdot;</span><span class="ws-space-l">&sdot;</span><span class="ws-space-l">&sdot;</span><span class="ws-space-l">&sdot;</span>whitespace<span class="ws-space-r">&sdot;</span><span class="ws-space-r">&sdot;</span>
+<pre class="show-whitespaces"><code>This<span class="ws-tab">	</span>is<span class="ws-space">&#8901;</span>some<span class="ws-space-r">&#8901;</span><span class="ws-space-r">&#8901;</span>
+<span class="ws-space-l">&#8901;</span><span class="ws-space-l">&#8901;</span><span class="ws-space-l">&#8901;</span><span class="ws-space-l">&#8901;</span>whitespace<span class="ws-space-r">&#8901;</span><span class="ws-space-r">&#8901;</span>
 </code></pre>

data/test/testcases/block/07_horizontal_rule/error.html.19

@@ -0,0 +1,7 @@
+<p>_ * _</p>
+
+<p>— * * *</p>
+
+<p>_ - *</p>
+
+<p>———————————————- test</p>

data/test/testcases/block/09_html/html_to_native/code.html

@@ -6,5 +6,5 @@ This is a <code>simple code</code> span.</p>
 <pre><code>Some very important &lt; thing
 </code></pre>
 
-<pre><code>Some code&sdot;&sdot;
+<pre><code>Some code&lt;&lt;
 </code></pre>

data/test/testcases/block/09_html/html_to_native/code.text

@@ -5,5 +5,5 @@ This is a <code>simple code</code> span.
 
 <pre>Some very important <b>&lt;</b> thing</pre>
 
-<pre><code>Some code<span>&sdot;</span>&sdot;
+<pre><code>Some code<span>&lt;</span>&lt;
 </code></pre>

data/test/testcases/block/09_html/html_to_native/table_simple.html

@@ -1,10 +1,46 @@
+<table class="examples">
+  <tbody>
+    <tr>
+      <td>Usage</td>
+      <td>Output</td>
+    </tr>
+    <tr>
+      <td>Some *data*</td>
+      <td>Some more</td>
+    </tr>
+  </tbody>
+</table>
+
+<table class="examples">
+  <thead>
+    <tr>
+      <th>Usage</th>
+      <th>Output</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>Some *data*</td>
+      <td>Some more</td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td>foot</td>
+      <td>locker</td>
+    </tr>
+  </tfoot>
+</table>
+
 <table class="examples">
   <tr>
     <th>Usage</th>
     <th>Output</th>
   </tr>
   <tr>
-    <td>Some *data*</td>
-    <td>Some more</td>
+    <td>
+Some *data*    </td>
+    <td>
+Some more    </td>
   </tr>
 </table>

data/test/testcases/block/09_html/html_to_native/table_simple.text

@@ -1,3 +1,45 @@
+<table class="examples">
+<tr>
+  <td>Usage</td>
+  <td>
+Output
+  </td>
+</tr>
+<tr>
+  <td>Some *data*</td>
+  <td>
+Some more
+  </td>
+</tr>
+</table>
+
+<table class="examples">
+<thead>
+<tr>
+  <th>Usage</th>
+  <th>
+Output
+  </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td>Some *data*</td>
+  <td>
+Some more
+  </td>
+</tr>
+</tbody>
+<tfoot>
+<tr>
+  <td>foot</td>
+  <td>
+locker
+  </td>
+</tr>
+</tfoot>
+</table>
+
 <table class="examples">
 <tr>
   <th>Usage</th>

data/test/testcases/block/09_html/html_to_native/typography.html.19

@@ -0,0 +1 @@
+<p>This is … something “to remember”!</p>

data/test/testcases/block/09_html/simple.html.19

@@ -0,0 +1,62 @@
+<div>
+  <p>test</p>
+</div>
+
+<p>
+para2
+</p>
+
+<div id="test">
+  <p>tes</p>
+
+  <p>test
+weiter
+</p>
+</div>
+
+<p>para4</p>
+
+<div>
+  <div>
+    <div>
+      <p>foo</p>
+    </div>
+    <div style="&nbsp;"></div>
+  </div>
+  <div>
+    <p>bar </p>
+  </div>
+</div>
+
+<p>para5</p>
+
+<div>
+  <p>id</p>
+</div>
+<p>test</p>
+
+<div>
+  <p>hallo</p>
+</div>
+<div>
+  <p>hallo</p>
+</div>
+
+<p>para6</p>
+
+<div>
+  <div class="clear"></div>
+  <p>Another para.</p>
+</div>
+
+<webgen:block name="test" />
+
+<some:url name:spac="hallo">doit</some:url>
+
+<p><em>Test</em></p>
+
+<p><em>Test</em></p>
+
+<p><em>Test
+</em>
+</p>

data/test/testcases/block/11_ial/simple.html

@@ -18,8 +18,9 @@
 
 <p class="cls">Some paragraph here</p>
 
-<p class="cls">Paragraph
-Paragraph</p>
+<p class="cls">Paragraph</p>
+<p>Paragraph</p>
 
 <h1 class="class" id="other">Another header</h1>
 
+

data/test/testcases/block/12_extension/comment.html

@@ -1,5 +1,6 @@
-<p>This is a simple paragraph.
-And another paragraph</p>
+<p>This is a simple paragraph.</p>
+<!-- This is a comment {:/}which is {:/comment} ignored. -->
+<p>And another paragraph</p>
 
 <p>Paragraph
 Another paragraph</p>

data/test/testcases/block/12_extension/options.html

@@ -10,9 +10,6 @@ some <span>*para*</span>
   <p>some <span><em>para</em></span></p>
 </div>
 
-
-This is some text.
-
 <p>Some text<sup id="fnref:ab"><a href="#fn:ab" rel="footnote">10</a></sup>.</p>
 
 <div class="footnotes">

data/test/testcases/block/12_extension/options.text

@@ -14,12 +14,6 @@ some <span>*para*</span>
 some <span>*para*</span>
 </div>
 
-{::options auto_ids="false" filter_html="p em" /}
-
-<p>
-This is <em>some</em> text.
-</p>
-
 {::options footnote_nr="10" /}
 
 Some text[^ab].

data/test/testcases/block/13_definition_list/item_ial.html

@@ -0,0 +1,14 @@
+<dl>
+  <dt>item</dt>
+  <dd class="cls">definition
+continued</dd>
+  <dd>another </dd>
+  <dd class="class">
+    <pre><code>code
+</code></pre>
+  </dd>
+  <dd class="cls">IAL at last
+    <pre><code>code
+</code></pre>
+  </dd>
+</dl>

data/test/testcases/block/13_definition_list/item_ial.text

@@ -0,0 +1,8 @@
+item
+:   {:.cls} definition
+    continued
+: another {:.cls}
+: {:.class}
+        code
+: {:.cls} IAL at last
+      code

data/test/testcases/block/16_toc/no_toc_depth.html

@@ -0,0 +1,33 @@
+<ul id="markdown-toc">
+  <li><a href="#header-level-1">Header level 1</a>    <ul>
+      <li><a href="#header-level-2">Header level 2</a>        <ul>
+          <li><a href="#header-level-3">Header level 3</a>            <ul>
+              <li><a href="#header-level-4">Header level 4</a></li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+  <li><a href="#other-header-level-1">Other header level 1</a>    <ul>
+      <li><a href="#other-header-level-2">Other header level 2</a>        <ul>
+          <li><a href="#other-header-level-3">Other header level 3</a></li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+</ul>
+
+<h1 id="header-level-1">Header level 1</h1>
+
+<h2 id="header-level-2">Header level 2</h2>
+
+<h3 id="header-level-3">Header level 3</h3>
+
+<h4 id="header-level-4">Header level 4</h4>
+
+<h1 id="other-header-level-1">Other header level 1</h1>
+
+<h2 id="other-header-level-2">Other header level 2</h2>
+
+<h3 id="other-header-level-3">Other header level 3</h3>