asciidoctor-diagram 1.2.0 → 2.0.0

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/meme_spec.rb

@@ -0,0 +1,67 @@
+require_relative 'test_helper'
+
+describe Asciidoctor::Diagram::MemeBlockMacroProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    FileUtils.cp(
+        File.expand_path('man.jpg', File.dirname(__FILE__)),
+        File.expand_path('man.jpg', Dir.getwd)
+    )
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+meme::man.jpg[I don't always // write unit tests, but when I do // they generate memes, format=png, options=noupcase]
+    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 GIF images when format is set to 'gif'" do
+    FileUtils.cp(
+        File.expand_path('man.jpg', File.dirname(__FILE__)),
+        File.expand_path('man.jpg', Dir.getwd)
+    )
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+meme::man.jpg[I don't always // write unit tests, but when I do // they generate memes, format=gif, options=noupcase]
+    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(/\.gif/)
+    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/mermaid_spec.rb

@@ -0,0 +1,336 @@
+require_relative 'test_helper'
+
+code = <<-eos
+graph LR
+    A[Square Rect] -- Link text --> B((Circle))
+    A --> C(Round Rect)
+    B --> D{Rhombus}
+    C --> D
+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
+
+  it "should respect the sequenceConfig attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+    eos
+
+    seq_config = <<-eos
+{
+  "diagramMarginX": 0,
+  "diagramMarginY": 0,
+  "actorMargin": 0,
+  "boxMargin": 0,
+  "boxTextMargin": 0,
+  "noteMargin": 0,
+  "messageMargin": 0
+}
+    eos
+    File.write('seqconfig.txt', seq_config)
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_config", sequenceConfig="seqconfig.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_not be File.size('without_config.png')
+  end
+
+  it "should respect the width attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    Bob->>Claire: Hello Claire, how are you?
+    Claire->>Doug: Hello Doug, how are you?
+    eos
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_width", width="700"]
+mermaid::mermaid.txt["without_width"]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('with_width.png')).to be true
+    expect(File.exist?('without_width.png')).to be true
+    expect(File.size('with_width.png')).to_not be File.size('without_width.png')
+  end
+
+  it "should respect the theme attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    Bob->>Claire: Hello Claire, how are you?
+    Claire->>Doug: Hello Doug, how are you?
+    eos
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["default", format="svg"]
+mermaid::mermaid.txt["dark", format="svg", theme="dark"]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('default.svg')).to be true
+    expect(File.exist?('dark.svg')).to be true
+    expect(File.read('default.svg')).to_not be File.read('dark.svg')
+  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