asciidoctor-diagram 1.4.0 → 1.5.0

data/lib/asciidoctor-diagram.rb

@@ -1,9 +1,9 @@
-require 'asciidoctor-diagram/blockdiag'
-require 'asciidoctor-diagram/ditaa'
-require 'asciidoctor-diagram/graphviz'
-require 'asciidoctor-diagram/meme'
-require 'asciidoctor-diagram/mermaid'
-require 'asciidoctor-diagram/plantuml'
-require 'asciidoctor-diagram/salt'
-require 'asciidoctor-diagram/shaape'
-require 'asciidoctor-diagram/wavedrom'
+require_relative 'asciidoctor-diagram/blockdiag'
+require_relative 'asciidoctor-diagram/ditaa'
+require_relative 'asciidoctor-diagram/graphviz'
+require_relative 'asciidoctor-diagram/meme'
+require_relative 'asciidoctor-diagram/mermaid'
+require_relative 'asciidoctor-diagram/plantuml'
+require_relative 'asciidoctor-diagram/salt'
+require_relative 'asciidoctor-diagram/shaape'
+require_relative 'asciidoctor-diagram/wavedrom'

data/lib/asciidoctor-diagram/blockdiag.rb

@@ -1,5 +1,4 @@
-require 'asciidoctor/extensions'
-require_relative 'version'
+require_relative 'extensions'
 
 Asciidoctor::Extensions.register do
   require_relative 'blockdiag/extension'

data/lib/asciidoctor-diagram/blockdiag/extension.rb

@@ -1,5 +1,6 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/platform'
 require_relative '../util/which'
 
 module Asciidoctor
@@ -72,7 +73,17 @@ module Asciidoctor
 
     # @private
     module BlockDiag
-      def self.define_processors(name, &init)
+      def self.define_processors(name)
+        init = Proc.new do
+          include ::Asciidoctor::Diagram::BlockDiag
+
+          [:png, :svg].each do |f|
+            register_format(f, :image) do |p, c|
+              blockdiag(name, p, c, f)
+            end
+          end
+        end
+
         block = Class.new(Extensions::DiagramBlockProcessor) do
           self.instance_eval &init
         end
@@ -84,20 +95,24 @@ module Asciidoctor
 
         ::Asciidoctor::Diagram.const_set("#{name}BlockMacroProcessor", block_macro)
       end
-    end
 
-    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
-      BlockDiag.define_processors(tool) do
-        include Which
+      include Which
 
-        [:png, :svg].each do |f|
-          register_format(f, :image) do |c, p|
-            CliGenerator.generate_stdin(which(p, tool.downcase), f.to_s, c.to_s) do |tool_path, output_path|
-              [tool_path, '-o', output_path, "-T#{f.to_s}", '-']
-            end
-          end
+      def blockdiag(tool, parent, source, format)
+        cmd_name = tool.downcase
+
+        # On Debian based systems the Python 3.x packages python3-(act|block|nw|seq)diag executables with
+        # a '3' suffix.
+        alt_cmd_name = "#{tool.downcase}3"
+
+        CliGenerator.generate_stdin(which(parent, cmd_name, :alt_cmds => [alt_cmd_name]), format.to_s, source.to_s) do |tool_path, output_path|
+          [tool_path, '-o', Platform.native_path(output_path), "-T#{format.to_s}", '-']
         end
       end
     end
+
+    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
+      BlockDiag.define_processors(tool)
+    end
   end
-end
+end

data/lib/asciidoctor-diagram/ditaa.rb

@@ -1,5 +1,4 @@
-require 'asciidoctor/extensions'
-require_relative 'version'
+require_relative 'extensions'
 
 Asciidoctor::Extensions.register do
   require_relative 'ditaa/extension'

data/lib/asciidoctor-diagram/ditaa/extension.rb

@@ -7,19 +7,49 @@ module Asciidoctor
   module Diagram
     # @private
     module Ditaa
+      OPTIONS = {
+          'scale' => lambda { |o, v| o << '--scale' << v if v },
+          'tabs' => lambda { |o, v| o << '--tabs' << v if v },
+          'background' => lambda { |o, v| o << '--background' << v if v },
+          'antialias' => lambda { |o, v| o << '--no-antialias' if v == 'false' },
+          'separation' => lambda { |o, v| o  << '--no-separation' if v == 'false'},
+          'round-corners' => lambda { |o, v| o  << '--round-corners' if v == 'true'},
+          'shadows' => lambda { |o, v| o  << '--no-shadows' if v == 'false'},
+          'debug' => lambda { |o, v| o  << '--debug' if v == 'true'},
+          'fixed-slope' => lambda { |o, v| o  << '--fixed-slope' if v == 'true'},
+          'transparent' => lambda { |o, v| o  << '--transparent' if v == 'true'}
+      }
+
       JARS = ['ditaamini-0.10.jar'].map do |jar|
         File.expand_path File.join('../..', jar), File.dirname(__FILE__)
       end
       Java.classpath.concat JARS
 
-      def ditaa(code, source)
+      def self.included(mod)
+        mod.register_format(:png, :image) do |parent, source|
+          ditaa(parent, source)
+        end
+      end
+
+      def ditaa(parent, source)
         Java.load
 
+        global_attributes = parent.document.attributes
+
+        options = []
+
+        OPTIONS.keys.each do |key|
+          value = source.attributes.delete(key) || global_attributes["ditaa-option-#{key}"]
+          OPTIONS[key].call(options, value)
+        end
+
+        options = options.join(' ')
+
         response = Java.send_request(
             :url => '/ditaa',
-            :body => code,
+            :body => source.to_s,
             :headers => {
-                'X-Options' => source.options
+                'X-Options' => options
             }
         )
 
@@ -29,51 +59,6 @@ module Asciidoctor
 
         response[:body]
       end
-
-      def self.included(mod)
-        mod.register_format(:png, :image) do |c, _, source|
-          ditaa(c.to_s, source)
-        end
-      end
-
-      def create_source(parent, reader, attributes)
-        source = super(parent, reader, attributes)
-        source.extend DitaaSource
-
-        source.init_ditaa_options(parent, attributes)
-
-        source
-      end
-
-      module DitaaSource
-        attr_reader :options
-
-        OPTIONS = {
-          'scale' => lambda { |o, v| o << '--scale' << v if v },
-          'tabs' => lambda { |o, v| o << '--tabs' << v if v },
-          'background' => lambda { |o, v| o << '--background' << v if v },
-          'antialias' => lambda { |o, v| o << '--no-antialias' if v == 'false' },
-          'separation' => lambda { |o, v| o  << '--no-separation' if v == 'false'},
-          'round-corners' => lambda { |o, v| o  << '--round-corners' if v == 'true'},
-          'shadows' => lambda { |o, v| o  << '--no-shadows' if v == 'false'},
-          'debug' => lambda { |o, v| o  << '--debug' if v == 'true'},
-          'fixed-slope' => lambda { |o, v| o  << '--fixed-slope' if v == 'true'},
-          'transparent' => lambda { |o, v| o  << '--transparent' if v == 'true'}
-        }
-
-        def init_ditaa_options(parent, attributes)
-          global_attributes = parent.document.attributes
-
-          options = []
-
-          OPTIONS.keys.each do |key|
-            value = attributes.delete(key) || global_attributes["ditaa-option-#{key}"]
-            OPTIONS[key].call(options, value)
-          end
-
-          @options = options.join(' ')
-        end
-      end
     end
 
     class DitaaBlockProcessor < Extensions::DiagramBlockProcessor

data/lib/asciidoctor-diagram/extensions.rb

@@ -1,7 +1,9 @@
+require 'asciidoctor' unless defined? ::Asciidoctor::VERSION
 require 'asciidoctor/extensions'
 require 'digest'
 require 'json'
 require 'fileutils'
+require_relative 'version'
 require_relative 'util/java'
 require_relative 'util/gif'
 require_relative 'util/png'
@@ -143,8 +145,9 @@ module Asciidoctor
         def create_image_block(parent, source, format, generator_info)
           image_name = "#{source.image_name}.#{format}"
           image_dir = image_output_dir(parent)
+          cache_dir = cache_dir(parent)
           image_file = parent.normalize_system_path image_name, image_dir
-          metadata_file = parent.normalize_system_path "#{image_name}.cache", image_dir
+          metadata_file = parent.normalize_system_path "#{image_name}.cache", cache_dir
 
           if File.exists? metadata_file
             metadata = File.open(metadata_file, 'r') { |f| JSON.load f }
@@ -157,7 +160,7 @@ module Asciidoctor
           if !File.exists?(image_file) || source.should_process?(image_file, metadata)
             params = IMAGE_PARAMS[format]
 
-            result = instance_exec(source, parent, source, &generator_info[:generator])
+            result = instance_exec(parent, source, &generator_info[:generator])
 
             result.force_encoding(params[:encoding])
 
@@ -166,6 +169,8 @@ module Asciidoctor
 
             FileUtils.mkdir_p(File.dirname(image_file)) unless Dir.exist?(File.dirname(image_file))
             File.open(image_file, 'wb') { |f| f.write result }
+
+            FileUtils.mkdir_p(File.dirname(metadata_file)) unless Dir.exist?(File.dirname(metadata_file))
             File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
           end
 
@@ -212,23 +217,30 @@ module Asciidoctor
         def image_output_dir(parent)
           document = parent.document
 
-          images_dir = document.attr('imagesoutdir')
+          images_dir = parent.attr('imagesoutdir')
 
           if images_dir
             base_dir = nil
           else
-            base_dir = document.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
-            images_dir = document.attr('imagesdir')
+            base_dir = parent.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
+            images_dir = parent.attr('imagesdir')
           end
 
           parent.normalize_system_path(images_dir, base_dir)
         end
 
+        def cache_dir(parent)
+          document = parent.document
+          cache_dir = '.asciidoctor/diagram'
+          base_dir = parent.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
+          parent.normalize_system_path(cache_dir, base_dir)
+        end
+
         def create_literal_block(parent, source, generator_info)
           literal_attributes = source.attributes
           literal_attributes.delete('target')
 
-          result = instance_exec(source, parent, &generator_info[:generator])
+          result = instance_exec(parent, source, &generator_info[:generator])
 
           result.force_encoding(Encoding::UTF_8)
           Asciidoctor::Block.new parent, :literal, :source => result, :attributes => literal_attributes
@@ -249,7 +261,7 @@ module Asciidoctor
         #
         # @return [ReaderSource] a ReaderSource
         def create_source(parent, reader, attributes)
-          ReaderSource.new(reader, attributes)
+          ReaderSource.new(parent, reader, attributes)
         end
       end
 
@@ -265,7 +277,7 @@ module Asciidoctor
         #
         # @return [FileSource] a FileSource
         def create_source(parent, target, attributes)
-          FileSource.new(target.empty? ? nil : parent.normalize_system_path(target, parent.document.base_dir), attributes)
+          FileSource.new(parent, target.empty? ? nil : parent.normalize_system_path(target, parent.attr('docdir')), attributes)
         end
       end
 
@@ -284,6 +296,28 @@ module Asciidoctor
           raise NotImplementedError.new
         end
 
+        # Get the value for the specified attribute. First look in the attributes on
+        # this node and return the value of the attribute if found. Otherwise, if
+        # this node is a child of the Document node, look in the attributes of the
+        # Document node and return the value of the attribute if found. Otherwise,
+        # return the default value, which defaults to nil.
+        #
+        # @param name [String, Symbol] the name of the attribute to lookup
+        # @param default_value [Object] the value to return if the attribute is not found
+        # @inherit [Boolean] indicates whether to check for the attribute on the AsciiDoctor::Document if not found on this node
+        #
+        # @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
+        # @abstract
+        def attr(name, default_value = nil, inherit = true)
+          raise NotImplementedError.new
+        end
+
+        # @return [String] the base directory against which relative paths in this diagram should be resolved
+        # @abstract
+        def base_dir
+          raise NotImplementedError.new
+        end
+
         # Alias for code
         def to_s
           code
@@ -316,12 +350,23 @@ module Asciidoctor
 
         attr_reader :attributes
 
-        def initialize(attributes)
+        def initialize(parent, attributes)
+          @parent = parent
           @attributes = attributes
         end
 
         def image_name
-          @attributes['target'] || ('diag-' + checksum)
+          attr('target', 'diag-' + checksum)
+        end
+
+        def attr(name, default_value=nil, inherit=nil)
+          name = name.to_s if ::Symbol === name
+
+          if inherit
+            @attributes[name] || @parent.attr(name, default_value, true)
+          else
+            @attributes[name] || default_value
+          end
         end
 
         def should_process?(image_file, image_metadata)
@@ -336,11 +381,21 @@ module Asciidoctor
           @checksum ||= compute_checksum(code)
         end
 
+        protected
+        def resolve_diagram_subs
+          if @attributes.key? 'subs'
+            subs = @parent.resolve_block_subs @attributes['subs'], nil, 'diagram'
+            subs.empty? ? nil : subs
+          else
+            nil
+          end
+        end
+
         private
         def compute_checksum(code)
           md5 = Digest::MD5.new
           md5 << code
-          attributes.each do |k, v|
+          @attributes.each do |k, v|
             md5 << k.to_s if k
             md5 << v.to_s if v
           end
@@ -352,23 +407,31 @@ module Asciidoctor
       class ReaderSource < BasicSource
         include DiagramSource
 
-        def initialize(reader, attributes)
-          super(attributes)
+        def initialize(parent, reader, attributes)
+          super(parent, attributes)
           @reader = reader
         end
 
+        def base_dir
+          attr('docdir', nil, true)
+        end
+
         def code
-          @code ||= @reader.lines.join("\n")
+          @code ||= @parent.apply_subs(@reader.lines, resolve_diagram_subs).join("\n")
         end
       end
 
       # A diagram source that retrieves the code for a diagram from an external source file.
       class FileSource < BasicSource
-        def initialize(file_name, attributes)
-          super(attributes)
+        def initialize(parent, file_name, attributes)
+          super(parent, attributes)
           @file_name = file_name
         end
 
+        def base_dir
+          File.dirname(@file_name)
+        end
+
         def image_name
           if @attributes['target']
             super
@@ -384,12 +447,16 @@ module Asciidoctor
         end
 
         def code
+          @code ||= read_code
+        end
+
+        def read_code
           if @file_name
             lines = File.readlines(@file_name)
             lines = ::Asciidoctor::Helpers.normalize_lines(lines)
-            @code ||= lines.join("\n")
+            @parent.apply_subs(lines, resolve_diagram_subs).join("\n")
           else
-            @code ||= ''
+            ''
           end
         end
       end

data/lib/asciidoctor-diagram/graphviz.rb

@@ -1,5 +1,4 @@
-require 'asciidoctor/extensions'
-require_relative 'version'
+require_relative 'extensions'
 
 Asciidoctor::Extensions.register do
   require_relative 'graphviz/extension'

data/lib/asciidoctor-diagram/graphviz/extension.rb

@@ -1,5 +1,6 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/platform'
 require_relative '../util/which'
 
 module Asciidoctor
@@ -10,13 +11,22 @@ module Asciidoctor
 
       def self.included(mod)
         [:png, :svg].each do |f|
-          mod.register_format(f, :image) do |c, p|
-            CliGenerator.generate_stdin(which(p, 'dot', :attr_names => ['dot', 'graphvizdot']), f.to_s, c.to_s) do |tool_path, output_path|
-              [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
-            end
+          mod.register_format(f, :image) do |parent, source|
+            graphviz(parent, source, f)
           end
         end
       end
+
+      def graphviz(parent, source, format)
+        CliGenerator.generate_stdin(which(parent, 'dot', :alt_attrs => ['graphvizdot']), format.to_s, source.to_s) do |tool_path, output_path|
+          args = [tool_path, "-o#{Platform.native_path(output_path)}", "-T#{format.to_s}"]
+
+          layout = source.attr('layout')
+          args << "-K#{layout}" if layout
+
+          args
+        end
+      end
     end
 
     class GraphvizBlockProcessor < Extensions::DiagramBlockProcessor