asciidoctor 0.1.2 → 0.1.3

data/lib/asciidoctor.rb

@@ -1,9 +1,10 @@
-require 'rubygems' unless RUBY_VERSION >= '1.9'
+if RUBY_VERSION < '1.9'
+  require 'rubygems'
+end
 require 'strscan'
 require 'set'
 
 $:.unshift(File.dirname(__FILE__))
-#$:.unshift(File.join(File.dirname(__FILE__), '..', 'vendor'))
 
 # Public: Methods for parsing Asciidoc input files and rendering documents
 # using eRuby templates.
@@ -91,6 +92,12 @@ module Asciidoctor
   # The root path of the Asciidoctor gem
   ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
+  # Flag to indicate whether encoding of external strings needs to be forced to UTF-8
+  # _All_ input data must be force encoded to UTF-8 if Encoding.default_external is *not* UTF-8
+  # Address 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)
+  FORCE_ENCODING = RUBY_VERSION > '1.9' && Encoding.default_external != Encoding::UTF_8
+
   # The default document type
   # Can influence markup generated by render templates
   DEFAULT_DOCTYPE = 'article'
@@ -98,11 +105,9 @@ module Asciidoctor
   # The backend determines the format of the rendered output, default to html5
   DEFAULT_BACKEND = 'html5'
 
-  DEFAULT_STYLESHEET_PATH = File.join(ROOT_PATH, 'stylesheets', 'asciidoctor.css')
-
   DEFAULT_STYLESHEET_KEYS = ['', 'DEFAULT'].to_set
 
-  DEFAULT_STYLESHEET_NAME = File.basename(DEFAULT_STYLESHEET_PATH)
+  DEFAULT_STYLESHEET_NAME = 'asciidoctor.css'
 
   # Pointers to the preferred version for a given backend.
   BACKEND_ALIASES = {
@@ -133,21 +138,22 @@ module Asciidoctor
 
   ADMONITION_STYLES = ['NOTE', 'TIP', 'IMPORTANT', 'WARNING', 'CAUTION'].to_set
 
-  # NOTE: AsciiDoc doesn't support pass style for paragraph
-  PARAGRAPH_STYLES = ['comment', 'example', 'literal', 'listing', 'normal', 'pass', 'quote', 'sidebar', 'source', 'verse'].to_set
+  PARAGRAPH_STYLES = ['comment', 'example', 'literal', 'listing', 'normal', 'pass', 'quote', 'sidebar', 'source', 'verse', 'abstract', 'partintro'].to_set
 
   VERBATIM_STYLES = ['literal', 'listing', 'source', 'verse'].to_set
 
   DELIMITED_BLOCKS = {
-    # NOTE: AsciiDoc doesn't support pass style for open block
-    '--'   => [:open, ['comment', 'example', 'literal', 'listing', 'pass', 'quote', 'sidebar', 'source', 'verse', 'admonition'].to_set],
+    '--'   => [:open, ['comment', 'example', 'literal', 'listing', 'pass', 'quote', 'sidebar', 'source', 'verse', 'admonition', 'abstract', 'partintro'].to_set],
     '----' => [:listing, ['literal', 'source'].to_set],
     '....' => [:literal, ['listing', 'source'].to_set],
     '====' => [:example, ['admonition'].to_set],
     '****' => [:sidebar, Set.new],
     '____' => [:quote, ['verse'].to_set],
+    '""'   => [:quote, ['verse'].to_set],
     '++++' => [:pass, Set.new],
     '|===' => [:table, Set.new],
+    ',===' => [:table, Set.new],
+    ':===' => [:table, Set.new],
     '!===' => [:table, Set.new],
     '////' => [:comment, Set.new],
     '```'  => [:fenced_code, Set.new],
@@ -173,12 +179,19 @@ module Asciidoctor
     :upperroman => /[IVX]+\)/
   }
 
+  ORDERED_LIST_KEYWORDS = {
+    'loweralpha' => 'a',
+    'lowerroman' => 'i',
+    'upperalpha' => 'A',
+    'upperroman' => 'I'
+  }
+
   LIST_CONTINUATION = '+'
 
   LINE_BREAK = ' +'
 
   # NOTE allows for empty space in line as it could be left by the template engine
-  BLANK_LINES_PATTERN = /^\s*\n/
+  BLANK_LINE_PATTERN = /^[[:blank:]]*\n/
 
   LINE_FEED_ENTITY = '&#10;' # or &#x0A;
 
@@ -200,7 +213,12 @@ module Asciidoctor
     # a block to be different lengths
     # this option requires that they be the same
     # Compliance value: false
-    :congruent_block_delimiters => true
+    :congruent_block_delimiters => true,
+
+    # AsciiDoc will recognize commonly-used Markdown syntax
+    # to the degree it does not interfere with existing
+    # AsciiDoc behavior.
+    :markdown_syntax => true
   }
 
   # The following pattern, which appears frequently, captures the contents between square brackets,
@@ -223,10 +241,11 @@ module Asciidoctor
     # [[ref]] (anywhere inline)
     :anchor_macro     => /\\?\[\[([\w":].*?)\]\]/,
 
-    # matches any block delimiter:
-    #   open, listing, example, literal, comment, quote, sidebar, passthrough, table
-    # NOTE position the most common blocks towards the front of the pattern
-    :any_blk          => %r{^(?:--|(?:-|\.|=|\*|_|\+|/){4,}|[\|!]={3,}|(?:`|~){3,}.*)$},
+    # matches any unbounded block delimiter:
+    #   listing, literal, example, sidebar, quote, passthrough, table, fenced code
+    # does not include open block or air quotes
+    # TIP position the most common blocks towards the front of the pattern
+    :any_blk          => %r{^(?:(?:-|\.|=|\*|_|\+|/){4,}|[\|,;!]={3,}|(?:`|~){3,}.*)$},
 
     # detect a list item of any sort
     # [[:graph:]] is a non-blank character
@@ -262,15 +281,15 @@ module Asciidoctor
     # [NOTE, caption="Good to know"]
     # Can be defined by an attribute
     # [{lead}]
-    :blk_attr_list    => /^\[(|[[:blank:]]*[\w\{,"'].*)\]$/,
+    :blk_attr_list    => /^\[(|[[:blank:]]*[\w\{,.#"'].*)\]$/,
 
     # block attribute list or block id (bulk query)
-    :attr_line        => /^\[(|[[:blank:]]*[\w\{,"'].*|\[[^\[\]]*\])\]$/,
+    :attr_line        => /^\[(|[[:blank:]]*[\w\{,.#"'].*|\[[^\[\]]*\])\]$/,
 
     # attribute reference
     # {foo}
     # {counter:pcount:1}
-    :attr_ref         => /(\\?)\{(\w+(?:[\-:]\w+)*)(\\?)\}/,
+    :attr_ref         => /(\\)?\{((set|counter2?):.+?|\w+(?:[\-]\w+)*)(\\)?\}/,
 
     # The author info line the appears immediately following the document title
     # John Doe <john@anonymous.com>
@@ -297,18 +316,18 @@ module Asciidoctor
     # // (and then whatever)
     :comment          => %r{^//(?:[^/]|$)},
 
-    # one,two
-    # one, two
-    # one , two
-    :csv_delimiter    => /[[:blank:]]*,[[:blank:]]*/,
+    # one,two;three;four
+    :ssv_or_csv_delim   => /,|;/,
+
+    # one two	three
+    :space_delim      => /([^\\])[[:blank:]]+/,
 
-    # one;two
-    # one; two
-    # one ; two
-    :semicolon_delim  => /[[:blank:]]*;[[:blank:]]*/,
+    # Ctrl + Alt+T
+    # Ctrl,T
+    :kbd_delim        => /(?:\+|,)(?=[[:blank:]]*[^\1])/,
 
-    # one,two;three;four
-    :scsv_csv_delim   => /[[:blank:]]*[,;][[:blank:]]*/,
+    # one\ two\	three
+    :escaped_space    => /\\([[:blank:]])/,
 
     # 29
     :digits           => /^\d+$/,
@@ -330,14 +349,27 @@ module Asciidoctor
                            '::::' => /^[[:blank:]]*((?:.*[^:])?)(::::)(?:[[:blank:]]+(.*))?$/,
                            ';;' => /^[[:blank:]]*(.*)(;;)(?:[[:blank:]]+(.*))?$/
                          },
-    # ====
-    #:example          => /^={4,}$/,
 
     # footnote:[text]
     # footnoteref:[id,text]
     # footnoteref:[id]
     :footnote_macro   => /\\?(footnote|footnoteref):\[((?:\\\]|[^\]])*?)\]/,
 
+    # kbd:[F3]
+    # kbd:[Ctrl+Shift+T]
+    # kbd:[Ctrl+\]]
+    # kbd:[Ctrl,T]
+    # btn:[Save]
+    :kbd_btn_macro    => /\\?(?:kbd|btn):\[((?:\\\]|[^\]])+?)\]/,
+
+    # menu:File[New...]
+    # menu:View[Page Style > No Style]
+    # menu:View[Page Style, No Style]
+    :menu_macro       => /\\?menu:(\w|\w.*?\S)\[[[:blank:]]*(.+?)?\]/,
+
+    # "File > New..."
+    :menu_inline_macro  => /\\?"(\w[^"]*?[[:blank:]]*&gt;[[:blank:]]*[^"[:blank:]][^"]*)"/,
+
     # image::filename.png[Caption]
     # video::http://youtube.com/12345[Cats vs Dogs]
     :media_blk_macro  => /^(image|video|audio)::(\S+?)\[((?:\\\]|[^\]])*?)\]$/,
@@ -371,7 +403,7 @@ module Asciidoctor
 
     # inline link and some inline link macro
     # FIXME revisit!
-    :link_inline      => %r{(^|link:|\s|>|&lt;|[\(\)\[\]])(\\?(?:https?|ftp)://[^\s\[<]*[^\s.,\[<])(?:\[((?:\\\]|[^\]])*?)\])?},
+    :link_inline      => %r{(^|link:|\s|>|&lt;|[\(\)\[\]])(\\?(?:https?|ftp|irc)://[^\s\[<]*[^\s.,\[<])(?:\[((?:\\\]|[^\]])*?)\])?},
 
     # inline link macro
     # link:path[label]
@@ -381,18 +413,9 @@ module Asciidoctor
     # doc.writer@asciidoc.org
     :email_inline     => /[\\>:]?\w[\w.%+-]*@[[:alnum:]][[:alnum:].-]*\.[[:alpha:]]{2,4}\b/, 
 
-    # ----
-    #:listing          => /^\-{4,}$/,
-
-    # ....
-    #:literal          => /^\.{4,}$/,
-
     # <TAB>Foo  or one-or-more-spaces-or-tabs then whatever
     :lit_par          => /^([[:blank:]]+.*)$/,
 
-    # --
-    #:open_blk         => /^\-\-$/,
-
     # . Foo (up to 5 consecutive dots)
     # 1. Foo (arabic, default)
     # a. Foo (loweralpha)
@@ -406,9 +429,6 @@ module Asciidoctor
     # <<< (pagebreak)
     :break_line        => /^('|<){3,}$/,
 
-    # ++++
-    #:pass             => /^\+{4,}$/,
-
     # inline passthrough macros
     # +++text+++
     # $$text$$
@@ -424,22 +444,13 @@ module Asciidoctor
     :pass_lit         => /(^|[^`\w])(\\?`([^`\s]|[^`\s].*?\S)`)(?![`\w])/m,
 
     # placeholder for extracted passthrough text
-    :pass_placeholder => /\x0(\d+)\x0/,
-
-    # ____
-    #:quote            => /^_{4,}$/,
+    :pass_placeholder => /\e(\d+)\e/,
 
     # The document revision info line the appears immediately following the
     # document title author info line, if present
     # v1.0, 2013-01-01: Ring in the new year release
     :revision_info    => /^(?:\D*(.*?),)?(?:\s*(?!:)(.*?))(?:\s*(?!^):\s*(.*))?$/,
 
-    # '''
-    #:ruler            => /^'{3,}$/,
-
-    # ****
-    #:sidebar_blk      => /^\*{4,}$/,
-
     # \' within a word
     :single_quote_esc => /(\w)\\'(\w)/,
     # an alternative if our backend generated single-quoted html/xml attributes
@@ -448,16 +459,6 @@ module Asciidoctor
     # used for sanitizing attribute names
     :illegal_attr_name_chars => /[^\w\-]/,
 
-    # |===
-    # |table
-    # |===
-    #:table            => /^\|={3,}$/,
-
-    # !===
-    # !table
-    # !===
-    #:table_nested     => /^!={3,}$/,
-
     # 1*h,2*,^3e
     :table_colspec    => /^(?:(\d+)\*)?([<^>](?:\.[<^>]?)?|(?:[<^>]?\.)?[<^>])?(\d+)?([a-z])?$/,
 
@@ -490,7 +491,7 @@ module Asciidoctor
     # match[1] is the delimiter, whose length determines the level
     # match[2] is the title itself
     # match[3] is an inline anchor, which becomes the section id
-    :section_title     => /^(={1,5})\s+(\S.*?)(?:\s*\[\[([^\[]+)\]\])?(?:\s+\1)?$/,
+    :section_title     => /^((?:=|#){1,6})\s+(\S.*?)(?:\s*\[\[([^\[]+)\]\])?(?:\s+\1)?$/,
 
     # does not begin with a dot and has at least one alphanumeric character
     :section_name      => /^((?=.*\w+.*)[^.].*?)$/,
@@ -664,8 +665,9 @@ module Asciidoctor
   # Document object.
   #
   # input   - the AsciiDoc source as a IO, String or Array.
-  # options - a Hash of options to control processing (default: {})
-  #           see Asciidoctor::Document#initialize for details
+  # options - a String, Array or Hash of options to control processing (default: {})
+  #           String and Array values are converted into a Hash.
+  #           See Asciidoctor::Document#initialize for details about options.
   # block   - a callback block for handling include::[] directives
   #
   # returns the Asciidoctor::Document
@@ -674,10 +676,31 @@ module Asciidoctor
       start = Time.now
     end
 
+    attrs = (options[:attributes] ||= {})
+    if attrs.is_a? Hash
+      # all good; placed here as optimization
+    elsif attrs.is_a? Array
+      attrs = options[:attributes] = attrs.inject({}) do |accum, entry|
+        k, v = entry.split '=', 2
+        accum[k] = v || ''
+        accum
+      end
+    elsif attrs.is_a? String
+      # convert non-escaped spaces into null character, so we split on the
+      # correct spaces chars, and restore escaped spaces
+      attrs = attrs.gsub(REGEXP[:space_delim], "\\1\0").gsub(REGEXP[:escaped_space], '\1')
+
+      attrs = options[:attributes] = attrs.split("\0").inject({}) do |accum, entry|
+        k, v = entry.split '=', 2
+        accum[k] = v || ''
+        accum
+      end
+    else
+      raise ArgumentError, 'illegal type for attributes option'
+    end
+
     lines = nil
-    if input.is_a?(File)
-      options[:attributes] ||= {}
-      attrs = options[:attributes]
+    if input.is_a? File
       lines = input.readlines
       input_mtime = input.mtime
       input_path = File.expand_path(input.path)
@@ -721,8 +744,9 @@ module Asciidoctor
   # attributes on the Document.
   #
   # input   - the String AsciiDoc source filename
-  # options - a Hash of options to control processing (default: {})
-  #           see Asciidoctor::Document#initialize for details
+  # options - a String, Array or Hash of options to control processing (default: {})
+  #           String and Array values are converted into a Hash.
+  #           See Asciidoctor::Document#initialize for details about options.
   # block   - a callback block for handling include::[] directives
   #
   # returns the Asciidoctor::Document
@@ -753,8 +777,9 @@ module Asciidoctor
   # default and the rendered output is returned.
   #
   # input   - the String AsciiDoc source filename
-  # options - a Hash of options to control processing (default: {})
-  #           see Asciidoctor::Document#initialize for details
+  # options - a String, Array or Hash of options to control processing (default: {})
+  #           String and Array values are converted into a Hash.
+  #           See Asciidoctor::Document#initialize for details about options.
   # block   - a callback block for handling include::[] directives
   #
   # returns the Document object if the rendered result String is written to a
@@ -785,7 +810,7 @@ module Asciidoctor
     elsif write_in_place
       to_file = File.join(File.dirname(input.path), "#{doc.attributes['docname']}#{doc.attributes['outfilesuffix']}")
     elsif !stream_output && write_to_target
-      working_dir = options.has_key?(:base_dir) ? File.expand_path(opts[:base_dir]) : File.expand_path(Dir.pwd)
+      working_dir = options.has_key?(:base_dir) ? File.expand_path(options[:base_dir]) : File.expand_path(Dir.pwd)
       # QUESTION should the jail be the working_dir or doc.base_dir???
       jail = doc.safe >= SafeMode::SAFE ? working_dir : nil
       if to_dir
@@ -841,14 +866,16 @@ module Asciidoctor
       end
 
       # NOTE document cannot control this behavior if safe >= SafeMode::SERVER
-      if !stream_output && doc.attr?('copycss') &&
+      if !stream_output && doc.attr?('basebackend-html') && doc.attr?('copycss') &&
           doc.attr?('linkcss') && DEFAULT_STYLESHEET_KEYS.include?(doc.attr('stylesheet'))
         Helpers.require_library 'fileutils'
         outdir = doc.attr('outdir')
         stylesdir = doc.normalize_system_path(doc.attr('stylesdir'), outdir,
             doc.safe >= SafeMode::SAFE ? outdir : nil)
-        FileUtils.mkdir_p stylesdir
-        FileUtils.cp DEFAULT_STYLESHEET_PATH, stylesdir, :preserve => true
+        Helpers.mkdir_p stylesdir
+        File.open(File.join(stylesdir, DEFAULT_STYLESHEET_NAME), 'w') {|f|
+          f.write Asciidoctor::HTML5.default_asciidoctor_stylesheet
+        }
       end
       doc
     else
@@ -860,8 +887,9 @@ module Asciidoctor
   # and render it to the specified backend format
   #
   # input   - the String AsciiDoc source filename
-  # options - a Hash of options to control processing (default: {})
-  #           see Asciidoctor::Document#initialize for details
+  # options - a String, Array or Hash of options to control processing (default: {})
+  #           String and Array values are converted into a Hash.
+  #           See Asciidoctor::Document#initialize for details about options.
   # block   - a callback block for handling include::[] directives
   #
   # returns the Document object if the rendered result String is written to a
@@ -870,14 +898,6 @@ module Asciidoctor
     Asciidoctor.render(File.new(filename), options, &block)
   end
 
-  # NOTE still contemplating this method
-  #def self.parse_document_header(input, options = {})
-  #  document = Document.new [], options
-  #  reader = Reader.new input, document, true
-  #  Lexer.parse_document_header reader, document
-  #  document
-  #end
-
   # modules
   require 'asciidoctor/debug'
   require 'asciidoctor/substituters'

data/lib/asciidoctor/abstract_block.rb

@@ -9,11 +9,15 @@ class AbstractBlock < AbstractNode
   # Public: Set the String block title.
   attr_writer :title
 
+  # Public: Get/Set the caption for this block
+  attr_accessor :caption
+
   def initialize(parent, context)
     super(parent, context)
     @blocks = []
     @id = nil
     @title = nil
+    @caption = nil
     if context == :document
       @level = 0
     elsif !parent.nil? && !self.is_a?(Section)
@@ -63,7 +67,7 @@ class AbstractBlock < AbstractNode
   # whether this Block *can* have block content
   # that should be the option 'sectionbody'
   def blocks?
-    !blocks.empty?
+    !@blocks.empty?
   end
 
   # Public: Get the element at i in the array of blocks.
@@ -219,7 +223,7 @@ class AbstractBlock < AbstractNode
         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}. "
+          @caption = "#{caption_title} #{caption_num}. "
         end
       else
         @caption = caption

data/lib/asciidoctor/abstract_node.rb

@@ -43,14 +43,17 @@ class AbstractNode
   # Document node and return the value of the attribute if found. Otherwise,
   # return the default value, which defaults to nil.
   #
-  # name    - the name of the attribute to lookup as a String or Symbol
-  # default - the value to return if the attribute is not found (default: nil)
+  # name    - the String or Symbol name of the attribute to lookup
+  # default - the Object value to return if the attribute is not found (default: nil)
+  # inherit - a Boolean indicating whether to check for the attribute on the
+  #           AsciiDoctor::Document if not found on this node (default: false)
   #
   # return the value of the attribute or the default value if the attribute
   # is not found in the attributes of this node or the document node
-  def attr(name, default = nil)
+  def attr(name, default = nil, inherit = true)
     name = name.to_s if name.is_a?(Symbol)
-    if self == @document
+    inherit = false if self == @document
+    if !inherit
       default.nil? ? @attributes[name] : @attributes.fetch(name, default)
     else
       default.nil? ? @attributes.fetch(name, @document.attr(name)) :
@@ -59,26 +62,29 @@ class AbstractNode
   end
 
   # Public: Check if the attribute is defined, optionally performing a
-  # comparison of its value
+  # comparison of its value if expected is not nil
   #
   # Check if the attribute is defined. First look in the attributes on this
   # node. If not found, and this node is a child of the Document node, look in
   # the attributes of the Document node. If the attribute is found and a
-  # comparison value is specified, return whether the two values match.
+  # comparison value is specified (not nil), return whether the two values match.
   # Otherwise, return whether the attribute was found.
   #
-  # name   - the name of the attribute to lookup as a String or Symbol
-  # expect - the expected value of the attribute (default: nil)
+  # name    - the String or Symbol name of the attribute to lookup
+  # expect  - the expected Object value of the attribute (default: nil)
+  # inherit - a Boolean indicating whether to check for the attribute on the
+  #           AsciiDoctor::Document if not found on this node (default: false)
   #
   # return a Boolean indicating whether the attribute exists and, if a
   # comparison value is specified, whether the value of the attribute matches
   # the comparison value
-  def attr?(name, expect = nil)
+  def attr?(name, expect = nil, inherit = true)
     name = name.to_s if name.is_a?(Symbol)
+    inherit = false if self == @document
     if expect.nil?
       if @attributes.has_key? name
         true
-      elsif self != @document
+      elsif inherit
         @document.attributes.has_key? name
       else
         false
@@ -86,7 +92,7 @@ class AbstractNode
     else
       if @attributes.has_key? name
         @attributes[name] == expect
-      elsif self != @document && @document.attributes.has_key?(name)
+      elsif inherit && @document.attributes.has_key?(name)
         @document.attributes[name] == expect
       else
         false
@@ -251,7 +257,9 @@ class AbstractNode
   def generate_data_uri(target_image, asset_dir_key = nil)
     Helpers.require_library 'base64'
 
-    mimetype = 'image/' + File.extname(target_image)[1..-1]
+    ext = File.extname(target_image)[1..-1]
+    mimetype = 'image/' + ext
+    mimetype = "#{mimetype}+xml" if ext == 'svg'
     if asset_dir_key
       #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')
@@ -287,7 +295,7 @@ class AbstractNode
   # if the file does not exist.
   def read_asset(path, warn_on_failure = false)
     if File.readable? path
-      File.read path
+      File.read(path).chomp
     else
       puts "asciidoctor: WARNING: file does not exist or cannot be read: #{path}" if warn_on_failure
       nil