kramdown 1.12.0 → 1.13.0

data/test/test_files.rb

@@ -82,6 +82,7 @@ class TestFiles < Minitest::Test
                           'test/testcases/span/math/mathjaxnode.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
@@ -241,6 +242,7 @@ class TestFiles < Minitest::Test
                              'test/testcases/span/math/mathjaxnode.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/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
@@ -261,12 +263,23 @@ class TestFiles < Minitest::Test
     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_GFM_FILES = [
                        'test/testcases/block/03_paragraph/no_newline_at_end.text',
                        'test/testcases/block/03_paragraph/indented.text',
                        'test/testcases/block/03_paragraph/two_para.text',
                        'test/testcases/block/04_header/atx_header.text',
                        'test/testcases/block/04_header/setext_header.text',
+                       'test/testcases/block/04_header/with_auto_ids.text', # bc of ID generation difference
+                       'test/testcases/block/04_header/with_auto_id_prefix.text', # bc of ID generation difference
                        'test/testcases/block/05_blockquote/indented.text',
                        'test/testcases/block/05_blockquote/lazy.text',
                        'test/testcases/block/05_blockquote/nested.text',
@@ -280,6 +293,7 @@ class TestFiles < Minitest::Test
                        'test/testcases/block/08_list/other_first_element.text',
                        'test/testcases/block/08_list/simple_ul.text',
                        'test/testcases/block/08_list/special_cases.text',
+                       'test/testcases/block/08_list/lazy_and_nested.text', # bc of change in lazy line handling
                        'test/testcases/block/09_html/comment.text',
                        'test/testcases/block/09_html/html_to_native/code.text',
                        'test/testcases/block/09_html/html_to_native/emphasis.text',
@@ -298,6 +312,7 @@ class TestFiles < Minitest::Test
                        'test/testcases/block/14_table/escaping.text',
                        'test/testcases/block/14_table/simple.text',
                        'test/testcases/block/15_math/normal.text',
+                       'test/testcases/block/16_toc/toc_with_footnotes.text', # bc of ID generation difference
                        'test/testcases/encoding.text',
                        'test/testcases/span/01_link/inline.text',
                        'test/testcases/span/01_link/link_defs.text',

data/test/testcases/block/08_list/lazy_and_nested.html

@@ -0,0 +1,9 @@
+<ol>
+  <li>Root level
+  * Second level
+    <ul>
+      <li>Third level
+      * Back to second level</li>
+    </ul>
+  </li>
+</ol>

data/test/testcases/block/08_list/lazy_and_nested.text

@@ -0,0 +1,4 @@
+1. Root level
+  * Second level
+    * Third level
+  * Back to second level

data/test/testcases/block/14_table/header.html

@@ -94,3 +94,24 @@
     </tr>
   </tbody>
 </table>
+
+<p>Sep line with tab</p>
+
+<table>
+  <thead>
+    <tr>
+      <th style="text-align: right">right</th>
+      <th style="text-align: center">center</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td style="text-align: right">cell1</td>
+      <td style="text-align: center">cell2</td>
+    </tr>
+    <tr>
+      <td style="text-align: right">cell3</td>
+      <td style="text-align: center">cell4</td>
+    </tr>
+  </tbody>
+</table>

data/test/testcases/block/14_table/header.text

@@ -30,3 +30,10 @@ Multiple bodies
 | cell3 | cell4
 |----|||
 | cell5 | cell6
+
+Sep line with tab
+
+right | center
+---:  	|	:---:
+cell1 | cell2
+cell3 | cell4

data/test/testcases/block/15_math/mathjax_preview_as_code.html

@@ -0,0 +1,4 @@
+<p>This is a <code class="MathJax_Preview">5 + 5</code><script type="math/tex">5 + 5</script> statement</p>
+
+<pre class="MathJax_Preview"><code>5 + 5</code></pre>
+<script type="math/tex; mode=display">5 + 5</script>

data/test/testcases/block/15_math/mathjax_preview_as_code.options

@@ -0,0 +1,3 @@
+:math_engine_opts:
+  :preview: true
+  :preview_as_code: true

data/test/testcases/block/15_math/mathjax_preview_as_code.text

@@ -0,0 +1,5 @@
+This is a $$5 + 5$$ statement
+
+$$
+5 + 5
+$$

data/test/testcases/man/example.man

@@ -0,0 +1,123 @@
+.\" generated by kramdown
+.TH "NAME" "1" "November 2016" "Some extra data"
+.SH NAME
+name \- description
+.SH "SYNOPSIS"
+\fBname\fP [\fBOPTIONS\fP] \fIarguments\fP\.\.\.
+.SH "DESCRIPTION"
+This is a normal paragraph\.
+.sp
+.PD 0
+.IP \(bu 4
+A
+.IP \(bu 4
+compact
+.IP \(bu 4
+list
+.IP \(bu 4
+with multiple 
+.RS
+.IP \(bu 4
+items and 
+.RS
+.IP \(bu 4
+nested
+.RE
+.RE
+.IP \(bu 4
+as well
+.PD
+.RS
+.P
+blockquotes are fine
+.IP 1. 4
+numbered lists
+.IP 2. 4
+work too 
+.RS
+.IP 1. 4
+and they
+.IP 2. 4
+can be 
+.RS
+.IP 1. 4
+nested
+.RE
+.RE
+.IP 3. 4
+again
+.RE
+.sp
+.RS 4
+.EX
+Some fancy code
+   going
+     on
+       here
+.EE
+.RE
+.TP
+\fB\-o\fP
+.TQ
+\fB\-\-option\fP
+Description lists
+.sp
+are useful as well
+.P
+And compact definition lists:
+.sp
+.PD 0
+.TP
+\fBo\fP
+Option
+.TP
+\fBk\fP
+Key
+.TP
+\fBv\fP
+Value
+.PD
+.TS
+box center ;
+l l l l .
+tables	can	be	centered	
+.TE
+.sp
+.TS
+box ;
+lb lb cb rb .
+Default aligned	Left aligned	Center aligned	Right aligned	
+=
+.T&
+l l c r .
+First body part	Second cell	Third cell	fourth cell	
+Second \fIline\fP	foo	\fBstrong\fP	baz	
+Third line	\fBquux\fP	baz	bar	
+_
+.T&
+l l c r .
+Second body				
+2nd line				
+=
+Footer row one				
+Footer row two				
+.TE
+.sp
+.P
+Inline formatting like \fIemphasis\fP, \fBstrong\fP and \fBcode span\fP work as ususal\. 
+.UR are_well\.html
+Links
+.UE
+work, too! As do
+.br
+line breaks\.
+.P
+Abbreviations like MD can be used but the abbreviation title is ignored\.
+.P
+Math elements work \fB\el = 5\fP inline and in block form:
+.sp
+.RS 4
+.EX
+\elambda_5 = \ealpha + 4
+.EE
+.RE

data/test/testcases/man/example.text

@@ -0,0 +1,85 @@
+# name(1) - description
+{: data-date="November 2016" data-extra="Some extra data"}
+
+## SYNOPSIS
+
+`name` \[`OPTIONS`\] *arguments*...
+
+## DESCRIPTION
+
+This is a normal paragraph.
+
+* A
+* compact
+* list
+* with multiple
+  * items and
+    * nested
+* as well
+{:.compact}
+
+> blockquotes are fine
+>
+> 1. numbered lists
+>
+> 2. work too
+>    1. and they
+>    2. can be
+>       1. nested
+>
+> 3. again
+
+~~~
+Some fancy code
+   going
+     on
+       here
+~~~
+
+`-o`
+`--option`
+: Description lists
+: are useful as well
+
+And compact definition lists:
+
+`o`
+: Option
+
+`k`
+: Key
+
+`v`
+: Value
+{:.compact}
+
+| tables | can | be | centered |
+{:.center}
+
+|-----------------+------------+-----------------+----------------|
+| Default aligned |Left aligned| Center aligned  | Right aligned  |
+|-----------------|:-----------|:---------------:|---------------:|
+| First body part |Second cell | Third cell      | fourth cell    |
+| Second *line*   |foo         | **strong**      | baz            |
+| Third line      |`quux`      | baz             | bar            |
+|-----------------+------------+-----------------+----------------|
+| Second body     |            |                 |                |
+| 2nd line        |            |                 |                |
+|=================+============+=================+================|
+| Footer row one  |            |                 |                |
+| Footer row two  |            |                 |                |
+|-----------------+------------+-----------------+----------------|
+
+
+Inline formatting like *emphasis*, **strong** and `code span` work
+as ususal. [Links](are_well.html) work, too! As do\\
+line breaks.
+
+Abbreviations like MD can be used but the abbreviation title is
+ignored.
+
+*[MD]: Markdown
+
+Math elements work $$\l = 5$$ inline and in block form:
+
+$$\lambda_5 = \alpha + 4$$

data/test/testcases/man/heading-name-dash-description.man

@@ -0,0 +1,4 @@
+.\" generated by kramdown
+.TH "NAME" "7"
+.SH NAME
+name \- description

data/test/testcases/man/heading-name-dash-description.text

@@ -0,0 +1 @@
+# name -- description

data/test/testcases/man/heading-name-description.man

@@ -0,0 +1,4 @@
+.\" generated by kramdown
+.TH "NAME" "1" "November 2016" "Something extra"
+.SH NAME
+name \- description

data/test/testcases/man/heading-name-description.text

@@ -0,0 +1,2 @@
+# name description
+{: data-section="1" data-date="November 2016" data-extra="Something extra"}

data/test/testcases/man/heading-name-section-description.man

@@ -0,0 +1,4 @@
+.\" generated by kramdown
+.TH "NAME" "1"
+.SH NAME
+name \- description

data/test/testcases/man/heading-name-section-description.text

@@ -0,0 +1 @@
+# name(1) -- description

data/test/testcases/man/heading-name-section.man

@@ -0,0 +1,2 @@
+.\" generated by kramdown
+.TH "NAME" "1"

data/test/testcases/man/heading-name-section.text

@@ -0,0 +1 @@
+# name(1)

data/test/testcases/man/heading-name.man

@@ -0,0 +1,2 @@
+.\" generated by kramdown
+.TH "NAME" "7"

data/test/testcases/man/heading-name.text

@@ -0,0 +1 @@
+# name

data/test/testcases/man/sections.man

@@ -0,0 +1,4 @@
+.\" generated by kramdown
+.SH "NAME"
+works
+.SS "Sub section"

data/test/testcases/man/sections.text

@@ -0,0 +1,11 @@
+## NAME
+
+works
+
+### Sub section
+
+#### Ignored
+
+##### Ignored
+
+###### Ignored

data/test/testcases/man/text-escaping.man

@@ -0,0 +1,8 @@
+.\" generated by kramdown
+\&\. at the start of the line
+.P
+line with \efB backslash symbol
+.P
+some \. other \- escaped \' symbols
+.P
+\&\.

data/test/testcases/man/text-escaping.text

@@ -0,0 +1,7 @@
+. at the start of the line
+
+line with \fB backslash symbol
+
+some . other - escaped \' symbols
+
+.

data/test/testcases/span/text_substitutions/typography.html

@@ -36,3 +36,5 @@ Mark’s name. “…you”
 <p>This: &ldquo;&hellip;some Text&rdquo;</p>
 
 <p>This: &ldquo;&hellip; some Text&rdquo;</p>
+
+<p>&rdquo;[foo]&rdquo; &ldquo;[foo]&rdquo; d &ldquo;[foo]&rdquo;</p>

data/test/testcases/span/text_substitutions/typography.text

@@ -36,3 +36,5 @@ Nam liber tempor
 This: "...some Text"
 
 This: "... some Text"
+
+"\[foo]" "\[foo]" d "\[foo]"

data/test/testcases_gfm/codeblock_fenced.html

@@ -0,0 +1,20 @@
+<p>normal</p>
+
+<pre><code class="language-ruby">require 'kramdown'
+
+Kramdown::Document.new(text).to_html
+</code></pre>
+
+<p>indent with tab</p>
+
+<pre><code>```ruby
+require 'kramdown'
+
+Kramdown::Document.new(text).to_html
+```
+</code></pre>
+
+<p>indent with 2 spaces</p>
+
+<pre><code class="language-js">  console.log("hello");
+</code></pre>