asciidoctor 1.5.3 → 1.5.4

data/bin/asciidoctor

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rubygems' unless defined? Gem
 
-if File.exist?(asciidoctor_lib_path = File.join(File.dirname(__FILE__), '../lib/asciidoctor'))
-  require asciidoctor_lib_path
+if File.exist?(asciidoctor = (File.expand_path '../../lib/asciidoctor', __FILE__))
+  require asciidoctor
 else
   require 'asciidoctor'
 end

data/bin/asciidoctor-safe

@@ -1,12 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'rubygems' if RUBY_VERSION < '1.9'
+require 'rubygems' unless defined? Gem
 
-require File.join File.dirname(__FILE__), '../lib/asciidoctor'
+if File.exist?(asciidoctor = (File.expand_path '../../lib/asciidoctor', __FILE__))
+  require asciidoctor
+else
+  require 'asciidoctor'
+end
 require 'asciidoctor/cli'
 
-options = Asciidoctor::Cli::Options.parse! ARGV
-options[:safe] = Asciidoctor::SafeMode::SAFE
-invoker = Asciidoctor::Cli::Invoker.new options
+invoker = Asciidoctor::Cli::Invoker.new(ARGV + ['-S', 'safe'])
+GC.start
 invoker.invoke!
 exit invoker.code

data/lib/asciidoctor.rb

@@ -105,12 +105,10 @@ module Asciidoctor
 
     # Defines a new compliance key and assigns an initial value.
     def self.define key, value
-      if key == :keys || (self.respond_to? key)
-        raise ::ArgumentError, %(illegal key name: #{key})
-      end
       instance_variable_set %(@#{key}), value
       class << self; self; end.send :attr_accessor, key
       @keys << key
+      nil
     end
 
     # AsciiDoc terminates paragraphs adjacent to
@@ -190,7 +188,7 @@ module Asciidoctor
 
   # Flag to indicate whether encoding can be coerced to UTF-8
   # _All_ input data must be force encoded to UTF-8 if Encoding.default_external is *not* UTF-8
-  # Addresses failures performing string operations that are reported as "invalid byte sequence in US-ASCII" 
+  # Addresses failures performing string operations that are reported as "invalid byte sequence in US-ASCII"
   # Ruby 1.8 doesn't seem to experience this problem (perhaps because it isn't validating the encodings)
   COERCE_ENCODING = !::RUBY_ENGINE_OPAL && ::RUBY_MIN_VERSION_1_9
 
@@ -424,7 +422,7 @@ module Asciidoctor
     #
     # Examples
     #
-    #   = asciidoctor ( 1 ) 
+    #   = asciidoctor ( 1 )
     #
     ManpageTitleVolnumRx = /^(.*)\((.*)\)$/
 
@@ -710,7 +708,7 @@ module Asciidoctor
     #
     # NOTE negative match for comment line is intentional since that isn't handled when looking for next list item
     # QUESTION should we check for line comment in regex or when scanning the lines?
-    # 
+    #
     DefinitionListRx = /^(?!\/\/)#{CG_BLANK}*(.*?)(:{2,4}|;;)(?:#{CG_BLANK}+(.*))?$/
 
     # Matches a sibling definition list item (which does not include the keyed type).
@@ -732,7 +730,7 @@ module Asciidoctor
     CalloutListRx = /^<?(\d+)>#{CG_BLANK}+(.*)/
 
     # Matches a callout reference inside literal text.
-    # 
+    #
     # Examples
     #   <1> (optionally prefixed by //, #, -- or ;; line comment chars)
     #   <1> <2> (multiple callouts on one line)
@@ -780,7 +778,7 @@ module Asciidoctor
     # Matches the general block macro pattern.
     #
     # Examples
-    # 
+    #
     #   gist::123456[]
     #
     #--
@@ -887,7 +885,7 @@ module Asciidoctor
     # Matches an implicit link and some of the link inline macro.
     #
     # Examples
-    # 
+    #
     #   http://github.com
     #   http://github.com[GitHub]
     #
@@ -1015,15 +1013,7 @@ module Asciidoctor
     #   one,two
     #   three;four
     #
-    DataDelimiterRx = /,|;/ 
-
-    # Matches one or more consecutive digits on a single line.
-    #
-    # Examples
-    #
-    #   29
-    #
-    DigitsRx = /^\d+$/
+    DataDelimiterRx = /,|;/
 
     # Matches a single-line of text enclosed in double quotes, capturing the quote char and text.
     #
@@ -1055,7 +1045,7 @@ module Asciidoctor
     # Matches a space escaped by a backslash.
     #
     # Examples
-    # 
+    #
     #   one\ two\ three
     #
     EscapedSpaceRx = /\\(#{CG_BLANK})/
@@ -1295,9 +1285,8 @@ module Asciidoctor
     elsif ::String === attrs
       # convert non-escaped spaces into null character, so we split on the
       # correct spaces chars, and restore escaped spaces
-      capture_1 = ::RUBY_ENGINE_OPAL ? '$1' : '\1'
+      capture_1 = '\1'
       attrs = attrs.gsub(SpaceDelimiterRx, %(#{capture_1}#{NULL})).gsub(EscapedSpaceRx, capture_1)
-
       attrs.split(NULL).inject({}) do |accum, entry|
         k, v = entry.split '=', 2
         accum[k] = v || ''

data/lib/asciidoctor/abstract_block.rb

@@ -167,11 +167,12 @@ class AbstractBlock < AbstractNode
   #   block.blocks.size
   #   # => 2
   #
-  # Returns nothing.
+  # Returns The parent Block
   def << block
     # parent assignment pending refactor
     #block.parent = self
     @blocks << block
+    self
   end
 
   # NOTE append alias required for adapting to a Java API
@@ -182,16 +183,20 @@ class AbstractBlock < AbstractNode
   # Only applies to Document and Section instances
   #
   # Examples
-  # 
-  #   section = Section.new(parent)
-  #   section << Block.new(section, :paragraph, :source => 'paragraph 1')
-  #   section << Section.new(parent)
-  #   section << Block.new(section, :paragraph, :source => 'paragraph 2')
-  #   section.blocks?
+  #
+  #   doc << (sect1 = Section.new doc, 1, false)
+  #   sect1.title = 'Section 1'
+  #   para1 = Block.new sect1, :paragraph, :source => 'Paragraph 1'
+  #   para2 = Block.new sect1, :paragraph, :source => 'Paragraph 2'
+  #   sect1 << para1 << para2
+  #   sect1 << (sect1_1 = Section.new sect1, 2, false)
+  #   sect1_1.title = 'Section 1.1'
+  #   sect1_1 << (Block.new sect1_1, :paragraph, :source => 'Paragraph 3')
+  #   sect1.blocks?
   #   # => true
-  #   section.blocks.size
+  #   sect1.blocks.size
   #   # => 3
-  #   section.sections.size
+  #   sect1.sections.size
   #   # => 1
   #
   # Returns an [Array] of Section objects
@@ -199,6 +204,15 @@ class AbstractBlock < AbstractNode
     @blocks.select {|block| block.context == :section }
   end
 
+  # Public: Check whether this block has any child Section objects.
+  #
+  # Only applies to Document and Section instances
+  #
+  # Returns A [Boolean] to indicate whether this block has child Section objects
+  def sections?
+    @next_section_index > 0
+  end
+
 # stage the Enumerable mixin until we're sure we've got it right
 =begin
   include ::Enumerable
@@ -238,7 +252,7 @@ class AbstractBlock < AbstractNode
   #
   # Examples
   #
-  #   doc.find_by context: :section 
+  #   doc.find_by context: :section
   #   #=> Asciidoctor::Section@14459860 { level: 0, title: "Hello, AsciiDoc!", blocks: 0 }
   #   #=> Asciidoctor::Section@14505460 { level: 1, title: "First Section", blocks: 1 }
   #
@@ -281,7 +295,8 @@ class AbstractBlock < AbstractNode
       if @context == :dlist
         if any_context || context_selector != :section # optimization
           @blocks.flatten.each do |li|
-            result.concat(li.find_by selector, &block)
+            # NOTE the list item of a dlist can be nil, so we have to check
+            result.concat(li.find_by selector, &block) if li
           end
         end
       elsif
@@ -375,6 +390,9 @@ class AbstractBlock < AbstractNode
   # Walk the descendents of the current Document or Section
   # and reassign the section 0-based index value to each Section
   # as it appears in document order.
+  #
+  # IMPORTANT You must invoke this method on a node after removing
+  # child sections or else the internal counters will be off.
   # 
   # Returns nothing
   def reindex_sections

data/lib/asciidoctor/abstract_node.rb

@@ -264,11 +264,16 @@ class AbstractNode
   # name - The String name of the icon
   #
   # Returns A String reference or data URI for an icon image
-  def icon_uri(name)
+  def icon_uri name
     if attr? 'icon'
-      image_uri(attr('icon'), nil)
+      # QUESTION should we add extension if resolved value is an absolute URI?
+      if ::File.extname(uri = (image_uri attr('icon'), 'iconsdir')).empty?
+        %(#{uri}.#{@document.attr 'icontype', 'png'})
+      else
+        uri
+      end
     else
-      image_uri(%(#{name}.#{@document.attr('icontype', 'png')}), 'iconsdir')
+      image_uri %(#{name}.#{@document.attr 'icontype', 'png'}), 'iconsdir'
     end
   end
 
@@ -366,7 +371,7 @@ class AbstractNode
     # NOTE base64 is autoloaded by reference to ::Base64
     %(data:#{mimetype};base64,#{::Base64.encode64(bindata).delete EOL})
   end
- 
+
   # Public: Read the image data from the specified URI and generate a data URI
   #
   # The image data is read from the URI and converted to Base64. A data URI is
@@ -392,7 +397,7 @@ class AbstractNode
     begin
       mimetype = nil
       bindata = open(image_uri, 'rb') {|file|
-        mimetype = file.content_type 
+        mimetype = file.content_type
         file.read
       }
       # NOTE base64 is autoloaded by reference to ::Base64
@@ -484,7 +489,7 @@ class AbstractNode
   # start               - the String start (i.e, parent) path (optional, default: nil)
   # preserve_uri_target - a Boolean indicating whether target should be preserved if contains a URI (default: true)
   #
-  # Returns the resolved [String] path 
+  # Returns the resolved [String] path
   def normalize_web_path(target, start = nil, preserve_uri_target = true)
     if preserve_uri_target && (Helpers.uriish? target)
       target

data/lib/asciidoctor/callouts.rb

@@ -27,10 +27,9 @@ class Callouts
   #  # => "CO2-1"
   #
   # 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)}
+  def register li_ordinal
+    current_list << { :ordinal => li_ordinal.to_i, :id => (id = generate_next_callout_id) }
     @co_index += 1
-
     id
   end
 
@@ -50,7 +49,6 @@ class Callouts
     end
 
     @co_index += 1
-
     id
   end
 
@@ -60,7 +58,7 @@ class Callouts
   #              retrieve the callouts
   #
   # Returns A space-separated String of callout ids associated with the specified list item
-  def callout_ids(li_ordinal)
+  def callout_ids li_ordinal
     current_list.map {|element| element[:ordinal] == li_ordinal ? %(#{element[:id]} ) : nil }.join.chop
   end
 
@@ -82,7 +80,6 @@ class Callouts
     end
 
     @co_index = 1
-
     nil
   end
 
@@ -93,7 +90,6 @@ class Callouts
   def rewind
     @list_index = 1
     @co_index = 1
-    
     nil
   end
 
@@ -101,7 +97,7 @@ class Callouts
   #
   # Returns A unique String id for this callout
   def generate_next_callout_id
-    generate_callout_id(@list_index, @co_index)
+    generate_callout_id @list_index, @co_index
   end
 
   # Internal: Generate a unique id for the callout at the specified position
@@ -110,8 +106,8 @@ class Callouts
   # co_index   - The 1-based Integer index of the callout since the end of the last callout list
   #
   # Returns A unique String id for a callout
-  def generate_callout_id(list_index, co_index)
-    "CO#{list_index}-#{co_index}"
+  def generate_callout_id list_index, co_index
+    %(CO#{list_index}-#{co_index})
   end
 end
 end

data/lib/asciidoctor/cli/options.rb

@@ -136,12 +136,12 @@ Example: asciidoctor -b html5 source.asciidoc
           opts.on_tail('-V', '--version', 'display the version and runtime environment (or -v if no other flags or arguments)') do
             return print_version $stdout
           end
-          
+
         end
 
         infiles = []
         opts_parser.parse! args
-        
+
         if args.empty?
           if self[:verbose] == 2
             return print_version $stdout

data/lib/asciidoctor/converter.rb

@@ -136,7 +136,7 @@ module Asciidoctor
         converter.extend Config
       end
     end
-  
+
     include Config
     include BackendInfo
 

data/lib/asciidoctor/converter/docbook5.rb

@@ -43,10 +43,13 @@ module Asciidoctor
 
     def section node
       doctype = node.document.doctype
-      tag_name = if node.special
-        node.level <= 1 ? node.sectname : 'section'
+      if node.special
+        if (tag_name = node.sectname).start_with? 'sect'
+          # a normal child section of a special section
+          tag_name = 'section'
+        end
       else
-        doctype == 'book' && node.level <= 1 ? (node.level == 0 ? 'part' : 'chapter') : 'section'
+        tag_name = doctype == 'book' && node.level <= 1 ? (node.level == 0 ? 'part' : 'chapter') : 'section'
       end
       if doctype == 'manpage'
         if tag_name == 'section'
@@ -103,7 +106,12 @@ module Asciidoctor
         :term  => 'glossterm',
         :item  => 'glossdef'
       }
-    }).default = DLIST_TAGS['labeled']
+    }).default = { # default value == DLIST['labeled'], expanded for Opal
+      :list => 'variablelist',
+      :entry => 'varlistentry',
+      :term => 'term',
+      :item => 'listitem'
+    }
 
     def dlist node
       result = []
@@ -252,15 +260,18 @@ module Asciidoctor
       end
       equation = node.content
       node.subs.insert idx, :specialcharacters if idx
-      if node.style == 'latexmath'
-        equation_data = %(<alt><![CDATA[#{equation}]]></alt>
-<mediaobject><textobject><phrase></phrase></textobject></mediaobject>)
-      elsif node.style == 'asciimath' && ((defined? ::AsciiMath) || (!(defined? @asciimath_loaded) ?
-          (@asciimath_loaded = Helpers.require_library 'asciimath', true, :warn) : @asciimath_loaded))
-        equation_data = ::AsciiMath.parse(equation).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'
+      if node.style == 'asciimath'
+        if ((defined? ::AsciiMath) || ((defined? @asciimath_available) ? @asciimath_available :
+            (@asciimath_available = Helpers.require_library 'asciimath', true, :warn)))
+          # NOTE fop requires jeuclid to process raw mathml
+          equation_data = (::AsciiMath.parse equation).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'
+        else
+          equation_data = %(<mathphrase><![CDATA[#{equation}]]></mathphrase>)
+        end
       else
-        # Unsupported math style, so output raw expression in text object
-        equation_data = %(<mediaobject><textobject><phrase><![CDATA[#{equation}]]></phrase></textobject></mediaobject>)
+        # unhandled math; pass source to alt and required mathphrase element; dblatex will process alt as LaTeX math
+        equation_data = %(<alt><![CDATA[#{equation}]]></alt>
+<mathphrase><![CDATA[#{equation}]]></mathphrase>)
       end
       if node.title?
         %(<equation#{common_attributes node.id, node.role, node.reftext}>
@@ -268,6 +279,7 @@ module Asciidoctor
 #{equation_data}
 </equation>)
       else
+        # WARNING dblatex displays the <informalequation> element inline instead of block as documented (except w/ mathml)
         %(<informalequation#{common_attributes node.id, node.role, node.reftext}>
 #{equation_data}
 </informalequation>)
@@ -383,14 +395,17 @@ module Asciidoctor
         result << '<?dbfo keep-together="auto"?>'
       end
       result << %(<title>#{node.title}</title>) if tag_name == 'table'
-      if (width = (node.attr? 'width') ? (node.attr 'width') : nil)
+      col_width_key = if (width = (node.attr? 'width') ? (node.attr 'width') : nil)
         TABLE_PI_NAMES.each do |pi_name|
           result << %(<?#{pi_name} table-width="#{width}"?>)
         end
+        'colabswidth'
+      else
+        'colpcwidth'
       end
       result << %(<tgroup cols="#{node.attr 'colcount'}">)
       node.columns.each do |col|
-        result << %(<colspec colname="col_#{col.attr 'colnumber'}" colwidth="#{col.attr(width ? 'colabswidth' : 'colpcwidth')}*"/>)
+        result << %(<colspec colname="col_#{col.attr 'colnumber'}" colwidth="#{col.attr col_width_key}*"/>)
       end
       TABLE_SECTIONS.select {|tblsec| !node.rows[tblsec].empty? }.each do |tblsec|
         has_body = true if tblsec == :body
@@ -498,13 +513,13 @@ module Asciidoctor
       when :xref
         if (path = node.attributes['path'])
           # QUESTION should we use refid as fallback text instead? (like the html5 backend?)
-          %(<link xlink:href="#{node.target}">#{node.text || path}</link>)
+          %(<link xl:href="#{node.target}">#{node.text || path}</link>)
         else
           linkend = node.attributes['fragment'] || node.target
           (text = node.text) ? %(<link linkend="#{linkend}">#{text}</link>) : %(<xref linkend="#{linkend}"/>)
         end
       when :link
-        %(<link xlink:href="#{node.target}">#{node.text}</link>)
+        %(<link xl:href="#{node.target}">#{node.text}</link>)
       when :bibref
         target = node.target
         %(<anchor#{common_attributes target, nil, "[#{target}]"}/>[#{target}])
@@ -599,11 +614,17 @@ module Asciidoctor
     }).default = [nil, nil, true]
 
     def inline_quoted node
-      if (type = node.type) == :latexmath
-        %(<inlineequation>
-<alt><![CDATA[#{node.text}]]></alt>
-<inlinemediaobject><textobject><phrase><![CDATA[#{node.text}]]></phrase></textobject></inlinemediaobject>
-</inlineequation>)
+      if (type = node.type) == :asciimath
+        if ((defined? ::AsciiMath) || ((defined? @asciimath_available) ? @asciimath_available :
+            (@asciimath_available = Helpers.require_library 'asciimath', true, :warn)))
+          # NOTE fop requires jeuclid to process raw mathml
+          %(<inlineequation>#{(::AsciiMath.parse node.text).to_mathml 'mml:', 'xmlns:mml' => 'http://www.w3.org/1998/Math/MathML'}</inlineequation>)
+        else
+          %(<inlineequation><mathphrase><![CDATA[#{node.text}]]></mathphrase></inlineequation>)
+        end
+      elsif type == :latexmath
+        # unhandled math; pass source to alt and required mathphrase element; dblatex will process alt as LaTeX math
+        %(<inlineequation><alt><![CDATA[#{equation = node.text}]]></alt><mathphrase><![CDATA[#{equation}]]></mathphrase></inlineequation>)
       else
         open, close, supports_phrase = QUOTE_TAGS[type]
         text = node.text
@@ -656,7 +677,9 @@ module Asciidoctor
       result = []
       result << %(<#{info_tag_prefix}info>)
       result << document_title_tags(doc.doctitle :partition => true, :use_fallback => true) unless doc.notitle
-      result << %(<date>#{(doc.attr? 'revdate') ? (doc.attr 'revdate') : (doc.attr 'docdate')}</date>)
+      if (date = (doc.attr? 'revdate') ? (doc.attr 'revdate') : ((doc.attr? 'reproducible') ? nil : (doc.attr 'docdate')))
+        result << %(<date>#{date}</date>)
+      end
       if doc.has_header?
         if doc.attr? 'author'
           if (authorcount = (doc.attr 'authorcount').to_i) < 2
@@ -702,7 +725,7 @@ module Asciidoctor
     end
 
     def document_ns_attributes doc
-      ' xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"'
+      ' xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0"'
     end
 
     def lang_attribute_name