asciidoctor 0.1.1 → 0.1.2

data/test/reader_test.rb

@@ -153,13 +153,14 @@ This is a paragraph outside the block.
   end
 
   context 'Include Macro' do
-    test 'include macro is disabled by default' do
+    test 'include macro is disabled by default and becomes a link' do
       input = <<-EOS
 include::include-file.asciidoc[]
       EOS
       para = block_from_string input, :attributes => { 'include-depth' => 0 }
       assert_equal 1, para.buffer.size
-      assert_equal 'include::include-file.asciidoc[]', para.buffer.join
+      #assert_equal 'include::include-file.asciidoc[]', para.buffer.join
+      assert_equal 'link:include-file.asciidoc[include-file.asciidoc]', para.buffer.join
     end
 
     test 'include macro is enabled when safe mode is less than SECURE' do
@@ -172,6 +173,76 @@ include::fixtures/include-file.asciidoc[]
       assert_match(/included content/, output)
     end
 
+    test 'missing file referenced by include macro does not crash processor' do
+      input = <<-EOS
+include::fixtures/no-such-file.ad[]
+      EOS
+
+      begin
+        doc = document_from_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
+        assert_equal 0, doc.blocks.size
+      rescue
+        flunk('include macro should not raise exception on missing file')
+      end
+    end
+
+    test 'include macro supports line selection' do
+      input = <<-EOS
+include::fixtures/include-file.asciidoc[lines=1;3..4;6..-1]
+      EOS
+
+      output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :header_footer => false, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_match(/first line/, output)
+      assert_no_match(/second line/, output)
+      assert_match(/third line/, output)
+      assert_match(/fourth line/, output)
+      assert_no_match(/fifth line/, output)
+      assert_match(/sixth line/, output)
+      assert_match(/seventh line/, output)
+      assert_match(/eighth line/, output)
+      assert_match(/last line of included content/, output)
+    end
+
+    test 'include macro supports line selection using quoted attribute value' do
+      input = <<-EOS
+include::fixtures/include-file.asciidoc[lines="1, 3..4 , 6 .. -1"]
+      EOS
+
+      output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :header_footer => false, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_match(/first line/, output)
+      assert_no_match(/second line/, output)
+      assert_match(/third line/, output)
+      assert_match(/fourth line/, output)
+      assert_no_match(/fifth line/, output)
+      assert_match(/sixth line/, output)
+      assert_match(/seventh line/, output)
+      assert_match(/eighth line/, output)
+      assert_match(/last line of included content/, output)
+    end
+
+    test 'include macro supports tagged selection' do
+      input = <<-EOS
+include::fixtures/include-file.asciidoc[tags=snippetA;snippetB]
+      EOS
+
+      output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :header_footer => false, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_match(/snippetA content/, output)
+      assert_match(/snippetB content/, output)
+      assert_no_match(/non-tagged content/, output)
+      assert_no_match(/included content/, output)
+    end
+
+    test 'lines attribute takes precedence over tags attribute in include macro' do
+      input = <<-EOS
+include::fixtures/include-file.asciidoc[lines=1, tags=snippetA;snippetB]
+      EOS
+
+      output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :header_footer => false, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_match(/first line of included content/, output)
+      assert_no_match(/snippetA content/, output)
+      assert_no_match(/snippetB content/, output)
+    end
+
     test "block is called to handle an include macro" do
       input = <<-EOS
 first line
@@ -329,6 +400,22 @@ There was much rejoicing.
       assert_equal "On our quest we go...\nThere is a holy grail!\nThere was much rejoicing.", lines.join.strip
     end
 
+    test 'ifndef with defined attribute does not include text in brackets' do
+      input = <<-EOS
+On our quest we go...
+ifndef::hardships[There is a holy grail!]
+There was no rejoicing.
+      EOS
+       
+      doc = Asciidoctor::Document.new [], :attributes => {'hardships' => ''}
+      reader = Asciidoctor::Reader.new(input.lines.entries, doc, true)
+      lines = []
+      while reader.has_more_lines?
+        lines << reader.get_line
+      end
+      assert_equal "On our quest we go...\nThere was no rejoicing.", lines.join.strip
+    end
+
     test 'include with non-matching nested exclude' do
       input = <<-EOS
 ifdef::grail[]

data/test/sections_test.rb

@@ -257,6 +257,23 @@ not in section
       assert floatingtitle.is_a?(Asciidoctor::Block)
       assert !floatingtitle.is_a?(Asciidoctor::Section)
       assert_equal :floating_title, floatingtitle.context
+      assert_equal '_plain_ol_heading', floatingtitle.id
+      assert doc.references[:ids].has_key?('_plain_ol_heading')
+    end
+
+    test 'can assign explicit id to floating title' do
+      input = <<-EOS
+[[unchained]]
+[float]
+=== Plain Ol' Heading
+
+not in section
+      EOS
+
+      doc = document_from_string input
+      floating_title = doc.blocks.first
+      assert_equal 'unchained', floating_title.id
+      assert doc.references[:ids].has_key?('unchained')
     end
 
     test 'should not include floating title in toc' do
@@ -321,6 +338,115 @@ not in section
     end
   end
 
+  context 'Level offset' do
+    test 'should print error if standalone document is included without level offset' do
+      input = <<-EOS
+= Master Document
+Doc Writer
+
+text in master
+
+// begin simulated include::[]
+= Standalone Document
+:author: Junior Writer
+
+text in standalone
+
+// end simulated include::[]
+      EOS
+
+      output = nil
+      errors = nil
+      redirect_streams do |stdout, stderr|
+        output = render_string input
+        errors = stdout.string
+      end
+
+      assert !errors.empty?
+      assert_match(/section title out of sequence/, errors)
+    end
+
+    test 'should add level offset to section level' do
+      input = <<-EOS
+= Master Document
+Doc Writer
+
+Master document written by {author}.
+
+:leveloffset: 1
+
+// begin simulated include::[]
+= Standalone Document
+:author: Junior Writer
+
+Standalone document written by {author}.
+
+== Section in Standalone
+
+Standalone section text.
+// end simulated include::[]
+
+:leveloffset!:
+
+== Section in Master
+
+Master section text.
+      EOS
+
+      output = nil
+      errors = nil
+      redirect_streams do |stdout, stderr|
+        output = render_string input
+        errors = stdout.string
+      end
+
+      assert errors.empty?
+      assert_match(/Master document written by Doc Writer/, output) 
+      assert_match(/Standalone document written by Junior Writer/, output) 
+      assert_xpath '//*[@class="sect1"]/h2[text() = "Standalone Document"]', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[text() = "Section in Standalone"]', output, 1
+      assert_xpath '//*[@class="sect1"]/h2[text() = "Section in Master"]', output, 1
+    end
+
+    test 'level offset should be added to floating title' do
+      input = <<-EOS
+= Master Document
+Doc Writer
+
+:leveloffset: 1
+
+[float]
+= Floating Title
+      EOS
+
+      output = render_string input
+      assert_xpath '//h2[@class="float"][text() = "Floating Title"]', output, 1
+    end
+
+    test 'should be able to reset level offset' do
+      input = <<-EOS
+= Master Document
+Doc Writer
+
+Master preamble.
+
+:leveloffset: 1
+
+= Standalone Document
+
+Standalone preamble.
+
+:leveloffset!:
+
+== Level 1 Section
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@class = "sect1"]/h2[text() = "Standalone Document"]', output, 1
+      assert_xpath '//*[@class = "sect1"]/h2[text() = "Level 1 Section"]', output, 1
+    end
+  end
+
   context 'Section Numbering' do
     test 'should create section number with one entry for level 1' do
       sect1 = Asciidoctor::Section.new(nil)
@@ -560,6 +686,28 @@ Terms
       assert_xpath '//*[@id="toc"]/ol//li/a[text()="Gotchas"]', output, 1
       assert_xpath '//*[@id="toc"]/ol//li/a[text()="Glossary"]', output, 1
     end
+
+    test 'level 0 special sections in multipart book should be rendered as level 1' do
+      input = <<-EOS
+= Multipart Book
+Doc Writer
+:doctype: book
+
+[preface]
+= Preface
+
+Preface text
+
+[appendix]
+= Appendix
+
+Appendix text
+      EOS
+
+      output = render_string input
+      assert_xpath '//h2[@id = "_preface"]', output, 1
+      assert_xpath '//h2[@id = "_appendix"]', output, 1
+    end
   end
 
   context "heading patterns in blocks" do
@@ -606,7 +754,7 @@ This should be a tip, not a heading.
 ====
       EOS
       output = render_string input
-      assert_xpath "//*[@class='admonitionblock']//p[text() = 'This should be a tip, not a heading.']", output, 1
+      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
@@ -669,10 +817,9 @@ fin.
   end
 
   context 'Table of Contents' do
-    test 'should render table of contents if toc attribute is set' do
+    test 'should render table of contents in header if toc attribute is set' do
       input = <<-EOS
-Article
-=======
+= Article
 :toc:
 
 == Section One
@@ -692,22 +839,288 @@ While they were waiting...
 That's all she wrote!
       EOS
       output = render_string input
-      assert_xpath '//*[@id="toc"]', output, 1
-      assert_xpath '//*[@id="toc"]/*[@id="toctitle"][text()="Table of Contents"]', output, 1
-      assert_xpath '//*[@id="toc"]/ol', output, 1
-      assert_xpath '//*[@id="toc"]//ol', output, 2
-      assert_xpath '//*[@id="toc"]/ol/li', output, 4
-      assert_xpath '//*[@id="toc"]/ol/li[1]/a[@href="#_section_one"][text()="1. Section One"]', output, 1
-      assert_xpath '//*[@id="toc"]/ol/li/ol/li', output, 1
-      assert_xpath '//*[@id="toc"]/ol/li/ol/li/a[@href="#_interlude"][text()="2.1. Interlude"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"][@class="toc"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/*[@id="toctitle"][text()="Table of Contents"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol', output, 2
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li', output, 4
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li[1]/a[@href="#_section_one"][text()="1. Section One"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li/ol/li', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li/ol/li/a[@href="#_interlude"][text()="2.1. Interlude"]', output, 1
+    end
+
+    test 'should render table of contents in header if toc2 attribute is set' do
+      input = <<-EOS
+= Article
+:toc2:
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@id="header"]//*[@id="toc"][@class="toc2"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li[1]/a[@href="#_section_one"][text()="1. Section One"]', output, 1
+    end
+
+    test 'should use document attributes toc-class, toc-title and toclevels to create toc' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-title: Contents
+:toc-class: toc2
+:toclevels: 1
+
+== Section 1
+
+=== Section 1.1
+
+==== Section 1.1.1
+
+==== Section 1.1.2
+
+=== Section 1.2
+
+== Section 2
+
+Fin.
+      EOS
+      output = render_string input
+      assert_css '#header #toc', output, 1
+      assert_css '#header #toc.toc2', output, 1
+      assert_css '#header #toc li', output, 2
+      assert_css '#header #toc #toctitle', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/*[@id="toctitle"][text()="Contents"]', output, 1
+    end
+
+    test 'should not render table of contents if toc-placement attribute is unset' do
+      input = <<-EOS
+= Article
+:toc-placement!:
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@id="toc"]', output, 0
+    end
+
+    test 'should render table of contents at location of toc macro' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-placement!:
+
+Once upon a time...
+
+toc::[]
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+      EOS
+
+      output = render_string input
+      assert_css '#preamble #toc', output, 1
+      assert_css '#preamble .paragraph + #toc', output, 1
+    end
+
+    test 'should render table of contents at location of toc macro in embedded document' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-placement!:
+
+Once upon a time...
+
+toc::[]
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+      EOS
+
+      output = render_string input, :header_footer => false
+      assert_css '#preamble:root #toc', output, 1
+      assert_css '#preamble:root .paragraph + #toc', output, 1
+    end
+
+    test 'should not assign toc id to more than one toc' do
+      input = <<-EOS
+= Article
+:toc:
+
+Once upon a time...
+
+toc::[]
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+      EOS
+
+      output = render_string input
+
+      assert_css '#toc', output, 1
+      assert_css '#toctitle', output, 1
+      assert_xpath '(//*[@class="toc"])[2][not(@id)]', output, 1
+      assert_xpath '(//*[@class="toc"])[2]/*[@class="title"][not(@id)]', output, 1
+    end
+
+    test 'should use global attributes for toc-title, toc-class and toclevels for toc macro' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-placement!:
+:toc-title: Contents
+:toc-class: contents
+:toclevels: 1
+
+Preamble.
+
+toc::[]
+
+== Section 1
+
+=== Section 1.1
+
+==== Section 1.1.1
+
+==== Section 1.1.2
+
+=== Section 1.2
+
+== Section 2
+
+Fin.
+      EOS
+
+      output = render_string input
+      assert_css '#toc', output, 1
+      assert_css '#toctitle', output, 1
+      assert_css '#preamble #toc', output, 1
+      assert_css '#preamble #toc.contents', output, 1
+      assert_xpath '//*[@id="toc"]/*[@class="title"][text() = "Contents"]', output, 1
+      assert_css '#toc li', output, 2
+      assert_xpath '(//*[@id="toc"]//li)[1]/a[text() = "1. Section 1"]', output, 1
+      assert_xpath '(//*[@id="toc"]//li)[2]/a[text() = "2. Section 2"]', output, 1
+    end
+
+    test 'should honor id, title, role and level attributes on toc macro' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-placement!:
+:toc-title: Ignored
+:toc-class: ignored
+:toclevels: 5
+:tocdepth: 1
+
+Preamble.
+
+[[contents]]
+[role="contents"]
+.Contents
+toc::[levels={tocdepth}]
+
+== Section 1
+
+=== Section 1.1
+
+==== Section 1.1.1
+
+==== Section 1.1.2
+
+=== Section 1.2
+
+== Section 2
+
+Fin.
+      EOS
+
+      output = render_string input
+      assert_css '#toc', output, 0
+      assert_css '#toctitle', output, 0
+      assert_css '#preamble #contents', output, 1
+      assert_css '#preamble #contents.contents', output, 1
+      assert_xpath '//*[@id="contents"]/*[@class="title"][text() = "Contents"]', output, 1
+      assert_css '#contents li', output, 2
+      assert_xpath '(//*[@id="contents"]//li)[1]/a[text() = "1. Section 1"]', output, 1
+      assert_xpath '(//*[@id="contents"]//li)[2]/a[text() = "2. Section 2"]', output, 1
     end
   end
 
-  context "book doctype" do
-    test "document title with level 0 headings" do
+  context 'article doctype' do
+    test 'should create sections only in docbook backend' do
       input = <<-EOS
-Book
-====
+= Article
+Doc Writer
+
+== Section 1
+
+The adventure.
+
+=== Subsection One
+
+It was a dark and stormy night...
+
+=== Subsection Two
+
+They couldn't believe their eyes when...
+
+== Section 2
+
+The return.
+
+=== Subsection Three
+
+While they were returning...
+
+=== Subsection Four
+
+That's all she wrote!
+      EOS
+
+      output = render_string input, :backend => 'docbook'
+      assert_xpath '//part', output, 0
+      assert_xpath '//chapter', output, 0
+      assert_xpath '/article/section', output, 2
+      assert_xpath '/article/section[1]/title[text() = "Section 1"]', output, 1
+      assert_xpath '/article/section[2]/title[text() = "Section 2"]', output, 1
+      assert_xpath '/article/section/section', output, 4
+      assert_xpath '/article/section[1]/section[1]/title[text() = "Subsection One"]', output, 1
+      assert_xpath '/article/section[2]/section[1]/title[text() = "Subsection Three"]', output, 1
+    end
+  end
+
+  context 'book doctype' do
+    test 'document title with level 0 headings' do
+      input = <<-EOS
+= Book
+Doc Writer
 :doctype: book
 
 = Chapter One
@@ -734,5 +1147,94 @@ That's all she wrote!
       assert_xpath '//h1[@id="_chapter_two"][text() = "Chapter Two"]', output, 1
       assert_xpath '//h1[@id="_chapter_three"][text() = "Chapter Three"]', output, 1
     end
+
+    test 'should create parts and chapters in docbook backend' do
+      input = <<-EOS
+= Book
+Doc Writer
+:doctype: book
+
+= Part 1
+
+The adventure.
+
+== Chapter One
+
+It was a dark and stormy night...
+
+== Chapter Two
+
+They couldn't believe their eyes when...
+
+= Part 2
+
+The return.
+
+== Chapter Three
+
+While they were returning...
+
+== Chapter Four
+
+That's all she wrote!
+      EOS
+
+      output = render_string input, :backend => 'docbook'
+      assert_xpath '//chapter/chapter', output, 0
+      assert_xpath '/book/part', output, 2
+      assert_xpath '/book/part[1]/title[text() = "Part 1"]', output, 1
+      assert_xpath '/book/part[2]/title[text() = "Part 2"]', output, 1
+      assert_xpath '/book/part/chapter', output, 4
+      assert_xpath '/book/part[1]/chapter[1]/title[text() = "Chapter One"]', output, 1
+      assert_xpath '/book/part[2]/chapter[1]/title[text() = "Chapter Three"]', output, 1
+    end
+
+    test 'subsections in preface and appendix should start at level 2' do
+      input = <<-EOS
+= Multipart Book
+Doc Writer
+:doctype: book
+
+[preface]
+= Preface
+
+Preface content
+
+=== Preface subsection
+
+Preface subsection content
+
+= Part 1
+
+.Part intro title
+[partintro]
+Part intro content
+
+[appendix]
+= Appendix
+
+Appendix content
+
+=== Appendix subsection
+
+Appendix subsection content
+      EOS
+
+      output = nil
+      errors = nil
+      redirect_streams do |stdout, stderr|
+        output = render_string input, :backend => 'docbook'
+        errors = stdout.string
+      end
+      assert errors.empty?
+      assert_xpath '/book/preface', output, 1
+      assert_xpath '/book/preface/section', output, 1
+      assert_xpath '/book/part', output, 1
+      assert_xpath '/book/part/partintro', output, 1
+      assert_xpath '/book/part/partintro/title', output, 1
+      assert_xpath '/book/part/partintro/simpara', output, 1
+      assert_xpath '/book/appendix', output, 1
+      assert_xpath '/book/appendix/section', output, 1
+    end
   end
 end