asciidoctor 1.5.5 → 1.5.6

data/lib/asciidoctor/converter/manpage.rb

@@ -10,7 +10,7 @@ module Asciidoctor
     TAB = %(\t)
     WHITESPACE = %(#{LF}#{TAB} )
     ET = ' ' * 8
-    ESC = %(\u001b)      # troff leader marker
+    ESC = %(\u001b) # troff leader marker
     ESC_BS = %(#{ESC}\\) # escaped backslash (indicates troff formatting sequence)
     ESC_FS = %(#{ESC}.)  # escaped full stop (indicates troff macro)
 
@@ -60,6 +60,7 @@ module Asciidoctor
         gsub('\'', '\(aq').       # apostrophe-quote
         gsub(MockBoundaryRx, ''). # mock boundary
         gsub(ESC_BS, '\\').       # unescape troff backslash (NOTE update if more escapes are added)
+        gsub(ESC_FS, '.').        # unescape full stop in troff commands (NOTE must take place after gsub(LeadingPeriodRx))
         rstrip                    # strip trailing space
       opts[:append_newline] ? %(#{str}#{LF}) : str
     end
@@ -159,13 +160,10 @@ Author(s).
     end
 
     def section node
-      slevel = node.level
-      # QUESTION should the check for slevel be done in section?
-      slevel = 1 if slevel == 0 && node.special
       result = []
-      if slevel > 1
+      if node.level > 1
         macro = 'SS'
-        # QUESTION why captioned title? why not for slevel == 1?
+        # QUESTION why captioned title? why not when level == 1?
         stitle = node.captioned_title
       else
         macro = 'SH'
@@ -187,7 +185,7 @@ Author(s).
 .nr an-break-flag 1
 .br
 .ps +1
-.B #{node.caption}#{node.title? ? "\\fP #{manify node.title}" : nil}
+.B #{node.attr 'textlabel'}#{node.title? ? "\\fP: #{manify node.title}" : nil}
 .ps -1
 .br
 #{resolve_content node}
@@ -196,7 +194,7 @@ Author(s).
       result * LF
     end
 
-    alias :audio :skip_with_warning
+    alias audio skip_with_warning
 
     def colist node
       result = []
@@ -207,10 +205,12 @@ Author(s).
 tab(:);
 r lw(\n(.lu*75u/100u).'
 
-      node.items.each_with_index do |item, index|
-        result << %(\\fB(#{index + 1})\\fP\\h'-2n':T{
-#{manify item.text}
-T})
+      num = 0
+      node.items.each do |item|
+        result << %(\\fB(#{num += 1})\\fP\\h'-2n':T{)
+        result << (manify item.text)
+        result << item.content if item.blocks?
+        result << 'T}'
       end
       result << '.TE'
       result * LF
@@ -226,11 +226,11 @@ T})
         case node.style
         when 'qanda'
           result << %(.sp
-#{counter}. #{manify([*terms].map {|dt| dt.text }.join ' ')}
+#{counter}. #{manify([*terms].map {|dt| dt.text } * ' ')}
 .RS 4)
         else
           result << %(.sp
-#{manify([*terms].map {|dt| dt.text }.join ', ')}
+#{manify([*terms].map {|dt| dt.text } * ', ')}
 .RS 4)
         end
         if dd
@@ -257,7 +257,7 @@ T})
       %(.SS "#{manify node.title}")
     end
 
-    alias :image :skip_with_warning
+    alias image skip_with_warning
 
     def listing node
       result = []
@@ -328,7 +328,7 @@ T})
     end
 
     # TODO use Page Control https://www.gnu.org/software/groff/manual/html_node/Page-Control.html#Page-Control
-    alias :page_break :skip
+    alias page_break skip
 
     def paragraph node
       if node.title?
@@ -342,7 +342,7 @@ T})
       end
     end
 
-    alias :preamble :content
+    alias preamble content
 
     def quote node
       result = []
@@ -373,7 +373,7 @@ T})
       result * LF
     end
 
-    alias :sidebar :skip_with_warning
+    alias sidebar skip_with_warning
 
     def stem node
       title_element = node.title? ? %(.sp
@@ -402,15 +402,16 @@ T})
 .nr an-no-space-flag 1
 .nr an-break-flag 1
 .br
-.B #{manify node.captioned_title})
+.B #{manify node.captioned_title}
+)
       end
       result << '.TS
 allbox tab(:);'
       row_header = []
       row_text = []
       row_index = 0
-      [:head, :body, :foot].each do |tsec|
-        node.rows[tsec].each do |row|
+      node.rows.by_section.each do |tsec, rows|
+        rows.each do |row|
           row_header[row_index] ||= []
           row_text[row_index] ||= []
           # result << LF
@@ -430,19 +431,17 @@ allbox tab(:);'
               row_text[row_index] << %(T{#{LF}.sp#{LF}T}:)
             end
             row_text[row_index] << %(T{#{LF}.sp#{LF})
-            cell_halign = (cell.attr 'halign', 'left')[0..0]
+            cell_halign = (cell.attr 'halign', 'left').chr
             if tsec == :head
-              if row_header[row_index].empty? ||
-                 row_header[row_index][cell_index].empty?
+              if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
                 row_header[row_index][cell_index] << %(#{cell_halign}tB)
               else
                 row_header[row_index][cell_index + 1] ||= []
                 row_header[row_index][cell_index + 1] << %(#{cell_halign}tB)
               end
-              row_text[row_index] << %(#{cell.text}#{LF})
+              row_text[row_index] << %(#{manify cell.text}#{LF})
             elsif tsec == :body
-              if row_header[row_index].empty? ||
-                 row_header[row_index][cell_index].empty?
+              if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
                 row_header[row_index][cell_index] << %(#{cell_halign}t)
               else
                 row_header[row_index][cell_index + 1] ||= []
@@ -451,26 +450,26 @@ allbox tab(:);'
               case cell.style
               when :asciidoc
                 cell_content = cell.content
-              when :verse, :literal
-                cell_content = cell.text
+              when :literal
+                cell_content = %(.nf#{LF}#{manify cell.text}#{LF}.fi)
+              when :verse
+                cell_content = %(.nf#{LF}#{manify cell.text}#{LF}.fi)
               else
-                cell_content = cell.content.join
+                cell_content = manify cell.content.join
               end
               row_text[row_index] << %(#{cell_content}#{LF})
             elsif tsec == :foot
-              if row_header[row_index].empty? ||
-                 row_header[row_index][cell_index].empty?
+              if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
                 row_header[row_index][cell_index] << %(#{cell_halign}tB)
               else
                 row_header[row_index][cell_index + 1] ||= []
                 row_header[row_index][cell_index + 1] << %(#{cell_halign}tB)
               end
-              row_text[row_index] << %(#{cell.text}#{LF})
+              row_text[row_index] << %(#{manify cell.text}#{LF})
             end
             if cell.colspan && cell.colspan > 1
               (cell.colspan - 1).times do |i|
-                if row_header[row_index].empty? ||
-                   row_header[row_index][cell_index].empty?
+                if row_header[row_index].empty? || row_header[row_index][cell_index].empty?
                   row_header[row_index][cell_index + i] << 'st'
                 else
                   row_header[row_index][cell_index + 1 + i] ||= []
@@ -481,8 +480,7 @@ allbox tab(:);'
             if cell.rowspan && cell.rowspan > 1
               (cell.rowspan - 1).times do |i|
                 row_header[row_index + 1 + i] ||= []
-                if row_header[row_index + 1 + i].empty? ||
-                   row_header[row_index + 1 + i][cell_index].empty?
+                if row_header[row_index + 1 + i].empty? || row_header[row_index + 1 + i][cell_index].empty?
                   row_header[row_index + 1 + i][cell_index] ||= []
                   row_header[row_index + 1 + i][cell_index] << '^t'
                 else
@@ -498,19 +496,19 @@ allbox tab(:);'
             end
           end
           row_index += 1
-        end
+        end unless rows.empty?
       end
 
       #row_header.each do |row|
       #  result << LF
       #  row.each_with_index do |cell, i|
-      #    result << (cell.join ' ')
+      #    result << (cell * ' ')
       #    result << ' ' if row.size > i + 1
       #  end
       #end
       # FIXME temporary fix to get basic table to display
       result << LF
-      result << row_header.first.map {|r| 'lt'}.join(' ')
+      result << row_header[0].map { 'lt' } * ' '
 
       result << %(.#{LF})
       row_text.each do |row|
@@ -526,7 +524,7 @@ allbox tab(:);'
 \l\'\n(.lu*25u/100u\(ap\''
     end
 
-    alias :toc :skip
+    alias toc skip
 
     def ulist node
       result = []
@@ -578,8 +576,12 @@ allbox tab(:);'
     def video node
       start_param = (node.attr? 'start', nil, false) ? %(&start=#{node.attr 'start'}) : nil
       end_param = (node.attr? 'end', nil, false) ? %(&end=#{node.attr 'end'}) : nil
-      %(.sp
-#{manify node.captioned_title} (video) <#{node.media_uri(node.attr 'target')}#{start_param}#{end_param}>)
+      result = []
+      result << %(.sp
+.B #{manify node.title}
+.br) if node.title?
+      result << %(<#{node.media_uri(node.attr 'target')}#{start_param}#{end_param}> (video))
+      result * LF
     end
 
     def inline_anchor node
@@ -600,9 +602,9 @@ allbox tab(:);'
         %(#{ESC_BS}c#{LF}#{ESC_FS}#{macro} "#{target}" "#{text}" )
       when :xref
         refid = (node.attr 'refid') || target
-        node.text || (node.document.references[:ids][refid] || %([#{refid}]))
+        node.text || (node.document.catalog[:ids][refid] || %([#{refid}]))
       when :ref, :bibref
-        # These are anchor points, which shouldn't be visual
+        # These are anchor points, which shouldn't be visible
         ''
       else
         warn %(asciidoctor: WARNING: unknown anchor type: #{node.type.inspect})
@@ -610,8 +612,7 @@ allbox tab(:);'
     end
 
     def inline_break node
-      %(#{node.text}
-.br)
+      %(#{node.text}#{LF}#{ESC_FS}br)
     end
 
     def inline_button node
@@ -632,9 +633,7 @@ allbox tab(:);'
     end
 
     def inline_image node
-      # NOTE alt should always be set
-      alt_text = (node.attr? 'alt') ? (node.attr 'alt') : node.target
-      (node.attr? 'link') ? %([#{alt_text}] <#{node.attr 'link'}>) : %([#{alt_text}])
+      (node.attr? 'link') ? %([#{node.alt}] <#{node.attr 'link'}>) : %([#{node.alt}])
     end
 
     def inline_indexterm node
@@ -645,7 +644,7 @@ allbox tab(:);'
       if (keys = node.attr 'keys').size == 1
         keys[0]
       else
-        keys.join %(#{ESC_BS}0+#{ESC_BS}0)
+        keys * %(#{ESC_BS}0+#{ESC_BS}0)
       end
     end
 
@@ -653,7 +652,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) }.join caret
+        submenu_path = submenus.map {|item| %(#{ESC_BS}fI#{item}#{ESC_BS}fP) } * 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)

data/lib/asciidoctor/converter/template.rb

@@ -5,9 +5,9 @@ module Asciidoctor
   # {AbstractNode} objects from a parsed AsciiDoc document tree to the backend
   # format.
   #
-  # The converter scans the provided directories for template files that are
+  # The converter scans the specified directories for template files that are
   # supported by Tilt. If an engine name (e.g., "slim") is specified in the
-  # options Hash passed to the constructor, the scan is limited to template
+  # options Hash passed to the constructor, the scan is restricted to template
   # files that have a matching extension (e.g., ".slim"). The scanner trims any
   # extensions from the basename of the file and uses the resulting name as the
   # key under which to store the template. When the {Converter#convert} method
@@ -15,20 +15,21 @@ module Asciidoctor
   # table and use it to convert the node.
   #
   # For example, the template file "path/to/templates/paragraph.html.slim" will
-  # be registered as the "paragraph" transform. The template would then be used
-  # to convert a paragraph {Block} object from the parsed AsciiDoc tree to an
-  # HTML backend format (e.g., "html5").
+  # be registered as the "paragraph" transform. The template is then used to
+  # convert a paragraph {Block} object from the parsed AsciiDoc tree to an HTML
+  # 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
-  # safe. If this gem is not present, they are not and a warning is issued.
+  # safe. If this gem is not present, there is no such guarantee and a warning
+  # will be issued.
   class Converter::TemplateConverter < Converter::Base
     DEFAULT_ENGINE_OPTIONS = {
       :erb =>  { :trim => '<' },
       # TODO line 466 of haml/compiler.rb sorts the attributes; file an issue to make this configurable
       # NOTE AsciiDoc syntax expects HTML/XML output to use double quotes around attribute values
-      :haml => { :format => :xhtml, :attr_wrapper => '"', :ugly => true, :escape_attrs => false },
+      :haml => { :format => :xhtml, :attr_wrapper => '"', :escape_attrs => false, :ugly => true },
       :slim => { :disable_escape => true, :sort_attrs => false, :pretty => false }
     }
 
@@ -58,6 +59,7 @@ module Asciidoctor
       @template_dirs = template_dirs
       @eruby = opts[:eruby]
       @safe = opts[:safe]
+      @active_engines = {}
       @engine = opts[:template_engine]
       @engine_options = DEFAULT_ENGINE_OPTIONS.inject({}) do |accum, (engine, default_opts)|
         accum[engine] = default_opts.dup
@@ -67,6 +69,7 @@ module Asciidoctor
         @engine_options[:haml][:format] = :html5
         @engine_options[:slim][:format] = :html
       end
+      @engine_options[:slim][:include_dirs] = template_dirs.reverse.map {|dir| ::File.expand_path dir }
       if (overrides = opts[:template_engine_options])
         overrides.each do |engine, override_opts|
           (@engine_options[engine] ||= {}).update override_opts
@@ -208,7 +211,7 @@ module Asciidoctor
     #
     # Returns a [Hash] of Tilt template objects keyed by template name.
     def templates
-      @templates.dup.freeze
+      @templates.dup
     end
 
     # Public: Registers a Tilt template with this converter.
@@ -231,45 +234,53 @@ module Asciidoctor
     #
     # Returns the scan result as a [Hash]
     def scan_dir template_dir, pattern, template_cache = nil
-      result = {}
-      eruby_loaded = nil
+      result, helpers = {}, nil
       # Grab the files in the top level of the directory (do not recurse)
       ::Dir.glob(pattern).select {|match| ::File.file? match }.each do |file|
-        if (basename = ::File.basename file) == 'helpers.rb' || (path_segments = basename.split '.').size < 2
+        if (basename = ::File.basename file) == 'helpers.rb'
+          helpers = file
+          next
+        elsif (path_segments = basename.split '.').size < 2
           next
         end
-        # TODO we could derive the basebackend from the minor extension of the template file
-        #name, *rest, ext_name = *path_segments # this form only works in Ruby >= 1.9
-        name = path_segments[0]
-        if name == 'block_ruler'
+        if (name = path_segments[0]) == 'block_ruler'
           name = 'thematic_break'
         elsif name.start_with? 'block_'
-          name = name[6..-1]
-        end
-        
-        template_class = ::Tilt
-        extra_engine_options = {}
-        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'
-        when 'erb'
-          template_class, extra_engine_options = (eruby_loaded ||= load_eruby(@eruby))
-        when 'rb'
-          next
-        else
-          next unless ::Tilt.registered? ext_name
+          name = name.slice 6, name.length
         end
         unless template_cache && (template = template_cache[file])
-          template = template_class.new file, 1, (@engine_options[ext_name.to_sym] || {}).merge(extra_engine_options)
+          template_class, extra_engine_options, extsym = ::Tilt, {}, path_segments[-1].to_sym
+          case extsym
+          when :slim
+            unless @active_engines[extsym]
+              # NOTE slim doesn't get automatically loaded by Tilt
+              Helpers.require_library 'slim' unless defined? ::Slim
+              # 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'
+              # load include plugin when using Slim >= 2.1
+              require 'slim/include' unless (defined? ::Slim::Include) || ::Slim::VERSION < '2.1'
+              @active_engines[extsym] = true
+            end
+          when :haml
+            unless @active_engines[extsym]
+              Helpers.require_library 'haml' unless defined? ::Haml
+              # NOTE Haml 5 dropped support for pretty printing
+              @engine_options[extsym].delete :ugly if defined? ::Haml::TempleEngine
+              @active_engines[extsym] = true
+            end
+          when :erb
+            template_class, extra_engine_options = (@active_engines[extsym] ||= (load_eruby @eruby))
+          when :rb
+            next
+          else
+            next unless ::Tilt.registered? extsym.to_s
+          end
+          template = template_class.new file, 1, (@engine_options[extsym] ||= {}).merge(extra_engine_options)
         end
         result[name] = template
       end
-      if ::File.file?(helpers = (::File.join template_dir, 'helpers.rb'))
+      if helpers || ::File.file?(helpers = (::File.join template_dir, 'helpers.rb'))
         require helpers
       end
       result

data/lib/asciidoctor/core_ext.rb

@@ -1,8 +1,14 @@
 require 'asciidoctor/core_ext/nil_or_empty'
+require 'asciidoctor/core_ext/regexp/is_match'
 if RUBY_MIN_VERSION_1_9
-  require 'asciidoctor/core_ext/string/limit'
+  require 'asciidoctor/core_ext/string/limit_bytesize'
+  require 'asciidoctor/core_ext/1.8.7/io/write' if RUBY_ENGINE == 'opal'
 elsif RUBY_ENGINE != 'opal'
+  require 'asciidoctor/core_ext/1.8.7/hash/key'
+  require 'asciidoctor/core_ext/1.8.7/io/binread'
+  require 'asciidoctor/core_ext/1.8.7/io/write'
   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/string/limit_bytesize'
+  require 'asciidoctor/core_ext/1.8.7/symbol/empty'
   require 'asciidoctor/core_ext/1.8.7/symbol/length'
 end