RubyGems - pseudohikiparser - Versions diffs - 0.0.3 → 0.0.4.develop - Mend

pseudohikiparser 0.0.3 → 0.0.4.develop

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +4 -4
data/README.ja.md +132 -8
data/README.md +134 -10
data/lib/htmlelement.rb +42 -42
data/lib/pseudohiki/autolink.rb +60 -0
data/lib/pseudohiki/blockparser.rb +233 -125
data/lib/pseudohiki/converter.rb +140 -81
data/lib/pseudohiki/htmlformat.rb +156 -82
data/lib/pseudohiki/htmlplugin.rb +9 -28
data/lib/pseudohiki/inlineparser.rb +21 -24
data/lib/pseudohiki/markdownformat.rb +94 -98
data/lib/pseudohiki/plaintextformat.rb +67 -57
data/lib/pseudohiki/sinatra_helpers.rb +23 -0
data/lib/pseudohiki/treestack.rb +4 -4
data/lib/pseudohiki/utils.rb +1 -2
data/lib/pseudohiki/version.rb +1 -1
data/lib/pseudohikiparser.rb +49 -28
data/test/test_autolink.rb +104 -0
data/test/test_blockparser.rb +78 -11
data/test/test_htmlformat.rb +436 -0
data/test/test_htmlplugin.rb +43 -0
data/test/test_markdownformat.rb +156 -3
data/test/test_plaintextformat.rb +85 -0
data/test/test_pseudohiki2html.rb +82 -0
data/test/test_pseudohikiparser.rb +286 -0
data/test/test_utils.rb +1 -1
metadata +22 -4

data/test/test_htmlformat.rb CHANGED Viewed

@@ -677,6 +677,20 @@ HTML
     assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
   end
+  def test_no_automatical_link_generation
+    text = <<TEXT
+a line with a url http://www.example.org/ to test an automatical link generation.
+TEXT
+    xhtml = <<HTML
+<p>
+a line with a url http://www.example.org/ to test an automatical link generation.
+</p>
+HTML
+    tree = BlockParser.parse(text.lines.to_a, AutoLink::Off)
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
   def test_automatical_link_generation_in_verbatim_blocks
     text = <<TEXT
  a line with a url http://www.example.org/ to test an automatical link generation.
@@ -696,6 +710,428 @@ HTML
     assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
   end
+  def test_no_automatical_link_generation_in_verbatim_blocks
+    text = <<TEXT
+ a line with a url http://www.example.org/ to test an automatical link generation.
+ another line with [[link|sample.html]]
+TEXT
+    xhtml = <<HTML
+<pre>
+a line with a url http://www.example.org/ to test an automatical link generation.
+</pre>
+<pre>
+another line with [[link|sample.html]]
+</pre>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    XhtmlFormat.auto_link_in_verbatim = false
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+    XhtmlFormat.auto_link_in_verbatim = true
+  end
+  def test_temporal_no_automatical_link_generation_in_verbatim_blocks
+    text = <<TEXT
+ a line with a url http://www.example.org/ to test an automatical link generation.
+ another line with [[link|sample.html]]
+TEXT
+    xhtml = <<HTML
+<pre>
+a line with a url http://www.example.org/ to test an automatical link generation.
+</pre>
+<pre>
+another line with [[link|sample.html]]
+</pre>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(xhtml, XhtmlFormat.format(tree, {:auto_link_in_verbatim => false }).to_s)
+  end
+  def test_temporal_no_automatical_link_generation_in_verbatim_blocks_with_html
+    text = <<TEXT
+ a line with a url http://www.example.org/ to test an automatical link generation.
+ another line with [[link|sample.html]]
+TEXT
+    xhtml = <<HTML
+<pre>
+a line with a url http://www.example.org/ to test an automatical link generation.
+</pre>
+<pre>
+another line with [[link|sample.html]]
+</pre>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(xhtml, HtmlFormat.format(tree, {:auto_link_in_verbatim => false }).to_s)
+  end
+  def test_decorator
+    text = <<TEXT
+//@class[section_type]
+!!title of section
+a paragraph.
+//@class[class_name]
+//@id[id_name]
+another paragraph.
+TEXT
+    xhtml = <<HTML
+<div class="section_type">
+<h2>title of section</h2>
+<p>
+a paragraph.</p>
+<p class="class_name" id="ID_NAME">
+another paragraph.</p>
+<!-- end of section_type -->
+</div>
+HTML
+    tree = BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+  def test_decorator_for_table
+    text = <<TEXT
+//@summary: Summary of the table
+||!header 1||! header 2
+||cell 1||cell 2
+TEXT
+    xhtml = <<HTML
+<table summary="Summary of the table">
+<tr><th>header 1</th><th> header 2</th></tr>
+<tr><td>cell 1</td><td>cell 2</td></tr>
+</table>
+HTML
+    tree = BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+  def test_decorator_for_verbatim
+    text = <<TEXT
+//@code[ruby]
+ def bonjour!
+   puts "Bonjour!"
+ end
+TEXT
+    xhtml = <<HTML
+<pre>
+def bonjour!
+  puts &quot;Bonjour!&quot;
+end
+</pre>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+  def test_sectioning_node
+        text = <<TEXT
+! Main title
+//@begin[header]
+!! first title in header
+paragraph
+!! second title in header
+paragraph2
+//@end[header]
+!! first subtitle in main part
+paragraph3
+//@begin[#footer]
+paragraph4
+//@end[#footer]
+TEXT
+    expected_html = <<HTML
+<div class="section h1">
+<h1> Main title
+</h1>
+<div class="header">
+<div class="section h2">
+<h2> first title in header
+</h2>
+<p>
+paragraph
+</p>
+<!-- end of section h2 -->
+</div>
+<div class="section h2">
+<h2> second title in header
+</h2>
+<p>
+paragraph2
+</p>
+<!-- end of section h2 -->
+</div>
+<!-- end of header -->
+</div>
+<div class="section h2">
+<h2> first subtitle in main part
+</h2>
+<p>
+paragraph3
+</p>
+<div class="section" id="footer">
+<p>
+paragraph4
+</p>
+<!-- end of footer -->
+</div>
+<!-- end of section h2 -->
+</div>
+<!-- end of section h1 -->
+</div>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_html, XhtmlFormat.format(tree).to_s)
+  end
+  def test_sectioning_node_for_html5
+        text = <<TEXT
+! Main title
+//@begin[header]
+!! first title in header
+paragraph
+!! second title in header
+paragraph2
+//@end[header]
+!! first subtitle in main part
+paragraph3
+//@begin[#footer]
+paragraph4
+//@end[#footer]
+TEXT
+    expected_html = <<HTML
+<section class="h1">
+<h1> Main title
+</h1>
+<header>
+<section class="h2">
+<h2> first title in header
+</h2>
+<p>
+paragraph
+</p>
+<!-- end of h2 -->
+</section>
+<section class="h2">
+<h2> second title in header
+</h2>
+<p>
+paragraph2
+</p>
+<!-- end of h2 -->
+</section>
+</header>
+<section class="h2">
+<h2> first subtitle in main part
+</h2>
+<p>
+paragraph3
+</p>
+<section id="footer">
+<p>
+paragraph4
+</p>
+<!-- end of footer -->
+</section>
+<!-- end of h2 -->
+</section>
+<!-- end of h1 -->
+</section>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_html, Xhtml5Format.format(tree).to_s)
+  end
+  def test_sectioning_node_when_end_tag_is_omitted
+        text = <<TEXT
+!! First part
+paragraph1
+//@begin[first_sub_part]
+!!! first title in first sub-part
+paragraph2
+!!! second title in first sub-part
+paragraph3
+//you should put //@end[first_sub_part] here.
+!! Second part
+paragraph4
+//@begin[#footer]
+paragraph5
+//@end[#footer]
+TEXT
+    expected_html = <<HTML
+<div class=\"section h2\">
+<h2> First part
+</h2>
+<p>
+paragraph1
+</p>
+<div class=\"section first_sub_part\">
+<div class=\"section h3\">
+<h3> first title in first sub-part
+</h3>
+<p>
+paragraph2
+</p>
+<!-- end of section h3 -->
+</div>
+<div class=\"section h3\">
+<h3> second title in first sub-part
+</h3>
+<p>
+paragraph3
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section first_sub_part -->
+</div>
+<!-- end of section h2 -->
+</div>
+<div class=\"section h2\">
+<h2> Second part
+</h2>
+<p>
+paragraph4
+</p>
+<div class=\"section\" id=\"footer\">
+<p>
+paragraph5
+</p>
+<!-- end of footer -->
+</div>
+<!-- end of section h2 -->
+</div>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_html, XhtmlFormat.format(tree).to_s)
+  end
+  def test_sectioning_node_when_end_tag_is_wrongly_placed
+        text = <<TEXT
+!! First part
+paragraph1
+//@begin[first_sub_part]
+!!! first title in first sub-part
+paragraph2
+!!! second title in first sub-part
+paragraph3
+//you should put //@end[first_sub_part] here.
+!! Second part
+paragraph4
+//@end[first_sub_part] this end tag is wrongly placed.
+//@begin[#footer]
+paragraph5
+//@end[#footer]
+TEXT
+    expected_html = <<HTML
+<div class=\"section h2\">
+<h2> First part
+</h2>
+<p>
+paragraph1
+</p>
+<div class=\"section first_sub_part\">
+<div class=\"section h3\">
+<h3> first title in first sub-part
+</h3>
+<p>
+paragraph2
+</p>
+<!-- end of section h3 -->
+</div>
+<div class=\"section h3\">
+<h3> second title in first sub-part
+</h3>
+<p>
+paragraph3
+</p>
+<!-- end of section h3 -->
+</div>
+<!-- end of section first_sub_part -->
+</div>
+<!-- end of section h2 -->
+</div>
+<div class=\"section h2\">
+<h2> Second part
+</h2>
+<p>
+paragraph4
+</p>
+<div class=\"section\" id=\"footer\">
+<p>
+paragraph5
+</p>
+<!-- end of footer -->
+</div>
+<!-- end of section h2 -->
+</div>
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_html, XhtmlFormat.format(tree).to_s)
+  end
   def test_comment_out_followed_by_a_verbatim_block
     text = <<TEXT
 the first paragraph

data/test/test_htmlplugin.rb CHANGED Viewed

@@ -23,4 +23,47 @@ class TC_HtmlPlugin < MiniTest::Unit::TestCase
     tree = InlineParser.new("you can directly embed a snippet of html code like '{{html(<i>italic</i>)}}'.").parse.tree
     assert_equal("you can directly embed a snippet of html code like '<i>italic</i>'.",tree.accept(formatter).to_s)
   end
+  def test_html
+    expected_html = '<ul>
+<li>list
+<li>list
+</ul>'
+    input = "html(
+<ul>
+<li>list
+<li>list
+</ul>)"
+    assert_equal(expected_html, HtmlPlugin.new("div", input).apply)
+  end
+  def test_inline
+    input = "inline(
+*list
+*list
+)"
+    assert_raises(ArgumentError) do
+      HtmlPlugin.new("div", input).apply
+    end
+  end
+  def test_co2
+    assert_equal("CO<sub>2</sub>", HtmlPlugin.new("div", "co2").apply)
+    assert_equal("carbon dioxide", HtmlPlugin.new("div", "co2 :en").apply)
+  end
+  def test_cubic
+    assert_equal("3km<sup>3</sup>", HtmlPlugin.new("div", "cb(3km)").apply)
+  end
+  def test_per
+    assert_equal("m<sup>-1</sup>", HtmlPlugin.new("div", "per m").apply)
+  end
+  def test_co2_isotope
+    assert_equal("<sup>18</sup>CO<sub>2</sub>", HtmlPlugin.new("div", "iso 18co2").apply)
+  end
 end

data/test/test_markdownformat.rb CHANGED Viewed

@@ -44,11 +44,11 @@ TEXT
     assert_equal(gfm_text, MarkDownFormat.format(tree, :gfm_style => true))
   end
-  def test_self_convert_to_gfm_id_format
+  def test_self_convert_into_gfm_id_format
     heading_with_non_ascii_chars = "class PseudoHiki::BlockParser"
     heading_with_multiple_spaces = "Development status of features from the original Hiki notation"
-    gfm_id_with_non_ascii_chars = MarkDownFormat.convert_to_gfm_id_format(heading_with_non_ascii_chars)
-    gfm_id_with_multiple_spaces = MarkDownFormat.convert_to_gfm_id_format(heading_with_multiple_spaces)
+    gfm_id_with_non_ascii_chars = MarkDownFormat.convert_into_gfm_id_format(heading_with_non_ascii_chars)
+    gfm_id_with_multiple_spaces = MarkDownFormat.convert_into_gfm_id_format(heading_with_multiple_spaces)
     assert_equal("class-pseudohikiblockparser", gfm_id_with_non_ascii_chars)
     assert_equal("development-status-of-features-from-the-original-hiki-notation", gfm_id_with_multiple_spaces)
   end
@@ -518,6 +518,159 @@ TEXT
     assert_equal(md_text, @formatter.format(tree).to_s)
   end
+  def test_decorator_for_verbatim
+    text = <<TEXT
+//@code[ruby]
+ def bonjour!
+   puts "Bonjour!"
+ end
+TEXT
+    gfm_text =<<TEXT
+```ruby
+def bonjour!
+  puts "Bonjour!"
+end
+```
+TEXT
+    md_text = <<TEXT
+    def bonjour!
+      puts "Bonjour!"
+    end
+TEXT
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(gfm_text, @gfm_formatter.format(tree).to_s)
+    assert_equal(md_text, @formatter.format(tree).to_s)
+  end
+  def test_decorator_for_verbatim_block
+    text = <<TEXT
+//@code[ruby]
+<<<
+def bonjour!
+  puts "Bonjour!"
+end
+>>>
+TEXT
+    gfm_text =<<TEXT
+```ruby
+def bonjour!
+  puts "Bonjour!"
+end
+```
+TEXT
+    md_text = <<TEXT
+    def bonjour!
+      puts "Bonjour!"
+    end
+TEXT
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(gfm_text, @gfm_formatter.format(tree).to_s)
+    assert_equal(md_text, @formatter.format(tree).to_s)
+  end
+  def test_without_sectioning_node
+        text = <<TEXT
+! Main title
+!! first title in header
+paragraph
+!! second title in header
+paragraph2
+!! first subtitle in main part
+paragraph3
+paragraph4
+TEXT
+    expected_text = <<HTML
+# Main title
+## first title in header
+paragraph
+## second title in header
+paragraph2
+## first subtitle in main part
+paragraph3
+paragraph4
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_text, @gfm_formatter.format(tree).to_s)
+  end
+  def test_sectioning_node
+        text = <<TEXT
+! Main title
+//@begin[header]
+!! first title in header
+paragraph
+!! second title in header
+paragraph2
+//@end[header]
+!! first subtitle in main part
+paragraph3
+//@begin[#footer]
+paragraph4
+//@end[#footer]
+TEXT
+    expected_text = <<HTML
+# Main title
+## first title in header
+paragraph
+## second title in header
+paragraph2
+## first subtitle in main part
+paragraph3
+paragraph4
+HTML
+    tree = BlockParser.parse(text.lines.to_a)
+    assert_equal(expected_text, @gfm_formatter.format(tree).to_s)
+  end
   def test_collect_headings
     text = <<TEXT
 !![main-heading] heading