asciidoctor 2.0.10 → 2.0.17

data/lib/asciidoctor/load.rb

@@ -1,117 +1,119 @@
+# frozen_string_literal: true
 module Asciidoctor
-  module_function
+  class << self
+    # Public: Parse the AsciiDoc source input into a {Document}
+    #
+    # Accepts input as an IO (or StringIO), String or String Array object. If the
+    # input is a File, the object is expected to be opened for reading and is not
+    # closed afterwards by this method. Information about the file (filename,
+    # directory name, etc) gets assigned to attributes on the Document object.
+    #
+    # input   - the AsciiDoc source as a IO, String or Array.
+    # options - a String, Array or Hash of options to control processing (default: {})
+    #           String and Array values are converted into a Hash.
+    #           See {Document#initialize} for details about these options.
+    #
+    # Returns the Document
+    def load input, options = {}
+      options = options.merge
 
-  # Public: Parse the AsciiDoc source input into a {Document}
-  #
-  # Accepts input as an IO (or StringIO), String or String Array object. If the
-  # input is a File, the object is expected to be opened for reading and is not
-  # closed afterwards by this method. Information about the file (filename,
-  # directory name, etc) gets assigned to attributes on the Document object.
-  #
-  # input   - the AsciiDoc source as a IO, String or Array.
-  # options - a String, Array or Hash of options to control processing (default: {})
-  #           String and Array values are converted into a Hash.
-  #           See {Document#initialize} for details about these options.
-  #
-  # Returns the Document
-  def load input, options = {}
-    options = options.merge
-
-    if (timings = options[:timings])
-      timings.start :read
-    end
+      if (timings = options[:timings])
+        timings.start :read
+      end
 
-    if (logger = options[:logger]) && logger != LoggerManager.logger
-      LoggerManager.logger = logger
-    end
+      if (options.key? :logger) && (logger = options[:logger]) != LoggerManager.logger
+        LoggerManager.logger = logger || NullLogger.new
+      end
 
-    if !(attrs = options[:attributes])
-      attrs = {}
-    elsif ::Hash === attrs
-      attrs = attrs.merge
-    elsif (defined? ::Java::JavaUtil::Map) && ::Java::JavaUtil::Map === attrs
-      attrs = attrs.dup
-    elsif ::Array === attrs
-      attrs = {}.tap do |accum|
-        attrs.each do |entry|
-          k, _, v = entry.partition '='
-          accum[k] = v
+      if !(attrs = options[:attributes])
+        attrs = {}
+      elsif ::Hash === attrs
+        attrs = attrs.merge
+      elsif (defined? ::Java::JavaUtil::Map) && ::Java::JavaUtil::Map === attrs
+        attrs = attrs.dup
+      elsif ::Array === attrs
+        attrs = {}.tap do |accum|
+          attrs.each do |entry|
+            k, _, v = entry.partition '='
+            accum[k] = v
+          end
         end
-      end
-    elsif ::String === attrs
-      # condense and convert non-escaped spaces to null, unescape escaped spaces, then split on null
-      attrs = {}.tap do |accum|
-        attrs.gsub(SpaceDelimiterRx, '\1' + NULL).gsub(EscapedSpaceRx, '\1').split(NULL).each do |entry|
-          k, _, v = entry.partition '='
-          accum[k] = v
+      elsif ::String === attrs
+        # condense and convert non-escaped spaces to null, unescape escaped spaces, then split on null
+        attrs = {}.tap do |accum|
+          attrs.gsub(SpaceDelimiterRx, '\1' + NULL).gsub(EscapedSpaceRx, '\1').split(NULL).each do |entry|
+            k, _, v = entry.partition '='
+            accum[k] = v
+          end
         end
+      elsif (attrs.respond_to? :keys) && (attrs.respond_to? :[])
+        # coerce attrs to a real Hash
+        attrs = {}.tap {|accum| attrs.keys.each {|k| accum[k] = attrs[k] } }
+      else
+        raise ::ArgumentError, %(illegal type for attributes option: #{attrs.class.ancestors.join ' < '})
       end
-    elsif (attrs.respond_to? :keys) && (attrs.respond_to? :[])
-      # coerce attrs to a real Hash
-      attrs = {}.tap {|accum| attrs.keys.each {|k| accum[k] = attrs[k] } }
-    else
-      raise ::ArgumentError, %(illegal type for attributes option: #{attrs.class.ancestors.join ' < '})
-    end
 
-    if ::File === input
-      options[:input_mtime] = 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
-      attrs['docdir'] = ::File.dirname input_path
-      attrs['docname'] = Helpers.basename input_path, (attrs['docfilesuffix'] = Helpers.extname input_path)
-      source = input.read
-    elsif input.respond_to? :read
-      # NOTE tty, pipes & sockets can't be rewound, but can't be sniffed easily either
-      # just fail the rewind operation silently to handle all cases
-      input.rewind rescue nil
-      source = input.read
-    elsif ::String === input
-      source = input
-    elsif ::Array === input
-      source = input.drop 0
-    elsif input
-      raise ::ArgumentError, %(unsupported input type: #{input.class})
-    end
+      if ::File === input
+        # 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
+        attrs['docdir'] = ::File.dirname input_path
+        attrs['docname'] = Helpers.basename input_path, (attrs['docfilesuffix'] = Helpers.extname input_path)
+        source = input.read
+      elsif input.respond_to? :read
+        # NOTE tty, pipes & sockets can't be rewound, but can't be sniffed easily either
+        # just fail the rewind operation silently to handle all cases
+        input.rewind rescue nil
+        source = input.read
+      elsif ::String === input
+        source = input
+      elsif ::Array === input
+        source = input.drop 0
+      elsif input
+        raise ::ArgumentError, %(unsupported input type: #{input.class})
+      end
 
-    if timings
-      timings.record :read
-      timings.start :parse
-    end
+      if timings
+        timings.record :read
+        timings.start :parse
+      end
 
-    options[:attributes] = attrs
-    doc = options[:parse] == false ? (Document.new source, options) : (Document.new source, options).parse
+      options[:attributes] = attrs
+      doc = options[:parse] == false ? (Document.new source, options) : (Document.new source, options).parse
 
-    timings.record :parse if timings
-    doc
-  rescue => ex
-    begin
-      context = %(asciidoctor: FAILED: #{attrs['docfile'] || '<stdin>'}: Failed to load AsciiDoc document)
-      if ex.respond_to? :exception
-        # The original message must be explicitly preserved when wrapping a Ruby exception
-        wrapped_ex = ex.exception %(#{context} - #{ex.message})
-        # JRuby automatically sets backtrace; MRI did not until 2.6
-        wrapped_ex.set_backtrace ex.backtrace
-      else
-        # Likely a Java exception class
-        wrapped_ex = ex.class.new context, ex
-        wrapped_ex.stack_trace = ex.stack_trace
+      timings.record :parse if timings
+      doc
+    rescue => e
+      begin
+        context = %(asciidoctor: FAILED: #{attrs['docfile'] || '<stdin>'}: Failed to load AsciiDoc document)
+        if e.respond_to? :exception
+          # The original message must be explicitly preserved when wrapping a Ruby exception
+          wrapped_e = e.exception %(#{context} - #{e.message})
+          # JRuby automatically sets backtrace; MRI did not until 2.6
+          wrapped_e.set_backtrace e.backtrace
+        else
+          # Likely a Java exception class
+          wrapped_e = e.class.new context, e
+          wrapped_e.stack_trace = e.stack_trace
+        end
+      rescue
+        wrapped_e = e
       end
-    rescue
-      wrapped_ex = ex
+      raise wrapped_e
     end
-    raise wrapped_ex
-  end
 
-  # Public: Parse the contents of the AsciiDoc source file into an Asciidoctor::Document
-  #
-  # input   - the String AsciiDoc source filename
-  # options - a String, Array or Hash of options to control processing (default: {})
-  #           String and Array values are converted into a Hash.
-  #           See Asciidoctor::Document#initialize for details about options.
-  #
-  # Returns the Asciidoctor::Document
-  def load_file filename, options = {}
-    ::File.open(filename, FILE_READ_MODE) {|file| load file, options }
+    # Public: Parse the contents of the AsciiDoc source file into an Asciidoctor::Document
+    #
+    # input   - the String AsciiDoc source filename
+    # options - a String, Array or Hash of options to control processing (default: {})
+    #           String and Array values are converted into a Hash.
+    #           See Asciidoctor::Document#initialize for details about options.
+    #
+    # Returns the Asciidoctor::Document
+    def load_file filename, options = {}
+      ::File.open(filename, FILE_READ_MODE) {|file| load file, options }
+    end
   end
 end

data/lib/asciidoctor/logging.rb

@@ -20,10 +20,10 @@ class Logger < ::Logger
   end
 
   class BasicFormatter < Formatter
-    SEVERITY_LABELS = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
+    SEVERITY_LABEL_SUBSTITUTES = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
 
     def call severity, _, progname, msg
-      %(#{progname}: #{SEVERITY_LABELS[severity] || severity}: #{::String === msg ? msg : msg.inspect}#{LF})
+      %(#{progname}: #{SEVERITY_LABEL_SUBSTITUTES[severity] || severity}: #{::String === msg ? msg : msg.inspect}#{LF})
     end
   end
 
@@ -35,7 +35,7 @@ class Logger < ::Logger
 end
 
 class MemoryLogger < ::Logger
-  SEVERITY_LABELS = {}.tap {|accum| (Severity.constants false).each {|c| accum[Severity.const_get c, false] = c } }
+  SEVERITY_SYMBOL_BY_VALUE = (Severity.constants false).map {|c| [(Severity.const_get c), c] }.to_h
 
   attr_reader :messages
 
@@ -45,8 +45,8 @@ class MemoryLogger < ::Logger
   end
 
   def add severity, message = nil, progname = nil
-    message = block_given? ? yield : progname unless message
-    @messages << { severity: SEVERITY_LABELS[severity || UNKNOWN], message: message }
+    message ||= block_given? ? yield : progname
+    @messages << { severity: SEVERITY_SYMBOL_BY_VALUE[severity || UNKNOWN], message: message }
     true
   end
 
@@ -59,7 +59,7 @@ class MemoryLogger < ::Logger
   end
 
   def max_severity
-    empty? ? nil : @messages.map {|m| Severity.const_get m[:severity], false }.max
+    empty? ? nil : @messages.map {|m| Severity.const_get m[:severity] }.max
   end
 end
 
@@ -89,6 +89,7 @@ module LoggerManager
       @logger ||= (@logger_class.new pipe)
     end
 
+    # Returns the specified Logger
     def logger= new_logger
       @logger = new_logger || (@logger_class.new $stderr)
     end
@@ -110,9 +111,10 @@ module Logging
   # into - The Class that includes the {Logging} module
   #
   # Returns nothing
-  private_class_method def self.included into
+  def self.included into
     into.extend Logging
-  end || :included
+  end
+  private_class_method :included # use separate declaration for Ruby 2.0.x
 
   def logger
     LoggerManager.logger