asciidoctor-diagram 1.2.0.preview.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed05ad18a6da6febe775f07fda8713b77fe25a82
-  data.tar.gz: c2ba98ed53a5405b4e95ce72f03d4c7158e7b561
+  metadata.gz: 74838c060f09bcfe7603faef3aeee8c075cecaec
+  data.tar.gz: cb315faf5b140f071a6f7a0fdb748e366d5eefae
 SHA512:
-  metadata.gz: 655e2240b3fa83d06d3e379281cfda32158965b4254ba9b9e4125ec520b064a87fffa59c220d058e0cd0947b3c516970429ea839c686152058d777b782a7a7c9
-  data.tar.gz: 36ded3b76a7980587dd546f52ce1f64ae39ff87c51ac2d8e88be6d46ee1881944b302e890967c1b32716b3cae6a067f1400f57c328d3768791e1255caad0052d
+  metadata.gz: 131fb3f8a3cecb232601c72424240c284996bfeef9a66c64bc3d88c6e0a1aab48299c2baa5935d1d3ed54ceca85b912716ae10dea48c21950ce6d5ff3b76f960
+  data.tar.gz: 4d096215c18e27b7fdfbb4bccd131c6e94699c9fb572c1f5f00e9df196a2c0d81390dd84c70dfbef3153a9cfe8d7c3598fd15f6f14d53979b93fe44130f82589

data/CHANGELOG.adoc

@@ -6,6 +6,20 @@ Enhancements::
 
   * Updated to Asciidoctor 1.5.0
 
+== 1.1.6
+
+Enhancements::
+
+  * Updated PlantUML to revision 8002 (23/07U/2014)
+  * Add support for Shaape diagrams (requires Shaape to be installed separately)
+  * Add support for Blockdiag diagrams (requires Blockdiag to be installed separately)
+  * Add support for Actdiag diagrams (requires Actdiag to be installed separately)
+  * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
+  * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
+
+Bug Fixes::
+  * Issue #38: Resolved Graphviz syntax errors with certain diagrams
+
 == 1.1.5
 
 Enhancements::

data/lib/asciidoctor-diagram.rb

@@ -1,3 +1,5 @@
+require 'asciidoctor-diagram/blockdiag'
 require 'asciidoctor-diagram/ditaa'
 require 'asciidoctor-diagram/graphviz'
-require 'asciidoctor-diagram/plantuml'
+require 'asciidoctor-diagram/plantuml'
+require 'asciidoctor-diagram/shaape'

data/lib/asciidoctor-diagram/blockdiag.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'blockdiag/extension'
+  block Asciidoctor::Diagram::BlockDiagBlock, :blockdiag
+  block_macro Asciidoctor::Diagram::BlockDiagBlockMacro, :blockdiag
+end

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

@@ -0,0 +1,18 @@
+require_relative '../util/cli_generator'
+require_relative '../util/diagram'
+
+module Asciidoctor
+  module Diagram
+    ['BlockDiag', 'SeqDiag', 'ActDiag', 'NwDiag', 'RackDiag', 'PacketDiag'].each do |tool|
+      define_processors(tool) do
+        [:png, :svg].each do |f|
+          register_format(f, :image) do |c, p|
+            CliGenerator.generate(tool.downcase, p, c) do |tool_path, output_path|
+              [tool_path, '-o', output_path, "-T#{f.to_s}", '-']
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,37 +1,35 @@
 require_relative '../util/diagram'
-require_relative 'generator'
+require_relative '../util/java'
 
 module Asciidoctor
   module Diagram
-    module DitaaBase
-      include DitaaGenerator
+    module DitaaGenerator
+      DITAA_JAR_PATH = File.expand_path File.join('../..', 'ditaamini0_9.jar'), File.dirname(__FILE__)
+      Java.classpath << DITAA_JAR_PATH
 
-      private
+      def self.ditaa(code)
+        Java.load
 
-      def register_formats
-        register_format(:png, :image) do |c|
-          ditaa(c)
-        end
-      end
-    end
+        args = ['-e', 'UTF-8']
+
+        bytes = code.encode(Encoding::UTF_8).bytes.to_a
+        bis = Java.new_object(Java.java.io.ByteArrayInputStream, '[B', Java.array_to_java_array(bytes, :byte))
+        bos = Java.new_object(Java.java.io.ByteArrayOutputStream)
+        result_code = Java.org.stathissideris.ascii2image.core.CommandLineConverter.convert(Java.array_to_java_array(args, :string), bis, bos)
+        bis.close
+        bos.close
 
-    class DitaaBlock < Asciidoctor::Extensions::BlockProcessor
-      include DiagramProcessorBase
-      include DitaaBase
+        result = Java.string_from_java_bytes(bos.toByteArray)
 
-      def initialize name = nil, config = {}
-        super
-        register_formats()
+        raise "Ditaa image generation failed: #{result}" unless result_code == 0
+
+        result
       end
     end
 
-    class DitaaBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
-      include DiagramProcessorBase
-      include DitaaBase
-
-      def initialize name = nil, config = {}
-        super
-        register_formats()
+    define_processors('Ditaa') do
+      register_format(:png, :image) do |c|
+        DitaaGenerator.ditaa(c)
       end
     end
   end

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

@@ -1,41 +1,16 @@
+require_relative '../util/cli_generator'
 require_relative '../util/diagram'
-require_relative '../plantuml/generator'
 
 module Asciidoctor
   module Diagram
-    module GraphvizBase
-      include PlantUmlGenerator
-
-      private
-
-      def register_formats
-        register_format(:png, :image) do |c, p|
-          plantuml(p, c, 'dot')
-        end
-        register_format(:svg, :image) do |c, p|
-          plantuml(p, c, 'dot', '-tsvg')
+    define_processors('Graphviz') do
+      [:png, :svg].each do |f|
+        register_format(f, :image) do |c, p|
+          CliGenerator.generate('dot', p, c) do |tool_path, output_path|
+            [tool_path, "-o#{output_path}", "-T#{f.to_s}"]
+          end
         end
       end
     end
-
-    class GraphvizBlock < Asciidoctor::Extensions::BlockProcessor
-      include DiagramProcessorBase
-      include GraphvizBase
-
-      def initialize name = nil, config = {}
-        super
-        register_formats()
-      end
-    end
-
-    class GraphvizBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
-      include DiagramProcessorBase
-      include GraphvizBase
-
-      def initialize name = nil, config = {}
-        super
-        register_formats()
-      end
-    end
   end
 end

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

@@ -3,41 +3,25 @@ require_relative 'generator'
 
 module Asciidoctor
   module Diagram
-    module PlantUmlBase
-      include PlantUmlGenerator
-
-      private
-
-      def register_formats()
-        register_format(:png, :image) do |c, p|
-          plantuml(p, c, 'uml')
-        end
-        register_format(:svg, :image) do |c, p|
-          plantuml(p, c, 'uml', '-tsvg')
+    define_processors('PlantUml') do
+      def config_args(parent)
+        config_args = []
+        config = parent.document.attributes['plantumlconfig']
+        if config
+          config_args += ['-config', File.expand_path(config, parent.document.attributes['docdir'])]
         end
-        register_format(:txt, :literal) do |c, p|
-          plantuml(p, c, 'uml', '-tutxt')
-        end
-      end
-    end
 
-    class PlantUmlBlock < Asciidoctor::Extensions::BlockProcessor
-      include DiagramProcessorBase
-      include PlantUmlBase
-
-      def initialize name = nil, config = {}
-        super
-        register_formats()
+        config_args
       end
-    end
-
-    class PlantUmlBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
-      include DiagramProcessorBase
-      include PlantUmlBase
 
-      def initialize name = nil, config = {}
-        super
-        register_formats()
+      register_format(:png, :image) do |c, p|
+        PlantUmlGenerator.plantuml(p, c, 'uml', *config_args(p))
+      end
+      register_format(:svg, :image) do |c, p|
+        PlantUmlGenerator.plantuml(p, c, 'uml', '-tsvg', *config_args(p))
+      end
+      register_format(:txt, :literal) do |c, p|
+        PlantUmlGenerator.plantuml(p, c, 'uml', '-tutxt', *config_args(p))
       end
     end
   end

data/lib/asciidoctor-diagram/plantuml/generator.rb

@@ -1,4 +1,5 @@
 require_relative '../util/java'
+require_relative '../util/which'
 
 module Asciidoctor
   module Diagram
@@ -8,10 +9,10 @@ module Asciidoctor
       PLANTUML_JAR_PATH = File.expand_path File.join('../..', 'plantuml.jar'), File.dirname(__FILE__)
       Java.classpath << PLANTUML_JAR_PATH
 
-      def plantuml(parent, code, tag, *flags)
+      def self.plantuml(parent, code, tag, *flags)
         unless @graphvizdot
           @graphvizdot = parent.document.attributes['graphvizdot']
-          @graphvizdot = which('dot') unless @graphvizdot && File.executable?(@graphvizdot)
+          @graphvizdot = ::Asciidoctor::Diagram.which('dot') unless @graphvizdot && File.executable?(@graphvizdot)
           raise "Could not find the Graphviz 'dot' executable in PATH; add it to the PATH or specify its location using the 'graphvizdot' document attribute" unless @graphvizdot
         end
 
@@ -40,17 +41,6 @@ module Asciidoctor
         ps.close
         Java.string_from_java_bytes(bos.toByteArray)
       end
-
-      def which(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-          exts.each { |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable? exe
-          }
-        end
-        nil
-      end
     end
   end
 end

data/lib/asciidoctor-diagram/shaape.rb

@@ -0,0 +1,9 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'shaape/extension'
+
+  block Asciidoctor::Diagram::ShaapeBlock, :shaape
+  block_macro Asciidoctor::Diagram::ShaapeBlockMacro, :shaape
+end

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

@@ -0,0 +1,16 @@
+require_relative '../util/cli_generator'
+require_relative '../util/diagram'
+
+module Asciidoctor
+  module Diagram
+    define_processors('Shaape') do
+      [:png, :svg].each do |f|
+        register_format(f, :image) do |c, p|
+          CliGenerator.generate('shaape', p, c) do |tool_path, output_path|
+            [tool_path, '-o', output_path, '-t', f.to_s, '-']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/util/cli_generator.rb

@@ -0,0 +1,40 @@
+require 'tempfile'
+
+require_relative '../util/java'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    module CliGenerator
+      def self.generate(tool, parent, code)
+        tool_var = '@' + tool
+
+        tool_path = instance_variable_get(tool_var)
+        unless tool_path
+          tool_path = parent.document.attributes[tool]
+          tool_path = ::Asciidoctor::Diagram.which(tool) unless tool_path && File.executable?(tool_path)
+          raise "Could not find the '#{tool}' executable in PATH; add it to the PATH or specify its location using the 'shaape' document attribute" unless tool_path
+          instance_variable_set(tool_var, tool_path)
+        end
+
+        target_file = Tempfile.new(tool)
+        begin
+          target_file.close
+
+          args = yield tool_path, target_file.path
+
+          IO.popen(args, "w") do |io|
+            io.write code
+          end
+          result_code = $?
+
+          raise "#{tool} image generation failed" unless result_code == 0
+
+          File.read(target_file.path)
+        ensure
+          target_file.unlink
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/util/diagram.rb

@@ -8,69 +8,47 @@ require_relative 'svg'
 
 module Asciidoctor
   module Diagram
-    module DiagramProcessorBase
-      IMAGE_PARAMS = {
-          :svg => {
-              :encoding => Encoding::UTF_8,
-              :decoder => SVG
-          },
-          :png => {
-              :encoding => Encoding::ASCII_8BIT,
-              :decoder => PNG
-          }
-      }
-
-      def self.included(base)
-        base.option :pos_attrs, ['target', 'format']
-
-        if base.ancestors.include?(Asciidoctor::Extensions::BlockProcessor)
-          base.option :contexts, [:listing, :literal, :open]
-          base.option :content_model, :simple
-
-          base.instance_eval do
-            alias_method :process, :process_block
-          end
-        else
-          base.instance_eval do
-            alias_method :process, :process_macro
-          end
+    def self.define_processors(name, &init)
+      block = Class.new(Asciidoctor::Extensions::BlockProcessor) do
+        class << self
+          include FormatRegistry
         end
+        include DiagramProcessor
 
-      end
-
-      def process_macro(parent, target, attributes)
-        source = FileSource.new(File.expand_path(target, parent.document.attributes['docdir']))
-        attributes['target'] ||= File.basename(target, File.extname(target))
+        option :pos_attrs, ['target', 'format']
+        option :contexts, [:listing, :literal, :open]
+        option :content_model, :simple
 
-        generate_block(parent, source, attributes)
-      end
+        def process(parent, reader, attributes)
+          generate_block(parent, ReaderSource.new(reader), attributes)
+        end
 
-      def process_block(parent, reader, attributes)
-        generate_block(parent, ReaderSource.new(reader), attributes)
+        self.instance_eval &init
       end
 
-      def generate_block(parent, source, attributes)
-        format = attributes.delete('format') || @default_format
-        format = format.to_sym if format.respond_to?(:to_sym)
-
-        raise "Format undefined" unless format
+      block_macro = Class.new(Asciidoctor::Extensions::BlockMacroProcessor) do
+        class << self
+          include FormatRegistry
+        end
+        include DiagramProcessor
 
-        generator_info = formats[format]
+        option :pos_attrs, ['target', 'format']
 
-        raise "#{self.class.name} does not support output format #{format}" unless generator_info
+        def process(parent, target, attributes)
+          source = FileSource.new(File.expand_path(target, parent.document.attributes['docdir']))
+          attributes['target'] ||= File.basename(target, File.extname(target))
 
-        case generator_info[:type]
-          when :image
-            create_image_block(parent, source, attributes, format, generator_info)
-          when :literal
-            create_literal_block(parent, source, attributes, generator_info)
-          else
-            raise "Unsupported output format: #{format}"
+          generate_block(parent, source, attributes)
         end
+
+        self.instance_eval &init
       end
 
-      private
+      Asciidoctor::Diagram.const_set("#{name}Block", block)
+      Asciidoctor::Diagram.const_set("#{name}BlockMacro", block_macro)
+    end
 
+    module FormatRegistry
       #
       # Registers a supported format. The first registered format becomes the default format for the block processor.
       #
@@ -93,6 +71,45 @@ module Asciidoctor
         @formats ||= {}
       end
 
+      def default_format
+        @default_format
+      end
+    end
+
+    module DiagramProcessor
+      IMAGE_PARAMS = {
+          :svg => {
+              :encoding => Encoding::UTF_8,
+              :decoder => SVG
+          },
+          :png => {
+              :encoding => Encoding::ASCII_8BIT,
+              :decoder => PNG
+          }
+      }
+
+      private
+
+      def generate_block(parent, source, attributes)
+        format = attributes.delete('format') || self.class.default_format
+        format = format.to_sym if format.respond_to?(:to_sym)
+
+        raise "Format undefined" unless format
+
+        generator_info = self.class.formats[format]
+
+        raise "#{self.class.name} does not support output format #{format}" unless generator_info
+
+        case generator_info[:type]
+          when :image
+            create_image_block(parent, source, attributes, format, generator_info)
+          when :literal
+            create_literal_block(parent, source, attributes, generator_info)
+          else
+            raise "Unsupported output format: #{format}"
+        end
+      end
+
       def create_image_block(parent, source, attributes, format, generator_info)
         target = attributes.delete('target')