asciidoctor 2.0.15 → 2.0.17

data/lib/asciidoctor/document.rb

@@ -198,7 +198,7 @@ class Document < AbstractBlock
   # Public: Get the document catalog Hash
   attr_reader :catalog
 
-  # Public: Alias catalog property as references for backwards compatiblity
+  # Public: Alias catalog property as references for backwards compatibility
   alias references catalog
 
   # Public: Get the Hash of document counters
@@ -286,7 +286,6 @@ class Document < AbstractBlock
         footnotes: [],
         links: [],
         images: [],
-        #indexterms: [],
         callouts: Callouts.new,
         includes: {},
       }
@@ -311,7 +310,7 @@ class Document < AbstractBlock
         end
         attr_overrides[key.downcase] = val
       end
-      if (to_file = options[:to_file])
+      if ::String === (to_file = options[:to_file])
         attr_overrides['outfilesuffix'] = Helpers.extname to_file
       end
       # safely resolve the safe mode from const, int or string
@@ -329,7 +328,7 @@ class Document < AbstractBlock
       @timings = options.delete :timings
       @path_resolver = PathResolver.new
       initialize_extensions = (defined? ::Asciidoctor::Extensions) || (options.key? :extensions) ? ::Asciidoctor::Extensions : nil
-      @extensions = nil # initialize furthur down if initialize_extensions is true
+      @extensions = nil # initialize further down if initialize_extensions is true
       options[:standalone] = options[:header_footer] if (options.key? :header_footer) && !(options.key? :standalone)
     end
 
@@ -360,9 +359,9 @@ class Document < AbstractBlock
       # sync embedded attribute with :standalone option value
       attr_overrides['embedded'] = ''
       if (attr_overrides.key? 'showtitle') && (attr_overrides.keys & %w(notitle showtitle))[-1] == 'showtitle'
-        attr_overrides['notitle'] = { nil => '', false => '@', '@' => false}[attr_overrides['showtitle']]
+        attr_overrides['notitle'] = { nil => '', false => '@', '@' => false }[attr_overrides['showtitle']]
       elsif attr_overrides.key? 'notitle'
-        attr_overrides['showtitle'] = { nil => '', false => '@', '@' => false}[attr_overrides['notitle']]
+        attr_overrides['showtitle'] = { nil => '', false => '@', '@' => false }[attr_overrides['notitle']]
       else
         attrs['notitle'] = ''
       end
@@ -399,11 +398,11 @@ class Document < AbstractBlock
 
     # allow common attributes backend and doctype to be set using options hash, coerce values to string
     if (backend_val = options[:backend])
-      attr_overrides['backend'] = %(#{backend_val})
+      attr_overrides['backend'] = backend_val.to_s
     end
 
     if (doctype_val = options[:doctype])
-      attr_overrides['doctype'] = %(#{doctype_val})
+      attr_overrides['doctype'] = doctype_val.to_s
     end
 
     if @safe >= SafeMode::SERVER
@@ -566,9 +565,7 @@ class Document < AbstractBlock
   # returns the next number in the sequence for the specified counter
   def counter name, seed = nil
     return @parent_document.counter name, seed if @parent_document
-    if (locked = attribute_locked? name) && (curr_val = @counters[name])
-      next_val = @counters[name] = Helpers.nextval curr_val
-    elsif !(curr_val = @attributes[name]).nil_or_empty?
+    if ((locked = attribute_locked? name) && (curr_val = @counters[name])) || !(curr_val = @attributes[name]).nil_or_empty?
       next_val = @counters[name] = Helpers.nextval curr_val
     elsif seed
       next_val = @counters[name] = seed == seed.to_i.to_s ? seed.to_i : seed
@@ -618,15 +615,29 @@ class Document < AbstractBlock
       # @reftexts is set eagerly to prevent nested lazy init
       (@reftexts = {}).tap {|accum| @catalog[:refs].each {|id, ref| accum[ref.xreftext] ||= id } }[text]
     else
-      # @reftexts is set eagerly to prevent nested lazy init
       resolved_id = nil
-      # NOTE short-circuit early since we're throwing away this table
-      (@reftexts = {}).tap {|accum| @catalog[:refs].each {|id, ref| (xreftext = ref.xreftext) == text ? (break (resolved_id = id)) : (accum[xreftext] ||= id) } }
+      # @reftexts is set eagerly to prevent nested lazy init
+      @reftexts = accum = {}
+      @catalog[:refs].each do |id, ref|
+        # NOTE short-circuit early since we're throwing away this table anyway
+        if (xreftext = ref.xreftext) == text
+          resolved_id = id
+          break
+        end
+        accum[xreftext] ||= id
+      end
       @reftexts = nil
       resolved_id
     end
   end
 
+  # Public: Check whether this Document has any child Section objects.
+  #
+  # Returns A [Boolean] to indicate whether this Document has child Section objects
+  def sections?
+    @next_section_index > 0
+  end
+
   def footnotes?
     @catalog[:footnotes].empty? ? false : true
   end
@@ -679,7 +690,7 @@ class Document < AbstractBlock
   #
   # title - the String title to assign as the title of the document header
   #
-  # Returns the new [String] title assigned to the document header
+  # Returns the specified [String] title
   def title= title
     unless (sect = @header)
       (sect = (@header = Section.new self, 0)).sectname = 'header'
@@ -961,8 +972,14 @@ class Document < AbstractBlock
 
   # Public: Write the output to the specified file
   #
-  # If the converter responds to :write, delegate the work of writing the file
-  # to that method. Otherwise, write the output the specified file.
+  # If the converter responds to :write, delegate the work of writing the output
+  # to that method. Otherwise, write the output to the specified file. In the
+  # latter case, this method ensures the output has a trailing newline if the
+  # target responds to write and the output is not empty.
+  #
+  # output - The output to write. Unless the converter responds to write, this
+  #          object is expected to be a String.
+  # target - The file to write, either a File object or a String path.
   #
   # Returns nothing
   def write output, target
@@ -988,25 +1005,6 @@ class Document < AbstractBlock
     nil
   end
 
-=begin
-  def convert_to target, opts = {}
-    start = ::Time.now.to_f if (monitor = opts[:monitor])
-    output = (r = converter opts).convert
-    monitor[:convert] = ::Time.now.to_f - start if monitor
-
-    unless target.respond_to? :write
-      @attributes['outfile'] = target = ::File.expand_path target
-      @attributes['outdir'] = ::File.dirname target
-    end
-
-    start = ::Time.now.to_f if monitor
-    r.write output, target
-    monitor[:write] = ::Time.now.to_f - start if monitor
-
-    output
-  end
-=end
-
   def content
     # NOTE per AsciiDoc-spec, remove the title before converting the body
     @attributes.delete('title')
@@ -1028,7 +1026,7 @@ class Document < AbstractBlock
   def docinfo location = :head, suffix = nil
     if safe < SafeMode::SECURE
       qualifier = %(-#{location}) unless location == :head
-      suffix = @outfilesuffix unless suffix
+      suffix ||= @outfilesuffix
 
       if (docinfo = @attributes['docinfo']).nil_or_empty?
         if @attributes.key? 'docinfo2'
@@ -1085,7 +1083,7 @@ class Document < AbstractBlock
   end
 
   def to_s
-    %(#<#{self.class}@#{object_id} {doctype: #{doctype.inspect}, doctitle: #{(@header != nil ? @header.title : nil).inspect}, blocks: #{@blocks.size}}>)
+    %(#<#{self.class}@#{object_id} {doctype: #{doctype.inspect}, doctitle: #{(@header && @header.title).inspect}, blocks: #{@blocks.size}}>)
   end
 
   private
@@ -1214,8 +1212,8 @@ class Document < AbstractBlock
       end
     end
 
-    if (@compat_mode = attrs.key? 'compat-mode')
-      attrs['source-language'] = attrs['language'] if attrs.key? 'language'
+    if (@compat_mode = attrs.key? 'compat-mode') && (attrs.key? 'language')
+      attrs['source-language'] = attrs['language']
     end
 
     unless @parent_document
@@ -1388,7 +1386,7 @@ class Document < AbstractBlock
         attrs[%(basebackend-#{current_basebackend}-doctype-#{new_doctype})] = '' if current_basebackend
       end
       attrs[%(doctype-#{new_doctype})] = ''
-      return @doctype = attrs['doctype'] = new_doctype
+      @doctype = attrs['doctype'] = new_doctype
     end
   end
 end

data/lib/asciidoctor/extensions.rb

@@ -134,14 +134,14 @@ module Extensions
         if opts.fetch :numbered, (style == 'appendix')
           sect.numbered = true
         elsif !(opts.key? :numbered) && (doc.attr? 'sectnums', 'all')
-          sect.numbered = book && level == 1 ? :chapter : true
+          sect.numbered = (book && level == 1 ? :chapter : true)
         end
       elsif level > 0
         if opts.fetch :numbered, (doc.attr? 'sectnums')
           sect.numbered = sect.special ? parent.numbered && true : true
         end
-      else
-        sect.numbered = true if opts.fetch :numbered, (book && (doc.attr? 'partnums'))
+      elsif opts.fetch :numbered, (book && (doc.attr? 'partnums'))
+        sect.numbered = true
       end
       if (id = attrs['id']) == false
         attrs.delete 'id'
@@ -229,7 +229,7 @@ module Extensions
     def parse_attributes block, attrlist, opts = {}
       return {} if attrlist ? attrlist.empty? : true
       attrlist = block.sub_attributes attrlist if opts[:sub_attributes] && (attrlist.include? ATTR_REF_HEAD)
-      (AttributeList.new attrlist).parse (opts[:positional_attributes] || [])
+      (AttributeList.new attrlist).parse opts[:positional_attributes] || []
     end
 
     # TODO fill out remaining methods
@@ -511,6 +511,10 @@ module Extensions
   # registered to handle this name and, if found, invokes its {Processor#process}
   # method to build a corresponding node in the document tree.
   #
+  # If the process method returns an instance of Block, the content model of that
+  # Block is :compound, and the Block contains at least one line, the parser will
+  # parse those lines into blocks an assigned them to the returned block.
+  #
   # AsciiDoc example:
   #
   #   [shout]
@@ -594,6 +598,10 @@ module Extensions
   # Public: BlockMacroProcessors are used to handle block macros that have a
   # custom name.
   #
+  # If the process method returns an instance of Block, the content model of that
+  # Block is :compound, and the Block contains at least one line, the parser will
+  # parse those lines into blocks an assigned them to the returned block.
+  #
   # BlockMacroProcessor implementations must extend BlockMacroProcessor.
   class BlockMacroProcessor < MacroProcessor
     def name
@@ -666,7 +674,7 @@ module Extensions
 
   # Public: A specialization of the Extension proxy that additionally stores a
   # reference to the {Processor#process} method. By storing this reference, its
-  # possible to accomodate both concrete extension implementations and Procs.
+  # possible to accommodate both concrete extension implementations and Procs.
   class ProcessorExtension < Extension
     attr_reader :process_method
 
@@ -954,7 +962,7 @@ module Extensions
     end
 
     # Public: Registers an {DocinfoProcessor} with the extension registry to
-    # add additionnal docinfo to the document.
+    # add additional docinfo to the document.
     #
     # The DocinfoProcessor may be one of four types:
     #
@@ -1199,7 +1207,7 @@ module Extensions
     # name - the String or Symbol (coersed to a Symbol) macro name
     #
     # Returns the [Extension] object stored in the registry that proxies the
-    # cooresponding BlockMacroProcessor or nil if a match is not found.
+    # corresponding BlockMacroProcessor or nil if a match is not found.
     def find_block_macro_extension name
       @block_macro_extensions[name.to_sym]
     end
@@ -1286,7 +1294,7 @@ module Extensions
     # name - the String or Symbol (coersed to a Symbol) macro name
     #
     # Returns the [Extension] object stored in the registry that proxies the
-    # cooresponding InlineMacroProcessor or nil if a match is not found.
+    # corresponding InlineMacroProcessor or nil if a match is not found.
     def find_inline_macro_extension name
       @inline_macro_extensions[name.to_sym]
     end
@@ -1328,7 +1336,7 @@ module Extensions
       kind_java_class = (defined? ::AsciidoctorJ) ? (::AsciidoctorJ::Extensions.const_get kind_class_symbol, false) : nil
       kind_store = instance_variable_get(%(@#{kind}_extensions).to_sym) || instance_variable_set(%(@#{kind}_extensions).to_sym, [])
       # style 1: specified as block
-      extension = if block_given?
+      if block_given?
         config = resolve_args args, 1
         (processor = kind_class.new config).singleton_class.enable_dsl
         if block.arity == 0
@@ -1340,7 +1348,7 @@ module Extensions
           raise ::ArgumentError, %(No block specified to process #{kind_name} extension at #{block.source_location})
         end
         processor.freeze
-        ProcessorExtension.new kind, processor
+        extension = ProcessorExtension.new kind, processor
       else
         processor, config = resolve_args args, 2
         # style 2: specified as Class or String class name
@@ -1350,12 +1358,12 @@ module Extensions
           end
           processor_instance = processor_class.new config
           processor_instance.freeze
-          ProcessorExtension.new kind, processor_instance
+          extension = ProcessorExtension.new kind, processor_instance
         # style 3: specified as instance
         elsif kind_class === processor || (kind_java_class && kind_java_class === processor)
           processor.update_config config
           processor.freeze
-          ProcessorExtension.new kind, processor
+          extension = ProcessorExtension.new kind, processor
         else
           raise ::ArgumentError, %(Invalid arguments specified for registering #{kind_name} extension: #{args})
         end

data/lib/asciidoctor/list.rb

@@ -80,12 +80,8 @@ class ListItem < AbstractBlock
     @text && (apply_subs @text, @subs)
   end
 
-  # Public: Set the String text.
-  #
-  # Returns the new String text assigned to this ListItem
-  def text= val
-    @text = val
-  end
+  # Public: Set the String text assigned to this ListItem
+  attr_writer :text
 
   # Check whether this list item has simple content (no nested blocks aside from a single outline list).
   # Primarily relevant for outline lists.

data/lib/asciidoctor/load.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Asciidoctor
   class << self
     # Public: Parse the AsciiDoc source input into a {Document}
@@ -53,7 +54,7 @@ module Asciidoctor
       end
 
       if ::File === input
-        # File#mtime on JRuby for Windows doesn't honor TZ environment variable; see https://github.com/jruby/jruby/issues/6659
+        # File#mtime on JRuby 9.1 for Windows doesn't honor TZ environment variable; see https://github.com/jruby/jruby/issues/6659
         options[:input_mtime] = RUBY_ENGINE == 'jruby' ? (::Time.at input.mtime.to_i) : 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
@@ -84,23 +85,23 @@ module Asciidoctor
 
       timings.record :parse if timings
       doc
-    rescue => ex
+    rescue => e
       begin
         context = %(asciidoctor: FAILED: #{attrs['docfile'] || '<stdin>'}: Failed to load AsciiDoc document)
-        if ex.respond_to? :exception
+        if e.respond_to? :exception
           # The original message must be explicitly preserved when wrapping a Ruby exception
-          wrapped_ex = ex.exception %(#{context} - #{ex.message})
+          wrapped_e = e.exception %(#{context} - #{e.message})
           # JRuby automatically sets backtrace; MRI did not until 2.6
-          wrapped_ex.set_backtrace ex.backtrace
+          wrapped_e.set_backtrace e.backtrace
         else
           # Likely a Java exception class
-          wrapped_ex = ex.class.new context, ex
-          wrapped_ex.stack_trace = ex.stack_trace
+          wrapped_e = e.class.new context, e
+          wrapped_e.stack_trace = e.stack_trace
         end
       rescue
-        wrapped_ex = ex
+        wrapped_e = e
       end
-      raise wrapped_ex
+      raise wrapped_e
     end
 
     # Public: Parse the contents of the AsciiDoc source file into an Asciidoctor::Document

data/lib/asciidoctor/logging.rb

@@ -20,10 +20,10 @@ class Logger < ::Logger
   end
 
   class BasicFormatter < Formatter
-    SEVERITY_LABELS = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
+    SEVERITY_LABEL_SUBSTITUTES = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
 
     def call severity, _, progname, msg
-      %(#{progname}: #{SEVERITY_LABELS[severity] || severity}: #{::String === msg ? msg : msg.inspect}#{LF})
+      %(#{progname}: #{SEVERITY_LABEL_SUBSTITUTES[severity] || severity}: #{::String === msg ? msg : msg.inspect}#{LF})
     end
   end
 
@@ -35,7 +35,7 @@ class Logger < ::Logger
 end
 
 class MemoryLogger < ::Logger
-  SEVERITY_LABELS = {}.tap {|accum| (Severity.constants false).each {|c| accum[Severity.const_get c, false] = c } }
+  SEVERITY_SYMBOL_BY_VALUE = (Severity.constants false).map {|c| [(Severity.const_get c), c] }.to_h
 
   attr_reader :messages
 
@@ -45,8 +45,8 @@ class MemoryLogger < ::Logger
   end
 
   def add severity, message = nil, progname = nil
-    message = block_given? ? yield : progname unless message
-    @messages << { severity: SEVERITY_LABELS[severity || UNKNOWN], message: message }
+    message ||= block_given? ? yield : progname
+    @messages << { severity: SEVERITY_SYMBOL_BY_VALUE[severity || UNKNOWN], message: message }
     true
   end
 
@@ -59,7 +59,7 @@ class MemoryLogger < ::Logger
   end
 
   def max_severity
-    empty? ? nil : @messages.map {|m| Severity.const_get m[:severity], false }.max
+    empty? ? nil : @messages.map {|m| Severity.const_get m[:severity] }.max
   end
 end
 
@@ -89,6 +89,7 @@ module LoggerManager
       @logger ||= (@logger_class.new pipe)
     end
 
+    # Returns the specified Logger
     def logger= new_logger
       @logger = new_logger || (@logger_class.new $stderr)
     end
@@ -110,9 +111,10 @@ module Logging
   # into - The Class that includes the {Logging} module
   #
   # Returns nothing
-  private_class_method def self.included into
+  def self.included into
     into.extend Logging
-  end || :included
+  end
+  private_class_method :included # use separate declaration for Ruby 2.0.x
 
   def logger
     LoggerManager.logger