asciidoctor 2.0.6 → 2.0.11

data/lib/asciidoctor/substitutors.rb

@@ -422,7 +422,10 @@ module Substitutors
         end
         target = $1
         attrs = parse_attributes $2, posattrs, unescape_input: true
-        doc.register :images, [target, (attrs['imagesdir'] = doc_attrs['imagesdir'])] unless type == 'icon'
+        unless type == 'icon'
+          doc.register :images, target
+          attrs['imagesdir'] = doc_attrs['imagesdir']
+        end
         attrs['alt'] ||= (attrs['default-alt'] = Helpers.basename(target, true).tr('_-', ' '))
         Inline.new(self, :image, nil, type: type, target: target, attributes: attrs).convert
       end
@@ -539,14 +542,17 @@ module Substitutors
         end
 
         prefix, suffix = $1, ''
-        # NOTE if $4 is set, then we're looking at a formal macro
+        # 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
         else
-          # invalid macro syntax (link: prefix w/o trailing square brackets)
-          # FIXME we probably shouldn't even get here...our regex is doing too much
-          next $& if prefix == 'link:'
+          # 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
+          case prefix
+          when 'link:', ?", ?'
+            next $&
+          end
           text = ''
           case $3
           when ')'
@@ -588,7 +594,8 @@ module Substitutors
         unless text.empty?
           text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
           if !doc.compat_mode && (text.include? '=')
-            text = (attrs = (AttributeList.new text, self).parse)[1] || ''
+            # NOTE if an equals sign (=) is present, extract attributes from text
+            text, attrs = extract_attributes_from_text text, ''
             link_opts[:id] = attrs['id']
           end
 
@@ -634,7 +641,8 @@ module Substitutors
           text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
           if mailto
             if !doc.compat_mode && (text.include? ',')
-              text = (attrs = (AttributeList.new text, self).parse)[1] || ''
+              # NOTE if a comma (,) is present, extract attributes from text
+              text, attrs = extract_attributes_from_text text, ''
               link_opts[:id] = attrs['id']
               if attrs.key? 2
                 if attrs.key? 3
@@ -645,7 +653,8 @@ module Substitutors
               end
             end
           elsif !doc.compat_mode && (text.include? '=')
-            text = (attrs = (AttributeList.new text, self).parse)[1] || ''
+            # NOTE if an equals sign (=) is present, extract attributes from text
+            text, attrs = extract_attributes_from_text text, ''
             link_opts[:id] = attrs['id']
           end
 
@@ -736,8 +745,8 @@ module Substitutors
           refid = $2
           if (text = $3)
             text = text.gsub ESC_R_SB, R_SB if text.include? R_SB
-            # NOTE if an equal sign (=) is present, parse text as attributes
-            text = ((AttributeList.new text, self).parse_into attrs)[1] 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 !doc.compat_mode && (text.include? '=')
           end
         end
 
@@ -801,13 +810,13 @@ module Substitutors
         # handles: id (in compat mode or when natural xrefs are disabled)
         elsif doc.compat_mode || !Compliance.natural_xrefs
           refid, target = fragment, %(##{fragment})
-          logger.info %(possible invalid reference: #{refid}) if logger.info? && doc.catalog[:refs][refid]
+          logger.info %(possible invalid reference: #{refid}) if logger.info? && !doc.catalog[:refs][refid]
         # handles: id
         elsif doc.catalog[:refs][fragment]
           refid, target = fragment, %(##{fragment})
         # handles: Node Title or Reference Text
         # do reverse lookup on fragment if not a known ID and resembles reftext (contains a space or uppercase char)
-        elsif (refid = doc.resolve_id fragment) && ((fragment.include? ' ') || fragment.downcase != fragment)
+        elsif ((fragment.include? ' ') || fragment.downcase != fragment) && (refid = doc.resolve_id fragment)
           fragment, target = refid, %(##{refid})
         else
           refid, target = fragment, %(##{fragment})
@@ -840,19 +849,17 @@ module Substitutors
         end
 
         if id
-          if text
+          if (footnote = doc.footnotes.find {|candidate| candidate.id == id })
+            index, text = footnote.index, footnote.text
+            type, target, id = :xref, id, nil
+          elsif text
             text = restore_passthroughs(normalize_text text, true, true)
             index = doc.counter('footnote-number')
             doc.register(:footnotes, Document::Footnote.new(index, id, text))
             type, target = :ref, nil
           else
-            if (footnote = doc.footnotes.find {|candidate| candidate.id == id })
-              index, text = footnote.index, footnote.text
-            else
-              logger.warn %(invalid footnote reference: #{id})
-              index, text = nil, id
-            end
-            type, target, id = :xref, id, nil
+            logger.warn %(invalid footnote reference: #{id})
+            index, text = nil, id
           end
         elsif text
           text = restore_passthroughs(normalize_text text, true, true)
@@ -914,7 +921,7 @@ module Substitutors
         # use sub since it might be behind a line comment
         $&.sub RS, ''
       else
-        Inline.new(self, :callout, $4 == '.' ? (autonum += 1).to_s : $4, id: @document.callouts.read_next_id, attributes: { 'guard' => $1 }).convert
+        Inline.new(self, :callout, $4 == '.' ? (autonum += 1).to_s : $4, id: @document.callouts.read_next_id, attributes: { 'guard' => $1 || ($3 == '--' ? ['<!--', '-->'] : nil) }).convert
       end
     end
   end
@@ -942,7 +949,7 @@ module Substitutors
     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
     end
-    highlight_lines = resolve_lines_to_highlight source, (attr 'highlight') if attr? 'highlight'
+    highlight_lines = resolve_lines_to_highlight source, (attr 'highlight'), start_line_number if attr? 'highlight'
 
     highlighted, source_offset = syntax_hl.highlight self, source, (attr 'language'),
       callouts: callout_marks,
@@ -965,9 +972,10 @@ module Substitutors
   #
   # source - The String source.
   # spec   - The lines specifier (e.g., "1-5, !2, 10" or "1..5;!2;10")
+  # start  - The line number of the first line (optional, default: false)
   #
   # Returns an [Array] of unique, sorted line numbers.
-  def resolve_lines_to_highlight source, spec
+  def resolve_lines_to_highlight source, spec, start = nil
     lines = []
     spec = spec.delete ' ' if spec.include? ' '
     ((spec.include? ',') ? (spec.split ',') : (spec.split ';')).map do |entry|
@@ -978,21 +986,22 @@ module Substitutors
       if (delim = (entry.include? '..') ? '..' : ((entry.include? '-') ? '-' : nil))
         from, delim, to = entry.partition delim
         to = (source.count LF) + 1 if to.empty? || (to = to.to_i) < 0
-        line_nums = (from.to_i..to).to_a
         if negate
-          lines -= line_nums
+          lines -= (from.to_i..to).to_a
         else
-          lines.concat line_nums
-        end
-      else
-        if negate
-          lines.delete entry.to_i
-        else
-          lines << entry.to_i
+          lines |= (from.to_i..to).to_a
         end
+      elsif negate
+        lines.delete entry.to_i
+      elsif !lines.include?(line = entry.to_i)
+        lines << line
       end
     end
-    lines.sort.uniq
+    # If the start attribute is defined, then the lines to highlight specified by the provided spec should be relative to the start value.
+    unless (shift = start ? start - 1 : 0) == 0
+      lines = lines.map {|it| it - shift }
+    end
+    lines.sort
   end
 
   # Public: Extract the passthrough text from the document for reinsertion after processing.
@@ -1318,10 +1327,23 @@ module Substitutors
 
   private
 
+  # This method is used in cases when the attrlist can be mixed with the text of a macro.
+  # If no attributes are detected aside from the first positional attribute, and the first positional
+  # attribute matches the attrlist, then the original text is returned.
+  def extract_attributes_from_text text, default_text = nil
+    attrlist = (text.include? LF) ? (text.tr LF, ' ') : text
+    if (resolved_text = (attrs = (AttributeList.new attrlist, self).parse)[1])
+      # NOTE if resolved text remains unchanged, clear attributes and return unparsed text
+      resolved_text == attrlist ? [text, attrs.clear] : [resolved_text, attrs]
+    else
+      [default_text, attrs]
+    end
+  end
+
   # Internal: Extract the callout numbers from the source to prepare it for syntax highlighting.
   def extract_callouts source
     callout_marks = {}
-    lineno = 0
+    autonum = lineno = 0
     last_lineno = nil
     callout_rx = (attr? 'line-comment') ? CalloutExtractRxMap[attr 'line-comment'] : CalloutExtractRx
     # extract callout marks, indexed by line number
@@ -1333,7 +1355,7 @@ module Substitutors
           # use sub since it might be behind a line comment
           $&.sub RS, ''
         else
-          (callout_marks[lineno] ||= []) << [$1, $4]
+          (callout_marks[lineno] ||= []) << [$1 || ($3 == '--' ? ['<!--', '-->'] : nil), $4 == '.' ? (autonum += 1).to_s : $4]
           last_lineno = lineno
           ''
         end
@@ -1355,15 +1377,15 @@ module Substitutors
     else
       preamble = ''
     end
-    autonum = lineno = 0
+    lineno = 0
     preamble + ((source.split LF, -1).map do |line|
       if (conums = callout_marks.delete lineno += 1)
         if conums.size == 1
-          guard, conum = conums[0]
-          %(#{line}#{Inline.new(self, :callout, conum == '.' ? (autonum += 1).to_s : conum, id: @document.callouts.read_next_id, attributes: { 'guard' => guard }).convert})
+          guard, numeral = conums[0]
+          %(#{line}#{Inline.new(self, :callout, numeral, id: @document.callouts.read_next_id, attributes: { 'guard' => guard }).convert})
         else
-          %(#{line}#{conums.map do |guard_it, conum_it|
-            Inline.new(self, :callout, conum_it == '.' ? (autonum += 1).to_s : conum_it, id: @document.callouts.read_next_id, attributes: { 'guard' => guard_it }).convert
+          %(#{line}#{conums.map do |guard_it, numeral_it|
+            Inline.new(self, :callout, numeral_it, id: @document.callouts.read_next_id, attributes: { 'guard' => guard_it }).convert
           end.join ' '})
         end
       else

data/lib/asciidoctor/syntax_highlighter.rb

@@ -20,19 +20,25 @@ module SyntaxHighlighter
   end
 
   # Public: Indicates whether this syntax highlighter has docinfo (i.e., markup) to insert into the output document at
-  # the specified location.
+  # the specified location. Should be called by converter after main content has been converted.
   #
   # location - The Symbol representing the location slot (:head or :footer).
   #
   # Returns a [Boolean] indicating whether the docinfo method should be called for this location.
   def docinfo? location; end
 
-  # Public: Generates docinfo markup to insert in the output document at the specified location.
+  # Public: Generates docinfo markup for this syntax highlighter to insert at the specified location in the output document.
+  # Should be called by converter after main content has been converted.
   #
   # location - The Symbol representing the location slot (:head or :footer).
+  # doc      - The Document in which this syntax highlighter is being used.
+  # opts     - A Hash of options that configure the syntax highlighting:
+  #            :linkcss - A Boolean indicating whether the stylesheet should be linked instead of embedded (optional).
+  #            :cdn_base_url - The String base URL for assets loaded from the CDN.
+  #            :self_closing_tag_slash - The String '/' if the converter calling this method emits self-closing tags.
   #
   # Return the [String] markup to insert.
-  def docinfo location
+  def docinfo location, doc, opts
     raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method since #docinfo? returns true)
   end
 
@@ -100,15 +106,21 @@ module SyntaxHighlighter
   module Config
     # Public: Statically register the current class in the registry for the specified names.
     #
+    # names - one or more String or Symbol names with which to register the current class as a syntax highlighter
+    #         implementation. Symbol arguments are coerced to Strings.
+    #
     # Returns nothing.
     def register_for *names
-      SyntaxHighlighter.register self, *names
+      SyntaxHighlighter.register self, *(names.map {|name| name.to_s })
     end
   end
 
   module Factory
     # Public: Associates the syntax highlighter class or object with the specified names.
     #
+    # syntax_highlighter - the syntax highlighter implementation to register
+    # names              - one or more String names with which to register this syntax highlighter implementation.
+    #
     # Returns nothing.
     def register syntax_highlighter, *names
       names.each {|name| registry[name] = syntax_highlighter }
@@ -128,7 +140,7 @@ module SyntaxHighlighter
     # name    - The String name of the syntax highlighter to create.
     # backend - The String name of the backend for which this syntax highlighter is being used (default: 'html5').
     # opts    - A Hash of options providing information about the context in which this syntax highlighter is used:
-    #           :doc - The Document for which this syntax highlighter was created.
+    #           :document - The Document for which this syntax highlighter was created.
     #
     # Returns a [SyntaxHighlighter] instance for the specified name.
     def create name, backend = 'html5', opts = {}
@@ -224,9 +236,11 @@ module SyntaxHighlighter
     def format node, lang, opts
       class_attr_val = opts[:nowrap] ? %(#{@pre_class} highlight nowrap) : %(#{@pre_class} highlight)
       if (transform = opts[:transform])
-        pre = { 'class' => class_attr_val }
-        code = lang ? { 'data-lang' => lang } : {}
-        transform[pre, code]
+        transform[(pre = { 'class' => class_attr_val }), (code = lang ? { 'data-lang' => lang } : {})]
+        # NOTE: make sure data-lang is the last attribute on the code tag to remain consistent with 1.5.x
+        if (lang = code.delete 'data-lang')
+          code['data-lang'] = lang
+        end
         %(<pre#{pre.map {|k, v| %[ #{k}="#{v}"] }.join}><code#{code.map {|k, v| %[ #{k}="#{v}"] }.join}>#{node.content}</code></pre>)
       else
         %(<pre class="#{class_attr_val}"><code#{lang ? %[ data-lang="#{lang}"] : ''}>#{node.content}</code></pre>)

data/lib/asciidoctor/syntax_highlighter/coderay.rb

@@ -32,7 +32,7 @@ class SyntaxHighlighter::CodeRayAdapter < SyntaxHighlighter::Base
   end
 
   def docinfo? location
-    @requires_stylesheet && location == :footer
+    @requires_stylesheet && location == :head
   end
 
   def docinfo location, doc, opts

data/lib/asciidoctor/syntax_highlighter/highlightjs.rb

@@ -13,14 +13,22 @@ class SyntaxHighlighter::HighlightJsAdapter < SyntaxHighlighter::Base
   end
 
   def docinfo? location
-    location == :footer
+    true
   end
 
   def docinfo location, doc, opts
     base_url = doc.attr 'highlightjsdir', %(#{opts[:cdn_base_url]}/highlight.js/#{HIGHLIGHT_JS_VERSION})
-    %(<link rel="stylesheet" href="#{base_url}/styles/#{doc.attr 'highlightjs-theme', 'github'}.min.css"#{opts[:self_closing_tag_slash]}>
-<script src="#{base_url}/highlight.min.js"></script>
-#{(doc.attr? 'highlightjs-languages') ? ((doc.attr 'highlightjs-languages').split ',').map {|lang| %[<script src="#{base_url}/languages/#{lang.lstrip}.min.js"></script>\n] }.join : ''}<script>hljs.initHighlighting()</script>)
+    if location == :head
+      %(<link rel="stylesheet" href="#{base_url}/styles/#{doc.attr 'highlightjs-theme', 'github'}.min.css"#{opts[:self_closing_tag_slash]}>)
+    else # :footer
+      %(<script src="#{base_url}/highlight.min.js"></script>
+#{(doc.attr? 'highlightjs-languages') ? ((doc.attr 'highlightjs-languages').split ',').map {|lang| %[<script src="#{base_url}/languages/#{lang.lstrip}.min.js"></script>\n] }.join : ''}<script>
+if (!hljs.initHighlighting.called) {
+  hljs.initHighlighting.called = true
+  ;[].slice.call(document.querySelectorAll('pre.highlight > code')).forEach(function (el) { hljs.highlightBlock(el) })
+}
+</script>)
+    end
   end
 end
 end

data/lib/asciidoctor/syntax_highlighter/prettify.rb

@@ -14,14 +14,17 @@ class SyntaxHighlighter::PrettifyAdapter < SyntaxHighlighter::Base
   end
 
   def docinfo? location
-    location == :footer
+    true
   end
 
   def docinfo location, doc, opts
     base_url = doc.attr 'prettifydir', %(#{opts[:cdn_base_url]}/prettify/r298)
-    prettify_theme_url = ((prettify_theme = doc.attr 'prettify-theme', 'prettify').start_with? 'http://', 'https://') ? prettify_theme : %(#{base_url}/#{prettify_theme}.min.css)
-    %(<link rel="stylesheet" href="#{prettify_theme_url}"#{opts[:self_closing_tag_slash]}>
-<script src="#{base_url}/run_prettify.min.js"></script>)
+    if location == :head
+      prettify_theme_url = ((prettify_theme = doc.attr 'prettify-theme', 'prettify').start_with? 'http://', 'https://') ? prettify_theme : %(#{base_url}/#{prettify_theme}.min.css)
+      %(<link rel="stylesheet" href="#{prettify_theme_url}"#{opts[:self_closing_tag_slash]}>)
+    else # :footer
+      %(<script src="#{base_url}/run_prettify.min.js"></script>)
+    end
   end
 end
 end

data/lib/asciidoctor/syntax_highlighter/pygments.rb

@@ -5,8 +5,7 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
 
   def initialize *args
     super
-    @requires_stylesheet = nil
-    @style = nil
+    @requires_stylesheet = @style = nil
   end
 
   def highlight?
@@ -53,7 +52,7 @@ class SyntaxHighlighter::PygmentsAdapter < SyntaxHighlighter::Base
   end
 
   def docinfo? location
-    @requires_stylesheet && location == :footer
+    @requires_stylesheet && location == :head
   end
 
   def docinfo location, doc, opts

data/lib/asciidoctor/syntax_highlighter/rouge.rb

@@ -5,8 +5,7 @@ class SyntaxHighlighter::RougeAdapter < SyntaxHighlighter::Base
 
   def initialize *args
     super
-    @requires_stylesheet = nil
-    @style = nil
+    @requires_stylesheet = @style = nil
   end
 
   def highlight?
@@ -14,14 +13,23 @@ class SyntaxHighlighter::RougeAdapter < SyntaxHighlighter::Base
   end
 
   def highlight node, source, lang, opts
-    lexer = (::Rouge::Lexer.find_fancy lang) || ::Rouge::Lexers::PlainText
-    lexer_opts = lexer.tag == 'php' && !(node.option? 'mixed') ? { start_inline: true } : {}
+    if lang.include? '?'
+      # NOTE cgi-style options only properly supported in Rouge >= 2.1
+      if (lexer = ::Rouge::Lexer.find_fancy lang)
+        unless lexer.tag != 'php' || (node.option? 'mixed') || ((lexer_opts = lexer.options).key? 'start_inline')
+          lexer = lexer.class.new lexer_opts.merge 'start_inline' => true
+        end
+      end
+    elsif (lexer = ::Rouge::Lexer.find lang)
+      lexer = lexer.tag == 'php' && !(node.option? 'mixed') ? (lexer.new start_inline: true) : lexer.new
+    end if lang
+    lexer ||= ::Rouge::Lexers::PlainText.new
     @style ||= (style = opts[:style]) && (style_available? style) || DEFAULT_STYLE
     if opts[:css_mode] == :class
       @requires_stylesheet = true
-      formatter = ::Rouge::Formatters::HTML.new @style
+      formatter = ::Rouge::Formatters::HTML.new inline_theme: @style
     else
-      formatter = ::Rouge::Formatters::HTMLInline.new @style
+      formatter = ::Rouge::Formatters::HTMLInline.new (::Rouge::Theme.find @style).new
     end
     if (highlight_lines = opts[:highlight_lines])
       formatter = RougeExt::Formatters::HTMLLineHighlighter.new formatter, lines: highlight_lines
@@ -29,25 +37,24 @@ class SyntaxHighlighter::RougeAdapter < SyntaxHighlighter::Base
     if opts[:number_lines]
       formatter = RougeExt::Formatters::HTMLTable.new formatter, start_line: opts[:start_line_number]
       if opts[:callouts]
-        return [(highlighted = formatter.format lexer.lex source, lexer_opts), (idx = highlighted.index CodeCellStartTagCs) ? idx + CodeCellStartTagCs.length : nil]
+        return [(highlighted = formatter.format lexer.lex source), (idx = highlighted.index CodeCellStartTagCs) ? idx + CodeCellStartTagCs.length : nil]
       end
     end
-    formatter.format lexer.lex source, lexer_opts
+    formatter.format lexer.lex source
   end
 
   def format node, lang, opts
     if (query_idx = lang && (lang.index '?'))
       lang = lang.slice 0, query_idx
     end
-    if opts[:css_mode] != :class && (@style = (style = opts[:style]) && (style_available? style) || DEFAULT_STYLE) &&
-        (pre_style_attr_val = base_style @style)
+    if opts[:css_mode] != :class && (@style = (style = opts[:style]) && (style_available? style) || DEFAULT_STYLE) && (pre_style_attr_val = base_style @style)
       opts[:transform] = proc {|pre| pre['style'] = pre_style_attr_val }
     end
     super
   end
 
   def docinfo? location
-    @requires_stylesheet && location == :footer
+    @requires_stylesheet && location == :head
   end
 
   def docinfo location, doc, opts