asciidoctor 0.0.9 → 0.1.0

data/test/substitutions_test.rb

@@ -331,6 +331,228 @@ context 'Substitutions' do
       para = block_from_string('image:tiger.png[Tiger, link="http://en.wikipedia.org/wiki/Tiger"]')
       assert_equal %{<span class="image">\n  <a class="image" href="http://en.wikipedia.org/wiki/Tiger"><img src="tiger.png" alt="Tiger"></a>\n</span>}, para.sub_macros(para.buffer.join)
     end
+
+    test 'a single-line footnote macro should be registered and rendered as a footnote' do
+      para = block_from_string('Sentence text footnote:[An example footnote.].')
+      assert_equal %(Sentence text <span class="footnote">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote = para.document.references[:footnotes].first
+      assert_equal 1, footnote.index
+      assert footnote.id.nil?
+      assert_equal 'An example footnote.', footnote.text
+    end
+
+    test 'a multi-line footnote macro should be registered and rendered as a footnote' do
+      para = block_from_string("Sentence text footnote:[An example footnote\nwith wrapped text.].")
+      assert_equal %(Sentence text <span class="footnote">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote = para.document.references[:footnotes].first
+      assert_equal 1, footnote.index
+      assert footnote.id.nil?
+      assert_equal "An example footnote\nwith wrapped text.", footnote.text
+    end
+
+    test 'a footnote macro can be directly adjacent to preceding word' do
+      para = block_from_string('Sentence textfootnote:[An example footnote.].')
+      assert_equal %(Sentence text<span class="footnote">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+    end
+
+    test 'a footnote macro may contain a macro' do
+      para = block_from_string('Share your code. footnote:[http://github.com[GitHub]]')
+      assert_equal %(Share your code. <span class="footnote">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote1 = para.document.references[:footnotes][0]
+      assert_equal '<a href="http://github.com">GitHub</a>', footnote1.text
+    end
+
+    test 'should increment index of subsequent footnote macros' do
+      para = block_from_string("Sentence text footnote:[An example footnote.]. Sentence text footnote:[Another footnote.].")
+      assert_equal %(Sentence text <span class="footnote">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>. Sentence text <span class="footnote">[<a id="_footnoteref_2" href="#_footnote_2" title="View footnote." class="footnote">2</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 2, para.document.references[:footnotes].size
+      footnote1 = para.document.references[:footnotes][0]
+      assert_equal 1, footnote1.index
+      assert footnote1.id.nil?
+      assert_equal "An example footnote.", footnote1.text
+      footnote2 = para.document.references[:footnotes][1]
+      assert_equal 2, footnote2.index
+      assert footnote2.id.nil?
+      assert_equal "Another footnote.", footnote2.text
+    end
+
+    test 'a footnoteref macro with id and single-line text should be registered and rendered as a footnote' do
+      para = block_from_string('Sentence text footnoteref:[ex1, An example footnote.].')
+      assert_equal %(Sentence text <span class="footnote" id="_footnote_ex1">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote = para.document.references[:footnotes].first
+      assert_equal 1, footnote.index
+      assert_equal 'ex1', footnote.id
+      assert_equal 'An example footnote.', footnote.text
+    end
+
+    test 'a footnoteref macro with id and multi-line text should be registered and rendered as a footnote' do
+      para = block_from_string("Sentence text footnoteref:[ex1, An example footnote\nwith wrapped text.].")
+      assert_equal %(Sentence text <span class="footnote" id="_footnote_ex1">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote = para.document.references[:footnotes].first
+      assert_equal 1, footnote.index
+      assert_equal 'ex1', footnote.id
+      assert_equal "An example footnote\nwith wrapped text.", footnote.text
+    end
+
+    test 'a footnoteref macro with id should refer to footnoteref with same id' do
+      para = block_from_string('Sentence text footnoteref:[ex1, An example footnote.]. Sentence text footnoteref:[ex1].')
+      assert_equal %(Sentence text <span class="footnote" id="_footnote_ex1">[<a id="_footnoteref_1" href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>. Sentence text <span class="footnoteref">[<a href="#_footnote_1" title="View footnote." class="footnote">1</a>]</span>.), para.sub_macros(para.buffer.join)
+      assert_equal 1, para.document.references[:footnotes].size
+      footnote = para.document.references[:footnotes].first
+      assert_equal 1, footnote.index
+      assert_equal 'ex1', footnote.id
+      assert_equal 'An example footnote.', footnote.text
+    end
+
+    test 'a single-line index term macro with a primary term should be registered as an index reference' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macros = ['indexterm:[Tigers]', '(((Tigers)))']
+      macros.each do |macro|
+        para = block_from_string("#{sentence}#{macro}")
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['Tigers'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'a single-line index term macro with primary and secondary terms should be registered as an index reference' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macros = ['indexterm:[Big cats, Tigers]', '(((Big cats, Tigers)))']
+      macros.each do |macro|
+        para = block_from_string("#{sentence}#{macro}")
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['Big cats', 'Tigers'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'a single-line index term macro with primary, secondary and tertiary terms should be registered as an index reference' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macros = ['indexterm:[Big cats,Tigers , Panthera tigris]', '(((Big cats,Tigers , Panthera tigris)))']
+      macros.each do |macro|
+        para = block_from_string("#{sentence}#{macro}")
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['Big cats', 'Tigers', 'Panthera tigris'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'a multi-line index term macro should be compacted and registered as an index reference' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macros = ["indexterm:[Panthera\ntigris]", "(((Panthera\ntigris)))"]
+      macros.each do |macro|
+        para = block_from_string("#{sentence}#{macro}")
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['Panthera tigris'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'normal substitutions are performed on an index term macro' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macros = ['indexterm:[*Tigers*]', '(((*Tigers*)))']
+      macros.each do |macro|
+        para = block_from_string("#{sentence}#{macro}")
+        output = para.apply_normal_subs(para.buffer)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['<strong>Tigers</strong>'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'registers multiple index term macros' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species."
+      macros = "(((Tigers)))\n(((Animals,Cats)))"
+      para = block_from_string("#{sentence}\n#{macros}")
+      output = para.sub_macros(para.buffer.join)
+      assert_equal sentence, output.rstrip
+      assert_equal 2, para.document.references[:indexterms].size
+      assert_equal ['Tigers'], para.document.references[:indexterms][0]
+      assert_equal ['Animals', 'Cats'], para.document.references[:indexterms][1]
+    end
+
+    test 'an index term macro with round bracket syntax may contain round brackets in term' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macro = '(((Tiger (Panthera tigris))))'
+      para = block_from_string("#{sentence}#{macro}")
+      output = para.sub_macros(para.buffer.join)
+      assert_equal sentence, output
+      assert_equal 1, para.document.references[:indexterms].size
+      assert_equal ['Tiger (Panthera tigris)'], para.document.references[:indexterms].first
+    end
+
+    test 'an index term macro with square bracket syntax may contain square brackets in term' do
+      sentence = "The tiger (Panthera tigris) is the largest cat species.\n"
+      macro = 'indexterm:[Tiger [Panthera tigris\\]]'
+      para = block_from_string("#{sentence}#{macro}")
+      output = para.sub_macros(para.buffer.join)
+      assert_equal sentence, output
+      assert_equal 1, para.document.references[:indexterms].size
+      assert_equal ['Tiger [Panthera tigris]'], para.document.references[:indexterms].first
+    end
+
+    test 'a single-line index term 2 macro should be registered as an index reference and retain term inline' do
+      sentence = 'The tiger (Panthera tigris) is the largest cat species.'
+      macros = ['The indexterm2:[tiger] (Panthera tigris) is the largest cat species.', 'The ((tiger)) (Panthera tigris) is the largest cat species.']
+      macros.each do |macro|
+        para = block_from_string(macro)
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['tiger'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'a multi-line index term 2 macro should be compacted and registered as an index reference and retain term inline' do
+      sentence = 'The panthera tigris is the largest cat species.'
+      macros = ["The indexterm2:[ panthera\ntigris ] is the largest cat species.", "The (( panthera\ntigris )) is the largest cat species."]
+      macros.each do |macro|
+        para = block_from_string(macro)
+        output = para.sub_macros(para.buffer.join)
+        assert_equal sentence, output
+        assert_equal 1, para.document.references[:indexterms].size
+        assert_equal ['panthera tigris'], para.document.references[:indexterms].first
+      end
+    end
+
+    test 'registers multiple index term 2 macros' do
+      sentence = "The ((tiger)) (Panthera tigris) is the largest ((cat)) species."
+      para = block_from_string(sentence)
+      output = para.sub_macros(para.buffer.join)
+      assert_equal 'The tiger (Panthera tigris) is the largest cat species.', output
+      assert_equal 2, para.document.references[:indexterms].size
+      assert_equal ['tiger'], para.document.references[:indexterms][0]
+      assert_equal ['cat'], para.document.references[:indexterms][1]
+    end
+
+    test 'normal substitutions are performed on an index term 2 macro' do
+      sentence = 'The ((*tiger*)) (Panthera tigris) is the largest cat species.'
+      para = block_from_string sentence
+      output = para.apply_normal_subs(para.buffer)
+      assert_equal 'The <strong>tiger</strong> (Panthera tigris) is the largest cat species.', output
+      assert_equal 1, para.document.references[:indexterms].size
+      assert_equal ['<strong>tiger</strong>'], para.document.references[:indexterms].first
+    end
+
+    test 'index term 2 macro with round bracket syntex should not interfer with index term macro with round bracket syntax' do
+      sentence = "The ((panthera tigris)) is the largest cat species.\n(((Big cats,Tigers)))"
+      para = block_from_string sentence
+      output = para.sub_macros(para.buffer.join)
+      assert_equal "The panthera tigris is the largest cat species.\n", output
+      terms = para.document.references[:indexterms]
+      assert_equal 2, terms.size
+      assert_equal ['Big cats', 'Tigers'], terms[0]
+      assert_equal ['panthera tigris'], terms[1]
+    end
   end
 
   context 'Passthroughs' do
@@ -388,27 +610,47 @@ context 'Substitutions' do
       assert_equal [:specialcharacters, :quotes], para.passthroughs.first[:subs]
     end
 
+    # NOTE placeholder is surrounded by text to prevent reader from stripping trailing boundary char (unique to test scenario)
     test 'restore inline passthroughs without subs' do
-      para = block_from_string("\x0" + '0' + "\x0")
+      para = block_from_string("some \x0" + '0' + "\x0 to study")
       para.passthroughs << {:text => '<code>inline code</code>', :subs => []}
       result = para.restore_passthroughs(para.buffer.join)
-      assert_equal '<code>inline code</code>', result
+      assert_equal "some <code>inline code</code> to study", result
     end
 
+    # NOTE placeholder is surrounded by text to prevent reader from stripping trailing boundary char (unique to test scenario)
     # TODO add two entries to ensure index lookup is working correctly (0 indx could be ambiguous)
     test 'restore inline passthroughs with subs' do
-      para = block_from_string("\x0" + '0' + "\x0")
+      para = block_from_string("some \x0" + '0' + "\x0 to study")
       para.passthroughs << {:text => '<code>{code}</code>', :subs => [:specialcharacters]}
       result = para.restore_passthroughs(para.buffer.join)
-      assert_equal '&lt;code&gt;{code}&lt;/code&gt;', result
+      assert_equal 'some &lt;code&gt;{code}&lt;/code&gt; to study', result
     end
   end
 
   context 'Post replacements' do
-    test 'line break' do
+    test 'line break inserted after line with line break character' do
       para = block_from_string("First line +\nSecond line")
       result = para.apply_subs(para.buffer, :post_replacements)
       assert_equal "First line<br>\n", result.first
     end
+
+    test 'line break inserted after line wrap with hardbreaks enabled' do
+      para = block_from_string("First line\nSecond line", :attributes => {'hardbreaks' => ''})
+      result = para.apply_subs(para.buffer, :post_replacements)
+      assert_equal "First line<br>\n", result.first
+    end
+
+    test 'line break character stripped from end of line with hardbreaks enabled' do
+      para = block_from_string("First line +\nSecond line", :attributes => {'hardbreaks' => ''})
+      result = para.apply_subs(para.buffer, :post_replacements)
+      assert_equal "First line<br>\n", result.first
+    end
+
+    test 'line break not inserted for single line with hardbreaks enabled' do
+      para = block_from_string("First line", :attributes => {'hardbreaks' => ''})
+      result = para.apply_subs(para.buffer, :post_replacements)
+      assert_equal "First line", result.first
+    end
   end
 end

data/test/tables_test.rb

@@ -39,7 +39,7 @@ context 'Tables' do
 |=======
       EOS
       output = render_embedded_string input
-      assert_xpath '/table/caption[@class="title"][text()="Simple psv table"]', output, 1
+      assert_xpath '/table/caption[@class="title"][text()="Table 1. Simple psv table"]', output, 1
       assert_xpath '/table/caption/following-sibling::colgroup', output, 1
     end
 
@@ -58,6 +58,23 @@ context 'Tables' do
       assert_xpath '/table/tbody/tr/td[2]/p[text()="a | there"]', output, 1
     end
 
+    test 'should auto recover with warning if missing leading separator on first cell' do
+      input = <<-EOS
+|===
+A | here| a | there
+|===
+      EOS
+      output = render_embedded_string input
+      assert_css 'table', output, 1
+      assert_css 'table > colgroup > col', output, 4
+      assert_css 'table > tbody > tr', output, 1
+      assert_css 'table > tbody > tr > td', output, 4
+      assert_xpath '/table/tbody/tr/td[1]/p[text()="A"]', output, 1
+      assert_xpath '/table/tbody/tr/td[2]/p[text()="here"]', output, 1
+      assert_xpath '/table/tbody/tr/td[3]/p[text()="a"]', output, 1
+      assert_xpath '/table/tbody/tr/td[4]/p[text()="there"]', output, 1
+    end
+
     test 'performs normal substitutions on cell content' do
       input = <<-EOS
 :show_title: Cool new show
@@ -217,7 +234,7 @@ I am getting in shape!
       output = render_embedded_string input
       assert_css 'table', output, 1
       assert_css 'table[style~="width: 80%;"]', output, 1
-      assert_xpath '/table/caption[@class="title"][text()="Horizontal and vertical source data"]', output, 1
+      assert_xpath '/table/caption[@class="title"][text()="Table 1. Horizontal and vertical source data"]', output, 1
       assert_css 'table > colgroup > col', output, 4
       assert_css 'table > colgroup > col:nth-child(1)[@style~="width: 17%;"]', output, 1
       assert_css 'table > colgroup > col:nth-child(2)[@style~="width: 11%;"]', output, 1
@@ -242,7 +259,7 @@ I am getting in shape!
 |1 >s|2 |3 |4
 ^|5 2.2+^.^|6 .3+<.>m|7
 ^|8
-|9 2+>|10
+d|9 2+>|10
 |===
       EOS
       output = render_embedded_string input
@@ -267,7 +284,8 @@ I am getting in shape!
 
       assert_css 'table tr:nth-child(3) > td:nth-child(1).halign-center.valign-top p em', output, 1
 
-      assert_css 'table tr:nth-child(4) > td:nth-child(1).halign-left.valign-top p em', output, 1
+      assert_css 'table tr:nth-child(4) > td:nth-child(1).halign-left.valign-top p', output, 1
+      assert_css 'table tr:nth-child(4) > td:nth-child(1).halign-left.valign-top p em', output, 0
       assert_css 'table tr:nth-child(4) > td:nth-child(2).halign-right.valign-top[colspan="2"] p tt', output, 1
     end
 

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'pathname'
 require 'test/unit'
 
 require "#{File.expand_path(File.dirname(__FILE__))}/../lib/asciidoctor.rb"
@@ -15,6 +16,14 @@ require 'pending'
 ENV['SUPPRESS_DEBUG'] ||= 'true'
 
 class Test::Unit::TestCase
+  def windows?
+    RbConfig::CONFIG['host_os'] =~ /win|ming/
+  end
+
+  def disk_root
+    "#{windows? ? File.expand_path(__FILE__).split('/').first : nil}/"
+  end
+
   def sample_doc_path(name)
     name = name.to_s
     unless name.include?('.')
@@ -29,11 +38,12 @@ class Test::Unit::TestCase
   end
 
   def fixture_path(name)
-    File.join(File.dirname(__FILE__), "fixtures", name )
+    File.join(File.expand_path(File.dirname(__FILE__)), 'fixtures', name)
   end
 
-  def example_document(name)
-    Asciidoctor::Document.new(File.readlines(sample_doc_path(name)))
+  def example_document(name, opts = {})
+    opts[:header_footer] = true unless opts.has_key?(:header_footer)
+    Asciidoctor::Document.new(File.readlines(sample_doc_path(name)), opts)
   end
 
   def assert_difference(expression, difference = 1, message = nil, &block)
@@ -111,6 +121,7 @@ class Test::Unit::TestCase
   end
 
   def document_from_string(src, opts = {})
+    opts[:header_footer] = true unless opts.has_key?(:header_footer)
     Asciidoctor::Document.new(src.lines.entries, opts)
   end
 
@@ -133,6 +144,39 @@ class Test::Unit::TestCase
     reader = Asciidoctor::Reader.new source.lines.entries
     [Asciidoctor::Lexer.parse_header_metadata(reader), reader]
   end
+
+  def invoke_cli_to_buffer(argv = [], filename = 'sample.asciidoc', &block)
+    invoke_cli(argv, filename, [StringIO.new, StringIO.new], &block)
+  end
+
+  def invoke_cli(argv = [], filename = 'sample.asciidoc', buffers = nil, &block)
+    if filename.nil? || filename == '-' || ::Pathname.new(filename).absolute?
+      filepath = filename
+    else
+      filepath = File.join(File.dirname(__FILE__), 'fixtures', filename)
+    end
+    invoker = Asciidoctor::Cli::Invoker.new(argv + [filepath])
+    if buffers
+      invoker.redirect_streams(*buffers)
+    end
+    invoker.invoke!(&block)
+    invoker
+  end
+
+  def redirect_streams
+    old_stdout = $stdout
+    old_stderr = $stderr
+    stdout = StringIO.new
+    stderr = StringIO.new
+    $stdout = stdout
+    $stderr = stderr
+    begin
+      yield(stdout, stderr)
+    ensure
+      $stdout = old_stdout
+      $stderr = old_stderr
+    end
+  end
 end
 
 ###

data/test/text_test.rb

@@ -1,12 +1,28 @@
 require 'test_helper'
 
 context "Text" do
-  test "proper encoding to handle utf8 characters in document" do
-    assert_xpath "//p", example_document(:encoding).render, 1
+  test "proper encoding to handle utf8 characters in document using html backend" do
+    output = example_document(:encoding).render
+    assert_xpath '//p', output, 2
+    assert_xpath '//a', output, 1
   end
 
-  test "proper encoding to handle utf8 characters in embedded document" do
-    assert_xpath "//p", example_document(:encoding).render(:header_footer => false), 1
+  test "proper encoding to handle utf8 characters in embedded document using html backend" do
+    output = example_document(:encoding, :header_footer => false).render
+    assert_xpath '//p', output, 2
+    assert_xpath '//a', output, 1
+  end
+
+  test "proper encoding to handle utf8 characters in document using docbook backend" do
+    output = example_document(:encoding, :attributes => {'backend' => 'docbook'}).render
+    assert_xpath '//simpara', output, 2
+    assert_xpath '//ulink', output, 1
+  end
+
+  test "proper encoding to handle utf8 characters in embedded document using docbook backend" do
+    output = example_document(:encoding, :header_footer => false, :attributes => {'backend' => 'docbook'}).render
+    assert_xpath '//simpara', output, 2
+    assert_xpath '//ulink', output, 1
   end
 
   # NOTE this test ensures we have the encoding line on block templates too