asciidoctor 1.5.1 → 1.5.2

data/lib/asciidoctor/extensions.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Extensions provide a way to participate in the parsing and converting
 # phases of the AsciiDoc processor or extend the AsciiDoc syntax.
@@ -58,6 +59,8 @@ module Extensions
       # This method automatically detects whether to use the include or extend keyword
       # based on what is appropriate.
       #
+      # NOTE Inspiration for this DSL design comes from https://corcoran.io/2013/09/04/simple-pattern-ruby-dsl/
+      #
       # Returns nothing
       def use_dsl
         if self.name.nil_or_empty?
@@ -109,7 +112,7 @@ module Extensions
     def parse_content parent, content, attributes = {}
       reader = (content.is_a? Reader) ? reader : (Reader.new content)
       while reader.has_more_lines?
-        block = Parser.next_block(reader, parent, attributes)
+        block = Parser.next_block reader, parent, attributes
         parent << block if block
       end
       nil
@@ -242,6 +245,36 @@ module Extensions
   end
   IncludeProcessor::DSL = ProcessorDsl
 
+  # Public: DocinfoProcessors are used to add additional content to
+  # the header and/or footer of the generated document.
+  #
+  # The placement of docinfo content is controlled by the converter.
+  #
+  # DocinfoProcessors implementations must extend DocinfoProcessor.
+  # If a location is not specified, the DocinfoProcessor is assumed
+  # to add content to the header.
+  class DocinfoProcessor < Processor
+    attr_accessor :location
+
+    def initialize config = {}
+      super config
+      @config[:location] ||= :header
+    end
+
+    def process document
+      raise ::NotImplementedError
+    end
+  end
+
+  module DocinfoProcessorDsl
+    include ProcessorDsl
+
+    def at_location value
+      option :location, value
+    end
+  end
+  DocinfoProcessor::DSL = DocinfoProcessorDsl
+
   # Public: BlockProcessors are used to handle delimited blocks and paragraphs
   # that have a custom name.
   #
@@ -448,7 +481,7 @@ module Extensions
 
     def initialize kind, instance, process_method = nil
       super kind, instance, instance.config
-      @process_method = process_method || instance.method(:process)
+      @process_method = process_method || (instance.method :process)
     end
   end
 
@@ -484,7 +517,7 @@ module Extensions
 
     def initialize groups = {}
       @groups = groups
-      @preprocessor_extensions = @treeprocessor_extensions = @postprocessor_extensions = @include_processor_extensions = nil
+      @preprocessor_extensions = @treeprocessor_extensions = @postprocessor_extensions = @include_processor_extensions = @docinfo_processor_extensions =nil
       @block_extensions = @block_macro_extensions = @inline_macro_extensions = nil
       @document = nil
     end
@@ -723,6 +756,79 @@ module Extensions
       @include_processor_extensions
     end
 
+    # Public: Registers an {DocinfoProcessor} with the extension registry to
+    # add additionnal docinfo to the document.
+    #
+    # The DocinfoProcessor may be one of four types:
+    #
+    # * A DocinfoProcessor subclass
+    # * An instance of a DocinfoProcessor subclass
+    # * The String name of a DocinfoProcessor subclass
+    # * A method block (i.e., Proc) that conforms to the DocinfoProcessor contract
+    #
+    # Unless the DocinfoProcessor is passed as the method block, it must be the
+    # first argument to this method.
+    #
+    # Examples
+    #
+    #   # as an DocinfoProcessor subclass
+    #   docinfo_processor MetaRobotsDocinfoProcessor
+    #
+    #   # as an instance of a DocinfoProcessor subclass with an explicit location
+    #   docinfo_processor JQueryDocinfoProcessor.new, :location => :footer
+    #
+    #   # as a name of a DocinfoProcessor subclass
+    #   docinfo_processor 'MetaRobotsDocinfoProcessor'
+    #
+    #   # as a method block
+    #   docinfo_processor do
+    #     process |doc|
+    #       at_location :footer
+    #       'footer content'
+    #     end
+    #   end
+    #
+    # Returns the [Extension] stored in the registry that proxies the
+    # instance of this DocinfoProcessor.
+    def docinfo_processor *args, &block
+      add_document_processor :docinfo_processor, args, &block
+    end
+
+    # Public: Checks whether any {DocinfoProcessor} extensions have been registered.
+    #
+    # location - A Symbol for selecting docinfo extensions at a given location (:header or :footer) (default: nil)
+    #
+    # Returns a [Boolean] indicating whether any DocinfoProcessor extensions are registered.
+    def docinfo_processors? location = nil
+      if @docinfo_processor_extensions
+        if location
+          @docinfo_processor_extensions.find {|ext| ext.config[:location] == location }
+        else
+          true
+        end
+      else
+        false
+      end
+    end
+
+    # Public: Retrieves the {Extension} proxy objects for all the
+    # DocinfoProcessor instances stored in this registry.
+    #
+    # location - A Symbol for selecting docinfo extensions at a given location (:header or :footer) (default: nil)
+    #
+    # Returns an [Array] of Extension proxy objects.
+    def docinfo_processors location = nil
+      if @docinfo_processor_extensions
+        if location
+          @docinfo_processor_extensions.select {|ext| ext.config[:location] == location }
+        else
+          @docinfo_processor_extensions
+        end
+      else
+        nil
+      end
+    end
+
     # Public: Registers a {BlockProcessor} with the extension registry to
     # process the block content (i.e., delimited block or paragraph) in the
     # AsciiDoc source annotated with the specified block name (i.e., style).
@@ -1011,9 +1117,12 @@ module Extensions
         config = resolve_args args, 1
         # TODO if block arity is 0, assume block is process method
         processor = kind_class.new config
-        class << processor
-          include_dsl
-        end
+        # NOTE class << processor idiom doesn't work in Opal
+        #class << processor
+        #  include_dsl
+        #end
+        # NOTE kind_class.contants(false) doesn't exist in Ruby 1.8.7
+        processor.extend kind_class.const_get :DSL if kind_class.constants.grep :DSL
         processor.instance_exec(&block)
         processor.freeze
         unless processor.process_block_given?
@@ -1058,9 +1167,12 @@ module Extensions
       if block_given?
         name, config = resolve_args args, 2
         processor = kind_class.new as_symbol(name), config
-        class << processor
-          include_dsl
-        end
+        # NOTE class << processor idiom doesn't work in Opal
+        #class << processor
+        #  include_dsl
+        #end
+        # NOTE kind_class.contants(false) doesn't exist in Ruby 1.8.7
+        processor.extend kind_class.const_get :DSL if kind_class.constants.grep :DSL
         if block.arity == 1
           yield processor
         else

data/lib/asciidoctor/helpers.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 module Helpers
   # Internal: Require the specified library using Kernel#require.

data/lib/asciidoctor/inline.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods for managing inline elements in AsciiDoc block
 class Inline < AbstractNode

data/lib/asciidoctor/list.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods for managing AsciiDoc lists (ordered, unordered and labeled lists)
 class List < AbstractBlock

data/lib/asciidoctor/opal_ext.rb

@@ -1,3 +1,25 @@
+%x(
+  var value;
+  if (typeof module !== 'undefined' && module.exports) {
+    value = 'node';
+  }
+  else if (typeof XMLHttpRequest !== 'undefined') {
+  // or we can check for document
+  //else if (typeof document !== 'undefined' && document.nodeType) {
+    value = 'browser';
+  }
+  else if (typeof Java !== 'undefined' && Java.type) {
+    value = 'java-nashorn';
+  }
+  else if (typeof java !== 'undefined') {
+    value = 'java-rhino';
+  }
+  else {
+    // standalone is likely SpiderMonkey
+    value = 'standalone';
+  }
+)
+JAVASCRIPT_PLATFORM = %x(value)
 require 'asciidoctor/opal_ext/comparable'
 require 'asciidoctor/opal_ext/dir'
 require 'asciidoctor/opal_ext/error'

data/lib/asciidoctor/opal_ext/file.rb

@@ -44,7 +44,7 @@ class File
 
     if block_given?
       lines = File.read(@path)
-      %x{
+      %x(
         self.eof = false;
         self.lineno = 0; 
         var chomped  = #{lines.chomp},
@@ -61,7 +61,7 @@ class File
           }
         }
         self.eof = true;
-      }
+      )
       self
     else
       read.each_line
@@ -96,14 +96,22 @@ class File
   end
   
   def self.read(path)
-    %x{
-      var data = ''
-      if (typeof module !== 'undefined' && module.exports) {
-        // Running under Node.js
-        var fs = require("fs");
-        data = fs.readFileSync(path, "utf8");
-      } else {
-        // Running under the browser
+    case JAVASCRIPT_PLATFORM
+    when 'node'
+      %x(return require('fs').readFileSync(path, 'utf8');)
+    when 'java-nashorn'
+      %x(
+        var Paths = Java.type('java.nio.file.Paths');
+        var Files = Java.type('java.nio.file.Files');
+        var lines = Files.readAllLines(Paths.get(path), Java.type('java.nio.charset.StandardCharsets').UTF_8);
+        var data = [];
+        lines.forEach(function(line) { data.push(line); });
+        return data.join("\n");
+      )
+    #when 'java-rhino'
+    when 'browser'
+      %x(
+        var data = '';
         var status = -1;
         try {
           var xhr = new XMLHttpRequest();
@@ -125,8 +133,13 @@ class File
         if (status == 404 || (status == 0 && data == '')) {
           throw #{IOError.new `'No such file or directory: ' + path`};
         }
-      }
-    }
-    `data`
+        return data;
+      )
+    # NOTE we're assuming standalone is SpiderMonkey
+    when 'standalone'
+      %x(return read(path);)
+    else
+      ''
+    end
   end
 end

data/lib/asciidoctor/parser.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods to parse lines of AsciiDoc into an object hierarchy
 # representing the structure of the document. All methods are class methods and
@@ -52,19 +53,6 @@ class Parser
         new_section, block_attributes = next_section(reader, document, block_attributes)
         document << new_section if new_section
       end
-      # NOTE we could try to avoid creating a preamble in the first place, though
-      # that would require reworking assumptions in next_section since the preamble
-      # is treated like an untitled section
-      # NOTE logic relocated to end of next_section
-      #if Compliance.unwrap_standalone_preamble &&
-      #    document.blocks.size == 1 && (first_block = document.blocks[0]).context == :preamble &&
-      #    first_block.blocks? && (document.doctype != 'book' || first_block.blocks[0].style != 'abstract')
-      #  preamble = document.blocks.shift
-      #  while (child_block = preamble.blocks.shift)
-      #    child_block.parent = document
-      #    document << child_block
-      #  end
-      #end
     end
 
     document
@@ -230,6 +218,9 @@ class Parser
       doctype = parent.doctype
       if has_header || (doctype == 'book' && attributes[1] != 'abstract')
         preamble = intro = Block.new(parent, :preamble, :content_model => :compound)
+        if doctype == 'book' && (parent.attr? 'preface-title')
+          preamble.title = parent.attr 'preface-title'
+        end
         parent << preamble
       end
       section = parent
@@ -947,7 +938,7 @@ class Parser
 
       if block.sub? :callouts
         unless (catalog_callouts block.source, document)
-          # No need to look for callouts if they aren't there
+          # No need to sub callouts if they aren't there
           block.remove_sub :callouts
         end
       end
@@ -1144,7 +1135,6 @@ class Parser
     else
       list_block.level = 1
     end
-    #Debug.debug { "Created #{list_type} block: #{list_block}" }
 
     while reader.has_more_lines? && (match = ListRxMap[list_type].match(reader.peek_line))
       marker = resolve_list_marker(list_type, match[1])
@@ -2121,6 +2111,8 @@ class Parser
     end
 
     if accessible && attrs
+      # NOTE lookup resolved value (resolution occurs inside set_attribute)
+      value = doc.attributes[name] if value
       Document::AttributeEntry.new(name, value).save_to(attrs)
     end
 
@@ -2324,7 +2316,11 @@ class Parser
             parser_ctx.buffer = %(#{parser_ctx.buffer}#{m.pre_match})
           end
 
-          line = m.post_match
+          if (line = m.post_match) == ''
+            # hack to prevent dropping empty cell found at end of line (see issue #1106)
+            seen = false
+          end
+
           parser_ctx.close_cell
         else
           # no other delimiters to see here
@@ -2346,8 +2342,9 @@ class Parser
 
       skipped = table_reader.skip_blank_lines unless parser_ctx.cell_open?
 
-      if !table_reader.has_more_lines?
-        parser_ctx.close_cell true
+      unless table_reader.has_more_lines?
+        # NOTE may have already closed cell in csv or dsv table (see previous call to parser_ctx.close_cell(true))
+        parser_ctx.close_cell true if parser_ctx.cell_open?
       end
     end
 

data/lib/asciidoctor/path_resolver.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Handles all operations for resolving, cleaning and joining paths.
 # This class includes operations for handling both web paths (request URIs) and
@@ -394,6 +395,9 @@ class PathResolver
   # The main function of this operation is to resolve any parent
   # references and remove any self references.
   #
+  # The target is assumed to be a path, not a qualified URI.
+  # That check should happen before this method is invoked.
+  #
   # target - the String target path
   # start  - the String start (i.e., parent) path
   #
@@ -413,6 +417,20 @@ class PathResolver
       end
     end
 
+    # use this logic instead if we want to normalize target if it contains a URI
+    #unless is_web_root? target
+    #  if preserve_uri_target && (target.include? ':') && UriSniffRx =~ target
+    #    uri_prefix = $~[0]
+    #    target = target[uri_prefix.length..-1]
+    #  elsif !start.nil_or_empty?
+    #    target = %(#{start}#{SLASH}#{target})
+    #    if (target.include? ':') && UriSniffRx =~ target
+    #      uri_prefix = $~[0]
+    #      target = target[uri_prefix.length..-1]
+    #    end
+    #  end
+    #end
+
     target_segments, target_root, _ = partition_path target, true
     resolved_segments = []
     target_segments.each do |segment|

data/lib/asciidoctor/reader.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Asciidoctor
 # Public: Methods for retrieving lines from AsciiDoc source files
 class Reader
@@ -708,10 +709,10 @@ class PreprocessorReader < Reader
           @conditional_stack.pop
           @skipping = @conditional_stack.empty? ? false : @conditional_stack[-1][:skipping]
         else
-          warn "asciidoctor: ERROR: #{line_info}: mismatched macro: endif::#{target}[], expected endif::#{pair[:target]}[]"
+          warn %(asciidoctor: ERROR: #{line_info}: mismatched macro: endif::#{target}[], expected endif::#{pair[:target]}[])
         end
       else
-        warn "asciidoctor: ERROR: #{line_info}: unmatched macro: endif::#{target}[]"
+        warn %(asciidoctor: ERROR: #{line_info}: unmatched macro: endif::#{target}[])
       end
       return true
     end
@@ -858,7 +859,7 @@ class PreprocessorReader < Reader
         # include file is resolved relative to dir of current include, or base_dir if within original docfile
         include_file = @document.normalize_system_path(target, @dir, nil, :target_name => 'include file')
         unless ::File.file? include_file
-          warn "asciidoctor: WARNING: #{line_info}: include file not found: #{include_file}"
+          warn %(asciidoctor: WARNING: #{line_info}: include file not found: #{include_file})
           replace_line %(Unresolved directive in #{@path} - include::#{target}[#{raw_attributes}])
           return true
         end
@@ -891,7 +892,7 @@ class PreprocessorReader < Reader
         elsif attributes.has_key? 'tag'
           tags = [attributes['tag']].to_set
         elsif attributes.has_key? 'tags'
-          tags = attributes['tags'].split(DataDelimiterRx).uniq.to_set
+          tags = attributes['tags'].split(DataDelimiterRx).to_set
         end
       end
       if inc_lines
@@ -966,7 +967,7 @@ class PreprocessorReader < Reader
             return true
           end
           unless (missing_tags = tags.to_a - tags_found.to_a).empty?
-            warn "asciidoctor: WARNING: #{line_info}: tag#{missing_tags.size > 1 ? 's' : nil} '#{missing_tags * ','}' not found in include #{target_type}: #{include_file}"
+            warn %(asciidoctor: WARNING: #{line_info}: tag#{missing_tags.size > 1 ? 's' : nil} '#{missing_tags * ','}' not found in include #{target_type}: #{include_file})
           end
           advance
           # FIXME not accounting for skipped lines in reader line numbering
@@ -1187,13 +1188,11 @@ class PreprocessorReader < Reader
   end
 
   def include_processors?
-    if !@include_processor_extensions
+    if @include_processor_extensions.nil?
       if @document.extensions? && @document.extensions.include_processors?
-        @include_processor_extensions = @document.extensions.include_processors
-        true
+        !!(@include_processor_extensions = @document.extensions.include_processors)
       else
         @include_processor_extensions = false
-        false
       end
     else
       @include_processor_extensions != false