asciidoctor-diagram 2.2.3 → 3.0.0

data/lib/asciidoctor-diagram/penrose.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'penrose/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::PenroseBlockProcessor, :penrose
+  block_macro Asciidoctor::Diagram::PenroseBlockMacroProcessor, :penrose
+  inline_macro Asciidoctor::Diagram::PenroseInlineMacroProcessor, :penrose
+end

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

@@ -18,7 +18,10 @@ module Asciidoctor
         pikchr_path = source.find_command('pikchr')
 
         output = generate_file_stdout(pikchr_path, format.to_s, source.to_s) do |tool_path, input_path|
-          [tool_path, "--svg-only", input_path]
+          {
+            :args => [tool_path, "--svg-only", input_path],
+            :chdir => source.base_dir
+          }
         end
 
         if output.start_with? '<svg'

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

@@ -0,0 +1,60 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class PintoraConverter
+      include DiagramConverter
+      include CliGenerator
+
+
+      def supported_formats
+        [:png, :svg]
+      end
+
+      def collect_options(source)
+        options = {}
+
+        options[:width] = source.attr('width')
+        options[:theme] = source.attr('theme')
+        options[:background_color] = source.attr('background-color')
+        options[:pixel_ratio] = source.attr('pixel-ratio')
+
+        options
+      end
+
+      def convert(source, format, options)
+        pintora = source.find_command('pintora')
+
+        generate_file(pintora, 'pintora', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          args = [tool_path, 'render', '-i', Platform.native_path(input_path), '-o', Platform.native_path(output_path)]
+
+
+          if options[:width]
+            args << '-w' << options[:width]
+          end
+
+          if options[:theme]
+            args << '-t' << options[:theme]
+          end
+
+          if options[:pixel_ratio]
+            args << '-p' << options[:pixel_ratio]
+          end
+
+          if options[:background_color]
+            args << '-b' << options[:background_color]
+          end
+
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class PintoraBlockProcessor < DiagramBlockProcessor
+      use_converter PintoraConverter
+    end
+
+    class PintoraBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter PintoraConverter
+    end
+
+    class PintoraInlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter PintoraConverter
+    end
+  end
+end

data/lib/asciidoctor-diagram/pintora.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'pintora/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::PintoraBlockProcessor, :pintora
+  block_macro Asciidoctor::Diagram::PintoraBlockMacroProcessor, :pintora
+  inline_macro Asciidoctor::Diagram::PintoraInlineMacroProcessor, :pintora
+end

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

@@ -1,4 +1,7 @@
 require_relative '../diagram_converter'
+require_relative '../util/java'
+require_relative '../util/cli'
+require_relative '../util/cli_generator'
 require 'delegate'
 require 'uri'
 
@@ -7,25 +10,37 @@ module Asciidoctor
     # @private
     class PlantUmlConverter
       include DiagramConverter
+      include CliGenerator
 
-      CLASSPATH_ENV = 'DIAGRAM_PLANTUML_CLASSPATH'
+      CLASSPATH_ENV = Java.environment_variable('DIAGRAM_PLANTUML_CLASSPATH')
       LIB_DIR = File.expand_path('../..', File.dirname(__FILE__))
-      PLANTUML_JARS = if ENV.has_key?(CLASSPATH_ENV)
-                        ENV[CLASSPATH_ENV].split(File::PATH_SEPARATOR)
+      PLANTUML_JARS = if CLASSPATH_ENV
+                        CLASSPATH_ENV.split(File::PATH_SEPARATOR)
                       else
                         begin
                           require 'asciidoctor-diagram/plantuml/classpath'
                           ::Asciidoctor::Diagram::PlantUmlClasspath::JAR_FILES
                         rescue LoadError
-                          raise "Could not load PlantUML. Eiter require 'asciidoctor-diagram-plantuml' or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_PLANTUML_CLASSPATH' environment variable."
+                          nil
                         end
                       end
 
-      Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')].freeze
-      Java.classpath.concat PLANTUML_JARS
+      if PLANTUML_JARS
+        Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')].freeze
+        Java.classpath.concat PLANTUML_JARS
+      end
+
+      def self.find_plantuml_native(source)
+        source.find_command(
+          'plantuml-full',
+          :raise_on_error => false,
+          :attrs => ['plantuml-native'],
+          :alt_cmds => ['plantuml-headless']
+        )
+      end
 
       def wrap_source(source)
-        PlantUMLPreprocessedSource.new(source, self.class.tag)
+        PlantUMLPreprocessedSource.new(source, self)
       end
 
       def supported_formats
@@ -33,12 +48,62 @@ module Asciidoctor
       end
 
       def collect_options(source)
-        {
-            :size_limit => source.attr('size-limit', '4096')
+        options = {
+            :size_limit => source.attr('size-limit', '4096'),
         }
+
+        options[:smetana] = true if source.opt('smetana')
+
+        theme = source.attr('theme', nil)
+        options[:theme] = theme if theme
+
+        options[:debug] = true if source.opt('debug')
+
+        options
+      end
+
+      def should_preprocess(source)
+        source.attr('preprocess', 'true') == 'true'
       end
 
       def convert(source, format, options)
+        plantuml_native = PlantUmlConverter.find_plantuml_native(source)
+        if plantuml_native
+          convert_native(plantuml_native, source, format, options)
+        elsif PLANTUML_JARS
+          convert_http(source, format, options)
+        else
+          raise "Could not load PlantUML. Either require 'asciidoctor-diagram-plantuml' " \
+                  "or specify the location of the PlantUML JAR(s) using the 'DIAGRAM_PLANTUML_CLASSPATH' environment variable. " \
+                  "Alternatively a PlantUML binary can be provided (plantuml-native in $PATH)."
+        end
+      end
+
+      def add_common_headers(headers, source)
+        base_dir = source.base_dir
+
+        config_file = source.attr('plantumlconfig', nil, true) || source.attr('config')
+        if config_file
+          headers['X-PlantUML-Config'] = File.expand_path(config_file, base_dir)
+        end
+
+        headers['X-PlantUML-Basedir'] = Platform.native_path(File.expand_path(base_dir))
+
+        include_dir = source.attr('includedir')
+        if include_dir
+          headers['X-PlantUML-IncludeDir'] = Platform.native_path(File.expand_path(include_dir, base_dir))
+        end
+      end
+
+      def add_theme_header(headers, theme)
+        headers['X-PlantUML-Theme'] = theme if theme
+      end
+
+      def add_size_limit_header(headers, limit)
+        headers['X-PlantUML-SizeLimit'] = limit if limit
+      end
+
+      def convert_http(source, format, options)
         Java.load
 
         code = source.code
@@ -57,30 +122,139 @@ module Asciidoctor
         end
 
         headers = {
-            'Accept' => mime_type
+          'Accept' => mime_type
         }
 
-        size_limit = options[:size_limit]
-        if size_limit
-          headers['X-PlantUML-SizeLimit'] = size_limit
+        unless should_preprocess(source)
+          add_common_headers(headers, source)
         end
 
+        add_theme_header(headers, options[:theme])
+        add_size_limit_header(headers, options[:size_limit])
+
         dot = source.find_command('dot', :alt_attrs => ['graphvizdot'], :raise_on_error => false)
-        if dot
+        if options[:smetana] || !dot
+          headers['X-Graphviz'] = 'smetana'
+        else
           headers['X-Graphviz'] = ::Asciidoctor::Diagram::Platform.host_os_path(dot)
         end
 
+        if options[:debug]
+          headers['X-PlantUML-Debug'] = 'true'
+        end
+
         response = Java.send_request(
-            :url => '/plantuml',
-            :body => code,
-            :headers => headers
+          :url => '/plantuml',
+          :body => code,
+          :headers => headers
         )
 
         unless response[:code] == 200
           raise Java.create_error("PlantUML image generation failed", response)
         end
 
-        response[:body]
+        if response[:headers]['content-type'] =~ /multipart\/form-data;\s*boundary=(.*)/
+          boundary = $1
+          parts = {}
+
+          multipart_data = StringIO.new(response[:body])
+          while true
+            multipart_data.readline
+            marker = multipart_data.readline
+            if marker.start_with? "--#{boundary}--"
+              break
+            elsif marker.start_with? "--#{boundary}"
+              part = Java.parse_body(multipart_data)
+              if part[:headers]['content-disposition'] =~ /form-data;\s*name="([^"]*)"/
+                if $1 == 'image'
+                  parts[:result] = part[:body]
+                else
+                  parts[:extra] ||= {}
+                  parts[:extra][$1] = part[:body]
+                end
+              else
+                raise "Unexpected multipart content disposition"
+              end
+            else
+              raise "Unexpected multipart boundary"
+            end
+          end
+
+          parts
+        else
+          response[:body]
+        end
+      end
+
+      def add_theme_arg(args, theme)
+        if theme
+          args << '-theme' << theme
+        end
+      end
+
+      def add_common_args(args, source)
+        base_dir = File.expand_path(source.base_dir)
+        args << '-filedir'
+        args << base_dir
+
+        config_file = source.attr('plantumlconfig', nil, true) || source.attr('config')
+        if config_file
+          args << '-config'
+          args << File.expand_path(config_file, base_dir)
+        end
+
+        include_dir = source.attr('includedir')
+        if include_dir
+          args << "-Dplantuml.include.path=#{Platform.native_path(File.expand_path(include_dir, base_dir))}"
+        end
+      end
+
+      def convert_native(plantuml, source, format, options)
+        code = source.code
+
+        args = []
+        env = {}
+
+        args << case format
+        when :png
+          '-tpng'
+        when :svg
+          '-tsvg'
+        when :txt, :utxt
+          '-tutxt'
+        when :atxt
+          '-ttxt'
+        else
+          raise "Unsupported format: #{format}"
+        end
+
+        add_common_args(args, source)
+        add_theme_arg(args, options[:theme])
+
+        if options[:size_limit]
+          env['PLANTUML_LIMIT_SIZE'] = options[:size_limit]
+        end
+
+        dot = source.find_command('dot', :alt_attrs => ['graphvizdot'], :raise_on_error => false)
+        if options[:smetana] || !dot
+          args << '-Playout=smetana'
+        else
+          args << '-graphvizdot'
+          args << ::Asciidoctor::Diagram::Platform.host_os_path(dot)
+        end
+
+        generate_stdin_stdout(plantuml, code) do |tool, _|
+          cmd = [tool]
+          cmd << '-pipe'
+          cmd << '-failfast2'
+          cmd << '-stdrpt:1'
+          cmd.concat args
+
+          {
+            :args => cmd,
+            :env => env
+          }
+        end
       end
     end
 
@@ -97,9 +271,11 @@ module Asciidoctor
     end
 
     class PlantUMLPreprocessedSource < SimpleDelegator
-      def initialize(source, tag)
+      include CliGenerator
+
+      def initialize(source, converter)
         super(source)
-        @tag = tag
+        @converter = converter
       end
 
       def code
@@ -107,44 +283,81 @@ module Asciidoctor
       end
 
       def load_code
+        code = __getobj__.code
+
+        tag = @converter.class.tag
+        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index("@start") && code.index("@end")
+
+        if @converter.should_preprocess(self)
+          plantuml_native = PlantUmlConverter.find_plantuml_native(self)
+          if plantuml_native
+            code = preprocess_native(plantuml_native, code)
+          else
+            code = preprocess_http(code)
+          end
+        end
+
+        code
+      end
+
+      private
+
+      def preprocess_http(code)
         Java.load
 
-        code = __getobj__.code
+        headers = {}
+        @converter.add_common_headers(headers, self)
+        @converter.add_theme_header(headers, @converter.collect_options(self)[:theme])
+
+        response = Java.send_request(
+          :url => '/plantumlpreprocessor',
+          :body => code,
+          :headers => headers
+        )
+
+        unless response[:code] == 200
+          raise Java.create_error("PlantUML preprocessing failed", response)
+        end
 
-        code = "@start#{@tag}\n#{code}\n@end#{@tag}" unless code.index("@start") && code.index("@end")
+        code = response[:body]
+        code.force_encoding(Encoding::UTF_8)
+      end
 
-        should_preprocess = attr('preprocess', 'true') == 'true'
+      def preprocess_native(plantuml, code)
+        generate_stdin_stdout(plantuml, code) do |tool, _|
+          cmd = [tool]
+          cmd << '-pipe'
+          cmd << '-preproc'
+          cmd << '-failfast2'
+          cmd << '-stdrpt:1'
 
-        if should_preprocess
-          headers = {}
+          @converter.add_common_args(cmd, self)
+          @converter.add_theme_arg(cmd, @converter.collect_options(self)[:theme])
 
-          config_file = attr('plantumlconfig', nil, true) || attr('config')
+          base_dir = File.expand_path(self.base_dir)
+          cmd << '-filedir'
+          cmd << base_dir
+
+          config_file = self.attr('plantumlconfig', nil, true) || self.attr('config')
           if config_file
-            headers['X-PlantUML-Config'] = File.expand_path(config_file, base_dir)
+            cmd << '-config'
+            cmd <<  File.expand_path(config_file, base_dir)
           end
 
-          headers['X-PlantUML-Basedir'] = Platform.native_path(File.expand_path(base_dir))
-
-          include_dir = attr('includedir')
+          include_dir = self.attr('includedir')
           if include_dir
-            headers['X-PlantUML-IncludeDir'] = Platform.native_path(File.expand_path(include_dir, base_dir))
+            cmd << "-Dplantuml.include.path=#{Platform.native_path(File.expand_path(include_dir, base_dir))}"
           end
 
-          response = Java.send_request(
-            :url => '/plantumlpreprocessor',
-            :body => code,
-            :headers => headers
-          )
-
-          unless response[:code] == 200
-            raise Java.create_error("PlantUML preprocessing failed", response)
+          theme = @converter.collect_options(self)[:theme]
+          if theme
+            cmd << '-theme' << theme
           end
 
-          code = response[:body]
-          code.force_encoding(Encoding::UTF_8)
+          {
+            :args => cmd
+          }
         end
-
-        code
       end
     end
   end

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

@@ -17,7 +17,10 @@ module Asciidoctor
 
       def convert(source, format, options)
         generate_stdin(source.find_command('shaape'), format.to_s, source.to_s) do |tool_path, output_path|
-          [tool_path, '-o', Platform.native_path(output_path), '-t', format.to_s, '-']
+          {
+            :args => [tool_path, '-o', Platform.native_path(output_path), '-t', format.to_s, '-'],
+            :chdir => source.base_dir
+          }
         end
       end
     end

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

@@ -36,7 +36,11 @@ module Asciidoctor
           end
 
           args << '-'
-          args
+
+          {
+            :args => args,
+            :chdir => source.base_dir
+          }
         end
       end
     end

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

@@ -0,0 +1,69 @@
+require 'set'
+
+require_relative '../diagram_converter'
+require_relative '../diagram_processor'
+require_relative '../plantuml/converter'
+require_relative '../util/java'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class StructurizrConverter
+      include DiagramConverter
+
+      CLASSPATH_ENV = Java.environment_variable('DIAGRAM_STRUCTURIZR_CLASSPATH')
+      CLI_HOME_ENV = Java.environment_variable('DIAGRAM_STRUCTURIZRCLI_HOME')
+      STRUCTURIZR_JARS = if CLASSPATH_ENV
+                           CLASSPATH_ENV.split(File::PATH_SEPARATOR)
+                         elsif CLI_HOME_ENV
+                           lib_dir = File.expand_path('lib', CLI_HOME_ENV)
+                           Dir[File.join(lib_dir, '*.jar')]
+                         else
+                           nil
+                         end
+
+      if STRUCTURIZR_JARS
+        Java.classpath.concat Dir[File.join(File.dirname(__FILE__), '*.jar')]
+        Java.classpath.concat STRUCTURIZR_JARS
+      end
+
+      def supported_formats
+        [:txt]
+      end
+
+      def collect_options(source)
+        {
+          :view => source.attr('view'),
+          :renderer => Renderers.get_renderer_type(source)
+        }
+      end
+
+      def convert(source, format, options)
+        unless STRUCTURIZR_JARS
+          raise "Could not load Structurizr. Specify the location of the Structurizr JAR(s) using the 'DIAGRAM_STRUCTURIZRCLI_HOME' or DIAGRAM_STRUCTURIZR_CLASSPATH' environment variable."
+        end
+
+        Java.load
+
+        headers = {
+          'Accept' => Renderers.mime_type(options[:renderer])
+        }
+        headers['X-Structurizr-View'] = options[:view] if options[:view]
+        headers['X-Structurizr-IncludeDir'] = Platform.native_path(source.base_dir)
+
+
+        response = Java.send_request(
+          :url => '/structurizr',
+          :body => source.code,
+          :headers => headers
+        )
+
+        unless response[:code] == 200
+          raise Java.create_error("Structurizr code generation failed", response)
+        end
+
+        response[:body].force_encoding(Encoding::UTF_8)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require_relative 'converter'
+require_relative 'renderers.rb'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+
+    class StructurizrConvertBlockProcessor < DiagramBlockProcessor
+      use_converter StructurizrConverter
+    end
+
+    class StructurizrBlockProcessor < Asciidoctor::Extensions::BlockProcessor
+      DiagramBlockProcessor.inherited(self)
+
+      def initialize(name = nil, config = nil)
+        super
+        @structurizr = StructurizrConvertBlockProcessor.new(name)
+        @renderers = Renderers.new(name)
+      end
+
+      def process parent, reader, attributes
+        structurizr_attrs = attributes.dup
+        structurizr_attrs['format'] = 'txt'
+
+        renderer_block = @structurizr.process(parent, reader, structurizr_attrs)
+        @renderers.get_renderer(BasicSource.new(self, parent, attributes)).process(parent, renderer_block, attributes)
+      end
+    end
+
+    class StructurizrConvertBlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter StructurizrConverter
+    end
+
+    class StructurizrBlockMacroProcessor < Asciidoctor::Extensions::BlockMacroProcessor
+      DiagramBlockMacroProcessor.inherited(self)
+
+      def initialize(name = nil, config = nil)
+        super
+        @structurizr = StructurizrConvertBlockMacroProcessor.new(name)
+        @renderers = Renderers.new(name)
+      end
+
+      def process parent, target, attributes
+        structurizr_attrs = attributes.dup
+        structurizr_attrs['format'] = 'txt'
+
+        renderer_block = @structurizr.process(parent, target, structurizr_attrs)
+        @renderers.get_renderer(BasicSource.new(self, parent, attributes)).process(parent, renderer_block, attributes)
+      end
+    end
+  end
+end