asciidoctor-diagram 1.5.19 → 2.0.0

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

@@ -15,35 +15,6 @@ module Asciidoctor
 
         nil
       end
-
-      def which(parent_block, cmd, options = {})
-        attr_names = options[:attrs] || options.fetch(:alt_attrs, []) + [cmd]
-        cmd_names = [cmd] + options.fetch(:alt_cmds, [])
-
-        cmd_var = 'cmd-' + attr_names[0]
-
-        if config.key? cmd_var
-          cmd_path = config[cmd_var]
-        else
-          cmd_path = attr_names.map { |attr_name| parent_block.attr(attr_name, nil, true) }.find { |attr| !attr.nil? }
-
-          unless cmd_path && File.executable?(cmd_path)
-            cmd_paths = cmd_names.map do |c|
-              ::Asciidoctor::Diagram::Which.which(c, :path => options[:path])
-            end
-
-            cmd_path = cmd_paths.reject { |c| c.nil? }.first
-          end
-
-          config[cmd_var] = cmd_path
-
-          if cmd_path.nil? && options.fetch(:raise_on_error, true)
-            raise "Could not find the #{cmd_names.map { |c| "'#{c}'" }.join(', ')} executable in PATH; add it to the PATH or specify its location using the '#{attr_names[0]}' document attribute"
-          end
-        end
-
-        cmd_path
-      end
     end
   end
 end

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

@@ -0,0 +1,47 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class VegaConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:svg, :png]
+      end
+
+
+      def collect_options(source, name)
+        {
+            :vegalite => name.to_s.include?('lite') || source.attr('vegalite')
+        }
+      end
+
+      def convert(source, format, options)
+        base_dir = source.base_dir
+
+        code = source.to_s
+
+        if code.include?('/schema/vega-lite/') || options[:vegalite]
+          vega_code = generate_stdin_stdout(source.find_command("vl2vg"), code)
+        else
+          vega_code = code
+        end
+
+        generate_file(source.find_command("vg2#{format}"), "json", format.to_s, vega_code) do |tool_path, input_path, output_path|
+          args = [tool_path, '--base', Platform.native_path(base_dir)]
+          if format == :svg
+            args << '--header'
+          end
+
+          args << Platform.native_path(input_path)
+          args << Platform.native_path(output_path)
+        end
+      end
+    end
+  end
+end

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

@@ -1,52 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative '../diagram_processor'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Vega
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:svg, :png].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            vega(parent, source, f)
-          end
-        end
-      end
-
-      def vega(parent, source, format)
-        base_dir = source.base_dir
-
-        code = source.to_s
-
-        if code.include?('/schema/vega-lite/') || name.to_s.include?('lite') || source.attr('vegalite')
-          vega_code = generate_stdin_stdout(which(parent, "vl2vg"), code)
-        else
-          vega_code = code
-        end
-
-        generate_file(which(parent, "vg2#{format}"), "json", format.to_s, vega_code) do |tool_path, input_path, output_path|
-          args = [tool_path, '--base', Platform.native_path(base_dir)]
-          if format == :svg
-            args << '--header'
-          end
-
-          args << Platform.native_path(input_path)
-          args << Platform.native_path(output_path)
-        end
-      end
-    end
-
-    class VegaBlockProcessor < Extensions::DiagramBlockProcessor
-      include Vega
+    class VegaBlockProcessor < DiagramBlockProcessor
+      use_converter VegaConverter
     end
 
-    class VegaBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Vega
+    class VegaBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter VegaConverter
     end
   end
 end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.19"
+    VERSION = "2.0.0"
   end
 end

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

@@ -0,0 +1,50 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class WavedromConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg]
+      end
+
+
+      def convert(source, format, options)
+        wavedrom_cli = source.find_command('wavedrom-cli', :raise_on_error => false)
+        if wavedrom_cli
+          generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+            [Platform.native_path(tool_path), '--input', Platform.native_path(input_path), "--#{format.to_s}", Platform.native_path(output_path)]
+          end
+        else
+          wavedrom_cli = source.find_command('wavedrom', :raise_on_error => false)
+          phantomjs = source.find_command('phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
+
+          if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
+            generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
+            end
+          else
+            if ::Asciidoctor::Diagram::Platform.os == :macosx
+              wavedrom = source.find_command('WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'], :path => ['/Applications'])
+              if wavedrom
+                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+              end
+            else
+              wavedrom = source.find_command('WaveDromEditor')
+            end
+
+            generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+              [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,62 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative '../diagram_processor'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Wavedrom
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:png, :svg].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            wavedrom(parent, source, f)
-          end
-        end
-      end
-
-      def wavedrom(parent, source, format)
-        wavedrom_cli = which(parent, 'wavedrom-cli', :raise_on_error => false)
-
-        if wavedrom_cli
-          generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-            [Platform.native_path(tool_path), '--input', Platform.native_path(input_path), "--#{format.to_s}", Platform.native_path(output_path)]
-          end
-        else
-          wavedrom_cli = which(parent, 'wavedrom', :raise_on_error => false)
-          phantomjs = which(parent, 'phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
-
-          if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
-            generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-              [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
-            end
-          else
-            if ::Asciidoctor::Diagram::Platform.os == :macosx
-              wavedrom = which(parent, 'WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'],:path => ['/Applications'])
-              if wavedrom
-                wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
-              end
-            else
-              wavedrom = which(parent, 'WaveDromEditor')
-            end
-
-            generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-              [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
-            end
-          end
-        end
-      end
-    end
-
-    class WavedromBlockProcessor < Extensions::DiagramBlockProcessor
-      include Wavedrom
+    class WavedromBlockProcessor < DiagramBlockProcessor
+      use_converter WavedromConverter
     end
 
-    class WavedromBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Wavedrom
+    class WavedromBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter WavedromConverter
     end
   end
 end

data/spec/bpmn-example.xml

@@ -0,0 +1,44 @@
+<?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>

data/spec/bpmn_spec.rb

@@ -0,0 +1,96 @@
+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
+
+    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
+end

data/spec/mermaid_spec.rb

@@ -301,4 +301,36 @@ mermaid::mermaid.txt["dark", format="svg", theme="dark"]
     expect(File.exist?('dark.svg')).to be true
     expect(File.read('default.svg')).to_not be File.read('dark.svg')
   end
-end
+
+  it "should respect the puppeteerConfig attribute" do
+    seq_diag = <<-eos
+sequenceDiagram
+    Alice->>John: Hello John, how are you?
+    John-->>Alice: Great!
+    eos
+
+    pptr_config = <<-eos
+{
+    "args": ["--no-sandbox"]
+}
+    eos
+    File.write('pptrconfig.txt', pptr_config)
+
+    File.write('mermaid.txt', seq_diag)
+
+    doc = <<-eos
+= Hello, Mermaid!
+Doc Writer <doc@example.com>
+
+== First Section
+
+mermaid::mermaid.txt["with_config", puppeteerConfig="pptrconfig.txt"]
+mermaid::mermaid.txt["without_config"]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('with_config.png')).to be true
+    expect(File.exist?('without_config.png')).to be true
+    expect(File.size('with_config.png')).to be File.size('without_config.png')
+  end
+end