asciidoctor-diagram 2.0.0 → 2.1.0

data/spec/bpmn_spec.rb

@@ -1,96 +1,56 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::BpmnBlockMacroProcessor do
-  it "should generate SVG images when format is set to 'svg'" do
-    FileUtils.cp(
-        File.expand_path('bpmn-example.xml', File.dirname(__FILE__)),
-        File.expand_path('bpmn-example.xml', Dir.getwd)
-    )
-
-    doc = <<-eos
-= Hello, BPMN!
-Doc Writer <doc@example.com>
-
-== First Section
-
-bpmn::bpmn-example.xml[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 PNG images when format is set to 'png'" do
-    FileUtils.cp(
-        File.expand_path('bpmn-example.xml', File.dirname(__FILE__)),
-        File.expand_path('bpmn-example.xml', Dir.getwd)
-    )
-
-    doc = <<-eos
-= Hello, BPMN!
-Doc Writer <doc@example.com>
-
-== First Section
-
-bpmn::bpmn-example.xml[format="png"]
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
+code = <<EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_0zt4mn9" targetNamespace="http://bpmn.io/schema/bpmn" exporter="bpmn-js (https://demo.bpmn.io)" exporterVersion="5.1.2">
+  <bpmn:process id="Process_081h9u7" isExecutable="false">
+    <bpmn:startEvent id="StartEvent_00w25dz" name="Start">
+      <bpmn:outgoing>SequenceFlow_11u0n1f</bpmn:outgoing>
+    </bpmn:startEvent>
+    <bpmn:task id="Task_0yx8j7s" name="Task">
+      <bpmn:incoming>SequenceFlow_11u0n1f</bpmn:incoming>
+      <bpmn:outgoing>SequenceFlow_104th5x</bpmn:outgoing>
+    </bpmn:task>
+    <bpmn:sequenceFlow id="SequenceFlow_11u0n1f" sourceRef="StartEvent_00w25dz" targetRef="Task_0yx8j7s" />
+    <bpmn:endEvent id="EndEvent_0jxehtp" name="End">
+      <bpmn:incoming>SequenceFlow_104th5x</bpmn:incoming>
+    </bpmn:endEvent>
+    <bpmn:sequenceFlow id="SequenceFlow_104th5x" sourceRef="Task_0yx8j7s" targetRef="EndEvent_0jxehtp" />
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_081h9u7">
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_00w25dz">
+        <dc:Bounds x="156" y="81" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="162" y="124" width="24" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Task_0yx8j7s_di" bpmnElement="Task_0yx8j7s">
+        <dc:Bounds x="250" y="59" width="100" height="80" />
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="SequenceFlow_11u0n1f_di" bpmnElement="SequenceFlow_11u0n1f">
+        <di:waypoint x="192" y="99" />
+        <di:waypoint x="250" y="99" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="EndEvent_0jxehtp_di" bpmnElement="EndEvent_0jxehtp">
+        <dc:Bounds x="412" y="81" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="420" y="124" width="20" height="14" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNEdge id="SequenceFlow_104th5x_di" bpmnElement="SequenceFlow_104th5x">
+        <di:waypoint x="350" y="99" />
+        <di:waypoint x="412" y="99" />
+      </bpmndi:BPMNEdge>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>
+EOF
 
-    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 PDF images when format is set to 'pdf'" do
-    FileUtils.cp(
-        File.expand_path('bpmn-example.xml', File.dirname(__FILE__)),
-        File.expand_path('bpmn-example.xml', Dir.getwd)
-    )
-
-    doc = <<-eos
-= Hello, BPMN!
-Doc Writer <doc@example.com>
-
-== First Section
-
-bpmn::bpmn-example.xml[format="pdf"]
-    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(/\.pdf$/)
-    expect(File.exist?(target)).to be true
-  end
+describe Asciidoctor::Diagram::BpmnBlockMacroProcessor do
+  include_examples "block_macro", :bpmn, code, [:png, :svg, :pdf]
 end
+
+describe Asciidoctor::Diagram::BpmnBlockProcessor do
+  include_examples "block", :bpmn, code, [:png, :svg, :pdf]
+end

data/spec/bytefield_spec.rb

@@ -0,0 +1,92 @@
+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_windows do
+  include_examples "block_macro", :bytefield, code, [:svg]
+end
+
+describe Asciidoctor::Diagram::BytefieldBlockProcessor, :broken_on_windows do
+  include_examples "block", :bytefield, code, [:svg]
+end

data/spec/ditaa_spec.rb

@@ -1,8 +1,6 @@
 require_relative 'test_helper'
 
-describe Asciidoctor::Diagram::DitaaBlockMacroProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    code = <<-eos
+code = <<-eos
 +--------+   +-------+    +-------+
 |        | --+ ditaa +--> |       |
 |  Text  |   +-------+    |diagram|
@@ -12,150 +10,14 @@ describe Asciidoctor::Diagram::DitaaBlockMacroProcessor do
     :                         ^
     |       Lots of work      |
     +-------------------------+
-    eos
-
-    File.write('ditaa.txt', code)
-
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
+eos
 
-ditaa::ditaa.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::DitaaBlockMacroProcessor do
+  include_examples "block_macro", :ditaa, code, [:png, :svg]
 end
 
 describe Asciidoctor::Diagram::DitaaBlockProcessor do
-  it "should generate PNG images when format is set to 'png'" do
-    doc = <<-eos
-= Hello, ditaa!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[ditaa, format="png"]
-----
-+--------+   +-------+    +-------+
-|        | --+ ditaa +--> |       |
-|  Text  |   +-------+    |diagram|
-|Document|   |!magic!|    |       |
-|     {d}|   |       |    |       |
-+---+----+   +-------+    +-------+
-    :                         ^
-    |       Lots of work      |
-    +-------------------------+
-----
-    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, ditaa!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[ditaa, format="svg"]
-----
-+--------+   +-------+    +-------+
-|        | --+ ditaa +--> |       |
-|  Text  |   +-------+    |diagram|
-|Document|   |!magic!|    |       |
-|     {d}|   |       |    |       |
-+---+----+   +-------+    +-------+
-    :                         ^
-    |       Lots of work      |
-    +-------------------------+
-----
-    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, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[ditaa, format="foobar"]
-----
-----
-    eos
-
-    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
-  end
-
-  it "should use a default format when none was given" do
-    doc = <<-eos
-= Hello, PlantUML!
-Doc Writer <doc@example.com>
-
-== First Section
-
-[ditaa]
-----
-----
-    eos
-
-    d = load_asciidoc doc
-    expect(d).to_not be_nil
-
-    b = d.find { |bl| bl.context == :image }
-    expect(b).to_not be_nil
-    target = b.attributes['target']
-    expect(target).to match(/\.png$/)
-    expect(File.exist?(target)).to be true
-  end
+  include_examples "block", :ditaa, code, [:png, :svg]
 
   it "should support ditaa options as attributes" do
     doc = <<-eos
@@ -253,4 +115,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(/Ambiguous input/i)
+  end
 end

data/spec/dpic_spec.rb

@@ -0,0 +1,19 @@
+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_windows do
+  include_examples "block_macro", :dpic, code, [:svg]
+end
+
+describe Asciidoctor::Diagram::DpicBlockProcessor, :broken_on_windows do
+  include_examples "block", :dpic, code, [:svg]
+end