asciidoctor-diagram 1.5.18 → 2.0.3

data/spec/lilypond_spec.rb

@@ -0,0 +1,151 @@
+require_relative 'test_helper'
+
+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
+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

data/spec/mermaid_spec.rb

@@ -301,4 +301,36 @@ mermaid::mermaid.txt["dark", format="svg", theme="dark"]
     expect(File.exist?('dark.svg')).to be true
     expect(File.read('default.svg')).to_not be File.read('dark.svg')
   end
-end
+
+  it "should respect the puppeteerConfig attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+    eos
+
+    pptr_config = <<-eos
+{
+    "args": ["--no-sandbox"]
+}
+    eos
+    File.write('pptrconfig.txt', pptr_config)
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_config", puppeteerConfig="pptrconfig.txt"]
+mermaid::mermaid.txt["without_config"]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('with_config.png')).to be true
+    expect(File.exist?('without_config.png')).to be true
+    expect(File.size('with_config.png')).to be File.size('without_config.png')
+  end
+end

data/spec/pikchr_spec.rb

@@ -0,0 +1,106 @@
+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
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('pikchr.txt', code)
+
+    doc = <<-eos
+= Hello, Pikchr!
+Doc Writer <doc@example.com>
+
+== First Section
+
+pikchr::pikchr.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::ErdBlockProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Pikchr!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[pikchr, 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
+end

data/spec/plantuml_spec.rb

@@ -314,6 +314,77 @@ User --> (Use the application) : Label
     expect(b.attributes['height']).to_not be_nil
   end
 
+  it "should respect the svg-type attribute when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, 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
+----
+    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.option?('inline')).to be_truthy
+
+    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
+----
+    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.option?('inline')).to be_truthy
+
+    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!
@@ -389,7 +460,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"/)
+    expect(svg).to match(/<[^<]+ fill=["']#DEADBE["']/)
   end
 
   it 'should not regenerate images when source has not changed' do
@@ -1074,4 +1145,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

data/spec/smcat_spec.rb

@@ -0,0 +1,164 @@
+require_relative 'test_helper'
+
+code = <<-eos
+initial,
+doing: entry/ write unit test
+       do/ write code
+       exit/ ...,
+# smcat recognizes initial
+# and final states by name
+# and renders them appropriately
+final;
+
+initial      => "on backlog" : item adds most value;
+"on backlog" => doing        : working on it;
+doing        => testing      : built & unit tested;
+testing      => "on backlog" : test not ok;
+testing      => final        : test ok;
+eos
+
+describe Asciidoctor::Diagram::SmcatBlockMacroProcessor, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('smcat.txt', code)
+
+    doc = <<-eos
+= Hello, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+smcat::smcat.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::SmcatBlockProcessor, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[smcat, 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, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[smcat, 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('smcat.txt', code)
+
+    doc = <<-eos
+= Hello, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+smcat::smcat.txt
+
+[smcat, 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('smcat.txt', code)
+
+    doc = <<-eos
+= Hello, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+smcat::smcat.txt[]
+smcat::smcat.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('smcat.svg')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('smcat.txt', code)
+
+    doc = <<-eos
+= Hello, Smcat!
+Doc Writer <doc@example.com>
+
+== First Section
+
+smcat::smcat.txt["foobar"]
+smcat::smcat.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?('smcat.svg')).to be false
+  end
+end