asciidoctor-diagram 2.0.2 → 2.1.2

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
+PLANTUML_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
+eos
 
-    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
-
-    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, PLANTUML_CODE, [:png, :svg, :txt]
 
   it 'should support substitutions in diagram code' do
     code = <<-eos
@@ -216,153 +153,23 @@ 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
+  include_examples "block", :plantuml, PLANTUML_CODE, [:png, :svg, :txt]
 
-    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 respect the svg-type attribute when format is set to 'svg'" do
+  it "should work with plantuml.com" do
     doc = <<-eos
-= Hello, PlantUML!
+= Hello, kroki!
+:diagram-server-url: http://plantuml.com/plantuml
+:diagram-server-type: plantuml
 Doc Writer <doc@example.com>
 
 == First Section
 
-[plantuml, format="svg", svg-type="inline"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
+[plantuml, 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['opts']).to eq('inline')
-
-    expect(b.attributes['width']).to_not be_nil
-    expect(b.attributes['height']).to_not be_nil
-  end
-
-  it "should respect the diagram-svg-type attribute when format is set to 'svg'" do
-    doc = <<-eos
-= Hello, PlantUML!
-:diagram-svg-type: inline
-Doc Writer <doc@example.com>
-
-== First Section
-
-[plantuml, format="svg"]
-----
-User -> (Start)
-User --> (Use the application) : Label
-
-:Main Admin: ---> (Use the application) : Another label
+#{PLANTUML_CODE}
 ----
     eos
 
@@ -376,57 +183,13 @@ User --> (Use the application) : Label
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match(/\.svg/)
+    expect(target).to match(/\.svg$/)
     expect(File.exist?(target)).to be true
 
-    expect(b.attributes['opts']).to eq('inline')
-
     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
-
   it 'should use plantuml configuration when specified as a document attribute' do
     doc = <<-eos
 = Hello, PlantUML!
@@ -460,275 +223,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
@@ -834,41 +329,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!
@@ -1163,4 +623,54 @@ Bob; Alice; foo
       load_asciidoc doc
     }.to raise_error(/syntax error/i)
   end
+
+  it "should support complex preprocessor usage" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml,format="png"]
+----
+@startuml
+!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Container.puml
+
+!define DEVICONS https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/devicons
+!define FONTAWESOME https://raw.githubusercontent.com/tupadr3/plantuml-icon-font-sprites/master/font-awesome-5
+!include DEVICONS/angular.puml
+!include DEVICONS/java.puml
+!include DEVICONS/msql_server.puml
+!include FONTAWESOME/users.puml
+
+LAYOUT_WITH_LEGEND()
+
+Person(user, "Customer", "People that need products", "users")
+Container(spa, "SPA", "angular", "The main interface that the customer interacts with", "angular")
+Container(api, "API", "java", "Handles all business logic", "java")
+ContainerDb(db, "Database", "Microsoft SQL", "Holds product, order and invoice information", "msql_server")
+
+Rel(user, spa, "Uses", "https")
+Rel(spa, api, "Uses", "https")
+Rel_R(api, db, "Reads/Writes")
+@enduml
+----
+    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
 end