asciidoctor 0.1.2 → 0.1.3

data/test/paths_test.rb

@@ -166,9 +166,9 @@ context 'Path Resolver' do
 
     test 'resolves windows paths when file separator is backlash' do
       @resolver.file_separator = '\\'
-      assert_equal 'C:\\data\\docs', @resolver.system_path('..', "C:\\data\\docs\\assets", 'C:\\data\\docs')
-      assert_equal 'C:\\data\\docs', @resolver.system_path('..\\..', "C:\\data\\docs\\assets", 'C:\\data\\docs')
-      assert_equal 'C:\\data\\docs\\css', @resolver.system_path('..\\..\\css', "C:\\data\\docs\\assets", 'C:\\data\\docs')
+      assert_equal 'C:/data/docs', @resolver.system_path('..', "C:\\data\\docs\\assets", 'C:\\data\\docs')
+      assert_equal 'C:/data/docs', @resolver.system_path('..\\..', "C:\\data\\docs\\assets", 'C:\\data\\docs')
+      assert_equal 'C:/data/docs/css', @resolver.system_path('..\\..\\css', "C:\\data\\docs\\assets", 'C:\\data\\docs')
     end
   end
 end

data/test/reader_test.rb

@@ -243,6 +243,19 @@ include::fixtures/include-file.asciidoc[lines=1, tags=snippetA;snippetB]
       assert_no_match(/snippetB content/, output)
     end
 
+    test 'indent of included file can be reset to size of indent attribute' do
+      input = <<-EOS
+[source, xml]
+----
+include::fixtures/basic-docinfo.xml[lines=2..3, indent=0]
+----
+      EOS
+
+      output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :header_footer => false, :attributes => {'docdir' => File.dirname(__FILE__)}
+      result = xmlnodes_at_xpath('//pre', output, 1).text
+      assert_equal "<year>2013</year>\n<holder>Acme, Inc.</holder>", result
+    end
+
     test "block is called to handle an include macro" do
       input = <<-EOS
 first line
@@ -262,6 +275,39 @@ last line
       assert_match(/^:includefile: include-file.asciidoc$/, lines.join)
     end
 
+    test 'attributes are substituted in target of include macro' do
+      input = <<-EOS
+:fixturesdir: fixtures
+:ext: asciidoc
+
+include::{fixturesdir}/include-file.{ext}[]
+      EOS
+
+      doc = document_from_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
+      output = doc.render
+      assert_match(/included content/, output)
+    end
+
+    test 'line is dropped if target of include macro resolves to empty' do
+      input = <<-EOS
+include::{foodir}/include-file.asciidoc[]
+      EOS
+
+      output = render_embedded_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert output.strip.empty?
+    end
+
+    test 'line is dropped but not following line if target of include macro resolves to empty' do
+      input = <<-EOS
+include::{foodir}/include-file.asciidoc[]
+yo
+      EOS
+
+      output = render_embedded_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_xpath '//p', output, 1
+      assert_xpath '//p[text()="yo"]', output, 1
+    end
+
     test 'escaped include macro is left unprocessed' do
       input = <<-EOS
 \\include::include-file.asciidoc[]

data/test/sections_test.rb

@@ -208,6 +208,50 @@ text
     end
   end
 
+  context "level 5" do 
+    test "with single line syntax" do
+      assert_xpath "//h6[@id='_my_title'][text() = 'My Title']", render_string(":fragment:\n====== My Title")
+    end
+  end
+
+  context 'Markdown-style headings' do
+    test 'single-line document title with leading marker' do
+      input = <<-EOS
+# Document Title
+      EOS
+      output = render_string input
+      assert_xpath "//h1[not(@id)][text() = 'Document Title']", output, 1
+    end
+
+    test 'single-line document title with symmetric markers' do
+      input = <<-EOS
+# Document Title #
+      EOS
+      output = render_string input
+      assert_xpath "//h1[not(@id)][text() = 'Document Title']", output, 1
+    end
+
+    test 'single-line section title with leading marker' do
+      input = <<-EOS
+## Section One
+
+blah blah
+      EOS
+      output = render_string input
+      assert_xpath "//h2[@id='_section_one'][text() = 'Section One']", output, 1
+    end
+
+    test 'single-line section title with symmetric markers' do
+      input = <<-EOS
+## Section One ##
+
+blah blah
+      EOS
+      output = render_string input
+      assert_xpath "//h2[@id='_section_one'][text() = 'Section One']", output, 1
+    end
+  end
+
   context 'Floating Title' do
     test 'should create floating title if style is float' do
       input = <<-EOS
@@ -290,7 +334,7 @@ not in section
 
       output = render_string input
       assert_xpath '//*[@id="toc"]', output, 1
-      assert_xpath %(//*[@id="toc"]//a[contains(text(), " Section ")]), output, 2
+      assert_xpath %(//*[@id="toc"]//a[contains(text(), "Section ")]), output, 2
       assert_xpath %(//*[@id="toc"]//a[text()="Miss Independent"]), output, 0
     end
 
@@ -355,15 +399,14 @@ text in standalone
 // end simulated include::[]
       EOS
 
-      output = nil
-      errors = nil
+      output, 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)
+      assert_match(/only book doctypes can contain level 0 sections/, errors)
     end
 
     test 'should add level offset to section level' do
@@ -555,6 +598,48 @@ paragraph
     end
   end
 
+  context 'Links and anchors' do
+    test 'should include anchor if sectanchors document attribute is set' do
+      input = <<-EOS
+== Installation
+
+Installation section.
+
+=== Linux
+
+Linux installation instructions.
+      EOS
+
+      output = render_embedded_string input, :attributes => {'sectanchors' => ''}
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a', output, 1
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a[@class="anchor"][@href="#_installation"]', output, 1
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a/following-sibling::text()="Installation"', output, true
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a[@class="anchor"][@href="#_linux"]', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a/following-sibling::text()="Linux"', output, true
+    end
+
+    test 'should link section if sectlinks document attribute is set' do
+      input = <<-EOS
+== Installation
+
+Installation section.
+
+=== Linux
+
+Linux installation instructions.
+      EOS
+
+      output = render_embedded_string input, :attributes => {'sectlinks' => ''}
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a', output, 1
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a[@class="link"][@href="#_installation"]', output, 1
+      assert_xpath '/*[@class="sect1"]/h2[@id="_installation"]/a[text()="Installation"]', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a[@class="link"][@href="#_linux"]', output, 1
+      assert_xpath '//*[@class="sect2"]/h3[@id="_linux"]/a[text()="Linux"]', output, 1
+    end
+  end
+
   context 'Special sections' do
     test 'should assign sectname and caption to appendix section' do
       input = <<-EOS
@@ -566,7 +651,7 @@ Details
 
       output = block_from_string input
       assert_equal 'appendix', output.sectname
-      assert_equal 'Appendix A: ', output.attr('caption')
+      assert_equal 'Appendix A: ', output.caption
     end
 
     test 'should render appendix title prefixed with caption' do
@@ -708,6 +793,130 @@ Appendix text
       assert_xpath '//h2[@id = "_preface"]', output, 1
       assert_xpath '//h2[@id = "_appendix"]', output, 1
     end
+
+    test 'should output docbook elements that coorespond to special sections in book doctype' do
+      input = <<-EOS
+= Multipart Book
+:doctype: book
+:idprefix:
+
+[abstract]
+= Abstract Title
+
+Normal chapter (no abstract in book)
+
+[dedication]
+= Dedication Title
+
+Dedication content
+
+[preface]
+= Preface Title
+
+Preface content
+
+=== Preface sub-section
+
+Preface subsection content
+
+= Part 1
+
+[partintro]
+.Part intro title
+Part intro content
+
+== Chapter 1
+
+blah blah
+
+== Chapter 2
+
+blah blah
+
+= Part 2
+
+blah blah
+
+== Chapter 3
+
+blah blah
+
+== Chapter 4
+
+blah blah
+
+[appendix]
+= Appendix Title
+
+Appendix content
+
+=== Appendix sub-section
+
+Appendix sub-section content
+
+[bibliography]
+= Bibliography Title
+
+Bibliography content
+
+[glossary]
+= Glossary Title
+
+Glossary content
+
+[colophon]
+= Colophon Title
+
+Colophon content
+
+[index]
+= Index Title
+      EOS
+
+      output = render_embedded_string input, :backend => 'docbook'
+      assert_xpath '/chapter[@id="abstract_title"]', output, 1
+      assert_xpath '/chapter[@id="abstract_title"]/title[text()="Abstract Title"]', output, 1
+      assert_xpath '/chapter/following-sibling::dedication[@id="dedication_title"]', output, 1
+      assert_xpath '/chapter/following-sibling::dedication[@id="dedication_title"]/title[text()="Dedication Title"]', output, 1
+      assert_xpath '/dedication/following-sibling::preface[@id="preface_title"]', output, 1
+      assert_xpath '/dedication/following-sibling::preface[@id="preface_title"]/title[text()="Preface Title"]', output, 1
+      assert_xpath '/preface/section[@id="preface_sub_section"]', output, 1
+      assert_xpath '/preface/section[@id="preface_sub_section"]/title[text()="Preface sub-section"]', output, 1
+      assert_xpath '/preface/following-sibling::part[@id="part_1"]', output, 1
+      assert_xpath '/preface/following-sibling::part[@id="part_1"]/title[text()="Part 1"]', output, 1
+      assert_xpath '/part[@id="part_1"]/partintro', output, 1
+      assert_xpath '/part[@id="part_1"]/partintro/title[text()="Part intro title"]', output, 1
+      assert_xpath '/part[@id="part_1"]/partintro/following-sibling::chapter[@id="chapter_1"]', output, 1
+      assert_xpath '/part[@id="part_1"]/partintro/following-sibling::chapter[@id="chapter_1"]/title[text()="Chapter 1"]', output, 1
+      assert_xpath '(/part)[2]/following-sibling::appendix[@id="appendix_title"]', output, 1
+      assert_xpath '(/part)[2]/following-sibling::appendix[@id="appendix_title"]/title[text()="Appendix Title"]', output, 1
+      assert_xpath '/appendix/section[@id="appendix_sub_section"]', output, 1
+      assert_xpath '/appendix/section[@id="appendix_sub_section"]/title[text()="Appendix sub-section"]', output, 1
+      assert_xpath '/appendix/following-sibling::bibliography[@id="bibliography_title"]', output, 1
+      assert_xpath '/appendix/following-sibling::bibliography[@id="bibliography_title"]/title[text()="Bibliography Title"]', output, 1
+      assert_xpath '/bibliography/following-sibling::glossary[@id="glossary_title"]', output, 1
+      assert_xpath '/bibliography/following-sibling::glossary[@id="glossary_title"]/title[text()="Glossary Title"]', output, 1
+      assert_xpath '/glossary/following-sibling::colophon[@id="colophon_title"]', output, 1
+      assert_xpath '/glossary/following-sibling::colophon[@id="colophon_title"]/title[text()="Colophon Title"]', output, 1
+      assert_xpath '/colophon/following-sibling::index[@id="index_title"]', output, 1
+      assert_xpath '/colophon/following-sibling::index[@id="index_title"]/title[text()="Index Title"]', output, 1
+    end
+
+    test 'abstract section maps to abstract element in docbook for article doctype' do
+      input = <<-EOS
+= Article
+:idprefix:
+
+[abstract]
+== Abstract Title
+
+Abstract content
+      EOS
+
+      output = render_embedded_string input, :backend => 'docbook'
+      assert_xpath '/abstract[@id="abstract_title"]', output, 1
+      assert_xpath '/abstract[@id="abstract_title"]/title[text()="Abstract Title"]', output, 1
+    end
   end
 
   context "heading patterns in blocks" do
@@ -817,7 +1026,7 @@ fin.
   end
 
   context 'Table of Contents' do
-    test 'should render table of contents in header if toc attribute is set' do
+    test 'should render unnumbered table of contents in header if toc attribute is set' do
       input = <<-EOS
 = Article
 :toc:
@@ -842,17 +1051,133 @@ That's all she wrote!
       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[@type="none"][@class="sectlevel1"]', output, 1
       assert_xpath '//*[@id="header"]//*[@id="toc"]//ol', output, 2
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol[@type="none"]', 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()="Section One"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li/ol', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li/ol[@type="none"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]/ol/li/ol[@class="sectlevel2"]', 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()="Interlude"]', output, 1
+      assert_xpath '((//*[@id="header"]//*[@id="toc"]/ol)[1]/li)[4]/a[@href="#_section_three"][text()="Section Three"]', output, 1
+    end
+
+    test 'should render numbered table of contents in header if toc and numbered attributes are set' do
+      input = <<-EOS
+= Article
+:toc:
+:numbered:
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+
+=== Interlude
+
+While they were waiting...
+
+== Section Three
+
+That's all she wrote!
+      EOS
+      output = render_string input
+      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[@type="none"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol', output, 2
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol[@type="none"]', 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
+      assert_xpath '((//*[@id="header"]//*[@id="toc"]/ol)[1]/li)[4]/a[@href="#_section_three"][text()="3. Section Three"]', output, 1
+    end
+
+    test 'should render a table of contents that honors numbered setting at position of section in document' do
+      input = <<-EOS
+= Article
+:toc:
+:numbered:
+
+== Section One
+
+It was a dark and stormy night...
+
+== Section Two
+
+They couldn't believe their eyes when...
+
+=== Interlude
+
+While they were waiting...
+
+:numbered!:
+
+== Section Three
+
+That's all she wrote!
+      EOS
+      output = render_string input
+      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[@type="none"]', output, 1
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol', output, 2
+      assert_xpath '//*[@id="header"]//*[@id="toc"]//ol[@type="none"]', 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)[1]/li)[4]/a[@href="#_section_three"][text()="Section Three"]', output, 1
+    end
+
+    test 'should not number parts in table of contents for book doctype when numbered attribute is set' do
+      input = <<-EOS
+= Book
+:doctype: book
+:toc:
+:numbered:
+
+= Part 1
+
+== First Section of Part 1
+
+blah
+
+== Second Section of Part 1
+
+blah
+
+= Part 2
+
+== First Section of Part 2
+
+blah
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@id="toc"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol', output, 1
+      assert_xpath '//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li', output, 4
+      assert_xpath '(//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[1]/a[text()="Part 1"]', output, 1
+      assert_xpath '(//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[3]/a[text()="Part 2"]', output, 1
+      assert_xpath '(//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[2]/ol', output, 1
+      assert_xpath '(//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[2]/ol[@type="none"][@class="sectlevel1"]', output, 1
+      assert_xpath '(//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[2]/ol/li', output, 2
+      assert_xpath '((//*[@id="toc"]/ol[@type="none"][@class="sectlevel0"]/li)[2]/ol/li)[1]/a[text()="1. First Section of Part 1"]', output, 1
     end
 
     test 'should render table of contents in header if toc2 attribute is set' do
       input = <<-EOS
 = Article
 :toc2:
+:numbered:
 
 == Section One
 
@@ -864,6 +1189,7 @@ They couldn't believe their eyes when...
       EOS
 
       output = render_string input
+      assert_xpath '//body[@class="article toc2"]', output, 1
       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
@@ -898,9 +1224,31 @@ Fin.
       assert_xpath '//*[@id="header"]//*[@id="toc"]/*[@id="toctitle"][text()="Contents"]', output, 1
     end
 
+    test 'should render table of contents in preamble if toc-placement attribute value is preamble' do
+      input = <<-EOS
+= Article
+:toc:
+:toc-placement: preamble
+
+Once upon a time...
+
+== 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="preamble"]/*[@id="toc"]', output, 1
+    end
+
     test 'should not render table of contents if toc-placement attribute is unset' do
       input = <<-EOS
 = Article
+:toc:
 :toc-placement!:
 
 == Section One
@@ -1025,8 +1373,8 @@ Fin.
       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
+      assert_xpath '(//*[@id="toc"]//li)[1]/a[text() = "Section 1"]', output, 1
+      assert_xpath '(//*[@id="toc"]//li)[2]/a[text() = "Section 2"]', output, 1
     end
 
     test 'should honor id, title, role and level attributes on toc macro' do
@@ -1068,8 +1416,8 @@ Fin.
       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
+      assert_xpath '(//*[@id="contents"]//li)[1]/a[text() = "Section 1"]', output, 1
+      assert_xpath '(//*[@id="contents"]//li)[2]/a[text() = "Section 2"]', output, 1
     end
   end
 
@@ -1141,8 +1489,13 @@ That's all she wrote!
       EOS
 
       output = render_string(input)
-      assert_xpath '//h1', output, 4
-      assert_xpath '//h2', output, 1
+      assert_css 'body.book', output, 1
+      assert_css 'h1', output, 4
+      assert_css '#header h1', output, 1
+      assert_css '#content h1', output, 3
+      assert_css '#content h1.sect0', output, 3
+      assert_css 'h2', output, 1
+      assert_css '#content h2', output, 1
       assert_xpath '//h1[@id="_chapter_one"][text() = "Chapter One"]', output, 1
       assert_xpath '//h1[@id="_chapter_two"][text() = "Chapter Two"]', output, 1
       assert_xpath '//h1[@id="_chapter_three"][text() = "Chapter Three"]', output, 1