asciidoctor 0.1.0 → 0.1.1

data/lib/asciidoctor/block.rb

@@ -1,3 +1,4 @@
+module Asciidoctor
 # Public: Methods for managing blocks of Asciidoc content in a section.
 #
 # Examples
@@ -5,7 +6,7 @@
 #   block = Asciidoctor::Block.new(document, :paragraph, ["`This` is a <test>"])
 #   block.content
 #   => ["<em>This</em> is a &lt;test&gt;"]
-class Asciidoctor::Block < Asciidoctor::AbstractBlock
+class Block < AbstractBlock
 
   # Public: Create alias for context to be consistent w/ AsciiDoc
   alias :blockname :context
@@ -32,7 +33,8 @@ class Asciidoctor::Block < Asciidoctor::AbstractBlock
   # rendered and returned as content that can be included in the
   # parent block's template.
   def render
-    Asciidoctor.debug { "Now rendering #{@context} block for #{self}" }
+    Debug.debug { "Now rendering #{@context} block for #{self}" }
+    @document.playback_attributes @attributes
     out = renderer.render("block_#{@context}", self)
     @document.callouts.next_list if @context == :colist
     out
@@ -40,42 +42,42 @@ class Asciidoctor::Block < Asciidoctor::AbstractBlock
 
   def splain(parent_level = 0)
     parent_level += 1
-    Asciidoctor.puts_indented(parent_level, "Block id: #{id}") unless self.id.nil?
-    Asciidoctor.puts_indented(parent_level, "Block title: #{title}") unless self.title.nil?
-    Asciidoctor.puts_indented(parent_level, "Block caption: #{caption}") unless self.caption.nil?
-    Asciidoctor.puts_indented(parent_level, "Block level: #{level}") unless self.level.nil?
-    Asciidoctor.puts_indented(parent_level, "Block context: #{context}") unless self.context.nil?
+    Debug.puts_indented(parent_level, "Block id: #{id}") unless self.id.nil?
+    Debug.puts_indented(parent_level, "Block title: #{title}") unless self.title.nil?
+    Debug.puts_indented(parent_level, "Block caption: #{caption}") unless self.caption.nil?
+    Debug.puts_indented(parent_level, "Block level: #{level}") unless self.level.nil?
+    Debug.puts_indented(parent_level, "Block context: #{context}") unless self.context.nil?
 
-    Asciidoctor.puts_indented(parent_level, "Blocks: #{@blocks.count}")
+    Debug.puts_indented(parent_level, "Blocks: #{@blocks.count}")
 
     if buffer.is_a? Enumerable
       buffer.each_with_index do |buf, i|
-        Asciidoctor.puts_indented(parent_level, "v" * (60 - parent_level*2))
-        Asciidoctor.puts_indented(parent_level, "Buffer ##{i} is a #{buf.class}")
-        Asciidoctor.puts_indented(parent_level, "Name is #{buf.title rescue 'n/a'}")
+        Debug.puts_indented(parent_level, "v" * (60 - parent_level*2))
+        Debug.puts_indented(parent_level, "Buffer ##{i} is a #{buf.class}")
+        Debug.puts_indented(parent_level, "Name is #{buf.title rescue 'n/a'}")
 
         if buf.respond_to? :splain
           buf.splain(parent_level)
         else
-          Asciidoctor.puts_indented(parent_level, "Buffer: #{buf}")
+          Debug.puts_indented(parent_level, "Buffer: #{buf}")
         end
-        Asciidoctor.puts_indented(parent_level, "^" * (60 - parent_level*2))
+        Debug.puts_indented(parent_level, "^" * (60 - parent_level*2))
       end
     else
       if buffer.respond_to? :splain
         buffer.splain(parent_level)
       else
-        Asciidoctor.puts_indented(parent_level, "Buffer: #{@buffer}")
+        Debug.puts_indented(parent_level, "Buffer: #{@buffer}")
       end
     end
 
     @blocks.each_with_index do |block, i|
-      Asciidoctor.puts_indented(parent_level, "v" * (60 - parent_level*2))
-      Asciidoctor.puts_indented(parent_level, "Block ##{i} is a #{block.class}")
-      Asciidoctor.puts_indented(parent_level, "Name is #{block.title rescue 'n/a'}")
+      Debug.puts_indented(parent_level, "v" * (60 - parent_level*2))
+      Debug.puts_indented(parent_level, "Block ##{i} is a #{block.class}")
+      Debug.puts_indented(parent_level, "Name is #{block.title rescue 'n/a'}")
 
       block.splain(parent_level) if block.respond_to? :splain
-      Asciidoctor.puts_indented(parent_level, "^" * (60 - parent_level*2))
+      Debug.puts_indented(parent_level, "^" * (60 - parent_level*2))
     end
     
     nil
@@ -119,3 +121,4 @@ class Asciidoctor::Block < Asciidoctor::AbstractBlock
     "#{super.to_s} - #@context [blocks:#{(@blocks || []).size}]"
   end
 end
+end

data/lib/asciidoctor/callouts.rb

@@ -1,5 +1,6 @@
+module Asciidoctor
 # Public: Maintains a catalog of callouts and their associations.
-class Asciidoctor::Callouts
+class Callouts
   def initialize
     @lists = []
     @list_index = 0
@@ -115,3 +116,4 @@ class Asciidoctor::Callouts
     "CO#{list_index}-#{co_index}"
   end
 end
+end

data/lib/asciidoctor/cli/invoker.rb

@@ -14,12 +14,12 @@ module Asciidoctor
         @code = 0
         @timings = {}
         options = options.flatten
-        if !options.empty? && options.first.is_a?(Asciidoctor::Cli::Options)
+        if !options.empty? && options.first.is_a?(Cli::Options)
           @options = options.first
         elsif options.first.is_a? Hash
-          @options = Asciidoctor::Cli::Options.new(options)
+          @options = Cli::Options.new(options)
         else
-          @options = Asciidoctor::Cli::Options.parse!(options)
+          @options = Cli::Options.parse!(options)
           # hmmm
           if @options.is_a?(Integer)
             @code = @options

data/lib/asciidoctor/cli/options.rb

@@ -10,7 +10,7 @@ module Asciidoctor
         self[:attributes] = options[:attributes] || {}
         self[:input_file] = options[:input_file] || nil
         self[:output_file] = options[:output_file] || nil
-        self[:safe] = options[:safe] || Asciidoctor::SafeMode::UNSAFE
+        self[:safe] = options[:safe] || SafeMode::UNSAFE
         self[:header_footer] = options[:header_footer] || true
         self[:template_dir] = options[:template_dir] || nil
         if options[:doctype]
@@ -55,15 +55,15 @@ Example: asciidoctor -b html5 source.asciidoc
             self[:output_file] = output_file
           end
           opts.on('--safe',
-                  'set safe mode to safe (default: secure)',
+                  'set safe mode level to safe (default: unsafe)',
                   'enables include macros, but restricts access to ancestor paths of source file',
                   'provided for compatibility with the asciidoc command') do
-            self[:safe] = Asciidoctor::SafeMode::SAFE
+            self[:safe] = SafeMode::SAFE
           end
-          opts.on('-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'secure'],
-                  'set safe mode level explicitly: [unsafe, safe, secure] (default: secure)',
+          opts.on('-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'server', 'secure'],
+                  'set safe mode level explicitly: [unsafe, safe, server, secure] (default: unsafe)',
                   'disables potentially dangerous macros in source files, such as include::[]') do |safe_mode|
-            self[:safe] = Asciidoctor::SafeMode.const_get(safe_mode.upcase)
+            self[:safe] = SafeMode.const_get(safe_mode.upcase)
           end
           opts.on('-s', '--no-header-footer', 'suppress output of header and footer (default: false)') do
             self[:header_footer] = false

data/lib/asciidoctor/debug.rb

@@ -1,24 +1,25 @@
 module Asciidoctor
+module Debug
   @show_debug = nil
-
+  
   def self.debug
     puts yield if self.show_debug_output?
   end
-
+  
   def self.set_debug(value)
     @show_debug = value
   end
-
+  
   def self.show_debug_output?
     @show_debug || (ENV['DEBUG'] == 'true' && ENV['SUPPRESS_DEBUG'] != 'true')
   end
-
+  
   def self.puts_indented(level, *args)
     indentation = " " * level * 2
-
+  
     args.each do |arg|
       self.debug { "#{indentation}#{arg}" }
     end
   end
 end
-
+end

data/lib/asciidoctor/document.rb

@@ -1,3 +1,4 @@
+module Asciidoctor
 # Public: Methods for parsing Asciidoc documents and rendering them
 # using erb templates.
 #
@@ -15,11 +16,19 @@
 #
 # notitle  - The h1 heading should not be shown
 # noheader - The header block (h1 heading, author, revision info) should not be shown
-class Asciidoctor::Document < Asciidoctor::AbstractBlock
-
-  include Asciidoctor
+class Document < AbstractBlock
 
   Footnote = Struct.new(:index, :id, :text)
+  AttributeEntry = Struct.new(:name, :value, :negate) do
+    def initialize(name, value, negate = nil)
+      super(name, value, negate.nil? ? value.nil? : false)
+    end
+
+    def save_to(block_attributes)
+      block_attributes[:attribute_entries] ||= []
+      block_attributes[:attribute_entries] << self
+    end
+  end
 
   # Public A read-only integer value indicating the level of security that
   # should be enforced while processing this document. The value must be
@@ -122,43 +131,66 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     @attributes['asciidoctor-version'] = VERSION
     @attributes['sectids'] = ''
     @attributes['encoding'] = 'UTF-8'
-
-    attribute_overrides = options[:attributes] || {}
+    @attributes['notitle'] = '' if !@options[:header_footer]
+
+    # language strings
+    # TODO load these based on language settings
+    @attributes['caution-caption'] = 'Caution'
+    @attributes['important-caption'] = 'Important'
+    @attributes['note-caption'] = 'Note'
+    @attributes['tip-caption'] = 'Tip'
+    @attributes['warning-caption'] = 'Warning'
+    @attributes['appendix-caption'] = 'Appendix'
+    @attributes['example-caption'] = 'Example'
+    @attributes['figure-caption'] = 'Figure'
+    @attributes['table-caption'] = 'Table'
+    @attributes['toc-title'] = 'Table of Contents'
+
+    @attribute_overrides = options[:attributes] || {}
 
     # the only way to set the include-depth attribute is via the document options
     # 10 is the AsciiDoc default, though currently Asciidoctor only supports 1 level
-    attribute_overrides['include-depth'] ||= 10
+    @attribute_overrides['include-depth'] ||= 10
 
     # if the base_dir option is specified, it overrides docdir as the root for relative paths
     # otherwise, the base_dir is the directory of the source file (docdir) or the current
     # directory of the input is a string
     if options[:base_dir].nil?
-      if attribute_overrides['docdir']
-        @base_dir = attribute_overrides['docdir'] = File.expand_path(attribute_overrides['docdir'])
+      if @attribute_overrides['docdir']
+        @base_dir = @attribute_overrides['docdir'] = File.expand_path(@attribute_overrides['docdir'])
       else
         # perhaps issue a warning here?
-        @base_dir = attribute_overrides['docdir'] = Dir.pwd
+        @base_dir = @attribute_overrides['docdir'] = Dir.pwd
       end
     else
-      @base_dir = attribute_overrides['docdir'] = File.expand_path(options[:base_dir])
+      @base_dir = @attribute_overrides['docdir'] = File.expand_path(options[:base_dir])
+    end
+
+    # allow common attributes backend and doctype to be set using options hash
+    unless @options[:backend].nil?
+      @attribute_overrides['backend'] = @options[:backend]
+    end
+
+    unless @options[:doctype].nil?
+      @attribute_overrides['doctype'] = @options[:doctype]
     end
 
     if @safe >= SafeMode::SERVER
       # restrict document from setting source-highlighter and backend
-      attribute_overrides['source-highlighter'] ||= nil
-      attribute_overrides['backend'] ||= DEFAULT_BACKEND
+      @attribute_overrides['source-highlighter'] ||= nil
+      @attribute_overrides['backend'] ||= DEFAULT_BACKEND
       # restrict document from seeing the docdir and trim docfile to relative path
-      if attribute_overrides.has_key?('docfile') && @parent_document.nil?
-        attribute_overrides['docfile'] = attribute_overrides['docfile'][(attribute_overrides['docdir'].length + 1)..-1]
+      if @attribute_overrides.has_key?('docfile') && @parent_document.nil?
+        @attribute_overrides['docfile'] = @attribute_overrides['docfile'][(@attribute_overrides['docdir'].length + 1)..-1]
       end
-      attribute_overrides['docdir'] = ''
+      @attribute_overrides['docdir'] = ''
       # restrict document from enabling icons
       if @safe >= SafeMode::SECURE
-        attribute_overrides['icons'] ||= nil
+        @attribute_overrides['icons'] ||= nil
       end
     end
     
-    attribute_overrides.delete_if {|key, val|
+    @attribute_overrides.delete_if {|key, val|
       verdict = false
       # a nil or negative key undefines the attribute 
       if val.nil? || key[-1..-1] == '!'
@@ -184,7 +216,7 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
       # don't need to do the extra processing within our own document
       @reader = Reader.new(data)
     else
-      @reader = Reader.new(data, self, attribute_overrides, &block)
+      @reader = Reader.new(data, self, true, &block)
     end
 
     # dynamic intrinstic attribute values
@@ -202,13 +234,11 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     @attributes['iconsdir'] ||= File.join(@attributes.fetch('imagesdir', 'images'), 'icons')
 
     # Now parse the lines in the reader into blocks
-    Lexer.parse(@reader, self) 
-    # or we could make it...
-    #self << *Lexer.parse(@reader, self)
+    Lexer.parse(@reader, self, :header_only => @options.fetch(:parse_header_only, false)) 
 
     @callouts.rewind
 
-    Asciidoctor.debug {
+    Debug.debug {
       msg = []
       msg << "Found #{@blocks.size} blocks in this document:"
       @blocks.each {|b|
@@ -276,12 +306,25 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     end
   end
 
+  def footnotes?
+    not @references[:footnotes].empty?
+  end
+
+  def footnotes
+    @references[:footnotes]
+  end
+
   def nested?
     !@parent_document.nil?
   end
 
   # Make the raw source for the Document available.
   def source
+    @reader.source.join if @reader
+  end
+
+  # Make the raw source lines for the Document available.
+  def source_lines
     @reader.source if @reader
   end
 
@@ -289,13 +332,17 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     @attributes['doctype']
   end
 
+  def backend
+    @attributes['backend']
+  end
+
   # The title explicitly defined in the document attributes
   def title
     @attributes['title']
   end
 
   def title=(title)
-    @header = Section.new self
+    @header ||= Section.new self
     @header.title = title
   end
 
@@ -311,6 +358,20 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   end
   alias :name :doctitle
 
+  # Public: Convenience method to retrieve the document attribute 'author'
+  #
+  # returns the full name of the author as a String
+  def author
+    @attributes['author']
+  end
+
+  # Public: Convenience method to retrieve the document attribute 'revdate'
+  #
+  # returns the date of last revision for the document as a String
+  def revdate
+    @attributes['revdate']
+  end
+
   def notitle
     @attributes.has_key? 'notitle'
   end
@@ -327,6 +388,114 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   def has_header?
     !@header.nil?
   end
+ 
+  # Internal: Branch the attributes so that the original state can be restored
+  # at a future time.
+  def save_attributes
+    # css-signature cannot be updated after header attributes are processed
+    if @id.nil? && @attributes.has_key?('css-signature')
+      @id = @attributes['css-signature']
+    end
+    @original_attributes = @attributes.dup
+  end
+
+  # Internal: Restore the attributes to the previously saved state
+  def restore_attributes
+    @attributes = @original_attributes
+  end
+
+  # Internal: Delete any attributes stored for playback
+  def clear_playback_attributes(attributes)
+    attributes.delete(:attribute_entries)
+  end
+
+  # Internal: Replay attribute assignments at the block level
+  def playback_attributes(block_attributes)
+    if block_attributes.has_key? :attribute_entries
+      block_attributes[:attribute_entries].each do |entry|
+        if entry.negate
+          @attributes.delete(entry.name)
+        else
+          @attributes[entry.name] = entry.value
+        end
+      end
+    end
+  end
+
+  # Public: Set the specified attribute on the document if the name is not locked
+  #
+  # If the attribute is locked, false is returned. Otherwise, the value is
+  # assigned to the attribute name after first performing attribute
+  # substitutions on the value. If the attribute name is 'backend', then the
+  # value of backend-related attributes are updated.
+  #
+  # name  - the String attribute name
+  # value - the String attribute value
+  #
+  # returns true if the attribute was set, false if it was not set because it's locked
+  def set_attribute(name, value)
+    if attribute_locked?(name)
+      false
+    else
+      @attributes[name] = apply_attribute_value_subs(value)
+      if name == 'backend'
+        update_backend_attributes()
+      end
+      true
+    end
+  end
+
+  # Public: Delete the specified attribute from the document if the name is not locked
+  #
+  # If the attribute is locked, false is returned. Otherwise, the attribute is deleted.
+  #
+  # name  - the String attribute name
+  #
+  # returns true if the attribute was deleted, false if it was not because it's locked
+  def delete_attribute(name)
+    if attribute_locked?(name)
+      false
+    else
+      @attributes.delete(name)
+      true
+    end
+  end
+
+  # Public: Determine if the attribute has been locked by being assigned in document options
+  #
+  # key - The attribute key to check
+  #
+  # Returns true if the attribute is locked, false otherwise
+  def attribute_locked?(name)
+    @attribute_overrides.has_key?(name) || @attribute_overrides.has_key?("#{name}!")
+  end
+
+  # Internal: Apply substitutions to the attribute value
+  #
+  # If the value is an inline passthrough macro (e.g., pass:[text]), then
+  # apply the substitutions defined on the macro to the text. Otherwise,
+  # apply the verbatim substitutions to the value.
+  #
+  # value - The String attribute value on which to perform substitutions
+  #
+  # Returns The String value with substitutions performed.
+  def apply_attribute_value_subs(value)
+    if value.match(REGEXP[:pass_macro_basic])
+      # copy match for Ruby 1.8.7 compat
+      m = $~
+      subs = []
+      if !m[1].empty?
+        subs = resolve_subs(m[1])
+      end
+      if !subs.empty?
+        apply_subs(m[2], subs)
+      else
+        m[2]
+      end
+    else
+      apply_header_subs(value)
+    end
+  end
 
   # Public: Update the backend attributes to reflect a change in the selected backend
   def update_backend_attributes()
@@ -355,7 +524,7 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   end
 
   def splain
-    Asciidoctor.debug {
+    Debug.debug {
       msg = ''
       if @header
         msg = "Header is #{@header}"
@@ -381,11 +550,12 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     render_options = {}
 
     # Load up relevant Document @options
-    if @options[:template_dir]
+    if @options.has_key? :template_dir
       render_options[:template_dir] = @options[:template_dir]
     end
     
     render_options[:backend] = @attributes.fetch('backend', 'html5')
+    render_options[:template_engine] = @options[:template_engine]
     render_options[:eruby] = @options.fetch(:eruby, 'erb')
     render_options[:compact] = @options.fetch(:compact, false)
     
@@ -400,6 +570,7 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   # or a template is missing, the renderer will fall back to
   # using the appropriate built-in template.
   def render(opts = {})
+    restore_attributes
     r = renderer(opts)
     @options.merge(opts)[:header_footer] ? r.render('document', self).strip : r.render('embedded', self)
   end
@@ -415,3 +586,4 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   end
 
 end
+end