asciidoctor 0.1.2 → 0.1.3

data/test/document_test.rb

@@ -19,6 +19,30 @@ context 'Document' do
       assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
     end
 
+    test 'safe mode level set using string' do
+      doc = Asciidoctor::Document.new [], :safe => 'server'
+      assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
+
+      doc = Asciidoctor::Document.new [], :safe => 'foo'
+      assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
+    end
+
+    test 'safe mode level set using symbol' do
+      doc = Asciidoctor::Document.new [], :safe => :server
+      assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
+
+      doc = Asciidoctor::Document.new [], :safe => :foo
+      assert_equal Asciidoctor::SafeMode::SECURE, doc.safe
+    end
+
+    test 'safe mode level set using integer' do
+      doc = Asciidoctor::Document.new [], :safe => 10
+      assert_equal Asciidoctor::SafeMode::SERVER, doc.safe
+
+      doc = Asciidoctor::Document.new [], :safe => 100
+      assert_equal 100, 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')
@@ -99,6 +123,65 @@ preamble
       assert !doc.attr?('docfile')
       assert_equal doc.base_dir, doc.attr('docdir')
     end
+
+    test 'should accept attributes as array' do
+	  # NOTE there's a tab character before idseparator
+      doc = Asciidoctor.load('text', :attributes => %w(toc numbered   source-highlighter=coderay idprefix	idseparator=-))
+      assert doc.attributes.is_a?(Hash)
+      assert doc.attr?('toc')
+      assert_equal '', doc.attr('toc')
+      assert doc.attr?('numbered')
+      assert_equal '', doc.attr('numbered')
+      assert doc.attr?('source-highlighter')
+      assert_equal 'coderay', doc.attr('source-highlighter')
+      assert doc.attr?('idprefix')
+      assert_equal '', doc.attr('idprefix')
+      assert doc.attr?('idseparator')
+      assert_equal '-', doc.attr('idseparator')
+    end
+
+    test 'should accept attributes as empty array' do
+      doc = Asciidoctor.load('text', :attributes => [])
+      assert doc.attributes.is_a?(Hash)
+    end
+
+    test 'should accept attributes as string' do
+	  # NOTE there's a tab character before idseparator
+      doc = Asciidoctor.load('text', :attributes => 'toc numbered  source-highlighter=coderay idprefix	idseparator=-')
+      assert doc.attributes.is_a?(Hash)
+      assert doc.attr?('toc')
+      assert_equal '', doc.attr('toc')
+      assert doc.attr?('numbered')
+      assert_equal '', doc.attr('numbered')
+      assert doc.attr?('source-highlighter')
+      assert_equal 'coderay', doc.attr('source-highlighter')
+      assert doc.attr?('idprefix')
+      assert_equal '', doc.attr('idprefix')
+      assert doc.attr?('idseparator')
+      assert_equal '-', doc.attr('idseparator')
+    end
+
+    test 'should accept values containing spaces in attributes string' do
+	  # NOTE there's a tab character before self:
+      doc = Asciidoctor.load('text', :attributes => 'idprefix idseparator=-   note-caption=Note\ to\	self: toc')
+      assert doc.attributes.is_a?(Hash)
+      assert doc.attr?('idprefix')
+      assert_equal '', doc.attr('idprefix')
+      assert doc.attr?('idseparator')
+      assert_equal '-', doc.attr('idseparator')
+      assert doc.attr?('note-caption')
+      assert_equal "Note to	self:", doc.attr('note-caption')
+    end
+
+    test 'should accept attributes as empty string' do
+      doc = Asciidoctor.load('text', :attributes => '')
+      assert doc.attributes.is_a?(Hash)
+    end
+
+    test 'should accept attributes as nil' do
+      doc = Asciidoctor.load('text', :attributes => nil)
+      assert doc.attributes.is_a?(Hash)
+    end
   end
 
   context 'Render APIs' do
@@ -114,6 +197,18 @@ preamble
       assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
     end
 
+    test 'should accept attributes as array' do
+      sample_input_path = fixture_path('sample.asciidoc')
+      output = Asciidoctor.render_file(sample_input_path, :attributes => %w(numbered idprefix idseparator=-))
+      assert_css '#section-a', output, 1
+    end
+
+    test 'should accept attributes as string' do
+      sample_input_path = fixture_path('sample.asciidoc')
+      output = Asciidoctor.render_file(sample_input_path, :attributes => 'numbered idprefix idseparator=-')
+      assert_css '#section-a', output, 1
+    end
+
     test 'should include docinfo files for html backend' do
       sample_input_path = fixture_path('basic.asciidoc')
 
@@ -309,6 +404,27 @@ text
       end
     end
 
+    test 'should render document to file when base dir is set' do
+      sample_input_path = fixture_path('sample.asciidoc')
+      sample_output_path = fixture_path('result.html')
+      fixture_dir = fixture_path('')
+      begin
+        Asciidoctor.render_file(sample_input_path, :to_file => 'result.html', :base_dir => fixture_dir)
+        assert File.exist?(sample_output_path)
+        output = File.read(sample_output_path)
+        assert !output.empty?
+        assert_xpath '/html', output, 1
+        assert_xpath '/html/head', output, 1
+        assert_xpath '/html/body', output, 1
+        assert_xpath '/html/head/title[text() = "Document Title"]', output, 1
+        assert_xpath '/html/body/*[@id="header"]/h1[text() = "Document Title"]', output, 1
+      rescue => e
+        flunk e.message
+      ensure
+        FileUtils::rm(sample_output_path, :force => true)
+      end
+    end
+
     test 'in_place option must not be used with to_file option' do
       sample_input_path = fixture_path('sample.asciidoc')
       sample_output_path = fixture_path('result.html')
@@ -347,7 +463,7 @@ text
       end
     end
 
-    test 'missing directories should be created if specified' do
+    test 'missing directories should be created if mkdirs is enabled' do
       sample_input_path = fixture_path('sample.asciidoc')
       output_dir = File.join(File.join(File.dirname(sample_input_path), 'test_output'), 'subdir')
       sample_output_path = File.join(output_dir, 'sample.html')
@@ -389,7 +505,7 @@ text
       assert !renderer.nil?
       views = renderer.views
       assert !views.nil?
-      assert_equal 33, views.size
+      assert_equal 36, views.size
       assert views.has_key? 'document'
       assert views['document'].is_a?(Asciidoctor::HTML5::DocumentTemplate)
       assert_equal 'ERB', views['document'].eruby.to_s
@@ -405,7 +521,7 @@ text
       assert !renderer.nil?
       views = renderer.views
       assert !views.nil?
-      assert_equal 33, views.size
+      assert_equal 36, views.size
       assert views.has_key? 'document'
       assert views['document'].is_a?(Asciidoctor::DocBook45::DocumentTemplate)
       assert_equal 'ERB', views['document'].eruby.to_s
@@ -450,27 +566,49 @@ preamble
 
     test 'document with title attribute entry overrides doctitle' do
      input = <<-EOS
-= Title
-:title: Document Title
+= Document Title
+:title: Override
 
-preamble
+{doctitle}
 
 == First Section
      EOS
      doc = document_from_string input
-     assert_equal 'Document Title', doc.doctitle
-     assert_equal 'Document Title', doc.title
+     assert_equal 'Override', doc.doctitle
+     assert_equal 'Override', doc.title
      assert doc.has_header?
-     assert_equal 'Title', doc.header.title
-     assert_equal 'Title', doc.first_section.title
+     assert_equal 'Document Title', doc.header.title
+     assert_equal 'Document Title', doc.first_section.title
+     assert_xpath '//*[@id="preamble"]//p[text()="Document Title"]', doc.render, 1
+    end
+
+    test 'document with title attribute entry overrides doctitle attribute entry' do
+     input = <<-EOS
+= Document Title
+:snapshot: {doctitle}
+:doctitle: doctitle
+:title: Override
+
+{snapshot}, {doctitle}
+
+== First Section
+     EOS
+     doc = document_from_string input
+     assert_equal 'Override', doc.doctitle
+     assert_equal 'Override', doc.title
+     assert doc.has_header?
+     assert_equal 'doctitle', doc.header.title
+     assert_equal 'doctitle', doc.first_section.title
+     assert_xpath '//*[@id="preamble"]//p[text()="Document Title, doctitle"]', doc.render, 1
     end
 
     test 'document with doctitle attribute entry overrides header title and doctitle' do
      input = <<-EOS
-= Title
+= Document Title
+:snapshot: {doctitle}
 :doctitle: Override
 
-preamble
+{snapshot}, {doctitle}
 
 == First Section
      EOS
@@ -480,14 +618,15 @@ preamble
      assert doc.has_header?
      assert_equal 'Override', doc.header.title
      assert_equal 'Override', doc.first_section.title
+     assert_xpath '//*[@id="preamble"]//p[text()="Document Title, Override"]', doc.render, 1
     end
 
     test 'doctitle attribute entry above header overrides header title and doctitle' do
      input = <<-EOS
 :doctitle: Override
-= Title
+= Document Title
 
-preamble
+{doctitle}
 
 == First Section
      EOS
@@ -497,6 +636,7 @@ preamble
      assert doc.has_header?
      assert_equal 'Override', doc.header.title
      assert_equal 'Override', doc.first_section.title
+     assert_xpath '//*[@id="preamble"]//p[text()="Override"]', doc.render, 1
     end
 
     test 'should recognize document title when preceded by blank lines' do
@@ -575,6 +715,23 @@ more info...
       assert_xpath '/article/articleinfo/revhistory/revision/revremark[text() = "See changelog."]', output, 1
     end
 
+    test 'with author defined using attribute entry to DocBook' do
+      input = <<-EOS
+= Document Title
+:author: Doc Writer
+:email: thedoctor@asciidoc.org
+
+content
+      EOS
+
+      output = render_string input, :backend => 'docbook'
+      assert_xpath '//articleinfo/author', output, 1
+      assert_xpath '//articleinfo/author/firstname[text() = "Doc"]', output, 1
+      assert_xpath '//articleinfo/author/surname[text() = "Writer"]', output, 1
+      assert_xpath '//articleinfo/author/email[text() = "thedoctor@asciidoc.org"]', output, 1
+      assert_xpath '//articleinfo/authorinitials[text() = "DW"]', output, 1
+    end
+
     test 'should create authorgroup in DocBook when multiple authors' do
       input = <<-EOS
 = Document Title
@@ -591,6 +748,26 @@ content
       assert_xpath '//articleinfo/authorgroup/author[2]/firstname[text() = "Junior"]', output, 1
     end
 
+    test 'with authors defined using attribute entry to DocBook' do
+      input = <<-EOS
+= Document Title
+:authors: Doc Writer; Junior Writer
+:email_1: thedoctor@asciidoc.org
+:email_2: junior@asciidoc.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)[1]/email[text() = "thedoctor@asciidoc.org"]', output, 1
+      assert_xpath '(//articleinfo/authorgroup/author)[2]/firstname[text() = "Junior"]', output, 1
+      assert_xpath '(//articleinfo/authorgroup/author)[2]/email[text() = "junior@asciidoc.org"]', output, 1
+    end
+
     test 'with header footer' do
       doc = document_from_string "= Title\n\npreamble"
       assert !doc.attr?('embedded')

data/test/fixtures/encoding.asciidoc

@@ -3,3 +3,11 @@ Gregory Romé has written an AsciiDoc plugin for the Redmine project management
 https://github.com/foo-users/foo
 へと `vicmd` キーマップを足してみている試み、
 アニメーションgifです。
+
+tag::romé[]
+Gregory Romé has written an AsciiDoc plugin for the Redmine project management application.
+end::romé[]
+
+== Überschrift
+
+* Codierungen sind verrückt auf älteren Versionen von Ruby

data/test/invoker_test.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'test_helper'
 require 'asciidoctor/cli/options'
 require 'asciidoctor/cli/invoker'
@@ -234,6 +235,23 @@ context 'Invoker' do
     assert_xpath '//h2[@id="idsection_a"]', output, 1
   end
 
+  test 'should set attribute with value containing equal sign' do
+    invoker = invoke_cli_to_buffer %w(--trace -a toc -a toc-title=t=o=c -o -)
+    doc = invoker.document
+    assert_equal 't=o=c', doc.attr('toc-title')
+    output = invoker.read_output
+    assert_xpath '//*[@id="toctitle"][text() = "t=o=c"]', output, 1
+  end
+
+  test 'should set attribute with quoted value containing a space' do
+	# emulating commandline arguments: --trace -a toc -a note-caption="Note to self:" -o -
+    invoker = invoke_cli_to_buffer %w(--trace -a toc -a note-caption=Note\ to\ self: -o -)
+    doc = invoker.document
+    assert_equal 'Note to self:', doc.attr('note-caption')
+    output = invoker.read_output
+    assert_xpath %(//*[#{contains_class('admonitionblock')}]//*[@class='title'][text() = 'Note to self:']), output, 1
+  end
+
   test 'should not set attribute ending in @ if defined in document' do
     invoker = invoke_cli_to_buffer %w(--trace -a idprefix=id@ -s -o -)
     doc = invoker.document
@@ -291,4 +309,33 @@ context 'Invoker' do
     assert_equal 'erubis', doc.instance_variable_get('@options')[:eruby]
   end
 
+  test 'should force default external encoding to UTF-8' do
+    executable = File.expand_path(File.join(File.dirname(__FILE__), '..', 'bin', 'asciidoctor'))
+    input_path = fixture_path 'encoding.asciidoc'
+    old_lang = ENV['LANG']
+    ENV['LANG'] = 'US-ASCII'
+    begin
+      # using open3 to work around a bug in JRuby process_manager.rb,
+      # which tries to run a gsub on stdout prematurely breaking the test
+      require 'open3'
+      #cmd = "#{executable} -o - --trace #{input_path}"
+      cmd = "#{File.join RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name']} #{executable} -o - --trace #{input_path}"
+      _, stdout, stderr = Open3.popen3 cmd
+      stderr_lines = stderr.readlines
+      puts stderr_lines.join unless stderr_lines.empty?
+      assert stderr_lines.empty?, 'Command failed. Expected to receive a rendered document.'
+      stdout_lines = stdout.readlines
+      assert !stdout_lines.empty?
+      if Asciidoctor::FORCE_ENCODING
+        stdout_lines.each do |l|
+          l.force_encoding Encoding::UTF_8
+        end
+      end
+      stdout_str = stdout_lines.join
+      assert stdout_str.include?('Codierungen sind verrückt auf älteren Versionen von Ruby') 
+    ensure
+      ENV['LANG'] = old_lang
+    end
+  end
+
 end

data/test/lexer_test.rb

@@ -71,6 +71,14 @@ context "Lexer" do
     assert_equal expected, attributes
   end
 
+  test "collect unnamed attribute in second position after empty attribute" do
+    attributes = {}
+    line = ', John Smith'
+    expected = {1 => nil, 2 => 'John Smith'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
   test "collect unnamed attributes" do
     attributes = {}
     line = "first, second one, third"
@@ -182,6 +190,79 @@ context "Lexer" do
     assert_equal expected, attributes
   end
 
+  test 'parse style attribute with id and role' do
+    attributes = {1 => 'style#id.role'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_equal 'style', style
+    assert_nil original_style
+    assert_equal 'style', attributes['style']
+    assert_equal 'id', attributes['id']
+    assert_equal 'role', attributes['role']
+    assert_equal 'style#id.role', attributes[1]
+  end
+
+  test 'parse style attribute with style, role and id' do
+    attributes = {1 => 'style.role#id'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_equal 'style', style
+    assert_nil original_style
+    assert_equal 'style', attributes['style']
+    assert_equal 'id', attributes['id']
+    assert_equal 'role', attributes['role']
+    assert_equal 'style.role#id', attributes[1]
+  end
+
+  test 'parse style attribute with style, id and multiple roles' do
+    attributes = {1 => 'style#id.role1.role2'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_equal 'style', style
+    assert_nil original_style
+    assert_equal 'style', attributes['style']
+    assert_equal 'id', attributes['id']
+    assert_equal 'role1 role2', attributes['role']
+    assert_equal 'style#id.role1.role2', attributes[1]
+  end
+
+  test 'parse style attribute with style, multiple roles and id' do
+    attributes = {1 => 'style.role1.role2#id'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_equal 'style', style
+    assert_nil original_style
+    assert_equal 'style', attributes['style']
+    assert_equal 'id', attributes['id']
+    assert_equal 'role1 role2', attributes['role']
+    assert_equal 'style.role1.role2#id', attributes[1]
+  end
+
+  test 'parse style attribute with positional and original style' do
+    attributes = {1 => 'new_style', 'style' => 'original_style'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_equal 'new_style', style
+    assert_equal 'original_style', original_style
+    assert_equal 'new_style', attributes['style']
+    assert_equal 'new_style', attributes[1]
+  end
+
+  test 'parse style attribute with id and role only' do
+    attributes = {1 => '#id.role'}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_nil style
+    assert_nil original_style
+    assert_equal 'id', attributes['id']
+    assert_equal 'role', attributes['role']
+    assert_equal '#id.role', attributes[1]
+  end
+
+  test 'parse empty style attribute' do
+    attributes = {1 => nil}
+    style, original_style = Asciidoctor::Lexer.parse_style_attribute(attributes)
+    assert_nil style
+    assert_nil original_style
+    assert_nil attributes['id']
+    assert_nil attributes['role']
+    assert_nil attributes[1]
+  end
+
   test "parse author first" do
     metadata, = parse_header_metadata 'Stuart'
     assert_equal 5, metadata.size
@@ -406,4 +487,95 @@ context "Lexer" do
     assert_equal 'SJR', blankdoc.attributes['authorinitials']
   end
 
+  test 'reset block indent to 0' do
+    input = <<-EOS
+    def names
+
+      @name.split ' '
+
+    end
+    EOS
+
+    expected = <<-EOS
+def names
+
+  @name.split ' '
+
+end
+    EOS
+
+    lines = input.lines.entries
+    Asciidoctor::Lexer.reset_block_indent! lines
+    assert_equal expected, lines.join
+  end
+
+  test 'reset block indent mixed with tabs and spaces to 0' do
+    input = <<-EOS
+    def names
+
+\t  @name.split ' '
+
+    end
+    EOS
+
+    expected = <<-EOS
+def names
+
+  @name.split ' '
+
+end
+    EOS
+
+    lines = input.lines.entries
+    Asciidoctor::Lexer.reset_block_indent! lines
+    assert_equal expected, lines.join
+  end
+
+  test 'reset block indent to non-zero' do
+    input = <<-EOS
+    def names
+
+      @name.split ' '
+
+    end
+    EOS
+
+    expected = <<-EOS
+  def names
+  
+    @name.split ' '
+  
+  end
+    EOS
+
+    lines = input.lines.entries
+    Asciidoctor::Lexer.reset_block_indent! lines, 2
+    assert_equal expected, lines.join
+  end
+
+  test 'preserve block indent' do
+    input = <<-EOS
+    def names
+    
+      @name.split ' '
+    
+    end
+    EOS
+
+    expected = input
+
+    lines = input.lines.entries
+    Asciidoctor::Lexer.reset_block_indent! lines, nil
+    assert_equal expected, lines.join
+  end
+
+  test 'reset block indent hands empty lines gracefully' do
+    input = []
+    expected = input
+
+    lines = input.dup
+    Asciidoctor::Lexer.reset_block_indent! lines
+    assert_equal expected, lines
+  end
+
 end