asciidoctor-diagram 1.5.18 → 2.0.3

data/spec/bytefield_spec.rb

@@ -0,0 +1,230 @@
+require_relative 'test_helper'
+
+code = <<-eos
+;; This the source for the sample diagram illustrated in the project Read Me.
+
+;; Some nice default background colors, used to distinguish header sections.
+(defattrs :bg-green {:fill "#a0ffa0"})
+(defattrs :bg-yellow {:fill "#ffffa0"})
+(defattrs :bg-pink {:fill "#ffb0a0"})
+(defattrs :bg-cyan {:fill "#a0fafa"})
+(defattrs :bg-purple {:fill "#e4b5f7"})
+
+(defn draw-group-label-header
+  "Creates a small borderless box used to draw the textual label headers
+  used below the byte labels for remotedb message diagrams.
+  Arguments are the number of colums to span and the text of the
+  label."
+  [span label]
+  (draw-box (text label [:math {:font-size 12}]) {:span    span
+                                                  :borders \#{}
+                                                  :height  14}))
+
+(defn draw-remotedb-header
+  "Generates the byte and field labels and standard header fields of a
+  request or response message for the remotedb database server with
+  the specified kind and args values."
+  [kind args]
+  (draw-column-headers)
+  (draw-group-label-header 5 "start")
+  (draw-group-label-header 5 "TxID")
+  (draw-group-label-header 3 "type")
+  (draw-group-label-header 2 "args")
+  (draw-group-label-header 1 "tags")
+  (next-row 18)
+
+  (draw-box 0x11 :bg-green)
+  (draw-box 0x872349ae [{:span 4} :bg-green])
+  (draw-box 0x11 :bg-yellow)
+  (draw-box (text "TxID" :math) [{:span 4} :bg-yellow])
+  (draw-box 0x10 :bg-pink)
+  (draw-box (hex-text kind 4 :bold) [{:span 2} :bg-pink])
+  (draw-box 0x0f :bg-cyan)
+  (draw-box (hex-text args 2 :bold) :bg-cyan)
+  (draw-box 0x14 :bg-purple)
+
+  (draw-box (text "0000000c" :hex [[:plain {:font-weight "light" :font-size 16}] " (12)"])
+            [{:span 4} :bg-purple])
+  (draw-box (hex-text 6 2 :bold) [:box-first :bg-purple])
+  (doseq [val [6 6 3 6 6 6 6 3]]
+    (draw-box (hex-text val 2 :bold) [:box-related :bg-purple]))
+  (doseq [val [0 0]]
+    (draw-box val [:box-related :bg-purple]))
+  (draw-box 0 [:box-last :bg-purple]))
+
+;; Figure 48: Cue point response message.
+
+(draw-remotedb-header 0x4702 9)
+
+(draw-box 0x11)
+(draw-box 0x2104 {:span 4})
+(draw-box 0x11)
+(draw-box 0 {:span 4})
+(draw-box 0x11)
+(draw-box (text "length" [:math] [:sub 1]) {:span 4})
+(draw-box 0x14)
+
+(draw-box (text "length" [:math] [:sub 1]) {:span 4})
+(draw-gap "Cue and loop point bytes")
+
+(draw-box nil :box-below)
+(draw-box 0x11)
+(draw-box 0x36 {:span 4})
+(draw-box 0x11)
+(draw-box (text "num" [:math] [:sub "hot"]) {:span 4})
+(draw-box 0x11)
+(draw-box (text "num" [:math] [:sub "cue"]) {:span 4})
+
+(draw-box 0x11)
+(draw-box (text "length" [:math] [:sub 2]) {:span 4})
+(draw-box 0x14)
+(draw-box (text "length" [:math] [:sub 2]) {:span 4})
+(draw-gap "Unknown bytes" {:min-label-columns 6})
+(draw-bottom)
+eos
+
+describe Asciidoctor::Diagram::BytefieldBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('bytefield.txt', code)
+
+    doc = <<-eos
+= Hello, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+bytefield::bytefield.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::BytefieldBlockProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[bytefield, 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, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[bytefield, 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('bytefield.txt', code)
+
+    doc = <<-eos
+= Hello, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+bytefield::bytefield.txt
+
+[bytefield, 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('bytefield.txt', code)
+
+    doc = <<-eos
+= Hello, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+bytefield::bytefield.txt[]
+bytefield::bytefield.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('bytefield.svg')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('bytefield.txt', code)
+
+    doc = <<-eos
+= Hello, Bytefield!
+Doc Writer <doc@example.com>
+
+== First Section
+
+bytefield::bytefield.txt["foobar"]
+bytefield::bytefield.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?('bytefield.svg')).to be false
+  end
+end

data/spec/ditaa_spec.rb

@@ -253,4 +253,36 @@ 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, Ditaa!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[ditaa,format="svg"]
+----
+This should cause a bug.
+
+// TODO:
+// - don't make bugs
+// - oops I wrote a comment here
+
+    +--------+   +-------+    +-------+
+    |        | --+ ditaa +--> |       |
+    |  Text  |   +-------+    |diagram|
+    |Document|   |!magic!|    |       |
+    |     {d}|   |       |    |       |
+    +---+----+   +-------+    +-------+
+        :                         ^
+        |       Lots of work      |
+        +-------------------------+
+----
+    eos
+
+    expect {
+      load_asciidoc doc
+    }.to raise_error(/Cannot follow cell/i)
+  end
 end

data/spec/dpic_spec.rb

@@ -0,0 +1,74 @@
+require_relative 'test_helper'
+
+code = <<-eos
+  arrow "$u$" above
+S: circle rad 10/72.27  # 10 pt
+  line right 0.35
+G: box "$G(s)$"
+  arrow "$y$" above
+  line -> down G.ht from last arrow then left last arrow.c.x-S.x then to S.s
+  "$-\;$" below rjust
+eos
+
+describe Asciidoctor::Diagram::DpicBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('dpic.txt', code)
+
+    doc = <<-eos
+= Hello, Dpic!
+Doc Writer <doc@example.com>
+
+== First Section
+
+dpic::dpic.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::DpicBlockProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Dpic!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[dpic, 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/gnuplot_spec.rb

@@ -0,0 +1,478 @@
+require_relative 'test_helper'
+
+code = <<-eos
+plot [0:5][0:20] x**2 title 'O(n^2)'
+eos
+
+describe Asciidoctor::Diagram::GnuplotBlockMacroProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.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('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.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
+
+  it "should generate GIF images when format is set to 'gif'" do
+    File.write('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.txt[format="gif"]
+    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
+
+
+  it "should generate literal blocks when format is set to 'txt'" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="txt"]
+----
+#{code}
+----
+    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
+
+
+end
+
+describe Asciidoctor::Diagram::GnuplotBlockProcessor do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, 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, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, 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, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, 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('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.txt
+
+[gnuplot, 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('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.txt[]
+gnuplot::gnuplot.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('gnuplot.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('gnuplot.txt', code)
+
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+gnuplot::gnuplot.txt["foobar"]
+gnuplot::gnuplot.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?('gnuplot.png')).to be false
+  end
+  it "should generate images with user defined size" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png",width="800", height="600"]
+----
+#{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 nocrop/notrasparent images" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", crop=false, transparent=false]
+----
+#{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 crop/trasparent images" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", crop=true, transparent=true]
+----
+#{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 image with font name" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", font="Arial"]
+----
+#{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 image with font name and size" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", font="Arial,11"]
+----
+#{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 image with font name and scale" do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", font="Arial", scale="0.5"]
+----
+#{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 image with font background="red") do
+    doc = <<-eos
+= Hello, Gnuplot!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[gnuplot, format="png", background="red"]
+----
+#{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
+
+
+end