asciidoctor-diagram 2.1.2 → 2.2.0

data/spec/blockdiag_spec.rb

@@ -7,6 +7,10 @@ blockdiag {
 }
 eos
 
+describe Asciidoctor::Diagram::BlockDiagInlineMacroProcessor do
+  include_examples "inline_macro", :blockdiag, BLOCKDIAG_CODE, [:png, :svg, :pdf]
+end
+
 describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor do
   include_examples "block_macro", :blockdiag, BLOCKDIAG_CODE, [:png, :svg, :pdf]
 end

data/spec/bpmn_spec.rb

@@ -47,6 +47,10 @@ BPNM_CODE = <<EOF
 </bpmn:definitions>
 EOF
 
+describe Asciidoctor::Diagram::BpmnInlineMacroProcessor do
+  include_examples "inline_macro", :bpmn, BPNM_CODE, [:png, :svg, :pdf]
+end
+
 describe Asciidoctor::Diagram::BpmnBlockMacroProcessor do
   include_examples "block_macro", :bpmn, BPNM_CODE, [:png, :svg, :pdf]
 end

data/spec/bytefield_spec.rb

@@ -83,6 +83,10 @@ BYTEFIELD_CODE = <<-eos
 (draw-bottom)
 eos
 
+describe Asciidoctor::Diagram::BytefieldInlineMacroProcessor do
+  include_examples "inline_macro", :bytefield, BYTEFIELD_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::BytefieldBlockMacroProcessor do
   include_examples "block_macro", :bytefield, BYTEFIELD_CODE, [:svg]
 end

data/spec/diagrams_spec.rb

@@ -14,6 +14,10 @@ with Diagram("Grouped Workers", show=False, direction="TB"):
                   EC2("worker5")] >> RDS("events")
 eos
 
+describe Asciidoctor::Diagram::DiagramsInlineMacroProcessor do
+  include_examples "inline_macro", :diagrams, DIAGRAMS_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::DiagramsBlockMacroProcessor do
   include_examples "block_macro", :diagrams, DIAGRAMS_CODE, [:png, :svg]
 end

data/spec/ditaa_spec.rb

@@ -12,6 +12,10 @@ DITAA_CODE = <<-eos
     +-------------------------+
 eos
 
+describe Asciidoctor::Diagram::DitaaInlineMacroProcessor do
+  include_examples "inline_macro", :ditaa, DITAA_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::DitaaBlockMacroProcessor do
   include_examples "block_macro", :ditaa, DITAA_CODE, [:png, :svg]
 end

data/spec/dpic_spec.rb

@@ -10,6 +10,10 @@ G: box "$G(s)$"
   "$-\;$" below rjust
 eos
 
+describe Asciidoctor::Diagram::DpicInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :dpic, DPIC_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::DpicBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :dpic, DPIC_CODE, [:svg]
 end

data/spec/erd_spec.rb

@@ -83,6 +83,10 @@ play        1--* play_player
 player      1--* play_player
 eos
 
+describe Asciidoctor::Diagram::ErdInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :erd, ERD_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::ErdBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :erd, ERD_CODE, [:png, :svg]
 end

data/spec/gnuplot_spec.rb

@@ -4,6 +4,10 @@ GNUPLOT_CODE = <<-eos
 plot [0:5][0:20] x**2 title 'O(n^2)'
 eos
 
+describe Asciidoctor::Diagram::GnuplotInlineMacroProcessor do
+  include_examples "inline_macro", :gnuplot, GNUPLOT_CODE, [:png, :svg, :gif]
+end
+
 describe Asciidoctor::Diagram::GnuplotBlockMacroProcessor do
   include_examples "block_macro", :gnuplot, GNUPLOT_CODE, [:png, :svg, :gif, :txt]
 end

data/spec/graphviz_spec.rb

@@ -11,6 +11,10 @@ digraph foo {
 }
 eos
 
+describe Asciidoctor::Diagram::GraphvizInlineMacroProcessor do
+  include_examples "inline_macro", :graphviz, DOT_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::GraphvizBlockMacroProcessor do
   include_examples "block_macro", :graphviz, DOT_CODE, [:png, :svg]
 end

data/spec/lilypond_spec.rb

@@ -4,6 +4,10 @@ LILYPOND_CODE = <<-eos
 \\relative c' { f d f a d f e d cis a cis e a g f e }
 eos
 
+describe Asciidoctor::Diagram::LilypondInlineMacroProcessor do
+  include_examples "inline_macro", :lilypond, LILYPOND_CODE, [:png]
+end
+
 describe Asciidoctor::Diagram::LilypondBlockMacroProcessor do
   include_examples "block_macro", :lilypond, LILYPOND_CODE, [:png]
 end

data/spec/mermaid_spec.rb

@@ -8,6 +8,10 @@ graph LR
     C --> D
 eos
 
+describe Asciidoctor::Diagram::MermaidInlineMacroProcessor do
+  include_examples "inline_macro", :mermaid, MERMAID_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::MermaidBlockMacroProcessor do
   include_examples "block_macro", :mermaid, MERMAID_CODE, [:png, :svg]
 

data/spec/msc_spec.rb

@@ -24,6 +24,10 @@ msc {
 }
 eos
 
+describe Asciidoctor::Diagram::MscInlineMacroProcessor do
+  include_examples "inline_macro", :msc, MSC_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::MscBlockMacroProcessor do
   include_examples "block_macro", :msc, MSC_CODE, [:png, :svg]
 end

data/spec/nomnoml_spec.rb

@@ -23,6 +23,10 @@ NOMNOML_CODE = <<-eos
 [<actor>Sailor] - [<usecase>shiver me;timbers]
 eos
 
+describe Asciidoctor::Diagram::NomnomlInlineMacroProcessor do
+  include_examples "inline_macro", :nomnoml, NOMNOML_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::NomnomlBlockMacroProcessor do
   include_examples "block_macro", :nomnoml, NOMNOML_CODE, [:svg]
 end

data/spec/pikchr_spec.rb

@@ -42,6 +42,10 @@ 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::PikchrInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :pikchr, PIKCHR_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::PikchrBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :pikchr, PIKCHR_CODE, [:svg]
 end

data/spec/plantuml_spec.rb

@@ -7,6 +7,10 @@ User --> (Use the application) : Label
 :Main Admin: ---> (Use the application) : Another label
 eos
 
+describe Asciidoctor::Diagram::PlantUmlInlineMacroProcessor do
+  include_examples "inline_macro", :plantuml, PLANTUML_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::PlantUmlBlockMacroProcessor do
   include_examples "block_macro", :plantuml, PLANTUML_CODE, [:png, :svg, :txt]
 
@@ -190,6 +194,29 @@ Doc Writer <doc@example.com>
     expect(b.attributes['height']).to_not be_nil
   end
 
+  it "should handle syntax errors gracefully" do
+    doc = <<-eos
+[plantuml]
+----
+@startuml
+xxx
+@enduml
+----
+    eos
+
+    options = {}
+    options[:attributes] = {}
+    options[:attributes]['diagram-on-error'] = 'log'
+
+    d = load_asciidoc doc, options
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :listing }
+    expect(b).to_not be_nil
+
+    expect(b.source).to include 'Failed to generate image'
+  end
+
   it 'should use plantuml configuration when specified as a document attribute' do
     doc = <<-eos
 = Hello, PlantUML!
@@ -650,7 +677,9 @@ Container(spa, "SPA", "angular", "The main interface that the customer interacts
 Container(api, "API", "java", "Handles all business logic", "java")
 ContainerDb(db, "Database", "Microsoft SQL", "Holds product, order and invoice information", "msql_server")
 
-Rel(user, spa, "Uses", "https")
+!$protocol ?= "https"
+
+Rel(user, spa, "Uses", $protocol)
 Rel(spa, api, "Uses", "https")
 Rel_R(api, db, "Reads/Writes")
 @enduml

data/spec/shaape_spec.rb

@@ -7,6 +7,10 @@ SHAAPE_CODE = <<-eos
              \/
 eos
 
+describe Asciidoctor::Diagram::ShaapeInlineMacroProcessor, :broken_on_osx, :broken_on_github, :broken_on_windows do
+  include_examples "inline_macro", :shaape, SHAAPE_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::ShaapeBlockMacroProcessor, :broken_on_osx, :broken_on_github, :broken_on_windows do
   include_examples "block_macro", :shaape, SHAAPE_CODE, [:png, :svg]
 end

data/spec/shared_examples.rb

@@ -195,6 +195,167 @@ Doc Writer <doc@example.com>
   end
 end
 
+RSpec.shared_examples "inline_macro" do |name, code, formats|
+  formats.each do |format|
+    it "#{name} should generate image tags when format is set to '#{format}'" do
+      File.write("#{name}.txt", code)
+
+      doc = <<-eos
+= Hello, #{name}!
+Doc Writer <doc@example.com>
+
+== First Section
+
+#{name}:#{name}.txt[#{format}]
+      eos
+
+      d = load_asciidoc doc
+      expect(d).to_not be_nil
+
+      b = d.find { |bl| bl.context == :paragraph }
+      expect(b).to_not be_nil
+
+      output = b.convert
+      img_match = /<img[^>]*>/.match(output)
+      expect(img_match).to_not be_nil
+      img = img_match.to_s
+
+      src_match = /src="([^"]*)"/.match(img)
+      expect(src_match).to_not be_nil
+      src = src_match[1]
+
+      expect(src).to_not be_nil
+      expect(src).to match(/\.#{format}$/)
+      expect(File.exist?(src)).to be true
+
+      unless format == :pdf
+        expect(/width="([^"]*)"/.match(img)).to_not be_nil
+        expect(/height="([^"]*)"/.match(img)).to_not be_nil
+      end
+    end
+  end
+
+  it 'should support substitutions in the target attribute' do
+    File.write("#{name}.txt", code)
+
+    doc = <<-eos
+= Hello, #{name}!
+Doc Writer <doc@example.com>
+:file: #{name}
+
+== First Section
+
+#{name}:{file}.txt[subs=attributes+]
+    eos
+
+    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :paragraph }
+    expect(b).to_not be_nil
+
+    output = b.convert
+    img_match = /<img[^>]*>/.match(output)
+    expect(img_match).to_not be_nil
+    img = img_match.to_s
+
+    src_match = /src="([^"]*)"/.match(img)
+    expect(src_match).to_not be_nil
+    src = src_match[1]
+
+    expect(src).to_not be_nil
+    expect(src).to match(/\.#{formats[0]}$/)
+    expect(File.exist?(src)).to be true
+  end
+
+  it 'should support substitutions in the format attribute' do
+    File.write("#{name}.txt", code)
+
+    doc = <<-eos
+= Hello, #{name}!
+Doc Writer <doc@example.com>
+:file: #{name}
+:outputformat: #{formats[0]}
+
+== First Section
+
+#{name}:{file}.txt[format="{outputformat}", subs=attributes+]
+    eos
+
+    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :paragraph }
+    expect(b).to_not be_nil
+
+    output = b.convert
+    img_match = /<img[^>]*>/.match(output)
+    expect(img_match).to_not be_nil
+    img = img_match.to_s
+
+    src_match = /src="([^"]*)"/.match(img)
+    expect(src_match).to_not be_nil
+    src = src_match[1]
+
+    expect(src).to_not be_nil
+    expect(src).to match(/\.#{formats[0]}$/)
+    expect(File.exist?(src)).to be true
+
+    unless formats[0] == :pdf
+      expect(/width="([^"]*)"/.match(img)).to_not be_nil
+      expect(/height="([^"]*)"/.match(img)).to_not be_nil
+    end
+  end
+
+  it 'should respect target attribute in inline macros' do
+    File.write("#{name}.txt", code)
+
+    doc = <<-eos
+= Hello, #{name}!
+Doc Writer <doc@example.com>
+
+== First Section
+
+#{name}:#{name}.txt[target="foobar"]
+#{name}:#{name}.txt[target="foobaz"]
+    eos
+
+    d = load_asciidoc doc
+
+    b = d.find { |bl| bl.context == :paragraph }
+    expect(b).to_not be_nil
+    b.convert
+
+    expect(File.exist?("foobar.#{formats[0]}")).to be true
+    expect(File.exist?("foobaz.#{formats[0]}")).to be true
+    expect(File.exist?("#{name}.#{formats[0]}")).to be false
+  end
+
+  it 'should respect target attribute values with relative paths in inline macros' do
+    File.write("#{name}.txt", code)
+
+    doc = <<-eos
+= Hello, #{name}!
+Doc Writer <doc@example.com>
+
+== First Section
+
+#{name}:#{name}.txt[target="test/foobar"]
+#{name}:#{name}.txt[target="test2/foobaz"]
+    eos
+
+    d = load_asciidoc doc
+
+    b = d.find { |bl| bl.context == :paragraph }
+    expect(b).to_not be_nil
+    b.convert
+
+    expect(File.exist?("test/foobar.#{formats[0]}")).to be true
+    expect(File.exist?("test2/foobaz.#{formats[0]}")).to be true
+    expect(File.exist?("#{name}.#{formats[0]}")).to be false
+  end
+end
+
 RSpec.shared_examples "block" do |name, code, formats|
   formats.each do |format|
     if format == :txt

data/spec/smcat_spec.rb

@@ -17,6 +17,10 @@ testing      => "on backlog" : test not ok;
 testing      => final        : test ok;
 eos
 
+describe Asciidoctor::Diagram::SmcatInlineMacroProcessor do
+  include_examples "inline_macro", :smcat, SMCAT_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::SmcatBlockMacroProcessor do
   include_examples "block_macro", :smcat, SMCAT_CODE, [:svg]
 end

data/spec/svgbob_spec.rb

@@ -20,6 +20,10 @@ SVGBOB_CODE = <<-eos
                                       '---------------------------------------'
 eos
 
+describe Asciidoctor::Diagram::SvgBobInlineMacroProcessor do
+  include_examples "inline_macro", :svgbob, SVGBOB_CODE, [:svg]
+end
+
 describe Asciidoctor::Diagram::SvgBobBlockMacroProcessor do
   include_examples "block_macro", :svgbob, SVGBOB_CODE, [:svg]
 end

data/spec/symbolator_spec.rb

@@ -14,6 +14,10 @@ package demo is
 end package;
 eos
 
+describe Asciidoctor::Diagram::SymbolatorInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :symbolator, SYMBOLATOR_CODE, [:png, :svg, :pdf]
+end
+
 describe Asciidoctor::Diagram::SymbolatorBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :symbolator, SYMBOLATOR_CODE, [:png, :svg, :pdf]
 end

data/spec/syntrax_spec.rb

@@ -9,6 +9,10 @@ indentstack(10,
 )
 eos
 
+describe Asciidoctor::Diagram::SyntraxInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :syntrax, SYNTRAX_CODE, [:png, :svg]
+end
+
 describe Asciidoctor::Diagram::SyntraxBlockMacroProcessor, :broken_on_windows do
   include_examples "block_macro", :syntrax, SYNTRAX_CODE, [:png, :svg]
 end