asciidoctor 1.5.5 → 1.5.6

data/test/options_test.rb

@@ -6,7 +6,7 @@ end
 require 'asciidoctor/cli/options'
 
 context 'Options' do
-  test 'should return error code 0 when help flag is present' do
+  test 'should print usage and 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
@@ -14,6 +14,23 @@ context 'Options' do
     end
   end
 
+  test 'should print usage and return error code 0 when help flag is unknown' do
+    exitval, output = redirect_streams do |out, _|
+      [Asciidoctor::Cli::Options.parse!(%w(-h unknown)), out.string]
+    end
+    assert_equal 0, exitval
+    assert_match(/^Usage:/, output)
+  end
+
+  test 'should dump man page and return error code 0 when help topic is manpage' do
+    exitval, output = redirect_streams do |out, _|
+      [Asciidoctor::Cli::Options.parse!(%w(-h manpage)), out.string]
+    end
+    assert_equal 0, exitval
+    assert_includes output, 'Manual: Asciidoctor Manual'
+    assert_includes output, '.TH "ASCIIDOCTOR"'
+  end
+
   test 'should return error code 1 when invalid option present' do
     redirect_streams do |stdout, stderr|
       exitval = Asciidoctor::Cli::Options.parse!(%w(--foobar))

data/test/paragraphs_test.rb

@@ -156,29 +156,29 @@ Note that multi-entry terms generate separate index entries.
 
       output = render_embedded_string input, :attributes => {'backend' => 'docbook45'}
       assert_xpath '/simpara', output, 1
-      term1 = (xmlnodes_at_xpath '(//indexterm)[1]', output, 1).first
+      term1 = xmlnodes_at_xpath '(//indexterm)[1]', output, 1
       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 = xmlnodes_at_xpath '(//indexterm)[2]', output, 1
       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 = xmlnodes_at_xpath '(//indexterm)[3]', output, 1
       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 = xmlnodes_at_xpath '(//indexterm)[4]', output, 1
       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
+      term5 = xmlnodes_at_xpath '(//indexterm)[5]', output, 1
       assert_equal '<indexterm><primary>Linux</primary></indexterm>', term5.to_s
       assert term5.next.content.start_with?('Linux')
 
@@ -418,6 +418,26 @@ Content goes here
       assert_xpath "//*[@class='sidebarblock']//p", result, 1
     end
 
+    test 'should process preprocessor conditional in paragrpah content' do
+      input = <<-EOS
+ifdef::asciidoctor-version[]
+[sidebar]
+First line of sidebar.
+ifdef::backend[The backend is {backend}.]
+Last line of sidebar.
+endif::[]
+      EOS
+
+      result = render_embedded_string input
+      assert_equal %(<div class="sidebarblock">
+<div class="content">
+First line of sidebar.
+The backend is html5.
+Last line of sidebar.
+</div>
+</div>), result
+    end
+
     context 'Styled Paragraphs' do
       test 'should wrap text in simpara for styled paragraphs when rendered to DocBook' do
         input = <<-EOS
@@ -514,10 +534,15 @@ Wise words from a wise person.
         assert_equal '<a href="http://asciidoc.org">AsciiDoc</a> is a <em>lightweight</em> markup language&#8230;&#8203;', output
       end
 
-      test 'should output nil if first block is not a paragraph' do
+      test 'should output nil and warn if first block is not a paragraph' do
         input = '* bullet'
-        output = render_string input, :doctype => 'inline'
+        output = nil
+        warnings = redirect_streams do |_, err|
+          output =  render_string input, :doctype => 'inline'
+          err.string
+        end
         assert output.nil?
+        assert_includes warnings, 'no inline candidate'
       end
     end
   end

data/test/parser_test.rb

@@ -17,6 +17,85 @@ context "Parser" do
     assert_equal 'foo3-bar', Asciidoctor::Parser.sanitize_attribute_name("Foo 3^ # - Bar[")
   end
 
+  test 'store attribute with value' do
+    attr_name, attr_value = Asciidoctor::Parser.store_attribute 'foo', 'bar'
+    assert_equal 'foo', attr_name
+    assert_equal 'bar', attr_value
+  end
+
+  test 'store attribute with negated value' do
+    { 'foo!' => nil, '!foo' => nil, 'foo' => nil }.each do |name, value|
+      attr_name, attr_value = Asciidoctor::Parser.store_attribute name, value
+      assert_equal name.sub('!', ''), attr_name
+      assert_nil attr_value
+    end
+  end
+
+  test 'store accessible attribute on document with value' do
+    doc = empty_document
+    doc.set_attribute 'foo', 'baz'
+    attrs = {}
+    attr_name, attr_value = Asciidoctor::Parser.store_attribute 'foo', 'bar', doc, attrs
+    assert_equal 'foo', attr_name
+    assert_equal 'bar', attr_value
+    assert_equal 'bar', (doc.attr 'foo')
+    assert attrs.key?(:attribute_entries)
+    assert_equal 1, attrs[:attribute_entries].size
+    assert_equal 'foo', attrs[:attribute_entries][0].name
+    assert_equal 'bar', attrs[:attribute_entries][0].value
+  end
+
+  test 'store accessible attribute on document with value that contains attribute reference' do
+    doc = empty_document
+    doc.set_attribute 'foo', 'baz'
+    doc.set_attribute 'release', 'ultramega'
+    attrs = {}
+    attr_name, attr_value = Asciidoctor::Parser.store_attribute 'foo', '{release}', doc, attrs
+    assert_equal 'foo', attr_name
+    assert_equal 'ultramega', attr_value
+    assert_equal 'ultramega', (doc.attr 'foo')
+    assert attrs.key?(:attribute_entries)
+    assert_equal 1, attrs[:attribute_entries].size
+    assert_equal 'foo', attrs[:attribute_entries][0].name
+    assert_equal 'ultramega', attrs[:attribute_entries][0].value
+  end
+
+  test 'store inaccessible attribute on document with value' do
+    doc = empty_document :attributes => { 'foo' => 'baz' }
+    attrs = {}
+    attr_name, attr_value = Asciidoctor::Parser.store_attribute 'foo', 'bar', doc, attrs
+    assert_equal 'foo', attr_name
+    assert_equal 'bar', attr_value
+    assert_equal 'baz', (doc.attr 'foo')
+    refute attrs.key?(:attribute_entries)
+  end
+
+  test 'store accessible attribute on document with negated value' do
+    { 'foo!' => nil, '!foo' => nil, 'foo' => nil }.each do |name, value|
+      doc = empty_document
+      doc.set_attribute 'foo', 'baz'
+      attrs = {}
+      attr_name, attr_value = Asciidoctor::Parser.store_attribute name, value, doc, attrs
+      assert_equal name.sub('!', ''), attr_name
+      assert_nil attr_value
+      assert attrs.key?(:attribute_entries)
+      assert_equal 1, attrs[:attribute_entries].size
+      assert_equal 'foo', attrs[:attribute_entries][0].name
+      assert_nil attrs[:attribute_entries][0].value
+    end
+  end
+
+  test 'store inaccessible attribute on document with negated value' do
+    { 'foo!' => nil, '!foo' => nil, 'foo' => nil }.each do |name, value|
+      doc = empty_document :attributes => { 'foo' => 'baz' }
+      attrs = {}
+      attr_name, attr_value = Asciidoctor::Parser.store_attribute name, value, doc, attrs
+      assert_equal name.sub('!', ''), attr_name
+      assert_nil attr_value
+      refute attrs.key?(:attribute_entries)
+    end
+  end
+
   test "collect unnamed attribute" do
     attributes = {}
     line = 'quote'
@@ -172,7 +251,7 @@ context "Parser" do
   test "collect options attribute" do
     attributes = {}
     line = "quote, options='opt1,opt2 , opt3'"
-    expected = {1 => 'quote', 'options' => 'opt1,opt2 , opt3', 'opt1-option' => '', 'opt2-option' => '', 'opt3-option' => ''}
+    expected = {1 => 'quote', 'options' => 'opt1,opt2,opt3', 'opt1-option' => '', 'opt2-option' => '', 'opt3-option' => ''}
     Asciidoctor::AttributeList.new(line).parse_into(attributes)
     assert_equal expected, attributes
   end
@@ -180,7 +259,7 @@ context "Parser" do
   test "collect opts attribute as options" do
     attributes = {}
     line = "quote, opts='opt1,opt2 , opt3'"
-    expected = {1 => 'quote', 'options' => 'opt1,opt2 , opt3', 'opt1-option' => '', 'opt2-option' => '', 'opt3-option' => ''}
+    expected = {1 => 'quote', 'options' => 'opt1,opt2,opt3', 'opt1-option' => '', 'opt2-option' => '', 'opt3-option' => ''}
     Asciidoctor::AttributeList.new(line).parse_into(attributes)
     assert_equal expected, attributes
   end
@@ -202,9 +281,8 @@ context "Parser" do
 
   test 'parse style attribute with id and role' do
     attributes = {1 => 'style#id.role'}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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']
@@ -213,9 +291,8 @@ context "Parser" do
 
   test 'parse style attribute with style, role, id and option' do
     attributes = {1 => 'style.role#id%fragment'}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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']
@@ -226,9 +303,8 @@ context "Parser" do
 
   test 'parse style attribute with style, id and multiple roles' do
     attributes = {1 => 'style#id.role1.role2'}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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']
@@ -237,9 +313,8 @@ context "Parser" do
 
   test 'parse style attribute with style, multiple roles and id' do
     attributes = {1 => 'style.role1.role2#id'}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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']
@@ -248,18 +323,16 @@ context "Parser" do
 
   test 'parse style attribute with positional and original style' do
     attributes = {1 => 'new_style', 'style' => 'original_style'}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.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]
@@ -267,9 +340,8 @@ context "Parser" do
 
   test 'parse empty style attribute' do
     attributes = {1 => nil}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.parse_style_attribute(attributes)
     assert_nil style
-    assert_nil original_style
     assert_nil attributes['id']
     assert_nil attributes['role']
     assert_nil attributes[1]
@@ -277,9 +349,8 @@ context "Parser" do
 
   test 'parse style attribute with option should preserve existing options' do
     attributes = {1 => '%header', 'options' => 'footer', 'footer-option' => ''}
-    style, original_style = Asciidoctor::Parser.parse_style_attribute(attributes)
+    style = Asciidoctor::Parser.parse_style_attribute(attributes)
     assert_nil style
-    assert_nil original_style
     assert_equal 'header,footer', attributes['options']
     assert_equal '', attributes['header-option']
     assert_equal '', attributes['footer-option']
@@ -455,6 +526,56 @@ context "Parser" do
     assert_equal 'John Smith', metadata['author_2']
   end
 
+  test 'parse name with more than 3 parts in author attribute' do
+    doc = empty_document
+    parse_header_metadata ':author: Leroy  Harold  Scherer,  Jr.', doc
+    assert_equal 'Leroy Harold Scherer, Jr.', doc.attributes['author']
+    assert_equal 'Leroy', doc.attributes['firstname']
+    assert_equal 'Harold', doc.attributes['middlename']
+    assert_equal 'Scherer, Jr.', doc.attributes['lastname']
+  end
+
+  test 'does not drop name joiner when using multiple authors' do
+    input = <<-EOS
+Kismet Chameleon; Lazarus het_Draeke
+    EOS
+    doc = empty_document
+    parse_header_metadata input, doc
+    assert_equal 2, doc.attributes['authorcount']
+    assert_equal 'Kismet Chameleon, Lazarus het Draeke', doc.attributes['authors']
+    assert_equal 'Kismet Chameleon', doc.attributes['author_1']
+    assert_equal 'Lazarus het Draeke', doc.attributes['author_2']
+    assert_equal 'het Draeke', doc.attributes['lastname_2']
+  end
+
+  test 'allows authors to be overridden using explicit author attributes' do
+    input = <<-EOS
+Kismet Chameleon; Johnny Bravo; Lazarus het_Draeke
+:author_2: Danger Mouse
+    EOS
+    doc = empty_document
+    parse_header_metadata input, doc
+    assert_equal 3, doc.attributes['authorcount']
+    assert_equal 'Kismet Chameleon, Danger Mouse, Lazarus het Draeke', doc.attributes['authors']
+    assert_equal 'Kismet Chameleon', doc.attributes['author_1']
+    assert_equal 'Danger Mouse', doc.attributes['author_2']
+    assert_equal 'Lazarus het Draeke', doc.attributes['author_3']
+    assert_equal 'het Draeke', doc.attributes['lastname_3']
+  end
+
+  test 'removes formatting before partitioning author defined using author attribute' do
+    input = <<-EOS
+:author: pass:n[http://example.org/community/team.html[Ze_**Project** team]]
+    EOS
+
+    doc = empty_document
+    parse_header_metadata input, doc
+    assert_equal 1, doc.attributes['authorcount']
+    assert_equal '<a href="http://example.org/community/team.html">Ze <strong>Project</strong> team</a>', doc.attributes['authors']
+    assert_equal 'Ze Project', doc.attributes['firstname']
+    assert_equal 'team', doc.attributes['lastname']
+  end
+
   test "parse rev number date remark" do
     input = <<-EOS
 Ryan Waldron
@@ -591,19 +712,18 @@ v0.0.7, 2013-12-18
     assert_equal '2013-12-18', metadata['revdate']
   end
 
-  test "attribute entry overrides generated author initials" do
-    blankdoc = Asciidoctor::Document.new
-    reader = Asciidoctor::Reader.new "Stuart Rackham <founder@asciidoc.org>\n:Author Initials: SJR".lines.entries
-    metadata = Asciidoctor::Parser.parse_header_metadata(reader, blankdoc)
+  test 'attribute entry overrides generated author initials' do
+    doc = empty_document
+    metadata, _ = parse_header_metadata %(Stuart Rackham <founder@asciidoc.org>\n:Author Initials: SJR), doc
     assert_equal 'SR', metadata['authorinitials']
-    assert_equal 'SJR', blankdoc.attributes['authorinitials']
+    assert_equal 'SJR', doc.attributes['authorinitials']
   end
 
   test 'adjust indentation to 0' do
     input = <<-EOS.chomp
     def names
 
-      @name.split ' '
+      @name.split
 
     end
     EOS
@@ -611,7 +731,7 @@ v0.0.7, 2013-12-18
     expected = <<-EOS.chomp
 def names
 
-  @name.split ' '
+  @name.split
 
 end
     EOS
@@ -625,7 +745,7 @@ end
     input = <<-EOS.chomp
     def names
 
-\t  @name.split ' '
+\t  @name.split
 
     end
     EOS
@@ -633,7 +753,7 @@ end
     expected = <<-EOS.chomp
 def names
 
-  @name.split ' '
+  @name.split
 
 end
     EOS
@@ -667,7 +787,7 @@ devtmpfs                3.9G       0     3.9G     0%    /dev
     input = <<-EOS.chomp
     def names
 
-      @name.split ' '
+      @name.split
 
     end
     EOS
@@ -675,7 +795,7 @@ devtmpfs                3.9G       0     3.9G     0%    /dev
     expected = <<-EOS.chomp
   def names
 
-    @name.split ' '
+    @name.split
 
   end
     EOS
@@ -689,7 +809,7 @@ devtmpfs                3.9G       0     3.9G     0%    /dev
     input = <<-EOS
     def names
 
-      @name.split ' '
+      @name.split
 
     end
     EOS

data/test/paths_test.rb

@@ -88,13 +88,17 @@ context 'Path Resolver' do
       assert_equal 'assets/images', @resolver.web_path(nil, 'assets/images')
     end
 
-    test 'posixfies windows paths' do
+    test 'posixifies windows paths' do
       assert_equal '/images', @resolver.web_path('\\images')
       assert_equal '../images', @resolver.web_path('..\\images')
       assert_equal '/images', @resolver.web_path('\\..\\images')
       assert_equal 'assets/images', @resolver.web_path('assets\\images')
       assert_equal '../assets/images', @resolver.web_path('assets\\images', '..\\images\\..')
     end
+
+    test 'URL encode spaces in path' do
+      assert_equal 'assets%20and%20stuff/lots%20of%20images', @resolver.web_path('lots of images', 'assets and stuff')
+    end
   end
 
   context 'System Paths' do
@@ -105,9 +109,23 @@ context 'Path Resolver' do
     end
 
     test 'prevents access to paths outside of jail' do
-      assert_equal "#{JAIL}/css", @resolver.system_path('../../../../../css', "#{JAIL}/assets/stylesheets", JAIL)
-      assert_equal "#{JAIL}/css", @resolver.system_path('/../../../../../css', "#{JAIL}/assets/stylesheets", JAIL)
-      assert_equal "#{JAIL}/css", @resolver.system_path('../../../css', '../../..', JAIL)
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '../../../../../css', %(#{JAIL}/assets/stylesheets), JAIL), err.string]
+      end
+      assert_equal %(#{JAIL}/css), result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
+
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '/../../../../../css', %(#{JAIL}/assets/stylesheets), JAIL), err.string]
+      end
+      assert_equal %(#{JAIL}/css), result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
+
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '../../../css', '../../..', JAIL), err.string]
+      end
+      assert_equal %(#{JAIL}/css), result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
     end
 
     test 'throws exception for illegal path access if recover is false' do
@@ -181,6 +199,7 @@ context 'Path Resolver' do
       pwd = File.expand_path(Dir.pwd)
       assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png', '')
       assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png', nil)
+      assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png')
     end
 
     test 'resolves relative hidden target relative to current directory if start is empty' do
@@ -190,22 +209,37 @@ context 'Path Resolver' do
     end
 
     test 'resolves and normalizes start with target is empty' do
-      pwd = File.expand_path(Dir.pwd)
-      assert_equal '/home/doctor/docs', @resolver.system_path('', '/home/doctor/docs')
-      assert_equal '/home/doctor/docs', @resolver.system_path(nil, '/home/doctor/docs')
-      assert_equal "#{pwd}/assets/images", @resolver.system_path(nil, 'assets/images')
-      assert_equal "#{JAIL}/assets/images", @resolver.system_path('', '../assets/images', JAIL)
+      pwd = File.expand_path Dir.pwd
+      assert_equal '/home/doctor/docs', (@resolver.system_path '', '/home/doctor/docs')
+      assert_equal '/home/doctor/docs', (@resolver.system_path nil, '/home/doctor/docs')
+      assert_equal %(#{pwd}/assets/images), (@resolver.system_path nil, 'assets/images')
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '', '../assets/images', JAIL), err.string]
+      end
+      assert_equal %(#{JAIL}/assets/images), result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
     end
 
-    test 'posixfies windows paths' do
+    test 'posixifies windows paths' do
       assert_equal "#{JAIL}/assets/css", @resolver.system_path('..\\css', 'assets\\stylesheets', JAIL)
     end
 
     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')
+
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '..\\..', 'C:\\data\\docs\\assets', 'C:\\data\\docs'), err.string]
+      end
+      assert_equal 'C:/data/docs', result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
+
+      result, warnings = redirect_streams do |_, err|
+        [(@resolver.system_path '..\\..\\css', 'C:\\data\\docs\\assets', 'C:\\data\\docs'), err.string]
+      end
+      assert_equal 'C:/data/docs/css', result
+      assert_includes warnings, 'path has illegal reference to ancestor of jail'
     end
 
     test 'should calculate relative path' do