asciidoctor-diagram 1.5.19 → 2.0.5

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

@@ -0,0 +1,192 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class MermaidConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg]
+      end
+
+      def native_scaling?
+        true
+      end
+
+      def collect_options(source)
+        options = {}
+
+        options[:css] = source.attr('css')
+        options[:gantt_config] = source.attr(['ganttconfig', 'gantt-config'])
+        options[:seq_config] = source.attr(['sequenceconfig', 'sequence-config'])
+        options[:width] = source.attr('width')
+        options[:height] = source.attr('height')
+        options[:scale] = source.attr('scale')
+        if options[:scale]
+          raise "Mermaid only supports integer scale factors: #{options[:scale]}" unless options[:scale] =~ /^[0-9]+$/
+        end
+        options[:theme] = source.attr('theme')
+        options[:background] = source.attr('background')
+        options[:config] = source.attr('config')
+        options[:puppeteer_config] = source.attr(['puppeteerconfig', 'puppeteer-config'])
+
+        options
+      end
+
+      def convert(source, format, options)
+        opts = {}
+
+        css = options[:css]
+        if css
+          opts[:css] = source.resolve_path(css)
+        end
+
+        gantt_config = options[:gantt_config]
+        if gantt_config
+          opts[:gantt] = source.resolve_path(gantt_config)
+        end
+
+        seq_config = options[:seq_config]
+        if seq_config
+          opts[:sequence] = source.resolve_path(seq_config)
+        end
+
+        puppeteer_config = options[:puppeteer_config]
+        if puppeteer_config
+          opts[:puppeteer] = source.resolve_path(puppeteer_config)
+        end
+
+        opts[:width] = options[:width]
+
+        mmdc = source.find_command('mmdc', :raise_on_error => false)
+        node = source.find_command('node', :raise_on_error => false)
+        if mmdc && node
+          opts[:height] = options[:height]
+          opts[:scale] = options[:scale]
+          opts[:theme] = options[:theme]
+          opts[:background] = options[:background]
+          config = options[:config]
+          if config
+            opts[:config] = source.resolve_path(config)
+          end
+          run_mmdc(node, mmdc, source, format, opts)
+        else
+          mermaid = source.find_command('mermaid')
+          run_mermaid(mermaid, source, format, opts)
+        end
+      end
+
+      private
+      def run_mmdc(node, mmdc, source, format, options = {})
+        generate_file(node, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          args = [tool_path, '--unhandled-rejections=strict', mmdc, '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)]
+
+          if options[:css]
+            args << '--cssFile' << Platform.native_path(options[:css])
+          end
+
+          if options[:theme]
+            args << '--theme' << options[:theme]
+          end
+
+          if options[:width]
+            args << '--width' << options[:width]
+          end
+
+          if options[:height]
+            args << '--height' << options[:height]
+          end
+
+          if options[:scale]
+            args << '--scale' << options[:scale]
+          end
+
+          if options[:background]
+            bg = options[:background]
+            bg = "##{bg}" unless bg[0] == '#'
+            args << '--backgroundColor' << bg
+          end
+
+          if options[:config]
+            args << '--configFile' << Platform.native_path(options[:config])
+          elsif options[:gantt] || options[:sequence]
+            mermaidConfig = []
+
+            if options[:gantt]
+              mermaidConfig << "\"gantt\": #{File.read(options[:gantt])}"
+            end
+
+            if options[:sequence]
+              configKey = source.config['mmdcSequenceConfigKey'] ||= begin
+                version_parts = ::Asciidoctor::Diagram::Cli.run(mmdc, '--version')[:out].split('.').map { |p| p.to_i }
+                major = version_parts[0] || 0
+                minor = version_parts[1] || 0
+                patch = version_parts[2] || 0
+                if major > 0 || (major == 0 && minor > 4) || (major == 0 && minor == 4 && patch > 1)
+                  'sequence'
+                else
+                  'sequenceDiagram'
+                end
+              end
+              mermaidConfig << "\"#{configKey}\": #{File.read(options[:sequence])}"
+            end
+
+            config_file = "#{input_path}.json"
+
+            File.write(config_file, "{#{mermaidConfig.join ','}}")
+
+            args << '--configFile' << Platform.native_path(config_file)
+          end
+
+          if options[:puppeteer]
+            args << '--puppeteerConfigFile' << Platform.native_path(options[:puppeteer])
+          end
+
+          args
+        end
+      end
+
+      def run_mermaid(mermaid, source, format, options = {})
+        source.config['mermaid>=6'] ||= ::Asciidoctor::Diagram::Cli.run(mermaid, '--version')[:out].split('.')[0].to_i >= 6
+        # Mermaid >= 6.0.0 requires PhantomJS 2.1; older version required 1.9
+        phantomjs = source.find_command('phantomjs', :alt_attrs => [source.config['mermaid>=6'] ? 'phantomjs_2' : 'phantomjs_19'])
+
+        generate_file(mermaid, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          output_dir = File.dirname(output_path)
+          output_file = File.expand_path(File.basename(input_path) + ".#{format.to_s}", output_dir)
+
+          args = [tool_path, '--phantomPath', Platform.native_path(phantomjs), "--#{format.to_s}", '-o', Platform.native_path(output_dir)]
+
+          if options[:css]
+            args << '--css' << Platform.native_path(options[:css])
+          end
+
+          if options[:gantt]
+            args << '--gantt_config' << Platform.native_path(options[:gantt])
+          end
+
+          if options[:sequence]
+            args << '--sequenceConfig' << Platform.native_path(options[:sequence])
+          end
+
+          if options[:width]
+            args << '--width' << options[:width]
+          end
+
+          args << Platform.native_path(input_path)
+
+          {
+              :args => args,
+              :out_file => output_file
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -1,167 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative 'converter'
+require_relative '../diagram_processor'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Mermaid
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:png, :svg].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            mermaid(parent, source, f)
-          end
-        end
-      end
-
-      def mermaid(parent_block, source, format)
-        inherit_prefix = name
-
-        options = {}
-
-        css = source.attr('css', nil, inherit_prefix)
-        if css
-          options[:css] = parent_block.normalize_system_path(css, source.base_dir)
-        end
-
-        gantt_config = source.attr('ganttConfig', nil, inherit_prefix) || source.attr('ganttconfig', nil, inherit_prefix)
-        if gantt_config
-          options[:gantt] = parent_block.normalize_system_path(gantt_config, source.base_dir)
-        end
-
-        seq_config = source.attr('sequenceConfig', nil, inherit_prefix) || source.attr('sequenceconfig', nil, inherit_prefix)
-        if seq_config
-          options[:sequence] = parent_block.normalize_system_path(seq_config, source.base_dir)
-        end
-
-        options[:width] = source.attr('width', nil, inherit_prefix)
-
-        mmdc = which(parent_block, 'mmdc', :raise_on_error => false)
-        if mmdc
-          options[:height] = source.attr('height', nil, inherit_prefix)
-          options[:theme] = source.attr('theme', nil, inherit_prefix)
-          options[:background] = source.attr('background', nil, inherit_prefix)
-          config = source.attr('config', nil, inherit_prefix) || source.attr('config', nil, inherit_prefix)
-          if config
-            options[:config] = parent_block.normalize_system_path(config, source.base_dir)
-          end
-          run_mmdc(mmdc, source, format, options)
-        else
-          mermaid = which(parent_block, 'mermaid')
-          run_mermaid(mermaid, parent_block, source, format, options)
-        end
-      end
-
-      private
-      def run_mmdc(mmdc, source, format, options = {})
-        generate_file(mmdc, 'mmd', 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)]
-
-          if options[:css]
-            args << '--cssFile' << Platform.native_path(options[:css])
-          end
-
-          if options[:theme]
-            args << '--theme' << options[:theme]
-          end
-
-          if options[:width]
-            args << '--width' << options[:width]
-          end
-
-          if options[:height]
-            args << '--height' << options[:height]
-          end
-
-          if options[:background]
-            bg = options[:background]
-            bg = "##{bg}" unless bg[0] == '#'
-            args << '--backgroundColor' << bg
-          end
-
-          if options[:config]
-            args << '--configFile' << Platform.native_path(options[:config])
-          elsif options[:gantt] || options[:sequence]
-            mermaidConfig = []
-
-            if options[:gantt]
-              mermaidConfig << "\"gantt\": #{File.read(options[:gantt])}"
-            end
-
-            if options[:sequence]
-              configKey = config['mmdcSequenceConfigKey'] ||= begin
-                version_parts = ::Asciidoctor::Diagram::Cli.run(mmdc, '--version')[:out].split('.').map { |p| p.to_i }
-                major = version_parts[0] || 0
-                minor = version_parts[1] || 0
-                patch = version_parts[2] || 0
-                if major > 0 || (major == 0 && minor > 4) || (major == 0 && minor == 4 && patch > 1)
-                  'sequence'
-                else
-                  'sequenceDiagram'
-                end
-              end
-              mermaidConfig << "\"#{configKey}\": #{File.read(options[:sequence])}"
-            end
-
-            config_file = "#{input_path}.json"
-
-            File.write(config_file, "{#{mermaidConfig.join ','}}")
-
-            args << '--configFile' << Platform.native_path(config_file)
-          end
-
-          args
-        end
-      end
-
-      def run_mermaid(mermaid, parent_block, source, format, options = {})
-        config['mermaid>=6'] ||= ::Asciidoctor::Diagram::Cli.run(mermaid, '--version')[:out].split('.')[0].to_i >= 6
-        # Mermaid >= 6.0.0 requires PhantomJS 2.1; older version required 1.9
-        phantomjs = which(parent_block, 'phantomjs', :alt_attrs => [config['mermaid>=6'] ? 'phantomjs_2' : 'phantomjs_19'])
-
-        generate_file(mermaid, 'mmd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
-          output_dir = File.dirname(output_path)
-          output_file = File.expand_path(File.basename(input_path) + ".#{format.to_s}", output_dir)
-
-          args = [tool_path, '--phantomPath', Platform.native_path(phantomjs), "--#{format.to_s}", '-o', Platform.native_path(output_dir)]
-
-          if options[:css]
-            args << '--css' << Platform.native_path(options[:css])
-          end
-
-          if options[:gantt]
-            args << '--gantt_config' << Platform.native_path(options[:gantt])
-          end
-
-          if options[:sequence]
-            args << '--sequenceConfig' << Platform.native_path(options[:sequence])
-          end
-
-          if options[:width]
-            args << '--width' << options[:width]
-          end
-
-          args << Platform.native_path(input_path)
-
-          {
-              :args => args,
-              :out_file => output_file
-          }
-        end
-      end
-    end
-
-    class MermaidBlockProcessor < Extensions::DiagramBlockProcessor
-      include Mermaid
+    class MermaidBlockProcessor < DiagramBlockProcessor
+      use_converter MermaidConverter
     end
 
-    class MermaidBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Mermaid
+    class MermaidBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter MermaidConverter
     end
   end
 end

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

@@ -0,0 +1,35 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class MscgenConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg]
+      end
+
+      def collect_options(source)
+        {:font => source.attr('font')}
+      end
+
+      def convert(source, format, options)
+        font = options[:font]
+
+        generate_stdin(source.find_command('mscgen'), format.to_s, source.to_s) do |tool_path, output_path|
+          args = [tool_path, '-o', Platform.native_path(output_path), '-T', format.to_s]
+          if font
+            args << '-F' << font
+          end
+          args << '-'
+          args
+        end
+      end
+    end
+  end
+end

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

@@ -1,44 +1,14 @@
-require_relative '../extensions'
-require_relative '../util/cli_generator'
-require_relative '../util/platform'
-require_relative '../util/which'
+require_relative 'converter'
+require_relative '../diagram_processor'
 
 module Asciidoctor
   module Diagram
-    # @private
-    module Mscgen
-      include CliGenerator
-      include Which
-
-      def self.included(mod)
-        [:png, :svg].each do |f|
-          mod.register_format(f, :image) do |parent, source|
-            mscgen(parent, source, f)
-          end
-        end
-      end
-
-      def mscgen(parent, source, format)
-        inherit_prefix = name
-        font = source.attr('font', nil, inherit_prefix)
-
-        generate_stdin(which(parent, 'mscgen'), format.to_s, source.to_s) do |tool_path, output_path|
-          args = [tool_path, '-o', Platform.native_path(output_path), '-T', format.to_s]
-          if font
-            args << '-F' << font
-          end
-          args << '-'
-          args
-        end
-      end
-    end
-
-    class MscBlockProcessor < Extensions::DiagramBlockProcessor
-      include Mscgen
+    class MscBlockProcessor < DiagramBlockProcessor
+      use_converter MscgenConverter
     end
 
-    class MscBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
-      include Mscgen
+    class MscBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter MscgenConverter
     end
   end
 end