asciidoctor 0.1.1 → 0.1.2

data/lib/asciidoctor/abstract_block.rb

@@ -189,6 +189,47 @@ class AbstractBlock < AbstractNode
     }
   end
 
+  # Public: Generate a caption and assign it to this block if one
+  # is not already assigned.
+  #
+  # If the block has a title and a caption prefix is available
+  # for this block, then build a caption from this information,
+  # assign it a number and store it to the caption attribute on
+  # the block.
+  #
+  # If an explicit caption has been specified on this block, then
+  # do nothing.
+  #
+  # key         - The prefix of the caption and counter attribute names.
+  #               If not provided, the name of the context for this block
+  #               is used. (default: nil).
+  #
+  # returns nothing
+  def assign_caption(caption = nil, key = nil)
+    unless title? || @caption.nil?
+      return nil
+    end
+
+    if caption.nil?
+      if @document.attr?('caption')
+        @caption = @document.attr('caption')
+      elsif title?
+        key ||= @context.to_s
+        caption_key = "#{key}-caption"
+        if @document.attributes.has_key?(caption_key)
+          caption_title = @document.attributes["#{key}-caption"]
+          caption_num = @document.counter_increment("#{key}-number", self)
+          @caption = @attributes['caption'] = "#{caption_title} #{caption_num}. "
+        end
+      else
+        @caption = caption
+      end
+    else
+      @caption = caption
+    end
+    nil
+  end
+
   # Internal: Assign the next index (0-based) to this section
   #
   # Assign the next index of this section within the parent

data/lib/asciidoctor/abstract_node.rb

@@ -94,6 +94,27 @@ class AbstractNode
     end
   end
 
+  # Public: Assign the value to the specified key in this
+  # block's attributes hash.
+  #
+  # key - The attribute key (or name)
+  # val - The value to assign to the key
+  #
+  # returns a flag indicating whether the assignment was performed
+  def set_attr(key, val, overwrite = nil)
+    if overwrite.nil?
+      @attributes[key] = val
+      true
+    else
+      if overwrite || @attributes.has_key?(key)
+        @attributes[key] = val
+        true
+      else
+        false
+      end
+    end
+  end
+
   # Public: Get the execution context of this object (via Kernel#binding).
   #
   # This method is used to set the 'self' reference as well as local variables
@@ -156,11 +177,35 @@ class AbstractNode
     if attr? 'icon'
       image_uri(attr('icon'), nil)
     else
-      image_uri(name + '.' + @document.attr('icontype', 'png'), 'iconsdir')
+      image_uri("#{name}.#{@document.attr('icontype', 'png')}", 'iconsdir')
+    end
+  end
+
+  # Public: Construct a URI reference to the target media.
+  #
+  # If the target media is a URI reference, then leave it untouched.
+  #
+  # The target media is resolved relative to the directory retrieved from the
+  # specified attribute key, if provided.
+  #
+  # The return value can be safely used in a media tag (img, audio, video).
+  #
+  # target        - A String reference to the target media
+  # asset_dir_key - The String attribute key used to lookup the directory where
+  #                 the media is located (default: 'imagesdir')
+  #
+  # Returns A String reference for the target media
+  def media_uri(target, asset_dir_key = 'imagesdir')
+    if target.include?(':') && target.match(Asciidoctor::REGEXP[:uri_sniff])
+      target
+    elsif asset_dir_key && attr?(asset_dir_key)
+      normalize_web_path(target, @document.attr(asset_dir_key))
+    else
+      normalize_web_path(target)
     end
   end
 
-  # Public: Construct a reference or data URI to the target image.
+  # Public: Construct a URI reference or data URI to the target image.
   #
   # If the target image is a URI reference, then leave it untouched.
   #
@@ -185,9 +230,9 @@ class AbstractNode
     elsif @document.safe < Asciidoctor::SafeMode::SECURE && @document.attr?('data-uri')
       generate_data_uri(target_image, asset_dir_key)
     elsif asset_dir_key && attr?(asset_dir_key)
-      File.join(@document.attr(asset_dir_key), target_image)
+      normalize_web_path(target_image, @document.attr(asset_dir_key))
     else
-      target_image
+      normalize_web_path(target_image)
     end
   end
 
@@ -208,9 +253,17 @@ class AbstractNode
 
     mimetype = 'image/' + File.extname(target_image)[1..-1]
     if asset_dir_key
-      image_path = File.join(normalize_asset_path(@document.attr(asset_dir_key, '.'), asset_dir_key), target_image)
+      #asset_dir_path = normalize_system_path(@document.attr(asset_dir_key), nil, nil, :target_name => asset_dir_key)
+      #image_path = normalize_system_path(target_image, asset_dir_path, nil, :target_name => 'image')
+      image_path = normalize_system_path(target_image, @document.attr(asset_dir_key), nil, :target_name => 'image')
     else
-      image_path = normalize_asset_path(target_image)
+      image_path = normalize_system_path(target_image)
+    end
+
+    if !File.readable? image_path
+      puts "asciidoctor: WARNING: image to embed not found or not readable: #{image_path}"
+      return "data:#{mimetype}:base64,"
+      #return 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
     end
 
     bindata = nil
@@ -219,88 +272,82 @@ class AbstractNode
     else
       bindata = File.open(image_path, 'rb') {|file| file.read }
     end
-    'data:' + mimetype + ';base64,' + Base64.encode64(bindata).delete("\n")
+    "data:#{mimetype};base64,#{Base64.encode64(bindata).delete("\n")}"
   end
 
-  # Public: Normalize the asset file or directory to a concrete and rinsed path
-  #
-  # The most important functionality in this method is to prevent the asset
-  # reference from resolving to a directory outside of the chroot directory
-  # (which defaults to the directory of the source file, stored in the base_dir
-  # instance variable on Document) if the document safe level is set to
-  # SafeMode::SAFE or greater (a condition which is true by default).
-  #
-  # asset_ref    - the String asset file or directory referenced in the document
-  #                or configuration attribute
-  # asset_name   - the String name of the file or directory being resolved (for use in
-  #                the warning message) (default: 'path')
-  #
-  # Examples
-  #
-  #  # given these fixtures
-  #  document.base_dir
-  #  # => "/path/to/chroot"
-  #  document.safe >= Asciidoctor::SafeMode::SAFE
-  #  # => true
-  #
-  #  # then
-  #  normalize_asset_path('images')
-  #  # => "/path/to/chroot/images"
-  #  normalize_asset_path('/etc/images')
-  #  # => "/path/to/chroot/images"
-  #  normalize_asset_path('../images')
-  #  # => "/path/to/chroot/images"
-  #
-  #  # given these fixtures
-  #  document.base_dir
-  #  # => "/path/to/chroot"
-  #  document.safe >= Asciidoctor::SafeMode::SAFE
-  #  # => false
-  #
-  #  # then
-  #  normalize_asset_path('images')
-  #  # => "/path/to/chroot/images"
-  #  normalize_asset_path('/etc/images')
-  #  # => "/etc/images"
-  #  normalize_asset_path('../images')
-  #  # => "/path/to/images"
-  #
-  # Returns The normalized asset file or directory as a String path
-  #--
-  # TODO this method is missing a coordinate; it should be able to resolve
-  # both the directory reference and the path to an asset in it; callers
-  # of this method are still doing a File.join to finish the task
-  def normalize_asset_path(asset_ref, asset_name = 'path', autocorrect = true)
-    # TODO we may use pathname enough to make it a top-level require
-    Helpers.require_library 'pathname'
-
-    input_path = @document.base_dir
-    asset_path = Pathname.new(asset_ref)
-    
-    if asset_path.relative?
-      asset_path = File.expand_path(File.join(input_path, asset_ref))
+  # Public: Read the contents of the file at the specified path.
+  # This method assumes that the path is safe to read. It checks
+  # that the file is readable before attempting to read it.
+  #
+  # path            - the String path from which to read the contents
+  # warn_on_failure - a Boolean that controls whether a warning is issued if
+  #                   the file cannot be read
+  #
+  # returns the contents of the file at the specified path, or nil
+  # if the file does not exist.
+  def read_asset(path, warn_on_failure = false)
+    if File.readable? path
+      File.read path
     else
-      asset_path = asset_path.cleanpath.to_s
+      puts "asciidoctor: WARNING: file does not exist or cannot be read: #{path}" if warn_on_failure
+      nil
     end
+  end
 
-    if @document.safe >= SafeMode::SAFE
-      relative_asset_path = Pathname.new(asset_path).relative_path_from(Pathname.new(input_path)).to_s
-      if relative_asset_path.start_with?('..')
-        if autocorrect
-          puts "asciidoctor: WARNING: #{asset_name} has illegal reference to ancestor of base directory"
-        else
-          raise SecurityError, "#{asset_name} has reference to path outside of base directory, disallowed in safe mode: #{asset_path}"
-        end
-        relative_asset_path.sub!(/^(?:\.\.\/)*/, '')
-        # just to be absolutely sure ;)
-        if relative_asset_path[0..0] == '.'
-          raise 'Substitution of parent path references failed for ' + relative_asset_path
-        end
-        asset_path = File.expand_path(File.join(input_path, relative_asset_path))
-      end
+  # Public: Normalize the web page using the PathResolver.
+  #
+  # See PathResolver::web_path(target, start) for details.
+  #
+  # target - the String target path
+  # start  - the String start (i.e, parent) path (optional, default: nil)
+  #
+  # returns the resolved String path 
+  def normalize_web_path(target, start = nil)
+    PathResolver.new.web_path(target, start)
+  end
+
+  # Public: Resolve and normalize a secure path from the target and start paths
+  # using the PathResolver.
+  #
+  # See PathResolver::system_path(target, start, jail, opts) for details.
+  #
+  # The most important functionality in this method is to prevent resolving a
+  # path outside of the jail (which defaults to the directory of the source
+  # file, stored in the base_dir instance variable on Document) if the document
+  # safe level is set to SafeMode::SAFE or greater (a condition which is true
+  # by default).
+  #
+  # target - the String target path
+  # start  - the String start (i.e., parent) path
+  # jail   - the String jail path to confine the resolved path
+  # opts   - an optional Hash of options to control processing (default: {}):
+  #          * :recover is used to control whether the processor should auto-recover
+  #              when an illegal path is encountered
+  #          * :target_name is used in messages to refer to the path being resolved
+  #
+  # raises a SecurityError if a jail is specified and the resolved path is
+  # outside the jail.
+  #
+  # returns a String path resolved from the start and target paths, with any
+  # parent references resolved and self references removed. If a jail is provided,
+  # this path will be guaranteed to be contained within the jail.
+  def normalize_system_path(target, start = nil, jail = nil, opts = {})
+    if start.nil?
+      start = @document.base_dir
     end
+    if jail.nil? && @document.safe >= SafeMode::SAFE
+      jail = @document.base_dir
+    end
+    PathResolver.new.system_path(target, start, jail, opts)
+  end
 
-    asset_path
+  # Public: Normalize the asset file or directory to a concrete and rinsed path
+  #
+  # Delegates to normalize_system_path, with the start path set to the value of
+  # the base_dir instance variable on the Document object.
+  def normalize_asset_path(asset_ref, asset_name = 'path', autocorrect = true)
+    normalize_system_path(asset_ref, @document.base_dir, nil,
+        :target_name => asset_name, :recover => autocorrect)
   end
 
 end

data/lib/asciidoctor/attribute_list.rb

@@ -84,6 +84,7 @@ class AttributeList
 
   def self.rekey(attributes, pos_attrs)
     pos_attrs.each_with_index do |key, index|
+      next if key.nil?
       pos = index + 1
       unless (val = attributes[pos]).nil?
         attributes[key] = val
@@ -166,9 +167,11 @@ class AttributeList
     else
       resolved_value = value
       # example: options="opt1,opt2,opt3"
-      if name == 'options'
+      # opts is an alias for options
+      if name == 'options' || name == 'opts'
+        name = 'options'
         resolved_value.split(CSV_SPLIT_PATTERN).each do |o|
-          @attributes[o + '-option'] = nil
+          @attributes[o + '-option'] = ''
         end
       elsif single_quoted_value && !@block.nil?
         resolved_value = @block.apply_normal_subs(value)

data/lib/asciidoctor/backends/base_template.rb

@@ -40,15 +40,17 @@ class BaseTemplate
   # locals - A Hash of additional variables. Not currently in use.
   def render(node = Object.new, locals = {})
     tmpl = template
-    if tmpl.equal? :content
+    case tmpl
+    when :invoke_result
+      return result(node)
+    when :content
       result = node.content
-    #elsif tmpl.is_a?(String)
-    #  result = tmpl
     else
       result = tmpl.result(node.get_binding(self))
     end
 
-    if (@view == 'document' || @view == 'embedded') && node.renderer.compact
+    if (@view == 'document' || @view == 'embedded') &&
+        node.renderer.compact && !node.document.nested?
       compact result
     else
       result
@@ -105,4 +107,14 @@ class BaseTemplate
     attribute('id', '@id')
   end
 end
+
+module EmptyTemplate
+  def result(node)
+    ''
+  end
+
+  def template
+    :invoke_result
+  end
+end
 end

data/lib/asciidoctor/backends/docbook45.rb

@@ -1,11 +1,12 @@
 module Asciidoctor
   class BaseTemplate
-    def tag(name, key)
+    def tag(name, key, dynamic = false)
       type = key.is_a?(Symbol) ? :attr : :var
       key = key.to_s
       if type == :attr
+        key_str = dynamic ? %("#{key}") : "'#{key}'"
         # example: <% if attr? 'foo' %><bar><%= attr 'foo' %></bar><% end %>
-        %(<% if attr? '#{key}' %><#{name}><%= attr '#{key}' %></#{name}><% end %>)
+        %(<% if attr? #{key_str} %><#{name}><%= attr #{key_str} %></#{name}><% end %>)
       else
         # example: <% unless foo.to_s.empty? %><bar><%= foo %></bar><% end %>
         %(<% unless #{key}.to_s.empty? %><#{name}><%= #{key} %></#{name}><% end %>)
@@ -31,10 +32,20 @@ module Asciidoctor
 
 module DocBook45
 class DocumentTemplate < BaseTemplate
+  def title_tags(str)
+    if str.include?(': ')
+      title, _, subtitle = str.rpartition(': ')
+      %(<title>#{title}</title>
+    <subtitle>#{subtitle}</subtitle>)
+    else
+      %(<title>#{str}</title>)
+    end
+  end
+
   def docinfo
     <<-EOF
     <% if has_header? && !notitle %>
-    #{tag 'title', '@header.title'}
+    <%= template.title_tags(@header.title) %>
     <% end %>
     <% if attr? :revdate %>
     <date><%= attr :revdate %></date>
@@ -43,6 +54,7 @@ class DocumentTemplate < BaseTemplate
     <% end %>
     <% if has_header? %>
     <% if attr? :author %>
+    <% if attr? :authorcount, 1 %>
     <author>
       #{tag 'firstname', :firstname}
       #{tag 'othername', :middlename}
@@ -50,15 +62,31 @@ class DocumentTemplate < BaseTemplate
       #{tag 'email', :email}
     </author>
     #{tag 'authorinitials', :authorinitials}
+    <% else %>
+    <authorgroup>
+    <% (1..(attr(:authorcount))).each do |idx| %>
+      <author> 
+        #{tag 'firstname', :"firstname_\#{idx}", true}
+        #{tag 'othername', :"middlename_\#{idx}", true}
+        #{tag 'surname', :"lastname_\#{idx}", true}
+        #{tag 'email', :"email_\#{idx}", true}
+      </author> 
+    <% end %>
+    </authorgroup>
+    <% end %>
     <% end %>
     <% if (attr? :revnumber) || (attr? :revremark) %>
     <revhistory>
-      #{tag 'revision', :revnumber}
-      #{tag 'date', :revdate}
-      #{tag 'authorinitials', :authorinitials}
-      #{tag 'revremark', :revremark}
+      <revision>
+        #{tag 'revnumber', :revnumber}
+        #{tag 'date', :revdate}
+        #{tag 'authorinitials', :authorinitials}
+        #{tag 'revremark', :revremark}
+      </revision>
     </revhistory>
     <% end %>
+<%= docinfo %>
+    #{tag 'orgname', :orgname}
     <% end %>
     EOF
   end
@@ -94,12 +122,22 @@ class EmbeddedTemplate < BaseTemplate
   end
 end
 
+class BlockTocTemplate < BaseTemplate
+  def result(node)
+    ''
+  end
+
+  def template
+    :invoke_result
+  end
+end
+
 class BlockPreambleTemplate < BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
 <%#encoding:UTF-8%><% if @document.doctype == 'book' %>
 <preface#{common_attrs_erb}>
-  <title><%= title %></title>
+  #{title_tag false}
 <%= content %>
 </preface>
 <% else %>
@@ -110,11 +148,11 @@ class BlockPreambleTemplate < BaseTemplate
 end
 
 class SectionTemplate < BaseTemplate
-  def section(sec)
+  def result(sec)
     if sec.special
       tag = sec.level <= 1 ? sec.sectname : 'section'
     else
-      tag = sec.document.doctype == 'book' && sec.level <= 1 ? 'chapter' : 'section'
+      tag = sec.document.doctype == 'book' && sec.level <= 1 ? (sec.level == 0 ? 'part' : 'chapter') : 'section'
     end
     %(<#{tag}#{common_attrs(sec.id, (sec.attr 'role'), (sec.attr 'reftext'))}>
   #{sec.title? ? "<title>#{sec.title}</title>" : nil}
@@ -123,10 +161,7 @@ class SectionTemplate < BaseTemplate
   end
 
   def template
-    # hot piece of code, optimized for speed
-    @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%><%= template.section(self) %>
-    EOF
+    :invoke_result
   end
 end
 
@@ -138,25 +173,38 @@ class BlockFloatingTitleTemplate < BaseTemplate
   end
 end
 
-
 class BlockParagraphTemplate < BaseTemplate
-
-  def paragraph(id, role, reftext, title, content)
-    if title
-      %(<formalpara#{common_attrs(id, role, reftext)}>
+  def paragraph(id, style, role, reftext, title, content)
+    # FIXME temporary hack until I can generalize this feature
+    if style == 'partintro'
+      if title
+        %(<partintro#{common_attrs(id, role, reftext)}>
+  <title>#{title}</title>
+  <simpara>#{content}</simpara>
+</partintro>)
+      else
+        %(<partintro#{common_attrs(id, role, reftext)}>
+  <simpara>#{content}</simpara>
+</partintro>)
+      end
+    else
+      if title
+        %(<formalpara#{common_attrs(id, role, reftext)}>
   <title>#{title}</title>
   <para>#{content}</para>
 </formalpara>)
-    else
-      %(<simpara#{common_attrs(id, role, reftext)}>#{content}</simpara>)
+      else
+        %(<simpara#{common_attrs(id, role, reftext)}>#{content}</simpara>)
+      end
     end
   end
 
+  def result(node)
+    paragraph(node.id, node.attr('style'), node.attr('role'), node.attr('reftext'), (node.title? ? node.title : nil), node.content)
+  end
+
   def template
-    # very hot piece of code, optimized for speed
-    @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%><%= template.paragraph(@id, (attr 'role'), (attr 'reftext'), title? ? title : nil, content) %>
-    EOF
+    :invoke_result
   end
 end
 
@@ -254,7 +302,8 @@ class BlockDlistTemplate < BaseTemplate
     'qanda' => {
       :list => 'qandaset',
       :entry => 'qandaentry',
-      :term => 'question',
+      :label => 'question',
+      :term => 'simpara',
       :item => 'answer'
     },
     'glossary' => {
@@ -272,9 +321,17 @@ class BlockDlistTemplate < BaseTemplate
   #{title_tag}
   <% content.each do |dt, dd| %>
   <<%= tags[:entry] %>>
+    <% if tags.has_key?(:label) %>
+    <<%= tags[:label] %>>
+      <<%= tags[:term] %>>
+        <%= dt.text %>
+      </<%= tags[:term] %>>
+    </<%= tags[:label] %>>
+    <% else %>
     <<%= tags[:term] %>>
       <%= dt.text %>
     </<%= tags[:term] %>>
+    <% end %>
     <% unless dd.nil? %>
     <<%= tags[:item] %>>
       <% if dd.text? %>
@@ -469,6 +526,14 @@ class BlockImageTemplate < BaseTemplate
   end
 end
 
+class BlockAudioTemplate < BaseTemplate
+  include EmptyTemplate
+end
+
+class BlockVideoTemplate < BaseTemplate
+  include EmptyTemplate
+end
+
 class BlockRulerTemplate < BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
@@ -494,6 +559,8 @@ class InlineBreakTemplate < BaseTemplate
 end
 
 class InlineQuotedTemplate < BaseTemplate
+  NO_TAGS = ['', '']
+
   QUOTED_TAGS = {
     :emphasis => ['<emphasis>', '</emphasis>'],
     :strong => ['<emphasis role="strong">', '</emphasis>'],
@@ -502,11 +569,10 @@ class InlineQuotedTemplate < BaseTemplate
     :subscript => ['<subscript>', '</subscript>'],
     :double => ['&#8220;', '&#8221;'],
     :single => ['&#8216;', '&#8217;']
-    #:none => ['', '']
   }
 
-  def quote(text, type, role)
-    start_tag, end_tag = QUOTED_TAGS[type] || ['', '']
+  def quote_text(text, type, role)
+    start_tag, end_tag = QUOTED_TAGS[type] || NO_TAGS
     if role
       "#{start_tag}<phrase role=\"#{role}\">#{text}</phrase>#{end_tag}"
     else
@@ -514,11 +580,12 @@ class InlineQuotedTemplate < BaseTemplate
     end
   end
 
+  def result(node)
+    quote_text(node.text, node.type, node.attr('role'))
+  end
+
   def template
-    # very hot piece of code, optimized for speed
-    @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%><%= template.quote(@text, @type, attr('role')) %>
-    EOF
+    :invoke_result
   end
 end
 
@@ -536,11 +603,12 @@ class InlineAnchorTemplate < BaseTemplate
     end
   end
 
+  def result(node)
+    anchor(node.target, node.text, node.type)
+  end
+
   def template
-    # hot piece of code, optimized for speed
-    @template ||= @eruby.new <<-EOS
-<%#encoding:UTF-8%><%= template.anchor(@target, @text, @type) %>
-    EOS
+    :invoke_result
   end
 end
 
@@ -571,10 +639,12 @@ end %>
 end
 
 class InlineCalloutTemplate < BaseTemplate
+  def result(node)
+    %(<co id="#{node.id}"/>)
+  end
+
   def template
-    @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%><co#{id}/>
-    EOF
+    :invoke_result
   end
 end
 
@@ -588,10 +658,10 @@ if numterms > 2 %><indexterm>
 </indexterm>
 <% end %><%
 if numterms > 1 %><indexterm>
-  <primary><%= terms[numterms - 2] %></primary><secondary><%= terms[numterms - 1] %></secondary>
+  <primary><%= terms[-2] %></primary><secondary><%= terms[-1] %></secondary>
 </indexterm>
 <% end %><indexterm>
-  <primary><%= terms[numterms - 1] %></primary>
+  <primary><%= terms[-1] %></primary>
 </indexterm><% end %>
     EOS
   end