asciidoctor-diagram 1.3.2 → 1.4.0

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

@@ -5,6 +5,8 @@ module Asciidoctor
   module Diagram
     # @private
     module PlantUml
+      include Which
+
       private
 
       JARS = ['plantuml.jar'].map do |jar|
@@ -26,6 +28,11 @@ module Asciidoctor
           headers['X-PlantUML-Config'] = File.expand_path(config_file, parent.document.attributes['docdir'])
         end
 
+        dot = which(parent, 'dot', :attr_names => ['dot', 'graphvizdot'], :raise_on_error => false)
+        if dot
+          headers['X-Graphviz'] = dot
+        end
+
         response = Java.send_request(
             :url => '/plantuml',
             :body => code,

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

@@ -11,7 +11,7 @@ module Asciidoctor
       def self.included(mod)
         [:png, :svg].each do |f|
           mod.register_format(f, :image) do |c, p|
-            CliGenerator.generate_stdin(which(p, 'shaape'), c.to_s) do |tool_path, output_path|
+            CliGenerator.generate_stdin(which(p, 'shaape'), f.to_s, c.to_s) do |tool_path, output_path|
               [tool_path, '-o', output_path, '-t', f.to_s, '-']
             end
           end

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

@@ -8,12 +8,30 @@ module Asciidoctor
         @offset = 0
       end
 
+      def read_uint16_be
+        uint16 = @data[@offset,2].unpack('n')[0]
+        @offset += 2
+        uint16
+      end
+
+      def read_uint16_le
+        uint16 = @data[@offset,2].unpack('v')[0]
+        @offset += 2
+        uint16
+      end
+
       def read_uint32_be
         uint32 = @data[@offset,4].unpack('N')[0]
         @offset += 4
         uint32
       end
 
+      def read_uint32_le
+        uint32 = @data[@offset,4].unpack('V')[0]
+        @offset += 4
+        uint32
+      end
+
       def read_string(length, encoding = Encoding::ASCII_8BIT)
         str = @data[@offset,length]
         @offset += length

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

@@ -1,50 +1,39 @@
 require 'tempfile'
+require 'open3'
 
 module Asciidoctor
   module Diagram
     # @private
     module CliGenerator
-      def self.generate_stdin(tool, code)
+      def self.generate_stdin(tool, format, code)
         tool_name = File.basename(tool)
 
-        target_file = Tempfile.new(tool_name)
+        target_file = Tempfile.new([tool_name, ".#{format}"])
         begin
           target_file.close
 
-          args = yield tool, target_file.path
+          opts = yield tool, target_file.path
 
-          IO.popen(args, "w") do |io|
-            io.write code
-          end
-          result_code = $?
-
-          raise "#{tool_name} image generation failed" unless result_code == 0
-
-          File.binread(target_file.path)
+          generate(opts, target_file, :stdin_data => code)
         ensure
           target_file.unlink
         end
       end
 
-      def self.generate_file(tool, code)
+      def self.generate_file(tool, format, code)
         tool_name = File.basename(tool)
 
-        source_file = Tempfile.new(tool_name)
+        source_file = Tempfile.new([tool_name, ".#{format}"])
         begin
           File.write(source_file.path, code)
 
-          target_file = Tempfile.new(tool_name)
+          target_file = Tempfile.new([tool_name, ".#{format}"])
           begin
             target_file.close
 
-            args = yield tool, source_file.path, target_file.path
-
-            system(*args)
-            result_code = $?
-
-            raise "#{tool_name} image generation failed" unless result_code == 0
+            opts = yield tool, source_file.path, target_file.path
 
-            File.binread(target_file.path)
+            generate(opts, target_file)
           ensure
             target_file.unlink
           end
@@ -52,6 +41,37 @@ module Asciidoctor
           source_file.unlink
         end
       end
+
+      def self.generate(opts, target_file, open3_opts = {})
+        case opts
+          when Array
+            args = opts
+            out_file = nil
+          when Hash
+            args = opts[:args]
+            out_file = opts[:out_file]
+          else
+            raise "Block passed to generate_file should return an Array or a Hash"
+        end
+
+        run_cli(*args, open3_opts)
+
+        if out_file
+          File.rename(out_file, target_file.path)
+        end
+
+        File.binread(target_file.path)
+      end
+
+      def self.run_cli(*args)
+        stdout, stderr, status = Open3.capture3(*args)
+
+        if status != 0
+          raise "#{File.basename(args[0])} failed: #{stdout.empty? ? stderr : stdout}"
+        end
+
+        stdout
+      end
     end
   end
 end

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

@@ -0,0 +1,21 @@
+require_relative 'binaryio'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module GIF
+      GIF87A_SIGNATURE = 'GIF87a'.force_encoding(Encoding::ASCII_8BIT)
+      GIF89A_SIGNATURE = 'GIF89a'.force_encoding(Encoding::ASCII_8BIT)
+
+      def self.get_image_size(data)
+        bio = BinaryIO.new(data)
+        gif_signature = bio.read_string(6)
+        raise "Invalid GIF signature" unless gif_signature == GIF87A_SIGNATURE || gif_signature == GIF89A_SIGNATURE
+
+        width = bio.read_uint16_le
+        height = bio.read_uint16_le
+        [width, height]
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Asciidoctor
     module Java
       def self.classpath
         @classpath ||= [
-            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.7.jar'), File.dirname(__FILE__))
+            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.8.jar'), File.dirname(__FILE__))
         ]
       end
 

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

@@ -0,0 +1,25 @@
+require 'rbconfig'
+
+module Asciidoctor
+  module Diagram
+    module Platform
+      def self.os
+        @os ||= (
+        host_os = RbConfig::CONFIG['host_os']
+        case host_os
+          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+            :windows
+          when /darwin|mac os/
+            :macosx
+          when /linux/
+            :linux
+          when /solaris|bsd/
+            :unix
+          else
+            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+        end
+        )
+      end
+    end
+  end
+end

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

@@ -26,9 +26,9 @@ module Asciidoctor
       private
 
       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+)"/
+      WIDTH_REGEX = /width="(?<value>\d+(?:\.\d+)?)(?<unit>[a-zA-Z]+)?"/
+      HEIGHT_REGEX = /height="(?<value>\d+(?:\.\d+)?)(?<unit>[a-zA-Z]+)?"/
+      VIEWBOX_REGEX = /viewBox="\d+(?:\.\d+)? \d+(?:\.\d+)? (?<width>\d+(?:\.\d+)?) (?<height>\d+(?:\.\d+)?)"/
 
       def self.to_px_factor(unit)
         case unit

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

@@ -20,13 +20,19 @@ module Asciidoctor
 
         cmd_var = '@' + attr_names[0]
 
-        cmd_path = instance_variable_get(cmd_var)
-        unless cmd_path
+        already_defined = instance_variable_defined?(cmd_var)
+
+        if already_defined
+          cmd_path = instance_variable_get(cmd_var)
+        else
           cmd_path = attr_names.map { |attr_name| parent_block.document.attributes[attr_name] }.find { |attr| !attr.nil? }
           cmd_path = ::Asciidoctor::Diagram::Which.which(cmd, :path => options[:path]) unless cmd_path && File.executable?(cmd_path)
-          raise "Could not find the '#{cmd}' executable in PATH; add it to the PATH or specify its location using the '#{attr_names[0]}' document attribute" unless cmd_path
           instance_variable_set(cmd_var, cmd_path)
+          if cmd_path.nil? && options.fetch(:raise_on_error, true)
+            raise "Could not find the '#{cmd}' executable in PATH; add it to the PATH or specify its location using the '#{attr_names[0]}' document attribute"
+          end
         end
+
         cmd_path
       end
     end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.3.2"
+    VERSION = "1.4.0"
   end
 end

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

@@ -1,5 +1,6 @@
 require_relative '../extensions'
 require_relative '../util/cli_generator'
+require_relative '../util/platform'
 require_relative '../util/which'
 
 module Asciidoctor
@@ -11,17 +12,26 @@ module Asciidoctor
       def self.included(mod)
         [:png, :svg].each do |f|
           mod.register_format(f, :image) do |c, p|
-            if /darwin/ =~ RUBY_PLATFORM
-              wavedrom = which(p, 'WaveDromEditor.app', :attr_names => ['wavedrom'], :path => ['/Applications'])
-              if wavedrom
-                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+            wavedrom_cli = which(p, 'wavedrom', :raise_on_error => false)
+            phantomjs = which(p, 'phantomjs', :raise_on_error => false)
+
+            if wavedrom_cli && phantomjs
+              CliGenerator.generate_file(wavedrom_cli, f.to_s, c.to_s) do |tool_path, input_path, output_path|
+                [phantomjs, tool_path, '-i', input_path, "-#{f.to_s[0]}", output_path]
               end
             else
-              wavedrom = which(p, 'WaveDromEditor', :attr_names => ['wavedrom'])
-            end
+              if ::Asciidoctor::Diagram::Platform.os == :macosx
+                wavedrom = which(p, 'WaveDromEditor.app', :attr_names => ['wavedrom'], :path => ['/Applications'])
+                if wavedrom
+                  wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+                end
+              else
+                wavedrom = which(p, 'WaveDromEditor', :attr_names => ['wavedrom'])
+              end
 
-            CliGenerator.generate_file(wavedrom, c.to_s) do |tool_path, input_path, output_path|
-              [tool_path, 'source', input_path, f.to_s, output_path]
+              CliGenerator.generate_file(wavedrom, f.to_s, c.to_s) do |tool_path, input_path, output_path|
+                [tool_path, 'source', input_path, f.to_s, output_path]
+              end
             end
           end
         end

data/spec/ditaa_spec.rb

@@ -159,7 +159,7 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-[ditaa, {opts}]
+[ditaa, test, png, {opts}]
 ----
 +--------+   +-------+    +-------+
 |        | --+ ditaa +--> |       |

data/spec/meme_spec.rb

@@ -0,0 +1,67 @@
+require_relative 'test_helper'
+
+describe Asciidoctor::Diagram::MemeBlockMacroProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    FileUtils.cp(
+        File.expand_path('man.jpg', File.dirname(__FILE__)),
+        File.expand_path('man.jpg', Dir.getwd)
+    )
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+meme::man.jpg[I don't always // write unit tests, but when I do // they generate memes, format=png, options=noupcase]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.png$/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate GIF images when format is set to 'gif'" do
+    FileUtils.cp(
+        File.expand_path('man.jpg', File.dirname(__FILE__)),
+        File.expand_path('man.jpg', Dir.getwd)
+    )
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+meme::man.jpg[I don't always // write unit tests, but when I do // they generate memes, format=gif, options=noupcase]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.gif/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+end

data/spec/mermaid_spec.rb

@@ -0,0 +1,277 @@
+require_relative 'test_helper'
+
+code = <<-eos
+graph LR
+    A[Square Rect] -- Link text --> B((Circle))
+    A --> C(Round Rect)
+    B --> D{Rhombus}
+    C --> D
+eos
+
+describe Asciidoctor::Diagram::MermaidBlockMacroProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('mermaid.txt', code)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt[format="png"]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.png$/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('mermaid.txt', code)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt[format="svg"]
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.svg/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+end
+
+describe Asciidoctor::Diagram::MermaidBlockProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[mermaid, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.png$/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[mermaid, format="svg"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match /\.svg/
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should raise an error when when format is set to an invalid value" do
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[mermaid, format="foobar"]
+----
+----
+    eos
+
+    expect { Asciidoctor.load StringIO.new(doc) }.to raise_error /support.*format/i
+  end
+
+  it "should not regenerate images when source has not changed" do
+    File.write('mermaid.txt', code)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt
+
+[mermaid, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+    target = b.attributes['target']
+    mtime1 = File.mtime(target)
+
+    sleep 1
+
+    d = Asciidoctor.load StringIO.new(doc)
+
+    mtime2 = File.mtime(target)
+
+    expect(mtime2).to eq mtime1
+  end
+
+  it "should handle two block macros with the same source" do
+    File.write('mermaid.txt', code)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt[]
+mermaid::mermaid.txt[]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('mermaid.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('mermaid.txt', code)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["foobar"]
+mermaid::mermaid.txt["foobaz"]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('foobar.png')).to be true
+    expect(File.exists?('foobaz.png')).to be true
+    expect(File.exists?('mermaid.png')).to be false
+  end
+
+  it "should respect the sequenceConfig attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+    eos
+
+    seq_config = <<-eos
+{
+  "diagramMarginX": 0,
+  "diagramMarginY": 0,
+  "actorMargin": 0,
+  "boxMargin": 0,
+  "boxTextMargin": 0,
+  "noteMargin": 0,
+  "messageMargin": 0
+}
+    eos
+    File.write('seqconfig.txt', seq_config)
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_config", sequenceConfig="seqconfig.txt"]
+mermaid::mermaid.txt["without_config"]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('with_config.png')).to be true
+    expect(File.exists?('without_config.png')).to be true
+    expect(File.size('with_config.png')).to_not be File.size('without_config.png')
+  end
+
+  it "should respect the width attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+    eos
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_width", width="700"]
+mermaid::mermaid.txt["without_width"]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('with_width.png')).to be true
+    expect(File.exists?('without_width.png')).to be true
+    expect(File.size('with_width.png')).to_not be File.size('without_width.png')
+  end
+end