asciidoctor 0.1.3 → 0.1.4

data/lib/asciidoctor/abstract_block.rb

@@ -1,5 +1,14 @@
 module Asciidoctor
 class AbstractBlock < AbstractNode
+  # Public: The types of content that this block can accomodate
+  attr_accessor :content_model
+
+  # Public: Substitutions to be applied to content in this block
+  attr_reader :subs
+
+  # Public: Get/Set the String name of the render template
+  attr_accessor :template_name
+
   # Public: Get the Array of Asciidoctor::AbstractBlock sub-blocks for this block
   attr_reader :blocks
 
@@ -9,15 +18,22 @@ class AbstractBlock < AbstractNode
   # Public: Set the String block title.
   attr_writer :title
 
+  # Public: Get/Set the String style (block type qualifier) for this block.
+  attr_accessor :style
+
   # Public: Get/Set the caption for this block
   attr_accessor :caption
 
   def initialize(parent, context)
     super(parent, context)
+    @content_model = :compound
+    @subs = []
+    @template_name = "block_#{context}"
     @blocks = []
     @id = nil
     @title = nil
     @caption = nil
+    @style = nil
     if context == :document
       @level = 0
     elsif !parent.nil? && !self.is_a?(Section)
@@ -25,7 +41,34 @@ class AbstractBlock < AbstractNode
     else
       @level = nil
     end
-    @next_section_index = 0 
+    @next_section_index = 0
+    @next_section_number = 1
+  end
+
+  # Public: Get the rendered String content for this Block.  If the block
+  # has child blocks, the content method should cause them to be
+  # rendered and returned as content that can be included in the
+  # parent block's template.
+  def render
+    @document.playback_attributes @attributes
+    renderer.render(@template_name, self)
+  end
+
+  # Public: Get an rendered version of the block content, rendering the
+  # children appropriate to content model that this block supports.
+  def content
+    @blocks.map {|b| b.render } * EOL
+  end
+
+  # Public: A convenience method that checks whether the specified
+  # substitution is enabled for this block.
+  #
+  # name - The Symbol substitution name
+  #
+  # Returns A Boolean indicating whether the specified substitution is
+  # enabled for this block
+  def sub? name
+    @subs.include? name
   end
 
   # Public: A convenience method that indicates whether the title instance
@@ -58,120 +101,49 @@ class AbstractBlock < AbstractNode
     end
   end
 
+  # Public: Convenience method that returns the interpreted title of the Block
+  # with the caption prepended.
+  #
+  # Concatenates the value of this Block's caption instance variable and the
+  # return value of this Block's title method. No space is added between the
+  # two values. If the Block does not have a caption, the interpreted title is
+  # returned.
+  #
+  # Returns the String title prefixed with the caption, or just the title if no
+  # caption is set
+  def captioned_title
+    %(#{@caption}#{title})
+  end
+
   # Public: Determine whether this Block contains block content
   #
-  # returns Whether this Block has block content
-  #
-  #--
-  # TODO we still need another method that answers
-  # whether this Block *can* have block content
-  # that should be the option 'sectionbody'
+  # Returns A Boolean indicating whether this Block has block content
   def blocks?
     !@blocks.empty?
   end
 
-  # Public: Get the element at i in the array of blocks.
-  #
-  # i - The Integer array index number.
-  #
-  #   section = Section.new
-  #
-  #   section << 'foo'
-  #   section << 'bar'
-  #   section[1]
-  #   => "bar"
-  def [](i)
-    @blocks[i]
-  end
-
   # Public: Append a content block to this block's list of blocks.
   #
   # block - The new child block.
   #
   # Examples
   #
-  #   block = Block.new(parent, :preamble)
+  #   block = Block.new(parent, :preamble, :content_model => :compound)
   #
-  #   block << Block.new(block, :paragraph, 'p1')
-  #   block << Block.new(block, :paragraph, 'p2')
-  #   block.blocks
-  #   # => ["p1", "p2"]
+  #   block << Block.new(block, :paragraph, :source => 'p1')
+  #   block << Block.new(block, :paragraph, :source => 'p2')
+  #   block.blocks?
+  #   # => true
+  #   block.blocks.size
+  #   # => 2
   #
   # Returns nothing.
   def <<(block)
-    if block.is_a?(Section)
-      assign_index(block)
-    end
+    # parent assignment pending refactor
+    #block.parent = self
     @blocks << block
   end
 
-  # Public: Insert a content block at the specified index in this block's
-  # list of blocks.
-  #
-  # i - The Integer array index number.
-  # val = The content block to insert.
-  #
-  #   section = Section.new
-  #
-  #   section << 'foo'
-  #   section << 'baz'
-  #   section.insert(1, 'bar')
-  #   section.blocks
-  #   ["foo", "bar", "baz"]
-  def insert(i, block)
-    @blocks.insert(i, block)
-  end
-
-  # Public: Delete the element at i in the array of section blocks,
-  # returning that element or nil if i is out of range.
-  #
-  # i - The Integer array index number.
-  #
-  #   section = Section.new
-  #
-  #   section << 'foo'
-  #   section << 'bar'
-  #   section.delete_at(1)
-  #   => "bar"
-  #
-  #   section.blocks
-  #   => ["foo"]
-  def delete_at(i)
-    @blocks.delete_at(i)
-  end
-
-  # Public: Clear this Block's list of blocks.
-  #
-  #   section = Section.new
-  #
-  #   section << 'foo'
-  #   section << 'bar'
-  #   section.blocks
-  #   => ["foo", "bar"]
-  #   section.clear_blocks
-  #   section.blocks
-  #   => []
-  def clear_blocks
-    @blocks = []
-  end
-
-  # Public: Get the Integer number of blocks in this block
-  #
-  # Examples
-  #
-  #   section = Section.new
-  #
-  #   section.size
-  #   => 0
-  #
-  #   section << 'foo'
-  #   section << 'bar'
-  #   section.size
-  #   => 2
-  def size
-    @blocks.size
-  end
-
   # Public: Get the Array of child Section objects
   #
   # Only applies to Document and Section instances
@@ -179,9 +151,13 @@ class AbstractBlock < AbstractNode
   # Examples
   # 
   #   section = Section.new(parent)
-  #   section << Block.new(section, :paragraph, 'paragraph 1')
+  #   section << Block.new(section, :paragraph, :source => 'paragraph 1')
   #   section << Section.new(parent)
-  #   section << Block.new(section, :paragraph, 'paragraph 2')
+  #   section << Block.new(section, :paragraph, :source => 'paragraph 2')
+  #   section.blocks?
+  #   # => true
+  #   section.blocks.size
+  #   # => 3
   #   section.sections.size
   #   # => 1
   #
@@ -193,6 +169,55 @@ class AbstractBlock < AbstractNode
     }
   end
 
+  # Internal: Lock-in the substitutions for this block
+  #
+  # Looks for an attribute named "subs". If present, resolves the
+  # substitutions and assigns it to the subs property on this block.
+  # Otherwise, assigns a set of default substitutions based on the
+  # content model of the block.
+  #
+  # Returns nothing
+  def lock_in_subs
+    default_subs = []
+    case @content_model
+    when :simple
+      default_subs = SUBS[:normal]
+    when :verbatim
+      if @context == :listing || (@context == :literal && !(option? 'listparagraph'))
+        default_subs = SUBS[:verbatim]
+      else
+        default_subs = SUBS[:basic]
+      end
+    when :raw
+      default_subs = SUBS[:pass]
+    else
+      return
+    end
+
+    if (custom_subs = @attributes['subs'])
+      @subs = resolve_block_subs custom_subs, @context
+    else
+      @subs = default_subs.dup
+    end
+
+    # QUESION delegate this logic to method?
+    if @context == :listing && @style == 'source' && (@document.basebackend? 'html') &&
+      ((highlighter = @document.attributes['source-highlighter']) == 'coderay' ||
+      highlighter == 'pygments') && (attr? 'language')
+      @subs = @subs.map {|sub| sub == :specialcharacters ? :highlight : sub }
+    end
+  end
+
+  # Public: Remove a substitution from this block
+  #
+  # sub  - The Symbol substitution name
+  #
+  # Returns nothing
+  def remove_sub sub
+    @subs.delete sub
+    nil
+  end
+
   # Public: Generate a caption and assign it to this block if one
   # is not already assigned.
   #
@@ -215,12 +240,12 @@ class AbstractBlock < AbstractNode
     end
 
     if caption.nil?
-      if @document.attr?('caption')
-        @caption = @document.attr('caption')
+      if @document.attributes.has_key? 'caption'
+        @caption = @document.attributes['caption']
       elsif title?
         key ||= @context.to_s
         caption_key = "#{key}-caption"
-        if @document.attributes.has_key?(caption_key)
+        if @document.attributes.has_key? caption_key
           caption_title = @document.attributes["#{key}-caption"]
           caption_num = @document.counter_increment("#{key}-number", self)
           @caption = "#{caption_title} #{caption_num}. "
@@ -243,6 +268,10 @@ class AbstractBlock < AbstractNode
   def assign_index(section)
     section.index = @next_section_index
     @next_section_index += 1
+    if section.numbered
+      section.number = @next_section_number
+      @next_section_number += 1
+    end
   end
 
   # Internal: Reassign the section indexes
@@ -254,6 +283,7 @@ class AbstractBlock < AbstractNode
   # returns nothing
   def reindex_sections
     @next_section_index = 0
+    @next_section_number = 0
     @blocks.each {|block|
       if block.is_a?(Section)
         assign_index(block)

data/lib/asciidoctor/abstract_node.rb

@@ -22,19 +22,30 @@ class AbstractNode
   attr_reader :attributes
 
   def initialize(parent, context)
-    @parent = (context != :document ? parent : nil)
-
-    if !parent.nil?
-      @document = parent.is_a?(Document) ? parent : parent.document
+    # document is a special case, should refer to itself
+    if context == :document
+      @parent = nil
+      @document = parent
     else
-      @document = nil
+      @parent = parent
+      @document = (parent.nil? ? nil : parent.document)
     end
-    
     @context = context
     @attributes = {}
     @passthroughs = []
   end
 
+  # Public: Associate this Block with a new parent Block
+  #
+  # parent - The Block to set as the parent of this Block
+  #
+  # Returns nothing
+  def parent=(parent)
+    @parent = parent
+    @document = parent.document
+    nil
+  end
+
   # Public: Get the value of the specified attribute
   #
   # Get the value for the specified attribute. First look in the attributes on
@@ -53,11 +64,10 @@ class AbstractNode
   def attr(name, default = nil, inherit = true)
     name = name.to_s if name.is_a?(Symbol)
     inherit = false if self == @document
-    if !inherit
-      default.nil? ? @attributes[name] : @attributes.fetch(name, default)
+    if inherit
+      @attributes[name] || @document.attributes[name] || default
     else
-      default.nil? ? @attributes.fetch(name, @document.attr(name)) :
-          @attributes.fetch(name, @document.attr(name, default))
+      @attributes[name] || default
     end
   end
 
@@ -82,21 +92,11 @@ class AbstractNode
     name = name.to_s if name.is_a?(Symbol)
     inherit = false if self == @document
     if expect.nil?
-      if @attributes.has_key? name
-        true
-      elsif inherit
-        @document.attributes.has_key? name
-      else
-        false
-      end
+      @attributes.has_key?(name) || (inherit && @document.attributes.has_key?(name))
+    elsif inherit
+      expect == (@attributes[name] || @document.attributes[name])
     else
-      if @attributes.has_key? name
-        @attributes[name] == expect
-      elsif inherit && @document.attributes.has_key?(name)
-        @document.attributes[name] == expect
-      else
-        false
-      end
+      expect == @attributes[name]
     end
   end
 
@@ -121,6 +121,29 @@ class AbstractNode
     end
   end
 
+  # TODO document me
+  def set_option(name)
+    if @attributes.has_key? 'options'
+      @attributes['options'] = "#{@attributes['options']},#{name}"
+    else
+      @attributes['options'] = name
+    end
+    @attributes["#{name}-option"] = ''
+  end
+
+  # Public: A convenience method to check if the specified option attribute is
+  # enabled on the current node.
+  #
+  # Check if the option is enabled. This method simply checks to see if the
+  # {name}-option attribute is defined on the current node.
+  #
+  # name    - the String or Symbol name of the option
+  #
+  # return a Boolean indicating whether the option has been specified
+  def option?(name)
+    @attributes.has_key? "#{name}-option"
+  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
@@ -161,6 +184,49 @@ class AbstractNode
     @document.renderer
   end
 
+  # Public: A convenience method that checks if the role attribute is specified
+  def role?(expect = nil)
+    if expect.nil?
+      @attributes.has_key?('role') || @document.attributes.has_key?('role')
+    else
+      expect == (@attributes['role'] || @document.attributes['role'])
+    end
+  end
+
+  # Public: A convenience method that returns the value of the role attribute
+  def role
+    @attributes['role'] || @document.attributes['role']
+  end
+
+  # Public: A convenience method that checks if the specified role is present
+  # in the list of roles on this node
+  def has_role?(name)
+    if (val = (@attributes['role'] || @document.attributes['role']))
+      val.split(' ').include?(name)
+    else
+      false
+    end
+  end
+
+  # Public: A convenience method that returns the role names as an Array
+  def roles
+    if (val = (@attributes['role'] || @document.attributes['role']))
+      val.split(' ')
+    else
+      []
+    end
+  end
+
+  # Public: A convenience method that checks if the reftext attribute is specified
+  def reftext?
+    @attributes.has_key?('reftext') || @document.attributes.has_key?('reftext')
+  end
+
+  # Public: A convenience method that returns the value of the reftext attribute
+  def reftext
+    @attributes['reftext'] || @document.attributes['reftext']
+  end
+
   # Public: Construct a reference or data URI to an icon image for the
   # specified icon name.
   #
@@ -269,7 +335,7 @@ class AbstractNode
     end
 
     if !File.readable? image_path
-      puts "asciidoctor: WARNING: image to embed not found or not readable: #{image_path}"
+      warn "asciidoctor: WARNING: image to embed not found or not readable: #{image_path}"
       return "data:#{mimetype}:base64,"
       #return 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='
     end
@@ -297,7 +363,7 @@ class AbstractNode
     if File.readable? path
       File.read(path).chomp
     else
-      puts "asciidoctor: WARNING: file does not exist or cannot be read: #{path}" if warn_on_failure
+      warn "asciidoctor: WARNING: file does not exist or cannot be read: #{path}" if warn_on_failure
       nil
     end
   end
@@ -358,5 +424,21 @@ class AbstractNode
         :target_name => asset_name, :recover => autocorrect)
   end
 
+  # Public: Calculate the relative path to this absolute filename from the Document#base_dir
+  def relative_path(filename)
+    PathResolver.new.relative_path filename, @document.base_dir
+  end
+
+  # Public: Retrieve the list marker keyword for the specified list type.
+  #
+  # For use in the HTML type attribute.
+  #
+  # list_type - the type of list; default to the @style if not specified
+  #
+  # returns the single-character String keyword that represents the marker for the specified list type
+  def list_marker_keyword(list_type = nil)
+    ORDERED_LIST_KEYWORDS[list_type || @style]
+  end
+
 end
 end