asciidoctor-diagram 2.0.2 → 2.1.2

data/spec/graphviz_spec.rb

@@ -1,159 +1,20 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::GraphvizBlockMacroProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    code = <<-eos
+DOT_CODE = <<-eos
 digraph foo {
   node [style=rounded]
   node1 [shape=box]
   node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
-  node3 [shape=record, label="{ a | b | c }"]
+  node3 [shape=record, label=" a b c"]
 
   node1 -> node2 -> node3
 }
-    eos
-
-    File.write('graphviz.txt', code)
-
-    doc = <<-eos
-= Hello, graphviz!
-Doc Writer <doc@example.com>
-
-== First Section
-
-graphviz::graphviz.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
+eos
 
-    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::GraphvizBlockMacroProcessor do
+  include_examples "block_macro", :graphviz, DOT_CODE, [:png, :svg]
 end
 
 describe Asciidoctor::Diagram::GraphvizBlockProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, graphviz!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[graphviz, format="png"]
-----
-digraph foo {
-  node [style=rounded]
-  node1 [shape=box]
-  node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
-  node3 [shape=record, label="{ a | b | c }"]
-
-  node1 -> node2 -> node3
-}
-----
-    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, graphviz!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[graphviz, format="svg"]
-----
-digraph foo {
-  node [style=rounded]
-  node1 [shape=box]
-  node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]
-  node3 [shape=record, label="{ a | b | c }"]
-
-  node1 -> node2 -> node3
-}
-----
-    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, graphviz!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[graphviz, format="foobar"]
-----
-----
-    eos
-
-    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
-  end
-
-  it "should support neato layout engine" do
-    doc = <<-eos
-= Hello, graphviz!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[graphviz, layout=neato]
-----
-digraph g { rankdir=LR; Text->Graphviz->Image }
-----
-    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(File.exist?(target)).to be true
-  end
+  include_examples "block", :graphviz, DOT_CODE, [:png, :svg]
 end

data/spec/lilypond_spec.rb

@@ -1,151 +1,13 @@
 require_relative 'test_helper'
 
-code = <<-eos
+LILYPOND_CODE = <<-eos
 \\relative c' { f d f a d f e d cis a cis e a g f e }
 eos
 
-describe Asciidoctor::Diagram::LilypondBlockMacroProcessor, :broken_on_windows do
-  it "should generate PNG images when format is set to 'png'" do
-    File.write('lilypond.txt', code)
-
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-lilypond::lilypond.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::LilypondBlockMacroProcessor do
+  include_examples "block_macro", :lilypond, LILYPOND_CODE, [:png]
 end
 
-describe Asciidoctor::Diagram::LilypondBlockProcessor, :broken_on_windows do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[lilypond, format="png"]
-----
-#{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(/\.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 raise an error when when format is set to an invalid value" do
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[lilypond, 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('lilypond.txt', code)
-
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-lilypond::lilypond.txt
-
-[lilypond, format="png"]
-----
-#{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('lilypond.txt', code)
-
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-lilypond::lilypond.txt[]
-lilypond::lilypond.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('lilypond.png')).to be true
-  end
-
-  it "should respect target attribute in block macros" do
-    File.write('lilypond.txt', code)
-
-    doc = <<-eos
-= Hello, Lilypond!
-Doc Writer <doc@example.com>
-
-== First Section
-
-lilypond::lilypond.txt["foobar"]
-lilypond::lilypond.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?('lilypond.png')).to be false
-  end
-end
+describe Asciidoctor::Diagram::LilypondBlockProcessor do
+  include_examples "block", :lilypond, LILYPOND_CODE, [:png]
+end

data/spec/mermaid_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-code = <<-eos
+MERMAID_CODE = <<-eos
 graph LR
     A[Square Rect] -- Link text --> B((Circle))
     A --> C(Round Rect)
@@ -9,208 +9,7 @@ graph LR
 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 = 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
-    File.write('mermaid.txt', code)
-
-    doc = <<-eos
-= Hello, Mermaid!
-Doc Writer <doc@example.com>
-
-== First Section
-
-mermaid::mermaid.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
-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 = 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, Mermaid!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[mermaid, 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, Mermaid!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[mermaid, 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('mermaid.txt', code)
-
-    doc = <<-eos
-= Hello, Mermaid!
-Doc Writer <doc@example.com>
-
-== First Section
-
-mermaid::mermaid.txt
-
-[mermaid, format="png"]
-----
-#{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('mermaid.txt', code)
-
-    doc = <<-eos
-= Hello, Mermaid!
-Doc Writer <doc@example.com>
-
-== First Section
-
-mermaid::mermaid.txt[]
-mermaid::mermaid.txt[]
-    eos
-
-    load_asciidoc doc
-    expect(File.exist?('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
-
-    load_asciidoc doc
-    expect(File.exist?('foobar.png')).to be true
-    expect(File.exist?('foobaz.png')).to be true
-    expect(File.exist?('mermaid.png')).to be false
-  end
+  include_examples "block_macro", :mermaid, MERMAID_CODE, [:png, :svg]
 
   it "should respect the sequenceConfig attribute" do
     seq_diag = <<-eos
@@ -240,8 +39,8 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-mermaid::mermaid.txt["with_config", sequenceConfig="seqconfig.txt"]
-mermaid::mermaid.txt["without_config"]
+mermaid::mermaid.txt[target="with_config", sequenceConfig="seqconfig.txt"]
+mermaid::mermaid.txt[target="without_config"]
     eos
 
     load_asciidoc doc
@@ -266,8 +65,8 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-mermaid::mermaid.txt["with_width", width="700"]
-mermaid::mermaid.txt["without_width"]
+mermaid::mermaid.txt[target="with_width", width="700"]
+mermaid::mermaid.txt[target="without_width"]
     eos
 
     load_asciidoc doc
@@ -292,8 +91,8 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-mermaid::mermaid.txt["default", format="svg"]
-mermaid::mermaid.txt["dark", format="svg", theme="dark"]
+mermaid::mermaid.txt[target="default", format="svg"]
+mermaid::mermaid.txt[target="dark", format="svg", theme="dark"]
     eos
 
     load_asciidoc doc
@@ -324,8 +123,8 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-mermaid::mermaid.txt["with_config", puppeteerConfig="pptrconfig.txt"]
-mermaid::mermaid.txt["without_config"]
+mermaid::mermaid.txt[target="with_config", puppeteerConfig="pptrconfig.txt"]
+mermaid::mermaid.txt[target="without_config"]
     eos
 
     load_asciidoc doc
@@ -334,3 +133,62 @@ mermaid::mermaid.txt["without_config"]
     expect(File.size('with_config.png')).to be File.size('without_config.png')
   end
 end
+
+describe Asciidoctor::Diagram::MermaidBlockProcessor do
+  include_examples "block", :mermaid, MERMAID_CODE, [:png, :svg]
+
+  it "should work with kroki.io" do
+    doc = <<-eos
+= Hello, kroki!
+:diagram-server-url: https://kroki.io/
+:diagram-server-type: kroki_io
+Doc Writer <doc@example.com>
+
+== First Section
+
+[mermaid, format=svg]
+----
+graph TD
+  A[ Anyone ] -->|Can help | B( Go to github.com/yuzutech/kroki )
+  B --> C{ How to contribute? }
+  C --> D[ Reporting bugs ]
+  C --> E[ Sharing ideas ]
+  C --> F[ Advocating ]
+----
+    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 report unsupported scaling factors" do
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[mermaid, scale=1.5]
+----
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+----
+    eos
+
+    expect { load_asciidoc doc }.to raise_error(/support.*scale/i)
+  end
+end