asciidoctor-diagram 2.2.7 → 2.2.9

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

@@ -9,6 +9,21 @@ module Asciidoctor
       include DiagramConverter
       include CliGenerator
 
+      CLASSPATH_ENV = 'DIAGRAM_JSYNTRAX_CLASSPATH'
+      CLI_HOME_ENV = 'DIAGRAM_JSYNTRAX_HOME'
+      JSYNTRAX_JARS = if ENV.has_key?(CLASSPATH_ENV)
+                           ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
+                         elsif ENV.has_key?(CLI_HOME_ENV)
+                           lib_dir = File.expand_path('lib', ENV[CLI_HOME_ENV])
+                           Dir.children(lib_dir).select { |c| c.end_with? '.jar' }.map { |c| File.expand_path(c, lib_dir) }
+                         else
+                           nil
+                         end
+
+      if JSYNTRAX_JARS
+        Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')]
+        Java.classpath.concat JSYNTRAX_JARS
+      end
 
       def supported_formats
         [:png, :svg]
@@ -24,30 +39,62 @@ module Asciidoctor
       end
 
       def convert(source, format, options)
-        generate_file(source.find_command('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)]
+        shared_args = []
+        title = options[:heading]
+        if title
+          shared_args << '--title' << title
+        end
 
-          title = options[:heading]
-          if title
-            args << '--title' << title
-          end
+        scale = options[:scale]
+        if scale
+          shared_args << '--scale' << scale
+        end
 
-          scale = options[:scale]
-          if scale
-            args << '--scale' << scale
-          end
+        transparent = options[:transparent]
+        if transparent == 'true'
+          shared_args << '--transparent'
+        end
+        style = options[:style]
+        if style
+          shared_args << '--style' << style
+        end
 
-          transparent = options[:transparent]
-          if transparent == 'true'
-            args << '--transparent'
+        if JSYNTRAX_JARS
+          Java.load
+
+          options_string = shared_args.join(' ')
+
+          case format
+          when :png
+            mime_type = 'image/png'
+          when :svg
+            mime_type = 'image/svg+xml'
+          else
+            raise "Unsupported format: #{format}"
           end
-          style = options[:style]
-          if style
-            args << '--style' << style
+
+          headers = {
+            'Accept' => mime_type,
+            'X-Options' => options_string
+          }
+
+          response = Java.send_request(
+            :url => '/syntrax',
+            :body => source.to_s,
+            :headers => headers
+          )
+
+          unless response[:code] == 200
+            raise Java.create_error("JSyntrax code generation failed", response)
           end
 
-          args
+          response[:body]
+        else
+          generate_file(source.find_command('syntrax'), 'spec', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+            [tool_path, '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)] + shared_args
+          end
         end
+
       end
 
       def native_scaling?

data/lib/asciidoctor-diagram/util/cli.rb

@@ -9,8 +9,13 @@ module Asciidoctor
         require_relative 'java'
 
         def self.run(*args)
-          opts = args.pop.dup if args.last.is_a? Hash
-          in_data = opts && opts[:stdin_data]
+          if args.last.is_a? Hash
+            opts = args.pop.dup
+          else
+            opts = {}
+          end
+
+          in_data = opts[:stdin_data]
 
           if Hash === args.first
             env = args.shift.dup
@@ -19,6 +24,9 @@ module Asciidoctor
           end
 
           pb = java.lang.ProcessBuilder.new(*args)
+
+          pb.directory(java.io.File.new(opts[:chdir] || Dir.pwd))
+
           env.each_pair do |key, value|
             pb.environment.put(key, value)
           end

data/lib/asciidoctor-diagram/util/cli_generator.rb

@@ -81,6 +81,7 @@ module Asciidoctor
             args = opts[:args]
             out_file = opts[:out_file]
             env = opts[:env] || {}
+            open3_opts[:chdir] = opts[:chdir] if opts[:chdir]
           else
             raise "Block passed to generate_file should return an Array or a Hash"
         end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.7"
+    VERSION = "2.2.9"
   end
 end

data/lib/asciidoctor-diagram.rb

@@ -4,6 +4,7 @@ require_relative 'asciidoctor-diagram/blockdiag'
 require_relative 'asciidoctor-diagram/bpmn'
 require_relative 'asciidoctor-diagram/bytefield'
 require_relative 'asciidoctor-diagram/d2'
+require_relative 'asciidoctor-diagram/dbml'
 require_relative 'asciidoctor-diagram/diagrams'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/dpic'
@@ -21,6 +22,7 @@ require_relative 'asciidoctor-diagram/plantuml'
 require_relative 'asciidoctor-diagram/salt'
 require_relative 'asciidoctor-diagram/shaape'
 require_relative 'asciidoctor-diagram/smcat'
+require_relative 'asciidoctor-diagram/structurizr'
 require_relative 'asciidoctor-diagram/svgbob'
 require_relative 'asciidoctor-diagram/symbolator'
 require_relative 'asciidoctor-diagram/syntrax'

data/spec/a2s_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 A2S_CODE = <<-eos
                       .--.            .---.  .---. .---.  .---.    .---.  .---. 

data/spec/barcode_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 BARCODES = {
   :bookland => '978-0-306-40615-7',

data/spec/blockdiag_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 BLOCKDIAG_CODE = <<-eos
 blockdiag {

data/spec/bpmn_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 BPNM_CODE = <<EOF
 <?xml version="1.0" encoding="UTF-8"?>

data/spec/bytefield_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 BYTEFIELD_CODE = <<-eos
 ;; This the source for the sample diagram illustrated in the project Read Me.

data/spec/d2_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 D2_CODE = <<-eos
 # Actors
@@ -34,4 +34,54 @@ end
 
 describe Asciidoctor::Diagram::D2BlockProcessor, :broken_on_windows do
   include_examples "block", :d2, D2_CODE, [:svg]
+
+  it "should not use sketch mode by default" do
+    doc = <<-eos
+= Hello, D2!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[d2]
+----
+#{D2_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
+    target = b.attributes['target']
+    expect(target).to match(/\.svg$/)
+    expect(File.exist?(target)).to be true
+    svg = File.read(target, :encoding => Encoding::UTF_8)
+    expect(svg).to_not match(/class='.*?sketch-overlay-B5.*?'/)
+  end
+
+  it "should support sketch mode" do
+    doc = <<-eos
+= Hello, D2!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[d2, foobar, svg, sketch]
+----
+#{D2_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
+    target = b.attributes['target']
+    expect(target).to match(/\.svg$/)
+    expect(File.exist?(target)).to be true
+    svg = File.read(target, :encoding => Encoding::UTF_8)
+    expect(svg).to match(/class='.*?sketch-overlay-B5.*?'/)
+  end
 end

data/spec/dbml_spec.rb

@@ -0,0 +1,32 @@
+require_relative 'test_helper_methods'
+
+DBML_CODE = <<-eos
+Table users {
+    id integer
+    username varchar
+    role varchar
+    created_at timestamp
+}
+
+Table posts {
+    id integer [primary key]
+    title varchar
+    body text [note: 'Content of the post']
+    user_id integer
+    created_at timestamp
+}
+
+Ref: posts.user_id > users.id
+eos
+
+describe Asciidoctor::Diagram::DbmlInlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :dbml, DBML_CODE, [:svg]
+end
+
+describe Asciidoctor::Diagram::DbmlBlockMacroProcessor, :broken_on_windows do
+  include_examples "block_macro", :dbml, DBML_CODE, [:svg]
+end
+
+describe Asciidoctor::Diagram::DbmlBlockProcessor, :broken_on_windows do
+  include_examples "block", :dbml, DBML_CODE, [:svg]
+end

data/spec/diagrams_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 DIAGRAMS_CODE = <<-eos
 from diagrams import Diagram

data/spec/ditaa_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 DITAA_CODE = <<-eos
 +--------+   +-------+    +-------+

data/spec/dpic_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 DPIC_CODE = <<-eos
   arrow "$u$" above

data/spec/erd_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 ERD_CODE = <<-eos
 title {label: "nfldb Entity-Relationship diagram (condensed)", size: "20"}

data/spec/gnuplot_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 GNUPLOT_CODE = <<-eos
 plot [0:5][0:20] x**2 title 'O(n^2)'

data/spec/graphviz_py_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 GRAPHVIZ_PY_CODE = <<-eos
 graph python_graph {

data/spec/graphviz_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 DOT_CODE = <<-eos
 digraph foo {

data/spec/lilypond_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 LILYPOND_CODE = <<-eos
 \\relative c' { f d f a d f e d cis a cis e a g f e }

data/spec/meme_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 describe Asciidoctor::Diagram::MemeBlockMacroProcessor do
   it "should generate PNG images when format is set to 'png'" do

data/spec/mermaid_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 MERMAID_CODE = <<-eos
 graph LR

data/spec/msc_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 MSC_CODE = <<-eos
 # MSC for some fictional process

data/spec/nomnoml_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 NOMNOML_CODE = <<-eos
 [Pirate

data/spec/pikchr_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 PIKCHR_CODE = <<-eos
 # Change from the original:

data/spec/plantuml_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 PLANTUML_CODE = <<-eos
 User -> (Start)
@@ -278,7 +278,7 @@ Foo1 -> Foo2 : To boundary
     expect(File.exist?(target)).to be true
 
     svg = File.read(target, :encoding => Encoding::UTF_8)
-    expect(svg).to match(/<[^<]+ fill=["']url\(#gvl9ibi66ipfc0\)["']/)
+    expect(svg).to match(/<[^<]+ stop-color=["']#7C9AB9["']/)
   end
 
   it 'should use plantuml include dir when specified as a document attribute' do

data/spec/shaape_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 SHAAPE_CODE = <<-eos
         +-->

data/spec/shared_examples.rb

@@ -1,4 +1,5 @@
-require_relative 'test_helper'
+require 'rspec'
+require_relative 'test_helper_methods'
 
 RSpec.shared_examples "block_macro" do |name, code, formats|
   formats.each do |format|
@@ -497,6 +498,7 @@ Doc Writer <doc@example.com>
 
 [#{name}, format="foobar"]
 ----
+#{code}
 ----
     eos
 
@@ -757,8 +759,8 @@ Doc Writer <doc@example.com>
     scaled_image = d.find { |bl| bl.context == :image }
 
     unless formats[0] == :pdf
-      expect(scaled_image.attributes['width']).to be_within(1).of(unscaled_image.attributes['width'] * 2)
-      expect(scaled_image.attributes['height']).to be_within(1).of(unscaled_image.attributes['height'] * 2)
+      expect(scaled_image.attributes['width']).to be_within(10).of(unscaled_image.attributes['width'] * 2)
+      expect(scaled_image.attributes['height']).to be_within(10).of(unscaled_image.attributes['height'] * 2)
     end
   end
 end

data/spec/smcat_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 SMCAT_CODE = <<-eos
 initial,

data/spec/structurizr_spec.rb

@@ -0,0 +1,41 @@
+require_relative 'test_helper_methods'
+
+STRUCTURIZR_CODE = <<-eos
+workspace {
+
+    model {
+        user = person "User"
+        softwareSystem = softwareSystem "Software System" {
+            webapp = container "Web Application" {
+                user -> this "Uses"
+            }
+            container "Database" {
+                webapp -> this "Reads from and writes to"
+            }
+        }
+    }
+
+    views {
+        systemContext softwareSystem {
+            include *
+            autolayout lr
+        }
+
+        container softwareSystem {
+            include *
+            autolayout lr
+        }
+
+        theme default
+    }
+
+}
+eos
+
+describe Asciidoctor::Diagram::StructurizrBlockMacroProcessor, :broken_on_windows, :broken_on_github do
+  include_examples "block_macro", :structurizr, STRUCTURIZR_CODE, [:png, :png]
+end
+
+describe Asciidoctor::Diagram::StructurizrBlockProcessor, :broken_on_windows, :broken_on_github do
+  include_examples "block", :structurizr, STRUCTURIZR_CODE, [:png, :png]
+end

data/spec/svgbob_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 SVGBOB_CODE = <<-eos
                       .--.            .---.  .---. .---.  .---.    .---.  .---. 

data/spec/symbolator_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 SYMBOLATOR_CODE = <<-eos
 library ieee;

data/spec/syntrax_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 SYNTRAX_CODE = <<-eos
 indentstack(10,

data/spec/{test_helper.rb → test_helper_methods.rb}

@@ -1,3 +1,5 @@
+require 'rspec'
+
 require 'asciidoctor'
 require 'asciidoctor/cli/invoker'
 

data/spec/tikz_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 TIKZ_CODE = <<-'eos'
 \begin{tikzpicture}[font=\LARGE] 

data/spec/umlet_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 CODE = <<-eos
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>

data/spec/vega_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 VEGA_CODE = <<-eos
 {

data/spec/wavedrom_spec.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative 'test_helper_methods'
 
 WAVEDROM_CODE = <<-eos
 { signal : [