asciidoctor-diagram 1.5.5 → 1.5.6

data/lib/asciidoctor-diagram/syntrax.rb

@@ -0,0 +1,8 @@
+require_relative 'extensions'
+
+Asciidoctor::Extensions.register do
+  require_relative 'syntrax/extension'
+
+  block Asciidoctor::Diagram::SyntraxBlockProcessor, :syntrax
+  block_macro Asciidoctor::Diagram::SyntraxBlockMacroProcessor, :syntrax
+end

data/lib/asciidoctor-diagram/syntrax/extension.rb

@@ -0,0 +1,54 @@
+require_relative '../extensions'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+require_relative '../util/which'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    module Syntrax
+      include CliGenerator
+      include Which
+
+      def self.included(mod)
+        [:png, :svg].each do |f|
+          mod.register_format(f, :image) do |parent, source|
+            syntrax(parent, source, f)
+          end
+        end
+      end
+
+      def syntrax(parent, source, format)
+        inherit_prefix = name
+
+        generate_file(which(parent, 'syntrax'), 'spec', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          args = [tool_path, '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)]
+
+          scale = source.attr('scale', nil, inherit_prefix)
+          if scale
+            args << '--scale' << scale
+          end
+
+          transparent = source.attr('transparent', nil, inherit_prefix)
+          if transparent == 'true'
+            args << '--transparent'
+          end
+          style = source.attr('style', nil, inherit_prefix)
+          if style
+            args << '--style' << style
+          end
+
+          args
+        end
+      end
+    end
+
+    class SyntraxBlockProcessor < Extensions::DiagramBlockProcessor
+      include Syntrax
+    end
+
+    class SyntraxBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      include Syntrax
+    end
+  end
+end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.5"
+    VERSION = "1.5.6"
   end
 end

data/spec/blockdiag_spec.rb

@@ -7,7 +7,7 @@ blockdiag {
 }
 eos
 
-describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor do
+describe Asciidoctor::Diagram::BlockDiagBlockMacroProcessor, :broken_on_appveyor do
   it "should generate PNG images when format is set to 'png'" do
     File.write('blockdiag.txt', code)
 
@@ -38,7 +38,7 @@ blockdiag::blockdiag.txt[format="png"]
   end
 end
 
-describe Asciidoctor::Diagram::BlockDiagBlockProcessor do
+describe Asciidoctor::Diagram::BlockDiagBlockProcessor, :broken_on_appveyor do
   it "should generate PNG images when format is set to 'png'" do
     doc = <<-eos
 = Hello, BlockDiag!

data/spec/msc_spec.rb

@@ -0,0 +1,230 @@
+require_relative 'test_helper'
+
+code = <<-eos
+# MSC for some fictional process
+msc {
+  hscale = "2";
+
+  a,b,c;
+
+  a->b [ label = "ab()" ] ;
+  b->c [ label = "bc(TRUE)"];
+  c=>c [ label = "process(1)" ];
+  c=>c [ label = "process(2)" ];
+  ...;
+  c=>c [ label = "process(n)" ];
+  c=>c [ label = "process(END)" ];
+  a<<=c [ label = "callback()"];
+  ---  [ label = "If more to run", ID="*" ];
+  a->a [ label = "next()"];
+  a->c [ label = "ac1()\nac2()"];
+  b<-c [ label = "cb(TRUE)"];
+  b->b [ label = "stalled(...)"];
+  a<-b [ label = "ab() = FALSE"];
+}
+eos
+
+describe Asciidoctor::Diagram::MscBlockMacroProcessor, :broken_on_windows do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('msc.txt', code)
+
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+msc::msc.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('msc.txt', code)
+
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+msc::msc.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::MscBlockProcessor, :broken_on_windows do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[msc, 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, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[msc, 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, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[msc, 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('msc.txt', code)
+
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+msc::msc.txt
+
+[msc, 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('msc.txt', code)
+
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+msc::msc.txt[]
+msc::msc.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('msc.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('msc.txt', code)
+
+    doc = <<-eos
+= Hello, Msc!
+Doc Writer <doc@example.com>
+
+== First Section
+
+msc::msc.txt["foobar"]
+msc::msc.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?('msc.png')).to be false
+  end
+end

data/spec/plantuml_spec.rb

@@ -73,7 +73,7 @@ plantuml::plantuml.txt[format="png"]
     expect(b.attributes['height']).to_not be_nil
   end
 
-  it 'should support substitutions' do
+  it 'should support substitutions in diagram code' do
     code = <<-eos
 class {parent-class}
 class {child-class}
@@ -102,7 +102,7 @@ plantuml::plantuml.txt[format="svg", subs=attributes+]
     target = b.attributes['target']
     expect(File.exist?(target)).to be true
 
-    content = File.read(target)
+    content = File.read(target, :encoding => Encoding::UTF_8)
     expect(content).to include('ParentClass')
     expect(content).to include('ChildClass')
   end
@@ -137,11 +137,45 @@ plantuml::{file}.txt[format="svg", subs=attributes+]
     target = b.attributes['target']
     expect(File.exist?(target)).to be true
 
-    content = File.read(target)
+    content = File.read(target, :encoding => Encoding::UTF_8)
     expect(content).to include('ParentClass')
     expect(content).to include('ChildClass')
   end
 
+  it 'should support substitutions in the format attribute' do
+    code = <<-eos
+class Parent
+class Child
+Parent <|-- Child
+    eos
+
+    File.write('plantuml.txt', code)
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+:file: plantuml
+:plantumlformat: png
+
+== First Section
+
+plantuml::{file}.txt[format="{plantumlformat}", subs=attributes+]
+    eos
+
+    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
+    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
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
   it 'should resolve !include directives with relative paths' do
     included = <<-eos
 interface List
@@ -166,12 +200,50 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-plantuml::dir/plantuml.txt[format="png", subs=attributes+]
+plantuml::dir/plantuml.txt[format="svg", subs=attributes+]
     eos
 
-    load_asciidoc doc, :attributes => {'backend' => 'html5'}
+    d = load_asciidoc doc, :attributes => {'backend' => 'html5'}
+
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exist?(target)).to be true
 
-    # No easy way to assert this since PlantUML doesn't produce an error on file not found
+    content = File.read(target, :encoding => Encoding::UTF_8)
+    expect(content).to_not include('!include')
+  end
+
+  it 'should generate blocks with figure captions' do
+    code = <<-eos
+User -> (Start)
+User --> (Use the application) : Label
+
+:Main Admin: ---> (Use the application) : Another label
+    eos
+
+    File.write('plantuml.txt', code)
+
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+.This is a UML diagram
+plantuml::plantuml.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.caption).to match /Figure \d+/
   end
 end
 
@@ -288,11 +360,12 @@ Doc Writer <doc@example.com>
     doc = <<-eos
 = Hello, PlantUML!
 Doc Writer <doc@example.com>
-:plantumlconfig: test.config
+:plantuml-config: test.config
+:plantuml-format: svg
 
 == First Section
 
-[plantuml, format="svg"]
+[plantuml]
 ----
 actor Foo1
 boundary Foo2
@@ -315,7 +388,7 @@ ArrowColor #DEADBE
     expect(target).to_not be_nil
     expect(File.exist?(target)).to be true
 
-    svg = File.read(target)
+    svg = File.read(target, :encoding => Encoding::UTF_8)
     expect(svg).to match(/<path.*fill="#DEADBE"/)
   end
 
@@ -510,6 +583,29 @@ User -> (Start)
     expect(b.attributes['height']).to be_nil
   end
 
+  it 'should generate blocks with figure captions' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+.Caption for my UML diagram
+[plantuml, format="png"]
+----
+User -> (Start)
+----
+    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.caption).to match /Figure \d+/
+  end
+
   it 'should support salt diagrams using salt block type' do
     doc = <<-eos
 = Hello, PlantUML!
@@ -683,7 +779,7 @@ List : void clear()
     eos
 
     Dir.mkdir('dir')
-    File.write('dir/list.iuml', included)
+    File.write('dir/List.iuml', included)
 
     creole_doc = <<-eos
 = Hello, PlantUML!
@@ -691,16 +787,25 @@ Doc Writer <doc@example.com>
 
 == First Section
 
-[plantuml, format="png"]
+[plantuml, format="svg"]
 ----
 !include dir/List.iuml
 List <|.. ArrayList
 ----
     eos
 
-    load_asciidoc creole_doc, :attributes => {'backend' => 'html5'}
+    d = load_asciidoc creole_doc, :attributes => {'backend' => 'html5'}
+
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exist?(target)).to be true
 
-    # No easy way to assert this since PlantUML doesn't produce an error on file not found
+    content = File.read(target, :encoding => Encoding::UTF_8)
+    expect(content).to_not include('!include')
   end
 
   it 'should support substitutions' do
@@ -726,7 +831,7 @@ class {child-class}
     target = b.attributes['target']
     expect(File.exist?(target)).to be true
 
-    content = File.read(target)
+    content = File.read(target, :encoding => Encoding::UTF_8)
     expect(content).to include('ParentClass')
     expect(content).to include('ChildClass')
   end