asciidoctor 1.5.6.1 → 1.5.6.2

data/lib/asciidoctor/document.rb

@@ -319,18 +319,16 @@ class Document < AbstractBlock
     # legacy support for numbered attribute
     attr_overrides['sectnums'] = attr_overrides.delete 'numbered' if attr_overrides.key? 'numbered'
 
-    # if the base_dir option is specified, it overrides docdir as the root for relative paths
-    # otherwise, the base_dir is the directory of the source file (docdir) or the current
-    # directory of the input is a string
-    if options[:base_dir]
-      @base_dir = attr_overrides['docdir'] = ::File.expand_path(options[:base_dir])
+    # If the base_dir option is specified, it overrides docdir and is used as the root for relative
+    # paths. Otherwise, the base_dir is the directory of the source file (docdir), if set, otherwise
+    # the current directory.
+    if (base_dir_val = options[:base_dir])
+      @base_dir = (attr_overrides['docdir'] = ::File.expand_path base_dir_val)
+    elsif attr_overrides['docdir']
+      @base_dir = attr_overrides['docdir']
     else
-      if attr_overrides['docdir']
-        @base_dir = attr_overrides['docdir'] = ::File.expand_path(attr_overrides['docdir'])
-      else
-        #warn 'asciidoctor: WARNING: setting base_dir is recommended when working with string documents' unless nested?
-        @base_dir = attr_overrides['docdir'] = ::File.expand_path(::Dir.pwd)
-      end
+      #warn 'asciidoctor: WARNING: setting base_dir is recommended when working with string documents' unless nested?
+      @base_dir = attr_overrides['docdir'] = ::Dir.pwd
     end
 
     # allow common attributes backend and doctype to be set using options hash, coerce values to string
@@ -1195,12 +1193,10 @@ class Document < AbstractBlock
     if @docinfo_processor_extensions.key?(location)
       # false means we already performed a lookup and didn't find any
       @docinfo_processor_extensions[location] != false
+    elsif @extensions && @document.extensions.docinfo_processors?(location)
+      !!(@docinfo_processor_extensions[location] = @document.extensions.docinfo_processors(location))
     else
-      if @extensions && @document.extensions.docinfo_processors?(location)
-        !!(@docinfo_processor_extensions[location] = @document.extensions.docinfo_processors(location))
-      else
-        @docinfo_processor_extensions[location] = false
-      end
+      @docinfo_processor_extensions[location] = false
     end
   end
 

data/lib/asciidoctor/extensions.rb

@@ -147,7 +147,20 @@ module Extensions
       Block.new parent, context, { :source => source, :attributes => attrs }.merge(opts)
     end
 
+    # Public: Creates an image block node and links it to the specified parent.
+    #
+    # parent - The parent Block (Block, Section, or Document) of this new image block.
+    # attrs  - A Hash of attributes to control how the image block is built.
+    #          Use the target attribute to set the source of the image.
+    #          Use the alt attribute to specify an alternate text for the image.
+    # opts   - An optional Hash of options (default: {})
+    #
+    # Returns a [Block] node with all properties properly initialized.
     def create_image_block parent, attrs, opts = {}
+      unless (target = attrs['target'])
+        raise ::ArgumentError, 'Unable to create an image block, target attribute is required'
+      end
+      attrs['alt'] ||= (attrs['default-alt'] = Helpers.basename(target, true).tr('_-', ' '))
       create_block parent, :image, nil, attrs, opts
     end
 

data/lib/asciidoctor/path_resolver.rb

@@ -124,32 +124,49 @@ class PathResolver
   def initialize file_separator = nil, working_dir = nil
     @file_separator = file_separator ? file_separator : (::File::ALT_SEPARATOR || ::File::SEPARATOR)
     if working_dir
-      @working_dir = (is_root? working_dir) ? working_dir : (::File.expand_path working_dir)
+      @working_dir = (root? working_dir) ? working_dir : (::File.expand_path working_dir)
     else
       @working_dir = ::File.expand_path ::Dir.pwd
     end
     @_partition_path_sys, @_partition_path_web = {}, {}
   end
 
-  # Public: Check if the specified path is an absolute root path.
-  # This operation considers posix paths, windows paths, and file URLs.
+  # Public: Check whether the specified path is an absolute path.
   #
-  # Unix absolute paths and UNC paths start with slash. Windows roots can start
-  # with a drive letter. Absolute paths in the browser start with file://.
+  # This operation considers both posix paths and Windows paths. It does not
+  # consider URIs.
+  #
+  # Unix absolute paths and UNC paths both start with slash. Windows roots can
+  # start with a drive letter.
   #
   # path - the String path to check
   #
   # returns a Boolean indicating whether the path is an absolute root path
-  if RUBY_ENGINE == 'opal'
-    def is_root? path
-      (path.start_with? SLASH) ||
-          (::JAVASCRIPT_IO_MODULE == 'xmlhttprequest' && (path.start_with? 'file://')) ||
-          (@file_separator == BACKSLASH && (WindowsRootRx.match? path))
+  def absolute_path? path
+    (path.start_with? SLASH) || (@file_separator == BACKSLASH && (WindowsRootRx.match? path))
+  end
+
+  # Public: Check if the specified path is an absolute root path (or, in the
+  # browser environment, an absolute URI as well)
+  #
+  # This operation considers both posix paths and Windows paths. If the JavaScript IO
+  # module is xmlhttprequest, this operation also considers absolute URIs.
+  #
+  # Unix absolute paths and UNC paths start with slash. Windows roots can
+  # start with a drive letter. When the IO module is xmlhttprequest (Opal
+  # runtime only), an absolute (qualified) URI (starts with file://, http://,
+  # or https://) is also considered to be an absolute path.
+  #
+  # path - the String path to check
+  #
+  # returns a Boolean indicating whether the path is an absolute root path (or
+  # an absolute URI when the JavaScript IO module is xmlhttprequest)
+  if RUBY_ENGINE == 'opal' && ::JAVASCRIPT_IO_MODULE == 'xmlhttprequest'
+    def root? path
+      (absolute_path? path) || (path.start_with? 'file://', 'http://', 'https://')
     end
   else
-    def is_root? path
-      (path.start_with? SLASH) || (@file_separator == BACKSLASH && (WindowsRootRx.match? path))
-    end
+    alias root? absolute_path?
   end
 
   # Public: Determine if the path is a UNC (root) path
@@ -157,7 +174,7 @@ class PathResolver
   # path - the String path to check
   #
   # returns a Boolean indicating whether the path is a UNC path
-  def is_unc? path
+  def unc? path
     path.start_with? DOUBLE_SLASH
   end
 
@@ -166,10 +183,22 @@ class PathResolver
   # path - the String path to check
   #
   # returns a Boolean indicating whether the path is an absolute (root) web path
-  def is_web_root? path
+  def web_root? path
     path.start_with? SLASH
   end
 
+  # Public: Determine whether path descends from base.
+  #
+  # If path equals base, or base is a parent of path, return true.
+  #
+  # path - The String path to check. Can be relative.
+  # base - The String base path to check against. Can be relative.
+  #
+  # returns If path descends from base, return the offset, otherwise false.
+  def descends_from? path, base
+    base == path ? 0 : ((path.start_with? base + '/') ? base.length + 1 : false)
+  end
+
   # Public: Normalize path by converting any backslashes to forward slashes
   #
   # path - the String path to normalize
@@ -224,7 +253,7 @@ class PathResolver
 
     root = if web
       # ex. /sample/path
-      if is_web_root? posix_path
+      if web_root? posix_path
         SLASH
       # ex. ./sample/path
       elsif posix_path.start_with? DOT_SLASH
@@ -234,9 +263,9 @@ class PathResolver
         nil
       end
     else
-      if is_root? posix_path
+      if root? posix_path
         # ex. //sample/path
-        if is_unc? posix_path
+        if unc? posix_path
           DOUBLE_SLASH
         # ex. /sample/path
         elsif posix_path.start_with? SLASH
@@ -308,7 +337,7 @@ class PathResolver
   # that the resolved path be contained within the jail, if provided
   def system_path target, start = nil, jail = nil, opts = {}
     if jail
-      unless is_root? jail
+      unless root? jail
         raise ::SecurityError, %(Jail is not an absolute path: #{jail})
       end
       jail = posixify jail
@@ -323,7 +352,7 @@ class PathResolver
     if target_segments.empty?
       if start.nil_or_empty?
         return jail ? jail : @working_dir
-      elsif is_root? start
+      elsif root? start
         unless jail
           return expand_path start
         end
@@ -343,7 +372,7 @@ class PathResolver
 
     if start.nil_or_empty?
       start = jail ? jail : @working_dir
-    elsif is_root? start
+    elsif root? start
       start = posixify start
     else
       start = system_path start, jail, jail, opts
@@ -412,7 +441,7 @@ class PathResolver
     start = posixify start
     uri_prefix = nil
 
-    unless start.nil_or_empty? || (is_web_root? target)
+    unless start.nil_or_empty? || (web_root? target)
       target = (start.end_with? SLASH) ? %(#{start}#{target}) : %(#{start}#{SLASH}#{target})
       if (uri_prefix = Helpers.uri_prefix target)
         target = target[uri_prefix.length..-1]
@@ -420,7 +449,7 @@ class PathResolver
     end
 
     # use this logic instead if we want to normalize target if it contains a URI
-    #unless is_web_root? target
+    #unless web_root? target
     #  if preserve_uri_target && (uri_prefix = Helpers.uri_prefix target)
     #    target = target[uri_prefix.length..-1]
     #  elsif !start.nil_or_empty?
@@ -466,7 +495,7 @@ class PathResolver
   #
   # Return the [String] relative path of the filename calculated from the base directory.
   def relative_path filename, base_directory
-    if (is_root? filename) && (filename.start_with? base_directory)
+    if (root? filename) && (filename.start_with? base_directory)
       filename.slice base_directory.length + 1, filename.length
     else
       filename

data/lib/asciidoctor/reader.rb

@@ -89,12 +89,10 @@ class Reader
       else
         data.split LF, -1
       end
+    elsif opts[:normalize]
+      Helpers.normalize_lines_array data
     else
-      if opts[:normalize]
-        Helpers.normalize_lines_array data
-      else
-        data.dup
-      end
+      data.dup
     end
   end
 
@@ -296,11 +294,11 @@ class Reader
   #
   # replacement - The String line to put in place of the next line (i.e., the line at the cursor).
   #
-  # Returns nothing.
+  # Returns true.
   def replace_next_line replacement
     shift
     unshift replacement
-    nil
+    true
   end
   # deprecated
   alias replace_line replace_next_line
@@ -816,76 +814,46 @@ class PreprocessorReader < Reader
   #
   # If none of the above apply, emit the include directive line verbatim.
   #
-  # target - The name of the source document to include as specified in the
-  #          target slot of the include::[] directive
+  # target   - The unsubstituted String name of the target document to include as specified in the
+  #            target slot of the include directive.
+  # attrlist - An attribute list String, which is the text between the square brackets of the
+  #            include directive.
   #
-  # Returns a Boolean indicating whether the line under the cursor has changed.
-  def preprocess_include_directive raw_target, raw_attributes
-    if ((target = raw_target).include? ATTR_REF_HEAD) &&
-        (target = @document.sub_attributes raw_target, :attribute_missing => 'drop-line').empty?
+  # Returns a [Boolean] indicating whether the line under the cursor was changed. To skip over the
+  # directive, call shift and return true.
+  def preprocess_include_directive target, attrlist
+    if ((expanded_target = target).include? ATTR_REF_HEAD) &&
+        (expanded_target = @document.sub_attributes target, :attribute_missing => 'drop-line').empty?
       shift
       if @document.attributes.fetch('attribute-missing', Compliance.attribute_missing) == 'skip'
-        unshift %(Unresolved directive in #{@path} - include::#{raw_target}[#{raw_attributes}])
+        unshift %(Unresolved directive in #{@path} - include::#{target}[#{attrlist}])
       end
       true
-    elsif include_processors? && (ext = @include_processor_extensions.find {|candidate| candidate.instance.handles? target })
+    elsif include_processors? && (ext = @include_processor_extensions.find {|candidate| candidate.instance.handles? expanded_target })
       shift
       # FIXME parse attributes only if requested by extension
-      ext.process_method[@document, self, target, AttributeList.new(raw_attributes).parse]
+      ext.process_method[@document, self, expanded_target, AttributeList.new(attrlist).parse]
       true
     # if running in SafeMode::SECURE or greater, don't process this directive
     # 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_next_line %(link:#{target}[])
-      true
+      replace_next_line %(link:#{expanded_target}[])
     elsif (abs_maxdepth = @maxdepth[:abs]) > 0
       if @include_stack.size >= abs_maxdepth
         warn %(asciidoctor: ERROR: #{line_info}: maximum include depth of #{@maxdepth[:rel]} exceeded)
-        return false
+        return
       end
-      if ::RUBY_ENGINE_OPAL && ::JAVASCRIPT_IO_MODULE == 'xmlhttprequest'
-        # NOTE resolves uri relative to currently loaded document
-        # NOTE we defer checking if file exists and catch the 404 error if it does not
-        target_type = :file
-        inc_path = relpath = @include_stack.empty? && ::Dir.pwd == @document.base_dir ? target : (::File.join @dir, target)
-      elsif Helpers.uriish? target
-        unless @document.attributes.key? 'allow-uri-read'
-          replace_next_line %(link:#{target}[])
-          return true
-        end
 
-        target_type = :uri
-        inc_path = relpath = target
-        if @document.attributes.key? 'cache-uri'
-          # caching requires the open-uri-cached gem to be installed
-          # processing will be automatically aborted if these libraries can't be opened
-          Helpers.require_library 'open-uri/cached', 'open-uri-cached' unless defined? ::OpenURI::Cache
-        elsif !::RUBY_ENGINE_OPAL
-          # autoload open-uri
-          ::OpenURI
-        end
-      else
-        target_type = :file
-        # include file is resolved relative to dir of current include, or base_dir if within original docfile
-        inc_path = @document.normalize_system_path target, @dir, nil, :target_name => 'include file'
-        unless ::File.file? inc_path
-          warn %(asciidoctor: WARNING: #{line_info}: include file not found: #{inc_path})
-          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
-          return true
-        end
-        # NOTE relpath is the path relative to the root document (or base_dir, if set)
-        # QUESTION should we move relative_path method to Document
-        relpath = (@path_resolver ||= PathResolver.new).relative_path inc_path, @document.base_dir
-      end
+      parsed_attributes = attrlist.empty? ? {} : (AttributeList.new attrlist).parse
+      inc_path, target_type, relpath = resolve_include_path expanded_target, attrlist, parsed_attributes
+      return inc_path unless target_type
 
-      inc_linenos, inc_tags, attributes = nil, nil, {}
-      unless raw_attributes.empty?
-        # QUESTION should we use @document.parse_attribues?
-        attributes = AttributeList.new(raw_attributes).parse
-        if attributes.key? 'lines'
+      inc_linenos = inc_tags = nil
+      unless parsed_attributes.empty?
+        if parsed_attributes.key? 'lines'
           inc_linenos = []
-          attributes['lines'].split(DataDelimiterRx).each do |linedef|
+          parsed_attributes['lines'].split(DataDelimiterRx).each do |linedef|
             if linedef.include?('..')
               from, to = linedef.split('..', 2).map {|it| it.to_i }
               if to == -1
@@ -899,17 +867,17 @@ class PreprocessorReader < Reader
             end
           end
           inc_linenos = inc_linenos.empty? ? nil : inc_linenos.sort.uniq
-        elsif attributes.key? 'tag'
-          unless (tag = attributes['tag']).empty?
+        elsif parsed_attributes.key? 'tag'
+          unless (tag = parsed_attributes['tag']).empty?
             if tag.start_with? '!'
               inc_tags = { (tag.slice 1, tag.length) => false } unless tag == '!'
             else
               inc_tags = { tag => true }
             end
           end
-        elsif attributes.key? 'tags'
+        elsif parsed_attributes.key? 'tags'
           inc_tags = {}
-          attributes['tags'].split(DataDelimiterRx).each do |tagdef|
+          parsed_attributes['tags'].split(DataDelimiterRx).each do |tagdef|
             if tagdef.start_with? '!'
               inc_tags[tagdef.slice 1, tagdef.length] = false unless tagdef == '!'
             else
@@ -944,12 +912,11 @@ class PreprocessorReader < Reader
           end
         rescue
           warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{inc_path})
-          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
-          return true
+          return replace_next_line %(Unresolved directive in #{@path} - include::#{expanded_target}[#{attrlist}])
         end
         shift
         # FIXME not accounting for skipped lines in reader line numbering
-        push_include inc_lines, inc_path, relpath, inc_offset, attributes if inc_offset
+        push_include inc_lines, inc_path, relpath, inc_offset, parsed_attributes if inc_offset
       elsif inc_tags
         inc_lines, inc_offset, inc_lineno, tag_stack, tags_used, active_tag = [], nil, 0, [], ::Set.new, nil
         if inc_tags.key? '**'
@@ -982,9 +949,9 @@ class PreprocessorReader < Reader
                   elsif inc_tags.key? this_tag
                     if (idx = tag_stack.rindex {|key, _| key == this_tag })
                       idx == 0 ? tag_stack.shift : (tag_stack.delete_at idx)
-                      warn %(asciidoctor: WARNING: #{target}: line #{inc_lineno}: mismatched end tag in include: expected #{active_tag}, found #{this_tag})
+                      warn %(asciidoctor: WARNING: #{expanded_target}: line #{inc_lineno}: mismatched end tag in include: expected #{active_tag}, found #{this_tag})
                     else
-                      warn %(asciidoctor: WARNING: #{target}: line #{inc_lineno}: unexpected end tag in include: #{this_tag})
+                      warn %(asciidoctor: WARNING: #{expanded_target}: line #{inc_lineno}: unexpected end tag in include: #{this_tag})
                     end
                   end
                 elsif inc_tags.key?(this_tag = $2)
@@ -1004,25 +971,23 @@ class PreprocessorReader < Reader
           end
         rescue
           warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{inc_path})
-          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
-          return true
+          return replace_next_line %(Unresolved directive in #{@path} - include::#{expanded_target}[#{attrlist}])
         end
         unless (missing_tags = inc_tags.keys.to_a - tags_used.to_a).empty?
           warn %(asciidoctor: WARNING: #{line_info}: tag#{missing_tags.size > 1 ? 's' : nil} '#{missing_tags * ','}' not found in include #{target_type}: #{inc_path})
         end
         shift
         # FIXME not accounting for skipped lines in reader line numbering
-        push_include inc_lines, inc_path, relpath, inc_offset, attributes if inc_offset
+        push_include inc_lines, inc_path, relpath, inc_offset, parsed_attributes if inc_offset
       else
         begin
           # NOTE read content first so that we only advance cursor if IO operation succeeds
           inc_content = target_type == :file ? (::IO.read inc_path) : open(inc_path, 'r') {|f| f.read }
           shift
-          push_include inc_content, inc_path, relpath, 1, attributes
+          push_include inc_content, inc_path, relpath, 1, parsed_attributes
         rescue
           warn %(asciidoctor: WARNING: #{line_info}: include #{target_type} not readable: #{inc_path})
-          replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
-          return true
+          return replace_next_line %(Unresolved directive in #{@path} - include::#{expanded_target}[#{attrlist}])
         end
       end
       true
@@ -1031,6 +996,50 @@ class PreprocessorReader < Reader
     end
   end
 
+  # Internal: Resolve the target of an include directive.
+  #
+  # An internal method to resolve the target of an include directive. This method must return an
+  # Array containing the resolved (absolute) path of the target, the target type (:file or :uri),
+  # and the path of the target relative to the outermost document. Alternately, the method may
+  # return a boolean to halt processing of the include directive line and to indicate whether the
+  # cursor should be advanced beyond this line (true) or the line should be reprocessed (false).
+  #
+  # This method is overridden in Asciidoctor.js to resolve the target of an include in the browser
+  # environment.
+  #
+  # target     - A String containing the unresolved include target.
+  #              (Attribute references in target value have already been resolved).
+  # attrlist   - An attribute list String (i.e., the text between the square brackets).
+  # attributes - A Hash of attributes parsed from attrlist.
+  #
+  # Returns An Array containing the resolved (absolute) include path, the target type, and the path
+  # relative to the outermost document. May also return a boolean to halt processing of the include.
+  def resolve_include_path target, attrlist, attributes
+    if Helpers.uriish? target
+      return replace_next_line %(link:#{target}[#{attrlist}]) unless @document.attributes.key? 'allow-uri-read'
+      if @document.attributes.key? 'cache-uri'
+        # caching requires the open-uri-cached gem to be installed
+        # processing will be automatically aborted if these libraries can't be opened
+        Helpers.require_library 'open-uri/cached', 'open-uri-cached' unless defined? ::OpenURI::Cache
+      elsif !::RUBY_ENGINE_OPAL
+        # autoload open-uri
+        ::OpenURI
+      end
+      [target, :uri, target]
+    else
+      # include file is resolved relative to dir of current include, or base_dir if within original docfile
+      inc_path = @document.normalize_system_path target, @dir, nil, :target_name => 'include file'
+      unless ::File.file? inc_path
+        warn %(asciidoctor: WARNING: #{line_info}: include file not found: #{inc_path})
+        return replace_next_line %(Unresolved directive in #{@path} - include::#{target}[#{attrlist}])
+      end
+      # NOTE relpath is the path relative to the root document (or base_dir, if set)
+      # QUESTION should we move relative_path method to Document
+      relpath = (@path_resolver ||= PathResolver.new).relative_path inc_path, @document.base_dir
+      [inc_path, :file, relpath]
+    end
+  end
+
   # Public: Push source onto the front of the reader and switch the context
   # based on the file, document-relative path and line information given.
   #
@@ -1205,22 +1214,20 @@ class PreprocessorReader < Reader
 
     if quoted
       val
+    elsif val.empty?
+      nil
+    elsif val == 'true'
+      true
+    elsif val == 'false'
+      false
+    elsif val.rstrip.empty?
+      ' '
+    elsif val.include? '.'
+      val.to_f
     else
-      if val.empty?
-        nil
-      elsif val == 'true'
-        true
-      elsif val == 'false'
-        false
-      elsif val.rstrip.empty?
-        ' '
-      elsif val.include? '.'
-        val.to_f
-      else
-        # fallback to coercing to integer, since we
-        # require string values to be explicitly quoted
-        val.to_i
-      end
+      # fallback to coercing to integer, since we
+      # require string values to be explicitly quoted
+      val.to_i
     end
   end