asciidoctor 1.5.6.2 → 1.5.7

data/lib/asciidoctor/extensions.rb

@@ -1,3 +1,6 @@
+# NOTE .to_s hides require from Opal
+require 'asciidoctor'.to_s unless defined? Asciidoctor
+
 # encoding: UTF-8
 module Asciidoctor
 # Extensions provide a way to participate in the parsing and converting
@@ -107,37 +110,46 @@ module Extensions
     # opts   - An optional Hash of options (default: {}):
     #          :level    - [Integer] The level to assign to this section; defaults to
     #                      one greater than the parent level (optional).
-    #          :numbered - [Boolean] A flag to force numbering, which falls back to the 
+    #          :numbered - [Boolean] A flag to force numbering, which falls back to the
     #                      state of the sectnums document attribute (optional).
     #
     # Returns a [Section] node with all properties properly initialized.
     def create_section parent, title, attrs, opts = {}
       doc = parent.document
-      doctype, level = doc.doctype, (opts[:level] || parent.level + 1)
+      book = (doctype = doc.doctype) == 'book'
+      level = opts[:level] || parent.level + 1
       if (style = attrs.delete 'style')
-        if style == 'abstract' && doctype == 'book'
+        if book && style == 'abstract'
           sectname, level = 'chapter', 1
         else
           sectname, special = style, true
           level = 1 if level == 0
         end
-      elsif doctype == 'book'
-        sectname = level == 0 ? 'part' : (level == 1 ? 'chapter' : 'section')
+      elsif book
+        sectname = level == 0 ? 'part' : (level > 1 ? 'section' : 'chapter')
       elsif doctype == 'manpage' && (title.casecmp 'synopsis') == 0
         sectname, special = 'synopsis', true
       else
         sectname = 'section'
       end
-      sect = Section.new parent, level, false
+      sect = Section.new parent, level
       sect.title, sect.sectname = title, sectname
       if special
         sect.special = true
-        sect.numbered = true if opts.fetch :numbered, (style == 'appendix')
-      elsif opts.fetch :numbered, (level > 0 && (doc.attributes.key? 'sectnums'))
-        sect.numbered = sect.special ? (parent.context == :section && parent.numbered) : true
+        if opts.fetch :numbered, (style == 'appendix')
+          sect.numbered = true
+        elsif !(opts.key? :numbered) && (doc.attr? 'sectnums', 'all')
+          sect.numbered = book && level == 1 ? :chapter : true
+        end
+      elsif level > 0
+        if opts.fetch :numbered, (doc.attr? 'sectnums')
+          sect.numbered = sect.special ? parent.numbered && true : true
+        end
+      else
+        sect.numbered = true if opts.fetch :numbered, (book && (doc.attr? 'partnums'))
       end
       unless (id = attrs.delete 'id') == false
-        sect.id = attrs['id'] = id || ((doc.attributes.key? 'sectids') ? (Section.generate_id sect.title, doc) : nil)
+        sect.id = attrs['id'] = id || ((doc.attr? 'sectids') ? (Section.generate_id sect.title, doc) : nil)
       end
       sect.update_attributes attrs
       sect
@@ -152,7 +164,7 @@ module Extensions
     # parent - The parent Block (Block, Section, or Document) of this new image block.
     # attrs  - A Hash of attributes to control how the image block is built.
     #          Use the target attribute to set the source of the image.
-    #          Use the alt attribute to specify an alternate text for the image.
+    #          Use the alt attribute to specify an alternative text for the image.
     # opts   - An optional Hash of options (default: {})
     #
     # Returns a [Block] node with all properties properly initialized.
@@ -643,13 +655,12 @@ module Extensions
     # Public: Returns the {Asciidoctor::Document} on which the extensions in this registry are being used.
     attr_reader :document
 
-    # Public: Returns the Array of {Group} classes, instances and/or Procs that have been registered.
+    # Public: Returns the Hash of {Group} classes, instances, and/or Procs that have been registered with this registry.
     attr_reader :groups
 
     def initialize groups = {}
       @groups = groups
-      @preprocessor_extensions = @tree_processor_extensions = @postprocessor_extensions = @include_processor_extensions = @docinfo_processor_extensions = nil
-      @block_extensions = @block_macro_extensions = @inline_macro_extensions = nil
+      @preprocessor_extensions = @tree_processor_extensions = @postprocessor_extensions = @include_processor_extensions = @docinfo_processor_extensions = @block_extensions = @block_macro_extensions = @inline_macro_extensions = nil
       @document = nil
     end
 
@@ -661,19 +672,21 @@ module Extensions
     # Returns the instance of this [Registry].
     def activate document
       @document = document
-      (Extensions.groups.values + @groups.values).each do |group|
-        case group
-        when ::Proc
-          case group.arity
-          when 0, -1
-            instance_exec(&group)
-          when 1
-            group.call self
+      unless (ext_groups = Extensions.groups.values + @groups.values).empty?
+        ext_groups.each do |group|
+          case group
+          when ::Proc
+            case group.arity
+            when 0, -1
+              instance_exec(&group)
+            when 1
+              group.call self
+            end
+          when ::Class
+            group.new.activate self
+          else
+            group.activate self
           end
-        when ::Class
-          group.new.activate self
-        else
-          group.activate self
         end
       end
       self
@@ -705,7 +718,7 @@ module Extensions
     #
     #   # as a method block
     #   preprocessor do
-    #     process |doc, reader|
+    #     process do |doc, reader|
     #       ...
     #     end
     #   end
@@ -757,7 +770,7 @@ module Extensions
     #
     #   # as a method block
     #   tree_processor do
-    #     process |document|
+    #     process do |document|
     #       ...
     #     end
     #   end
@@ -814,7 +827,7 @@ module Extensions
     #
     #   # as a method block
     #   postprocessor do
-    #     process |document, output|
+    #     process do |document, output|
     #       ...
     #     end
     #   end
@@ -866,7 +879,7 @@ module Extensions
     #
     #   # as a method block
     #   include_processor do
-    #     process |document, output|
+    #     process do |document, output|
     #       ...
     #     end
     #   end
@@ -918,7 +931,7 @@ module Extensions
     #
     #   # as a method block
     #   docinfo_processor do
-    #     process |doc|
+    #     process do |doc|
     #       at_location :footer
     #       'footer content'
     #     end
@@ -1007,14 +1020,14 @@ module Extensions
     #   # as a method block
     #   block do
     #     named :shout
-    #     process |parent, reader, attrs|
+    #     process do |parent, reader, attrs|
     #       ...
     #     end
     #   end
     #
     #   # as a method block with an explicit block name
     #   block :shout do
-    #     process |parent, reader, attrs|
+    #     process do |parent, reader, attrs|
     #       ...
     #     end
     #   end
@@ -1096,14 +1109,14 @@ module Extensions
     #   # as a method block
     #   block_macro do
     #     named :gist
-    #     process |parent, target, attrs|
+    #     process do |parent, target, attrs|
     #       ...
     #     end
     #   end
     #
     #   # as a method block with an explicit macro name
     #   block_macro :gist do
-    #     process |parent, target, attrs|
+    #     process do |parent, target, attrs|
     #       ...
     #     end
     #   end
@@ -1168,7 +1181,7 @@ module Extensions
     #   inline_macro ChromeInlineMacro
     #
     #   # as an InlineMacroProcessor subclass with an explicit macro name
-    #   inline_macro ChromeInineMacro, :chrome
+    #   inline_macro ChromeInlineMacro, :chrome
     #
     #   # as an instance of an InlineMacroProcessor subclass
     #   inline_macro ChromeInlineMacro.new
@@ -1180,19 +1193,19 @@ module Extensions
     #   inline_macro 'ChromeInlineMacro'
     #
     #   # as a name of an InlineMacroProcessor subclass with an explicit macro name
-    #   inline_macro 'ChromeInineMacro', :chrome
+    #   inline_macro 'ChromeInlineMacro', :chrome
     #
     #   # as a method block
     #   inline_macro do
     #     named :chrome
-    #     process |parent, target, attrs|
+    #     process do |parent, target, attrs|
     #       ...
     #     end
     #   end
     #
     #   # as a method block with an explicit macro name
     #   inline_macro :chrome do
-    #     process |parent, target, attrs|
+    #     process do |parent, target, attrs|
     #       ...
     #     end
     #   end
@@ -1477,17 +1490,36 @@ module Extensions
     # Public: Resolves the Class object for the qualified name.
     #
     # Returns Class
-    def class_for_name qualified_name
-      resolved = ::Object
-      (qualified_name.split '::').each do |name|
-        unless name.empty? || ((resolved.const_defined? name) && ::Module === (resolved = resolved.const_get name))
-          raise ::NameError, %(Could not resolve class for name: #{qualified_name})
+    if RUBY_MIN_VERSION_2
+      def class_for_name qualified_name
+        resolved = ::Object.const_get qualified_name, false
+        raise unless ::Class === resolved
+        resolved
+      rescue
+        raise ::NameError, %(Could not resolve class for name: #{qualified_name})
+      end
+    elsif RUBY_MIN_VERSION_1_9
+      def class_for_name qualified_name
+        resolved = (qualified_name.split '::').reduce ::Object do |current, name|
+          name.empty? ? current : (current.const_get name, false)
         end
+        raise unless ::Class === resolved
+        resolved
+      rescue
+        raise ::NameError, %(Could not resolve class for name: #{qualified_name})
+      end
+    else
+      def class_for_name qualified_name
+        resolved = (qualified_name.split '::').reduce ::Object do |current, name|
+          # NOTE on Ruby 1.8, const_defined? only checks for constant in current scope
+          name.empty? ? current : ((current.const_defined? name) ? (current.const_get name) : raise)
+        end
+        raise unless ::Class === resolved
+        resolved
+      rescue
+        raise ::NameError, %(Could not resolve class for name: #{qualified_name})
       end
-      raise ::NameError, %(Could not resolve class for name: #{qualified_name}) unless ::Class === resolved
-      resolved
     end
   end
-
 end
 end

data/lib/asciidoctor/helpers.rb

@@ -16,29 +16,31 @@ module Helpers
   #              (default: true)
   # on_failure - a Symbol that indicates how to handle a load failure (:abort, :warn, :ignore) (default: :abort)
   #
-  # returns The return value of Kernel#require if the library is available and can be, or was previously, loaded.
-  # Otherwise, Kernel#raise is called with an appropriate message if on_failure is :abort.
-  # Otherwise, Kernel#warn is called with an appropriate message and nil returned if on_failure is :warn.
+  # Returns The [Boolean] return value of Kernel#require if the library can be loaded.
+  # Otherwise, if on_failure is :abort, Kernel#raise is called with an appropriate message.
+  # Otherwise, if on_failure is :warn, Kernel#warn is called with an appropriate message and nil returned.
   # Otherwise, nil is returned.
   def self.require_library name, gem_name = true, on_failure = :abort
     require name
   rescue ::LoadError => e
+    include Logging unless include? Logging
     if gem_name
       gem_name = name if gem_name == true
       case on_failure
       when :abort
         raise ::LoadError, %(asciidoctor: FAILED: required gem '#{gem_name}' is not installed. Processing aborted.)
       when :warn
-        warn %(asciidoctor: WARNING: optional gem '#{gem_name}' is not installed. Functionality disabled.)
+        logger.warn %(optional gem '#{gem_name}' is not installed. Functionality disabled.)
       end
     else
       case on_failure
       when :abort
         raise ::LoadError, %(asciidoctor: FAILED: #{e.message.chomp '.'}. Processing aborted.)
       when :warn
-        warn %(asciidoctor: WARNING: #{e.message.chomp '.'}. Functionality disabled.)
+        logger.warn %(#{e.message.chomp '.'}. Functionality disabled.)
       end
     end
+    nil
   end
 
   # Public: Normalize the data to prepare for parsing
@@ -48,7 +50,7 @@ module Helpers
   #
   # returns a String Array of normalized lines
   def self.normalize_lines data
-    data.class == ::String ? (normalize_lines_from_string data) : (normalize_lines_array data)
+    ::String === data ? (normalize_lines_from_string data) : (normalize_lines_array data)
   end
 
   # Public: Normalize the array of lines to prepare them for parsing
@@ -195,14 +197,34 @@ module Helpers
     end
   end
 
-  def self.mkdir_p(dir)
+  def self.mkdir_p dir
     unless ::File.directory? dir
-      parent_dir = ::File.dirname(dir)
-      if !::File.directory?(parent_dir = ::File.dirname(dir)) && parent_dir != '.'
-        mkdir_p(parent_dir)
+      unless (parent_dir = ::File.dirname dir) == '.'
+        mkdir_p parent_dir
+      end
+      begin
+        ::Dir.mkdir dir
+      rescue ::SystemCallError
+        raise unless ::File.directory? dir
       end
-      ::Dir.mkdir(dir)
     end
   end
+
+  ROMAN_NUMERALS = {
+    'M' => 1000, 'CM' => 900, 'D' => 500, 'CD' => 400, 'C' => 100, 'XC' => 90,
+    'L' => 50, 'XL' => 40, 'X' => 10, 'IX' => 9, 'V' => 5, 'IV' => 4, 'I' => 1
+  }
+
+  # Converts an integer to a Roman numeral.
+  #
+  # val - the [Integer] value to convert
+  #
+  # Returns the [String] roman numeral for this integer
+  def self.int_to_roman val
+    ROMAN_NUMERALS.map {|l, i|
+      repeat, val = val.divmod i
+      l * repeat
+    }.join
+  end
 end
 end

data/lib/asciidoctor/inline.rb

@@ -21,8 +21,9 @@ class Inline < AbstractNode
     @type = opts[:type]
     @target = opts[:target]
 
-    unless (more_attributes = opts[:attributes]).nil_or_empty?
-      update_attributes more_attributes
+    # value of attributes option for inline nodes may be nil
+    if (attrs = opts[:attributes])
+      @attributes = attrs.dup
     end
   end
 

data/lib/asciidoctor/list.rb

@@ -73,7 +73,8 @@ class ListItem < AbstractBlock
   #
   # Returns the converted String text for this ListItem
   def text
-    apply_subs @text, @subs
+    # NOTE @text can be nil if dd node only has block content
+    @text && (apply_subs @text, @subs)
   end
 
   # Public: Set the String text.

data/lib/asciidoctor/logging.rb

@@ -0,0 +1,122 @@
+require 'logger'
+
+module Asciidoctor
+class Logger < ::Logger
+  attr_reader :max_severity
+
+  def initialize *args
+    super
+    self.progname = 'asciidoctor'
+    self.formatter = BasicFormatter.new
+    self.level = WARN
+  end
+
+  def add severity, message = nil, progname = nil
+    if (severity ||= UNKNOWN) > (@max_severity ||= severity)
+      @max_severity = severity
+    end
+    super
+  end
+
+  class BasicFormatter < Formatter
+    SEVERITY_LABELS = { 'WARN' => 'WARNING', 'FATAL' => 'FAILED' }
+
+    def call severity, _, progname, msg
+      %(#{progname}: #{SEVERITY_LABELS[severity] || severity}: #{::String === msg ? msg : msg.inspect}\n)
+    end
+  end
+
+  module AutoFormattingMessage
+    def inspect
+      (sloc = self[:source_location]) ? %(#{sloc}: #{self[:text]}) : self[:text]
+    end
+  end
+end
+
+class MemoryLogger < ::Logger
+  # NOTE Ruby 1.8.7 returns constants as strings instead of symbols
+  SEVERITY_LABELS = ::Hash[Severity.constants.map {|c| [(Severity.const_get c), c.to_sym] }]
+
+  attr_reader :messages
+
+  def initialize
+    self.level = WARN
+    @messages = []
+  end
+
+  def add severity, message = nil, progname = nil
+    message = block_given? ? yield : progname unless message
+    @messages << { :severity => SEVERITY_LABELS[severity || UNKNOWN], :message => message }
+    true
+  end
+
+  def clear
+    @messages.clear
+  end
+
+  def empty?
+    @messages.empty?
+  end
+
+  def max_severity
+    empty? ? nil : @messages.map {|m| Severity.const_get m[:severity] }.max
+  end
+end
+
+class NullLogger < ::Logger
+  attr_reader :max_severity
+
+  def initialize; end
+
+  def add severity, message = nil, progname = nil
+    if (severity ||= UNKNOWN) > (@max_severity ||= severity)
+      @max_severity = severity
+    end
+    true
+  end
+end
+
+module LoggerManager
+  @logger_class = Logger
+  class << self
+    attr_accessor :logger_class
+
+    # NOTE subsequent calls to logger access the logger via the logger property directly
+    def logger pipe = $stderr
+      memoize_logger
+      @logger ||= (@logger_class.new pipe)
+    end
+
+    def logger= logger
+      @logger = logger || (@logger_class.new $stderr)
+    end
+
+    private
+    def memoize_logger
+      class << self
+        alias_method :logger, :logger
+        if RUBY_ENGINE == 'opal'
+          define_method :logger do @logger end
+        else
+          attr_reader :logger
+        end
+      end
+    end
+  end
+end
+
+module Logging
+  def self.included into
+    into.extend Logging
+  end
+
+  private
+  def logger
+    LoggerManager.logger
+  end
+
+  def message_with_context text, context = {}
+    ({ :text => text }.merge context).extend Logger::AutoFormattingMessage
+  end
+end
+end