asciidoctor 1.5.3 → 1.5.4

data/lib/asciidoctor/path_resolver.rb

@@ -96,7 +96,7 @@ module Asciidoctor
 #     begin
 #       resolver.system_path('images', '/etc', '/path/to/docs')
 #     rescue SecurityError => e
-#       puts e.message 
+#       puts e.message
 #     end
 #     => Start path /etc is outside of jail: /path/to/docs'
 #
@@ -145,6 +145,9 @@ class PathResolver
     # Windows roots can begin with drive letter
     elsif @file_separator == BACKSLASH && WindowsRootRx =~ path
       true
+    # Absolute paths in the browser start with file:///
+    elsif ::RUBY_ENGINE_OPAL && ::JAVASCRIPT_PLATFORM == 'browser' && (path.start_with? 'file:///')
+      true
     else
       false
     end
@@ -167,7 +170,7 @@ class PathResolver
   def is_web_root? path
     path.start_with? SLASH
   end
-  
+
   # Public: Normalize path by converting any backslashes to forward slashes
   #
   # path - the String path to normalize
@@ -198,7 +201,7 @@ class PathResolver
     path_segments, path_root, _ = partition_path path
     join_path path_segments, path_root
   end
-  
+
   # Public: Partition the path into path segments and remove any empty segments
   # or segments that are self references (.). The path is converted to a posix
   # path before being partitioned.
@@ -211,7 +214,7 @@ class PathResolver
   # path root (e.g., '/', './', 'c:/') if the path is absolute and the posix
   # version of the path.
   #--
-  # QUESTION is it worth it to normalize slashes? it doubles the time elapsed 
+  # QUESTION is it worth it to normalize slashes? it doubles the time elapsed
   def partition_path path, web_path = false
     if (result = web_path ? @_partition_path_web[path] : @_partition_path_sys[path])
       return result
@@ -238,7 +241,7 @@ class PathResolver
         # ex. /sample/path
         elsif posix_path.start_with? SLASH
           SLASH
-        # ex. c:/sample/path
+        # ex. c:/sample/path (or file:///sample/path in browser environment)
         else
           posix_path[0..(posix_path.index SLASH)]
         end
@@ -255,6 +258,11 @@ class PathResolver
     # shift twice for a UNC path
     if root == DOUBLE_SLASH
       path_segments = path_segments[2..-1]
+    # shift twice for a file:/// path and adjust root
+    # NOTE technically file:/// paths work without this adjustment
+    #elsif ::RUBY_ENGINE_OPAL && ::JAVASCRIPT_PLATFORM == 'browser' && root == 'file:/'
+    #  root = 'file://'
+    #  path_segments = path_segments[2..-1]
     # shift once for any other root
     elsif root
       path_segments.shift
@@ -265,7 +273,7 @@ class PathResolver
     #posix_path = posix_path.chomp '/'
     (web_path ? @_partition_path_web : @_partition_path_sys)[path] = [path_segments, root, posix_path]
   end
-  
+
   # Public: Join the segments using the posix file separator (since Ruby knows
   # how to work with paths specified this way, regardless of OS). Use the root,
   # if specified, to construct an absolute path. Otherwise join the segments as
@@ -283,7 +291,7 @@ class PathResolver
       segments * SLASH
     end
   end
-  
+
   # Public: Resolve a system path from the target and start paths. If a jail
   # path is specified, enforce that the resolved directory is contained within
   # the jail path. If a jail path is not provided, the resolved path may be
@@ -313,7 +321,7 @@ class PathResolver
     if target.nil_or_empty?
       target_segments = []
     else
-      target_segments, target_root, _ = partition_path target 
+      target_segments, target_root, _ = partition_path target
     end
 
     if target_segments.empty?
@@ -327,7 +335,7 @@ class PathResolver
         return system_path start, jail, jail, opts
       end
     end
-  
+
     if target_root && target_root != DOT_SLASH
       resolved_target = join_path target_segments, target_root
       # if target is absolute and a sub-directory of jail, or
@@ -336,7 +344,7 @@ class PathResolver
         return resolved_target
       end
     end
-  
+
     if start.nil_or_empty?
       start = jail ? jail : @working_dir
     elsif is_root? start
@@ -344,7 +352,7 @@ class PathResolver
     else
       start = system_path start, jail, jail, opts
     end
-  
+
     # both jail and start have been posixfied at this point
     if jail == start
       jail_segments, jail_root, _ = partition_path jail
@@ -354,9 +362,9 @@ class PathResolver
         raise ::SecurityError, %(#{opts[:target_name] || 'Start path'} #{start} is outside of jail: #{jail} (disallowed in safe mode))
       end
 
-      start_segments, start_root, _ = partition_path start 
+      start_segments, start_root, _ = partition_path start
       jail_segments, jail_root, _ = partition_path jail
-  
+
       # Already checked for this condition
       #if start_root != jail_root
       #  raise ::SecurityError, %(Jail root #{jail_root} does not match root of #{opts[:target_name] || 'start path'}: #{start_root})
@@ -365,7 +373,7 @@ class PathResolver
       start_segments, start_root, _ = partition_path start
       jail_root = start_root
     end
-  
+
     resolved_segments = start_segments.dup
     warned = false
     target_segments.each do |segment|
@@ -386,7 +394,7 @@ class PathResolver
         resolved_segments.push segment
       end
     end
-  
+
     join_path resolved_segments, jail_root
   end
 

data/lib/asciidoctor/reader.rb

@@ -7,7 +7,7 @@ class Reader
     attr_accessor :dir
     attr_accessor :path
     attr_accessor :lineno
-  
+
     def initialize file, dir = nil, path = nil, lineno = nil
       @file = file
       @dir = dir
@@ -147,7 +147,7 @@ class Reader
   #           returns the first element of the internal @lines Array. (default: false)
   #
   # Returns the next line of the source data as a String if there are lines remaining.
-  # Returns nil if there is no more data.
+  # Returns nothing if there is no more data.
   def peek_line direct = false
     if direct || @look_ahead > 0
       @unescape_next_line ? @lines[0][1..-1] : @lines[0]
@@ -205,7 +205,7 @@ class Reader
   #           returns the first element of the internal @lines Array. (default: false)
   #
   # Returns the String of the next line of the source data if data is present.
-  # Returns nil if there is no more data.
+  # Returns nothing if there is no more data.
   def read_line direct = false
     if direct || @look_ahead > 0 || has_more_lines?
       shift
@@ -245,7 +245,7 @@ class Reader
   # direct  - A Boolean flag to bypasses the check for more lines and immediately
   #           returns the first element of the internal @lines Array. (default: true)
   #
-  # returns a Boolean indicating whether there was a line to discard.
+  # Returns a Boolean indicating whether there was a line to discard.
   def advance direct = true
     !!read_line(direct)
   end
@@ -255,7 +255,9 @@ class Reader
   # Since this line was (assumed to be) previously retrieved through the
   # reader, it is marked as seen.
   #
-  # returns nil
+  # line_to_restore - the line to restore onto the stack
+  #
+  # Returns nothing.
   def unshift_line line_to_restore
     unshift line_to_restore
     nil
@@ -267,7 +269,7 @@ class Reader
   # Since these lines were (assumed to be) previously retrieved through the
   # reader, they are marked as seen.
   #
-  # Returns nil
+  # Returns nothing.
   def unshift_lines lines_to_restore
     # QUESTION is it faster to use unshift(*lines_to_restore)?
     lines_to_restore.reverse_each {|line| unshift line }
@@ -275,20 +277,22 @@ class Reader
   end
   alias :restore_lines :unshift_lines
 
-  # Public: Replace the current line with the specified line.
+  # Public: Replace the next line with the specified line.
   #
   # Calls Reader#advance to consume the current line, then calls
   # Reader#unshift to push the replacement onto the top of the
   # line stack.
   #
-  # replacement  - The String line to put in place of the line at the cursor.
+  # replacement - The String line to put in place of the next line (i.e., the line at the cursor).
   #
   # Returns nothing.
-  def replace_line replacement
+  def replace_next_line replacement
     advance
     unshift replacement
     nil
   end
+  # deprecated
+  alias :replace_line :replace_next_line
 
   # Public: Strip off leading blank lines in the Array of lines.
   #
@@ -441,7 +445,7 @@ class Reader
     skip_comments = options[:skip_line_comments]
     line_read = false
     line_restored = false
-    
+
     complete = false
     while !complete && (line = read_line)
       complete = while true
@@ -462,7 +466,7 @@ class Reader
           line_read = true
         end
         if options[:preserve_last_line]
-          restore_line line
+          unshift line
           line_restored = true
         end
       else
@@ -656,7 +660,7 @@ class PreprocessorReader < Reader
   #
   # Returns the next line of the source data as a String if there are lines remaining
   # in the current include context or a parent include context.
-  # Returns nil if there are no more lines remaining and the include stack is empty.
+  # Returns nothing if there are no more lines remaining and the include stack is empty.
   def peek_line direct = false
     if (line = super)
       line
@@ -687,7 +691,7 @@ class PreprocessorReader < Reader
   #              Used for a single-line conditional block in the case of the ifdef or
   #              ifndef directives, and for the conditional expression for the ifeval directive.
   #
-  # returns a Boolean indicating whether the cursor should be advanced
+  # Returns a Boolean indicating whether the cursor should be advanced
   def preprocess_conditional_inclusion directive, target, delimiter, text
     # must have a target before brackets if ifdef or ifndef
     # must not have text between brackets if endif
@@ -773,8 +777,9 @@ class PreprocessorReader < Reader
       unless @skipping || skip
         # FIXME slight hack to skip past conditional line
         # but keep our synthetic line marked as processed
+        # QUESTION can we use read_line true and unshift twice instead?
         conditional_line = peek_line true
-        replace_line text.rstrip
+        replace_next_line text.rstrip
         unshift conditional_line
         return true
       end
@@ -803,16 +808,14 @@ class PreprocessorReader < Reader
   # target - The name of the source document to include as specified in the
   #          target slot of the include::[] macro
   #
-  # returns a Boolean indicating whether the line under the cursor has changed.
+  # Returns a Boolean indicating whether the line under the cursor has changed.
   def preprocess_include raw_target, raw_attributes
     if (target = @document.sub_attributes raw_target, :attribute_missing => 'drop-line').empty?
+      advance
       if @document.attributes.fetch('attribute-missing', Compliance.attribute_missing) == 'skip'
-        replace_line %(Unresolved directive in #{@path} - include::#{raw_target}[#{raw_attributes}])
-        true
-      else
-        advance
-        true
+        unshift %(Unresolved directive in #{@path} - include::#{raw_target}[#{raw_attributes}])
       end
+      true
     # assume that if an include processor is given, the developer wants
     # to handle when and how to process the include
     elsif include_processors? &&
@@ -825,7 +828,7 @@ class PreprocessorReader < Reader
     # however, be friendly and at least make it a link to the source document
     elsif @document.safe >= SafeMode::SECURE
       # FIXME we don't want to use a link macro if we are in a verbatim context
-      replace_line %(link:#{target}[])
+      replace_next_line %(link:#{target}[])
       true
     elsif (abs_maxdepth = @maxdepth[:abs]) > 0 && @include_stack.size >= abs_maxdepth
       warn %(asciidoctor: ERROR: #{line_info}: maximum include depth of #{@maxdepth[:rel]} exceeded)
@@ -843,7 +846,7 @@ class PreprocessorReader < Reader
         end
       elsif Helpers.uriish? target
         unless @document.attributes.has_key? 'allow-uri-read'
-          replace_line %(link:#{target}[])
+          replace_next_line %(link:#{target}[])
           return true
         end
 
@@ -863,7 +866,7 @@ class PreprocessorReader < Reader
         include_file = @document.normalize_system_path(target, @dir, nil, :target_name => 'include file')
         unless ::File.file? include_file
           warn %(asciidoctor: WARNING: #{line_info}: include file not found: #{include_file})
-          replace_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
+          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
           return true
         end
         #path = @document.relative_path include_file
@@ -923,7 +926,7 @@ class PreprocessorReader < Reader
             end
           rescue
             warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{include_file})
-            replace_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
+            replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
             return true
           end
           advance
@@ -966,7 +969,7 @@ class PreprocessorReader < Reader
             end
           rescue
             warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{include_file})
-            replace_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
+            replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
             return true
           end
           unless (missing_tags = tags.to_a - tags_found.to_a).empty?
@@ -978,11 +981,13 @@ class PreprocessorReader < Reader
         end
       else
         begin
+          # NOTE read content first so that we only advance cursor if IO operation succeeds
+          include_content = open(include_file, 'r') {|f| f.read }
           advance
-          push_include open(include_file, 'r') {|f| f.read }, include_file, path, 1, attributes
+          push_include include_content, include_file, path, 1, attributes
         rescue
           warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{include_file})
-          replace_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
+          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
           return true
         end
       end
@@ -1005,7 +1010,7 @@ class PreprocessorReader < Reader
   #    data = IO.read file
   #    reader.push_include data, file, path
   #
-  # Returns nothing
+  # Returns nothing.
   def push_include data, file = nil, path = nil, lineno = 1, attributes = {}
     @include_stack << [@lines, @file, @dir, @path, @lineno, @maxdepth, @process_lines]
     if file
@@ -1075,7 +1080,7 @@ class PreprocessorReader < Reader
   end
 
   def include_depth
-    @include_stack.size 
+    @include_stack.size
   end
 
   def exceeded_max_depth?

data/lib/asciidoctor/section.rb

@@ -95,9 +95,9 @@ class Section < AbstractBlock
       gen_id = base_id
       cnt = Compliance.unique_id_start_index
       while @document.references[:ids].has_key? gen_id
-        gen_id = "#{base_id}#{sep}#{cnt}"
+        gen_id = %(#{base_id}#{sep}#{cnt})
         cnt += 1
-      end 
+      end
       gen_id
     else
       nil
@@ -150,9 +150,9 @@ class Section < AbstractBlock
   def sectnum(delimiter = '.', append = nil)
     append ||= (append == false ? '' : delimiter)
     if @level && @level > 1 && @parent && @parent.context == :section
-      "#{@parent.sectnum(delimiter)}#{@number}#{append}"
+      %(#{@parent.sectnum(delimiter)}#{@number}#{append})
     else
-      "#{@number}#{append}"
+      %(#{@number}#{append})
     end
   end
 
@@ -162,12 +162,10 @@ class Section < AbstractBlock
   #
   # block - The child Block to append to this parent Block
   #
-  # Returns nothing.
+  # Returns The parent Block
   def << block
+    assign_index block if block.context == :section
     super
-    if block.context == :section
-      assign_index block
-    end
   end
 
   def to_s

data/lib/asciidoctor/substitutors.rb

@@ -1303,12 +1303,12 @@ module Substitutors
           current.push c
         end
       end
-  
+
       values << current.join.strip
     else
       values = str.split(',').map {|it| it.strip }
     end
-  
+
     values
   end
 

data/lib/asciidoctor/table.rb

@@ -42,7 +42,7 @@ class Table < AbstractBlock
     'v' => :verse,
     'a' => :asciidoc
   }
-  
+
   # Public: A Hash mapping alignment abbreviations to alignments (horizontal
   # and vertial) that can be applies to a table column or cell
   ALIGNMENTS = {
@@ -99,21 +99,45 @@ class Table < AbstractBlock
   # Internal: Creates the Column objects from the column spec
   #
   # returns nothing
-  def create_columns(col_specs)
-    total_width = 0
+  def create_columns col_specs
     cols = []
+    width_base = 0
     col_specs.each do |col_spec|
-      total_width += col_spec['width']
-      cols << Column.new(self, cols.size, col_spec)
+      width_base += col_spec['width']
+      cols << (Column.new self, cols.size, col_spec)
     end
-
-    unless cols.empty?
+    unless (@columns = cols).empty?
       @attributes['colcount'] = cols.size
-      even_width = (100.0 / cols.size).floor
-      cols.each {|c| c.assign_width(total_width, even_width) }
+      assign_col_widths(width_base == 0 ? nil : width_base)
+    end
+    nil
+  end
+
+  # Internal: Assign column widths to columns
+  #
+  # This method rounds the percentage width values to 4 decimal places and
+  # donates the balance to the final column.
+  #
+  # This method assumes there's at least one column in the columns array.
+  #
+  # width_base - the total of the relative column values used for calculating percentage widths (default: nil)
+  #
+  # returns nothing
+  def assign_col_widths width_base = nil
+    pf = 10.0 ** 4 # precision factor (multipler / divisor) for managing precision of calculated result
+    total_width = col_pcwidth = 0
+
+    if width_base
+      @columns.each {|col| total_width += (col_pcwidth = col.assign_width nil, width_base, pf) }
+    else
+      col_pcwidth = ((100 * pf / @columns.size).to_i) / pf
+      col_pcwidth = col_pcwidth.to_i if col_pcwidth.to_i == col_pcwidth
+      @columns.each {|col| total_width += col.assign_width col_pcwidth }
     end
 
-    @columns = cols
+    # donate balance, if any, to final column
+    @columns[-1].assign_width(((100 - total_width + col_pcwidth) * pf).round / pf) unless total_width == 100
+
     nil
   end
 
@@ -139,7 +163,7 @@ class Table < AbstractBlock
     if num_body_rows > 0 && attributes.key?('footer-option')
       @rows.foot = [@rows.body.pop]
     end
-    
+
     nil
   end
 end
@@ -167,19 +191,18 @@ class Table::Column < AbstractNode
   #
   # This method assigns the colpcwidth and colabswidth attributes.
   #
-  # returns nothing
-  def assign_width(total_width, even_width)
-    if total_width > 0
-      width = ((@attributes['width'].to_f / total_width) * 100).floor
-    else
-      width = even_width
+  # returns the resolved colpcwidth value
+  def assign_width col_pcwidth, width_base = nil, pf = 10000.0
+    if width_base
+      col_pcwidth = ((@attributes['width'].to_f / width_base) * 100 * pf).to_i / pf
+      col_pcwidth = col_pcwidth.to_i if col_pcwidth.to_i == col_pcwidth
     end
-    @attributes['colpcwidth'] = width
+    @attributes['colpcwidth'] = col_pcwidth
     if parent.attributes.key? 'tableabswidth'
-      @attributes['colabswidth'] = ((width.to_f / 100) * parent.attributes['tableabswidth']).round
+      # FIXME calculate more accurately (only used in DocBook output)
+      @attributes['colabswidth'] = ((col_pcwidth / 100.0) * parent.attributes['tableabswidth']).round
     end
-
-    nil
+    col_pcwidth
   end
 end
 
@@ -348,7 +371,7 @@ class Table::ParserContext
 
   # Public: Determines whether the buffer has unclosed quotes. Used for CSV data.
   #
-  # returns true if the buffer has unclosed quotes, false if it doesn't or it 
+  # returns true if the buffer has unclosed quotes, false if it doesn't or it
   # isn't quoted data
   def buffer_has_unclosed_quotes?(append = nil)
     record = %(#{@buffer}#{append}).strip
@@ -455,7 +478,7 @@ class Table::ParserContext
             # unquote
             cell_text = cell_text[1...-1].strip
           end
-          
+
           # collapses escaped quotes
           cell_text = cell_text.tr_s('"', '"')
         end