asciidoctor 0.0.9 → 0.1.0

data/test/options_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+require 'asciidoctor/cli/options'
+
+context 'Options' do
+  test 'should return error code 0 when help flag is present' do
+    redirect_streams do |stdout, stderr|
+      exitval = Asciidoctor::Cli::Options.parse!(%w(-h))
+      assert_equal 0, exitval
+      assert_match(/^Usage:/, stdout.string)
+    end
+  end
+
+  test 'should return error code 1 when invalid option present' do
+    redirect_streams do |stdout, stderr|
+      exitval = Asciidoctor::Cli::Options.parse!(%w(--foobar))
+      assert_equal 1, exitval
+      assert_equal 'asciidoctor: invalid option: --foobar', stderr.string.chomp
+    end
+  end
+
+  test 'should return error code 1 when option has invalid argument' do
+    redirect_streams do |stdout, stderr|
+      exitval = Asciidoctor::Cli::Options.parse!(%w(-b foo input.ad))
+      assert_equal 1, exitval
+      assert_equal 'asciidoctor: invalid argument: -b foo', stderr.string.chomp
+    end
+  end
+
+  test 'should return error code 1 when option is missing required argument' do
+    redirect_streams do |stdout, stderr|
+      exitval = Asciidoctor::Cli::Options.parse!(%w(-b))
+      assert_equal 1, exitval
+      assert_equal 'asciidoctor: option missing argument: -b', stderr.string.chomp
+    end
+  end
+
+  test 'should emit warning when unparsed options remain' do
+    redirect_streams do |stdout, stderr|
+      options = Asciidoctor::Cli::Options.parse!(%w(-b docbook extra junk test/fixtures/sample.asciidoc))
+      assert options.is_a? Hash
+      assert_equal 'asciidoctor: WARNING: extra arguments detected (unparsed arguments: \'extra\', \'junk\')', stderr.string.chomp
+    end
+  end
+
+  test 'basic argument assignment' do
+    options = Asciidoctor::Cli::Options.parse!(%w(-v -s -d book test/fixtures/sample.asciidoc))
+
+    assert_equal true, options[:verbose]
+    assert_equal false, options[:header_footer]
+    assert_equal 'book', options[:attributes]['doctype']
+    assert_equal 'test/fixtures/sample.asciidoc', options[:input_file]
+  end
+
+  test 'standard attribute assignment' do
+    options = Asciidoctor::Cli::Options.parse!(%w(-a imagesdir=images,icons test/fixtures/sample.asciidoc))
+
+    assert_equal 'images', options[:attributes]['imagesdir']
+    assert_equal '', options[:attributes]['icons']
+  end
+
+  test 'multiple attribute arguments' do
+    options = Asciidoctor::Cli::Options.parse!(%w(-a imagesdir=images -a icons test/fixtures/sample.asciidoc))
+
+    assert_equal 'images', options[:attributes]['imagesdir']
+    assert_equal '', options[:attributes]['icons']
+  end
+
+end

data/test/paragraphs_test.rb

@@ -17,6 +17,70 @@ context "Paragraphs" do
       rendered = render_string("Title\n=====\n\nPreamble.\n\n== First Section\n\nParagraph 1\n\nParagraph 2\n\n\n== Second Section\n\nLast words")
       assert_xpath '//p[text()="Paragraph 2"]', rendered, 1
     end
+
+    test 'does not treat wrapped line as a list item' do
+      input = <<-EOS
+paragraph
+. wrapped line
+      EOS
+
+      output = render_embedded_string input 
+      assert_css 'p', output, 1
+      assert_xpath %(//p[text()="paragraph\n. wrapped line"]), output, 1
+    end
+
+    test 'does not treat wrapped line as a block title' do
+      input = <<-EOS
+paragraph
+.wrapped line
+      EOS
+
+      output = render_embedded_string input 
+      assert_css 'p', output, 1
+      assert_xpath %(//p[text()="paragraph\n.wrapped line"]), output, 1
+    end
+
+    test 'expands index term macros in DocBook backend' do
+      input = <<-EOS
+Here is an index entry for ((tigers)).
+indexterm:[Big cats,Tigers,Siberian Tiger]
+Here is an index entry for indexterm2:[Linux].
+(((Operating Systems,Linux,Fedora)))
+Note that multi-entry terms generate separate index entries.
+      EOS
+
+      output = render_embedded_string input, :attributes => {'backend' => 'docbook45'}
+      assert_xpath '/simpara', output, 1
+      term1 = (xmlnodes_at_xpath '(//indexterm)[1]', output, 1).first
+      assert_equal '<indexterm><primary>tigers</primary></indexterm>', term1.to_s
+      assert term1.next.content.start_with?('tigers')
+
+      term2 = (xmlnodes_at_xpath '(//indexterm)[2]', output, 1).first
+      term2_elements = term2.elements
+      assert_equal 3, term2_elements.size
+      assert_equal '<primary>Big cats</primary>', term2_elements[0].to_s
+      assert_equal '<secondary>Tigers</secondary>', term2_elements[1].to_s
+      assert_equal '<tertiary>Siberian Tiger</tertiary>', term2_elements[2].to_s
+
+      term3 = (xmlnodes_at_xpath '(//indexterm)[3]', output, 1).first
+      term3_elements = term3.elements
+      assert_equal 2, term3_elements.size
+      assert_equal '<primary>Tigers</primary>', term3_elements[0].to_s
+      assert_equal '<secondary>Siberian Tiger</secondary>', term3_elements[1].to_s
+
+      term4 = (xmlnodes_at_xpath '(//indexterm)[4]', output, 1).first
+      term4_elements = term4.elements
+      assert_equal 1, term4_elements.size
+      assert_equal '<primary>Siberian Tiger</primary>', term4_elements[0].to_s
+
+      term5 = (xmlnodes_at_xpath '(//indexterm)[5]', output, 1).first
+      assert_equal '<indexterm><primary>Linux</primary></indexterm>', term5.to_s
+      assert term5.next.content.start_with?('Linux')
+
+      assert_xpath '(//indexterm)[6]/*', output, 3
+      assert_xpath '(//indexterm)[7]/*', output, 2
+      assert_xpath '(//indexterm)[8]/*', output, 1
+    end
   end
 
   context "code" do
@@ -58,7 +122,7 @@ You're good to go!
       output = render_string("[quote, A famous person, A famous book (1999)]\n____\nFamous quote.\n____")
       assert_xpath '//*[@class = "quoteblock"]', output, 1
       assert_xpath '//*[@class = "quoteblock"]/*[@class = "attribution"]', output, 1
-      assert_xpath '//*[@class = "quoteblock"]/*[@class = "attribution"]/em[text() = "A famous book (1999)"]', output, 1
+      assert_xpath '//*[@class = "quoteblock"]/*[@class = "attribution"]/cite[text() = "A famous book (1999)"]', output, 1
       # TODO I can't seem to match the attribution (author) w/ xpath
     end
 

data/test/reader_test.rb

@@ -231,15 +231,15 @@ include::include-file.asciidoc[]
   context 'build secure asset path' do
     test 'allows us to specify a path relative to the current dir' do
       doc = Asciidoctor::Document.new
-      reader = Asciidoctor::Reader.new(["foo"], doc)
+      Asciidoctor::Reader.new(["foo"], doc)
       legit_path = Dir.pwd + "/foo"
       assert_equal legit_path, doc.normalize_asset_path(legit_path)
     end
 
     test "keeps naughty absolute paths from getting outside" do
-      naughty_path = "/etc/passwd"
+      naughty_path = "#{disk_root}etc/passwd"
       doc = Asciidoctor::Document.new
-      reader = Asciidoctor::Reader.new(["foo"], doc)
+      Asciidoctor::Reader.new(["foo"], doc)
       secure_path = doc.normalize_asset_path(naughty_path)
       assert naughty_path != secure_path
       assert_match(/^#{doc.base_dir}/, secure_path)
@@ -248,7 +248,7 @@ include::include-file.asciidoc[]
     test "keeps naughty relative paths from getting outside" do
       naughty_path = "safe/ok/../../../../../etc/passwd"
       doc = Asciidoctor::Document.new
-      reader = Asciidoctor::Reader.new(["foo"], doc)
+      Asciidoctor::Reader.new(["foo"], doc)
       secure_path = doc.normalize_asset_path(naughty_path)
       assert naughty_path != secure_path
       assert_match(/^#{doc.base_dir}/, secure_path)
@@ -283,6 +283,20 @@ endif::holygrail[]
   end
 
   context 'Text processing' do
+    test 'should clean CRLF from end of lines' do
+      input = <<-EOS
+source\r
+with\r
+CRLF\r
+endlines\r
+      EOS
+
+      reader = Asciidoctor::Reader.new(input.lines.entries, Asciidoctor::Document.new)
+      reader.lines.each do |line|
+        assert !line.end_with?("\r\n")
+      end
+    end
+
     test 'sanitize attribute name' do
       assert_equal 'foobar', @reader.sanitize_attribute_name("Foo Bar")
       assert_equal 'foo', @reader.sanitize_attribute_name("foo")

data/test/{headers_test.rb → sections_test.rb}

@@ -28,6 +28,16 @@ context 'Sections' do
       assert_equal 'section_one', sec.id
     end
 
+    test 'synthetic id separator can be customized' do
+      sec = block_from_string(":idseparator: -\n\n== Section One")
+      assert_equal '_section-one', sec.id
+    end
+
+    test 'synthetic id separator can be set to blank' do
+      sec = block_from_string(":idseparator:\n\n== Section One")
+      assert_equal '_sectionone', sec.id
+    end
+
     test 'synthetic ids can be disabled' do
       sec = block_from_string(":sectids!:\n\n== Section One\n")
       assert sec.id.nil?
@@ -198,6 +208,119 @@ text
     end
   end
 
+  context 'Floating Title' do
+    test 'should create floating title if style is float' do
+      input = <<-EOS
+[float]
+= Plain Ol' Heading
+
+not in section
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '/h1[@id="_plain_ol_heading"]', output, 1
+      assert_xpath '/h1[@class="float"]', output, 1
+      assert_xpath %(/h1[@class="float"][text()="Plain Ol' Heading"]), output, 1
+      assert_xpath '/h1/following-sibling::*[@class="paragraph"]', output, 1
+      assert_xpath '/h1/following-sibling::*[@class="paragraph"]/p', output, 1
+      assert_xpath '/h1/following-sibling::*[@class="paragraph"]/p[text()="not in section"]', output, 1
+    end
+
+    test 'should create floating title if style is discrete' do
+      input = <<-EOS
+[discrete]
+=== Plain Ol' Heading
+
+not in section
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '/h3', output, 1
+      assert_xpath '/h3[@id="_plain_ol_heading"]', output, 1
+      assert_xpath '/h3[@class="discrete"]', output, 1
+      assert_xpath %(/h3[@class="discrete"][text()="Plain Ol' Heading"]), output, 1
+      assert_xpath '/h3/following-sibling::*[@class="paragraph"]', output, 1
+      assert_xpath '/h3/following-sibling::*[@class="paragraph"]/p', output, 1
+      assert_xpath '/h3/following-sibling::*[@class="paragraph"]/p[text()="not in section"]', output, 1
+    end
+
+    test 'floating title should be a block with context floating_title' do
+      input = <<-EOS
+[float]
+=== Plain Ol' Heading
+
+not in section
+      EOS
+
+      doc = document_from_string input
+      floatingtitle = doc.blocks.first
+      assert floatingtitle.is_a?(Asciidoctor::Block)
+      assert !floatingtitle.is_a?(Asciidoctor::Section)
+      assert_equal :floating_title, floatingtitle.context
+    end
+
+    test 'should not include floating title in toc' do
+      input = <<-EOS
+:toc:
+
+== Section One
+
+[float]
+=== Miss Independent
+
+== Section Two
+      EOS
+
+      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[text()="Miss Independent"]), output, 0
+    end
+
+    test 'should not set id on floating title if sectids attribute is unset' do
+      input = <<-EOS
+[float]
+=== Plain Ol' Heading
+
+not in section
+      EOS
+
+      output = render_embedded_string input, :attributes => {'sectids' => nil}
+      assert_xpath '/h3', output, 1
+      assert_xpath '/h3[@id="_plain_ol_heading"]', output, 0
+      assert_xpath '/h3[@class="float"]', output, 1
+    end
+
+    test 'should use explicit id for floating title if specified' do
+      input = <<-EOS
+[[free]]
+[float]
+== Plain Ol' Heading
+
+not in section
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '/h2', output, 1
+      assert_xpath '/h2[@id="free"]', output, 1
+      assert_xpath '/h2[@class="float"]', output, 1
+    end
+
+    test 'should add role to class attribute on floating title' do
+      input = <<-EOS
+[float, role="isolated"]
+== Plain Ol' Heading
+
+not in section
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '/h2', output, 1
+      assert_xpath '/h2[@id="_plain_ol_heading"]', output, 1
+      assert_xpath '/h2[@class="float isolated"]', 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)
@@ -306,6 +429,120 @@ paragraph
     end
   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.attr('caption')
+    end
+
+    test 'should render appendix title prefixed with caption' do
+      input = <<-EOS
+[appendix]
+== Attribute Options
+
+Details
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '//h2[text()="Appendix A: Attribute Options"]', output, 1
+    end
+
+    test 'should increment appendix number for each appendix section' do
+      input = <<-EOS
+[appendix]
+== Attribute Options
+
+Details
+
+[appendix]
+== Migration
+
+Details
+      EOS
+
+      output = render_embedded_string input
+      assert_xpath '(//h2)[1][text()="Appendix A: Attribute Options"]', output, 1
+      assert_xpath '(//h2)[2][text()="Appendix B: Migration"]', output, 1
+    end
+
+    test 'should not number special sections or subsections' do
+      input = <<-EOS
+:numbered:
+
+== Section One
+
+[appendix]
+== Attribute Options
+
+Details
+
+[appendix]
+== Migration
+
+Details
+
+=== Gotchas
+
+Details
+
+[glossary]
+== Glossary
+
+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
+    end
+
+    test 'should not number special sections or subsections in toc' do
+      input = <<-EOS
+:numbered:
+:toc:
+
+== Section One
+
+[appendix]
+== Attribute Options
+
+Details
+
+[appendix]
+== Migration
+
+Details
+
+=== Gotchas
+
+Details
+
+[glossary]
+== Glossary
+
+Terms
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@id="toc"]/ol//li/a[text()="1. Section One"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol//li/a[text()="Appendix A: Attribute Options"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol//li/a[text()="Appendix B: Migration"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol//li/a[text()="Gotchas"]', output, 1
+      assert_xpath '//*[@id="toc"]/ol//li/a[text()="Glossary"]', output, 1
+    end
+  end
+
   context "heading patterns in blocks" do
     test "should not interpret a listing block as a heading" do
       input = <<-EOS