asciidoctor-diagram 1.2.0.preview.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9f55fc39f6f8cb962714d683847a914da57605b
-  data.tar.gz: 3410e9e1a782f07fd8e9143118f08b6f3b7a9739
+  metadata.gz: 74838c060f09bcfe7603faef3aeee8c075cecaec
+  data.tar.gz: cb315faf5b140f071a6f7a0fdb748e366d5eefae
 SHA512:
-  metadata.gz: 65555754f853801c0380791eb75084674dd3fc9ebd8f59413d422be56867ee6f6c598d3acc39809ea113b6e29a2a265933c5f7dcb4ada80c99518b6d86d4f597
-  data.tar.gz: 37fbe270d7885a05cf16e6301be67ba0a7c5c51e79c74013bef0e13c95978197b575bb0f516d8cd2e006f839a1b422384ee3f0c666af7f5205a56e4361e3737c
+  metadata.gz: 131fb3f8a3cecb232601c72424240c284996bfeef9a66c64bc3d88c6e0a1aab48299c2baa5935d1d3ed54ceca85b912716ae10dea48c21950ce6d5ff3b76f960
+  data.tar.gz: 4d096215c18e27b7fdfbb4bccd131c6e94699c9fb572c1f5f00e9df196a2c0d81390dd84c70dfbef3153a9cfe8d7c3598fd15f6f14d53979b93fe44130f82589

data/CHANGELOG.adoc

@@ -6,6 +6,49 @@ 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::
+
+  * Use the output directory (outdir attribute) as base directory if it's specified.
+  * Do not auto-generate width/height attributes when outputting to a non-HTML backend. This resolves issues with
+    oversized images in docbook output.
+
+== 1.1.4
+
+Bug Fixes::
+
+  * Under CRuby in combination with certain Java versions a FileNotFoundException could be triggered due to incorrect
+    method selection by RJB
+
+== 1.1.3
+
+Bug Fixes::
+
+  * Image regeneration logic did not always correctly detect cases where images did not need to be updated
+
+== 1.1.2
+
+Bug Fixes::
+
+  * Fix corrupt PNG images on Windows
+  * Fix NoSuchMethodError in block macro processing when target image file already existed
+  * Respect target attribute in block macros
+
 == 1.1.1
 
 Bug Fixes::

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/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/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
 
@@ -25,31 +26,21 @@ module Asciidoctor
         if config_file
           flags += ['-config', File.expand_path(config_file, parent.document.attributes['docdir'])]
         end
-
-        option = Java.net.sourceforge.plantuml.Option.new(Java.array_to_java_array(flags, :string))
-        source_reader = Java.net.sourceforge.plantuml.SourceStringReader.new(
-            Java.net.sourceforge.plantuml.preproc.Defines.new(),
-            code,
-            option.getConfig()
+        
+        option = Java.new_object( Java.net.sourceforge.plantuml.Option, '[Ljava.lang.String;', Java.array_to_java_array(flags, :string) )
+        source_reader = Java.new_object( Java.net.sourceforge.plantuml.SourceStringReader,
+                                         'Lnet.sourceforge.plantuml.preproc.Defines;Ljava.lang.String;Ljava.util.List;',
+                                         Java.new_object( Java.net.sourceforge.plantuml.preproc.Defines ),
+                                         code,
+                                         option.getConfig()
         )
 
-        bos = Java.java.io.ByteArrayOutputStream.new
-        ps = Java.java.io.PrintStream.new(bos)
+        bos = Java.new_object( Java.java.io.ByteArrayOutputStream )
+        ps = Java.new_object( Java.java.io.PrintStream, 'Ljava.io.OutputStream;', bos )
         source_reader.generateImage(ps, 0, option.getFileFormatOption())
         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/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/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/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

@@ -1,75 +1,54 @@
 require 'asciidoctor/extensions'
 require 'digest'
 require 'json'
+require 'fileutils'
 require_relative 'java'
 require_relative 'png'
 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)
+      block_macro = Class.new(Asciidoctor::Extensions::BlockMacroProcessor) do
+        class << self
+          include FormatRegistry
+        end
+        include DiagramProcessor
 
-        raise "Format undefined" unless format
+        option :pos_attrs, ['target', 'format']
 
-        generator_info = formats[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))
 
-        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}"
+          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.
       #
@@ -92,11 +71,50 @@ 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')
 
         image_name = "#{target || ('diag-' + source.checksum)}.#{format}"
-        image_dir = File.expand_path(parent.document.attributes['imagesdir'] || '', parent.document.attributes['docdir'])
+        image_dir = File.expand_path(parent.document.attributes['imagesdir'] || '', parent.document.attributes['outdir'] || parent.document.attributes['docdir'])
         image_file = File.expand_path(image_name, image_dir)
         metadata_file = File.expand_path("#{image_name}.cache", image_dir)
 
@@ -116,14 +134,17 @@ module Asciidoctor
           metadata = {'checksum' => source.checksum}
           metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
 
+          FileUtils.mkdir_p(image_dir) unless Dir.exists?(image_dir)
           File.open(image_file, 'wb') { |f| f.write result }
           File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
         end
 
         attributes['target'] = image_name
-        attributes['width'] ||= metadata['width'] if metadata['width']
-        attributes['height'] ||= metadata['height'] if metadata['height']
-        attributes['alt'] ||= if (title_text = attributes['title'])
+        if /html/i =~ parent.document.attributes['backend']
+          attributes['width'] ||= metadata['width'] if metadata['width']
+          attributes['height'] ||= metadata['height'] if metadata['height']
+        end
+        attributes['alt'] ||= if title_text = attributes['title']
                                 title_text
                               elsif target
                                 (File.basename target, (File.extname target) || '').tr '_-', ' '

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

@@ -31,6 +31,10 @@ module Asciidoctor
         load
         ::Java.send(meth)
       end
+
+      def self.new_object(java_class, signature = nil, *args)
+        java_class.new(*args)
+      end
     end
   end
 end

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

@@ -77,6 +77,14 @@ module Asciidoctor
         @root_package ||= Package.send(:create_package, nil)
         @root_package.send(meth, *args)
       end
+
+      def self.new_object(java_class, signature = nil, *args)
+        if signature
+          java_class.new_with_sig(signature, *args)
+        else
+          java_class.new(*args)
+        end
+      end
     end
   end
 end

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

@@ -4,34 +4,30 @@ module Asciidoctor
   module Diagram
     module SVG
       def self.get_image_size(data)
-        get_from_style(data) || get_from_viewport(data)
-      end
-
-      private
-
-      SVG_STYLE_REGEX = /style\s*=\s*"width:(?<width>\d+)px;height:(?<height>\d+)px/
+        if m = START_TAG_REGEX.match(data)
+          start_tag = m[0]
+          if (w = WIDTH_REGEX.match(start_tag)) && (h = HEIGHT_REGEX.match(start_tag))
+            width = w[:value].to_i * to_px_factor(w[:unit])
+            height = h[:value].to_i * to_px_factor(h[:unit])
+            return [width.to_i, height.to_i]
+          end
 
-      def self.get_from_style(data)
-        match_data = SVG_STYLE_REGEX.match(data)
-        if match_data
-          [match_data[:width].to_i, match_data[:height].to_i]
-        else
-          nil
+          if v = VIEWBOX_REGEX.match(start_tag)
+            width = v[:width]
+            height = v[:height]
+            return [width.to_i, height.to_i]
+          end
         end
+
+        nil
       end
 
-      SVG_VIEWPORT_REGEX = /<svg width="(?<width>\d+)(?<width_unit>[a-zA-Z]+)" height="(?<height>\d+)(?<height_unit>[a-zA-Z]+)"/
+      private
 
-      def self.get_from_viewport(data)
-        match_data = SVG_VIEWPORT_REGEX.match(data)
-        if match_data
-          width = match_data[:width].to_i * to_px_factor(match_data[:width_unit])
-          height = match_data[:height].to_i * to_px_factor(match_data[:height_unit])
-          [width.to_i, height.to_i]
-        else
-          nil
-        end
-      end
+      START_TAG_REGEX = /<svg[^>]*>/
+      WIDTH_REGEX = /width="(?<value>\d+)(?<unit>[a-zA-Z]+)"/
+      HEIGHT_REGEX = /height="(?<value>\d+)(?<unit>[a-zA-Z]+)"/
+      VIEWBOX_REGEX = /viewBox="\d+ \d+ (?<width>\d+) (?<height>\d+)"/
 
       def self.to_px_factor(unit)
         case unit

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

@@ -0,0 +1,14 @@
+module Asciidoctor
+  module Diagram
+    def self.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

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.2.0.preview.3"
+    VERSION = "1.2.0"
   end
 end