asciidoctor-diagram 1.5.18 → 2.0.4

data/spec/nomnoml_spec.rb

@@ -1,7 +1,7 @@
 require_relative 'test_helper'
 
 code = <<-eos
-[Pirate|eyeCount: Int|raid();pillage()|
+[Pirate
   [beard]--[parrot]
   [beard]-:>[foul mouth]
 ]
@@ -11,7 +11,7 @@ code = <<-eos
 [jollyness]->[Pirate]
 [jollyness]->[rum]
 [jollyness]->[singing]
-[Pirate]-> *[rum|tastiness: Int|swig()]
+[Pirate]-> *[rum]
 [Pirate]->[singing]
 [singing]<->[rum]
 
@@ -24,147 +24,9 @@ code = <<-eos
 eos
 
 describe Asciidoctor::Diagram::NomnomlBlockMacroProcessor do
-  it "should generate SVG images when format is set to 'svg'" do
-    File.write('nomnoml.txt', code)
-
-    doc = <<-eos
-= Hello, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-nomnoml::nomnoml.txt[format="svg"]
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.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.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+  include_examples "block_macro", :nomnoml, code, [:svg]
 end
 
 describe Asciidoctor::Diagram::NomnomlBlockProcessor, :broken_on_windows do
-  it "should generate SVG images when format is set to 'svg'" do
-    doc = <<-eos
-= Hello, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[nomnoml, format="svg"]
-----
-#{code}
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.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.exist?(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, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[nomnoml, format="foobar"]
-----
-----
-    eos
-
-    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
-  end
-
-  it "should not regenerate images when source has not changed" do
-    File.write('nomnoml.txt', code)
-
-    doc = <<-eos
-= Hello, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-nomnoml::nomnoml.txt
-
-[nomnoml, format="svg"]
-----
-#{code}
-----
-    eos
-
-    d = load_asciidoc doc
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-    target = b.attributes['target']
-    mtime1 = File.mtime(target)
-
-    sleep 1
-
-    d = load_asciidoc doc
-
-    mtime2 = File.mtime(target)
-
-    expect(mtime2).to eq mtime1
-  end
-
-  it "should handle two block macros with the same source" do
-    File.write('nomnoml.txt', code)
-
-    doc = <<-eos
-= Hello, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-nomnoml::nomnoml.txt[]
-nomnoml::nomnoml.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('nomnoml.svg')).to be true
-  end
-
-  it "should respect target attribute in block macros" do
-    File.write('nomnoml.txt', code)
-
-    doc = <<-eos
-= Hello, Nomnoml!
-Doc Writer <doc@example.com>
-
-== First Section
-
-nomnoml::nomnoml.txt["foobar"]
-nomnoml::nomnoml.txt["foobaz"]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('foobar.svg')).to be true
-    expect(File.exist?('foobaz.svg')).to be true
-    expect(File.exist?('nomnoml.svg')).to be false
-  end
+  include_examples "block", :nomnoml, code, [:svg]
 end

data/spec/pikchr_spec.rb

@@ -0,0 +1,51 @@
+require_relative 'test_helper'
+
+code = <<-eos
+# Change from the original:
+#    * Expand the macro by hand, as Pikchr does not support
+#      macros
+#
+#define ndblock {
+#  box wid boxwid/2 ht boxht/2
+#  down;  box same with .t at bottom of last box;   box same
+#}
+boxht = .2; boxwid = .3; circlerad = .3; dx = 0.05
+down; box; box; box; box ht 3*boxht "." "." "."
+L: box; box; box invis wid 2*boxwid "hashtab:" with .e at 1st box .w
+right
+Start: box wid .5 with .sw at 1st box.ne + (.4,.2) "..."
+N1: box wid .2 "n1";  D1: box wid .3 "d1"
+N3: box wid .4 "n3";  D3: box wid .3 "d3"
+box wid .4 "..."
+N2: box wid .5 "n2";  D2: box wid .2 "d2"
+arrow right from 2nd box
+#ndblock
+  box wid boxwid/2 ht boxht/2
+  down;  box same with .t at bottom of last box;   box same
+spline -> right .2 from 3rd last box then to N1.sw + (dx,0)
+spline -> right .3 from 2nd last box then to D1.sw + (dx,0)
+arrow right from last box
+#ndblock
+  box wid boxwid/2 ht boxht/2
+  down;  box same with .t at bottom of last box;   box same
+spline -> right .2 from 3rd last box to N2.sw-(dx,.2) to N2.sw+(dx,0)
+spline -> right .3 from 2nd last box to D2.sw-(dx,.2) to D2.sw+(dx,0)
+arrow right 2*linewid from L
+#ndblock
+  box wid boxwid/2 ht boxht/2
+  down;  box same with .t at bottom of last box;   box same
+spline -> right .2 from 3rd last box to N3.sw + (dx,0)
+spline -> right .3 from 2nd last box to D3.sw + (dx,0)
+circlerad = .3
+circle invis "ndblock"  at last box.e + (1.2,.2)
+arrow dashed from last circle.w to 5/8<last circle.w,2nd last box> chop
+box invis wid 2*boxwid "ndtable:" with .e at Start.w
+eos
+
+describe Asciidoctor::Diagram::PikchrBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  include_examples "block_macro", :pikchr, code, [:svg]
+end
+
+describe Asciidoctor::Diagram::ErdBlockProcessor, :broken_on_travis, :broken_on_windows do
+  include_examples "block", :pikchr, code, [:svg]
+end

data/spec/plantuml_spec.rb

@@ -1,77 +1,14 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::PlantUmlBlockMacroProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    code = <<-eos
+code = <<-eos
 User -> (Start)
 User --> (Use the application) : Label
 
 :Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt[format="png"]
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.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.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate PNG images when format is set to 'png'" do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt[format="png"]
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-
-    expect(b.content_model).to eq :empty
+eos
 
-    target = b.attributes['target']
-    expect(target).to_not be_nil
-    expect(target).to match(/\.png$/)
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
+describe Asciidoctor::Diagram::PlantUmlBlockMacroProcessor do
+  include_examples "block_macro", :plantuml, code, [:png, :svg, :txt]
 
   it 'should support substitutions in diagram code' do
     code = <<-eos
@@ -216,145 +153,10 @@ plantuml::dir/plantuml.txt[format="svg", subs=attributes+]
     content = File.read(target, :encoding => Encoding::UTF_8)
     expect(content).to_not include('!include')
   end
-
-  it 'should generate blocks with figure captions' do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-.This is a UML diagram
-plantuml::plantuml.txt[format="png"]
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-
-    expect(b.caption).to match(/Figure \d+/)
-  end
 end
 
 describe Asciidoctor::Diagram::PlantUmlBlockProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="png"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.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.exist?(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, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="svg"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.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.exist?(target)).to be true
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should generate literal blocks when format is set to 'txt'" do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="txt"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :literal }
-    expect(b).to_not be_nil
-
-    expect(b.content_model).to eq :verbatim
-
-    expect(b.attributes['target']).to be_nil
-  end
-
-  it 'should raise an error when when format is set to an invalid value' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="foobar"]
-----
-----
-    eos
-
-    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
-  end
+  include_examples "block", :plantuml, code, [:png, :svg, :txt]
 
   it 'should use plantuml configuration when specified as a document attribute' do
     doc = <<-eos
@@ -389,275 +191,7 @@ skinparam ArrowColor #DEADBE
     expect(File.exist?(target)).to be true
 
     svg = File.read(target, :encoding => Encoding::UTF_8)
-    expect(svg).to match(/<path.*fill="#DEADBE"/)
-  end
-
-  it 'should not regenerate images when source has not changed' do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt
-
-[plantuml, format="png"]
-----
-actor Foo1
-boundary Foo2
-Foo1 -> Foo2 : To boundary
-----
-    eos
-
-    d = load_asciidoc doc
-    b = d.find { |bl| bl.context == :image }
-    target = b.attributes['target']
-    mtime1 = File.mtime(target)
-
-    sleep 1
-
-    d = load_asciidoc doc
-
-    mtime2 = File.mtime(target)
-
-    expect(mtime2).to eq mtime1
-  end
-
-  it 'should handle two block macros with the same source' do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt[]
-plantuml::plantuml.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('plantuml.png')).to be true
-  end
-
-  it 'should respect target attribute in block macros' do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt["foobar"]
-plantuml::plantuml.txt["foobaz"]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('foobar.png')).to be true
-    expect(File.exist?('foobaz.png')).to be true
-    expect(File.exist?('plantuml.png')).to be false
-  end
-
-  it 'should respect target attribute values with relative paths in block macros' do
-    code = <<-eos
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
-    eos
-
-    File.write('plantuml.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-plantuml::plantuml.txt["test/foobar"]
-plantuml::plantuml.txt["test2/foobaz"]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('test/foobar.png')).to be true
-    expect(File.exist?('test2/foobaz.png')).to be true
-    expect(File.exist?('plantuml.png')).to be false
-  end
-
-  it 'should write files to outdir if set' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="svg"]
-----
-actor Foo1
-boundary Foo2
-Foo1 -> Foo2 : To boundary
-----
-    eos
-
-    d = load_asciidoc doc, {:attributes => {'outdir' => 'foo'}}
-    b = d.find { |bl| bl.context == :image }
-
-    target = b.attributes['target']
-    expect(target).to_not be_nil
-    expect(File.exist?(target)).to be false
-    expect(File.exist?(File.expand_path(target, 'foo'))).to be true
-  end
-
-  it 'should write files to to_dir if set' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="svg"]
-----
-actor Foo1
-boundary Foo2
-Foo1 -> Foo2 : To boundary
-----
-    eos
-
-    d = load_asciidoc doc, {:to_dir => 'foo'}
-    b = d.find { |bl| bl.context == :image }
-
-    target = b.attributes['target']
-    expect(target).to_not be_nil
-    expect(File.exist?(target)).to be false
-    expect(File.exist?(File.expand_path(target, 'foo'))).to be true
-  end
-
-  it 'should write files to to_dir if set when embedded in table' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-|===
-|Type | Example
-
-|graphviz
-a|
-[plantuml, format="svg"]
-----
-actor Foo1
-boundary Foo2
-Foo1 -> Foo2 : To boundary
-----
-|===
-    eos
-
-    d = load_asciidoc doc, {:to_dir => 'foo'}
-    b = d.find { |bl| bl.context == :image }
-
-    target = b.attributes['target']
-    expect(target).to_not be_nil
-    expect(File.exist?(target)).to be false
-    expect(File.exist?(File.expand_path(target, 'foo'))).to be true
-  end
-
-  it 'should write files to imagesoutdir if set' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="svg"]
-----
-actor Foo1
-boundary Foo2
-Foo1 -> Foo2 : To boundary
-----
-    eos
-
-    d = load_asciidoc doc, {:attributes => {'imagesoutdir' => 'bar', 'outdir' => 'foo'}}
-    b = d.find { |bl| bl.context == :image }
-
-    target = b.attributes['target']
-    expect(target).to_not be_nil
-    expect(File.exist?(target)).to be false
-    expect(File.exist?(File.expand_path(target, 'bar'))).to be true
-    expect(File.exist?(File.expand_path(target, 'foo'))).to be false
-  end
-
-  it 'should omit width/height attributes when generating docbook' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="png"]
-----
-User -> (Start)
-----
-    eos
-
-    d = load_asciidoc doc, :attributes => {'backend' => 'docbook5'}
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-
-    target = b.attributes['target']
-    expect(File.exist?(target)).to be true
-
-    expect(b.attributes['width']).to be_nil
-    expect(b.attributes['height']).to be_nil
-  end
-
-  it 'should generate blocks with figure captions' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-.Caption for my UML diagram
-[plantuml, format="png"]
-----
-User -> (Start)
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-
-    expect(b.caption).to match(/Figure \d+/)
+    expect(svg).to match(/<[^<]+ fill=["']#DEADBE["']/)
   end
 
   it 'should support salt diagrams using salt block type' do
@@ -763,41 +297,6 @@ salt
     expect(b.attributes['height']).to be_nil
   end
 
-  it 'should support scaling diagrams' do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="png"]
-----
-A -> B
-----
-    eos
-
-    scaled_doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="png", scale="1.5"]
-----
-A -> B
-----
-    eos
-
-    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
-    unscaled_image = d.find { |bl| bl.context == :image }
-
-    d = load_asciidoc scaled_doc, :attributes => {'backend' => 'html5'}
-    scaled_image = d.find { |bl| bl.context == :image }
-
-    expect(scaled_image.attributes['width']).to be_within(1).of(unscaled_image.attributes['width'] * 1.5)
-    expect(scaled_image.attributes['height']).to be_within(1).of(unscaled_image.attributes['height'] * 1.5)
-  end
-
   it 'should handle embedded creole images correctly' do
     creole_doc = <<-eos
 = Hello, PlantUML!
@@ -1074,4 +573,22 @@ Doc Writer <doc@example.com>
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
   end
+
+  it "should report syntax errors" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml,format="svg"]
+----
+Bob; Alice; foo
+----
+    eos
+
+    expect {
+      load_asciidoc doc
+    }.to raise_error(/syntax error/i)
+  end
 end