asciidoctor 1.5.5 → 1.5.6

data/test/sections_test.rb

@@ -22,10 +22,15 @@ context 'Sections' do
     end
 
     test 'synthetic id removes entities' do
-      sec = block_from_string('== Ben & Jerry & Company "Ice Cream Brothers" ✾')
+      sec = block_from_string('== Ben & Jerry & Company¹ "Ice Cream Brothers" あ')
       assert_equal '_ben_jerry_company_ice_cream_brothers', sec.id
     end
 
+    test 'synthetic id removes adjacent entities with mixed case' do
+      sec = block_from_string('== a ®&© b')
+      assert_equal '_a_b', sec.id
+    end
+
     test 'synthetic id prefix can be customized' do
       sec = block_from_string(":idprefix: id_\n\n== Section One")
       assert_equal 'id_section_one', sec.id
@@ -77,6 +82,17 @@ context 'Sections' do
       assert_equal 'Section One', sec.title
     end
 
+    test 'explicit id can be defined using an embedded anchor when using setext section titles' do
+      input = <<-EOS
+Section Title [[refid,reftext]]
+-------------------------------
+      EOS
+      sec = block_from_string input
+      assert_equal 'Section Title', sec.title
+      assert_equal 'refid', sec.id
+      assert_equal 'reftext', (sec.attr 'reftext')
+    end
+
     test 'explicit id can be defined using an embedded anchor with reftext' do
       sec = block_from_string("== Section One [[one,Section Uno]] ==")
       assert_equal 'one', sec.id
@@ -155,7 +171,7 @@ content
       EOS
 
       doc = document_from_string input
-      reftext = doc.references[:ids]['install']
+      reftext = doc.catalog[:ids]['install']
       refute_nil reftext
       assert_equal 'Install Procedure', reftext
     end
@@ -169,12 +185,28 @@ content
       EOS
 
       doc = document_from_string input
-      reftext = doc.references[:ids]['_install']
+      reftext = doc.catalog[:ids]['_install']
       refute_nil reftext
       assert_equal 'Install Procedure', reftext
     end
 
-    test 'should not overwrite existing id entry in references table' do
+    test 'should substitute attributes when registering reftext for section' do
+      input = <<-EOS
+:platform-name: Linux
+
+[[install,install on {platform-name}]]
+== Install
+
+content
+      EOS
+
+      doc = document_from_string input
+      reftext = doc.catalog[:ids]['install']
+      refute_nil reftext
+      assert_equal 'install on Linux', reftext
+    end
+
+    test 'duplicate section id should not overwrite existing section id entry in references table' do
       input = <<-EOS
 [#install]
 == First Install
@@ -187,13 +219,14 @@ content
 content
       EOS
 
-      doc = document_from_string input
-      reftext = doc.references[:ids]['install']
+      doc, warnings = redirect_streams {|_, err| [(document_from_string input), err.string]}
+      reftext = doc.catalog[:ids]['install']
       refute_nil reftext
       assert_equal 'First Install', reftext
+      assert_includes warnings, 'line 7: id assigned to section already in use: install'
     end
 
-    test 'should not overwrite existing id entry with generated reftext in references table' do
+    test 'duplicate block id should not overwrite existing section id entry in references table' do
       input = <<-EOS
 [#install]
 == First Install
@@ -204,10 +237,11 @@ content
 content
       EOS
 
-      doc = document_from_string input
-      reftext = doc.references[:ids]['install']
+      doc, warnings = redirect_streams {|_, err| [(document_from_string input), err.string] }
+      reftext = doc.catalog[:ids]['install']
       refute_nil reftext
       assert_equal 'First Install', reftext
+      assert_includes warnings, 'line 7: id assigned to block already in use: install'
     end
   end
 
@@ -275,6 +309,14 @@ preamble
       assert_xpath "//h1[not(@id)][text() = 'My Title']", render_string("= My Title =")
     end
 
+    test 'document title created from leveloffset shift defined in document' do
+      assert_xpath "//h1[not(@id)][text() = 'Document Title']", render_string(%(:leveloffset: -1\n== Document Title))
+    end
+
+    test 'document title created from leveloffset shift defined in API' do
+      assert_xpath "//h1[not(@id)][text() = 'Document Title']", render_string('== Document Title', :attributes => { 'leveloffset' => '-1@' })
+    end
+
     test 'should assign id on document title to body' do
       input = <<-EOS
 [[idname]]
@@ -343,6 +385,17 @@ content
       assert_xpath "//h2[@id='_my_section'][text() = 'My Section']", render_string("My Section\n-----------")
     end
 
+    test 'should not recognize underline containing a mix of characters' do
+      input = <<-EOS
+My Section
+----^^----
+      EOS
+
+      result = render_embedded_string input
+      assert_xpath '//h2[@id="_my_section"][text() = "My Section"]', result, 0
+      assert_includes result, '----^^----'
+    end
+
     test "heading title with multiline syntax cannot begin with a dot" do
       title = ".My Title"
       chars = "-" * title.length
@@ -362,7 +415,7 @@ content
     end
 
     test "with XML entity" do
-      assert_xpath "//h2[@id='_where_s_the_love'][text() = \"Where#{[8217].pack('U*')}s the love?\"]", render_string("== Where's the love?")
+      assert_xpath "//h2[@id='_where_s_the_love'][text() = \"Where#{decode_char 8217}s the love?\"]", render_string("== Where's the love?")
     end
 
     test "with non-word character" do
@@ -495,6 +548,15 @@ blah blah
       output = render_string input
       assert_xpath "//h2[@id='_section_one'][text() = 'Section One']", output, 1
     end
+
+    test 'should not match mixed single-line syntax' do
+      input = <<-EOS
+=#= My Title
+      EOS
+      output = render_embedded_string input
+      assert_xpath "//h3[@id='_my_title'][text() = 'My Title']", output, 0
+      assert_includes output, '<p>=#= My Title</p>'
+    end
   end
 
   context 'Floating Title' do
@@ -533,6 +595,20 @@ not in section
       assert_xpath '/h3/following-sibling::*[@class="paragraph"]/p[text()="not in section"]', output, 1
     end
 
+    test 'should generate id for floating title from converted title' do
+      input = <<-EOS
+[discrete]
+=== {sp}Heading{sp}
+
+not in section
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '/h3', output, 1
+      assert_xpath '/h3[@class="discrete"][@id="_heading"]', output, 1
+      assert_xpath '/h3[@class="discrete"][@id="_heading"][text()=" Heading "]', output, 1
+    end
+
     test 'should create floating title if style is float with shorthand role and id' do
       input = <<-EOS
 [float.independent#first]
@@ -581,7 +657,7 @@ not in section
       assert floatingtitle.context != :section
       assert_equal :floating_title, floatingtitle.context
       assert_equal '_independent_heading', floatingtitle.id
-      assert doc.references[:ids].has_key?('_independent_heading')
+      assert doc.catalog[:ids].has_key?('_independent_heading')
     end
 
     test 'can assign explicit id to floating title' do
@@ -596,7 +672,7 @@ not in section
       doc = document_from_string input
       floating_title = doc.blocks.first
       assert_equal 'unchained', floating_title.id
-      assert doc.references[:ids].has_key?('unchained')
+      assert doc.catalog[:ids].has_key?('unchained')
     end
 
     test 'should not include floating title in toc' do
@@ -660,6 +736,20 @@ not in section
       assert_xpath '/h2[@class="float isolated"]', output, 1
     end
 
+    test 'should ignore title attribute on discrete heading' do
+      input = <<-EOS
+[discrete,title="Captured!"]
+== Independent Heading!
+
+not in section
+      EOS
+
+      doc = document_from_string input
+      heading = doc.blocks[0]
+      assert_equal 'Independent Heading!', heading.title
+      refute heading.attributes.key? 'title'
+    end
+
     test 'should use specified id and reftext when registering discrete section reference' do
       input = <<-EOS
 [[install,Install Procedure]]
@@ -670,7 +760,7 @@ content
       EOS
 
       doc = document_from_string input
-      reftext = doc.references[:ids]['install']
+      reftext = doc.catalog[:ids]['install']
       refute_nil reftext
       assert_equal 'Install Procedure', reftext
     end
@@ -685,7 +775,7 @@ content
       EOS
 
       doc = document_from_string input
-      reftext = doc.references[:ids]['_install']
+      reftext = doc.catalog[:ids]['_install']
       refute_nil reftext
       assert_equal 'Install Procedure', reftext
     end
@@ -1186,6 +1276,30 @@ content
         assert_xpath %(//h2[@id="_chapter_#{num}"][text()="#{num}. Chapter #{num}"]), result, 1
       end
     end
+
+    test 'reindex_sections should correct section enumeration after sections are modified' do
+      input = <<-EOS
+:sectnums:
+
+== First Section
+
+content
+
+== Last Section
+
+content
+      EOS
+
+      doc = document_from_string input
+      second_section = Asciidoctor::Section.new doc
+      doc.blocks.insert 1, second_section
+      doc.reindex_sections
+      sections = doc.sections
+      [0, 1, 2].each do |index|
+        assert_equal index, sections[index].index
+        assert_equal index + 1, sections[index].number
+      end
+    end
   end
 
   context 'Links and anchors' do
@@ -1231,20 +1345,7 @@ Linux installation instructions.
   end
 
   context 'Special sections' do
-    test 'should assign sectname and caption to appendix section' do
-      input = <<-EOS
-[appendix]
-== Attribute Options
-
-Details
-      EOS
-
-      output = block_from_string input
-      assert_equal 'appendix', output.sectname
-      assert_equal 'Appendix A: ', output.caption
-    end
-
-    test 'should render appendix title prefixed with caption' do
+    test 'should assign sectname, caption, and numeral to appendix section by default' do
       input = <<-EOS
 [appendix]
 == Attribute Options
@@ -1252,14 +1353,15 @@ Details
 Details
       EOS
 
-      output = render_embedded_string input
-      assert_xpath '//h2[text()="Appendix A: Attribute Options"]', output, 1
+      appendix = block_from_string input
+      assert_equal 'appendix', appendix.sectname
+      assert_equal 'Appendix A: ', appendix.caption
+      assert_equal 'A', appendix.number
+      assert_equal true, appendix.numbered
     end
 
-    test 'should prefix appendix title by label and letter only when numbered is enabled' do
+    test 'should prefix appendix title by numbered label even when section numbering is disabled' do
       input = <<-EOS
-:numbered:
-
 [appendix]
 == Attribute Options
 
@@ -1284,10 +1386,10 @@ Details
       assert_xpath '//h2[text()="App A: Attribute Options"]', output, 1
     end
 
-    test 'should only assign letter to appendix when numbered is enabled and appendix caption is empty' do
+    test 'should only assign letter to appendix when numbered is enabled and appendix caption is not set' do
       input = <<-EOS
 :numbered:
-:appendix-caption:
+:!appendix-caption:
 
 [appendix]
 == Attribute Options
@@ -1498,12 +1600,16 @@ Terms
       assert_xpath '//*[@id="toc"]//a[@href="#_level_3"][text()="Level 3"]', output, 1
     end
 
-    # reenable once we have :specialnumbered!: implemented
-=begin
-    test 'should not number special sections or subsections' do
+    test 'should not number special sections or their subsections by default except for appendices' do
       input = <<-EOS
-:numbered:
-:specialnumbered!:
+:sectnums:
+
+[dedication]
+== Dedication
+
+=== Dedication Subsection
+
+content
 
 == Section One
 
@@ -1528,19 +1634,27 @@ Terms
       EOS
 
       output = render_embedded_string input
-      assert_xpath '(//h2)[1][text()="1. Section One"]', output, 1
-      assert_xpath '(//h2)[2][text()="Appendix A: Attribute Options"]', output, 1
-      assert_xpath '(//h2)[3][text()="Appendix B: Migration"]', output, 1
-      assert_xpath '(//h3)[1][text()="Gotchas"]', output, 1
-      assert_xpath '(//h2)[4][text()="Glossary"]', output, 1
+      assert_xpath '(//h2)[1][text()="Dedication"]', output, 1
+      assert_xpath '(//h3)[1][text()="Dedication Subsection"]', output, 1
+      assert_xpath '(//h2)[2][text()="1. Section One"]', output, 1
+      assert_xpath '(//h2)[3][text()="Appendix A: Attribute Options"]', output, 1
+      assert_xpath '(//h2)[4][text()="Appendix B: Migration"]', output, 1
+      assert_xpath '(//h3)[2][text()="B.1. Gotchas"]', output, 1
+      assert_xpath '(//h2)[5][text()="Glossary"]', output, 1
     end
 
-    test 'should not number special sections or subsections in toc' do
+    test 'should not number special sections or their subsections in toc by default except for appendices' do
       input = <<-EOS
-:numbered:
-:specialnumbered!:
+:sectnums:
 :toc:
 
+[dedication]
+== Dedication
+
+=== Dedication Subsection
+
+content
+
 == Section One
 
 [appendix]
@@ -1564,13 +1678,14 @@ Terms
       EOS
 
       output = render_string input
+      assert_xpath '//*[@id="toc"]/ul//li/a[text()="Dedication"]', output, 1
+      assert_xpath '//*[@id="toc"]/ul//li/a[text()="Dedication Subsection"]', output, 1
       assert_xpath '//*[@id="toc"]/ul//li/a[text()="1. Section One"]', output, 1
       assert_xpath '//*[@id="toc"]/ul//li/a[text()="Appendix A: Attribute Options"]', output, 1
       assert_xpath '//*[@id="toc"]/ul//li/a[text()="Appendix B: Migration"]', output, 1
-      assert_xpath '//*[@id="toc"]/ul//li/a[text()="Gotchas"]', output, 1
+      assert_xpath '//*[@id="toc"]/ul//li/a[text()="B.1. Gotchas"]', output, 1
       assert_xpath '//*[@id="toc"]/ul//li/a[text()="Glossary"]', output, 1
     end
-=end
 
     test 'level 0 special sections in multipart book should be rendered as level 1' do
       input = <<-EOS
@@ -1594,7 +1709,7 @@ Appendix text
       assert_xpath '//h2[@id = "_appendix"]', output, 1
     end
 
-    test 'should output docbook elements that coorespond to special sections in book doctype' do
+    test 'should output docbook elements that correspond to special sections in book doctype' do
       input = <<-EOS
 = Multipart Book
 :doctype: book
@@ -1730,7 +1845,7 @@ Abstract content
 === Glossary A
 
 Glossaries are optional.
-Glossaries entries are an example of a style of AsciiDoc labeled lists.
+Glossaries entries are an example of a style of AsciiDoc description lists.
 
 [glossary]
 A glossary term::
@@ -1795,7 +1910,7 @@ This should be a tip, not a heading.
       assert_xpath "//*[@class='admonitionblock tip']//p[text() = 'This should be a tip, not a heading.']", output, 1
     end
 
-    test "should not match a heading in a labeled list" do
+    test "should not match a heading in a description list" do
       input = <<-EOS
 Section
 -------
@@ -2216,7 +2331,7 @@ It was a dark and stormy night...
 They couldn't believe their eyes when...
       EOS
 
-      output = render_string input, :header_footer => false
+      output = render_embedded_string input
       assert_css '#preamble:root #toc', output, 1
       assert_css '#preamble:root .paragraph + #toc', output, 1
     end
@@ -2238,7 +2353,7 @@ It was a dark and stormy night...
 They couldn't believe their eyes when...
       EOS
 
-      output = render_string input, :header_footer => false
+      output = render_embedded_string input
       assert_css 'h1:root', output, 1
       assert_css 'h1:root + #toc:root', output, 1
       assert_css 'h1:root + #toc:root + #preamble:root', output, 1
@@ -2433,7 +2548,7 @@ It only has content.
   end
 
   context 'article doctype' do
-    test 'should create sections only in docbook backend' do
+    test 'should create only sections in docbook backend' do
       input = <<-EOS
 = Article
 Doc Writer
@@ -2520,6 +2635,38 @@ That's all she wrote!
       assert_xpath '//h1[@id="_chapter_three"][text() = "Chapter Three"]', output, 1
     end
 
+    test 'should assign appropriate sectname for section type' do
+      input = <<-EOS
+= Book Title
+:doctype: book
+:idprefix:
+:idseparator: -
+
+= Part Title
+
+== Chapter Title
+
+=== Section Title
+
+content
+
+[appendix]
+== Appendix Title
+
+=== Appendix Section Title
+
+content
+      EOS
+
+      doc = document_from_string input
+      assert_equal 'header', doc.header.sectname
+      assert_equal 'part', (doc.find_by :id => 'part-title')[0].sectname
+      assert_equal 'chapter', (doc.find_by :id => 'chapter-title')[0].sectname
+      assert_equal 'section', (doc.find_by :id => 'section-title')[0].sectname
+      assert_equal 'appendix', (doc.find_by :id => 'appendix-title')[0].sectname
+      assert_equal 'section', (doc.find_by :id => 'appendix-section-title')[0].sectname
+    end
+
     test 'should add partintro style to child paragraph of part' do
       input = <<-EOS
 = Book