asciidoctor 1.5.7.1 → 1.5.8

data/lib/asciidoctor/table.rb

@@ -248,7 +248,7 @@ class Table::Cell < AbstractNode
       # REVIEW feels hacky to inherit all attributes from column
       update_attributes column.attributes
     end
-    # NOTE if attributes is defined, we know this is a psv cell; implies text should be stripped
+    # NOTE if attributes is defined, we know this is a psv cell; implies text needs to be stripped
     if attributes
       if attributes.empty?
         @colspan = @rowspan = nil
@@ -280,6 +280,10 @@ class Table::Cell < AbstractNode
       end
     else
       @colspan = @rowspan = nil
+      if cell_style == :asciidoc
+        asciidoc = true
+        inner_document_cursor = opts[:cursor]
+      end
     end
     # NOTE only true for non-header rows
     if asciidoc
@@ -587,14 +591,18 @@ class Table::ParserContext
       @buffer = ''
       cellspec = nil
       repeat = 1
-      if @format == 'csv'
-        if !cell_text.empty? && cell_text.include?('"')
-          # this may not be perfect logic, but it hits the 99%
-          if cell_text.start_with?('"') && cell_text.end_with?('"')
-            # unquote
-            cell_text = cell_text.slice(1, cell_text.length - 2).strip
+      if @format == 'csv' && !cell_text.empty? && cell_text.include?('"')
+        # this may not be perfect logic, but it hits the 99%
+        if cell_text.start_with?('"') && cell_text.end_with?('"')
+          # unquote
+          if (cell_text = cell_text.slice(1, cell_text.length - 2))
+            # trim whitespace and collapse escaped quotes
+            cell_text = cell_text.strip.squeeze('"')
+          else
+            logger.error message_with_context 'unclosed quote in CSV data; setting cell to empty', :source_location => @reader.cursor_at_prev_line
+            cell_text = ''
           end
-
+        else
           # collapse escaped quotes
           cell_text = cell_text.squeeze('"')
         end

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = '1.5.7.1'
+  VERSION = '1.5.8'
 end

data/man/asciidoctor.1

@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: asciidoctor
 .\"    Author: Dan Allen, Sarah White, Ryan Waldron
-.\" Generator: Asciidoctor 1.5.7.1
-.\"      Date: 2018-05-10
+.\" Generator: Asciidoctor 1.5.8
+.\"      Date: 2018-10-28
 .\"    Manual: Asciidoctor Manual
-.\"    Source: Asciidoctor 1.5.7.1
+.\"    Source: Asciidoctor 1.5.8
 .\"  Language: English
 .\"
-.TH "ASCIIDOCTOR" "1" "2018-05-10" "Asciidoctor 1.5.7.1" "Asciidoctor Manual"
+.TH "ASCIIDOCTOR" "1" "2018-10-28" "Asciidoctor 1.5.8" "Asciidoctor Manual"
 .ie \n(.g .ds Aq \(aq
 .el       .ds Aq '
 .ss \n[.ss] 0
@@ -153,7 +153,8 @@ This option may be specified more than once.
 .sp
 \fB\-s, \-\-no\-header\-footer\fP
 .RS 4
-Suppress the document header and footer in the output.
+Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document.
+This option is useful for producing documents that can be inserted into an external template.
 .RE
 .sp
 \fB\-T, \-\-template\-dir\fP=\fIDIR\fP

data/man/asciidoctor.adoc

@@ -2,7 +2,7 @@
 Dan Allen; Sarah White; Ryan Waldron
 :doctype: manpage
 :man manual: Asciidoctor Manual
-:man source: Asciidoctor 1.5.7.1
+:man source: Asciidoctor 1.5.8
 :page-layout: base
 
 == NAME
@@ -109,7 +109,8 @@ This option may be specified more than once.
   This option may be specified more than once.
 
 *-s, --no-header-footer*::
-  Suppress the document header and footer in the output.
+  Output an embeddable document, which excludes the header, the footer, and everything outside the body of the document.
+  This option is useful for producing documents that can be inserted into an external template.
 
 *-T, --template-dir*=_DIR_::
   A directory containing custom converter templates that override one or more templates from the built-in set.

data/test/api_test.rb

@@ -576,6 +576,90 @@ content
       assert_equal 'Section', result[0].title
     end
 
+    test 'find_by should skip node and its children if block returns :skip' do
+      input = <<-EOS
+paragraph 1
+
+====
+paragraph 2
+
+term::
++
+paragraph 3
+====
+
+paragraph 4
+      EOS
+      doc = Asciidoctor.load input
+      result = doc.find_by do |candidate|
+        ctx = candidate.context
+        if ctx == :example
+          :skip
+        elsif ctx == :paragraph
+          true
+        end
+      end
+      refute_nil result
+      assert_equal 2, result.size
+      assert_equal :paragraph, result[0].context
+      assert_equal :paragraph, result[1].context
+    end
+
+    test 'find_by should accept node but skip its children if block returns :skip_children' do
+      input = <<-EOS
+====
+paragraph 2
+
+term::
++
+paragraph 3
+====
+      EOS
+      doc = Asciidoctor.load input
+      result = doc.find_by do |candidate|
+        if candidate.context == :example
+          :skip_children
+        end
+      end
+      refute_nil result
+      assert_equal 1, result.size
+      assert_equal :example, result[0].context
+    end
+
+    test 'find_by should stop looking for blocks when StopIteration is raised' do
+      input = <<-EOS
+paragraph 1
+
+====
+paragraph 2
+
+****
+paragraph 3
+****
+====
+
+paragraph 4
+
+* item
++
+paragraph 5
+      EOS
+      doc = Asciidoctor.load input
+
+      stop_at_next = false
+      result = doc.find_by do |candidate|
+        raise StopIteration if stop_at_next
+        if candidate.context == :paragraph
+          candidate.parent.context == :sidebar ? (stop_at_next = true) : true
+        end
+      end
+      refute_nil result
+      assert_equal 3, result.size
+      assert_equal 'paragraph 1', result[0].content
+      assert_equal 'paragraph 2', result[1].content
+      assert_equal 'paragraph 3', result[2].content
+    end
+
     test 'find_by should only return one result when matching by id' do
       input = <<-EOS
 == Section
@@ -595,6 +679,29 @@ content
       assert_equal 'Subsection', result[0].title
     end
 
+    test 'find_by should stop seeking once match is found' do
+      input = <<-EOS
+== Section
+
+content
+
+[#subsection]
+=== Subsection
+
+[#last]
+content
+      EOS
+      doc = Asciidoctor.load input
+      visited_last = false
+      result = doc.find_by(:id => 'subsection') do |candidate|
+        visited_last = true if candidate.id == 'last'
+        true
+      end
+      refute_nil result
+      assert_equal 1, result.size
+      refute visited_last
+    end
+
     test 'find_by should return an empty Array if the id criteria matches but the block argument yields false' do
       input = <<-EOS
 == Section
@@ -988,6 +1095,94 @@ text
   end
 
   context 'AST' do
+    test 'with no author' do
+      input = <<-EOS
+= Getting Real: The Smarter, Faster, Easier Way to Build a Successful Web Application
+
+Getting Real details the business, design, programming, and marketing principles of 37signals.
+      EOS
+
+      doc = document_from_string input
+      assert_equal 0, doc.authors.size
+    end
+
+    test 'with one author' do
+      input = <<-EOS
+= Getting Real: The Smarter, Faster, Easier Way to Build a Successful Web Application
+David Heinemeier Hansson <david@37signals.com>
+
+Getting Real details the business, design, programming, and marketing principles of 37signals.
+      EOS
+
+      doc = document_from_string input
+      authors = doc.authors
+      assert_equal 1, authors.size
+      author_1 = authors[0]
+      assert_equal 'david@37signals.com', author_1.email
+      assert_equal 'David Heinemeier Hansson', author_1.name
+      assert_equal 'David', author_1.firstname
+      assert_equal 'Heinemeier', author_1.middlename
+      assert_equal 'Hansson', author_1.lastname
+      assert_equal 'DHH', author_1.initials
+    end
+
+    test 'with two authors' do
+      input = <<-EOS
+= Getting Real: The Smarter, Faster, Easier Way to Build a Successful Web Application
+David Heinemeier Hansson <david@37signals.com>; Jason Fried <jason@37signals.com>
+
+Getting Real details the business, design, programming, and marketing principles of 37signals.
+      EOS
+
+      doc = document_from_string input
+      authors = doc.authors
+      assert_equal 2, authors.size
+      author_1 = authors[0]
+      assert_equal 'david@37signals.com', author_1.email
+      assert_equal 'David Heinemeier Hansson', author_1.name
+      assert_equal 'David', author_1.firstname
+      assert_equal 'Heinemeier', author_1.middlename
+      assert_equal 'Hansson', author_1.lastname
+      assert_equal 'DHH', author_1.initials
+      author_2 = authors[1]
+      assert_equal 'jason@37signals.com', author_2.email
+      assert_equal 'Jason Fried', author_2.name
+      assert_equal 'Jason', author_2.firstname
+      assert_nil author_2.middlename
+      assert_equal 'Fried', author_2.lastname
+      assert_equal 'JF', author_2.initials
+    end
+
+    test 'with authors as attributes' do
+      input = <<-EOS
+= Getting Real: The Smarter, Faster, Easier Way to Build a Successful Web Application
+:author_1: David Heinemeier Hansson
+:email_1: david@37signals.com
+:author_2: Jason Fried
+:email_2: jason@37signals.com
+
+Getting Real details the business, design, programming, and marketing principles of 37signals.
+      EOS
+
+      doc = document_from_string input
+      authors = doc.authors
+      assert_equal 2, authors.size
+      author_1 = authors[0]
+      assert_equal 'david@37signals.com', author_1.email
+      assert_equal 'David Heinemeier Hansson', author_1.name
+      assert_equal 'David', author_1.firstname
+      assert_equal 'Heinemeier', author_1.middlename
+      assert_equal 'Hansson', author_1.lastname
+      assert_equal 'DHH', author_1.initials
+      author_2 = authors[1]
+      assert_equal 'jason@37signals.com', author_2.email
+      assert_equal 'Jason Fried', author_2.name
+      assert_equal 'Jason', author_2.firstname
+      assert_nil author_2.middlename
+      assert_equal 'Fried', author_2.lastname
+      assert_equal 'JF', author_2.initials
+    end
+
     test 'should not crash if nil cell text is passed to Cell constructor' do
       input = <<-EOS
 |===
@@ -1000,5 +1195,46 @@ text
       assert_same Asciidoctor::AbstractNode::NORMAL_SUBS, cell.subs
       assert_equal '', cell.text
     end
+
+    test 'should set option on node when set_option is called' do
+      input = <<-EOS
+. three
+. two
+. one
+      EOS
+
+      block = (document_from_string input).blocks[0]
+      assert block.set_option('reversed')
+      refute block.set_option('reversed')
+      assert block.option?('reversed')
+      assert_equal '', block.attributes['reversed-option']
+      assert_equal 'reversed', block.attributes['options']
+    end
+
+    test 'should append option to existing options' do
+      input = <<-EOS
+[%fancy]
+. three
+. two
+. one
+      EOS
+
+      block = (document_from_string input).blocks[0]
+      assert block.set_option('reversed')
+      assert_equal 'fancy,reversed', block.attributes['options']
+    end
+
+    test 'should not append option if option is already set' do
+      input = <<-EOS
+[%reversed]
+. three
+. two
+. one
+      EOS
+
+      block = (document_from_string input).blocks[0]
+      refute block.set_option('reversed')
+      assert_equal 'reversed', block.attributes['options']
+    end
   end
 end

data/test/attribute_list_test.rb

@@ -0,0 +1,242 @@
+# encoding: UTF-8
+unless defined? ASCIIDOCTOR_PROJECT_DIR
+  $: << File.dirname(__FILE__); $:.uniq!
+  require 'test_helper'
+end
+
+context 'AttributeList' do
+  test 'collect unnamed attribute' do
+    attributes = {}
+    line = 'quote'
+    expected = {1 => 'quote'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect unnamed attribute double-quoted' do
+    attributes = {}
+    line = '"quote"'
+    expected = {1 => 'quote'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect empty unnamed attribute double-quoted' do
+    attributes = {}
+    line = '""'
+    expected = {1 => ''}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect unnamed attribute double-quoted containing escaped quote' do
+    attributes = {}
+    line = '"ba\"zaar"'
+    expected = {1 => 'ba"zaar'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect unnamed attribute single-quoted' do
+    attributes = {}
+    line = '\'quote\''
+    expected = {1 => 'quote'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect empty unnamed attribute single-quoted' do
+    attributes = {}
+    line = '\'\''
+    expected = {1 => ''}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect isolated single quote positional attribute' do
+    attributes = {}
+    line = '\''
+    expected = { 1 => '\'' }
+    doc = empty_document
+    def doc.apply_subs *args
+      fail 'apply_subs should not be called'
+    end
+    Asciidoctor::AttributeList.new(line, doc).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect isolated single quote attribute value' do
+    attributes = {}
+    line = 'name=\''
+    expected = { 'name' => '\'' }
+    doc = empty_document
+    def doc.apply_subs *args
+      fail 'apply_subs should not be called'
+    end
+    Asciidoctor::AttributeList.new(line, doc).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect attribute value as is if it has only leading single quote' do
+    attributes = {}
+    line = 'name=\'{val}'
+    expected = { 'name' => '\'{val}' }
+    doc = empty_document :attributes => { 'val' => 'val' }
+    def doc.apply_subs *args
+      fail 'apply_subs should not be called'
+    end
+    Asciidoctor::AttributeList.new(line, doc).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect unnamed attribute single-quoted containing escaped quote' do
+    attributes = {}
+    line = '\'ba\\\'zaar\''
+    expected = {1 => 'ba\'zaar'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect unnamed attribute with dangling delimiter' do
+    attributes = {}
+    line = 'quote , '
+    expected = {1 => 'quote'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    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'
+    expected = {1 => 'first', 2 => 'second one', 3 => 'third'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attribute' do
+    attributes = {}
+    line = 'foo=bar'
+    expected = {'foo' => 'bar'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attribute double-quoted' do
+    attributes = {}
+    line = 'foo="bar"'
+    expected = {'foo' => 'bar'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attribute with double-quoted empty value' do
+    attributes = {}
+    line = 'height=100,caption="",link="images/octocat.png"'
+    expected = {'height' => '100', 'caption' => '', 'link' => 'images/octocat.png'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attribute single-quoted' do
+    attributes = {}
+    line = 'foo=\'bar\''
+    expected = {'foo' => 'bar'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attribute with single-quoted empty value' do
+    attributes = {}
+    line = %(height=100,caption='',link='images/octocat.png')
+    expected = {'height' => '100', 'caption' => '', 'link' => 'images/octocat.png'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect single named attribute with empty value' do
+    attributes = {}
+    line = 'foo='
+    expected = {'foo' => ''}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect single named attribute with empty value when followed by other attributes' do
+    attributes = {}
+    line = 'foo=,bar=baz'
+    expected = {'foo' => '', 'bar' => 'baz'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attributes unquoted' do
+    attributes = {}
+    line = 'first=value, second=two, third=3'
+    expected = {'first' => 'value', 'second' => 'two', 'third' => '3'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attributes quoted' do
+    attributes = {}
+    line = %(first='value', second="value two", third=three)
+    expected = {'first' => 'value', 'second' => 'value two', 'third' => 'three'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect named attributes quoted containing non-semantic spaces' do
+    attributes = {}
+    line = %(     first    =     'value', second     ="value two"     , third=       three      )
+    expected = {'first' => 'value', 'second' => 'value two', 'third' => 'three'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect mixed named and unnamed attributes' do
+    attributes = {}
+    line = %(first, second="value two", third=three, Sherlock Holmes)
+    expected = {1 => 'first', 'second' => 'value two', 'third' => 'three', 4 => 'Sherlock Holmes'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  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' => ''}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  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' => ''}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes)
+    assert_equal expected, attributes
+  end
+
+  test 'collect and rekey unnamed attributes' do
+    attributes = {}
+    line = 'first, second one, third, fourth'
+    expected = {1 => 'first', 2 => 'second one', 3 => 'third', 4 => 'fourth', 'a' => 'first', 'b' => 'second one', 'c' => 'third'}
+    Asciidoctor::AttributeList.new(line).parse_into(attributes, ['a', 'b', 'c'])
+    assert_equal expected, attributes
+  end
+
+  test 'rekey positional attributes' do
+    attributes = {1 => 'source', 2 => 'java'}
+    expected = {1 => 'source', 2 => 'java', 'style' => 'source', 'language' => 'java'}
+    Asciidoctor::AttributeList.rekey(attributes, ['style', 'language', 'linenums'])
+    assert_equal expected, attributes
+  end
+end