asciidoctor-diagram 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58d14ba5e18dc4427eb55a9a9472939de9f0fc31
-  data.tar.gz: 3af41c9149de5a88e06e8eacafe16f55a5580dc8
+  metadata.gz: 0098efdea85dc852061d2d62e6372757ce5dd564
+  data.tar.gz: 419ac386041d57d824dcf202c18a64929fb6fc85
 SHA512:
-  metadata.gz: 0a1e03a029afb9ee6c81e550f541b03e3d9d4d28fd82a3700daf9d0009c77a2ee4bd42f810ed70e5473e26a7b98704a9b1742dddb43e25b1d8e82824b8b8b086
-  data.tar.gz: 2d244e715c478627049baf87f7f8adb581213a0759df56c0a3dac9f7f24fc036e575117551cfd3be427e7439206b7c81d31411aad93764ad90690eda2efd6205
+  metadata.gz: 8e115238d21a4f3600f3671b9b614181ef37c609a07e3d880bbe30383355d315094a0d0f0ce8da364d24aa7b2a4a3ce85529bcd364c60afea7cc4fc410d81fd1
+  data.tar.gz: 2af83d989277ca19f966ce79df019c6c9e94689c5a88397638579397525ca7bcd6d3489ef3a51118a344c733f9e74809202d8ed803d35d9c283dab1a0bcf2717

data/CHANGELOG.adoc

@@ -1,5 +1,19 @@
 = Asciidoctor-diagram Changelog
 
+== 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 :blockdiag, Asciidoctor::Diagram::BlockDiagBlock
+  block_macro :blockdiag, Asciidoctor::Diagram::BlockDiagBlockMacro
+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|
+      DiagramProcessor.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(context, document, opts = {})
-        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(context, document, opts = {})
-        super
-        register_formats()
+    DiagramProcessor.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,18 @@
+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')
+    module Diagram
+      DiagramProcessor.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
     end
-
-    class GraphvizBlock < Asciidoctor::Extensions::BlockProcessor
-      include DiagramProcessorBase
-      include GraphvizBase
-
-      def initialize(context, document, opts = {})
-        super
-        register_formats()
-      end
-    end
-
-    class GraphvizBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
-      include DiagramProcessorBase
-      include GraphvizBase
-
-      def initialize(context, document, opts = {})
-        super
-        register_formats()
-      end
-    end
   end
 end

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

@@ -3,47 +3,25 @@ require_relative 'generator'
 
 module Asciidoctor
   module Diagram
-    module PlantUmlBase
-      include PlantUmlGenerator
-
-      private
-
-      def register_formats(document)
+    DiagramProcessor.define_processors('PlantUml') do
+      def config_args(parent)
         config_args = []
-        config = document.attributes['plantumlconfig']
+        config = parent.document.attributes['plantumlconfig']
         if config
-          config_args += ['-config', File.expand_path(config, document.attributes['docdir'])]
+          config_args += ['-config', File.expand_path(config, parent.document.attributes['docdir'])]
         end
 
-        register_format(:png, :image) do |c, p|
-          plantuml(p, c, 'uml', *config_args)
-        end
-        register_format(:svg, :image) do |c, p|
-          plantuml(p, c, 'uml', '-tsvg', *config_args)
-        end
-        register_format(:txt, :literal) do |c, p|
-          plantuml(p, c, 'uml', '-tutxt', *config_args)
-        end
+        config_args
       end
-    end
 
-    class PlantUmlBlock < Asciidoctor::Extensions::BlockProcessor
-      include DiagramProcessorBase
-      include PlantUmlBase
-
-      def initialize(context, document, opts = {})
-        super
-        register_formats(document)
+      register_format(:png, :image) do |c, p|
+        PlantUmlGenerator.plantuml(p, c, 'uml', *config_args(p))
       end
-    end
-
-    class PlantUmlBlockMacro < Asciidoctor::Extensions::BlockMacroProcessor
-      include DiagramProcessorBase
-      include PlantUmlBase
-
-      def initialize(context, document, opts = {})
-        super
-        register_formats(document)
+      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
 
@@ -35,17 +36,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,8 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'shaape/extension'
+  block :shaape, Asciidoctor::Diagram::ShaapeBlock
+  block_macro :shaape, Asciidoctor::Diagram::ShaapeBlockMacro
+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
+    DiagramProcessor.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,7 +8,7 @@ require_relative 'svg'
 
 module Asciidoctor
   module Diagram
-    module DiagramProcessorBase
+    module DiagramProcessor
       IMAGE_PARAMS = {
           :svg => {
               :encoding => Encoding::UTF_8,
@@ -20,42 +20,81 @@ module Asciidoctor
           }
       }
 
-      def self.included(base)
-        base.option :pos_attrs, ['target', 'format']
+      module ClassMethods
+        #
+        # Registers a supported format. The first registered format becomes the default format for the block processor.
+        #
+        # +format+ is a symbol with the format name
+        # +type+ is a symbol and should be either :image or :literal
+        # +block+ is a block that produces the diagrams from code. The block receives the parent asciidoc block and the diagram code as arguments
+        #
+        def register_format(format, type, &block)
+          unless @default_format
+            @default_format = format
+          end
 
-        if base.ancestors.include?(Asciidoctor::Extensions::BlockProcessor)
-          base.option :contexts, [:listing, :literal, :open]
-          base.option :content_model, :simple
+          formats[format] = {
+              :type => type,
+              :generator => block
+          }
+        end
 
-          base.instance_eval do
-            alias_method :process, :process_block
-          end
-        else
-          base.instance_eval do
-            alias_method :process, :process_macro
-          end
+        def formats
+          @formats ||= {}
         end
 
+        def default_format
+          @default_format
+        end
       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))
-
-        generate_block(parent, source, attributes)
+      def self.included base
+        base.extend ClassMethods
       end
 
-      def process_block(parent, reader, attributes)
-        generate_block(parent, ReaderSource.new(reader), attributes)
+      def self.define_processors(name, &init)
+        block = Class.new(Asciidoctor::Extensions::BlockProcessor) do
+          include DiagramProcessor
+
+          option :pos_attrs, ['target', 'format']
+          option :contexts, [:listing, :literal, :open]
+          option :content_model, :simple
+
+          def process(parent, reader, attributes)
+            generate_block(parent, ReaderSource.new(reader), attributes)
+          end
+
+          self.instance_eval &init
+        end
+
+        block_macro = Class.new(Asciidoctor::Extensions::BlockMacroProcessor) do
+          include DiagramProcessor
+
+          option :pos_attrs, ['target', 'format']
+
+          def process(parent, target, attributes)
+            source = FileSource.new(File.expand_path(target, parent.document.attributes['docdir']))
+            attributes['target'] ||= File.basename(target, File.extname(target))
+
+            generate_block(parent, source, attributes)
+          end
+
+          self.instance_eval &init
+        end
+
+        Asciidoctor::Diagram.const_set("#{name}Block", block)
+        Asciidoctor::Diagram.const_set("#{name}BlockMacro", block_macro)
       end
 
+      private
+
       def generate_block(parent, source, attributes)
-        format = attributes.delete('format') || @default_format
+        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 = formats[format]
+        generator_info = self.class.formats[format]
 
         raise "#{self.class.name} does not support output format #{format}" unless generator_info
 
@@ -69,30 +108,6 @@ module Asciidoctor
         end
       end
 
-      private
-
-      #
-      # Registers a supported format. The first registered format becomes the default format for the block processor.
-      #
-      # +format+ is a symbol with the format name
-      # +type+ is a symbol and should be either :image or :literal
-      # +block+ is a block that produces the diagrams from code. The block receives the parent asciidoc block and the diagram code as arguments
-      #
-      def register_format(format, type, &block)
-        unless @default_format
-          @default_format = format
-        end
-
-        formats[format] = {
-            :type => type,
-            :generator => block
-        }
-      end
-
-      def formats
-        @formats ||= {}
-      end
-
       def create_image_block(parent, source, attributes, format, generator_info)
         target = attributes.delete('target')