asciidoctor-diagram 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37e7e92d9ff0bcae6607a862a17d8d642a54ad482f896a671c698993c22ad18
-  data.tar.gz: 9da43fb78ccd16a79e341c662f0e6dae0fdb2edf4bd9697005f4321c8e518fe0
+  metadata.gz: 2c23479ec496e71fd006564fec4e1ca6cf88bd09ae730437e39e3d2dab6554c8
+  data.tar.gz: 583614138465d13c09a0134a888ecb513b27e9040d1d946fd62038c1421cfaf3
 SHA512:
-  metadata.gz: 5366ef0c9961283fa4df0dd1b59774237dfc78923160e705d739d856f7b8dd64dc0edd4b93bc7cc139e413481dd597a384b952e52483a36a672e3f47eed30e2f
-  data.tar.gz: b2828d5e8987b2f27f2c1c55a0bd80eae39b7c2015c09c9899cf5ad1ce0e264cef2af7782a402225ceea81027f65ef12480a8882af90e0dd4571e98fb1571c5c
+  metadata.gz: 92fdb3bcfbf238bbcfc13f2ea84b5441c9db60c98e053bef529487351c82fb07192d44304661fd1ede94fa3286923029bb3e93f72c5bb5ffd3a8f8cbeda2227e
+  data.tar.gz: bc7a9000e2ae1beeed9e61d538938241b6401a5aa4cff8bb5b9d15f8fe8dd7c4991b58ea326677feaf9f6e72f20c72961ce1286c53ed0704e5d48af102ad99e7

data/CHANGELOG.adoc

@@ -1,5 +1,11 @@
 = Asciidoctor-diagram Changelog
 
+== 2.0.1
+
+Bug Fixes::
+
+  * Issue #254: On Windows generating PlantUML or Ditaa diagrams would cause asciidoctor-diagram to block indefinitely
+
 == 2.0.0
 
 Enhancements::

data/README.adoc

@@ -347,7 +347,7 @@ Occurrences of `//` surrounded by whitespace are interpreted as line breaks.
 === Diagram Attributes
 
 Certain diagram types allow image generation to be customized using attributes.
-Each attribute can be specified either at the block level or at the document level.
+Each attribute can be specified per individual diagram block or for all blocks of a given diagram type in a document level.
 This is illustrated for the blockdiag `fontpath` attribute in the example below.
 
 ----
@@ -362,13 +362,23 @@ This is illustrated for the blockdiag `fontpath` attribute in the example below.
 ....
 ....
 ----
-<1> Block level attributes can be specified at the document level by prefixing them with `<blocktype>-`
-<2> The first diagram does not specify an explicit value for `fontpath` so the global value will be used
-<3> The second diagram specifies a `fontpath` value which overrrides the global value
+<1> Attributes can be specified for all diagram of a certain type at the document level by prefixing them with `<blocktype>-`.
+    In this example, the `fontpath` attribute is specified for all diagrams of type `blockdiag`.
+<2> The first diagram does not specify an explicit value for `fontpath` so the global `blockdiag-fontpath` value will be used
+<3> The second diagram does specifie a `fontpath` value.
+    This overrides the global `blockdiag-fontpath` value.
 
 Each attribute can either be specified at the block level or at the document level.
 The attribute name at the block level should be prefixed with the name of the diagram type and a dash.
 
+==== Shared Attributes
+
+[cols=">,<,<",options="header"]
+|===
+|Name         |Default value   |Description
+|svg-type     |unspecified     |One of `static`, `inline` or `interactive`. This determines the style of SVG embedding that's used in certain backends. The https://asciidoctor.org/docs/user-manual/#taming-svgs[asciidoctor user guide] describes this in more detail.
+|===
+
 ==== AsciiToSVG
 
 [cols=">,<,<",options="header"]
@@ -439,9 +449,9 @@ The attribute name at the block level should be prefixed with the name of the di
 [cols=">,<,<",options="header"]
 |===
 |Name          |Default value |Description
-|fillColor     |white         |The fill color for the text.
-|strokeColor   |black         |The outline color for the text
-|strokeWidth   |2             |The width of the text outline.
+|fill-color    |white         |The fill color for the text.
+|stroke-color  |black         |The outline color for the text
+|stroke-width  |2             |The width of the text outline.
 |font          |Impact        |The font face to use for the text.
 |options       |unspecified   |a comma separate list of flags that modify the image rendering. Currently only `noupcase` is supported which disable upper casing the labels.
 |===
@@ -454,9 +464,9 @@ The attribute name at the block level should be prefixed with the name of the di
 |background      |FFFFFF          |The background colour of the image. The format should be a six-digit hexadecimal number (as in HTML, FF0000 for red). Pass an eight-digit hex to define transparency.
 |css             |unspecified     |Path to a CSS file to pass to mermaid.
 |config          |unspecified     |Path to a JSON config file to pass to mermaid.
-|ganttConfig     |unspecified     |Path to a gantt config file to pass to mermaid.
-|puppeteerConfig |unspecified     |Path to a puppeteer config file to pass to mermaid.
-|sequenceConfig  |unspecified     |Path to a sequence config file to pass to mermaid.
+|gantt-config    |unspecified     |Path to a gantt config file to pass to mermaid.
+|puppeteer-config|unspecified     |Path to a puppeteer config file to pass to mermaid.
+|sequence-config |unspecified     |Path to a sequence config file to pass to mermaid.
 |theme           |unspecified     |Theme of the chart, could be default, forest, dark or neutral.
 |width           |unspecified     |Width of the page.
 |height          |unspecified     |Height of the page.

data/lib/asciidoctor-diagram/diagram_processor.rb

@@ -4,6 +4,7 @@ require 'digest'
 require 'json'
 require 'fileutils'
 require_relative 'diagram_source.rb'
+require_relative 'http/converter'
 require_relative 'version'
 require_relative 'util/java'
 require_relative 'util/gif'
@@ -29,6 +30,8 @@ module Asciidoctor
         host_class.extend(ClassMethods)
       end
 
+      DIAGRAM_PREFIX = 'diagram'
+
       IMAGE_PARAMS = {
           :svg => {
               :encoding => Encoding::UTF_8,
@@ -66,7 +69,7 @@ module Asciidoctor
         supported_formats = converter.supported_formats
 
         begin
-          format = source.attributes.delete('format') || source.attr('format', supported_formats[0], name)
+          format = source.attributes.delete('format') || source.attr('format', nil, name) || source.attr('format', supported_formats[0], DIAGRAM_PREFIX)
           format = format.to_sym if format.respond_to?(:to_sym)
 
           raise "Format undefined" unless format
@@ -78,8 +81,8 @@ module Asciidoctor
           caption = source.attributes.delete 'caption'
 
           case format
-          when :txt
-            block = create_literal_block(parent, source, converter)
+          when :txt, :atxt, :utxt
+            block = create_literal_block(parent, source, format, converter)
           else
             block = create_image_block(parent, source, format, converter)
           end
@@ -88,7 +91,7 @@ module Asciidoctor
           block.assign_caption(caption, 'figure')
           block
         rescue => e
-          case source.attr('on-error', 'log', 'diagram')
+          case source.attr('on-error', 'log', DIAGRAM_PREFIX)
           when 'abort'
             raise e
           else
@@ -158,6 +161,12 @@ module Asciidoctor
         if !File.exist?(image_file) || source.should_process?(image_file, metadata)
           params = IMAGE_PARAMS[format]
 
+          server_url = source.attr('server-url', nil, name) || source.attr('server-url', nil, DIAGRAM_PREFIX)
+          if server_url
+            server_type = source.attr('server-type', nil, name) || source.attr('server-type', 'plantuml', DIAGRAM_PREFIX)
+            converter = HttpConverter.new(server_url, server_type.to_sym, converter)
+          end
+
           options = converter.collect_options(source, name)
           result = converter.convert(source, format, options)
 
@@ -175,7 +184,7 @@ module Asciidoctor
 
         image_attributes['target'] = source.attr('data-uri', nil, true) ? image_file : image_name
         if format == :svg
-          svg_type = source.attr('svg-type', nil, 'diagram')
+          svg_type = source.attr('svg-type', nil, name) || source.attr('svg-type', nil, DIAGRAM_PREFIX)
           image_attributes['opts'] = svg_type if svg_type && svg_type != 'static'
         end
 
@@ -249,12 +258,12 @@ module Asciidoctor
         parent.normalize_system_path(cache_dir, base_dir)
       end
 
-      def create_literal_block(parent, source, converter)
+      def create_literal_block(parent, source, format, converter)
         literal_attributes = source.attributes
         literal_attributes.delete('target')
 
         options = converter.collect_options(source, name)
-        result = converter.convert(source, :txt, options)
+        result = converter.convert(source, format, options)
 
         result.force_encoding(Encoding::UTF_8)
         Asciidoctor::Block.new parent, :literal, :source => result, :attributes => literal_attributes

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

@@ -0,0 +1,79 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+require 'base64'
+require 'net/http'
+require 'uri'
+require 'zlib'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class HttpConverter
+      include DiagramConverter
+
+      def initialize(base_uri, type, converter)
+        @base_uri = base_uri
+        @type = type
+        @converter = converter
+      end
+
+      def supported_formats
+        @converter.supported_formats
+      end
+
+      def collect_options(source, name)
+        {
+            :block_name => name
+        }
+      end
+
+      def convert(source, format, options)
+        code = source.code
+
+        uri = URI(@base_uri)
+
+        case @type
+        when :plantuml
+          deflate = Zlib::Deflate.new(Zlib::BEST_COMPRESSION,
+                                      -Zlib::MAX_WBITS,
+                                      Zlib::MAX_MEM_LEVEL,
+                                      Zlib::DEFAULT_STRATEGY)
+
+          compressed = deflate.deflate(code, Zlib::FINISH)
+          deflate.close
+
+          encoded = Base64.urlsafe_encode64(compressed)
+          data = '0A' + encoded
+
+          path = uri.path
+          path << '/' unless path.end_with? '/'
+          path << format.to_s
+          path << '/' << data
+        when :kroki_io
+          compressed = Zlib.deflate(code, Zlib::BEST_COMPRESSION)
+          data = Base64.urlsafe_encode64(compressed)
+
+          path = uri.path
+          path << '/' unless path.end_with? '/'
+          path << options[:block_name].to_s
+          path << '/' << format.to_s
+          path << '/' << data
+        else
+          raise "Unsupported server type: " + @type
+        end
+
+        Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme.downcase == 'https') do |http|
+          response = http.request_get path
+          case response
+          when Net::HTTPSuccess
+            response.body
+          else
+            response.value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Asciidoctor
       Java.classpath.concat JARS
 
       def supported_formats
-        [:png, :svg, :txt]
+        [:png, :svg, :txt, :atxt, :utxt]
       end
 
       def collect_options(source, name)
@@ -37,8 +37,10 @@ module Asciidoctor
           mime_type = 'image/png'
         when :svg
           mime_type = 'image/svg+xml'
-        when :txt
+        when :txt, :utxt
           mime_type = 'text/plain;charset=utf-8'
+        when :atxt
+          mime_type = 'text/plain;charset=us-ascii'
         else
           raise "Unsupported format: #{format}"
         end

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

@@ -17,7 +17,7 @@ module Asciidoctor
           args << classpath.flatten.map { |jar| ::Asciidoctor::Diagram::Platform.host_os_path(jar).strip }.join(::Asciidoctor::Diagram::Platform.host_os_path_separator)
           args << 'org.asciidoctor.diagram.StdInOutCommandServer'
 
-          @server = IO.popen([java, *args], 'r+')
+          @server = IO.popen([java, *args], 'r+b')
         end
 
         def io

data/lib/asciidoctor-diagram/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-15 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/asciidoctor-diagram/graphviz.rb
 - lib/asciidoctor-diagram/graphviz/converter.rb
 - lib/asciidoctor-diagram/graphviz/extension.rb
+- lib/asciidoctor-diagram/http/converter.rb
 - lib/asciidoctor-diagram/http/server.rb
 - lib/asciidoctor-diagram/lilypond.rb
 - lib/asciidoctor-diagram/lilypond/converter.rb
@@ -222,7 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An extension for asciidoctor that adds support for UML diagram generation