asciidoctor 1.5.6.2 → 1.5.7

data/test/lists_test.rb

@@ -185,7 +185,7 @@ Bar
 
       output = render_embedded_string input
       assert_css 'ul ul', output, 1
-      refute output.include?('* Foo')
+      refute_includes output, '* Foo'
     end
 
     test 'a list item for a different list terminates non-indented paragraph for text of list item' do
@@ -205,9 +205,9 @@ term:: def
 
       output = render_embedded_string input
       assert_css 'ul ol', output, 1
-      refute output.include?('* Foo')
+      refute_includes output, '* Foo'
       assert_css 'ul dl', output, 1
-      refute output.include?('term:: def')
+      refute_includes output, 'term:: def'
     end
 
     test 'an indented wrapped line is unindented and folded into text of list item' do
@@ -255,7 +255,7 @@ second wrapped line
 
       output = render_embedded_string input
       assert_css 'ul ul', output, 1
-      refute output.include?('* Foo')
+      refute_includes output, '* Foo'
     end
 
     test 'a list item that starts with a sequence of list markers characters should not match a nested list' do
@@ -287,9 +287,9 @@ term:: def
 
       output = render_embedded_string input
       assert_css 'ul ol', output, 1
-      refute output.include?('* Foo')
+      refute_includes output, '* Foo'
       assert_css 'ul dl', output, 1
-      refute output.include?('term:: def')
+      refute_includes output, 'term:: def'
     end
 
     test "a literal paragraph offset by blank lines in list content is appended as a literal block" do
@@ -355,6 +355,48 @@ NOTE: This is a note.
       assert_xpath '//ul/li/*[@class="admonitionblock note"]//td[@class="content"][normalize-space(text())="This is a note."]', output, 1
     end
 
+    test 'paragraph-like blocks attached to an ancestory list item by a list continuation should produce blocks' do
+      input = <<-EOS
+* parent
+ ** child
+
++
+NOTE: This is a note.
+
+* another parent
+ ** another child
+
++
+'''
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'ul ul .admonitionblock.note', output, 0
+      assert_xpath '(//ul)[1]/li/*[@class="admonitionblock note"]', output, 1
+      assert_css 'ul ul hr', output, 0
+      assert_xpath '(//ul)[1]/li/hr', output, 1
+    end
+
+    test 'should continue to parse blocks attached by a list continuation after block is dropped' do
+      input = <<-EOS
+* item
++
+paragraph
++
+[comment]
+comment
++
+====
+example
+====
+'''
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'ul > li > .paragraph', output, 1
+      assert_css 'ul > li > .exampleblock', output, 1
+    end
+
     test 'appends line as paragraph if attached by continuation following line comment' do
       input = <<-EOS
 - list item 1
@@ -637,7 +679,7 @@ item
       assert_css 'ul', output, 1
       assert_css 'ul > li', output, 2
       assert_css 'h2', output, 0
-      assert output.include?('== Not a section')
+      assert_includes output, '== Not a section'
       assert_xpath %((//li)[2]/p[text() = "second\n== Not a section"]), output, 1
     end
   end
@@ -700,6 +742,26 @@ B. And it ends here.
       assert_xpath '//ol', output, 1
       assert_xpath '//ol/li', output, 2
     end
+
+    test 'should discover anchor at start of list item text and register it as a reference' do
+      input = <<-EOS
+The highest peak in the Front Range is <<grays-peak>>, which tops <<mount-evans>> by just a few feet.
+
+* [[mount-evans,Mount Evans]]At 14,271 feet, Mount Evans is the highest summit of the Chicago Peaks in the Front Range of the Rocky Mountains.
+* [[grays-peak,Grays Peak]]
+Grays Peak rises to 14,278 feet, making it the highest summit in the Front Range of the Rocky Mountains.
+* Longs Peak is a 14,259-foot high, prominent mountain summit in the northern Front Range of the Rocky Mountains.
+* Pikes Peak is the highest summit of the southern Front Range of the Rocky Mountains at 14,115 feet.
+      EOS
+
+      doc = document_from_string input
+      refs = doc.catalog[:refs]
+      assert refs.key?('mount-evans')
+      assert refs.key?('grays-peak')
+      output = doc.convert :header_footer => false
+      assert_xpath '(//p)[1]/a[@href="#grays-peak"][text()="Grays Peak"]', output, 1
+      assert_xpath '(//p)[1]/a[@href="#mount-evans"][text()="Mount Evans"]', output, 1
+    end
   end
 
   context "Nested lists" do
@@ -1540,6 +1602,23 @@ Item one, paragraph two
     end
 =end
 
+    test 'should warn if unterminated block is detected in list item' do
+      input = <<-EOS
+* item
++
+====
+example
+* swallowed item
+      EOS
+
+      using_memory_logger do |logger|
+        output = render_embedded_string input
+        assert_xpath '//ul/li', output, 1
+        assert_xpath '//ul/li/*[@class="exampleblock"]', output, 1
+        assert_xpath %(//p[text()="example\n* swallowed item"]), output, 1
+        assert_message logger, :WARN, '<stdin>: line 3: unterminated example block', Hash
+      end
+    end
   end
 end
 
@@ -1764,6 +1843,30 @@ List
       assert_xpath '(//orderedlist)[@startingnumber = "7"]', output, 1
     end
   end
+
+  test 'should warn if explicit uppercase roman numerals in list are out of sequence' do
+    input = <<-EOS
+I) one
+III) three
+    EOS
+    using_memory_logger do |logger|
+      output = render_embedded_string input
+      assert_xpath '//ol/li', output, 2
+      assert_message logger, :WARN, '<stdin>: line 2: list item index: expected II, got III', Hash
+    end
+  end
+
+  test 'should warn if explicit lowercase roman numerals in list are out of sequence' do
+    input = <<-EOS
+i) one
+iii) three
+    EOS
+    using_memory_logger do |logger|
+      output = render_embedded_string input
+      assert_xpath '//ol/li', output, 2
+      assert_message logger, :WARN, '<stdin>: line 2: list item index: expected ii, got iii', Hash
+    end
+  end
 end
 
 context "Description lists (:dlist)" do
@@ -1783,6 +1886,21 @@ term2:: def2
       assert_xpath '(//dl/dt)[2]/following-sibling::dd/p[text() = "def2"]', output, 1
     end
 
+    test 'should parse sibling items using same rules' do
+      input = <<-EOS
+term1;; ;; def1
+term2;; ;; def2
+      EOS
+      output = render_string input
+      assert_xpath '//dl', output, 1
+      assert_xpath '//dl/dt', output, 2
+      assert_xpath '//dl/dt/following-sibling::dd', output, 2
+      assert_xpath '(//dl/dt)[1][normalize-space(text()) = "term1"]', output, 1
+      assert_xpath '(//dl/dt)[1]/following-sibling::dd/p[text() = ";; def1"]', output, 1
+      assert_xpath '(//dl/dt)[2][normalize-space(text()) = "term2"]', output, 1
+      assert_xpath '(//dl/dt)[2]/following-sibling::dd/p[text() = ";; def2"]', output, 1
+    end
+
     test "single-line indented adjacent elements" do
       input = <<-EOS
 term1:: def1
@@ -2046,16 +2164,24 @@ def2
       assert_xpath '(//dl/dt)[2]/following-sibling::dd/p[text() = "def2"]', output, 1
     end
 
-    test "element with anchor" do
+    test 'should discover anchor at start of description term text and register it as a reference' do
       input = <<-EOS
-[[term1]]term1:: def1
-[[term2]]term2:: def2
+The highest peak in the Front Range is <<grays-peak>>, which tops <<mount-evans>> by just a few feet.
+
+[[mount-evans,Mount Evans]]Mount Evans:: 14,271 feet
+[[grays-peak]]Grays Peak:: 14,278 feet
       EOS
-      output = render_string input
+      doc = document_from_string input
+      refs = doc.catalog[:refs]
+      assert refs.key?('mount-evans')
+      assert refs.key?('grays-peak')
+      output = doc.convert :header_footer => false
+      assert_xpath '(//p)[1]/a[@href="#grays-peak"][text()="Grays Peak"]', output, 1
+      assert_xpath '(//p)[1]/a[@href="#mount-evans"][text()="Mount Evans"]', output, 1
       assert_xpath '//dl', output, 1
       assert_xpath '//dl/dt', output, 2
-      assert_xpath '(//dl/dt)[1]/a[@id = "term1"]', output, 1
-      assert_xpath '(//dl/dt)[2]/a[@id = "term2"]', output, 1
+      assert_xpath '(//dl/dt)[1]/a[@id="mount-evans"]', output, 1
+      assert_xpath '(//dl/dt)[2]/a[@id="grays-peak"]', output, 1
     end
 
     test "missing space before term does not produce description list" do
@@ -2327,6 +2453,18 @@ A term::::: a description
       assert_xpath '//dt[text()="A term:"]', output, 1
       assert_xpath '//dd/p[text()="a description"]', output, 1
     end
+
+    test 'text method of dd node should return nil if dd node only contains blocks' do
+      input = <<-EOS
+term::
++
+paragraph
+      EOS
+
+      doc = document_from_string input
+      dd = doc.blocks[0].items[0][1]
+      assert_nil dd.text
+    end
   end
 
   context "Nested lists" do
@@ -2774,6 +2912,23 @@ last question::
       assert_css 'bibliodiv > bibliomixed:nth-child(2) > bibliomisc > anchor[xreflabel="[walsh-muellner]"]', output, 1
     end
 
+    test 'should warn if a bibliography ID is already in use' do
+      input = <<-EOS
+[bibliography]
+* [[[Fowler]]] Fowler M. _Analysis Patterns: Reusable Object Models_.
+Addison-Wesley. 1997.
+* [[[Fowler]]] Fowler M. _Analysis Patterns: Reusable Object Models_.
+Addison-Wesley. 1997.
+      EOS
+      using_memory_logger do |logger|
+        output = render_embedded_string input
+        assert_css '.ulist.bibliography', output, 1
+        assert_css '.ulist.bibliography ul li:nth-child(1) p a#Fowler', output, 1
+        assert_css '.ulist.bibliography ul li:nth-child(2) p a#Fowler', output, 1
+        assert_message logger, :WARN, '<stdin>: line 4: id assigned to bibliography anchor already in use: Fowler', Hash
+      end
+    end
+
     test 'should automatically add bibliography style to top-level lists in bibliography section' do
       input = <<-EOS
 [bibliography]
@@ -3448,7 +3603,7 @@ not a term::: def
       assert_css '.dlist > dl > dt', output, 1
       assert_css '.dlist > dl > dd', output, 1
       assert_css '.dlist > dl > dd > .paragraph', output, 1
-      assert output.include?('not a term::: def')
+      assert_includes output, 'not a term::: def'
     end
 
     # FIXME pending
@@ -3465,7 +3620,7 @@ not a term:: def
       assert_css '.dlist > dl > dt', output, 1
       assert_css '.dlist > dl > dd', output, 1
       assert_css '.dlist > dl > dd > .paragraph', output, 1
-      assert output.include?('not a term:: def')
+      assert_includes output, 'not a term:: def'
     end
 =end
 
@@ -3482,7 +3637,7 @@ not a term::: def
       assert_css '.dlist > dl > dt', output, 1
       assert_css '.dlist > dl > dd', output, 1
       assert_css '.dlist > dl > dd > .quoteblock', output, 1
-      assert output.include?('not a term::: def')
+      assert_includes output, 'not a term::: def'
     end
 
     test 'appends line as paragraph if attached by continuation following blank line and line comment when term has no inline description' do
@@ -3906,7 +4061,7 @@ context 'Callout lists' do
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 <1> Describe the first line
 <2> Describe the second line
@@ -3930,7 +4085,7 @@ puts doc.render # <3>
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 
 Paragraph.
@@ -3958,7 +4113,7 @@ Paragraph.
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <2>
+puts doc.convert # <2>
 ----
 <1> Import the library
 <2> Where the magic happens
@@ -3980,7 +4135,7 @@ puts doc.render # <2>
 ----
 require 'asciidoctor' # <2>
 doc = Asciidoctor::Document.new('Hello, World!') # <3>
-puts doc.render # <1>
+puts doc.convert # <1>
 ----
 <1> Describe the first line
 <2> Describe the second line
@@ -4010,7 +4165,7 @@ require 'asciidoctor' # <1>
 [source, ruby]
 ----
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 
 <1> Describe the first line
@@ -4042,7 +4197,7 @@ require 'asciidoctor' # <1>
 [source, ruby]
 ----
 doc = Asciidoctor::Document.new('Hello, World!') # <1>
-puts doc.render # <2>
+puts doc.convert # <2>
 ----
 <1> Describe the second line
 <2> Describe the third line
@@ -4068,7 +4223,7 @@ puts doc.render # <2>
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 <1> Imports the library
 as a RubyGem
@@ -4093,7 +4248,7 @@ You can write this to file rather than printing to stdout.
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 <1> Imports the library
 as a RubyGem
@@ -4142,7 +4297,7 @@ puts "The syntax <1> at the end of the line makes a code callout"
 ----
 require 'asciidoctor' <1>
 doc = Asciidoctor.load('Hello, World!') # <2> <3> <4>
-puts doc.render <5><6>
+puts doc.convert <5><6>
 exit 0
 ----
 <1> Require library
@@ -4195,11 +4350,13 @@ foo::
 
 <1> Not pointing to a callout
     EOS
-    output, warnings = redirect_streams {|_, err| [(render_embedded_string input), err.string] }
-    assert_xpath '//dl//b', output, 0
-    assert_xpath '//dl/dd/p[text()="bar <1>"]', output, 1
-    assert_xpath '//ol/li/p[text()="Not pointing to a callout"]', output, 1
-    assert_includes warnings, 'line 4: no callouts refer to list item 1'
+    using_memory_logger do |logger|
+      output = render_embedded_string input
+      assert_xpath '//dl//b', output, 0
+      assert_xpath '//dl/dd/p[text()="bar <1>"]', output, 1
+      assert_xpath '//ol/li/p[text()="Not pointing to a callout"]', output, 1
+      assert_message logger, :WARN, '<stdin>: line 4: no callout found for <1>', Hash
+    end
   end
 
   test 'should not recognize callouts in an indented outline list paragraph' do
@@ -4209,11 +4366,13 @@ foo::
 
 <1> Not pointing to a callout
     EOS
-    output, warnings = redirect_streams {|_, err| [(render_embedded_string input), err.string] }
-    assert_xpath '//ul//b', output, 0
-    assert_xpath %(//ul/li/p[text()="foo\nbar <1>"]), output, 1
-    assert_xpath '//ol/li/p[text()="Not pointing to a callout"]', output, 1
-    assert_includes warnings, 'line 4: no callouts refer to list item 1'
+    using_memory_logger do |logger|
+      output = render_embedded_string input
+      assert_xpath '//ul//b', output, 0
+      assert_xpath %(//ul/li/p[text()="foo\nbar <1>"]), output, 1
+      assert_xpath '//ol/li/p[text()="Not pointing to a callout"]', output, 1
+      assert_message logger, :WARN, '<stdin>: line 4: no callout found for <1>', Hash
+    end
   end
 
   test 'should warn if numbers in callout list are out of sequence' do
@@ -4227,10 +4386,14 @@ foo::
 Beans are fun.
 <3> An actual bean.
     EOS
-    output, warnings = redirect_streams {|_, err| [(render_embedded_string input), err.string] }
-    assert_xpath '//ol/li', output, 2
-    assert_includes warnings, 'line 8: callout list item index: expected 2 got 3'
-    assert_includes warnings, 'line 8: no callouts refer to list item 2'
+    using_memory_logger do |logger|
+      output = render_embedded_string input
+      assert_xpath '//ol/li', output, 2
+      assert_messages logger, [
+        [:WARN, '<stdin>: line 8: callout list item index: expected 2, got 3', Hash],
+        [:WARN, '<stdin>: line 8: no callout found for <2>', Hash]
+      ]
+    end
   end
 
   test 'should remove line comment chars that precedes callout number' do
@@ -4312,7 +4475,7 @@ Violets are blue <2>
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') # <2>
-puts doc.render # <3>
+puts doc.convert # <3>
 ----
 <1> Describe the first line
 <2> Describe the second line
@@ -4335,7 +4498,7 @@ puts doc.render # <3>
 ----
 require 'asciidoctor' # <1>
 doc = Asciidoctor::Document.new('Hello, World!') #<2>
-puts doc.render #<3>
+puts doc.convert #<3>
 ----
 <1> Describe the first line
 <2> Describe the second line
@@ -4367,7 +4530,17 @@ context 'Checklists' do
 - plain
     EOS
 
-    output = render_embedded_string input
+    doc = document_from_string input
+    checklist = doc.blocks[0]
+    assert checklist.option?('checklist')
+    #assert_equal 'checklist', checklist.attributes['options']
+    assert checklist.items[0].attr?('checkbox')
+    refute checklist.items[0].attr?('checked')
+    assert checklist.items[1].attr?('checkbox')
+    assert checklist.items[1].attr?('checked')
+    refute checklist.items[4].attr?('checkbox')
+
+    output = doc.convert :header_footer => false
     assert_css '.ulist.checklist', output, 1
     assert_xpath %((/*[@class="ulist checklist"]/ul/li)[1]/p[text()="#{decode_char 10063} todo"]), output, 1
     assert_xpath %((/*[@class="ulist checklist"]/ul/li)[2]/p[text()="#{decode_char 10003} done"]), output, 1
@@ -4394,12 +4567,17 @@ context 'Checklists' do
     input = <<-EOS
 :icons: font
 
-[options="interactive"]
+[%interactive]
 - [ ] todo
 - [x] done
     EOS
 
-    output = render_embedded_string input
+    doc = document_from_string input
+    checklist = doc.blocks[0]
+    assert checklist.option?('checklist')
+    assert checklist.option?('interactive')
+
+    output = doc.convert :header_footer => false
     assert_css '.ulist.checklist', output, 1
     assert_css '.ulist.checklist li input[type="checkbox"]', output, 2
     assert_css '.ulist.checklist li input[type="checkbox"][disabled]', output, 0
@@ -4417,7 +4595,7 @@ context 'Lists model' do
 
     doc = document_from_string input
     list = doc.blocks.first
-    assert list.is_a? Asciidoctor::List
+    assert_kind_of Asciidoctor::List, list
     items = list.items
     assert_equal 3, items.size
     assert_equal list.items, list.content
@@ -4556,4 +4734,24 @@ listing block in list item 1
     assert_equal '`three`', list.items[2].text
     assert_equal '<mark>four</mark>', list.items[3].text
   end
+
+  test 'should set lineno to line number in source where list starts' do
+    input = <<-EOS
+* bullet 1
+** bullet 1.1
+*** bullet 1.1.1
+* bullet 2
+    EOS
+    doc = document_from_string input, :sourcemap => true
+    lists = doc.find_by :context => :ulist
+    assert_equal 1, lists[0].lineno
+    assert_equal 2, lists[1].lineno
+    assert_equal 3, lists[2].lineno
+
+    list_items = doc.find_by :context => :list_item
+    assert_equal 1, list_items[0].lineno
+    assert_equal 2, list_items[1].lineno
+    assert_equal 3, list_items[2].lineno
+    assert_equal 4, list_items[3].lineno
+  end
 end