asciidoctor 0.0.9 → 0.1.0

data/lib/asciidoctor/abstract_node.rb

@@ -97,7 +97,7 @@ class Asciidoctor::AbstractNode
   # If the 'icon' attribute is set on this block, the name is ignored and the
   # value of this attribute is used as the  target image path. Otherwise,
   # construct a target image path by concatenating the value of the 'iconsdir'
-  # attribute, the icon name and the value of the 'iconstype' attribute
+  # attribute, the icon name and the value of the 'icontype' attribute
   # (defaulting to 'png').
   #
   # The target image path is then passed through the #image_uri() method.  If
@@ -113,7 +113,7 @@ class Asciidoctor::AbstractNode
     if attr? 'icon'
       image_uri(attr('icon'), nil)
     else
-      image_uri(name + '.' + @document.attr('iconstype', 'png'), 'iconsdir')
+      image_uri(name + '.' + @document.attr('icontype', 'png'), 'iconsdir')
     end
   end
 
@@ -166,16 +166,22 @@ class Asciidoctor::AbstractNode
       image_path = normalize_asset_path(target_image)
     end
 
-    'data:' + mimetype + ';base64,' + Base64.encode64(IO.read(image_path)).delete("\n")
+    bindata = nil
+    if IO.respond_to? :binread
+      bindata = IO.binread(image_path)
+    else
+      bindata = File.open(image_path, 'rb') {|file| file.read }
+    end
+    '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 'docdir'
-  # attribute) if the document safe level is set to SafeMode::SAFE or greater
-  # (a condition which is true by default).
+  # (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
@@ -185,28 +191,28 @@ class Asciidoctor::AbstractNode
   # Examples
   #
   #  # given these fixtures
-  #  document.attr('docdir')
-  #  # => "/path/to/docdir"
+  #  document.base_dir
+  #  # => "/path/to/chroot"
   #  document.safe >= Asciidoctor::SafeMode::SAFE
   #  # => true
   #
   #  # then
   #  normalize_asset_path('images')
-  #  # => "/path/to/docdir/images"
+  #  # => "/path/to/chroot/images"
   #  normalize_asset_path('/etc/images')
-  #  # => "/path/to/docdir/images"
+  #  # => "/path/to/chroot/images"
   #  normalize_asset_path('../images')
-  #  # => "/path/to/docdir/images"
+  #  # => "/path/to/chroot/images"
   #
   #  # given these fixtures
-  #  document.attr('docdir')
-  #  # => "/path/to/docdir"
+  #  document.base_dir
+  #  # => "/path/to/chroot"
   #  document.safe >= Asciidoctor::SafeMode::SAFE
   #  # => false
   #
   #  # then
   #  normalize_asset_path('images')
-  #  # => "/path/to/docdir/images"
+  #  # => "/path/to/chroot/images"
   #  normalize_asset_path('/etc/images')
   #  # => "/etc/images"
   #  normalize_asset_path('../images')
@@ -217,11 +223,11 @@ class Asciidoctor::AbstractNode
   # 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')
+  def normalize_asset_path(asset_ref, asset_name = 'path', autocorrect = true)
     # TODO we may use pathname enough to make it a top-level require
     Asciidoctor.require_library 'pathname'
 
-    input_path = File.expand_path(@document.attr('docdir'))
+    input_path = @document.base_dir
     asset_path = Pathname.new(asset_ref)
     
     if asset_path.relative?
@@ -233,7 +239,11 @@ class Asciidoctor::AbstractNode
     if @document.safe >= Asciidoctor::SafeMode::SAFE
       relative_asset_path = Pathname.new(asset_path).relative_path_from(Pathname.new(input_path)).to_s
       if relative_asset_path.start_with?('..')
-        puts 'asciidoctor: WARNING: ' + asset_name + ' has illegal reference to ancestor of base directory'
+        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] == '.'

data/lib/asciidoctor/attribute_list.rb

@@ -179,6 +179,12 @@ class Asciidoctor::AttributeList
   end
 
   def parse_attribute_value(quote)
+    # empty quoted value
+    if @scanner.peek(1) == quote
+      @scanner.get_byte 
+      return ''
+    end
+
     value = scan_to_quote quote
     if value.nil?
       quote + scan_to_delimiter

data/lib/asciidoctor/backends/base_template.rb

@@ -75,13 +75,12 @@ class Asciidoctor::BaseTemplate
   # create template matter to insert an attribute if the variable has a value
   def attribute(name, key)
     type = key.is_a?(Symbol) ? :attr : :var
-    key = key.to_s
     if type == :attr
       # example: <% if attr? 'foo' %> bar="<%= attr 'foo' %>"<% end %>
-      '<% if attr? \'' + key + '\' %> ' + name + '="<%= attr \'' + key.to_s + '\' %>"<% end %>'
+      %(<% if attr? '#{key}' %> #{name}="<%= attr '#{key}' %>"<% end %>)
     else
       # example: <% if foo %> bar="<%= foo %>"<% end %>
-      '<% if ' + key + ' %> ' + name + '="<%= ' + key + ' %>"<% end %>'
+      %(<% if #{key} %> #{name}="<%= #{key} %>"<% end %>)
     end
   end
 
@@ -89,7 +88,7 @@ class Asciidoctor::BaseTemplate
   def attrvalue(key, sibling = true)
     delimiter = sibling ? ' ' : ''
     # example: <% if attr? 'foo' %><%= attr 'foo' %><% end %>
-    '<% if attr? \'' + key.to_s + '\' %>' + delimiter + '<%= attr \'' + key.to_s + '\' %><% end %>'
+    %(<% if attr? '#{key}' %>#{delimiter}<%= attr '#{key}' %><% end %>)
   end
 
   # create template matter to insert an id if one is specified for the block

data/lib/asciidoctor/backends/docbook45.rb

@@ -16,10 +16,10 @@ class Asciidoctor::BaseTemplate
     key = key.to_s
     if type == :attr
       # example: <% if attr? 'foo' %><bar><%= attr 'foo' %></bar><% end %>
-      '<% if attr? \'' + key + '\' %><' + name + '><%= attr \'' + key + '\' %></' + name + '><% end %>'
+      %(<% if attr? '#{key}' %><#{name}><%= attr '#{key}' %></#{name}><% end %>)
     else
       # example: <% unless foo.to_s.empty? %><bar><%= foo %></bar><% end %>
-      '<% unless ' + key + '.to_s.empty? %><' + name + '><%= ' + key + ' %></' + name + '><% end %>'
+      %(<% unless #{key}.to_s.empty? %><#{name}><%= #{key} %></#{name}><% end %>)
     end
   end
 end
@@ -60,8 +60,7 @@ class DocumentTemplate < ::Asciidoctor::BaseTemplate
 
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<?xml version="1.0" encoding="UTF-8"?>
+<%#encoding:UTF-8%><?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE <%= doctype %> PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
 <% if attr? :toc %><?asciidoc-toc?><% end %>
 <% if attr? :numbered %><?asciidoc-numbered?><% end %>
@@ -87,8 +86,7 @@ end
 class EmbeddedTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOS
-<%#encoding:UTF-8%>
-<%= content %>
+<%#encoding:UTF-8%><%= content %>
   EOS
   end
 end
@@ -96,8 +94,7 @@ end
 class BlockPreambleTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<% if document.doctype == 'book' %>
+<%#encoding:UTF-8%><% if document.doctype == 'book' %>
 <preface#{id}#{role}#{xreflabel}>
   <title><%= title %></title>
 <%= content %>
@@ -112,20 +109,27 @@ end
 class SectionTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<<%= document.doctype == 'book' && level <= 1 ? 'chapter' : 'section' %>#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><<%= @special ? @sectname : (document.doctype == 'book' && @level <= 1 ? 'chapter' : 'section') %>#{id}#{role}#{xreflabel}>
   #{title}
 <%= content %>
-</<%= document.doctype == 'book' && level <= 1 ? 'chapter' : 'section' %>>
+</<%= @special ? @sectname : (document.doctype == 'book' && @level <= 1 ? 'chapter' : 'section') %>>
     EOF
   end
 end
 
+class BlockFloatingTitleTemplate < ::Asciidoctor::BaseTemplate
+  def template
+    @template ||= @eruby.new <<-EOS
+<%#encoding:UTF-8%><bridgehead#{id}#{role}#{xreflabel} renderas="sect<%= @level %>"><%= title %></bridgehead>
+    EOS
+  end
+end
+
+
 class BlockParagraphTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<% if !title? %>
+<%#encoding:UTF-8%><% if !title? %>
 <simpara#{id}#{role}#{xreflabel}><%= content %></simpara>
 <% else %>
 <formalpara#{id}#{role}#{xreflabel}>
@@ -140,8 +144,7 @@ end
 class BlockAdmonitionTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<<%= attr :name %>#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><<%= attr :name %>#{id}#{role}#{xreflabel}>
   #{title}
   <% if blocks? %>
 <%= content %>
@@ -156,7 +159,19 @@ end
 class BlockUlistTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
+<%#encoding:UTF-8%><% if (attr :style) == 'bibliography' %>
+<bibliodiv#{id}#{role}#{xreflabel}>
+  #{title}
+  <% content.each do |li| %>
+    <bibliomixed>
+      <bibliomisc><%= li.text %></bibliomisc>
+      <% if li.blocks? %>
+<%= li.content %>
+      <% end %>
+    </bibliomixed>
+  <% end %>
+</bibliodiv>
+<% else %>
 <itemizedlist#{id}#{role}#{xreflabel}>
   #{title}
   <% content.each do |li| %>
@@ -168,6 +183,7 @@ class BlockUlistTemplate < ::Asciidoctor::BaseTemplate
     </listitem>
   <% end %>
 </itemizedlist>
+<% end %>
     EOF
   end
 end
@@ -175,8 +191,7 @@ end
 class BlockOlistTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<orderedlist#{id}#{role}#{xreflabel}#{attribute('numeration', :style)}>
+<%#encoding:UTF-8%><orderedlist#{id}#{role}#{xreflabel}#{attribute('numeration', :style)}>
   #{title}
   <% content.each do |li| %>
     <listitem>
@@ -194,8 +209,7 @@ end
 class BlockColistTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<calloutlist#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><calloutlist#{id}#{role}#{xreflabel}>
   #{title}
   <% content.each do |li| %>
     <callout arearefs="<%= li.attr :coids %>">
@@ -211,29 +225,50 @@ class BlockColistTemplate < ::Asciidoctor::BaseTemplate
 end
 
 class BlockDlistTemplate < ::Asciidoctor::BaseTemplate
+  LIST_TAGS = {
+    'labeled' => {
+      :list => 'variablelist',
+      :entry => 'varlistentry',
+      :term => 'term',
+      :item => 'listitem'
+    },
+    'qanda' => {
+      :list => 'qandaset',
+      :entry => 'qandaentry',
+      :term => 'question',
+      :item => 'answer'
+    },
+    'glossary' => {
+      :list => nil,
+      :entry => 'glossentry',
+      :term => 'glossterm',
+      :item => 'glossdef'
+    }
+  }
+
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<variablelist#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><% tags = (template.class::LIST_TAGS[attr :style] || template.class::LIST_TAGS['labeled']) %>
+<% if tags[:list] %><<%= tags[:list] %>#{id}#{role}#{xreflabel}><% end %>
   #{title}
   <% content.each do |dt, dd| %>
-  <varlistentry>
-    <term>
+  <<%= tags[:entry] %>>
+    <<%= tags[:term] %>>
       <%= dt.text %>
-    </term>
+    </<%= tags[:term] %>>
     <% unless dd.nil? %>
-    <listitem>
+    <<%= tags[:item] %>>
       <% if dd.text? %>
       <simpara><%= dd.text %></simpara>
       <% end %>
       <% if dd.blocks? %>
 <%= dd.content %>
       <% end %>
-    </listitem>
+    </<%= tags[:item] %>>
     <% end %>
-  </varlistentry>
+  </<%= tags[:entry] %>>
   <% end %>
-</variablelist>
+<% if tags[:list] %></<%= tags[:list] %>><% end %>
     EOF
   end
 end
@@ -241,8 +276,7 @@ end
 class BlockOpenTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOS
-<%#encoding:UTF-8%>
-<%= content %>
+<%#encoding:UTF-8%><%= content %>
     EOS
   end
 end
@@ -250,8 +284,7 @@ end
 class BlockListingTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<% if !title? %>
+<%#encoding:UTF-8%><% if !title? %>
 <% if (attr :style) == 'source' %>
 <programlisting#{id}#{role}#{xreflabel}#{attribute('language', :language)} linenumbering="<%= (attr? :linenums) ? 'numbered' : 'unnumbered' %>"><%= template.preserve_endlines(content, self) %></programlisting>
 <% else %>
@@ -276,8 +309,7 @@ end
 class BlockLiteralTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<% if !title? %>
+<%#encoding:UTF-8%><% if !title? %>
 <literallayout#{id}#{role}#{xreflabel} class="monospaced"><%= template.preserve_endlines(content, self) %></literallayout>
 <% else %>
 <formalpara#{id}#{role}#{xreflabel}>
@@ -294,8 +326,7 @@ end
 class BlockExampleTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<example#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><example#{id}#{role}#{xreflabel}>
   #{title}
 <%= content %>
 </example>
@@ -306,8 +337,7 @@ end
 class BlockSidebarTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<sidebar#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><sidebar#{id}#{role}#{xreflabel}>
   #{title}
 <%= content %>
 </sidebar>
@@ -318,8 +348,7 @@ end
 class BlockQuoteTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<blockquote#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><blockquote#{id}#{role}#{xreflabel}>
   #{title}
   <% if (attr? :attribution) || (attr? :citetitle) %>
   <attribution>
@@ -342,8 +371,7 @@ end
 class BlockVerseTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<blockquote#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><blockquote#{id}#{role}#{xreflabel}>
   #{title}
   <% if (attr? :attribution) || (attr? :citetitle) %>
   <attribution>
@@ -362,8 +390,7 @@ end
 class BlockPassTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOS
-<%#encoding:UTF-8%>
-<%= content %>
+<%#encoding:UTF-8%><%= content %>
     EOS
   end
 end
@@ -371,8 +398,7 @@ end
 class BlockTableTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOS
-<%#encoding:UTF-8%>
-<<%= title? ? 'table' : 'informaltable'%>#{id}#{role}#{xreflabel} frame="<%= attr :frame, 'all'%>"
+<%#encoding:UTF-8%><<%= title? ? 'table' : 'informaltable'%>#{id}#{role}#{xreflabel} frame="<%= attr :frame, 'all'%>"
     rowsep="<%= ['none', 'cols'].include?(attr :grid) ? 0 : 1 %>" colsep="<%= ['none', 'rows'].include?(attr :grid) ? 0 : 1 %>">
   #{title}
   <% if attr? :width %>
@@ -415,8 +441,7 @@ end
 class BlockImageTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%#encoding:UTF-8%>
-<figure#{id}#{role}#{xreflabel}>
+<%#encoding:UTF-8%><%#encoding:UTF-8%><figure#{id}#{role}#{xreflabel}>
   #{title}
   <mediaobject>
     <imageobject>
@@ -432,7 +457,7 @@ end
 class BlockRulerTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<simpara><?asciidoc-hr?></simpara>
+<%#encoding:UTF-8%><simpara><?asciidoc-hr?></simpara>
     EOF
   end
 end
@@ -440,7 +465,7 @@ end
 class InlineBreakTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<%= text %><?asciidoc-br?>
+<%#encoding:UTF-8%><%= text %><?asciidoc-br?>
     EOF
   end
 end
@@ -459,7 +484,7 @@ class InlineQuotedTemplate < ::Asciidoctor::BaseTemplate
 
   def template
     @template ||= @eruby.new <<-EOF
-<% tags = template.class::QUOTED_TAGS[@type] %><%= tags.first %><%
+<%#encoding:UTF-8%><% tags = template.class::QUOTED_TAGS[@type] %><%= tags.first %><%
 if attr? :role %><phrase#{role}><%
 end %><%= @text %><%
 if attr? :role %></phrase><%
@@ -471,7 +496,7 @@ end
 class InlineAnchorTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<% if @type == :xref
+<%#encoding:UTF-8%><% if @type == :xref
 %><%
   if @text.nil?
 %><xref linkend="<%= @target %>"/><%
@@ -480,6 +505,8 @@ class InlineAnchorTemplate < ::Asciidoctor::BaseTemplate
   end %><%
 elsif @type == :ref
 %><anchor id="<%= @target %>" xreflabel="<%= @text %>"/><%
+elsif @type == :bibref
+%><anchor id="<%= @target %>" xreflabel="[<%= @target %>]"/>[<%= @target %>]<%
 else
 %><ulink url="<%= @target %>"><%= @text %></ulink><%
 end %>
@@ -490,7 +517,7 @@ end
 class InlineImageTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<inlinemediaobject>
+<%#encoding:UTF-8%><inlinemediaobject>
   <imageobject>
     <imagedata fileref="<%= image_uri(@target) %>"#{attribute('width', :width)}#{attribute('depth', :height)}/>
   </imageobject>
@@ -500,11 +527,43 @@ class InlineImageTemplate < ::Asciidoctor::BaseTemplate
   end
 end
 
+class InlineFootnoteTemplate < ::Asciidoctor::BaseTemplate
+  def template
+    @template ||= @eruby.new <<-EOS
+<%#encoding:UTF-8%><%
+if type == :xref
+%><footnoteref linkend="<%= @target %>"/><%
+else
+%><footnote#{id}><simpara><%= @text %></simpara></footnote><%
+end %>
+    EOS
+  end
+end
+
 class InlineCalloutTemplate < ::Asciidoctor::BaseTemplate
   def template
     @template ||= @eruby.new <<-EOF
-<co#{id}/>
+<%#encoding:UTF-8%><co#{id}/>
     EOF
   end
 end
+
+class InlineIndextermTemplate < ::Asciidoctor::BaseTemplate
+  def template
+    @template ||= @eruby.new <<-EOS
+<%#encoding:UTF-8%><% if type == :visible %><indexterm><primary><%= @text %></primary></indexterm><%= @text %><%
+else %><% terms = (attr :terms); numterms = terms.size %><%
+if numterms > 2 %><indexterm>
+  <primary><%= terms[0] %></primary><secondary><%= terms[1] %></secondary><tertiary><%= terms[2] %></tertiary>
+</indexterm>
+<% end %><%
+if numterms > 1 %><indexterm>
+  <primary><%= terms[numterms - 2] %></primary><secondary><%= terms[numterms - 1] %></secondary>
+</indexterm>
+<% end %><indexterm>
+  <primary><%= terms[numterms - 1] %></primary>
+</indexterm><% end %>
+    EOS
+  end
+end
 end