asciidoctor 2.0.10 → 2.0.11

data/lib/asciidoctor/extensions.rb

@@ -425,7 +425,7 @@ module Extensions
   # TIP: Postprocessors can also be used to relocate assets needed by the published
   # document.
   #
-  # Postprocessor implementations must Postprocessor.
+  # Postprocessor implementations must extend Postprocessor.
   class Postprocessor < Processor
     def process document, output
       raise ::NotImplementedError, %(#{Postprocessor} subclass #{self.class} must implement the ##{__method__} method)
@@ -610,7 +610,7 @@ module Extensions
   #--
   # TODO break this out into different pattern types
   # for example, FullInlineMacro, ShortInlineMacro (no target) and other patterns
-  # FIXME for inline passthrough, we need to have some way to specify the text as a passthrough
+  # FIXME for inline macro, we need to have some way to specify the text as a passthrough
   class InlineMacroProcessor < MacroProcessor
     @@rx_cache = {}
 

data/lib/asciidoctor/helpers.rb

@@ -56,25 +56,27 @@ module Helpers
   # If a BOM is found at the beginning of the data, a best attempt is made to
   # encode it to UTF-8 from the specified source encoding.
   #
-  # data - the source data Array to prepare (no nil entries allowed)
+  # data     - the source data Array to prepare (no nil entries allowed)
+  # trim_end - whether to trim whitespace from the end of each line;
+  #            (true cleans all whitespace; false only removes trailing newline) (default: true)
   #
   # returns a String Array of prepared lines
-  def prepare_source_array data
+  def prepare_source_array data, trim_end = true
     return [] if data.empty?
     if (leading_2_bytes = (leading_bytes = (first = data[0]).unpack 'C3').slice 0, 2) == BOM_BYTES_UTF_16LE
       data[0] = first.byteslice 2, first.bytesize
       # NOTE you can't split a UTF-16LE string using .lines when encoding is UTF-8; doing so will cause this line to fail
-      return data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16LE).rstrip }
+      return trim_end ? data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16LE).rstrip } : data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16LE).chomp }
     elsif leading_2_bytes == BOM_BYTES_UTF_16BE
       data[0] = first.byteslice 2, first.bytesize
-      return data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16BE).rstrip }
+      return trim_end ? data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16BE).rstrip } : data.map {|line| (line.encode UTF_8, ::Encoding::UTF_16BE).chomp }
     elsif leading_bytes == BOM_BYTES_UTF_8
       data[0] = first.byteslice 3, first.bytesize
     end
     if first.encoding == UTF_8
-      data.map {|line| line.rstrip }
+      trim_end ? data.map {|line| line.rstrip } : data.map {|line| line.chomp }
     else
-      data.map {|line| (line.encode UTF_8).rstrip }
+      trim_end ? data.map {|line| (line.encode UTF_8).rstrip } : data.map {|line| (line.encode UTF_8).chomp }
     end
   end
 
@@ -86,10 +88,12 @@ module Helpers
   # If a BOM is found at the beginning of the data, a best attempt is made to
   # encode it to UTF-8 from the specified source encoding.
   #
-  # data - the source data String to prepare
+  # data     - the source data String to prepare
+  # trim_end - whether to trim whitespace from the end of each line;
+  #            (true cleans all whitespace; false only removes trailing newline) (default: true)
   #
   # returns a String Array of prepared lines
-  def prepare_source_string data
+  def prepare_source_string data, trim_end = true
     return [] if data.nil_or_empty?
     if (leading_2_bytes = (leading_bytes = data.unpack 'C3').slice 0, 2) == BOM_BYTES_UTF_16LE
       data = (data.byteslice 2, data.bytesize).encode UTF_8, ::Encoding::UTF_16LE
@@ -101,7 +105,11 @@ module Helpers
     elsif data.encoding != UTF_8
       data = data.encode UTF_8
     end
-    [].tap {|lines| data.each_line {|line| lines << line.rstrip } }
+    if trim_end
+      [].tap {|lines| data.each_line {|line| lines << line.rstrip } }
+    else
+      [].tap {|lines| data.each_line {|line| lines << line.chomp } }
+    end
   end
 
   # Internal: Efficiently checks whether the specified String resembles a URI

data/lib/asciidoctor/load.rb

@@ -1,117 +1,117 @@
 module Asciidoctor
-  module_function
+  class << self
+    # Public: Parse the AsciiDoc source input into a {Document}
+    #
+    # Accepts input as an IO (or StringIO), String or String Array object. If the
+    # input is a File, the object is expected to be opened for reading and is not
+    # closed afterwards by this method. Information about the file (filename,
+    # directory name, etc) gets assigned to attributes on the Document object.
+    #
+    # input   - the AsciiDoc source as a IO, String or Array.
+    # options - a String, Array or Hash of options to control processing (default: {})
+    #           String and Array values are converted into a Hash.
+    #           See {Document#initialize} for details about these options.
+    #
+    # Returns the Document
+    def load input, options = {}
+      options = options.merge
 
-  # Public: Parse the AsciiDoc source input into a {Document}
-  #
-  # Accepts input as an IO (or StringIO), String or String Array object. If the
-  # input is a File, the object is expected to be opened for reading and is not
-  # closed afterwards by this method. Information about the file (filename,
-  # directory name, etc) gets assigned to attributes on the Document object.
-  #
-  # input   - the AsciiDoc source as a IO, String or Array.
-  # options - a String, Array or Hash of options to control processing (default: {})
-  #           String and Array values are converted into a Hash.
-  #           See {Document#initialize} for details about these options.
-  #
-  # Returns the Document
-  def load input, options = {}
-    options = options.merge
-
-    if (timings = options[:timings])
-      timings.start :read
-    end
+      if (timings = options[:timings])
+        timings.start :read
+      end
 
-    if (logger = options[:logger]) && logger != LoggerManager.logger
-      LoggerManager.logger = logger
-    end
+      if (logger = options[:logger]) && logger != LoggerManager.logger
+        LoggerManager.logger = logger
+      end
 
-    if !(attrs = options[:attributes])
-      attrs = {}
-    elsif ::Hash === attrs
-      attrs = attrs.merge
-    elsif (defined? ::Java::JavaUtil::Map) && ::Java::JavaUtil::Map === attrs
-      attrs = attrs.dup
-    elsif ::Array === attrs
-      attrs = {}.tap do |accum|
-        attrs.each do |entry|
-          k, _, v = entry.partition '='
-          accum[k] = v
+      if !(attrs = options[:attributes])
+        attrs = {}
+      elsif ::Hash === attrs
+        attrs = attrs.merge
+      elsif (defined? ::Java::JavaUtil::Map) && ::Java::JavaUtil::Map === attrs
+        attrs = attrs.dup
+      elsif ::Array === attrs
+        attrs = {}.tap do |accum|
+          attrs.each do |entry|
+            k, _, v = entry.partition '='
+            accum[k] = v
+          end
         end
-      end
-    elsif ::String === attrs
-      # condense and convert non-escaped spaces to null, unescape escaped spaces, then split on null
-      attrs = {}.tap do |accum|
-        attrs.gsub(SpaceDelimiterRx, '\1' + NULL).gsub(EscapedSpaceRx, '\1').split(NULL).each do |entry|
-          k, _, v = entry.partition '='
-          accum[k] = v
+      elsif ::String === attrs
+        # condense and convert non-escaped spaces to null, unescape escaped spaces, then split on null
+        attrs = {}.tap do |accum|
+          attrs.gsub(SpaceDelimiterRx, '\1' + NULL).gsub(EscapedSpaceRx, '\1').split(NULL).each do |entry|
+            k, _, v = entry.partition '='
+            accum[k] = v
+          end
         end
+      elsif (attrs.respond_to? :keys) && (attrs.respond_to? :[])
+        # coerce attrs to a real Hash
+        attrs = {}.tap {|accum| attrs.keys.each {|k| accum[k] = attrs[k] } }
+      else
+        raise ::ArgumentError, %(illegal type for attributes option: #{attrs.class.ancestors.join ' < '})
       end
-    elsif (attrs.respond_to? :keys) && (attrs.respond_to? :[])
-      # coerce attrs to a real Hash
-      attrs = {}.tap {|accum| attrs.keys.each {|k| accum[k] = attrs[k] } }
-    else
-      raise ::ArgumentError, %(illegal type for attributes option: #{attrs.class.ancestors.join ' < '})
-    end
 
-    if ::File === input
-      options[:input_mtime] = input.mtime
-      # NOTE defer setting infile and indir until we get a better sense of their purpose
-      # TODO cli checks if input path can be read and is file, but might want to add check to API too
-      attrs['docfile'] = input_path = ::File.absolute_path input.path
-      attrs['docdir'] = ::File.dirname input_path
-      attrs['docname'] = Helpers.basename input_path, (attrs['docfilesuffix'] = Helpers.extname input_path)
-      source = input.read
-    elsif input.respond_to? :read
-      # NOTE tty, pipes & sockets can't be rewound, but can't be sniffed easily either
-      # just fail the rewind operation silently to handle all cases
-      input.rewind rescue nil
-      source = input.read
-    elsif ::String === input
-      source = input
-    elsif ::Array === input
-      source = input.drop 0
-    elsif input
-      raise ::ArgumentError, %(unsupported input type: #{input.class})
-    end
+      if ::File === input
+        options[:input_mtime] = input.mtime
+        # NOTE defer setting infile and indir until we get a better sense of their purpose
+        # TODO cli checks if input path can be read and is file, but might want to add check to API too
+        attrs['docfile'] = input_path = ::File.absolute_path input.path
+        attrs['docdir'] = ::File.dirname input_path
+        attrs['docname'] = Helpers.basename input_path, (attrs['docfilesuffix'] = Helpers.extname input_path)
+        source = input.read
+      elsif input.respond_to? :read
+        # NOTE tty, pipes & sockets can't be rewound, but can't be sniffed easily either
+        # just fail the rewind operation silently to handle all cases
+        input.rewind rescue nil
+        source = input.read
+      elsif ::String === input
+        source = input
+      elsif ::Array === input
+        source = input.drop 0
+      elsif input
+        raise ::ArgumentError, %(unsupported input type: #{input.class})
+      end
 
-    if timings
-      timings.record :read
-      timings.start :parse
-    end
+      if timings
+        timings.record :read
+        timings.start :parse
+      end
 
-    options[:attributes] = attrs
-    doc = options[:parse] == false ? (Document.new source, options) : (Document.new source, options).parse
+      options[:attributes] = attrs
+      doc = options[:parse] == false ? (Document.new source, options) : (Document.new source, options).parse
 
-    timings.record :parse if timings
-    doc
-  rescue => ex
-    begin
-      context = %(asciidoctor: FAILED: #{attrs['docfile'] || '<stdin>'}: Failed to load AsciiDoc document)
-      if ex.respond_to? :exception
-        # The original message must be explicitly preserved when wrapping a Ruby exception
-        wrapped_ex = ex.exception %(#{context} - #{ex.message})
-        # JRuby automatically sets backtrace; MRI did not until 2.6
-        wrapped_ex.set_backtrace ex.backtrace
-      else
-        # Likely a Java exception class
-        wrapped_ex = ex.class.new context, ex
-        wrapped_ex.stack_trace = ex.stack_trace
+      timings.record :parse if timings
+      doc
+    rescue => ex
+      begin
+        context = %(asciidoctor: FAILED: #{attrs['docfile'] || '<stdin>'}: Failed to load AsciiDoc document)
+        if ex.respond_to? :exception
+          # The original message must be explicitly preserved when wrapping a Ruby exception
+          wrapped_ex = ex.exception %(#{context} - #{ex.message})
+          # JRuby automatically sets backtrace; MRI did not until 2.6
+          wrapped_ex.set_backtrace ex.backtrace
+        else
+          # Likely a Java exception class
+          wrapped_ex = ex.class.new context, ex
+          wrapped_ex.stack_trace = ex.stack_trace
+        end
+      rescue
+        wrapped_ex = ex
       end
-    rescue
-      wrapped_ex = ex
+      raise wrapped_ex
     end
-    raise wrapped_ex
-  end
 
-  # Public: Parse the contents of the AsciiDoc source file into an Asciidoctor::Document
-  #
-  # input   - the String AsciiDoc source filename
-  # options - a String, Array or Hash of options to control processing (default: {})
-  #           String and Array values are converted into a Hash.
-  #           See Asciidoctor::Document#initialize for details about options.
-  #
-  # Returns the Asciidoctor::Document
-  def load_file filename, options = {}
-    ::File.open(filename, FILE_READ_MODE) {|file| load file, options }
+    # Public: Parse the contents of the AsciiDoc source file into an Asciidoctor::Document
+    #
+    # input   - the String AsciiDoc source filename
+    # options - a String, Array or Hash of options to control processing (default: {})
+    #           String and Array values are converted into a Hash.
+    #           See Asciidoctor::Document#initialize for details about options.
+    #
+    # Returns the Asciidoctor::Document
+    def load_file filename, options = {}
+      ::File.open(filename, FILE_READ_MODE) {|file| load file, options }
+    end
   end
 end

data/lib/asciidoctor/parser.rb

@@ -433,8 +433,10 @@ class Parser
     # is treated like an untitled section
     elsif preamble # implies parent == document
       if preamble.blocks?
+        if book || document.blocks[1] || !Compliance.unwrap_standalone_preamble
+          preamble.source_location = preamble.blocks[0].source_location if document.sourcemap
         # unwrap standalone preamble (i.e., document has no sections) except for books, if permissible
-        unless book || document.blocks[1] || !Compliance.unwrap_standalone_preamble
+        else
           document.blocks.shift
           while (child_block = preamble.blocks.shift)
             document << child_block
@@ -858,6 +860,7 @@ class Parser
       when :literal
         block = build_block(block_context, :verbatim, terminator, parent, reader, attributes)
       when :example
+        attributes['caption'] = '' if attributes['collapsible-option']
         block = build_block(block_context, :compound, terminator, parent, reader, attributes)
       when :quote, :verse
         AttributeList.rekey(attributes, [nil, 'attribution', 'citetitle'])
@@ -899,7 +902,7 @@ class Parser
     # FIXME title and caption should be assigned when block is constructed (though we need to handle all cases)
     if attributes['title']
       block.title = block_title = attributes.delete 'title'
-      if (caption_attr_name = CAPTION_ATTR_NAMES[block.context]) && document.attributes[caption_attr_name]
+      if (caption_attr_name = CAPTION_ATTRIBUTE_NAMES[block.context]) && document.attributes[caption_attr_name]
         block.assign_caption (attributes.delete 'caption')
       end
     end
@@ -1148,14 +1151,16 @@ class Parser
   def self.catalog_inline_anchors text, block, document, reader
     text.scan InlineAnchorScanRx do
       if (id = $1)
-        if (reftext = $2)
-          next if (reftext.include? ATTR_REF_HEAD) && (reftext = document.sub_attributes reftext).empty?
-        end
+        next if (reftext = $2) && (reftext.include? ATTR_REF_HEAD) && (reftext = document.sub_attributes reftext).empty?
       else
         id = $3
         if (reftext = $4)
-          reftext = reftext.gsub '\]', ']' if reftext.include? ']'
-          next if (reftext.include? ATTR_REF_HEAD) && (reftext = document.sub_attributes reftext).empty?
+          if reftext.include? ']'
+            reftext = reftext.gsub '\]', ']'
+            reftext = document.sub_attributes reftext if reftext.include? ATTR_REF_HEAD
+          elsif (reftext.include? ATTR_REF_HEAD) && (reftext = document.sub_attributes reftext).empty?
+            next
+          end
         end
       end
       unless document.register :refs, [id, (Inline.new block, :anchor, reftext, type: :ref, id: id)]
@@ -2119,6 +2124,8 @@ class Parser
       name = 'sectnums'
     elsif name == 'hardbreaks'
       name = 'hardbreaks-option'
+    elsif name == 'showtitle'
+      store_attribute 'notitle', (value ? nil : ''), doc, attrs
     end
 
     if doc
@@ -2273,9 +2280,14 @@ class Parser
     end
 
     skipped = table_reader.skip_blank_lines || 0
+    if attributes['header-option']
+      table.has_header_option = true
+    elsif skipped == 0 && !attributes['noheader-option']
+      # NOTE: assume table has header until we know otherwise; if it doesn't (nil), cells in first row get reprocessed
+      table.has_header_option = implicit_header = true
+    end
     parser_ctx = Table::ParserContext.new table_reader, table, attributes
     format, loop_idx, implicit_header_boundary = parser_ctx.format, -1, nil
-    implicit_header = true unless skipped > 0 || attributes['header-option'] || attributes['noheader-option']
 
     while (line = table_reader.read_line)
       if (beyond_first = (loop_idx += 1) > 0) && line.empty?
@@ -2295,7 +2307,7 @@ class Parser
             implicit_header_boundary = nil if implicit_header_boundary
           # otherwise, the cell continues from previous line
           elsif implicit_header_boundary && implicit_header_boundary == loop_idx
-            implicit_header, implicit_header_boundary = false, nil
+            table.has_header_option = implicit_header = implicit_header_boundary = nil
           end
         end
       end
@@ -2307,7 +2319,7 @@ class Parser
           if table_reader.has_more_lines? && table_reader.peek_line.empty?
             implicit_header_boundary = 1
           else
-            implicit_header = false
+            table.has_header_option = implicit_header = nil
           end
         end
       end
@@ -2358,7 +2370,7 @@ class Parser
           case format
           when 'csv'
             if parser_ctx.buffer_has_unclosed_quotes?
-              implicit_header, implicit_header_boundary = false, nil if implicit_header_boundary && loop_idx == 0
+              table.has_header_option = implicit_header = implicit_header_boundary = nil if implicit_header_boundary && loop_idx == 0
               parser_ctx.keep_cell_open
             else
               parser_ctx.close_cell true
@@ -2380,15 +2392,8 @@ class Parser
       end
     end
 
-    unless (table.attributes['colcount'] ||= table.columns.size) == 0 || explicit_colspecs
-      table.assign_column_widths
-    end
-
-    if implicit_header
-      table.has_header_option = true
-      attributes['header-option'] = ''
-    end
-
+    table.assign_column_widths unless (table.attributes['colcount'] ||= table.columns.size) == 0 || explicit_colspecs
+    attributes['header-option'] = '' if implicit_header
     table.partition_header_footer attributes
 
     table
@@ -2579,9 +2584,7 @@ class Parser
           attributes['role'] = (existing_role = attributes['role']).nil_or_empty? ? (parsed_attrs[:role].join ' ') : %(#{existing_role} #{parsed_attrs[:role].join ' '})
         end
 
-        if parsed_attrs.key? :option
-          (opts = parsed_attrs[:option]).each {|opt| attributes[%(#{opt}-option)] = '' }
-        end
+        parsed_attrs[:option].each {|opt| attributes[%(#{opt}-option)] = '' } if parsed_attrs.key? :option
 
         parsed_style
       else

data/lib/asciidoctor/path_resolver.rb

@@ -331,11 +331,12 @@ class PathResolver
 
   # Public: Securely resolve a system path
   #
-  # Resolve a system path from the target relative to the start path, jail path, or working
-  # directory (specified in the constructor), in that order. If a jail path is specified, enforce
-  # that the resolved path descends from the jail path. If a jail path is not provided, the resolved
-  # path may be any location on the system. If the resolved path is absolute, use it as is (unless
-  # it breaches the jail path). Expand all parent and self references in the resolved path.
+  # Resolves the target to an absolute path on the current filesystem. The target is assumed to be
+  # relative to the start path, jail path, or working directory (specified in the constructor), in
+  # that order. If a jail path is specified, the resolved path is forced to descend from the jail
+  # path. If a jail path is not provided, the resolved path may be any location on the system. If
+  # the target is an absolute path, use it as is (unless it breaches the jail path). Expands all
+  # parent and self references in the resolved path.
   #
   # target - the String target path
   # start  - the String start path from which to resolve a relative target; falls back to jail, if
@@ -347,8 +348,9 @@ class PathResolver
   #            automatically recover when an illegal path is encountered
   #          * :target_name is used in messages to refer to the path being resolved
   #
-  # returns a String path relative to the start path, if specified, and confined to the jail path,
-  # if specified. The path is posixified and all parent and self references in the path are expanded.
+  # Returns an absolute String path relative to the start path, if specified, and confined to the
+  # jail path, if specified. The path is posixified and all parent and self references in the path
+  # are expanded.
   def system_path target, start = nil, jail = nil, opts = {}
     if jail
       raise ::SecurityError, %(Jail is not an absolute path: #{jail}) unless root? jail
@@ -362,7 +364,7 @@ class PathResolver
         if jail && !(descends_from? target_path, jail)
           if opts.fetch :recover, true
             logger.warn %(#{opts[:target_name] || 'path'} is outside of jail; recovering automatically)
-            target_segments, _ = partition_path target_path
+            target_segments, = partition_path target_path
             jail_segments, jail_root = partition_path jail
             return join_path jail_segments + target_segments, jail_root
           else
@@ -371,7 +373,7 @@ class PathResolver
         end
         return target_path
       else
-        target_segments, _ = partition_path target
+        target_segments, = partition_path target
       end
     else
       target_segments = []
@@ -387,7 +389,7 @@ class PathResolver
           return expand_path start
         end
       else
-        target_segments, _ = partition_path start
+        target_segments, = partition_path start
         start = jail || @working_dir
       end
     elsif start.nil_or_empty?
@@ -419,7 +421,7 @@ class PathResolver
     if (resolved_segments = start_segments + target_segments).include? DOT_DOT
       unresolved_segments, resolved_segments = resolved_segments, []
       if jail
-        jail_segments, _ = partition_path jail unless jail_segments
+        jail_segments, = partition_path jail unless jail_segments
         warned = false
         unresolved_segments.each do |segment|
           if segment == DOT_DOT
@@ -450,7 +452,7 @@ class PathResolver
         target_path
       elsif opts.fetch :recover, true
         logger.warn %(#{opts[:target_name] || 'path'} is outside of jail; recovering automatically)
-        jail_segments, _ = partition_path jail unless jail_segments
+        jail_segments, = partition_path jail unless jail_segments
         join_path jail_segments + target_segments, jail_root
       else
         raise ::SecurityError, %(#{opts[:target_name] || 'path'} #{target} is outside of jail: #{jail} (disallowed in safe mode))