asciidoctor 0.1.1 → 0.1.2

data/test/document_test.rb

@@ -19,6 +19,16 @@ context 'Document' do
       assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
     end
 
+    test 'safe mode attributes are set on document' do
+      doc = Asciidoctor::Document.new
+      assert_equal Asciidoctor::SafeMode::SECURE, doc.attr('safe-mode-level')
+      assert_equal 'secure', doc.attr('safe-mode-name')
+      assert doc.attr?('safe-mode-secure')
+      assert !doc.attr?('safe-mode-unsafe')
+      assert !doc.attr?('safe-mode-safe')
+      assert !doc.attr?('safe-mode-server')
+    end
+
     test 'safe mode level can be set in the constructor' do
       doc = Asciidoctor::Document.new [], :safe => Asciidoctor::SafeMode::SAFE
       assert_equal Asciidoctor::SafeMode::SAFE, doc.safe
@@ -94,6 +104,7 @@ preamble
   context 'Render APIs' do
     test 'should render document to string' do
       sample_input_path = fixture_path('sample.asciidoc')
+
       output = Asciidoctor.render_file(sample_input_path, :header_footer => true)
       assert !output.empty?
       assert_xpath '/html', output, 1
@@ -103,6 +114,165 @@ preamble
       assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
     end
 
+    test 'should include docinfo files for html backend' do
+      sample_input_path = fixture_path('basic.asciidoc')
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
+      assert !output.empty?
+      assert_css 'script[src="modernizr.js"]', output, 1
+      assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
+      assert !output.empty?
+      assert_css 'script[src="modernizr.js"]', output, 0
+      assert_css 'meta[http-equiv="imagetoolbar"]', output, 1
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
+      assert !output.empty?
+      assert_css 'script[src="modernizr.js"]', output, 1
+      assert_css 'meta[http-equiv="imagetoolbar"]', output, 1
+    end
+
+    test 'should include docinfo files for docbook backend' do
+      sample_input_path = fixture_path('basic.asciidoc')
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo' => ''})
+      assert !output.empty?
+      assert_css 'productname', output, 0
+      assert_css 'copyright', output, 1
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo1' => ''})
+      assert !output.empty?
+      assert_css 'productname', output, 1
+      assert_css 'copyright', output, 0
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docinfo2' => ''})
+      assert !output.empty?
+      assert_css 'productname', output, 1
+      assert_css 'copyright', output, 1
+    end
+
+    test 'should not include docinfo files by default' do
+      sample_input_path = fixture_path('basic.asciidoc')
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :safe => Asciidoctor::SafeMode::SERVER)
+      assert !output.empty?
+      assert_css 'script[src="modernizr.js"]', output, 0
+      assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :backend => 'docbook', :safe => Asciidoctor::SafeMode::SERVER)
+      assert !output.empty?
+      assert_css 'productname', output, 0
+      assert_css 'copyright', output, 0
+    end
+
+    test 'should not include docinfo files if safe mode is SECURE or greater' do
+      sample_input_path = fixture_path('basic.asciidoc')
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :attributes => {'docinfo2' => ''})
+      assert !output.empty?
+      assert_css 'script[src="modernizr.js"]', output, 0
+      assert_css 'meta[http-equiv="imagetoolbar"]', output, 0
+
+      output = Asciidoctor.render_file(sample_input_path,
+          :header_footer => true, :backend => 'docbook', :attributes => {'docinfo2' => ''})
+      assert !output.empty?
+      assert_css 'productname', output, 0
+      assert_css 'copyright', output, 0
+    end
+
+    test 'should link to default stylesheet by default' do
+      sample_input_path = fixture_path('basic.asciidoc')
+      output = Asciidoctor.render_file(sample_input_path, :header_footer => true)
+      assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
+    end
+
+    test 'should link to default stylesheet by default if linkcss is unset in document' do
+      input = <<-EOS
+= Document Title
+:linkcss!:
+
+text
+      EOS
+
+      output = Asciidoctor.render(input, :header_footer => true)
+      assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
+    end
+
+    test 'should link to default stylesheet by default if linkcss is unset' do
+      input = <<-EOS
+= Document Title
+
+text
+      EOS
+
+      output = Asciidoctor.render(input, :header_footer => true, :attributes => {'linkcss!' => ''})
+      assert_css 'html:root > head > link[rel="stylesheet"][href="./asciidoctor.css"]', output, 1
+    end
+
+    test 'should embed default stylesheet if safe mode is less than secure and linkcss is unset' do
+      sample_input_path = fixture_path('basic.asciidoc')
+      output = Asciidoctor.render_file(sample_input_path, :header_footer => true,
+          :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'linkcss!' => ''})
+      assert_css 'html:root > head > style', output, 1
+      stylenode = xmlnodes_at_css 'html:root > head > style', output, 1
+      styles = stylenode.first.content
+      assert !styles.nil?
+      assert !styles.strip.empty?
+    end
+
+    test 'should not link to stylesheet if stylesheet is unset' do
+      input = <<-EOS
+= Document Title
+
+text
+      EOS
+
+      output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet!' => ''})
+      assert_css 'html:root > head > link[rel="stylesheet"]', output, 0
+    end
+
+    test 'should link to custom stylesheet if specified in stylesheet attribute' do
+      input = <<-EOS
+= Document Title
+
+text
+      EOS
+
+      output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet' => './custom.css'})
+      assert_css 'html:root > head > link[rel="stylesheet"][href="./custom.css"]', output, 1
+    end
+
+    test 'should resolve custom stylesheet relative to stylesdir' do
+      input = <<-EOS
+= Document Title
+
+text
+      EOS
+
+      output = Asciidoctor.render(input, :header_footer => true, :attributes => {'stylesheet' => 'custom.css', 'stylesdir' => './stylesheets'})
+      assert_css 'html:root > head > link[rel="stylesheet"][href="./stylesheets/custom.css"]', output, 1
+    end
+
+    test 'should resolve custom stylesheet to embed relative to stylesdir' do
+      sample_input_path = fixture_path('basic.asciidoc')
+      output = Asciidoctor.render_file(sample_input_path, :header_footer => true, :safe => Asciidoctor::SafeMode::SAFE,
+          :attributes => {'stylesheet' => 'custom.css', 'stylesdir' => './stylesheets', 'linkcss!' => ''})
+      stylenode = xmlnodes_at_css 'html:root > head > style', output, 1
+      styles = stylenode.first.content
+      assert !styles.nil?
+      assert !styles.strip.empty?
+    end
+
     test 'should render document in place' do
       sample_input_path = fixture_path('sample.asciidoc')
       sample_output_path = fixture_path('sample.html')
@@ -219,7 +389,7 @@ preamble
       assert !renderer.nil?
       views = renderer.views
       assert !views.nil?
-      assert_equal 30, views.size
+      assert_equal 33, views.size
       assert views.has_key? 'document'
       assert views['document'].is_a?(Asciidoctor::HTML5::DocumentTemplate)
       assert_equal 'ERB', views['document'].eruby.to_s
@@ -235,7 +405,7 @@ preamble
       assert !renderer.nil?
       views = renderer.views
       assert !views.nil?
-      assert_equal 30, views.size
+      assert_equal 33, views.size
       assert views.has_key? 'document'
       assert views['document'].is_a?(Asciidoctor::DocBook45::DocumentTemplate)
       assert_equal 'ERB', views['document'].eruby.to_s
@@ -302,6 +472,23 @@ preamble
 
 preamble
 
+== First Section
+     EOS
+     doc = document_from_string input
+     assert_equal 'Override', doc.doctitle
+     assert_nil doc.title
+     assert doc.has_header?
+     assert_equal 'Override', doc.header.title
+     assert_equal 'Override', doc.first_section.title
+    end
+
+    test 'doctitle attribute entry above header overrides header title and doctitle' do
+     input = <<-EOS
+:doctitle: Override
+= Title
+
+preamble
+
 == First Section
      EOS
      doc = document_from_string input
@@ -357,14 +544,57 @@ more info...
       EOS
       output = render_string input
       assert_xpath '//*[@id="header"]/span[@id="author"][text() = "Stuart Rackham"]', output, 1
-      assert_xpath '//*[@id="header"]/span[@id="email"][contains(text(), "founder@asciidoc.org")]', output, 1
+      assert_xpath '//*[@id="header"]/span[@id="email"]/a[@href="mailto:founder@asciidoc.org"][text() = "founder@asciidoc.org"]', output, 1
       assert_xpath '//*[@id="header"]/span[@id="revnumber"][text() = "version 8.6.8,"]', output, 1
       assert_xpath '//*[@id="header"]/span[@id="revdate"][text() = "2012-07-12"]', output, 1
       assert_xpath '//*[@id="header"]/span[@id="revremark"][text() = "See changelog."]', output, 1
     end
 
+    test 'with metadata to DocBook' do
+      input = <<-EOS
+= AsciiDoc
+Stuart Rackham <founder@asciidoc.org>
+v8.6.8, 2012-07-12: See changelog.
+
+== Version 8.6.8
+
+more info...
+      EOS
+      output = render_string input, :backend => 'docbook'
+      assert_xpath '/article/articleinfo', output, 1
+      assert_xpath '/article/articleinfo/title[text() = "AsciiDoc"]', output, 1
+      assert_xpath '/article/articleinfo/date[text() = "2012-07-12"]', output, 1
+      assert_xpath '/article/articleinfo/author/firstname[text() = "Stuart"]', output, 1
+      assert_xpath '/article/articleinfo/author/surname[text() = "Rackham"]', output, 1
+      assert_xpath '/article/articleinfo/author/email[text() = "founder@asciidoc.org"]', output, 1
+      assert_xpath '/article/articleinfo/revhistory', output, 1
+      assert_xpath '/article/articleinfo/revhistory/revision', output, 1
+      assert_xpath '/article/articleinfo/revhistory/revision/revnumber[text() = "8.6.8"]', output, 1
+      assert_xpath '/article/articleinfo/revhistory/revision/date[text() = "2012-07-12"]', output, 1
+      assert_xpath '/article/articleinfo/revhistory/revision/authorinitials[text() = "SR"]', output, 1
+      assert_xpath '/article/articleinfo/revhistory/revision/revremark[text() = "See changelog."]', output, 1
+    end
+
+    test 'should create authorgroup in DocBook when multiple authors' do
+      input = <<-EOS
+= Document Title
+Doc Writer <thedoctor@asciidoc.org>; Junior Writer <junior@asciidoctor.org>
+
+content
+      EOS
+
+      output = render_string input, :backend => 'docbook'
+      assert_xpath '//articleinfo/author', output, 0
+      assert_xpath '//articleinfo/authorgroup', output, 1
+      assert_xpath '//articleinfo/authorgroup/author', output, 2
+      assert_xpath '//articleinfo/authorgroup/author[1]/firstname[text() = "Doc"]', output, 1
+      assert_xpath '//articleinfo/authorgroup/author[2]/firstname[text() = "Junior"]', output, 1
+    end
+
     test 'with header footer' do
-      result = render_string("= Title\n\npreamble")
+      doc = document_from_string "= Title\n\npreamble"
+      assert !doc.attr?('embedded')
+      result = doc.render
       assert_xpath '/html', result, 1
       assert_xpath '//*[@id="header"]', result, 1
       assert_xpath '//*[@id="header"]/h1', result, 1
@@ -373,7 +603,9 @@ more info...
     end
 
     test 'no header footer' do
-      result = render_string("= Title\n\npreamble", :header_footer => false)
+      doc = document_from_string "= Title\n\npreamble", :header_footer => false
+      assert doc.attr?('embedded')
+      result = doc.render
       assert_xpath '/html', result, 0
       assert_xpath '/h1', result, 0
       assert_xpath '/*[@id="header"]', result, 0
@@ -381,7 +613,7 @@ more info...
       assert_xpath '/*[@id="preamble"]', result, 1
     end
 
-    test 'wip enable title when no header footer' do
+    test 'enable title when no header footer' do
       result = render_string("= Title\n\npreamble", :header_footer => false, :attributes => {'notitle!' => ''})
       assert_xpath '/html', result, 0
       assert_xpath '/h1', result, 1
@@ -428,6 +660,24 @@ finally a reference to the second footnote footnoteref:[note2].
       text = xmlnodes_at_xpath '//div[@id="footnotes"]/div[@id="_footnote_2"]/text()', output, 1
       assert_equal '. Second footnote.', text.text.strip
     end
+
+    test 'renders footnotes block in embedded document by default' do
+      input = <<-EOS
+Text that has supporting information{empty}footnote:[An example footnote.].
+      EOS
+
+      output = render_string input, :header_footer => false
+      assert_css '#footnotes', output, 1
+    end
+
+    test 'does not render footnotes block in embedded document if nofootnotes attribute is set' do
+      input = <<-EOS
+Text that has supporting information{empty}footnote:[An example footnote.].
+      EOS
+
+      output = render_string input, :header_footer => false, :attributes => {'nofootnotes' => ''}
+      assert_css '#footnotes', output, 0
+    end
   end
 
   context 'Backends and Doctypes' do 
@@ -499,6 +749,19 @@ chapter body
       assert_xpath '/book/simpara[text() = "text"]', result, 1
     end
 
+    test 'docbook45 backend parses out subtitle' do
+      input = <<-EOS
+= Document Title: Subtitle
+:doctype: book
+
+text
+      EOS
+      result = render_string input, :backend => 'docbook45'
+      assert_xpath '/book', result, 1
+      assert_xpath '/book/bookinfo/title[text() = "Document Title"]', result, 1
+      assert_xpath '/book/bookinfo/subtitle[text() = "Subtitle"]', result, 1
+    end
+
     test 'should be able to set backend using :backend option key' do
       doc = Asciidoctor::Document.new([], :backend => 'html5')
       assert_equal 'html5', doc.attributes['backend']

data/test/fixtures/basic-docinfo.html

@@ -0,0 +1 @@
+<script src="modernizr.js"></script>

data/test/fixtures/basic-docinfo.xml

@@ -0,0 +1,4 @@
+<copyright>
+  <year>2013</year>
+  <holder>Acme, Inc.</holder>
+</copyright>

data/test/fixtures/basic.asciidoc

@@ -0,0 +1,4 @@
+= Document Title
+Doc Writer <doc.writer@asciidoc.org>
+
+Body content.

data/test/fixtures/docinfo.html

@@ -0,0 +1 @@
+<meta http-equiv="imagetoolbar" content="false">

data/test/fixtures/docinfo.xml

@@ -0,0 +1,2 @@
+<productname>Asciidoctor</productname>
+<productnumber>1.0.0</productnumber>

data/test/fixtures/include-file.asciidoc

@@ -1 +1,22 @@
-included content
+first line of included content
+second line of included content
+third line of included content
+fourth line of included content
+fifth line of included content
+sixth line of included content
+seventh line of included content
+eighth line of included content
+
+// tag::snippetA[]
+snippetA content
+// end::snippetA[]
+
+non-tagged content
+
+// tag::snippetB[]
+snippetB content
+// end::snippetB[]
+
+more non-tagged content
+
+last line of included content

data/test/fixtures/stylesheets/custom.css

@@ -0,0 +1,3 @@
+body {
+  color: red;
+}

data/test/invoker_test.rb

@@ -110,7 +110,7 @@ context 'Invoker' do
       assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
       assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
     ensure
-      FileUtils::rm(sample_outpath)
+      FileUtils::rm_f(sample_outpath)
     end
   end
 
@@ -119,12 +119,14 @@ context 'Invoker' do
     sample_outpath = File.join(destination_path, 'sample.html')
     begin
       FileUtils::mkdir_p(destination_path) 
+      # QUESTION should -D be relative to working directory or source directory?
       invoker = invoke_cli %w(-D test/test_output)
+      #invoker = invoke_cli %w(-D ../../test/test_output)
       doc = invoker.document
       assert_equal sample_outpath, doc.attr('outfile')
       assert File.exist?(sample_outpath)
     ensure
-      FileUtils::rm(sample_outpath)
+      FileUtils::rm_f(sample_outpath)
       FileUtils::rmdir(destination_path)
     end
   end
@@ -137,7 +139,21 @@ context 'Invoker' do
       assert_equal sample_outpath, doc.attr('outfile')
       assert File.exist?(sample_outpath)
     ensure
-      FileUtils::rm(sample_outpath)
+      FileUtils::rm_f(sample_outpath)
+    end
+  end
+
+  test 'should copy default css to target directory if copycss is specified' do
+    sample_outpath = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'sample-output.html'))
+    default_stylesheet = File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', 'asciidoctor.css'))
+    begin
+      invoker = invoke_cli %W(-o #{sample_outpath} -a copycss)
+      invoker.document
+      assert File.exist?(sample_outpath)
+      assert File.exist?(default_stylesheet)
+    ensure
+      FileUtils::rm_f(sample_outpath)
+      FileUtils::rm_f(default_stylesheet)
     end
   end
 
@@ -149,17 +165,33 @@ context 'Invoker' do
   end
 
   test 'should not compact output by default' do
-    invoker = invoke_cli_to_buffer(%w(-s -o -), '-') { 'content' }
+    # NOTE we are relying on the fact that the template leaves blank lines
+    # this will always fail when using a template engine which strips blank lines by default
+    invoker = invoke_cli_to_buffer(%w(-o -), '-') { '* content' }
     output = invoker.read_output
     assert_match(/\n[[:blank:]]*\n/, output)
   end
 
   test 'should compact output if specified' do
-    invoker = invoke_cli_to_buffer(%w(-C -s -o -), '-') { 'content' }
+    # NOTE we are relying on the fact that the template leaves blank lines
+    # this will always succeed when using a template engine which strips blank lines by default
+    invoker = invoke_cli_to_buffer(%w(-C -s -o -), '-') { '* content' }
     output = invoker.read_output
     assert_no_match(/\n[[:blank:]]*\n/, output)
   end
 
+  test 'should output a trailing endline to stdout' do
+    invoker = nil
+    output = nil
+    redirect_streams do |stdout, stderr|
+      invoker = invoke_cli %w(-o -)
+      output = stdout.string
+    end
+    assert !invoker.nil?
+    assert !output.nil?
+    assert output.end_with?("\n")
+  end
+
   test 'should set backend to html5 if specified' do
     invoker = invoke_cli_to_buffer %w(-b html5 -o -)
     doc = invoker.document
@@ -215,7 +247,7 @@ context 'Invoker' do
     doc = invoker.document
     assert_equal '', doc.attr('icons')
     output = invoker.read_output
-    assert_xpath '//*[@class="admonitionblock"]//img[@alt="Note"]', output, 1
+    assert_xpath '//*[@class="admonitionblock note"]//img[@alt="Note"]', output, 1
   end
 
   test 'should unset attribute ending in bang' do