asciidoctor-diagram 1.2.0 → 2.0.0

data/spec/shaape_spec.rb

@@ -1,6 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::ShaapeBlockMacro do
+describe Asciidoctor::Diagram::ShaapeBlockMacroProcessor, :broken_on_osx, :broken_on_appveyor do
   it "should generate PNG images when format is set to 'png'" do
     code = <<-eos
     +--------+    +-------------+
@@ -22,25 +22,25 @@ Doc Writer <doc@example.com>
 shaape::shaape.txt[format="png"]
     eos
 
-    d = Asciidoctor.load StringIO.new(doc)
+    d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    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.exists?(target)).to be true
+    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::ShaapeBlock do
+describe Asciidoctor::Diagram::ShaapeBlockProcessor, :broken_on_osx, :broken_on_appveyor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, Shaape!
@@ -59,18 +59,18 @@ Doc Writer <doc@example.com>
 ----
     eos
 
-    d = Asciidoctor.load StringIO.new(doc)
+    d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    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.exists?(target)).to be true
+    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
@@ -94,18 +94,18 @@ Doc Writer <doc@example.com>
 ----
     eos
 
-    d = Asciidoctor.load StringIO.new(doc)
+    d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    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.exists?(target)).to be true
+    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
@@ -123,7 +123,7 @@ Doc Writer <doc@example.com>
 ----
     eos
 
-    expect { Asciidoctor.load StringIO.new(doc) }.to raise_error /support.*format/i
+    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
   end
 
   it "should not regenerate images when source has not changed" do
@@ -157,14 +157,15 @@ shaape::shaape.txt
 ----
     eos
 
-    d = Asciidoctor.load StringIO.new(doc)
-    b = d.find { |b| b.context == :image }
+    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 = Asciidoctor.load StringIO.new(doc)
+    d = load_asciidoc doc
 
     mtime2 = File.mtime(target)
 
@@ -193,8 +194,8 @@ shaape::shaape.txt[]
 shaape::shaape.txt[]
     eos
 
-    Asciidoctor.load StringIO.new(doc)
-    expect(File.exists?('shaape.png')).to be true
+    load_asciidoc doc
+    expect(File.exist?('shaape.png')).to be true
   end
 
   it "should respect target attribute in block macros" do
@@ -219,9 +220,9 @@ shaape::shaape.txt["foobar"]
 shaape::shaape.txt["foobaz"]
     eos
 
-    Asciidoctor.load StringIO.new(doc)
-    expect(File.exists?('foobar.png')).to be true
-    expect(File.exists?('foobaz.png')).to be true
-    expect(File.exists?('shaape.png')).to be false
+    load_asciidoc doc
+    expect(File.exist?('foobar.png')).to be true
+    expect(File.exist?('foobaz.png')).to be true
+    expect(File.exist?('shaape.png')).to be false
   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

data/spec/svgbob_spec.rb

@@ -0,0 +1,167 @@
+require_relative 'test_helper'
+
+code = <<-eos
+                      .--.            .---.  .---. .---.  .---.    .---.  .---. 
+                      |  |   OS API   '---'  '---' '---'  '---'    '---'  '---' 
+                      v  |              |      |     |      |        |      |   
+             .-. .-. .-. |              v      v     |      v        |      v   
+         .-->'-' '-' '-' |            .------------. | .-----------. |  .-----. 
+         |     \\  |  /   |            | Filesystem | | | Scheduler | |  | MMU | 
+         |      v . v    |            '------------' | '-----------' |  '-----' 
+         '_______/ \\_____|                   |       |      |        |          
+                 \\ /                         v       |      |        v          
+                  |     ____              .----.     |      |    .---------.    
+                  '--> /___/              | IO |<----'      |    | Network |    
+                                          '----'            |    '---------'    
+                                             |              |         |         
+                                             v              v         v         
+                                      .---------------------------------------. 
+                                      |                  HAL                  | 
+                                      '---------------------------------------'
+eos
+
+describe Asciidoctor::Diagram::SvgBobBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('svgbob.txt', code)
+
+    doc = <<-eos
+= Hello, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+svgbob::svgbob.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::SvgBobBlockProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[svgbob, 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, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[svgbob, 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('svgbob.txt', code)
+
+    doc = <<-eos
+= Hello, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+svgbob::svgbob.txt
+
+[svgbob]
+----
+#{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('svgbob.txt', code)
+
+    doc = <<-eos
+= Hello, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+svgbob::svgbob.txt[]
+svgbob::svgbob.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('svgbob.svg')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('svgbob.txt', code)
+
+    doc = <<-eos
+= Hello, SvgBob!
+Doc Writer <doc@example.com>
+
+== First Section
+
+svgbob::svgbob.txt["foobar"]
+svgbob::svgbob.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?('svgbob.svg')).to be false
+  end
+end

data/spec/syntrax_spec.rb

@@ -0,0 +1,228 @@
+require_relative 'test_helper'
+
+describe Asciidoctor::Diagram::SyntraxBlockMacroProcessor, :broken_on_appveyor do
+  it "should generate PNG images when format is set to 'png'" do
+    code = <<-eos
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+    eos
+
+    File.write('syntrax.txt', code)
+
+    doc = <<-eos
+= Hello, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+syntrax::syntrax.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::SyntraxBlockProcessor, :broken_on_appveyor do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[syntrax, format="png"]
+----
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+----
+    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, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[syntrax, format="svg"]
+----
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+----
+    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, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[syntrax, 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
+    code = <<-eos
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+    eos
+
+    File.write('syntrax.txt', code)
+
+    doc = <<-eos
+= Hello, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+syntrax::syntrax.txt
+
+[syntrax, format="png"]
+----
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+----
+    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
+    code = <<-eos
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+    eos
+
+    File.write('syntrax.txt', code)
+
+    doc = <<-eos
+= Hello, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+syntrax::syntrax.txt[]
+syntrax::syntrax.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('syntrax.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    code = <<-eos
+indentstack(10,
+  line(opt('-'), choice('0', line('1-9', loop(None, '0-9'))),
+    opt('.', loop('0-9', None))),
+
+  line(opt(choice('e', 'E'), choice(None, '+', '-'), loop('0-9', None)))
+)
+    eos
+
+    File.write('syntrax.txt', code)
+
+    doc = <<-eos
+= Hello, Syntrax!
+Doc Writer <doc@example.com>
+
+== First Section
+
+syntrax::syntrax.txt["foobar"]
+syntrax::syntrax.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?('syntrax.png')).to be false
+  end
+end