pseudohikiparser 0.0.4 → 0.0.5.develop

data/test/test_blockparser.rb

@@ -311,6 +311,73 @@ TEXT
     assert_equal([[[["heading"]]]],parsed)
   end
 
+
+  def test_decorator
+    text = <<TEXT
+//@class[section_name]
+!!title of section
+
+//@summary: Summary of the table
+||!header 1||! header 2
+||cell 1||cell 2
+
+a paragraph.
+
+//@class[class_name]
+//@[id_name]
+another paragraph.
+TEXT
+
+    tree = PseudoHiki::BlockParser.parse(text.lines.to_a.map {|line| line.chomp })
+    assert_equal(PseudoHiki::BlockParser::BlockNode, tree.class)
+    assert_equal("section_name", tree[0].decorator["class"].id)
+    assert_equal(PseudoHiki::BlockParser::BlockElement::HeadingNode, tree[0].class)
+    assert_equal([[["title of section"]], [[[["header 1"]], [[" header 2"]]], [[["cell 1"]], [["cell 2"]]]], [[["a paragraph."]]], [[["another paragraph."]]]], tree[0])
+    assert_equal([["Summary of the table"]], tree[0][1].decorator["summary"].value)
+    assert_equal(PseudoHiki::BlockParser::BlockElement::TableNode, tree[0][1].class)
+    assert_equal(nil, tree[0][2].decorator)
+    assert_equal('id_name', tree[0][3].decorator[:id].id)
+    assert_equal('class_name', tree[0][3].decorator["class"].id)
+  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
+
+TEXT
+
+    expected_tree = [[[[" Main title\n"]],
+                      [
+                       [[[" first title in header\n"]],
+                        [[["paragraph\n"]]]],
+                       [[[" second title in header\n"]],
+                        [[["paragraph2\n"]]]]
+                      ],
+                      [[[" first subtitle in main part\n"]],
+                       [[["paragraph3\n"]]]]]]
+
+
+    tree = PseudoHiki::BlockParser.parse(text)
+    assert_equal(expected_tree, tree)
+    assert_kind_of(PseudoHiki::BlockParser::BlockElement::SectioningNode, tree[0][1])
+    assert_equal("header", tree[0][1].node_id)
+  end
+
   def test_comment_out_followed_by_a_verbatim_block
     text = <<TEXT
 the first paragraph

data/test/test_data/css/test.css

@@ -0,0 +1,3 @@
+h1 {
+    margin-left: 0.5em;
+}

data/test/test_htmlelement_utils.rb

@@ -0,0 +1,200 @@
+#/usr/bin/env ruby
+
+require 'minitest/autorun'
+require 'lib/htmlelement'
+require 'lib/htmlelement/utils'
+require 'pseudohikiparser'
+
+class TC_HtmlElement_Utils_LinkManager < MiniTest::Unit::TestCase
+  def setup
+    @default_domain = "http://www.example.org/default_path"
+    @from_host_names = ["stage.example.org", "develop.example.org"]
+    @link_manager = HtmlElement::Utils::LinkManager.new(@default_domain,
+                                                        @from_host_names)
+    @link_manager_without_scheme = HtmlElement::Utils::LinkManager.new("www.example.org/default_path",
+                                                                       @from_host_names)
+    @link_manager_without_from_host_names = HtmlElement::Utils::LinkManager.new("www.example.org/default_path")
+  end
+
+  def test_unify_host_names
+    assert_equal("http://www.example.org/path1",
+                 @link_manager.unify_host_names("http://stage.example.org/path1"))
+    assert_equal("http://www.example.org/path1/path1-1",
+                 @link_manager.unify_host_names("http://develop.example.org/path1/path1-1"))
+  end
+
+  def test_unify_host_names_without_scheme
+    assert_equal("http://www.example.org/path1",
+                 @link_manager_without_scheme.unify_host_names("http://stage.example.org/path1"))
+    assert_equal("http://www.example.org/path1/path1-1",
+                 @link_manager_without_scheme.unify_host_names("http://develop.example.org/path1/path1-1"))
+  end
+
+  def test_unify_host_names_without_from_host_names
+    assert_equal("http://stage.example.org/path1",
+                 @link_manager_without_from_host_names.unify_host_names("http://stage.example.org/path1"))
+    assert_equal("http://develop.example.org/path1/path1-1",
+                 @link_manager_without_from_host_names.unify_host_names("http://develop.example.org/path1/path1-1"))
+  end
+
+  def test_convert_to_relative_path
+    assert_equal("../path1", @link_manager.convert_to_relative_path("http://www.example.org/path1"))
+    assert_equal("../path1/path1-1/",
+                 @link_manager.convert_to_relative_path("http://www.example.org/path1/path1-1/"))
+    assert_equal("./",
+                 @link_manager.convert_to_relative_path(@default_domain + "/"))
+    assert_equal("./",
+                 @link_manager.convert_to_relative_path(@default_domain))
+  end
+
+  def test_external_link?
+    assert(@link_manager.external_link?("http://www.example.com"), "In a different domain")
+    refute(@link_manager.external_link?("https://www.example.org/path2"), "In the same domain")
+  end
+
+  def test_collect_elements_by_name
+    hiki_text = <<TEXT
+!! Sample data with links
+
+*[[Default path|http://www.example.org/default_path/]]
+*[[Default index|http://www.example.org/default_path/index.html]]
+*[[Path for staging server|http://stage.example.org/path1/path1-1/index.html]]
+TEXT
+
+    expected_html = <<HTML
+<div class="section h2">
+<h2> Sample data with links
+</h2>
+<ul>
+<li><a href="./">Default path</a>
+</li>
+<li><a href="index.html">Default index</a>
+</li>
+<li><a href="../path1/path1-1/index.html">Path for staging server</a>
+</li>
+</ul>
+<!-- end of section h2 -->
+</div>
+HTML
+
+    html_str = PseudoHiki::Format.to_xhtml(hiki_text) do |html|
+      links = HtmlElement::Utils.collect_elements_by_name(html, "a".freeze)
+      links.each do |a|
+        href = a["href"]
+        href = @link_manager.unify_host_names(href)
+        href = @link_manager.convert_to_relative_path(href)
+        a["href"] = href
+      end
+    end
+
+    assert_equal(expected_html, html_str)
+  end
+
+  def test_use_relative_path_for_in_domain_links
+    hiki_text = <<TEXT
+!! Sample data with links
+
+*[[Default path|http://www.example.org/default_path/]]
+*[[Default index|http://www.example.org/default_path/index.html]]
+*[[Path for staging server|http://stage.example.org/path1/path1-1/index.html]]
+TEXT
+
+    expected_html = <<HTML
+<div class="section h2">
+<h2> Sample data with links
+</h2>
+<ul>
+<li><a href="./">Default path</a>
+</li>
+<li><a href="index.html">Default index</a>
+</li>
+<li><a href="../path1/path1-1/index.html">Path for staging server</a>
+</li>
+</ul>
+<!-- end of section h2 -->
+</div>
+HTML
+
+    html_str = PseudoHiki::Format.to_xhtml(hiki_text) do |html|
+      @link_manager.use_relative_path_for_in_domain_links(html).to_s
+    end
+
+    assert_equal(expected_html, html_str)
+  end
+end
+
+class TC_HtmlElement_Utils_TableManager < MiniTest::Unit::TestCase
+  def setup
+    table_with_row_header_text = <<TABLE
+||!header1||!header2||!header3
+||row1-1||row1-2||row1-3
+||row2-1||row2-2||row2-3
+TABLE
+
+table_with_col_header_text = <<TABLE
+||!header1||col1-1||col2-1
+||!header2||col1-2||col2-2
+||!header3||col1-3||col2-3
+TABLE
+
+table_with_row_header_and_caption_text = <<TABLE
+//@caption: Caption
+||!header1||!header2||!header3
+||row1-1||row1-2||row1-3
+||row2-1||row2-2||row2-3
+TABLE
+
+    @table_manager = HtmlElement::Utils::TableManager.new
+    @table_with_row_header = PseudoHiki::BlockParser.parse(table_with_row_header_text)
+    @table_with_col_header = PseudoHiki::BlockParser.parse(table_with_col_header_text)
+    @table_with_row_header_and_caption = PseudoHiki::BlockParser.parse(table_with_row_header_and_caption_text)
+
+  end
+
+  def test_guess_header_scope
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_row_header)[0]
+    assert_equal("col", @table_manager.guess_header_scope(html_table))
+
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_col_header)[0]
+    assert_equal("row", @table_manager.guess_header_scope(html_table))
+
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_row_header_and_caption)[0]
+    assert_equal("col", @table_manager.guess_header_scope(html_table))
+  end
+
+  def test_assign_scope
+col_scope_table = <<TABLE
+<table>
+<tr><th scope="col">header1</th><th scope="col">header2</th><th scope="col">header3
+</th></tr>
+<tr><td>row1-1</td><td>row1-2</td><td>row1-3
+</td></tr>
+<tr><td>row2-1</td><td>row2-2</td><td>row2-3
+</td></tr>
+</table>
+TABLE
+
+row_scope_table = <<TABLE
+<table>
+<tr><th scope="row">header1</th><td>col1-1</td><td>col2-1
+</td></tr>
+<tr><th scope="row">header2</th><td>col1-2</td><td>col2-2
+</td></tr>
+<tr><th scope="row">header3</th><td>col1-3</td><td>col2-3
+</td></tr>
+</table>
+TABLE
+
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_row_header)[0]
+    @table_manager.assign_scope(html_table)
+    assert_equal(col_scope_table, html_table.to_s)
+
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_col_header)[0]
+    @table_manager.assign_scope(html_table)
+    assert_equal(row_scope_table, html_table.to_s)
+
+    html_table = PseudoHiki::HtmlFormat.format(@table_with_row_header)[0]
+    HtmlElement::Utils::TableManager.assign_scope(html_table)
+    assert_equal(col_scope_table, html_table.to_s)
+  end
+end

data/test/test_htmlformat.rb

@@ -122,6 +122,8 @@ a paragraph with a normal [[link|http://www.example.org/]]
 a paragraph with an [[image|http://www.example.org/image.png]]
 
 a paragraph with a link to an image from [[[[a thumbnail image|image/thumb_nail.png]]|http://www.example.org/image.png]]
+
+an img element with an empty alt attribute: [[|http://www.example.org/image.png]]
 TEXT
 
     html = <<HTML
@@ -135,6 +137,10 @@ a paragraph with an <img alt="image" src="http://www.example.org/image.png">
 <p>
 a paragraph with a link to an image from <a href="http://www.example.org/image.png"><img alt="a thumbnail image" src="image/thumb_nail.png">
 </a>
+</p>
+<p>
+an img element with an empty alt attribute: <img alt="" src="http://www.example.org/image.png">
+
 </p>
 HTML
 
@@ -769,6 +775,419 @@ HTML
     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_table_summary
+    text = <<TEXT
+//@summary: Summary of the table
+||!header 1||! header 2
+TEXT
+
+    xhtml = <<HTML
+<table summary="Summary of the table">
+<tr><th>header 1</th><th> header 2
+</th></tr>
+</table>
+HTML
+    tree = BlockParser.parse(text.lines.to_a.map {|line| line })
+    assert_equal(xhtml, XhtmlFormat.format(tree).to_s)
+  end
+
+  def test_decorator_for_table_caption
+    text = <<TEXT
+//@caption: Caption of ''the table''
+||!header 1||! header 2
+||cell 1||cell 2
+TEXT
+
+    xhtml = <<HTML
+<table>
+<caption>Caption of <em>the table</em></caption>
+<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_table_caption_with_tags
+    text = <<TEXT
+//@caption: [[''Table caption''that begins with a link|http://www.example.org/]] and contains other strings
+||!header 1||! header 2
+TEXT
+
+    xhtml = <<HTML
+<table>
+<caption><a href="http://www.example.org/"><em>Table caption</em>that begins with a link</a> and contains other strings</caption>
+<tr><th>header 1</th><th> header 2</th></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