asciidoctor-diagram 1.2.0.preview.5 → 1.2.0

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.5"
+    VERSION = "1.2.0"
   end
 end

data/spec/blockdiag_spec.rb

@@ -0,0 +1,183 @@
+require_relative 'test_helper'
+
+code = <<-eos
+blockdiag {
+   A -> B -> C -> D;
+   A -> E -> F -> G;
+}
+eos
+
+describe Asciidoctor::Diagram::BlockDiagBlockMacro do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('blockdiag.txt', code)
+
+    doc = <<-eos
+= Hello, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+blockdiag::blockdiag.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
+end
+
+describe Asciidoctor::Diagram::BlockDiagBlock do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[blockdiag, 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, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[blockdiag, 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, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[blockdiag, 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('blockdiag.txt', code)
+
+    doc = <<-eos
+= Hello, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+blockdiag::blockdiag.txt
+
+[blockdiag, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    b = d.find { |b| b.context == :image }
+    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('blockdiag.txt', code)
+
+    doc = <<-eos
+= Hello, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+blockdiag::blockdiag.txt[]
+blockdiag::blockdiag.txt[]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('blockdiag.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('blockdiag.txt', code)
+
+    doc = <<-eos
+= Hello, BlockDiag!
+Doc Writer <doc@example.com>
+
+== First Section
+
+blockdiag::blockdiag.txt["foobar"]
+blockdiag::blockdiag.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?('blockdiag.png')).to be false
+  end
+end

data/spec/ditaa_spec.rb

@@ -36,7 +36,7 @@ ditaa::ditaa.txt[format="png"]
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -76,7 +76,7 @@ Doc Writer <doc@example.com>
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -116,6 +116,6 @@ Doc Writer <doc@example.com>
     expect(b).to_not be_nil
     target = b.attributes['target']
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
   end
 end

data/spec/graphviz_spec.rb

@@ -35,7 +35,7 @@ graphviz::graphviz.txt[format="png"]
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -74,7 +74,7 @@ digraph foo {
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -111,7 +111,7 @@ digraph foo {
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.svg$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -131,4 +131,29 @@ Doc Writer <doc@example.com>
 
     expect { Asciidoctor.load StringIO.new(doc) }.to raise_error /support.*format/i
   end
+
+  it "should support single line digraphs" do
+    doc = <<-eos
+= Hello, graphviz!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[graphviz]
+----
+digraph g { rankdir=LR; Text->Graphviz->Image }
+----
+    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(File.exists?(target)).to be true
+  end
 end

data/spec/plantuml_spec.rb

@@ -31,7 +31,7 @@ plantuml::plantuml.txt[format="png"]
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -66,7 +66,7 @@ User --> (Use the application) : Label
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -99,7 +99,7 @@ User --> (Use the application) : Label
     target = b.attributes['target']
     expect(target).to_not be_nil
     expect(target).to match /\.svg/
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -176,7 +176,7 @@ ArrowColor #DEADBE
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     svg = File.read(target)
     expect(svg).to match /<path.*fill="#DEADBE"/
@@ -243,7 +243,7 @@ plantuml::plantuml.txt[]
     eos
 
     Asciidoctor.load StringIO.new(doc)
-    expect(File.exists?('plantuml.png')).to be_true
+    expect(File.exists?('plantuml.png')).to be true
   end
 
   it "should respect target attribute in block macros" do
@@ -267,9 +267,9 @@ plantuml::plantuml.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?('plantuml.png')).to be_false
+    expect(File.exists?('foobar.png')).to be true
+    expect(File.exists?('foobaz.png')).to be true
+    expect(File.exists?('plantuml.png')).to be false
   end
 
 
@@ -293,8 +293,8 @@ Foo1 -> Foo2 : To boundary
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(File.exists?(target)).to be_false
-    expect(File.exists?(File.expand_path(target, 'foo'))).to be_true
+    expect(File.exists?(target)).to be false
+    expect(File.exists?(File.expand_path(target, 'foo'))).to be true
   end
 
   it "should omit width/height attributes when generating docbook" do
@@ -317,7 +317,7 @@ User -> (Start)
     expect(b).to_not be_nil
 
     target = b.attributes['target']
-    expect(File.exists?(target)).to be_true
+    expect(File.exists?(target)).to be true
 
     expect(b.attributes['width']).to be_nil
     expect(b.attributes['height']).to be_nil

data/spec/shaape_spec.rb

@@ -0,0 +1,227 @@
+require_relative 'test_helper'
+
+describe Asciidoctor::Diagram::ShaapeBlockMacro do
+  it "should generate PNG images when format is set to 'png'" do
+    code = <<-eos
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+    eos
+
+    File.write('shaape.txt', code)
+
+    doc = <<-eos
+= Hello, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+shaape::shaape.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
+end
+
+describe Asciidoctor::Diagram::ShaapeBlock do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[shaape, format="png"]
+----
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+----
+    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, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[shaape, format="svg"]
+----
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+----
+    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, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[shaape, 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
+    code = <<-eos
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+    eos
+
+    File.write('shaape.txt', code)
+
+    doc = <<-eos
+= Hello, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+shaape::shaape.txt
+
+[shaape, format="png"]
+----
+    +--------+
+    |        |
+    | Hello  |
+    |   ;)   |
+    |        |
+    +--------+
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    b = d.find { |b| b.context == :image }
+    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
+    code = <<-eos
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+    eos
+
+    File.write('shaape.txt', code)
+
+    doc = <<-eos
+= Hello, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+shaape::shaape.txt[]
+shaape::shaape.txt[]
+    eos
+
+    Asciidoctor.load StringIO.new(doc)
+    expect(File.exists?('shaape.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    code = <<-eos
+    +--------+    +-------------+
+    |        |     \\           /
+    | Hello  |--->  \\ Goodbye /
+    |   ;)   |      /         \\
+    |        |     /           \\
+    +--------+    +-------------+
+    eos
+
+    File.write('shaape.txt', code)
+
+    doc = <<-eos
+= Hello, Shaape!
+Doc Writer <doc@example.com>
+
+== First Section
+
+shaape::shaape.txt["foobar"]
+shaape::shaape.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?('shaape.png')).to be false
+  end
+end