asciidoctor 0.1.1 → 0.1.2

data/test/attributes_test.rb

@@ -181,6 +181,69 @@ Yo, {myfrog}!
       assert_match(/_cool_title/, result.css('h2').first.attr('id'))
     end
 
+    test 'interpolates attribute defined in header inside attribute entry in header' do
+      input = <<-EOS
+= Title
+Author Name
+:attribute-a: value
+:attribute-b: {attribute-a}
+
+preamble
+      EOS
+      doc = document_from_string(input, :parse_header_only => true)
+      assert_equal 'value', doc.attributes['attribute-b']
+    end
+
+    test 'interpolates author attribute inside attribute entry in header' do
+      input = <<-EOS
+= Title
+Author Name
+:name: {author}
+
+preamble
+      EOS
+      doc = document_from_string(input, :parse_header_only => true)
+      assert_equal 'Author Name', doc.attributes['name']
+    end
+
+    test 'interpolates revinfo attribute inside attribute entry in header' do
+      input = <<-EOS
+= Title
+Author Name
+2013-01-01
+:date: {revdate}
+
+preamble
+      EOS
+      doc = document_from_string(input, :parse_header_only => true)
+      assert_equal '2013-01-01', doc.attributes['date']
+    end
+
+    test 'attribute entries can resolve previously defined attributes' do
+      input = <<-EOS
+= Title
+Author Name
+v1.0, 2010-01-01: First release!
+:a: value
+:a2: {a}
+:revdate2: {revdate}
+
+{a} == {a2}
+
+{revdate} == {revdate2}
+      EOS
+
+      doc = document_from_string input
+      assert_equal '2010-01-01', doc.attr('revdate')
+      assert_equal '2010-01-01', doc.attr('revdate2')
+      assert_equal 'value', doc.attr('a')
+      assert_equal 'value', doc.attr('a2')
+
+      output = doc.render
+      assert output.include?('value == value')
+      assert output.include?('2010-01-01 == 2010-01-01')
+    end
+
     test 'substitutes inside block title' do
       input = <<-EOS
 :gem_name: asciidoctor
@@ -189,7 +252,7 @@ Yo, {myfrog}!
 To use {gem_name}, the first thing to do is to import it in your Ruby source file.
       EOS
       output = render_embedded_string input
-      assert_xpath '//*[@class="title"]/tt[text()="asciidoctor"]', output, 1
+      assert_xpath '//*[@class="title"]/code[text()="asciidoctor"]', output, 1
     end
 
     test 'renders attribute until it is deleted' do
@@ -365,10 +428,10 @@ of the attribute named foo in your document.
     
   end
 
-  context "Block attributes" do
-    test "Position attributes assigned to block" do
+  context 'Block attributes' do
+    test 'Positional attributes assigned to block' do
       input = <<-EOS
-[quote, Name, Source]
+[quote, author, source]
 ____
 A famous quote.
 ____
@@ -377,13 +440,13 @@ ____
       qb = doc.blocks.first
       assert_equal 'quote', qb.attributes['style']
       assert_equal 'quote', qb.attr(:style)
-      assert_equal 'Name', qb.attributes['attribution']
-      assert_equal 'Source', qb.attributes['citetitle']
+      assert_equal 'author', qb.attributes['attribution']
+      assert_equal 'source', qb.attributes['citetitle']
     end
 
-    test "Normal substitutions are performed on single-quoted attributes" do
+    test 'Normal substitutions are performed on single-quoted attributes' do
       input = <<-EOS
-[quote, Name, 'http://wikipedia.org[Source]']
+[quote, author, 'http://wikipedia.org[source]']
 ____
 A famous quote.
 ____
@@ -392,8 +455,68 @@ ____
       qb = doc.blocks.first
       assert_equal 'quote', qb.attributes['style']
       assert_equal 'quote', qb.attr(:style)
-      assert_equal 'Name', qb.attributes['attribution']
-      assert_equal '<a href="http://wikipedia.org">Source</a>', qb.attributes['citetitle']
+      assert_equal 'author', qb.attributes['attribution']
+      assert_equal '<a href="http://wikipedia.org">source</a>', qb.attributes['citetitle']
+    end
+
+    test 'attribute list may begin with space' do
+      input = <<-EOS
+[ quote]
+____
+A famous quote.
+____
+      EOS
+
+      doc = document_from_string input
+      qb = doc.blocks.first
+      assert_equal 'quote', qb.attributes['style']
+    end
+
+    test 'attribute list may begin with comma' do
+      input = <<-EOS
+[, author, source]
+____
+A famous quote.
+____
+      EOS
+
+      doc = document_from_string input
+      qb = doc.blocks.first
+      assert_equal 'quote', qb.attributes['style']
+      assert_equal 'author', qb.attributes['attribution']
+      assert_equal 'source', qb.attributes['citetitle']
+    end
+
+    test 'first attribute in list may be double quoted' do
+      input = <<-EOS
+["quote", "author", "source", role="famous"]
+____
+A famous quote.
+____
+      EOS
+
+      doc = document_from_string input
+      qb = doc.blocks.first
+      assert_equal 'quote', qb.attributes['style']
+      assert_equal 'author', qb.attributes['attribution']
+      assert_equal 'source', qb.attributes['citetitle']
+      assert_equal 'famous', qb.attributes['role']
+    end
+
+    test 'first attribute in list may be single quoted' do
+      input = <<-EOS
+['quote', 'author', 'source', role='famous']
+____
+A famous quote.
+____
+      EOS
+
+      doc = document_from_string input
+      qb = doc.blocks.first
+      assert_equal 'quote', qb.attributes['style']
+      assert_equal 'author', qb.attributes['attribution']
+      assert_equal 'source', qb.attributes['citetitle']
+      assert_equal 'famous', qb.attributes['role']
     end
 
     test "Attribute substitutions are performed on attribute list before parsing attributes" do

data/test/blocks_test.rb

@@ -18,9 +18,9 @@ context "Blocks" do
 
     test "page break" do
       output = render_embedded_string("page 1\n\n<<<\n\npage 2")
-      assert_xpath '/*[@style="page-break-after: always"]', output, 1
-      assert_xpath '/*[@style="page-break-after: always"]/preceding-sibling::div/p[text()="page 1"]', output, 1
-      assert_xpath '/*[@style="page-break-after: always"]/following-sibling::div/p[text()="page 2"]', output, 1
+      assert_xpath '/*[@style="page-break-after: always;"]', output, 1
+      assert_xpath '/*[@style="page-break-after: always;"]/preceding-sibling::div/p[text()="page 1"]', output, 1
+      assert_xpath '/*[@style="page-break-after: always;"]/following-sibling::div/p[text()="page 2"]', output, 1
     end
   end
 
@@ -239,7 +239,7 @@ TIP: Override the caption of an admonition block using an attribute entry
        EOS
 
        output = render_embedded_string input
-       assert_xpath '/*[@class="admonitionblock"]//*[@class="icon"]/*[@class="title"][text()="Pro Tip"]', output, 1
+       assert_xpath '/*[@class="admonitionblock tip"]//*[@class="icon"]/*[@class="title"][text()="Pro Tip"]', output, 1
     end
 
     test 'can override caption of admonition block using document attribute' do
@@ -250,7 +250,7 @@ TIP: Override the caption of an admonition block using an attribute entry
        EOS
 
        output = render_embedded_string input
-       assert_xpath '/*[@class="admonitionblock"]//*[@class="icon"]/*[@class="title"][text()="Pro Tip"]', output, 1
+       assert_xpath '/*[@class="admonitionblock tip"]//*[@class="icon"]/*[@class="title"][text()="Pro Tip"]', output, 1
     end
 
     test 'blank caption document attribute should not blank admonition block caption' do
@@ -261,7 +261,7 @@ TIP: Override the caption of an admonition block using an attribute entry
        EOS
 
        output = render_embedded_string input
-       assert_xpath '/*[@class="admonitionblock"]//*[@class="icon"]/*[@class="title"][text()="Tip"]', output, 1
+       assert_xpath '/*[@class="admonitionblock tip"]//*[@class="icon"]/*[@class="title"][text()="Tip"]', output, 1
     end
   end
 
@@ -367,6 +367,23 @@ EOS
       }
     end
 
+    test 'should not compact nested document twice' do
+      input = <<-EOS
+|===
+a|....
+line one
+
+line two
+
+line three
+....
+|===
+      EOS
+
+      output = render_string input, :compact => true
+      assert_xpath %(//pre[text() = "line one\n\nline two\n\nline three"]), output, 1
+    end
+
     test 'should process block with CRLF endlines' do
       input = <<-EOS
 [source]\r
@@ -382,6 +399,54 @@ source line 2\r
       assert_xpath '/*[@class="listingblock"]//pre/code', output, 1
       assert_xpath %(/*[@class="listingblock"]//pre/code[text()="source line 1\nsource line 2"]), output, 1
     end
+
+    test 'literal block should honor explicit subs list' do
+      input = <<-EOS
+[subs="verbatim,quotes"]
+----
+Map<String, String> *attributes*; //<1>
+----
+      EOS
+
+      output = render_embedded_string input
+      assert output.include?('Map&lt;String, String&gt; <strong>attributes</strong>;')
+      assert output.include?('1')
+    end
+
+    test 'listing block should honor explicit subs list' do
+      input = <<-EOS
+[subs="specialcharacters,quotes"]
+----
+$ *python functional_tests.py*
+Traceback (most recent call last):
+  File "functional_tests.py", line 4, in <module>
+    assert 'Django' in browser.title
+AssertionError
+----
+      EOS
+
+      output = render_embedded_string input
+
+      assert_css '.listingblock pre', output, 1
+      assert_css '.listingblock pre strong', output, 1
+      assert_css '.listingblock pre em', output, 1
+
+      input2 = <<-EOS
+[subs="specialcharacters,macros"]
+----
+$ pass:quotes[*python functional_tests.py*]
+Traceback (most recent call last):
+  File "functional_tests.py", line 4, in <module>
+    assert pass:quotes['Django'] in browser.title
+AssertionError
+----
+      EOS
+
+      output2 = render_embedded_string input2
+      # FIXME JRuby is adding extra trailing endlines in the second document,
+      # so rstrip is necessary
+      assert_equal output.rstrip, output2.rstrip
+    end
   end
 
   context "Open Blocks" do
@@ -500,10 +565,36 @@ paragraph
       output = render_string input
       assert_xpath '//*[@class="sect1"]//*[@class="paragraph"]/*[@class="title"][text() = "Block title"]', output, 1
     end
+
+    test 'empty attribute list should not appear in output' do
+      input = <<-EOS
+[]
+--
+Block content
+--
+      EOS
+
+      output = render_embedded_string input
+      assert output.include?('Block content')
+      assert !output.include?('[]')
+    end
+
+    test 'empty block anchor should not appear in output' do
+      input = <<-EOS
+[[]]
+--
+Block content
+--
+      EOS
+
+      output = render_embedded_string input
+      assert output.include?('Block content')
+      assert !output.include?('[[]]')
+    end
   end
 
-  context "Images" do
-    test "can render block image with alt text" do
+  context 'Images' do
+    test 'can render block image with alt text defined in macro' do
       input = <<-EOS
 image::images/tiger.png[Tiger]
       EOS
@@ -512,6 +603,36 @@ image::images/tiger.png[Tiger]
       assert_xpath '//*[@class="imageblock"]//img[@src="images/tiger.png"][@alt="Tiger"]', output, 1
     end
 
+    test 'can render block image with alt text defined in macro containing escaped square bracket' do
+      input = <<-EOS
+image::images/tiger.png[A [Bengal\\] Tiger]
+      EOS
+
+      output = render_string input
+      img = xmlnodes_at_xpath '//img', output, 1
+      assert_equal 'A [Bengal] Tiger', img.attr('alt').value
+    end
+
+    test 'can render block image with alt text defined in block attribute above macro' do
+      input = <<-EOS
+[Tiger]
+image::images/tiger.png[]
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@class="imageblock"]//img[@src="images/tiger.png"][@alt="Tiger"]', output, 1
+    end
+
+    test 'alt text in macro overrides alt text above macro' do
+      input = <<-EOS
+[Alt Text]
+image::images/tiger.png[Tiger]
+      EOS
+
+      output = render_string input
+      assert_xpath '//*[@class="imageblock"]//img[@src="images/tiger.png"][@alt="Tiger"]', output, 1
+    end
+
     test "can render block image with auto-generated alt text" do
       input = <<-EOS
 image::images/tiger.png[]
@@ -552,7 +673,43 @@ image::images/tiger.png[Tiger]
       assert_equal 1, doc.attributes['figure-number']
     end
 
-    test 'should pass through image that is a uri reference' do
+    test 'can render block image with explicit caption' do
+      input = <<-EOS
+[caption="Voila! "]
+.The AsciiDoc Tiger
+image::images/tiger.png[Tiger]
+      EOS
+
+      doc = document_from_string input
+      output = doc.render
+      assert_xpath '//*[@class="imageblock"]//img[@src="images/tiger.png"][@alt="Tiger"]', output, 1
+      assert_xpath '//*[@class="imageblock"]/*[@class="title"][text() = "Voila! The AsciiDoc Tiger"]', output, 1
+      assert !doc.attributes.has_key?('figure-number')
+    end
+
+    test 'drops line if image target is missing attribute reference' do
+      input = <<-EOS
+image::{bogus}[]
+      EOS
+
+      output = render_embedded_string input
+      assert output.strip.empty?
+    end
+
+    test 'dropped image does not break processing of following section' do
+      input = <<-EOS
+image::{bogus}[]
+
+== Section Title
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'img', output, 0
+      assert_css 'h2', output, 1 
+      assert !output.include?('== Section Title')
+    end
+
+    test 'should pass through image that references uri' do
       input = <<-EOS
 :imagesdir: images
 
@@ -589,19 +746,147 @@ image::dot.gif[Dot]
     end
 
     # this test will cause a warning to be printed to the console (until we have a message facility)
-    test 'cleans reference to ancestor directories before reading image if safe mode level is at least SAFE' do
+    test 'cleans reference to ancestor directories in imagesdir before reading image if safe mode level is at least SAFE' do
       input = <<-EOS
 :data-uri:
-:imagesdir: ../fixtures
+:imagesdir: ../..//fixtures/./../../fixtures
 
 image::dot.gif[Dot]
       EOS
 
       doc = document_from_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
-      assert_equal '../fixtures', doc.attributes['imagesdir']
+      assert_equal '../..//fixtures/./../../fixtures', doc.attributes['imagesdir']
       output = doc.render
+      # image target resolves to fixtures/dot.gif relative to docdir (which is explicitly set to the directory of this file)
+      # the reference cannot fall outside of the document directory in safe mode
       assert_xpath '//*[@class="imageblock"]//img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Dot"]', output, 1
     end
+
+    test 'cleans reference to ancestor directories in target before reading image if safe mode level is at least SAFE' do
+      input = <<-EOS
+:data-uri:
+:imagesdir: ./
+
+image::../..//fixtures/./../../fixtures/dot.gif[Dot]
+      EOS
+
+      doc = document_from_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
+      assert_equal './', doc.attributes['imagesdir']
+      output = doc.render
+      # image target resolves to fixtures/dot.gif relative to docdir (which is explicitly set to the directory of this file)
+      # the reference cannot fall outside of the document directory in safe mode
+      assert_xpath '//*[@class="imageblock"]//img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Dot"]', output, 1
+    end
+  end
+
+  context 'Media' do
+    test 'should detect and render video macro' do
+      input = <<-EOS
+video::cats-vs-dogs.avi[]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[src="cats-vs-dogs.avi"]', output, 1
+    end
+
+    test 'should detect and render video macro with positional attributes for poster and dimensions' do
+      input = <<-EOS
+video::cats-vs-dogs.avi[cats-and-dogs.png, 200, 300]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[src="cats-vs-dogs.avi"]', output, 1
+      assert_css 'video[poster="cats-and-dogs.png"]', output, 1
+      assert_css 'video[width="200"]', output, 1
+      assert_css 'video[height="300"]', output, 1
+    end
+
+    test 'video macro should honor all options' do
+      input = <<-EOS
+video::cats-vs-dogs.avi[options="autoplay,nocontrols,loop"]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[autoplay]', output, 1
+      assert_css 'video:not([controls])', output, 1
+      assert_css 'video[loop]', output, 1
+    end
+
+    test 'video macro should use imagesdir attribute to resolve target and poster' do
+      input = <<-EOS
+:imagesdir: assets
+
+video::cats-vs-dogs.avi[cats-and-dogs.png, 200, 300]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[src="assets/cats-vs-dogs.avi"]', output, 1
+      assert_css 'video[poster="assets/cats-and-dogs.png"]', output, 1
+      assert_css 'video[width="200"]', output, 1
+      assert_css 'video[height="300"]', output, 1
+    end
+
+    test 'video macro should not use imagesdir attribute to resolve target if target is a URL' do
+      input = <<-EOS
+:imagesdir: assets
+
+video::http://example.org/videos/cats-vs-dogs.avi[]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[src="http://example.org/videos/cats-vs-dogs.avi"]', output, 1
+    end
+
+    test 'should detect and render audio macro' do
+      input = <<-EOS
+audio::podcast.mp3[]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'audio', output, 1
+      assert_css 'audio[src="podcast.mp3"]', output, 1
+    end
+
+    test 'audio macro should use imagesdir attribute to resolve target' do
+      input = <<-EOS
+:imagesdir: assets
+
+audio::podcast.mp3[]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'audio', output, 1
+      assert_css 'audio[src="assets/podcast.mp3"]', output, 1
+    end
+
+    test 'audio macro should not use imagesdir attribute to resolve target if target is a URL' do
+      input = <<-EOS
+:imagesdir: assets
+
+video::http://example.org/podcast.mp3[]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'video', output, 1
+      assert_css 'video[src="http://example.org/podcast.mp3"]', output, 1
+    end
+
+    test 'audio macro should honor all options' do
+      input = <<-EOS
+audio::podcast.mp3[options="autoplay,nocontrols,loop"]
+      EOS
+
+      output = render_embedded_string input
+      assert_css 'audio', output, 1
+      assert_css 'audio[autoplay]', output, 1
+      assert_css 'audio:not([controls])', output, 1
+      assert_css 'audio[loop]', output, 1
+    end
   end
 
   context 'Admonition icons' do
@@ -614,7 +899,7 @@ You can use icons for admonitions by setting the 'icons' attribute.
       EOS
 
       output = render_string input, :safe => Asciidoctor::SafeMode::SERVER
-      assert_xpath '//*[@class="admonitionblock"]//*[@class="icon"]/img[@src="images/icons/tip.png"][@alt="Tip"]', output, 1
+      assert_xpath '//*[@class="admonitionblock tip"]//*[@class="icon"]/img[@src="./images/icons/tip.png"][@alt="Tip"]', output, 1
     end
 
     test 'can resolve icon relative to custom iconsdir' do
@@ -627,7 +912,7 @@ You can use icons for admonitions by setting the 'icons' attribute.
       EOS
 
       output = render_string input, :safe => Asciidoctor::SafeMode::SERVER
-      assert_xpath '//*[@class="admonitionblock"]//*[@class="icon"]/img[@src="icons/tip.png"][@alt="Tip"]', output, 1
+      assert_xpath '//*[@class="admonitionblock tip"]//*[@class="icon"]/img[@src="icons/tip.png"][@alt="Tip"]', output, 1
     end
 
     test 'embeds base64-encoded data uri of icon when data-uri attribute is set and safe mode level is less than SECURE' do
@@ -642,7 +927,7 @@ You can use icons for admonitions by setting the 'icons' attribute.
       EOS
 
       output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
-      assert_xpath '//*[@class="admonitionblock"]//*[@class="icon"]/img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Tip"]', output, 1
+      assert_xpath '//*[@class="admonitionblock tip"]//*[@class="icon"]/img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Tip"]', output, 1
     end
 
     test 'does not embed base64-encoded data uri of icon when safe mode level is SECURE or greater' do
@@ -657,7 +942,7 @@ You can use icons for admonitions by setting the 'icons' attribute.
       EOS
 
       output = render_string input, :attributes => {'icons' => ''}
-      assert_xpath '//*[@class="admonitionblock"]//*[@class="icon"]/img[@src="fixtures/tip.gif"][@alt="Tip"]', output, 1
+      assert_xpath '//*[@class="admonitionblock tip"]//*[@class="icon"]/img[@src="fixtures/tip.gif"][@alt="Tip"]', output, 1
     end
 
     test 'cleans reference to ancestor directories before reading icon if safe mode level is at least SAFE' do
@@ -672,7 +957,7 @@ You can use icons for admonitions by setting the 'icons' attribute.
       EOS
 
       output = render_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => File.dirname(__FILE__)}
-      assert_xpath '//*[@class="admonitionblock"]//*[@class="icon"]/img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Tip"]', output, 1
+      assert_xpath '//*[@class="admonitionblock tip"]//*[@class="icon"]/img[@src="data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs="][@alt="Tip"]', output, 1
     end
   end