asciidoctor 2.0.12 → 2.0.16

data/lib/asciidoctor/converter/template.rb

@@ -40,13 +40,13 @@ class Converter::TemplateConverter < Converter::Base
     @caches = { scans: {}, templates: {} }
   end
 
-  def self.caches
-    @caches
-  end
+  class << self
+    attr_reader :caches
 
-  def self.clear_caches
-    @caches[:scans].clear if @caches[:scans]
-    @caches[:templates].clear if @caches[:templates]
+    def clear_caches
+      @caches[:scans].clear
+      @caches[:templates].clear
+    end
   end
 
   def initialize backend, template_dirs, opts = {}
@@ -134,12 +134,10 @@ class Converter::TemplateConverter < Converter::Base
   #
   # Returns the Tilt template object
   def register name, template
-    @templates[name] = if (template_cache = @caches[:templates])
+    if (template_cache = @caches[:templates])
       template_cache[template.file] = template
-    else
-      template
     end
-    #create_handler name, template
+    @templates[name] = template
   end
 
   private
@@ -155,6 +153,7 @@ class Converter::TemplateConverter < Converter::Base
     engine = @engine
     @template_dirs.each do |template_dir|
       # FIXME need to think about safe mode restrictions here
+      # Ruby 2.3 requires the extra brackets around the path_resolver.system_path method call
       next unless ::File.directory?(template_dir = (path_resolver.system_path template_dir))
 
       if engine
@@ -186,8 +185,8 @@ class Converter::TemplateConverter < Converter::Base
       else
         @templates.update scan_dir(template_dir, pattern, @caches[:templates])
       end
-      nil
     end
+    nil
   end
 
   # Internal: Scan the specified directory for template files matching pattern and instantiate
@@ -262,7 +261,7 @@ class Converter::TemplateConverter < Converter::Base
       [::Tilt::ErubiTemplate, {}]
     elsif name == 'erubis'
       Helpers.require_library 'erubis' unless defined? ::Erubis::FastEruby
-      [::Tilt::ErubisTemplate, { engine_class: ::Erubis::FastEruby }]
+      [::Tilt::ErubisTemplate, engine_class: ::Erubis::FastEruby]
     else
       raise ::ArgumentError, %(Unknown ERB implementation: #{name})
     end

data/lib/asciidoctor/document.rb

@@ -259,12 +259,14 @@ class Document < AbstractBlock
       options[:catalog_assets] = true if parent_doc.options[:catalog_assets]
       @catalog = parent_doc.catalog.merge footnotes: []
       # QUESTION should we support setting attribute in parent document from nested document?
-      # NOTE we must dup or else all the assignments to the overrides clobbers the real attributes
-      @attribute_overrides = attr_overrides = parent_doc.attributes.merge
-      parent_doctype = attr_overrides.delete 'doctype'
+      @attribute_overrides = attr_overrides = (parent_doc.instance_variable_get :@attribute_overrides).merge parent_doc.attributes
       attr_overrides.delete 'compat-mode'
+      parent_doctype = attr_overrides.delete 'doctype'
+      attr_overrides.delete 'notitle'
+      attr_overrides.delete 'showtitle'
+      # QUESTION if toc is hard unset in parent document, should it be hard unset in nested document?
       attr_overrides.delete 'toc'
-      attr_overrides.delete 'toc-placement'
+      @attributes['toc-placement'] = (attr_overrides.delete 'toc-placement') || 'auto'
       attr_overrides.delete 'toc-position'
       @safe = parent_doc.safe
       @attributes['compat-mode'] = '' if (@compat_mode = parent_doc.compat_mode)
@@ -284,7 +286,6 @@ class Document < AbstractBlock
         footnotes: [],
         links: [],
         images: [],
-        #indexterms: [],
         callouts: Callouts.new,
         includes: {},
       }
@@ -309,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
@@ -339,11 +340,13 @@ class Document < AbstractBlock
     (@options = options).freeze
 
     attrs = @attributes
-    attrs['attribute-undefined'] = Compliance.attribute_undefined
-    attrs['attribute-missing'] = Compliance.attribute_missing
-    attrs.update DEFAULT_ATTRIBUTES
-    # TODO if lang attribute is set, @safe mode < SafeMode::SERVER, and !parent_doc,
-    # load attributes from data/locale/attributes-<lang>.adoc
+    unless parent_doc
+      attrs['attribute-undefined'] = Compliance.attribute_undefined
+      attrs['attribute-missing'] = Compliance.attribute_missing
+      attrs.update DEFAULT_ATTRIBUTES
+      # TODO if lang attribute is set, @safe mode < SafeMode::SERVER, and !parent_doc,
+      # load attributes from data/locale/attributes-<lang>.adoc
+    end
 
     if standalone
       # sync embedded attribute with :standalone option value
@@ -356,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
@@ -371,14 +374,12 @@ class Document < AbstractBlock
     attr_overrides[%(safe-mode-#{safe_mode_name})] = ''
     attr_overrides['safe-mode-level'] = @safe
 
-    # the only way to set the max-include-depth attribute is via the API; default to 64 like AsciiDoc Python
+    # the only way to set the max-include-depth attribute is via the API; default to 64 like AsciiDoc.py
     attr_overrides['max-include-depth'] ||= 64
 
     # the only way to set the allow-uri-read attribute is via the API; disabled by default
     attr_overrides['allow-uri-read'] ||= nil
 
-    attr_overrides['user-home'] = USER_HOME
-
     # remap legacy attribute names
     attr_overrides['sectnums'] = attr_overrides.delete 'numbered' if attr_overrides.key? 'numbered'
     attr_overrides['hardbreaks-option'] = attr_overrides.delete 'hardbreaks' if attr_overrides.key? 'hardbreaks'
@@ -397,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
@@ -414,7 +415,7 @@ class Document < AbstractBlock
         attr_overrides['docfile'] = attr_overrides['docfile'][(attr_overrides['docdir'].length + 1)..-1]
       end
       attr_overrides['docdir'] = ''
-      attr_overrides['user-home'] = '.'
+      attr_overrides['user-home'] ||= '.'
       if @safe >= SafeMode::SECURE
         attr_overrides['max-attribute-value-size'] = 4096 unless attr_overrides.key? 'max-attribute-value-size'
         # assign linkcss (preventing css embedding) unless explicitly disabled from the commandline or API
@@ -423,6 +424,8 @@ class Document < AbstractBlock
         # restrict document from enabling icons
         attr_overrides['icons'] ||= nil
       end
+    else
+      attr_overrides['user-home'] ||= USER_HOME
     end
 
     # the only way to set the max-attribute-value-size attribute is via the API; disabled by default
@@ -562,13 +565,15 @@ 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 (attr_seed = !(attr_val = @attributes[name]).nil_or_empty?) && (@counters.key? name)
-      @attributes[name] = @counters[name] = Helpers.nextval attr_val
+    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
-      @attributes[name] = @counters[name] = seed == seed.to_i.to_s ? seed.to_i : seed
+      next_val = @counters[name] = seed == seed.to_i.to_s ? seed.to_i : seed
     else
-      @attributes[name] = @counters[name] = Helpers.nextval attr_seed ? attr_val : 0
+      next_val = @counters[name] = 1
     end
+    @attributes[name] = next_val unless locked
+    next_val
   end
 
   # Public: Increment the specified counter and store it in the block's attributes
@@ -610,10 +615,17 @@ 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
@@ -671,7 +683,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'
@@ -980,25 +992,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')
@@ -1020,7 +1013,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'
@@ -1077,7 +1070,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
@@ -1206,8 +1199,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
@@ -1380,7 +1373,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
@@ -1021,8 +1021,6 @@ module Extensions
         else
           @docinfo_processor_extensions
         end
-      else
-        nil
       end
     end
 
@@ -1201,7 +1199,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
@@ -1288,7 +1286,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
@@ -1330,7 +1328,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
@@ -1342,7 +1340,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
@@ -1352,12 +1350,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/helpers.rb

@@ -274,13 +274,10 @@ module Helpers
   def nextval current
     if ::Integer === current
       current + 1
+    elsif (intval = current.to_i).to_s == current.to_s
+      intval + 1
     else
-      intval = current.to_i
-      if intval.to_s != current.to_s
-        (current[0].ord + 1).chr
-      else
-        intval + 1
-      end
+      current.succ
     end
   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}
@@ -20,8 +21,8 @@ module Asciidoctor
         timings.start :read
       end
 
-      if (logger = options[:logger]) && logger != LoggerManager.logger
-        LoggerManager.logger = logger
+      if (options.key? :logger) && (logger = options[:logger]) != LoggerManager.logger
+        LoggerManager.logger = logger || NullLogger.new
       end
 
       if !(attrs = options[:attributes])
@@ -53,7 +54,8 @@ module Asciidoctor
       end
 
       if ::File === input
-        options[:input_mtime] = input.mtime
+        # 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
         attrs['docfile'] = input_path = ::File.absolute_path input.path
@@ -83,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