asciidoctor 1.5.8 → 2.0.17

data/lib/asciidoctor/attribute_list.rb

@@ -1,40 +1,41 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Handles parsing AsciiDoc attribute lists into a Hash of key/value
 # pairs. By default, attributes must each be separated by a comma and quotes
 # may be used around the value. If a key is not detected, the value is assigned
 # to a 1-based positional key, The positional attributes can be "rekeyed" when
-# given a posattrs array either during parsing or after the fact.
+# given a positional_attrs array either during parsing or after the fact.
 #
 # Examples
 #
 #    attrlist = Asciidoctor::AttributeList.new('astyle')
 #
 #    attrlist.parse
-#    => {0 => 'astyle'}
+#    => { 0 => 'astyle' }
 #
 #    attrlist.rekey(['style'])
-#    => {'style' => 'astyle'}
+#    => { 'style' => 'astyle' }
 #
 #    attrlist = Asciidoctor::AttributeList.new('quote, Famous Person, Famous Book (2001)')
 #
 #    attrlist.parse(['style', 'attribution', 'citetitle'])
-#    => {'style' => 'quote', 'attribution' => 'Famous Person', 'citetitle' => 'Famous Book (2001)'}
+#    => { 'style' => 'quote', 'attribution' => 'Famous Person', 'citetitle' => 'Famous Book (2001)' }
 #
 class AttributeList
-  BACKSLASH = '\\'
   APOS = '\''
+  BACKSLASH = '\\'
+  QUOT = '"'
 
   # Public: Regular expressions for detecting the boundary of a value
-  BoundaryRxs = {
-    '"' => /.*?[^\\](?=")/,
+  BoundaryRx = {
+    QUOT => /.*?[^\\](?=")/,
     APOS => /.*?[^\\](?=')/,
     ',' => /.*?(?=[ \t]*(,|$))/
   }
 
   # Public: Regular expressions for unescaping quoted characters
   EscapedQuotes = {
-    '"' => '\\"',
+    QUOT => '\\"',
     APOS => '\\\''
   }
 
@@ -44,9 +45,8 @@ class AttributeList
 
   BlankRx = /[ \t]+/
 
-  # Public: Regular expressions for skipping blanks and delimiters
-  SkipRxs = {
-    :blank => BlankRx,
+  # Public: Regular expressions for skipping delimiters
+  SkipRx = {
     ',' => /[ \t]*(,|$)/
   }
 
@@ -54,25 +54,23 @@ class AttributeList
     @scanner = ::StringScanner.new source
     @block = block
     @delimiter = delimiter
-    @delimiter_skip_pattern = SkipRxs[delimiter]
-    @delimiter_boundary_pattern = BoundaryRxs[delimiter]
+    @delimiter_skip_pattern = SkipRx[delimiter]
+    @delimiter_boundary_pattern = BoundaryRx[delimiter]
     @attributes = nil
   end
 
-  def parse_into attributes, posattrs = []
-    attributes.update(parse posattrs)
+  def parse_into attributes, positional_attrs = []
+    attributes.update parse positional_attrs
   end
 
-  def parse posattrs = []
+  def parse positional_attrs = []
     # return if already parsed
     return @attributes if @attributes
 
     @attributes = {}
-    # QUESTION do we want to store the attribute list as the zero-index attribute?
-    #attributes[0] = @scanner.string
     index = 0
 
-    while parse_attribute index, posattrs
+    while parse_attribute index, positional_attrs
       break if @scanner.eos?
       skip_delimiter
       index += 1
@@ -81,90 +79,88 @@ class AttributeList
     @attributes
   end
 
-  def rekey posattrs
-    AttributeList.rekey @attributes, posattrs
+  def rekey positional_attrs
+    AttributeList.rekey @attributes, positional_attrs
   end
 
-  def self.rekey attributes, pos_attrs
-    pos_attrs.each_with_index do |key, index|
-      next unless key
-      pos = index + 1
-      if (val = attributes[pos])
+  def self.rekey attributes, positional_attrs
+    positional_attrs.each_with_index do |key, index|
+      if key && (val = attributes[index + 1])
         # QUESTION should we delete the positional key?
         attributes[key] = val
       end
     end
-
     attributes
   end
 
-  def parse_attribute index = 0, pos_attrs = []
-    single_quoted_value = false
+  private
+
+  def parse_attribute index, positional_attrs
+    continue = true
     skip_blank
-    # example: "quote"
-    if (first = @scanner.peek(1)) == '"'
+    case @scanner.peek 1
+    # example: "quote" || "foo
+    when QUOT
       name = parse_attribute_value @scanner.get_byte
-      value = nil
-    # example: 'quote'
-    elsif first == APOS
+    # example: 'quote' || 'foo
+    when APOS
       name = parse_attribute_value @scanner.get_byte
-      value = nil
-      single_quoted_value = true unless name.start_with? APOS
+      single_quoted = true unless name.start_with? APOS
     else
-      name = scan_name
-
-      skipped = 0
-      c = nil
+      skipped = ((name = scan_name) && skip_blank) || 0
       if @scanner.eos?
-        return false unless name
-      else
-        skipped = skip_blank || 0
-        c = @scanner.get_byte
-      end
-
-      # example: quote
-      if !c || c == @delimiter
-        value = nil
-      # example: Sherlock Holmes || =foo=
-      elsif c != '=' || !name
-        name = %(#{name}#{' ' * skipped}#{c}#{scan_to_delimiter})
-        value = nil
-      else
-        skip_blank
-        if @scanner.peek(1)
-          # example: foo="bar" || foo="ba\"zaar"
-          if (c = @scanner.get_byte) == '"'
+        return unless name || (@scanner.string.rstrip.end_with? @delimiter)
+        # example: quote (at eos)
+        continue = nil
+      # example: quote,
+      elsif (c = @scanner.get_byte) == @delimiter
+        @scanner.unscan
+      elsif name
+        # example: foo=...
+        if c == '='
+          skip_blank
+          case (c = @scanner.get_byte)
+          # example: foo="bar" || foo="ba\"zaar" || foo="bar
+          when QUOT
             value = parse_attribute_value c
-          # example: foo='bar' || foo='ba\'zaar' || foo='ba"zaar'
-          elsif c == APOS
+          # example: foo='bar' || foo='ba\'zaar' || foo='ba"zaar' || foo='bar
+          when APOS
             value = parse_attribute_value c
-            single_quoted_value = true unless value.start_with? APOS
+            single_quoted = true unless value.start_with? APOS
           # example: foo=,
-          elsif c == @delimiter
+          when @delimiter
             value = ''
-          # example: foo=bar (all spaces ignored)
+            @scanner.unscan
+          # example: foo= (at eos)
+          when nil
+            value = ''
+          # example: foo=bar || foo=None
           else
             value = %(#{c}#{scan_to_delimiter})
             return true if value == 'None'
           end
+        # example: foo bar
+        else
+          name = %(#{name}#{' ' * skipped}#{c}#{scan_to_delimiter})
         end
+      # example: =foo= || !foo
+      else
+        name = %(#{c}#{scan_to_delimiter})
       end
     end
 
     if value
-      # example: options="opt1,opt2,opt3"
-      # opts is an alias for options
+      # example: options="opt1,opt2,opt3" || opts="opts1,opt2,opt3"
       case name
       when 'options', 'opts'
         if value.include? ','
           value = value.delete ' ' if value.include? ' '
           (value.split ',').each {|opt| @attributes[%(#{opt}-option)] = '' unless opt.empty? }
         else
-          @attributes[%(#{value = value.strip}-option)] = ''
+          @attributes[%(#{value}-option)] = '' unless value.empty?
         end
-        @attributes['options'] = value
       else
-        if single_quoted_value && @block
+        if single_quoted && @block
           case name
           when 'title', 'reftext'
             @attributes[name] = value
@@ -176,33 +172,26 @@ class AttributeList
         end
       end
     else
-      resolved_name = single_quoted_value && @block ? (@block.apply_subs name) : name
-      if (pos_name = pos_attrs[index])
-        @attributes[pos_name] = resolved_name
+      name = @block.apply_subs name if single_quoted && @block
+      if (positional_attr_name = positional_attrs[index]) && name
+        @attributes[positional_attr_name] = name
       end
-      # QUESTION should we always assign the positional key?
-      @attributes[index + 1] = resolved_name
-      # QUESTION should we assign the resolved name as an attribute?
-      #@attributes[resolved_name] = nil
+      # QUESTION should we assign the positional key even when it's claimed by a positional attribute?
+      @attributes[index + 1] = name
     end
 
-    true
+    continue
   end
 
   def parse_attribute_value quote
     # empty quoted value
-    if @scanner.peek(1) == quote
+    if (@scanner.peek 1) == quote
       @scanner.get_byte
-      return ''
-    end
-
-    if (value = scan_to_quote quote)
+      ''
+    elsif (value = scan_to_quote quote)
       @scanner.get_byte
-      if value.include? BACKSLASH
-        value.gsub EscapedQuotes[quote], quote
-      else
-        value
-      end
+      (value.include? BACKSLASH) ? (value.gsub EscapedQuotes[quote], quote) : value
+    # leading quote only
     else
       %(#{quote}#{scan_to_delimiter})
     end
@@ -225,8 +214,7 @@ class AttributeList
   end
 
   def scan_to_quote quote
-    @scanner.scan BoundaryRxs[quote]
+    @scanner.scan BoundaryRx[quote]
   end
-
 end
 end

data/lib/asciidoctor/block.rb

@@ -1,26 +1,26 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
-# Public: Methods for managing blocks of Asciidoc content in a section.
+# Public: Methods for managing AsciiDoc content blocks.
 #
 # Examples
 #
-#   block = Asciidoctor::Block.new(parent, :paragraph, :source => '_This_ is a <test>')
+#   block = Asciidoctor::Block.new(parent, :paragraph, source: '_This_ is a <test>')
 #   block.content
 #   => "<em>This</em> is a &lt;test&gt;"
 class Block < AbstractBlock
 
   (DEFAULT_CONTENT_MODEL = {
     # TODO should probably fill in all known blocks
-    :audio => :empty,
-    :image => :empty,
-    :listing => :verbatim,
-    :literal => :verbatim,
-    :stem => :raw,
-    :open => :compound,
-    :page_break => :empty,
-    :pass => :raw,
-    :thematic_break => :empty,
-    :video => :empty
+    audio: :empty,
+    image: :empty,
+    listing: :verbatim,
+    literal: :verbatim,
+    stem: :raw,
+    open: :compound,
+    page_break: :empty,
+    pass: :raw,
+    thematic_break: :empty,
+    video: :empty,
   }).default = :simple
 
   # Public: Create alias for context to be consistent w/ AsciiDoc
@@ -40,10 +40,10 @@ class Block < AbstractBlock
   #                 * :source a String or Array of raw source for this Block. (default: nil)
   #
   # IMPORTANT: If you don't specify the `:subs` option, you must explicitly call
-  # the `lock_in_subs` method to resolve and assign the substitutions to this
+  # the `commit_subs` method to resolve and assign the substitutions to this
   # block (which are resolved from the `subs` attribute, if specified, or the
   # default substitutions based on this block's context). If you want to use the
-  # default subs for a block, pass the option `:subs => :default`. You can
+  # default subs for a block, pass the option `subs: :default`. You can
   # override the default subs using the `:default_subs` option.
   #--
   # QUESTION should we store source_data as lines for blocks that have compound content models?
@@ -51,28 +51,29 @@ class Block < AbstractBlock
     super
     @content_model = opts[:content_model] || DEFAULT_CONTENT_MODEL[context]
     if opts.key? :subs
-      # FIXME feels funky; we have to be defensive to get lock_in_subs to honor override
+      # FIXME feels funky; we have to be defensive to get commit_subs to honor override
       # FIXME does not resolve substitution groups inside Array (e.g., [:normal])
       if (subs = opts[:subs])
-        # e.g., :subs => :defult
+        case subs
+        # e.g., subs: :default
         # subs attribute is honored; falls back to opts[:default_subs], then built-in defaults based on context
-        if subs == :default
+        when :default
           @default_subs = opts[:default_subs]
-        # e.g., :subs => [:quotes]
+        # e.g., subs: [:quotes]
         # subs attribute is not honored
-        elsif ::Array === subs
+        when ::Array
           @default_subs = subs.drop 0
           @attributes.delete 'subs'
-        # e.g., :subs => :normal or :subs => 'normal'
+        # e.g., subs: :normal or subs: 'normal'
         # subs attribute is not honored
         else
           @default_subs = nil
-          # interpolation is the fastest way to dup subs as a string
-          @attributes['subs'] = %(#{subs})
+          @attributes['subs'] = subs.to_s
         end
         # resolve the subs eagerly only if subs option is specified
-        lock_in_subs
-      # e.g., :subs => nil
+        # QUESTION should we skip subsequent calls to commit_subs?
+        commit_subs
+      # e.g., subs: nil
       else
         # NOTE @subs is initialized as empty array by super constructor
         # prevent subs from being resolved
@@ -88,7 +89,7 @@ class Block < AbstractBlock
     if (raw_source = opts[:source]).nil_or_empty?
       @lines = []
     elsif ::String === raw_source
-      @lines = Helpers.normalize_lines_from_string raw_source
+      @lines = Helpers.prepare_source_string raw_source
     else
       @lines = raw_source.drop 0
     end
@@ -101,7 +102,7 @@ class Block < AbstractBlock
   #
   #   doc = Asciidoctor::Document.new
   #   block = Asciidoctor::Block.new(doc, :paragraph,
-  #       :source => '_This_ is what happens when you <meet> a stranger in the <alps>!')
+  #       source: '_This_ is what happens when you <meet> a stranger in the <alps>!')
   #   block.content
   #   => "<em>This</em> is what happens when you &lt;meet&gt; a stranger in the &lt;alps&gt;!"
   def content
@@ -122,7 +123,7 @@ class Block < AbstractBlock
         result.join LF
       end
     else
-      logger.warn %(Unknown content model '#{@content_model}' for block: #{to_s}) unless @content_model == :empty
+      logger.warn %(Unknown content model '#{@content_model}' for block: #{self}) unless @content_model == :empty
       nil
     end
   end

data/lib/asciidoctor/callouts.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Maintains a catalog of callouts and their associations.
 class Callouts
@@ -28,7 +28,7 @@ class Callouts
   #
   # Returns The unique String id of this callout
   def register li_ordinal
-    current_list << { :ordinal => li_ordinal.to_i, :id => (id = generate_next_callout_id) }
+    current_list << { ordinal: li_ordinal.to_i, id: (id = generate_next_callout_id) }
     @co_index += 1
     id
   end
@@ -93,6 +93,8 @@ class Callouts
     nil
   end
 
+  private
+
   # Internal: Generate a unique id for the callout based on the internal indexes
   #
   # Returns A unique String id for this callout

data/lib/asciidoctor/cli/invoker.rb

@@ -1,8 +1,9 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
   module Cli
     # Public Invocation class for starting Asciidoctor via CLI
     class Invoker
+      include Logging
 
       attr_reader :options
       attr_reader :documents
@@ -32,8 +33,8 @@ module Asciidoctor
       def invoke!
         return unless @options
 
-        old_verbose = $VERBOSE
         old_logger = old_logger_level = nil
+        old_verbose, $VERBOSE = $VERBOSE, @options[:warnings]
         opts = {}
         infiles = []
         outfile = nil
@@ -41,6 +42,8 @@ module Asciidoctor
         non_posix_env = ::File::ALT_SEPARATOR == RS
         err = @err || $stderr
         show_timings = false
+        # NOTE in Ruby 2.7, RubyGems sets SOURCE_DATE_EPOCH if it's not set
+        ::ENV.delete 'SOURCE_DATE_EPOCH' if (::ENV.key? 'IGNORE_SOURCE_DATE_EPOCH') && (::Gem.respond_to? :source_date_epoch)
 
         @options.map do |key, val|
           case key
@@ -61,18 +64,14 @@ module Asciidoctor
           when :timings
             show_timings = val
           when :trace
-            # currently does nothing
+            # no assignment
           when :verbose
             case val
             when 0
               $VERBOSE = nil
-              old_logger = LoggerManager.logger
-              LoggerManager.logger = NullLogger.new
-            when 1
-              $VERBOSE = false
+              old_logger, LoggerManager.logger = logger, NullLogger.new
             when 2
-              $VERBOSE = true
-              old_logger_level, LoggerManager.logger.level = LoggerManager.logger.level, ::Logger::Severity::DEBUG
+              old_logger_level, logger.level = logger.level, ::Logger::Severity::DEBUG
             end
           else
             opts[key] = val unless val.nil?
@@ -89,7 +88,7 @@ module Asciidoctor
         end
 
         if outfile == '-'
-          tofile = @out || $stdout
+          (tofile = @out) || ((tofile = $stdout).set_encoding UTF_8)
         elsif outfile
           opts[:mkdirs] = true
           tofile = outfile
@@ -100,17 +99,18 @@ module Asciidoctor
 
         if stdin
           # allows use of block to supply stdin, particularly useful for tests
-          input = block_given? ? yield : STDIN
-          input_opts = opts.merge :to_file => tofile
+          # NOTE set_encoding returns nil on JRuby 9.1
+          block_given? ? (input = yield) : ((input = $stdin).set_encoding UTF_8, UTF_8)
+          input_opts = opts.merge to_file: tofile
           if show_timings
-            @documents << (::Asciidoctor.convert input, (input_opts.merge :timings => (timings = Timings.new)))
+            @documents << (::Asciidoctor.convert input, (input_opts.merge timings: (timings = Timings.new)))
             timings.print_report err, '-'
           else
             @documents << (::Asciidoctor.convert input, input_opts)
           end
         else
           infiles.each do |infile|
-            input_opts = opts.merge :to_file => tofile
+            input_opts = opts.merge to_file: tofile
             if abs_srcdir_posix && (input_opts.key? :to_dir)
               abs_indir = ::File.dirname ::File.expand_path infile
               if non_posix_env
@@ -123,30 +123,26 @@ module Asciidoctor
               end
             end
             if show_timings
-              @documents << (::Asciidoctor.convert_file infile, (input_opts.merge :timings => (timings = Timings.new)))
+              @documents << (::Asciidoctor.convert_file infile, (input_opts.merge timings: (timings = Timings.new)))
               timings.print_report err, infile
             else
               @documents << (::Asciidoctor.convert_file infile, input_opts)
             end
           end
         end
-        @code = 1 if ((logger = LoggerManager.logger).respond_to? :max_severity) && logger.max_severity && logger.max_severity >= opts[:failure_level]
+        @code = 1 if (logger.respond_to? :max_severity) && logger.max_severity && logger.max_severity >= opts[:failure_level]
       rescue ::Exception => e
         if ::SignalException === e
           @code = e.signo
-          # add extra endline if Ctrl+C is used
+          # add extra newline if Ctrl+C is used
           err.puts if ::Interrupt === e
         else
           @code = (e.respond_to? :status) ? e.status : 1
           if @options[:trace]
             raise e
           else
-            if ::RuntimeError === e
-              err.puts %(#{e.message} (#{e.class}))
-            else
-              err.puts e.message
-            end
-            err.puts '  Use --trace for backtrace'
+            err.puts ::RuntimeError === e ? %(#{e.message} (#{e.class})) : e.message
+            err.puts '  Use --trace to show backtrace'
           end
         end
         nil
@@ -155,7 +151,7 @@ module Asciidoctor
         if old_logger
           LoggerManager.logger = old_logger
         elsif old_logger_level
-          LoggerManager.logger.level = old_logger_level
+          logger.level = old_logger_level
         end
       end