asciidoctor 2.0.15 → 2.0.17

data/lib/asciidoctor/substitutors.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Asciidoctor
 # Public: Methods to perform substitutions on lines of AsciiDoc text. This module
-# is intented to be mixed-in to Section and Block to provide operations for performing
+# is intended to be mixed-in to Section and Block to provide operations for performing
 # the necessary substitutions.
 module Substitutors
   SpecialCharsRx = /[<&>]/
@@ -330,13 +330,13 @@ module Substitutors
             # NOTE for convenience, map content (unparsed attrlist) to target when format is short
             target ||= ext_config[:format] == :short ? content : target
           end
-          if (Inline === (replacement = extension.process_method[self, target, attributes]))
+          if Inline === (replacement = extension.process_method[self, target, attributes])
             if (inline_subs = replacement.attributes.delete 'subs') && (inline_subs = expand_subs inline_subs, 'custom inline macro')
               replacement.text = apply_subs replacement.text, inline_subs
             end
             replacement.convert
           elsif replacement
-            logger.info %(expected substitution value for custom inline macro to be of type Inline; got #{replacement.class}: #{match})
+            logger.info { %(expected substitution value for custom inline macro to be of type Inline; got #{replacement.class}: #{match}) }
             replacement
           else
             ''
@@ -445,23 +445,16 @@ module Substitutors
           # indexterm:[Tigers,Big cats]
           if (attrlist = normalize_text $2, true, true).include? '='
             if (primary = (attrs = (AttributeList.new attrlist, self).parse)[1])
-              attrs['terms'] = terms = [primary]
-              if (secondary = attrs[2])
-                terms << secondary
-                if (tertiary = attrs[3])
-                  terms << tertiary
-                end
-              end
+              attrs['terms'] = [primary]
               if (see_also = attrs['see-also'])
                 attrs['see-also'] = (see_also.include? ',') ? (see_also.split ',').map {|it| it.lstrip } : [see_also]
               end
             else
-              attrs = { 'terms' => (terms = attrlist) }
+              attrs = { 'terms' => attrlist }
             end
           else
-            attrs = { 'terms' => (terms = split_simple_csv attrlist) }
+            attrs = { 'terms' => (split_simple_csv attrlist) }
           end
-          #doc.register :indexterms, terms
           (Inline.new self, :indexterm, nil, attributes: attrs).convert
         when 'indexterm2'
           # honor the escape
@@ -474,34 +467,33 @@ module Substitutors
               attrs['see-also'] = (see_also.include? ',') ? (see_also.split ',').map {|it| it.lstrip } : [see_also]
             end
           end
-          #doc.register :indexterms, [term]
           (Inline.new self, :indexterm, term, attributes: attrs, type: :visible).convert
         else
-          text = $3
+          encl_text = $3
           # honor the escape
           if $&.start_with? RS
             # escape concealed index term, but process nested flow index term
-            if (text.start_with? '(') && (text.end_with? ')')
-              text = text.slice 1, text.length - 2
+            if (encl_text.start_with? '(') && (encl_text.end_with? ')')
+              encl_text = encl_text.slice 1, encl_text.length - 2
               visible, before, after = true, '(', ')'
             else
               next $&.slice 1, $&.length
             end
           else
             visible = true
-            if text.start_with? '('
-              if text.end_with? ')'
-                text, visible = (text.slice 1, text.length - 2), false
+            if encl_text.start_with? '('
+              if encl_text.end_with? ')'
+                encl_text, visible = (encl_text.slice 1, encl_text.length - 2), false
               else
-                text, before, after = (text.slice 1, text.length), '(', ''
+                encl_text, before, after = (encl_text.slice 1, encl_text.length), '(', ''
               end
-            elsif text.end_with? ')'
-              text, before, after = text.chop, '', ')'
+            elsif encl_text.end_with? ')'
+              encl_text, before, after = encl_text.chop, '', ')'
             end
           end
           if visible
             # ((Tigers))
-            if (term = normalize_text text, true).include? ';&'
+            if (term = normalize_text encl_text, true).include? ';&'
               if term.include? ' &gt;&gt; '
                 term, _, see = term.partition ' &gt;&gt; '
                 attrs = { 'see' => see }
@@ -510,12 +502,11 @@ module Substitutors
                 attrs = { 'see-also' => see_also }
               end
             end
-            #doc.register :indexterms, [term]
             subbed_term = (Inline.new self, :indexterm, term, attributes: attrs, type: :visible).convert
           else
             # (((Tigers,Big cats)))
             attrs = {}
-            if (terms = normalize_text text, true).include? ';&'
+            if (terms = normalize_text encl_text, true).include? ';&'
               if terms.include? ' &gt;&gt; '
                 terms, _, see = terms.partition ' &gt;&gt; '
                 attrs['see'] = see
@@ -524,8 +515,7 @@ module Substitutors
                 attrs['see-also'] = see_also
               end
             end
-            attrs['terms'] = terms = split_simple_csv terms
-            #doc.register :indexterms, terms
+            attrs['terms'] = split_simple_csv terms
             subbed_term = (Inline.new self, :indexterm, nil, attributes: attrs).convert
           end
           before ? %(#{before}#{subbed_term}#{after}) : subbed_term
@@ -545,7 +535,7 @@ module Substitutors
         # NOTE if $4 is set, we're looking at a formal macro (e.g., https://example.org[])
         if $4
           prefix = '' if prefix == 'link:'
-          text = $4
+          link_text = nil if (link_text = $4).empty?
         else
           # invalid macro syntax (link: prefix w/o trailing square brackets or enclosed in double quotes)
           # FIXME we probably shouldn't even get here when the link: prefix is present; the regex is doing too much
@@ -553,7 +543,6 @@ module Substitutors
           when 'link:', ?", ?'
             next $&
           end
-          text = ''
           case $3
           when ')', '?', '!'
             target = target.chop
@@ -593,27 +582,37 @@ module Substitutors
         end
 
         attrs, link_opts = nil, { type: :link }
-        unless text.empty?
-          text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
-          if !doc.compat_mode && (text.include? '=')
-            # NOTE if an equals sign (=) is present, extract attributes from text
-            text, attrs = extract_attributes_from_text text, ''
+
+        if link_text
+          new_link_text = link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
+          if !doc.compat_mode && (link_text.include? '=')
+            # NOTE if an equals sign (=) is present, extract attributes from link text
+            link_text, attrs = extract_attributes_from_text link_text, ''
+            new_link_text = link_text
             link_opts[:id] = attrs['id']
           end
 
-          if text.end_with? '^'
-            text = text.chop
+          if link_text.end_with? '^'
+            new_link_text = link_text = link_text.chop
             if attrs
               attrs['window'] ||= '_blank'
             else
               attrs = { 'window' => '_blank' }
             end
           end
-        end
 
-        if text.empty?
+          if new_link_text && new_link_text.empty?
+            # NOTE it's not possible for the URI scheme to be bare in this case
+            link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
+            bare = true
+          end
+        else
           # NOTE it's not possible for the URI scheme to be bare in this case
-          text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
+          link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
+          bare = true
+        end
+
+        if bare
           if attrs
             attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
           else
@@ -623,7 +622,7 @@ module Substitutors
 
         doc.register :links, (link_opts[:target] = target)
         link_opts[:attributes] = attrs if attrs
-        %(#{prefix}#{(Inline.new self, :anchor, text, link_opts).convert}#{suffix})
+        %(#{prefix}#{(Inline.new self, :anchor, link_text, link_opts).convert}#{suffix})
       end
     end
 
@@ -639,12 +638,12 @@ module Substitutors
           target = $2
         end
         attrs, link_opts = nil, { type: :link }
-        unless (text = $3).empty?
-          text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
+        unless (link_text = $3).empty?
+          link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
           if mailto
-            if !doc.compat_mode && (text.include? ',')
-              # NOTE if a comma (,) is present, extract attributes from text
-              text, attrs = extract_attributes_from_text text, ''
+            if !doc.compat_mode && (link_text.include? ',')
+              # NOTE if a comma (,) is present, extract attributes from link text
+              link_text, attrs = extract_attributes_from_text link_text, ''
               link_opts[:id] = attrs['id']
               if attrs.key? 2
                 if attrs.key? 3
@@ -654,14 +653,14 @@ module Substitutors
                 end
               end
             end
-          elsif !doc.compat_mode && (text.include? '=')
-            # NOTE if an equals sign (=) is present, extract attributes from text
-            text, attrs = extract_attributes_from_text text, ''
+          elsif !doc.compat_mode && (link_text.include? '=')
+            # NOTE if an equals sign (=) is present, extract attributes from link text
+            link_text, attrs = extract_attributes_from_text link_text, ''
             link_opts[:id] = attrs['id']
           end
 
-          if text.end_with? '^'
-            text = text.chop
+          if link_text.end_with? '^'
+            link_text = link_text.chop
             if attrs
               attrs['window'] ||= '_blank'
             else
@@ -670,17 +669,17 @@ module Substitutors
           end
         end
 
-        if text.empty?
+        if link_text.empty?
           # mailto is a special case, already processed
           if mailto
-            text = mailto_text
+            link_text = mailto_text
           else
             if doc_attrs.key? 'hide-uri-scheme'
-              if (text = target.sub UriSniffRx, '').empty?
-                text = target
+              if (link_text = target.sub UriSniffRx, '').empty?
+                link_text = target
               end
             else
-              text = target
+              link_text = target
             end
             if attrs
               attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
@@ -693,7 +692,7 @@ module Substitutors
         # QUESTION should a mailto be registered as an e-mail address?
         doc.register :links, (link_opts[:target] = target)
         link_opts[:attributes] = attrs if attrs
-        Inline.new(self, :anchor, text, link_opts).convert
+        Inline.new(self, :anchor, link_text, link_opts).convert
       end
     end
 
@@ -740,15 +739,17 @@ module Substitutors
 
         attrs = {}
         if (refid = $1)
-          refid, text = refid.split ',', 2
-          text = text.lstrip if text
+          if refid.include? ','
+            refid, _, link_text = refid.partition ','
+            link_text = nil if (link_text = link_text.lstrip).empty?
+          end
         else
           macro = true
           refid = $2
-          if (text = $3)
-            text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
-            # NOTE if an equals sign (=) is present, extract attributes from text
-            text, attrs = extract_attributes_from_text text if !doc.compat_mode && (text.include? '=')
+          if (link_text = $3)
+            link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
+            # NOTE if an equals sign (=) is present, extract attributes from link text
+            link_text, attrs = extract_attributes_from_text link_text if !doc.compat_mode && (link_text.include? '=')
           end
         end
 
@@ -827,7 +828,7 @@ module Substitutors
         attrs['path'] = path
         attrs['fragment'] = fragment
         attrs['refid'] = refid
-        Inline.new(self, :anchor, text, type: :xref, target: target, attributes: attrs).convert
+        Inline.new(self, :anchor, link_text, type: :xref, target: target, attributes: attrs).convert
       end
     end
 
@@ -839,7 +840,7 @@ module Substitutors
         # footnoteref
         if $1
           if $3
-            id, text = $3.split ',', 2
+            id, content = $3.split ',', 2
             logger.warn %(found deprecated footnoteref macro: #{$&}; use footnote macro with target instead) unless doc.compat_mode
           else
             next $&
@@ -847,31 +848,31 @@ module Substitutors
         # footnote
         else
           id = $2
-          text = $3
+          content = $3
         end
 
         if id
           if (footnote = doc.footnotes.find {|candidate| candidate.id == id })
-            index, text = footnote.index, footnote.text
+            index, content = footnote.index, footnote.text
             type, target, id = :xref, id, nil
-          elsif text
-            text = restore_passthroughs(normalize_text text, true, true)
+          elsif content
+            content = restore_passthroughs(normalize_text content, true, true)
             index = doc.counter('footnote-number')
-            doc.register(:footnotes, Document::Footnote.new(index, id, text))
+            doc.register(:footnotes, Document::Footnote.new(index, id, content))
             type, target = :ref, nil
           else
             logger.warn %(invalid footnote reference: #{id})
-            type, target, text, id = :xref, id, id, nil
+            type, target, content, id = :xref, id, id, nil
           end
-        elsif text
-          text = restore_passthroughs(normalize_text text, true, true)
+        elsif content
+          content = restore_passthroughs(normalize_text content, true, true)
           index = doc.counter('footnote-number')
-          doc.register(:footnotes, Document::Footnote.new(index, id, text))
+          doc.register(:footnotes, Document::Footnote.new(index, id, content))
           type = target = nil
         else
           next $&
         end
-        Inline.new(self, :footnote, text, attributes: { 'index' => index }, id: id, target: target, type: type).convert
+        Inline.new(self, :footnote, content, attributes: { 'index' => index }, id: id, target: target, type: type).convert
       end
     end
 
@@ -939,7 +940,7 @@ module Substitutors
   # process_callouts - a Boolean flag indicating whether callout marks should be located and substituted
   #
   # Returns the highlighted source code, if a syntax highlighter is defined on the document, otherwise the source with
-  # verbatim substituions applied
+  # verbatim substitutions applied
   def highlight_source source, process_callouts
     # NOTE the call to highlight? is a defensive check since, normally, we wouldn't arrive here unless it returns true
     return sub_source source, process_callouts unless (syntax_hl = @document.syntax_highlighter) && syntax_hl.highlight?
@@ -948,8 +949,9 @@ module Substitutors
 
     doc_attrs = @document.attributes
     syntax_hl_name = syntax_hl.name
-    if (linenums_mode = (attr? 'linenums') ? (doc_attrs[%(#{syntax_hl_name}-linenums-mode)] || :table).to_sym : nil)
-      start_line_number = 1 if (start_line_number = (attr 'start', 1).to_i) < 1
+    if (linenums_mode = (attr? 'linenums') ? (doc_attrs[%(#{syntax_hl_name}-linenums-mode)] || :table).to_sym : nil) &&
+        (start_line_number = (attr 'start', 1).to_i) < 1
+      start_line_number = 1
     end
     highlight_lines = resolve_lines_to_highlight source, (attr 'highlight'), start_line_number if attr? 'highlight'
 
@@ -986,7 +988,7 @@ module Substitutors
         negate = true
       end
       if (delim = (entry.include? '..') ? '..' : ((entry.include? '-') ? '-' : nil))
-        from, delim, to = entry.partition delim
+        from, _, to = entry.partition delim
         to = (source.count LF) + 1 if to.empty? || (to = to.to_i) < 0
         if negate
           lines -= (from.to_i..to).to_a
@@ -1008,7 +1010,7 @@ module Substitutors
 
   # Public: Extract the passthrough text from the document for reinsertion after processing.
   #
-  # text - The String from which to extract passthrough fragements
+  # text - The String from which to extract passthrough fragments
   #
   # Returns the String text with passthrough regions substituted with placeholders
   def extract_passthroughs text
@@ -1215,7 +1217,7 @@ module Substitutors
       end
     end
     return unless candidates
-    # weed out invalid options and remove duplicates (order is preserved; first occurence wins)
+    # weed out invalid options and remove duplicates (order is preserved; first occurrence wins)
     resolved = candidates & SUB_OPTIONS[type]
     unless (candidates - resolved).empty?
       invalid = candidates - resolved
@@ -1241,9 +1243,10 @@ module Substitutors
   #
   # Returns a Symbol Array of substitutions to pass to apply_subs or nil if no substitutions were resolved.
   def expand_subs subs, subject = nil
-    if ::Symbol === subs
+    case subs
+    when ::Symbol
       subs == :none ? nil : SUB_GROUPS[subs] || [subs]
-    elsif ::Array === subs
+    when ::Array
       expanded_subs = []
       subs.each do |key|
         unless key == :none
@@ -1481,26 +1484,21 @@ module Substitutors
     if (str = str.strip).empty?
       {}
     elsif (str.start_with? '.', '#') && Compliance.shorthand_property_syntax
-      segments = str.split '#', 2
-
-      if segments.size > 1
-        id, *more_roles = segments[1].split('.')
+      before, _, after = str.partition '#'
+      attrs = {}
+      if after.empty?
+        attrs['role'] = (before.tr '.', ' ').lstrip if before.length > 1
       else
-        more_roles = []
-      end
-
-      roles = segments[0].empty? ? [] : segments[0].split('.')
-      if roles.size > 1
-        roles.shift
-      end
-
-      if more_roles.size > 0
-        roles.concat more_roles
+        id, _, roles = after.partition '.'
+        attrs['id'] = id unless id.empty?
+        if roles.empty?
+          attrs['role'] = (before.tr '.', ' ').lstrip if before.length > 1
+        elsif before.length > 1
+          attrs['role'] = ((before + '.' + roles).tr '.', ' ').lstrip
+        else
+          attrs['role'] = roles.tr '.', ' '
+        end
       end
-
-      attrs = {}
-      attrs['id'] = id if id
-      attrs['role'] = roles.join ' ' unless roles.empty?
       attrs
     else
       { 'role' => str }
@@ -1534,7 +1532,7 @@ module Substitutors
         case c
         when ','
           if quote_open
-            accum = accum + c
+            accum += c
           else
             values << accum.strip
             accum = ''
@@ -1542,7 +1540,7 @@ module Substitutors
         when '"'
           quote_open = !quote_open
         else
-          accum = accum + c
+          accum += c
         end
       end
       values << accum.strip

data/lib/asciidoctor/syntax_highlighter/coderay.rb

@@ -78,7 +78,8 @@ class SyntaxHighlighter::CodeRayAdapter < SyntaxHighlighter::Base
   end
 
   extend Styles # exports static methods
-  include Loader, Styles # adds methods to instance
+  include Styles # adds methods to instance
+  include Loader # adds methods to instance
 
   CodeCellStartTagCs = '<td class="code"><pre>'
 

data/lib/asciidoctor/syntax_highlighter/highlightjs.rb

@@ -9,7 +9,7 @@ class SyntaxHighlighter::HighlightJsAdapter < SyntaxHighlighter::Base
   end
 
   def format node, lang, opts
-    super node, lang, (opts.merge transform: proc {|_, code| code['class'] = %(language-#{lang || 'none'} hljs) } )
+    super node, lang, (opts.merge transform: proc {|_, code| code['class'] = %(language-#{lang || 'none'} hljs) })
   end
 
   def docinfo? location

data/lib/asciidoctor/syntax_highlighter/pygments.rb

@@ -36,7 +36,13 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
         node.sub_source source, false # handles nil response from ::Pygments::Lexer#highlight
       end
     elsif (highlighted = lexer.highlight source, options: highlight_opts)
-      highlighted = highlighted.gsub StyledLinenoSpanTagRx, LinenoSpanTagCs if linenos && noclasses
+      if linenos
+        if noclasses
+          highlighted = highlighted.gsub StyledLinenoSpanTagRx, LinenoSpanTagCs
+        elsif highlighted.include? LegacyLinenoSpanStartTagCs
+          highlighted = highlighted.gsub LegacyLinenoSpanTagRx, LinenoSpanTagCs
+        end
+      end
       highlighted.sub WrapperTagRx, '\1'
     else
       node.sub_source source, false # handles nil response from ::Pygments::Lexer#highlight
@@ -114,6 +120,7 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
     end
     @@stylesheet_cache = ::Hash.new do |cache, key|
       if (stylesheet = ::Pygments.css BASE_SELECTOR, classprefix: TOKEN_CLASS_PREFIX, style: key)
+        stylesheet = stylesheet.slice (stylesheet.index BASE_SELECTOR), stylesheet.length unless stylesheet.start_with? BASE_SELECTOR
         @@stylesheet_cache = cache.merge key => stylesheet
         stylesheet
       end
@@ -122,18 +129,20 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
     DEFAULT_STYLE = 'default'
     BASE_SELECTOR = 'pre.pygments'
     TOKEN_CLASS_PREFIX = 'tok-'
-
     BaseStyleRx = /^#{BASE_SELECTOR.gsub '.', '\\.'} +\{([^}]+?)\}/
 
     private_constant :BASE_SELECTOR, :TOKEN_CLASS_PREFIX, :BaseStyleRx
   end
 
   extend Styles # exports static methods
-  include Loader, Styles # adds methods to instance
+  include Styles # adds methods to instance
+  include Loader # adds methods to instance
 
   CodeCellStartTagCs = '<td class="code">'
+  LegacyLinenoSpanStartTagCs = '<span class="lineno">'
+  LegacyLinenoSpanTagRx = %r(#{LegacyLinenoSpanStartTagCs}( *\d+) ?</span>)
   LinenoColumnStartTagsCs = '<td class="linenos"><div class="linenodiv"><pre>'
-  LinenoSpanTagCs = '<span class="lineno">\1 </span>'
+  LinenoSpanTagCs = '<span class="linenos">\1</span>'
   PreTagCs = '<pre>\1</pre>'
   StyledLinenoColumnStartTagsRx = /<td><div class="linenodiv" style="[^"]+?"><pre style="[^"]+?">/
   StyledLinenoSpanTagRx = %r((?<=^|<span></span>)<span style="[^"]+">( *\d+) ?</span>)
@@ -143,6 +152,6 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
   # NOTE initial <span></span> preserves leading blank lines
   WrapperTagRx = %r(<div class="#{WRAPPER_CLASS}"><pre\b[^>]*?>(.*)</pre></div>\n*)m
 
-  private_constant :CodeCellStartTagCs, :LinenoColumnStartTagsCs, :LinenoSpanTagCs, :PreTagCs, :StyledLinenoColumnStartTagsRx, :StyledLinenoSpanTagRx, :WrapperTagRx, :WRAPPER_CLASS
+  private_constant :CodeCellStartTagCs, :LegacyLinenoSpanStartTagCs, :LegacyLinenoSpanTagRx, :LinenoColumnStartTagsCs, :LinenoSpanTagCs, :PreTagCs, :StyledLinenoColumnStartTagsRx, :StyledLinenoSpanTagRx, :WrapperTagRx, :WRAPPER_CLASS
 end
 end

data/lib/asciidoctor/syntax_highlighter/rouge.rb

@@ -133,7 +133,8 @@ class SyntaxHighlighter::RougeAdapter < SyntaxHighlighter::Base
   end
 
   extend Styles # exports static methods
-  include Loader, Styles # adds methods to instance
+  include Styles # adds methods to instance
+  include Loader # adds methods to instance
 
   CodeCellStartTagCs = '<td class="code">'
 

data/lib/asciidoctor/syntax_highlighter.rb

@@ -99,9 +99,10 @@ module SyntaxHighlighter
     raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method since #write_stylesheet? returns true)
   end
 
-  private_class_method def self.included into
+  def self.included into
     into.extend Config
-  end || :included
+  end
+  private_class_method :included # use separate declaration for Ruby 2.0.x
 
   module Config
     # Public: Statically register the current class in the registry for the specified names.
@@ -152,7 +153,7 @@ module SyntaxHighlighter
     end
 
     private
-    
+
     def registry
       raise ::NotImplementedError, %(#{Factory} subclass #{self.class} must implement the ##{__method__} method)
     end
@@ -166,19 +167,17 @@ module SyntaxHighlighter
     end
 
     private
-    
-    def registry
-      @registry
-    end
+
+    attr_reader :registry
   end
 
   module DefaultFactory
     include Factory
 
-    private
-
     @@registry = {}
 
+    private
+
     def registry
       @@registry
     end
@@ -216,8 +215,6 @@ module SyntaxHighlighter
         'rouge' => %(#{__dir__}/syntax_highlighter/rouge),
       }
 
-      private
-
       @@mutex = ::Mutex.new
     end
   end