asciidoctor 1.5.7.1 → 1.5.8

data/lib/asciidoctor/abstract_block.rb

@@ -13,10 +13,14 @@ class AbstractBlock < AbstractNode
   # Public: Set the Integer level of this Section or the Section level in which this Block resides
   attr_accessor :level
 
-  # Public: Get/Set the number of this block (if section, relative to parent, otherwise absolute)
+  # Public: Get/Set the numeral of this block (if section, relative to parent, otherwise absolute)
   # Only assigned to section if automatic section numbering is enabled
   # Only assigned to formal block (block with title) if corresponding caption attribute is present
-  attr_accessor :number
+  attr_accessor :numeral
+
+  # Deprecated: Legacy property to get/set the numeral of this block
+  alias number numeral
+  alias number= numeral=
 
   # Public: Gets/Sets the location in the AsciiDoc source where this block begins
   attr_accessor :source_location
@@ -32,7 +36,7 @@ class AbstractBlock < AbstractNode
     @content_model = :compound
     @blocks = []
     @subs = []
-    @id = @title = @title_converted = @caption = @number = @style = @default_subs = @source_location = nil
+    @id = @title = @title_converted = @caption = @numeral = @style = @default_subs = @source_location = nil
     if context == :document
       @level = 0
     elsif parent && context != :section
@@ -41,7 +45,7 @@ class AbstractBlock < AbstractNode
       @level = nil
     end
     @next_section_index = 0
-    @next_section_number = 1
+    @next_section_ordinal = 1
   end
 
   def block?
@@ -77,7 +81,7 @@ class AbstractBlock < AbstractNode
   # Public: Get the converted result of the child blocks by converting the
   # children appropriate to content model that this block supports.
   def content
-    @blocks.map {|b| b.convert } * LF
+    @blocks.map {|b| b.convert }.join LF
   end
 
   # Public: Update the context of this block.
@@ -132,10 +136,16 @@ class AbstractBlock < AbstractNode
     @next_section_index > 0
   end
 
-  # Public: Query for all descendant block-level nodes in the document tree
-  # that match the specified selector (context, style, id, and/or role). If a
-  # Ruby block is given, it's used as an additional filter. If no selector or
-  # Ruby block is supplied, all block-level nodes in the tree are returned.
+  # Public: Walk the document tree and find all block-level nodes that match
+  # the specified selector (context, style, id, role, and/or custom filter).
+  #
+  # If a Ruby block is given, it's treated as an supplemental filter. If the
+  # filter returns true, the node is accepted and traversal continues. If the
+  # filter returns false, the node is rejected, but traversal continues. If the
+  # filter returns :skip, the node and all its descendants are rejected. If the
+  # filter returns :skip_children, the node is accepted, but its descendants
+  # are rejected. If no selector or filter block is supplied, all block-level
+  # nodes in the tree are returned.
   #
   # Examples
   #
@@ -153,20 +163,34 @@ class AbstractBlock < AbstractNode
   #--
   # TODO support jQuery-style selector (e.g., image.thumb)
   def find_by selector = {}, &block
-    result = []
+    find_by_internal selector, (result = []), &block
+  rescue ::StopIteration
+    result
+  end
+
+  alias query find_by
 
+  # Internal: Performs the work for find_by, but does not handle the StopIteration exception.
+  def find_by_internal selector = {}, result = [], &block
     if ((any_context = !(context_selector = selector[:context])) || context_selector == @context) &&
         (!(style_selector = selector[:style]) || style_selector == @style) &&
         (!(role_selector = selector[:role]) || (has_role? role_selector)) &&
         (!(id_selector = selector[:id]) || id_selector == @id)
       if id_selector
-        if block_given?
-          return (yield self) ? [self] : result
-        else
-          return [self]
-        end
+        result.replace block_given? ? ((yield self) ? [self] : []) : [self]
+        raise ::StopIteration
       elsif block_given?
-        result << self if (yield self)
+        if (verdict = yield self)
+          case verdict
+          when :skip_children
+            result << self
+            return result
+          when :skip
+            return result
+          else
+            result << self
+          end
+        end
       else
         result << self
       end
@@ -174,7 +198,7 @@ class AbstractBlock < AbstractNode
 
     # process document header as a section if present
     if @context == :document && (any_context || context_selector == :section) && header?
-      result.concat(@header.find_by selector, &block)
+      @header.find_by_internal selector, result, &block
     end
 
     unless context_selector == :document # optimization
@@ -183,21 +207,19 @@ class AbstractBlock < AbstractNode
         if any_context || context_selector != :section # optimization
           @blocks.flatten.each do |li|
             # NOTE the list item of a dlist can be nil, so we have to check
-            result.concat(li.find_by selector, &block) if li
+            li.find_by_internal selector, result, &block if li
           end
         end
       elsif
         @blocks.each do |b|
           next if (context_selector == :section && b.context != :section) # optimization
-          result.concat(b.find_by selector, &block)
+          b.find_by_internal selector, result, &block
         end
       end
     end
     result
   end
 
-  alias query find_by
-
   # Move to the next adjacent block in document order. If the current block is the last
   # item in a list, this method will return the following sibling of the list block.
   def next_adjacent_block
@@ -358,14 +380,14 @@ class AbstractBlock < AbstractNode
       case xrefstyle
       when 'full'
         quoted_title = sprintf sub_quotes(@document.compat_mode ? %q(``%s'') : '"`%s`"'), title
-        if @number && (prefix = @document.attributes[@context == :image ? 'figure-caption' : %(#{@context}-caption)])
-          %(#{prefix} #{@number}, #{quoted_title})
+        if @numeral && (prefix = @document.attributes[@context == :image ? 'figure-caption' : %(#{@context}-caption)])
+          %(#{prefix} #{@numeral}, #{quoted_title})
         else
           %(#{@caption.chomp '. '}, #{quoted_title})
         end
       when 'short'
-        if @number && (prefix = @document.attributes[@context == :image ? 'figure-caption' : %(#{@context}-caption)])
-          %(#{prefix} #{@number})
+        if @numeral && (prefix = @document.attributes[@context == :image ? 'figure-caption' : %(#{@context}-caption)])
+          %(#{prefix} #{@numeral})
         else
           @caption.chomp '. '
         end
@@ -397,7 +419,7 @@ class AbstractBlock < AbstractNode
   def assign_caption value = nil, key = nil
     unless @caption || !@title || (@caption = value || @document.attributes['caption'])
       if (prefix = @document.attributes[%(#{key ||= @context}-caption)])
-        @caption = %(#{prefix} #{@number = @document.increment_and_store_counter "#{key}-number", self}. )
+        @caption = %(#{prefix} #{@numeral = @document.increment_and_store_counter "#{key}-number", self}. )
         nil
       end
     end
@@ -417,17 +439,18 @@ class AbstractBlock < AbstractNode
     @next_section_index = (section.index = @next_section_index) + 1
     if (like = section.numbered)
       if (sectname = section.sectname) == 'appendix'
-        section.number = @document.counter 'appendix-number', 'A'
+        section.numeral = @document.counter 'appendix-number', 'A'
         if (caption = @document.attributes['appendix-caption'])
-          section.caption = %(#{caption} #{section.number}: )
+          section.caption = %(#{caption} #{section.numeral}: )
         else
-          section.caption = %(#{section.number}. )
+          section.caption = %(#{section.numeral}. )
         end
       # NOTE currently chapters in a book doctype are sequential even for multi-part books (see #979)
       elsif sectname == 'chapter' || like == :chapter
-        section.number = @document.counter 'chapter-number', 1
+        section.numeral = @document.counter 'chapter-number', 1
       else
-        @next_section_number = (section.number = @next_section_number) + 1
+        section.numeral = @next_section_ordinal
+        @next_section_ordinal += 1
       end
     end
     nil
@@ -445,7 +468,7 @@ class AbstractBlock < AbstractNode
   # Returns nothing
   def reindex_sections
     @next_section_index = 0
-    @next_section_number = 1
+    @next_section_ordinal = 1
     @blocks.each do |block|
       if block.context == :section
         assign_numeral block

data/lib/asciidoctor/abstract_node.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Asciidoctor
 # Public: An abstract base class that provides state and methods for managing a
-# node of AsciiDoc content. The state and methods on this class are comment to
+# node of AsciiDoc content. The state and methods on this class are common to
 # all content segments in an AsciiDoc document.
 class AbstractNode
   include Logging
@@ -162,21 +162,32 @@ class AbstractNode
     @attributes.key? %(#{name}-option)
   end
 
-  # TODO document me
+  # Public: Set the specified option on this node.
+  #
+  # This method sets the specified option on this node if not already set.
+  # It will add the name to the options attribute and set the <name>-option
+  # attribute.
+  #
+  # name - the String name of the option
+  #
+  # returns truthy if the option was set or falsey if the option was already set
   def set_option(name)
-    if @attributes.key? 'options'
-      @attributes['options'] = %(#{@attributes['options']},#{name})
+    if (attrs = @attributes)['options']
+      unless attrs[key = %(#{name}-option)]
+        attrs['options'] += %(,#{name})
+        attrs[key] = ''
+      end
     else
-      @attributes['options'] = name
+      attrs['options'] = name
+      attrs[%(#{name}-option)] = ''
     end
-    @attributes[%(#{name}-option)] = ''
   end
 
   # Public: Update the attributes of this node with the new values in
   # the attributes argument.
   #
   # If an attribute already exists with the same key, it's value will
-  # be overridden.
+  # be overwritten.
   #
   # attributes - A Hash of attributes to assign to this node.
   #
@@ -240,7 +251,7 @@ class AbstractNode
       if val.empty?
         @attributes.delete('role')
       else
-        @attributes['role'] = val * ' '
+        @attributes['role'] = val.join ' '
       end
       true
     else
@@ -358,7 +369,7 @@ class AbstractNode
   def generate_data_uri(target_image, asset_dir_key = nil)
     ext = ::File.extname target_image
     # QUESTION what if ext is empty?
-    mimetype = (ext == '.svg' ? 'image/svg+xml' : %(image/#{ext[1..-1]}))
+    mimetype = (ext == '.svg' ? 'image/svg+xml' : %(image/#{ext.slice 1, ext.length}))
     if asset_dir_key
       image_path = normalize_system_path(target_image, @document.attr(asset_dir_key), nil, :target_name => 'image')
     else
@@ -400,9 +411,9 @@ class AbstractNode
 
     begin
       mimetype = nil
-      bindata = open image_uri, 'rb' do |fd|
-        mimetype = fd.content_type
-        fd.read
+      bindata = open image_uri, 'rb' do |f|
+        mimetype = f.content_type
+        f.read
       end
       # NOTE base64 is autoloaded by reference to ::Base64
       %(data:#{mimetype};base64,#{::Base64.strict_encode64 bindata})
@@ -499,7 +510,8 @@ class AbstractNode
     opts = { :warn_on_failure => (opts != false) } unless ::Hash === opts
     if ::File.readable? path
       if opts[:normalize]
-        Helpers.normalize_lines_from_string(::IO.read path) * LF
+        # NOTE Opal does not yet support File#readlines
+        (Helpers.normalize_lines_array ::File.open(path, 'rb') {|f| f.each_line.to_a }).join LF
       else
         # QUESTION should we chomp or rstrip content?
         ::IO.read path
@@ -533,9 +545,12 @@ class AbstractNode
       if doc.attr? 'allow-uri-read'
         Helpers.require_library 'open-uri/cached', 'open-uri-cached' if doc.attr? 'cache-uri'
         begin
-          data = ::OpenURI.open_uri(target) {|fd| fd.read }
-          data = (Helpers.normalize_lines_from_string data) * LF if opts[:normalize]
-          return data
+          if opts[:normalize]
+            # NOTE Opal does not yet support File#readlines
+            (Helpers.normalize_lines_array ::OpenURI.open_uri(target) {|f| f.each_line.to_a }).join LF
+          else
+            ::OpenURI.open_uri(target) {|f| f.read }
+          end
         rescue
           logger.warn %(could not retrieve contents of #{opts[:label] || 'asset'} at URI: #{target}) if opts.fetch :warn_on_failure, true
           return
@@ -546,7 +561,7 @@ class AbstractNode
       end
     else
       target = normalize_system_path target, opts[:start], nil, :target_name => (opts[:label] || 'asset')
-      return read_asset target, :normalize => opts[:normalize], :warn_on_failure => (opts.fetch :warn_on_failure, true), :label => opts[:label]
+      read_asset target, :normalize => opts[:normalize], :warn_on_failure => (opts.fetch :warn_on_failure, true), :label => opts[:label]
     end
   end
 

data/lib/asciidoctor/attribute_list.rb

@@ -23,18 +23,19 @@ module Asciidoctor
 #
 class AttributeList
   BACKSLASH = '\\'
+  APOS = '\''
 
   # Public: Regular expressions for detecting the boundary of a value
   BoundaryRxs = {
     '"' => /.*?[^\\](?=")/,
-    '\'' => /.*?[^\\](?=')/,
+    APOS => /.*?[^\\](?=')/,
     ',' => /.*?(?=[ \t]*(,|$))/
   }
 
   # Public: Regular expressions for unescaping quoted characters
   EscapedQuotes = {
     '"' => '\\"',
-    '\'' => '\\\''
+    APOS => '\\\''
   }
 
   # Public: A regular expression for an attribute name (approx. name token from XML)
@@ -105,10 +106,10 @@ class AttributeList
       name = parse_attribute_value @scanner.get_byte
       value = nil
     # example: 'quote'
-    elsif first == '\''
+    elsif first == APOS
       name = parse_attribute_value @scanner.get_byte
       value = nil
-      single_quoted_value = true
+      single_quoted_value = true unless name.start_with? APOS
     else
       name = scan_name
 
@@ -135,12 +136,12 @@ class AttributeList
           if (c = @scanner.get_byte) == '"'
             value = parse_attribute_value c
           # example: foo='bar' || foo='ba\'zaar' || foo='ba"zaar'
-          elsif c == '\''
+          elsif c == APOS
             value = parse_attribute_value c
-            single_quoted_value = true
+            single_quoted_value = true unless value.start_with? APOS
           # example: foo=,
           elsif c == @delimiter
-            value = nil
+            value = ''
           # example: foo=bar (all spaces ignored)
           else
             value = %(#{c}#{scan_to_delimiter})

data/lib/asciidoctor/block.rb

@@ -61,7 +61,7 @@ class Block < AbstractBlock
         # e.g., :subs => [:quotes]
         # subs attribute is not honored
         elsif ::Array === subs
-          @default_subs = subs.dup
+          @default_subs = subs.drop 0
           @attributes.delete 'subs'
         # e.g., :subs => :normal or :subs => 'normal'
         # subs attribute is not honored
@@ -90,7 +90,7 @@ class Block < AbstractBlock
     elsif ::String === raw_source
       @lines = Helpers.normalize_lines_from_string raw_source
     else
-      @lines = raw_source.dup
+      @lines = raw_source.drop 0
     end
   end
 
@@ -109,10 +109,8 @@ class Block < AbstractBlock
     when :compound
       super
     when :simple
-      apply_subs @lines * LF, @subs
+      apply_subs((@lines.join LF), @subs)
     when :verbatim, :raw
-      #((apply_subs @lines * LF, @subs).sub StripLineWiseRx, '\1')
-
       # QUESTION could we use strip here instead of popping empty lines?
       # maybe apply_subs can know how to strip whitespace?
       result = apply_subs @lines, @subs
@@ -121,7 +119,7 @@ class Block < AbstractBlock
       else
         result.shift while (first = result[0]) && first.rstrip.empty?
         result.pop while (last = result[-1]) && last.rstrip.empty?
-        result * LF
+        result.join LF
       end
     else
       logger.warn %(Unknown content model '#{@content_model}' for block: #{to_s}) unless @content_model == :empty
@@ -134,7 +132,7 @@ class Block < AbstractBlock
   # Returns the a String containing the lines joined together or empty string
   # if there are no lines
   def source
-    @lines * LF
+    @lines.join LF
   end
 
   def to_s

data/lib/asciidoctor/cli/options.rb

@@ -65,7 +65,7 @@ Example: asciidoctor -b html5 source.asciidoc
             self[:safe] = SafeMode::SAFE
           end
           opts.on('-S', '--safe-mode SAFE_MODE', (safe_mode_names = SafeMode.names),
-                  %(set safe mode level explicitly: [#{safe_mode_names * ', '}] (default: unsafe)),
+                  %(set safe mode level explicitly: [#{safe_mode_names.join ', '}] (default: unsafe)),
                   'disables potentially dangerous macros in source files, such as include::[]') do |name|
             self[:safe] = SafeMode.value_for_name name
           end
@@ -84,10 +84,6 @@ Example: asciidoctor -b html5 source.asciidoc
                   'defined in the source document') do |attr|
             key, val = attr.split '=', 2
             val = val ? (FORCE_ENCODING ? (val.force_encoding ::Encoding::UTF_8) : val) : ''
-            # move leading ! to end for internal processing
-            #if !val && key.start_with?('!')
-            #  key = %(#{key[1..-1]}!)
-            #end
             self[:attributes][key] = val
           end
           opts.on('-T', '--template-dir DIR', 'a directory containing custom converter templates that override the built-in converter (requires tilt gem)',
@@ -199,7 +195,7 @@ Example: asciidoctor -b html5 source.asciidoc
           args.each do |file|
             if file == '-' || (file.start_with? '-')
               # warn, but don't panic; we may have enough to proceed, so we won't force a failure
-              $stderr.puts %(asciidoctor: WARNING: extra arguments detected (unparsed arguments: '#{args * "', '"}') or incorrect usage of stdin)
+              $stderr.puts %(asciidoctor: WARNING: extra arguments detected (unparsed arguments: '#{args.join "', '"}') or incorrect usage of stdin)
             else
               if ::File.file? file
                 infiles << file
@@ -290,13 +286,13 @@ Example: asciidoctor -b html5 source.asciidoc
 
       def print_version os = $stdout
         os.puts %(Asciidoctor #{::Asciidoctor::VERSION} [https://asciidoctor.org])
-        if RUBY_MIN_VERSION_1_9
+        if ::RUBY_MIN_VERSION_1_9
           encoding_info = { 'lc' => 'locale', 'fs' => 'filesystem', 'in' => 'internal', 'ex' => 'external' }.map do |k, v|
             %(#{k}:#{v == 'internal' ? (::File.open(__FILE__) {|f| f.getc }).encoding : (::Encoding.find v)})
           end
-          os.puts %(Runtime Environment (#{RUBY_DESCRIPTION}) (#{encoding_info * ' '}))
+          os.puts %(Runtime Environment (#{::RUBY_DESCRIPTION}) (#{encoding_info.join ' '}))
         else
-          os.puts %(Runtime Environment (#{RUBY_DESCRIPTION}))
+          os.puts %(Runtime Environment (#{::RUBY_DESCRIPTION}))
         end
         0
       end

data/lib/asciidoctor/converter.rb

@@ -25,7 +25,7 @@ module Asciidoctor
   #       when 'document'
   #         node.content
   #       when 'section'
-  #         [node.title, node.content] * "\n\n"
+  #         [node.title, node.content].join "\n\n"
   #       when 'paragraph'
   #         node.content.tr("\n", ' ') << "\n"
   #       else
@@ -77,7 +77,7 @@ module Asciidoctor
         raise ::ArgumentError, %(Cannot determine backend for converter: #{self.class}) unless @backend
         base = @backend.sub TrailingDigitsRx, ''
         if (ext = DEFAULT_EXTENSIONS[base])
-          type = ext[1..-1]
+          type = ext.slice 1, ext.length
         else
           # QUESTION should we be forcing the basebackend to html if unknown?
           base = 'html'