asciidoctor 1.5.1 → 1.5.2

data/lib/asciidoctor/abstract_block.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 class AbstractBlock < AbstractNode
   # Public: The types of content that this block can accomodate
@@ -167,12 +168,15 @@ class AbstractBlock < AbstractNode
   #   # => 2
   #
   # Returns nothing.
-  def <<(block)
+  def << block
     # parent assignment pending refactor
     #block.parent = self
     @blocks << block
   end
 
+  # NOTE append alias required for adapting to a Java API
+  alias :append :<<
+
   # Public: Get the Array of child Section objects
   #
   # Only applies to Document and Section instances

data/lib/asciidoctor/abstract_node.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: An abstract base class that provides state and methods for managing a
 # node of AsciiDoc content. The state and methods on this class are comment to
@@ -32,6 +33,9 @@ class AbstractNode
       if parent
         @parent = parent
         @document = parent.document
+      else
+        @parent = nil
+        @document = nil
       end
     end
     @context = context
@@ -56,14 +60,18 @@ class AbstractNode
   #
   # Returns [Boolean]
   def inline?
+    # :nocov:
     raise ::NotImplementedError
+    # :nocov:
   end
 
   # Public: Returns whether this {AbstractNode} is an instance of {Block}
   #
   # Returns [Boolean]
   def block?
+    # :nocov:
     raise ::NotImplementedError
+    # :nocov:
   end
 
   # Public: Get the value of the specified attribute
@@ -269,11 +277,7 @@ class AbstractNode
   #
   # Returns A String reference for the target media
   def media_uri(target, asset_dir_key = 'imagesdir')
-    if is_uri? target
-      target
-    else
-      normalize_web_path target, (asset_dir_key ? @document.attr(asset_dir_key) : nil)
-    end
+    normalize_web_path target, (asset_dir_key ? @document.attr(asset_dir_key) : nil)
   end
 
   # Public: Construct a URI reference or data URI to the target image.
@@ -298,9 +302,9 @@ class AbstractNode
   def image_uri(target_image, asset_dir_key = 'imagesdir')
     if (doc = @document).safe < SafeMode::SECURE && doc.attr?('data-uri')
       if is_uri?(target_image) ||
-          (asset_dir_key && (images_base = doc.attr(asset_dir_key)) &&
-          is_uri?(images_base) && (target_image = normalize_web_path target_image, images_base))
-        if doc.attr? 'allow-uri-read'
+          (asset_dir_key && (images_base = doc.attr(asset_dir_key)) && is_uri?(images_base) &&
+          (target_image = normalize_web_path(target_image, images_base, false)))
+        if doc.attr?('allow-uri-read')
           generate_data_uri_from_uri target_image, doc.attr?('cache-uri')
         else
           target_image
@@ -308,8 +312,6 @@ class AbstractNode
       else
         generate_data_uri target_image, asset_dir_key
       end
-    elsif is_uri? target_image
-      target_image
     else
       normalize_web_path target_image, (asset_dir_key ? doc.attr(asset_dir_key) : nil)
     end
@@ -397,18 +399,27 @@ class AbstractNode
   # 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
+  # path - the String path from which to read the contents
+  # opts - a Hash of options to control processing (default: {})
+  #        * :warn_on_failure a Boolean that controls whether a warning
+  #          is issued if the file cannot be read (default: false)
+  #        * :normalize a Boolean that controls whether the lines
+  #          are normalized and coerced to UTF-8 (default: false)
   #
   # Returns the [String] content of the file at the specified path, or nil
   # if the file does not exist.
-  def read_asset(path, warn_on_failure = false)
+  def read_asset(path, opts = {})
+    # remap opts for backwards compatibility
+    opts = { :warn_on_failure => (opts != false) } unless ::Hash === opts
     if ::File.readable? path
-      # QUESTION should we use strip or rstrip instead of chomp here?
-      ::File.read(path).chomp
+      if opts[:normalize]
+        # QUESTION should we strip content?
+        Helpers.normalize_lines_from_string(::IO.read(path)) * EOL
+      else
+        ::IO.read(path)
+      end
     else
-      warn "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 opts[:warn_on_failure]
       nil
     end
   end
@@ -417,12 +428,17 @@ class AbstractNode
   #
   # See {PathResolver#web_path} for details.
   #
-  # target - the String target path
-  # start  - the String start (i.e, parent) path (optional, default: nil)
+  # target              - the String target path
+  # start               - the String start (i.e, parent) path (optional, default: nil)
+  # preserve_uri_target - a Boolean indicating whether target should be preserved if contains a URI (default: true)
   #
   # Returns the resolved [String] path 
-  def normalize_web_path(target, start = nil)
-    (@path_resolver ||= PathResolver.new).web_path(target, start)
+  def normalize_web_path(target, start = nil, preserve_uri_target = true)
+    if preserve_uri_target && is_uri?(target)
+      target
+    else
+      (@path_resolver ||= PathResolver.new).web_path target, start
+    end
   end
 
   # Public: Resolve and normalize a secure path from the target and start paths
@@ -451,9 +467,10 @@ class AbstractNode
   # 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 = {}
+    path_resolver = (@path_resolver ||= PathResolver.new)
     if (doc = @document).safe < SafeMode::SAFE
       if start
-        start = ::File.join doc.base_dir, start unless (@path_resolver ||= PathResolver.new).is_root? start
+        start = ::File.join doc.base_dir, start unless path_resolver.is_root? start
       else
         start = doc.base_dir
       end
@@ -461,7 +478,7 @@ class AbstractNode
       start = doc.base_dir unless start
       jail = doc.base_dir unless jail
     end
-    (@path_resolver ||= PathResolver.new).system_path target, start, jail, opts
+    path_resolver.system_path target, start, jail, opts
   end
 
   # Public: Normalize the asset file or directory to a concrete and rinsed path

data/lib/asciidoctor/attribute_list.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Handles parsing AsciiDoc attribute lists into a Hash of key/value
 # pairs. By default, attributes must each be separated by a comma and quotes
@@ -22,11 +23,19 @@ module Asciidoctor
 #
 class AttributeList
 
+  # FIXME Opal not inheriting constants from parent scope
+  # NOTE can't use ::RUBY_ENGINE_OPAL here either
+  if ::RUBY_ENGINE == 'opal'
+    CG_BLANK = '[ \\t]'
+    CC_WORD  = 'a-zA-Z0-9_'
+    CG_WORD  = '[a-zA-Z0-9_]'
+  end
+
   # Public: Regular expressions for detecting the boundary of a value
   BoundaryRxs = {
     '"' => /.*?[^\\](?=")/,
     '\'' => /.*?[^\\](?=')/,
-    ',' => /.*?(?=[ \t]*(,|$))/
+    ',' => /.*?(?=#{CG_BLANK}*(,|$))/
   }
 
   # Public: Regular expressions for unescaping quoted characters
@@ -35,16 +44,16 @@ class AttributeList
     '\'' => /\\'/
   }
 
-  # Public: A regular expression for an attribute name
+  # Public: A regular expression for an attribute name (approx. name token from XML)
   # TODO named attributes cannot contain dash characters
-  NameRx = /[A-Za-z:_][A-Za-z:_\-.]*/
+  NameRx = /#{CG_WORD}[#{CC_WORD}\-.]*/
 
-  BlankRx = /[ \t]+/
+  BlankRx = /#{CG_BLANK}+/
 
   # Public: Regular expressions for skipping blanks and delimiters
   SkipRxs = {
     :blank => BlankRx,
-    ',' => /[ \t]*(,|$)/
+    ',' => /#{CG_BLANK}*(,|$)/
   }
 
   def initialize source, block = nil, delimiter = ','

data/lib/asciidoctor/block.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods for managing blocks of Asciidoc content in a section.
 #
@@ -8,7 +9,7 @@ module Asciidoctor
 #   => "<em>This</em> is a &lt;test&gt;"
 class Block < AbstractBlock
 
-  DEFAULT_CONTENT_MODEL = ::Hash.new(:simple).merge({
+  DEFAULT_CONTENT_MODEL = {
     # TODO should probably fill in all known blocks
     :audio => :empty,
     :image => :empty,
@@ -20,7 +21,8 @@ class Block < AbstractBlock
     :pass => :raw,
     :thematic_break => :empty,
     :video => :empty
-  })
+  }
+  DEFAULT_CONTENT_MODEL.default = :simple
 
   # Public: Create alias for context to be consistent w/ AsciiDoc
   alias :blockname :context
@@ -37,25 +39,56 @@ class Block < AbstractBlock
   #                     how the lines should be processed (:simple, :verbatim, :raw, :empty). (default: :simple)
   #                 * :attributes a Hash of attributes (key/value pairs) to assign to this Block. (default: {})
   #                 * :source a String or Array of raw source for this Block. (default: nil)
+  #
+  # IMPORTANT: If you don't specify the `:subs` option, you must explicitly call
+  # the `lock_in_subs` method to resolve and assign the substitutions to this
+  # block (which are resolved from the `subs` attribute, if specified, or the
+  # default substitutions based on this block's context). If you want to use the
+  # default subs for a block, pass the option `:subs => :default`. You can
+  # override the default subs using the `:default_subs` option.
   #--
   # QUESTION should we store source_data as lines for blocks that have compound content models?
   def initialize parent, context, opts = {}
     super
     @content_model = opts[:content_model] || DEFAULT_CONTENT_MODEL[context]
-    if opts.has_key? :subs
-      # FIXME this is a bit funky
-      # we have to be defensive to avoid lock_in_subs wiping out the override
-      if !(subs = opts[:subs]) || (subs.is_a? ::Array)
-        @subs = subs || []
-        @default_subs = @subs.dup
-        @attributes.delete('subs')
+    if opts.key? :subs
+      # FIXME feels funky; we have to be defensive to get lock_in_subs to honor override
+      # FIXME does not resolve substitution groups inside Array (e.g., [:normal])
+      if (subs = opts[:subs])
+        # e.g., :subs => :defult
+        # subs attribute is honored; falls back to opts[:default_subs], then built-in defaults based on context
+        if subs == :default
+          @default_subs = opts[:default_subs]
+        # e.g., :subs => [:quotes]
+        # subs attribute is not honored
+        elsif ::Array === subs
+          @default_subs = subs.dup
+          @attributes.delete 'subs'
+        # e.g., :subs => :normal or :subs => 'normal'
+        # subs attribute is not honored
+        else
+          @default_subs = nil
+          # interpolation is the fastest way to dup subs as a string
+          @attributes['subs'] = %(#{subs})
+        end
+        # resolve the subs eagerly only if subs option is specified
+        lock_in_subs
+      # e.g., :subs => nil
       else
-        @attributes['subs'] = %(#{subs})
+        @subs = []
+        # prevent subs from being resolved
+        @default_subs = []
+        @attributes.delete 'subs'
       end
+    # defer subs resolution; subs attribute is honored
+    else
+      @subs = []
+      # QUESTION should we honor :default_subs option (i.e., @default_subs = opts[:default_subs])?
+      @default_subs = nil
     end
-    if !(raw_source = opts[:source])
+    if (raw_source = opts[:source]).nil_or_empty?
       @lines = []
-    elsif raw_source.is_a? ::String
+    elsif ::String === raw_source
       @lines = Helpers.normalize_lines_from_string raw_source
     else
       @lines = raw_source.dup

data/lib/asciidoctor/callouts.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Maintains a catalog of callouts and their associations.
 class Callouts

data/lib/asciidoctor/cli/invoker.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
   module Cli
     # Public Invocation class for starting Asciidoctor via CLI
@@ -104,8 +105,11 @@ module Asciidoctor
             raise e
           else
             err = (@err || $stderr)
-            err.print %(#{e.class}: ) if ::RuntimeError === e
-            err.puts e.message
+            if ::RuntimeError === e
+              err.puts %(#{e.message} (#{e.class}))
+            else
+              err.puts e.message
+            end
             err.puts '  Use --trace for backtrace'
           end
         end

data/lib/asciidoctor/cli/options.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
   module Cli
 
@@ -49,7 +50,7 @@ Example: asciidoctor -b html5 source.asciidoc
                   'document type to use when converting document: [article, book, manpage, inline] (default: article)') do |doc_type|
             self[:attributes]['doctype'] = doc_type
           end
-          opts.on('-o', '--out-file FILE', 'output file (default: based on input file path); use - to output to STDOUT') do |output_file|
+          opts.on('-o', '--out-file FILE', 'output file (default: based on path of input file); use - to output to STDOUT') do |output_file|
             self[:output_file] = output_file
           end
           opts.on('--safe',
@@ -134,9 +135,7 @@ Example: asciidoctor -b html5 source.asciidoc
           end
 
           opts.on_tail('-V', '--version', 'display the version and runtime environment (or -v if no other flags or arguments)') do
-            $stdout.puts %(Asciidoctor #{::Asciidoctor::VERSION} [http://asciidoctor.org])
-            $stdout.puts %(Runtime Environment (#{RUBY_DESCRIPTION}))
-            return 0
+            return print_version $stdout
           end
           
         end
@@ -146,9 +145,7 @@ Example: asciidoctor -b html5 source.asciidoc
         
         if args.empty?
           if self[:verbose] == 2
-            $stdout.puts %(Asciidoctor #{::Asciidoctor::VERSION} [http://asciidoctor.org])
-            $stdout.puts %(Runtime Environment (#{RUBY_DESCRIPTION}))
-            return 0
+            return print_version $stdout
           else
             $stderr.puts opts_parser
             return 1
@@ -183,8 +180,12 @@ Example: asciidoctor -b html5 source.asciidoc
         end
 
         infiles.each do |file|
-          unless file == '-' || (::File.readable? file)
-            $stderr.puts %(asciidoctor: FAILED: input file #{file} missing or cannot be read)
+          unless file == '-' || (::File.file? file)
+            if ::File.readable? file
+              $stderr.puts %(asciidoctor: FAILED: input path #{file} is a #{(::File.stat file).ftype}, not a file)
+            else
+              $stderr.puts %(asciidoctor: FAILED: input file #{file} missing or cannot be read)
+            end
             return 1
           end
         end
@@ -238,6 +239,19 @@ Example: asciidoctor -b html5 source.asciidoc
         $stdout.puts opts_parser
         return 1
       end
+
+      def print_version os = $stdout
+        os.puts %(Asciidoctor #{::Asciidoctor::VERSION} [http://asciidoctor.org])
+        if RUBY_VERSION >= '1.9.3'
+          encoding_info = {'lc' => 'locale', 'fs' => 'filesystem', 'in' => 'internal', 'ex' => 'external'}.map do |k,v|
+            %(#{k}:#{Encoding.find(v) || '-'})
+          end
+          os.puts %(Runtime Environment (#{RUBY_DESCRIPTION}) (#{encoding_info * ' '}))
+        else
+          os.puts %(Runtime Environment (#{RUBY_DESCRIPTION}))
+        end
+        0
+      end
     end
   end
 end

data/lib/asciidoctor/converter.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
   # A base module for defining converters that can be used to convert {AbstractNode}
   # objects in a parsed AsciiDoc document to a backend format such as HTML or
@@ -160,9 +161,9 @@ module Asciidoctor
     end
 =end
 
-    # Public: Converts an {AbstractNode} using the specified transform. If a
-    # transform is not specified, implementations typically derive one from the
-    # {AbstractNode#node_name} property.
+    # Public: Converts an {AbstractNode} using the specified transform along
+    # with additional options. If a transform is not specified, implementations
+    # typically derive one from the {AbstractNode#node_name} property.
     #
     # Implementations are free to decide how to carry out the conversion. In
     # the case of the built-in converters, the tranform value is used to
@@ -174,27 +175,16 @@ module Asciidoctor
     #             should be applied to this node. If a transform is not specified,
     #             the transform is typically derived from the value of the
     #             node's node_name property. (optional, default: nil)
+    # opts      - An optional Hash of options that provide additional hints about
+    #             how to convert the node. (optional, default: {})
     #
     # Returns the [String] result
-    def convert node, transform = nil
+    def convert node, transform = nil, opts = {}
       raise ::NotImplementedError
     end
 
-    # Public: Converts an {AbstractNode} using the specified transform along
-    # with additional options. Delegates to {#convert} without options by default.
-    #
-    # node      - The concrete instance of AbstractNode to convert
-    # transform - An optional String transform that hints at which transformation
-    #             should be applied to this node. If a transform is not specified,
-    #             the transform is typically derived from the value of the
-    #             node's node_name property. (optional, default: nil)
-    # opts      - An optional Hash of options that provide additional hints about
-    #             how to convert the node.
-    #
-    # Returns the [String] result
-    def convert_with_options node, transform = nil, opts = {}
-      convert node, transform
-    end
+    # Alias for backward compatibility.
+    alias :convert_with_options :convert
   end
 
   # A module that can be used to mix the {#write} method into a {Converter}

data/lib/asciidoctor/converter/base.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
   module Converter; end # required for Opal
 
@@ -16,25 +17,21 @@ module Asciidoctor
     def initialize backend, opts = {}
     end
 
-    # Public: Converts the specified {AbstractNode} using the specified transform.
+    # Public: Converts the specified {AbstractNode} using the specified
+    # transform and optionally additional options (when not empty).
     #
-    # See {Converter#convert} for more details.
+    # CAUTION: Method that handles the specified transform *may not* accept the
+    # second argument with additional options, in which case an {ArgumentError}
+    # is raised if the given +opts+ Hash is not nil. The additional options are
+    # used in template-based backends to access convert helper methods such as
+    # outline.
     #
-    # Returns the [String] result of conversion
-    def convert node, transform = nil
-      transform ||= node.node_name
-      send transform, node
-    end
-
-    # Public: Converts the specified {AbstractNode} using the specified transform 
-    # with additional options.
-    #
-    # See {Converter#convert_with_options} for more details.
+    # See {Converter#convert} for more details.
     #
     # Returns the [String] result of conversion
-    def convert_with_options node, transform = nil, opts = {}
+    def convert node, transform = nil, opts = {}
       transform ||= node.node_name
-      send transform, node, opts
+      opts.empty? ? (send transform, node) : (send transform, node, opts)
     end
 
     alias :handles? :respond_to?