asciidoctor 2.0.15 → 2.0.16

data/lib/asciidoctor/converter/manpage.rb

@@ -23,7 +23,7 @@ class Converter::ManPageConverter < Converter::Base
   LeadingPeriodRx = /^\./
   EscapedMacroRx = /^(?:#{ESC}\\c\n)?#{ESC}\.((?:URL|MTO) "#{CC_ANY}*?" "#{CC_ANY}*?" )( |[^\s]*)(#{CC_ANY}*?)(?: *#{ESC}\\c)?$/
   MalformedEscapedMacroRx = /(#{ESC}\\c) (#{ESC}\.(?:URL|MTO) )/
-  MockMacroRx = /<\/?(#{ESC}\\[^>]+)>/
+  MockMacroRx = %r(</?(#{ESC}\\[^>]+)>)
   EmDashCharRefRx = /&#8212;(?:&#8203;)?/
   EllipsisCharRefRx = /&#8230;(?:&#8203;)?/
   WrappedIndentRx = /#{CG_BLANK}*#{LF}#{CG_BLANK}*/
@@ -419,15 +419,7 @@ allbox tab(:);'
           end
           row_text[row_index] << %(T{#{LF}.sp#{LF})
           cell_halign = (cell.attr 'halign', 'left').chr
-          if tsec == :head
-            if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
-              row_header[row_index][cell_index] << %(#{cell_halign}tB)
-            else
-              row_header[row_index][cell_index + 1] ||= []
-              row_header[row_index][cell_index + 1] << %(#{cell_halign}tB)
-            end
-            row_text[row_index] << %(#{manify cell.text, whitespace: :normalize}#{LF})
-          elsif tsec == :body
+          if tsec == :body
             if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
               row_header[row_index][cell_index] << %(#{cell_halign}t)
             else
@@ -443,7 +435,7 @@ allbox tab(:);'
               cell_content = manify cell.content.join, whitespace: :normalize
             end
             row_text[row_index] << %(#{cell_content}#{LF})
-          elsif tsec == :foot
+          else # tsec == :head || tsec == :foot
             if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
               row_header[row_index][cell_index] << %(#{cell_halign}tB)
             else
@@ -587,8 +579,16 @@ allbox tab(:);'
       %(#{ESC_BS}c#{LF}#{ESC_FS}#{macro} "#{target}" "#{text}" )
     when :xref
       unless (text = node.text)
-        refid = node.attributes['refid']
-        text = %([#{refid}]) unless AbstractNode === (ref = (@refs ||= node.document.catalog[:refs])[refid]) && (@resolving_xref ||= outer = true) && outer && (text = ref.xreftext node.attr 'xrefstyle', nil, true)
+        if AbstractNode === (ref = (@refs ||= node.document.catalog[:refs])[refid = node.attributes['refid']] || (refid.nil_or_empty? ? (top = get_root_document node) : nil))
+          if (@resolving_xref ||= (outer = true)) && outer && (text = ref.xreftext node.attr 'xrefstyle', nil, true)
+            text = uppercase_pcdata text if ref.context === :section && ref.level < 2 && text == ref.title
+          else
+            text = top ? '[^top]' : %([#{refid}])
+          end
+          @resolving_xref = nil if outer
+        else
+          text = %([#{refid}])
+        end
       end
       text
     when :ref, :bibref
@@ -664,13 +664,12 @@ allbox tab(:);'
   end
 
   def self.write_alternate_pages mannames, manvolnum, target
-    if mannames && mannames.size > 1
-      mannames.shift
-      manvolext = %(.#{manvolnum})
-      dir, basename = ::File.split target
-      mannames.each do |manname|
-        ::File.write ::File.join(dir, %(#{manname}#{manvolext})), %(.so #{basename}), mode: FILE_WRITE_MODE
-      end
+    return unless mannames && mannames.size > 1
+    mannames.shift
+    manvolext = %(.#{manvolnum})
+    dir, basename = ::File.split target
+    mannames.each do |manname|
+      ::File.write ::File.join(dir, %(#{manname}#{manvolext})), %(.so #{basename}), mode: FILE_WRITE_MODE
     end
   end
 
@@ -679,7 +678,7 @@ allbox tab(:);'
   def append_footnotes result, node
     if node.footnotes? && !(node.attr? 'nofootnotes')
       result << '.SH "NOTES"'
-      node.footnotes.each_with_index do |fn, idx|
+      node.footnotes.each do |fn|
         result << %(.IP [#{fn.index}])
         # NOTE restore newline in escaped macro that gets removed by normalize_text in substitutor
         if (text = fn.text).include? %(#{ESC}\\c #{ESC}.)
@@ -713,37 +712,40 @@ allbox tab(:);'
     else
       str = str.tr_s WHITESPACE, ' '
     end
-    str = str.
-      gsub(LiteralBackslashRx) { $1 ? $& : '\\(rs' }. # literal backslash (not a troff escape sequence)
-      gsub(EllipsisCharRefRx, '...'). # horizontal ellipsis
-      gsub(LeadingPeriodRx, '\\\&.'). # leading . is used in troff for macro call or other formatting; replace with \&.
-      # drop orphaned \c escape lines, unescape troff macro, quote adjacent character, isolate macro line
-      gsub(EscapedMacroRx) { (rest = $3.lstrip).empty? ? %(.#$1"#$2") : %(.#$1"#{$2.rstrip}"#{LF}#{rest}) }.
-      gsub('-', '\-').
-      gsub('&lt;', '<').
-      gsub('&gt;', '>').
-      gsub('&#160;', '\~').     # non-breaking space
-      gsub('&#169;', '\(co').   # copyright sign
-      gsub('&#174;', '\(rg').   # registered sign
-      gsub('&#8482;', '\(tm').  # trademark sign
-      gsub('&#8201;', ' ').     # thin space
-      gsub('&#8211;', '\(en').  # en dash
-      gsub(EmDashCharRefRx, '\(em'). # em dash
-      gsub('&#8216;', '\(oq').  # left single quotation mark
-      gsub('&#8217;', '\(cq').  # right single quotation mark
-      gsub('&#8220;', '\(lq').  # left double quotation mark
-      gsub('&#8221;', '\(rq').  # right double quotation mark
-      gsub('&#8592;', '\(<-').  # leftwards arrow
-      gsub('&#8594;', '\(->').  # rightwards arrow
-      gsub('&#8656;', '\(lA').  # leftwards double arrow
-      gsub('&#8658;', '\(rA').  # rightwards double arrow
-      gsub('&#8203;', '\:').    # zero width space
-      gsub('&amp;', '&').       # literal ampersand (NOTE must take place after any other replacement that includes &)
-      gsub('\'', '\(aq').       # apostrophe-quote
-      gsub(MockMacroRx, '\1').  # mock boundary
-      gsub(ESC_BS, '\\').       # unescape troff backslash (NOTE update if more escapes are added)
-      gsub(ESC_FS, '.').        # unescape full stop in troff commands (NOTE must take place after gsub(LeadingPeriodRx))
-      rstrip                    # strip trailing space
+    str = str
+      .gsub(LiteralBackslashRx) { $1 ? $& : '\\(rs' } # literal backslash (not a troff escape sequence)
+      .gsub(EllipsisCharRefRx, '...') # horizontal ellipsis
+      .gsub(LeadingPeriodRx, '\\\&.') # leading . is used in troff for macro call or other formatting; replace with \&.
+      .gsub(EscapedMacroRx) do # drop orphaned \c escape lines, unescape troff macro, quote adjacent character, isolate macro line
+        (rest = $3.lstrip).empty? ? %(.#{$1}"#{$2}") : %(.#{$1}"#{$2.rstrip}"#{LF}#{rest})
+      end
+      .gsub('-', '\-')
+      .gsub('&lt;', '<')
+      .gsub('&gt;', '>')
+      .gsub('&#43;', '+')       # plus sign; alternately could use \c(pl
+      .gsub('&#160;', '\~')     # non-breaking space
+      .gsub('&#169;', '\(co')   # copyright sign
+      .gsub('&#174;', '\(rg')   # registered sign
+      .gsub('&#8482;', '\(tm')  # trademark sign
+      .gsub('&#176;', '\(de')   # degree sign
+      .gsub('&#8201;', ' ')     # thin space
+      .gsub('&#8211;', '\(en')  # en dash
+      .gsub(EmDashCharRefRx, '\(em') # em dash
+      .gsub('&#8216;', '\(oq')  # left single quotation mark
+      .gsub('&#8217;', '\(cq')  # right single quotation mark
+      .gsub('&#8220;', '\(lq')  # left double quotation mark
+      .gsub('&#8221;', '\(rq')  # right double quotation mark
+      .gsub('&#8592;', '\(<-')  # leftwards arrow
+      .gsub('&#8594;', '\(->')  # rightwards arrow
+      .gsub('&#8656;', '\(lA')  # leftwards double arrow
+      .gsub('&#8658;', '\(rA')  # rightwards double arrow
+      .gsub('&#8203;', '\:')    # zero width space
+      .gsub('&amp;', '&')       # literal ampersand (NOTE must take place after any other replacement that includes &)
+      .gsub('\'', '\*(Aq')      # apostrophe / neutral single quote
+      .gsub(MockMacroRx, '\1')  # mock boundary
+      .gsub(ESC_BS, '\\')       # unescape troff backslash (NOTE update if more escapes are added)
+      .gsub(ESC_FS, '.')        # unescape full stop in troff commands (NOTE must take place after gsub(LeadingPeriodRx))
+      .rstrip                   # strip trailing space
     opts[:append_newline] ? %(#{str}#{LF}) : str
   end
 
@@ -754,5 +756,12 @@ allbox tab(:);'
   def enclose_content node
     node.content_model == :compound ? node.content : %(.sp#{LF}#{manify node.content, whitespace: :normalize})
   end
+
+  def get_root_document node
+    while (node = node.document).nested?
+      node = node.parent_document
+    end
+    node
+  end
 end
 end

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

@@ -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
@@ -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,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
@@ -679,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'
@@ -988,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')
@@ -1028,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'
@@ -1085,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
@@ -1214,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
@@ -1388,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
@@ -1199,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
@@ -1286,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
@@ -1328,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
@@ -1340,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
@@ -1350,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/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.