asciidoctor 1.5.7.1 → 1.5.8

data/lib/asciidoctor/converter/manpage.rb

@@ -20,6 +20,7 @@ module Asciidoctor
     MockBoundaryRx = /<\/?BOUNDARY>/
     EmDashCharRefRx = /&#8212;(?:&#8203;)?/
     EllipsisCharRefRx = /&#8230;(?:&#8203;)?/
+    WrappedIndentRx = /#{CG_BLANK}*#{LF}#{CG_BLANK}*/
 
     # Converts HTML entity references back to their original form, escapes
     # special man characters and strips trailing whitespace.
@@ -28,11 +29,21 @@ module Asciidoctor
     #
     # str  - the String to convert
     # opts - an Hash of options to control processing (default: {})
-    #        * :preserve_space a Boolean that indicates whether to preserve spaces (only expanding tabs) if true
-    #          or to collapse all adjacent whitespace to a single space if false (default: true)
+    #        * :whitespace an enum that indicates how to handle whitespace; supported options are:
+    #          :preserve - preserve spaces (only expanding tabs); :normalize - normalize whitespace
+    #          (remove spaces around newlines); :collapse - collapse adjacent whitespace to a single
+    #          space (default: :collapse)
     #        * :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, ' ')).
+      case opts.fetch :whitespace, :collapse
+      when :preserve
+        str = str.gsub TAB, ET
+      when :normalize
+        str = str.gsub WrappedIndentRx, LF
+      else
+        str = str.tr_s WHITESPACE, ' '
+      end
+      str = str.
         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
@@ -78,6 +89,8 @@ module Asciidoctor
       mantitle = node.attr 'mantitle'
       manvolnum = node.attr 'manvolnum', '1'
       manname = node.attr 'manname', mantitle
+      manmanual = node.attr 'manmanual'
+      mansource = node.attr 'mansource'
       docdate = (node.attr? 'reproducible') ? nil : (node.attr 'docdate')
       # NOTE the first line enables the table (tbl) preprocessor, necessary for non-Linux systems
       result = [%('\\" t
@@ -85,12 +98,12 @@ module Asciidoctor
 .\\"    Author: #{(node.attr? 'authors') ? (node.attr 'authors') : '[see the "AUTHOR(S)" section]'}
 .\\" Generator: Asciidoctor #{node.attr 'asciidoctor-version'})]
       result << %(.\\"      Date: #{docdate}) if docdate
-      result << %(.\\"    Manual: #{(manual = node.attr 'manmanual') || '\ \&'}
-.\\"    Source: #{(source = node.attr 'mansource') || '\ \&'}
+      result << %(.\\"    Manual: #{manmanual ? (manmanual.tr_s WHITESPACE, ' ') : '\ \&'}
+.\\"    Source: #{mansource ? (mansource.tr_s WHITESPACE, ' ') : '\ \&'}
 .\\"  Language: English
 .\\")
       # TODO add document-level setting to disable capitalization of manname
-      result << %(.TH "#{manify manname.upcase}" "#{manvolnum}" "#{docdate}" "#{source ? (manify source) : '\ \&'}" "#{manual ? (manify manual) : '\ \&'}")
+      result << %(.TH "#{manify manname.upcase}" "#{manvolnum}" "#{docdate}" "#{mansource ? (manify mansource) : '\ \&'}" "#{manmanual ? (manify manmanual) : '\ \&'}")
       # define portability settings
       # see http://bugs.debian.org/507673
       # see http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
@@ -131,8 +144,8 @@ module Asciidoctor
       unless node.noheader
         if node.attr? 'manpurpose'
           mannames = node.attr 'mannames', [manname]
-          result << %(.SH "#{(node.attr 'manname-title').upcase}"
-#{mannames.map {|n| manify n } * ', '} \\- #{manify node.attr 'manpurpose'})
+          result << %(.SH "#{(node.attr 'manname-title', 'NAME').upcase}"
+#{mannames.map {|n| manify n }.join ', '} \\- #{manify node.attr('manpurpose'), :whitespace => :normalize})
         end
       end
 
@@ -144,22 +157,21 @@ module Asciidoctor
         result.concat(node.footnotes.map {|fn| %(#{fn.index}. #{fn.text}) })
       end
 
-      # FIXME we really need an API that returns the authors as an array
-      if (num_authors = (node.attr 'authorcount') || 0) > 0
-        if num_authors == 1
-          result << %(.SH "AUTHOR"
-.sp
-#{node.attr 'author'})
-        else
+      unless (authors = node.authors).empty?
+        if authors.size > 1
           result << '.SH "AUTHORS"'
-          (1.upto num_authors).each do |i|
+          authors.each do |author|
             result << %(.sp
-#{node.attr "author_#{i}"})
+#{author.name})
           end
+        else
+          result << %(.SH "AUTHOR"
+.sp
+#{authors[0].name})
         end
       end
 
-      result * LF
+      result.join LF
     end
 
     # NOTE embedded doesn't really make sense in the manpage backend
@@ -173,7 +185,7 @@ module Asciidoctor
 
       # QUESTION should we add an AUTHOR(S) section?
 
-      result * LF
+      result.join LF
     end
 
     def section node
@@ -188,7 +200,7 @@ module Asciidoctor
       end
       result << %(.#{macro} "#{manify stitle}"
 #{node.content})
-      result * LF
+      result.join LF
     end
 
     def admonition node
@@ -206,7 +218,7 @@ module Asciidoctor
 #{resolve_content node}
 .sp .5v
 .RE)
-      result * LF
+      result.join LF
     end
 
     alias audio skip_with_warning
@@ -223,12 +235,12 @@ r lw(\n(.lu*75u/100u).'
       num = 0
       node.items.each do |item|
         result << %(\\fB(#{num += 1})\\fP\\h'-2n':T{)
-        result << (manify item.text)
+        result << (manify item.text, :whitespace => :normalize)
         result << item.content if item.blocks?
         result << 'T}'
       end
       result << '.TE'
-      result * LF
+      result.join LF
     end
 
     # TODO implement horizontal (if it makes sense)
@@ -243,20 +255,20 @@ r lw(\n(.lu*75u/100u).'
         case node.style
         when 'qanda'
           result << %(.sp
-#{counter}. #{manify([*terms].map {|dt| dt.text } * ' ')}
+#{counter}. #{manify [*terms].map {|dt| dt.text }.join ' '}
 .RS 4)
         else
           result << %(.sp
-#{manify([*terms].map {|dt| dt.text } * ', ')}
+#{manify [*terms].map {|dt| dt.text }.join(', '), :whitespace => :normalize}
 .RS 4)
         end
         if dd
-          result << (manify dd.text) if dd.text?
+          result << (manify dd.text, :whitespace => :normalize) if dd.text?
           result << dd.content if dd.blocks?
         end
         result << '.RE'
       end
-      result * LF
+      result.join LF
     end
 
     def example node
@@ -267,7 +279,7 @@ r lw(\n(.lu*75u/100u).'
       result << %(.RS 4
 #{resolve_content node}
 .RE)
-      result * LF
+      result.join LF
     end
 
     def floating_title node
@@ -284,10 +296,10 @@ r lw(\n(.lu*75u/100u).'
       result << %(.sp
 .if n .RS 4
 .nf
-#{manify node.content}
+#{manify node.content, :whitespace => :preserve}
 .fi
 .if n .RE)
-      result * LF
+      result.join LF
     end
 
     def literal node
@@ -298,10 +310,10 @@ r lw(\n(.lu*75u/100u).'
       result << %(.sp
 .if n .RS 4
 .nf
-#{manify node.content}
+#{manify node.content, :whitespace => :preserve}
 .fi
 .if n .RE)
-      result * LF
+      result.join LF
     end
 
     def olist node
@@ -320,11 +332,11 @@ r lw(\n(.lu*75u/100u).'
 .  sp -1
 .  IP " #{idx + 1}." 4.2
 .\\}
-#{manify item.text})
+#{manify item.text, :whitespace => :normalize})
         result << item.content if item.blocks?
         result << '.RE'
       end
-      result * LF
+      result.join LF
     end
 
     def open node
@@ -344,10 +356,10 @@ r lw(\n(.lu*75u/100u).'
         %(.sp
 .B #{manify node.title}
 .br
-#{manify node.content})
+#{manify node.content, :whitespace => :normalize})
       else
         %(.sp
-#{manify node.content})
+#{manify node.content, :whitespace => :normalize})
       end
     end
 
@@ -357,29 +369,27 @@ r lw(\n(.lu*75u/100u).'
       result = []
       if node.title?
         result << %(.sp
-.in +.3i
+.RS 3
 .B #{manify node.title}
 .br
-.in)
+.RE)
       end
       attribution_line = (node.attr? 'citetitle') ? %(#{node.attr 'citetitle'} ) : nil
       attribution_line = (node.attr? 'attribution') ? %[#{attribution_line}\\(em #{node.attr 'attribution'}] : nil
-      result << %(.in +.3i
-.ll -.3i
-.nf
+      result << %(.RS 3
+.ll -.6i
 #{resolve_content node}
-.fi
 .br
-.in
+.RE
 .ll)
       if attribution_line
-        result << %(.in +.5i
-.ll -.5i
+        result << %(.RS 5
+.ll -.10i
 #{attribution_line}
-.in
+.RE
 .ll)
       end
-      result * LF
+      result.join LF
     end
 
     alias sidebar skip_with_warning
@@ -448,7 +458,7 @@ allbox tab(:);'
                 row_header[row_index][cell_index + 1] ||= []
                 row_header[row_index][cell_index + 1] << %(#{cell_halign}tB)
               end
-              row_text[row_index] << %(#{manify cell.text}#{LF})
+              row_text[row_index] << %(#{manify cell.text, :whitespace => :normalize}#{LF})
             elsif tsec == :body
               if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
                 row_header[row_index][cell_index] << %(#{cell_halign}t)
@@ -460,11 +470,11 @@ allbox tab(:);'
               when :asciidoc
                 cell_content = cell.content
               when :literal
-                cell_content = %(.nf#{LF}#{manify cell.text}#{LF}.fi)
+                cell_content = %(.nf#{LF}#{manify cell.text, :whitespace => :preserve}#{LF}.fi)
               when :verse
-                cell_content = %(.nf#{LF}#{manify cell.text}#{LF}.fi)
+                cell_content = %(.nf#{LF}#{manify cell.text, :whitespace => :preserve}#{LF}.fi)
               else
-                cell_content = manify cell.content.join
+                cell_content = manify cell.content.join, :whitespace => :normalize
               end
               row_text[row_index] << %(#{cell_content}#{LF})
             elsif tsec == :foot
@@ -474,7 +484,7 @@ allbox tab(:);'
                 row_header[row_index][cell_index + 1] ||= []
                 row_header[row_index][cell_index + 1] << %(#{cell_halign}tB)
               end
-              row_text[row_index] << %(#{manify cell.text}#{LF})
+              row_text[row_index] << %(#{manify cell.text, :whitespace => :normalize}#{LF})
             end
             if cell.colspan && cell.colspan > 1
               (cell.colspan - 1).times do |i|
@@ -511,13 +521,13 @@ allbox tab(:);'
       #row_header.each do |row|
       #  result << LF
       #  row.each_with_index do |cell, i|
-      #    result << (cell * ' ')
+      #    result << (cell.join ' ')
       #    result << ' ' if row.size > i + 1
       #  end
       #end
       # FIXME temporary fix to get basic table to display
       result << LF
-      result << row_header[0].map { 'lt' } * ' '
+      result << ('lt ' * row_header[0].size).chop
 
       result << %(.#{LF})
       row_text.each do |row|
@@ -550,11 +560,11 @@ allbox tab(:);'
 .  sp -1
 .  IP \\(bu 2.3
 .\\}
-#{manify item.text}]
+#{manify item.text, :whitespace => :normalize}]
         result << item.content if item.blocks?
         result << '.RE'
       }
-      result * LF
+      result.join LF
     end
 
     # FIXME git uses [verse] for the synopsis; detect this special case
@@ -569,7 +579,7 @@ allbox tab(:);'
       attribution_line = (node.attr? 'attribution') ? %[#{attribution_line}\\(em #{node.attr 'attribution'}] : nil
       result << %(.sp
 .nf
-#{manify node.content}
+#{manify node.content, :whitespace => :preserve}
 .fi
 .br)
       if attribution_line
@@ -579,7 +589,7 @@ allbox tab(:);'
 .in
 .ll)
       end
-      result * LF
+      result.join LF
     end
 
     def video node
@@ -590,7 +600,7 @@ allbox tab(:);'
 .B #{manify node.title}
 .br) if node.title?
       result << %(<#{node.media_uri(node.attr 'target')}#{start_param}#{end_param}> (video))
-      result * LF
+      result.join LF
     end
 
     def inline_anchor node
@@ -655,7 +665,7 @@ allbox tab(:);'
       if (keys = node.attr 'keys').size == 1
         keys[0]
       else
-        keys * %(#{ESC_BS}0+#{ESC_BS}0)
+        keys.join %(#{ESC_BS}0+#{ESC_BS}0)
       end
     end
 
@@ -663,7 +673,7 @@ allbox tab(:);'
       caret = %[#{ESC_BS}0#{ESC_BS}(fc#{ESC_BS}0]
       menu = node.attr 'menu'
       if !(submenus = node.attr 'submenus').empty?
-        submenu_path = submenus.map {|item| %(#{ESC_BS}fI#{item}#{ESC_BS}fP) } * caret
+        submenu_path = submenus.map {|item| %(#{ESC_BS}fI#{item}#{ESC_BS}fP) }.join caret
         %(#{ESC_BS}fI#{menu}#{ESC_BS}fP#{caret}#{submenu_path}#{caret}#{ESC_BS}fI#{node.attr 'menuitem'}#{ESC_BS}fP)
       elsif (menuitem = node.attr 'menuitem')
         %(#{ESC_BS}fI#{menu}#{caret}#{menuitem}#{ESC_BS}fP)
@@ -691,7 +701,7 @@ allbox tab(:);'
     end
 
     def resolve_content node
-      node.content_model == :compound ? node.content : %(.sp#{LF}#{manify node.content})
+      node.content_model == :compound ? node.content : %(.sp#{LF}#{manify node.content, :whitespace => :normalize})
     end
 
     def write_alternate_pages mannames, manvolnum, target

data/lib/asciidoctor/converter/template.rb

@@ -20,8 +20,8 @@ module Asciidoctor
   # backend format (e.g., "html5").
   #
   # As an optimization, scan results and templates are cached for the lifetime
-  # of the Ruby process. If the {https://rubygems.org/gems/thread_safe
-  # thread_safe} gem is installed, these caches are guaranteed to be thread
+  # of the Ruby process. If the {https://rubygems.org/gems/concurrent-ruby
+  # concurrent-ruby} gem is installed, these caches are guaranteed to be thread
   # safe. If this gem is not present, there is no such guarantee and a warning
   # will be issued.
   class Converter::TemplateConverter < Converter::Base
@@ -33,10 +33,11 @@ module Asciidoctor
       :slim => { :disable_escape => true, :sort_attrs => false, :pretty => false }
     }
 
-    # QUESTION are we handling how we load the thread_safe support correctly?
     begin
-      require 'thread_safe' unless defined? ::ThreadSafe
-      @caches = { :scans => ::ThreadSafe::Cache.new, :templates => ::ThreadSafe::Cache.new }
+      unless defined? ::Concurrent::Hash
+        require ::RUBY_MIN_VERSION_1_9 ? 'concurrent/hash' : 'asciidoctor/core_ext/1.8.7/concurrent/hash'
+      end
+      @caches = { :scans => ::Concurrent::Hash.new, :templates => ::Concurrent::Hash.new }
     rescue ::LoadError
       @caches = { :scans => {}, :templates => {} }
     end
@@ -75,7 +76,7 @@ module Asciidoctor
       end
       case opts[:template_cache]
       when true
-        logger.warn 'gem \'thread_safe\' is not installed. This gem is recommended when using the built-in template cache.' unless defined? ::ThreadSafe
+        logger.warn 'gem \'concurrent-ruby\' is not installed. This gem is recommended when using the built-in template cache.' unless defined? ::Concurrent::Hash
         @caches = self.class.caches
       when ::Hash
         @caches = opts[:template_cache]
@@ -255,6 +256,7 @@ module Asciidoctor
             unless @active_engines[extsym]
               # NOTE slim doesn't get automatically loaded by Tilt
               Helpers.require_library 'slim' unless defined? ::Slim
+              ::Slim::Engine.define_options :asciidoc => {}
               # align safe mode of AsciiDoc embedded in Slim template with safe mode of current document
               # NOTE safe mode won't get updated if using template cache and changing safe mode
               (@engine_options[extsym][:asciidoc] ||= {})[:safe] ||= @safe if @safe && ::Slim::VERSION >= '3.0'

data/lib/asciidoctor/core_ext/1.8.7/concurrent/hash.rb

@@ -0,0 +1,5 @@
+require 'thread_safe'
+
+module Concurrent
+  Hash = ::ThreadSafe::Cache
+end

data/lib/asciidoctor/document.rb

@@ -82,6 +82,10 @@ module Asciidoctor
 # can take the process to completion by calling the {Document#convert} method.
 class Document < AbstractBlock
 
+  ImageReference = ::Struct.new :target, :imagesdir do
+    alias to_s target
+  end
+
   Footnote = ::Struct.new :index, :id, :text
 
   class AttributeEntry
@@ -133,6 +137,9 @@ class Document < AbstractBlock
     end
   end
 
+  # Public: The Author class represents information about an author extracted from document attributes
+  Author = ::Struct.new :name, :firstname, :middlename, :lastname, :initials, :email
+
   # Public A read-only integer value indicating the level of security that
   # should be enforced while processing this document. The value must be
   # set in the Document constructor using the :safe option.
@@ -287,7 +294,7 @@ class Document < AbstractBlock
       (options[:attributes] || {}).each do |key, val|
         if key.end_with? '@'
           if key.start_with? '!'
-            key, val = (key.slice 1, key.length), false
+            key, val = (key.slice 1, key.length - 2), false
           elsif key.end_with? '!@'
             key, val = (key.slice 0, key.length - 2), false
           else
@@ -327,7 +334,7 @@ class Document < AbstractBlock
     end
 
     @parsed = false
-    @header = nil
+    @header = @header_attributes = nil
     @counters = {}
     @attributes_modified = ::Set.new
     @docinfo_processor_extensions = {}
@@ -493,14 +500,12 @@ class Document < AbstractBlock
       if (localdate = attrs['localdate'])
         localyear = (attrs['localyear'] ||= ((localdate.index '-') == 4 ? (localdate.slice 0, 4) : nil))
       else
-        localdate = attrs['localdate'] = (now.strftime '%Y-%m-%d')
+        localdate = attrs['localdate'] = (now.strftime '%F')
         localyear = (attrs['localyear'] ||= now.year.to_s)
       end
-      localtime = (attrs['localtime'] ||= begin
-          now.strftime '%H:%M:%S %Z'
-        rescue # Asciidoctor.js fails if timezone string has characters outside basic Latin (see asciidoctor.js#23)
-          now.strftime '%H:%M:%S %z'
-        end)
+      # %Z is OS dependent and may contain characters that aren't UTF-8 encoded (see asciidoctor#2770 and asciidoctor.js#23)
+      # Ruby 1.8 doesn't support %:z
+      localtime = (attrs['localtime'] ||= now.strftime %(%T #{now.utc_offset == 0 ? 'UTC' : '%z'}))
       attrs['localdatetime'] ||= %(#{localdate} #{localtime})
 
       # docdate, doctime and docdatetime should default to
@@ -643,7 +648,9 @@ class Document < AbstractBlock
     when :footnotes, :indexterms
       @catalog[type] << value
     else
-      @catalog[type] << value if @options[:catalog_assets]
+      if @options[:catalog_assets]
+        @catalog[type] << (type == :images ? (ImageReference.new value[0], value[1]) : value)
+      end
     end
   end
 
@@ -752,6 +759,27 @@ class Document < AbstractBlock
     @attributes['author']
   end
 
+  # Public: Convenience method to retrieve the authors of this document as an Array of Author objects.
+  #
+  # This method is backed by the author-related attributes on the document.
+  #
+  # returns the authors of this document as an Array
+  def authors
+    if (attrs = @attributes).key? 'author'
+      authors = [(Author.new attrs['author'], attrs['firstname'], attrs['middlename'], attrs['lastname'], attrs['authorinitials'], attrs['email'])]
+      if (num_authors = attrs['authorcount'] || 0) > 1
+        idx = 1
+        while idx < num_authors
+          idx += 1
+          authors << (Author.new attrs[%(author_#{idx})], attrs[%(firstname_#{idx})], attrs[%(middlename_#{idx})], attrs[%(lastname_#{idx})], attrs[%(authorinitials_#{idx})], attrs[%(email_#{idx})])
+        end
+      end
+      authors
+    else
+      []
+    end
+  end
+
   # Public: Convenience method to retrieve the document attribute 'revdate'
   #
   # returns the date of last revision for the document as a String
@@ -968,6 +996,27 @@ class Document < AbstractBlock
     @attribute_overrides.key?(name)
   end
 
+  # Public: Assign a value to the specified attribute in the document header.
+  #
+  # The assignment will be visible when the header attributes are restored,
+  # typically between processor phases (e.g., between parse and convert).
+  #
+  # name      - The String attribute name to assign
+  # value     - The Object value to assign to the attribute (default: '')
+  # overwrite - A Boolean indicating whether to assign the attribute
+  #             if already present in the attributes Hash (default: true)
+  #
+  # Returns a [Boolean] indicating whether the assignment was performed
+  def set_header_attribute name, value = '', overwrite = true
+    attrs = @header_attributes || @attributes
+    if overwrite == false && (attrs.key? name)
+      false
+    else
+      attrs[name] = value
+      true
+    end
+  end
+
   # Internal: Apply substitutions to the attribute value
   #
   # If the value is an inline passthrough macro (e.g., pass:<subs>[value]),
@@ -1168,11 +1217,14 @@ class Document < AbstractBlock
       @converter.write output, target
     else
       if target.respond_to? :write
+        # QUESTION should we set encoding using target.set_encoding?
         unless output.nil_or_empty?
           target.write output.chomp
           # ensure there's a trailing endline
           target.write LF
         end
+      elsif COERCE_ENCODING
+        ::IO.write target, output, :encoding => ::Encoding::UTF_8
       else
         ::IO.write target, output
       end
@@ -1265,7 +1317,7 @@ class Document < AbstractBlock
         content += @docinfo_processor_extensions[location].map {|ext| ext.process_method[self] }.compact
       end
 
-      content * LF
+      content.join LF
     end
   end