asciidoctor 1.5.4 → 1.5.5

data/lib/asciidoctor/converter/manpage.rb

@@ -14,6 +14,13 @@ module Asciidoctor
     ESC_BS = %(#{ESC}\\) # escaped backslash (indicates troff formatting sequence)
     ESC_FS = %(#{ESC}.)  # escaped full stop (indicates troff macro)
 
+    LiteralBackslashRx = /(?:\A|[^#{ESC}])\\/
+    LeadingPeriodRx = /^\./
+    EscapedMacroRx = /^(?:#{ESC}\\c\n)?#{ESC}\.((?:URL|MTO) ".*?" ".*?" )( |[^\s]*)(.*?)(?: *#{ESC}\\c)?$/
+    MockBoundaryRx = /<\/?BOUNDARY>/
+    EmDashCharRefRx = /&#8212(?:;&#8203;)?/
+    EllipsisCharRefRx = /&#8230;(?:&#8203;)?/
+
     # Converts HTML entity references back to their original form, escapes
     # special man characters and strips trailing whitespace.
     #
@@ -26,12 +33,10 @@ module Asciidoctor
     #        * :append_newline a Boolean that indicates whether to append an endline to the result (default: false)
     def manify str, opts = {}
       str = ((opts.fetch :preserve_space, true) ? (str.gsub TAB, ET) : (str.tr_s WHITESPACE, ' ')).
-        gsub(/(?:\A|[^#{ESC}])\\/, '\&(rs'). # literal backslash (not a troff escape sequence)
-        gsub(/^\./, '\\\&.').     # leading . is used in troff for macro call or other formatting; replace with \&.
+        gsub(LiteralBackslashRx, '\&(rs'). # literal backslash (not a troff escape sequence)
+        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(/^(?:#{ESC}\\c\n)?#{ESC}\.((?:URL|MTO) ".*?" ".*?" )( |[^\s]*)(.*?)(?: *#{ESC}\\c)?$/) {
-          (rest = $3.lstrip).empty? ? %(.#$1"#$2") : %(.#$1"#$2"#{LF}#{rest})
-        }.
+        gsub(EscapedMacroRx) { (rest = $3.lstrip).empty? ? %(.#$1"#$2") : %(.#$1"#$2"#{LF}#{rest}) }.
         gsub('-', '\-').
         gsub('&lt;', '<').
         gsub('&gt;', '>').
@@ -41,20 +46,20 @@ module Asciidoctor
         gsub('&#8482;', '\(tm').  # trademark sign
         gsub('&#8201;', ' ').     # thin space
         gsub('&#8211;', '\(en').  # en dash
-        gsub(/&#8212(?:;&#8203;)?/, '\(em'). # em 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(/&#8230;(?:&#8203;)?/, '...'). # horizontal ellipsis
+        gsub(EllipsisCharRefRx, '...'). # horizontal ellipsis
         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('\'', '\(aq').       # apostrophe-quote
-        gsub(/<\/?BOUNDARY>/, '').# artificial boundary
-        gsub(ESC_BS, '\\').       # unescape troff backslash (NOTE update if more escaped are added)
+        gsub(MockBoundaryRx, ''). # mock boundary
+        gsub(ESC_BS, '\\').       # unescape troff backslash (NOTE update if more escapes are added)
         rstrip                    # strip trailing space
       opts[:append_newline] ? %(#{str}#{LF}) : str
     end

data/lib/asciidoctor/converter/template.rb

@@ -246,20 +246,24 @@ module Asciidoctor
         elsif name.start_with? 'block_'
           name = name[6..-1]
         end
-        ext_name = path_segments[-1]
+        
         template_class = ::Tilt
         extra_engine_options = {}
-        if ext_name == 'slim'
+        case (ext_name = path_segments[-1])
+        when 'slim'
           # slim doesn't get loaded by Tilt, so we have to load it explicitly
           Helpers.require_library 'slim' unless defined? ::Slim
           # align safe mode of AsciiDoc embedded in Slim template with safe mode of current document
           (@engine_options[:slim][:asciidoc] ||= {})[:safe] ||= @safe if @safe && ::Slim::VERSION >= '3.0'
           # load include plugin when using Slim >= 2.1
           require 'slim/include' unless (defined? ::Slim::Include) || ::Slim::VERSION < '2.1'
-        elsif ext_name == 'erb'
+        when 'erb'
           template_class, extra_engine_options = (eruby_loaded ||= load_eruby(@eruby))
+        when 'rb'
+          next
+        else
+          next unless ::Tilt.registered? ext_name
         end
-        next unless ::Tilt.registered? ext_name
         unless template_cache && (template = template_cache[file])
           template = template_class.new file, 1, (@engine_options[ext_name.to_sym] || {}).merge(extra_engine_options)
         end

data/lib/asciidoctor/core_ext.rb

@@ -1,7 +1,8 @@
-require 'asciidoctor/core_ext/object/nil_or_empty'
-unless RUBY_ENGINE == 'opal'
-  unless RUBY_MIN_VERSION_1_9
-    require 'asciidoctor/core_ext/string/chr'
-    require 'asciidoctor/core_ext/symbol/length'
-  end
+require 'asciidoctor/core_ext/nil_or_empty'
+if RUBY_MIN_VERSION_1_9
+  require 'asciidoctor/core_ext/string/limit'
+elsif RUBY_ENGINE != 'opal'
+  require 'asciidoctor/core_ext/1.8.7/string/chr'
+  require 'asciidoctor/core_ext/1.8.7/string/limit'
+  require 'asciidoctor/core_ext/1.8.7/symbol/length'
 end

data/lib/asciidoctor/core_ext/{string → 1.8.7/string}/chr.rb

@@ -2,5 +2,5 @@
 class String
   def chr
     self[0..0]
-  end unless respond_to? :chr
+  end unless method_defined? :chr
 end

data/lib/asciidoctor/core_ext/1.8.7/string/limit.rb

@@ -0,0 +1,28 @@
+if RUBY_ENGINE_JRUBY
+  class String
+    # Safely truncate the string to the specified number of bytes.
+    # If a multibyte char gets split, the dangling fragment is removed.
+    def limit size
+      return self unless size < bytesize
+      result = (unpack %(a#{size}))[0]
+      begin
+        result.unpack 'U*'
+      rescue ArgumentError
+        result.chop!
+        retry
+      end
+      result
+    end unless method_defined? :limit
+  end
+else
+  class String
+    # Safely truncate the string to the specified number of bytes.
+    # If a multibyte char gets split, the dangling fragment is removed.
+    def limit size
+      return self unless size < bytesize
+      result = (unpack %(a#{size}))[0]
+      result.chop! until result.empty? || /.$/u =~ result
+      result
+    end unless method_defined? :limit
+  end
+end

data/lib/asciidoctor/core_ext/{symbol → 1.8.7/symbol}/length.rb

@@ -2,5 +2,5 @@
 class Symbol
   def length
     to_s.length
-  end unless respond_to? :length
+  end unless method_defined? :length
 end

data/lib/asciidoctor/core_ext/nil_or_empty.rb

@@ -0,0 +1,23 @@
+# A core library extension that defines the method nil_or_empty? as an alias to
+# optimize checks for nil? or empty? on common object types such as NilClass,
+# String, Array, Hash, and Numeric.
+
+class NilClass
+  alias :nil_or_empty? :nil? unless method_defined? :nil_or_empty?
+end
+
+class String
+  alias :nil_or_empty? :empty? unless method_defined? :nil_or_empty?
+end
+
+class Array
+  alias :nil_or_empty? :empty? unless method_defined? :nil_or_empty?
+end
+
+class Hash
+  alias :nil_or_empty? :empty? unless method_defined? :nil_or_empty?
+end
+
+class Numeric
+  alias :nil_or_empty? :nil? unless method_defined? :nil_or_empty?
+end

data/lib/asciidoctor/core_ext/string/limit.rb

@@ -0,0 +1,10 @@
+class String
+  # Safely truncate the string to the specified number of bytes.
+  # If a multibyte char gets split, the dangling fragment is removed.
+  def limit size
+    return self unless size < bytesize
+    # NOTE JRuby 1.7 & Rubinius fail to detect invalid encoding unless encoding is forced; impact is marginal.
+    size -= 1 until ((result = byteslice 0, size).force_encoding ::Encoding::UTF_8).valid_encoding?
+    result
+  end unless method_defined? :limit
+end

data/lib/asciidoctor/document.rb

@@ -225,7 +225,7 @@ class Document < AbstractBlock
       # safely resolve the safe mode from const, int or string
       if !(safe_mode = options[:safe])
         @safe = SafeMode::SECURE
-      elsif ::Fixnum === safe_mode
+      elsif ::Integer === safe_mode
         # be permissive in case API user wants to define new levels
         @safe = safe_mode
       else
@@ -236,8 +236,8 @@ class Document < AbstractBlock
           @safe = SafeMode::SECURE
         end
       end
+      @compat_mode = attr_overrides.key? 'compat-mode'
       @sourcemap = options[:sourcemap]
-      @compat_mode = false
       @converter = nil
       initialize_extensions = defined? ::Asciidoctor::Extensions
       @extensions = nil # initialize furthur down
@@ -287,7 +287,7 @@ class Document < AbstractBlock
     attr_overrides['asciidoctor'] = ''
     attr_overrides['asciidoctor-version'] = VERSION
 
-    safe_mode_name = SafeMode.constants.detect {|l| SafeMode.const_get(l) == @safe }.to_s.downcase
+    safe_mode_name = SafeMode.constants.find {|l| SafeMode.const_get(l) == @safe }.to_s.downcase
     attr_overrides['safe-mode-name'] = safe_mode_name
     attr_overrides["safe-mode-#{safe_mode_name}"] = ''
     attr_overrides['safe-mode-level'] = @safe
@@ -295,14 +295,11 @@ class Document < AbstractBlock
     # sync the embedded attribute w/ the value of options...do not allow override
     attr_overrides['embedded'] = header_footer ? nil : ''
 
-    # the only way to set the max-include-depth attribute is via the document options
-    # 64 is the AsciiDoc default
+    # the only way to set the max-include-depth attribute is via the API; default to 64 like AsciiDoc Python
     attr_overrides['max-include-depth'] ||= 64
 
-    # the only way to enable uri reads is via the document options, disabled by default
-    unless !attr_overrides['allow-uri-read'].nil?
-      attr_overrides['allow-uri-read'] = nil
-    end
+    # the only way to set the allow-uri-read attribute is via the API; disabled by default
+    attr_overrides['allow-uri-read'] ||= nil
 
     attr_overrides['user-home'] = USER_HOME
 
@@ -344,6 +341,7 @@ class Document < AbstractBlock
       attr_overrides['docdir'] = ''
       attr_overrides['user-home'] = '.'
       if @safe >= SafeMode::SECURE
+        attr_overrides['max-attribute-value-size'] = 4096 unless attr_overrides.key? 'max-attribute-value-size'
         # assign linkcss (preventing css embedding) unless explicitly disabled from the commandline or API
         # effectively the same has "has key 'linkcss' and value == nil"
         unless attr_overrides.fetch('linkcss', '').nil?
@@ -354,6 +352,9 @@ class Document < AbstractBlock
       end
     end
 
+    # the only way to set the max-attribute-value-size attribute is via the API; disabled by default
+    @max_attribute_value_size = (val = (attr_overrides['max-attribute-value-size'] ||= nil)) ? val.to_i.abs : nil
+
     attr_overrides.delete_if do |key, val|
       verdict = false
       # a nil value undefines the attribute
@@ -371,8 +372,6 @@ class Document < AbstractBlock
       verdict
     end
 
-    @compat_mode = true if attrs.key? 'compat-mode'
-
     if parent_doc
       # setup default doctype (backend is fixed)
       attrs['doctype'] ||= DEFAULT_DOCTYPE
@@ -401,13 +400,15 @@ class Document < AbstractBlock
       #attrs['infile'] = attrs['docfile']
 
       # dynamic intrinstic attribute values
-      now = ::Time.now
+
+      # See https://reproducible-builds.org/specs/source-date-epoch/
+      now = ::ENV['SOURCE_DATE_EPOCH'] ? (::Time.at ::ENV['SOURCE_DATE_EPOCH'].to_i).utc : ::Time.now
       localdate = (attrs['localdate'] ||= now.strftime('%Y-%m-%d'))
       unless (localtime = attrs['localtime'])
         begin
           localtime = attrs['localtime'] = now.strftime('%H:%M:%S %Z')
-        rescue
-          localtime = attrs['localtime'] = now.strftime('%H:%M:%S')
+        rescue # Asciidoctor.js fails if timezone string has characters outside basic Latin (see asciidoctor.js#23)
+          localtime = attrs['localtime'] = now.strftime('%H:%M:%S %z')
         end
       end
       attrs['localdatetime'] ||= %(#{localdate} #{localtime})
@@ -679,7 +680,7 @@ class Document < AbstractBlock
 
   # QUESTION move to AbstractBlock?
   def first_section
-    has_header? ? @header : (@blocks || []).detect{|e| e.context == :section }
+    has_header? ? @header : (@blocks || []).find {|e| e.context == :section }
   end
 
   def has_header?
@@ -835,13 +836,18 @@ class Document < AbstractBlock
     if attribute_locked?(name)
       false
     else
+      if @max_attribute_value_size
+        resolved_value = (apply_attribute_value_subs value).limit @max_attribute_value_size
+      else
+        resolved_value = apply_attribute_value_subs value
+      end
       case name
       when 'backend'
-        update_backend_attributes apply_attribute_value_subs(value), !!@attributes_modified.delete?('htmlsyntax')
+        update_backend_attributes resolved_value, !!@attributes_modified.delete?('htmlsyntax')
       when 'doctype'
-        update_doctype_attributes apply_attribute_value_subs(value)
+        update_doctype_attributes resolved_value
       else
-        @attributes[name] = apply_attribute_value_subs(value)
+        @attributes[name] = resolved_value
       end
       @attributes_modified << name
       true
@@ -1110,17 +1116,18 @@ class Document < AbstractBlock
   # attribute is set, read the doc-name.docinfo.ext file. If the docinfo2
   # attribute is set, read both files in that order.
   #
-  # location - The Symbol location of the docinfo, either :header or :footer. (default: :header)
-  # ext      - The extension of the docinfo file(s). If not set, the extension
-  #            will be determined based on the basebackend. (default: nil)
+  # location - The Symbol location of the docinfo (e.g., :head, :footer, etc). (default: :head)
+  # suffix   - The suffix of the docinfo file(s). If not set, the extension
+  #            will be set to the outfilesuffix. (default: nil)
   #
-  # returns The contents of the docinfo file(s)
-  def docinfo(location = :head, ext = nil)
+  # returns The contents of the docinfo file(s) or empty string if no files are
+  # found or the safe mode is secure or greater.
+  def docinfo location = :head, suffix = nil
     if safe >= SafeMode::SECURE
       ''
     else
-      qualifier = (location == :footer ? '-footer' : nil)
-      ext = @outfilesuffix unless ext
+      qualifier = location == :head ? nil : %(-#{location})
+      suffix = @outfilesuffix unless suffix
       docinfodir = @attributes['docinfodir']
 
       content = nil
@@ -1138,7 +1145,7 @@ class Document < AbstractBlock
       end
 
       if docinfo
-        docinfo_filename = %(docinfo#{qualifier}#{ext})
+        docinfo_filename = %(docinfo#{qualifier}#{suffix})
         unless (docinfo & ['shared', %(shared-#{location})]).empty?
           docinfo_path = normalize_system_path(docinfo_filename, docinfodir)
           # NOTE normalizing the lines is essential if we're performing substitutions

data/lib/asciidoctor/extensions.rb

@@ -106,16 +106,16 @@ module Extensions
 
     # Public: Parses blocks in the content and attaches the block to the parent.
     #
-    # Returns nothing
+    # Returns The parent node into which the blocks are parsed.
     #--
     # QUESTION is parse_content the right method name? should we wrap in open block automatically?
-    def parse_content parent, content, attributes = {}
-      reader = (content.is_a? Reader) ? content : (Reader.new content)
+    def parse_content parent, content, attributes = nil
+      reader = Reader === content ? content : (Reader.new content)
       while reader.has_more_lines?
-        block = Parser.next_block reader, parent, attributes
+        block = Parser.next_block reader, parent, (attributes ? attributes.dup : {})
         parent << block if block
       end
-      nil
+      parent
     end
 
     # TODO fill out remaining methods
@@ -145,7 +145,7 @@ module Extensions
     def process *args, &block
       # need to check for both block/proc and lambda
       # TODO need test for this!
-      #if block_given? || (args.size == 1 && ((block = args[0]).is_a? ::Proc))
+      #if block_given? || (args.size == 1 && ::Proc === (block = args[0]))
       if block_given?
         @process_block = block
       elsif @process_block
@@ -326,7 +326,7 @@ module Extensions
 
     # FIXME this isn't the prettiest thing
     def named value
-      if self.is_a? Processor
+      if Processor === self
         @name = value
       else
         option :name, value
@@ -379,7 +379,7 @@ module Extensions
     # QUESTION perhaps include a SyntaxDsl?
 
     def named value
-      if self.is_a? Processor
+      if Processor === self
         @name = value
       else
         option :name, value
@@ -803,7 +803,7 @@ module Extensions
     def docinfo_processors? location = nil
       if @docinfo_processor_extensions
         if location
-          @docinfo_processor_extensions.find {|ext| ext.config[:location] == location }
+          @docinfo_processor_extensions.any? {|ext| ext.config[:location] == location }
         else
           true
         end
@@ -1133,7 +1133,7 @@ module Extensions
       else
         processor, config = resolve_args args, 2
         # style 2: specified as class or class name
-        if (processor.is_a? ::Class) || ((processor.is_a? ::String) && (processor = Extensions.class_for_name processor))
+        if ::Class === processor || (::String === processor && (processor = Extensions.class_for_name processor))
           unless processor < kind_class || (kind_java_class && processor < kind_java_class)
             raise ::ArgumentError.new %(Invalid type for #{kind_name} extension: #{processor})
           end
@@ -1141,7 +1141,7 @@ module Extensions
           processor_instance.freeze
           ProcessorExtension.new kind, processor_instance
         # style 3: specified as instance
-        elsif (processor.is_a? kind_class) || (kind_java_class && (processor.is_a? kind_java_class))
+        elsif kind_class === processor || (kind_java_class && kind_java_class === processor)
           processor.update_config config
           processor.freeze
           ProcessorExtension.new kind, processor
@@ -1190,7 +1190,7 @@ module Extensions
       else
         processor, name, config = resolve_args args, 3
         # style 2: specified as class or class name
-        if (processor.is_a? ::Class) || ((processor.is_a? ::String) && (processor = Extensions.class_for_name processor))
+        if ::Class === processor || (::String === processor && (processor = Extensions.class_for_name processor))
           unless processor < kind_class || (kind_java_class && processor < kind_java_class)
             raise ::ArgumentError.new %(Class specified for #{kind_name} extension does not inherit from #{kind_class}: #{processor})
           end
@@ -1201,7 +1201,7 @@ module Extensions
           processor.freeze
           kind_store[name] = ProcessorExtension.new kind, processor_instance
         # style 3: specified as instance
-        elsif (processor.is_a? kind_class) || (kind_java_class && (processor.is_a? kind_java_class))
+        elsif kind_class === processor || (kind_java_class && kind_java_class === processor)
           processor.update_config config
           # TODO need a test for this override!
           unless (name = name ? (processor.name = as_symbol name) : (as_symbol processor.name))
@@ -1216,7 +1216,7 @@ module Extensions
     end
 
     def resolve_args args, expect
-      opts = (args[-1].is_a? ::Hash) ? args.pop : {}
+      opts = ::Hash === args[-1] ? args.pop : {}
       return opts if expect == 1
       num_args = args.size
       if (missing = expect - 1 - num_args) > 0
@@ -1229,7 +1229,7 @@ module Extensions
     end
 
     def as_symbol name
-      name ? ((name.is_a? ::Symbol) ? name : name.to_sym) : nil
+      name ? name.to_sym : nil
     end
   end
 
@@ -1323,7 +1323,7 @@ module Extensions
 
     # unused atm, but tested
     def resolve_class object
-      (object.is_a? ::Class) ? object : (class_for_name object.to_s)
+      ::Class === object ? object : (class_for_name object.to_s)
     end
 
     # Public: Resolves the Class object for the qualified name.