asciidoctor-diagram 1.5.12 → 1.5.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5913cbd36fd3b829ac50411bfa45bf67077c8ac2
-  data.tar.gz: fc549589f2920e44418d44befc61ea469dd831bc
+  metadata.gz: ffc1f6fe55704de14ad37b6d54292decde729e9b
+  data.tar.gz: e8e81c21b5918ba8337ff5340382cbe9a311ca37
 SHA512:
-  metadata.gz: 59573e38cc1ab7ea78ac87169857c43b88b29c1430175ae63a64f5828d0ce600d43c5f7684223fa413789db5120a4b33cb4511da24e145249e2db410b8652c58
-  data.tar.gz: fac3eab000034f0d4b5df6e549a4bb678d50dee313abf4ce01b99246461e0530bd5bb043b39b84c6db559628756357e68f8ca8c78b5d226ed2161c2e799b7ba1
+  metadata.gz: a2426b51df51fa6d625c4a2c2345f3157b0c8eac5cd5683d52680f2908326a2aa385483bdda8780321af7ee96276ae1dcdfb087ca3ed8859aaa7b47df9630389
+  data.tar.gz: 772a8642bda51b9abfba2044fa9d27d5296e5e13dd6d8e4ed7b9298dc4ee93f53e7eb18c94c04e295a407736e97b89465dcccfeaf8428d8884201150f1d414ef

data/CHANGELOG.adoc

@@ -1,5 +1,11 @@
 = Asciidoctor-diagram Changelog
 
+== 1.5.13
+
+Bug Fixes::
+
+  * Issue #212: Fix regression introduced by fix for #201 in 1.5.12
+
 == 1.5.12
 
 Bug Fixes::

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

@@ -0,0 +1,55 @@
+require_relative '../util/java'
+
+module Asciidoctor
+  module Diagram
+    module DitaaConverter
+      OPTIONS = {
+        'scale' => ->(o, v) { o << '--scale' << v if v  },
+        'tabs' => ->(o, v) { o << '--tabs' << v if v },
+        'background' => ->(o, v) { o << '--background' << v if v },
+        'antialias' => ->(o, v) { o << '--no-antialias' if v == 'false' },
+        'separation' => ->(o, v) { o << '--no-separation' if v == 'false' },
+        'round-corners' => ->(o, v) { o << '--round-corners' if v == 'true' },
+        'shadows' => ->(o, v) { o << '--no-shadows' if v == 'false' },
+        'debug' => ->(o, v) {o << '--debug' if v == 'true' },
+        'fixed-slope' => ->(o, v) { o << '--fixed-slope' if v == 'true' },
+        'transparent' => ->(o, v) { o << '--transparent' if v == 'true' }
+      }.freeze
+
+      JARS = %w[ditaa-1.3.13.jar ditaamini-0.11.jar].map do |jar|
+        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
+      end
+      Java.classpath.concat JARS
+
+      def self.convert(source, opts)
+        Java.load
+        headers = {
+          Accept: opts['mime_type'],
+          'X-Options' =>  to_header_options(opts)
+        }
+        send_request(source, headers)
+      end
+
+      def self.to_header_options opts
+        options = []
+        OPTIONS.keys.each do |key|
+          value = opts[key]
+          OPTIONS[key].call(options, value)
+        end
+        options.join(' ')
+      end
+
+      def self.send_request(body, headers, url = '/ditaa')
+        response = Java.send_request(
+          url:  url,
+          body: body,
+          headers: headers
+        )
+        unless response[:code] == 200
+          raise Java.create_error("Ditaa image generation failed", response)
+        end
+        response[:body]
+      end
+    end
+  end
+end

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

@@ -1,29 +1,12 @@
 require 'set'
 
 require_relative '../extensions'
-require_relative '../util/java'
+require_relative 'converter'
 
 module Asciidoctor
   module Diagram
-    # @private
     module Ditaa
-      OPTIONS = {
-          'scale' => lambda { |o, v| o << '--scale' << v if v },
-          'tabs' => lambda { |o, v| o << '--tabs' << v if v },
-          'background' => lambda { |o, v| o << '--background' << v if v },
-          'antialias' => lambda { |o, v| o << '--no-antialias' if v == 'false' },
-          'separation' => lambda { |o, v| o  << '--no-separation' if v == 'false'},
-          'round-corners' => lambda { |o, v| o  << '--round-corners' if v == 'true'},
-          'shadows' => lambda { |o, v| o  << '--no-shadows' if v == 'false'},
-          'debug' => lambda { |o, v| o  << '--debug' if v == 'true'},
-          'fixed-slope' => lambda { |o, v| o  << '--fixed-slope' if v == 'true'},
-          'transparent' => lambda { |o, v| o  << '--transparent' if v == 'true'}
-      }
-
-      JARS = ['ditaa-1.3.13.jar', 'ditaamini-0.11.jar'].map do |jar|
-        File.expand_path File.join('../..', jar), File.dirname(__FILE__)
-      end
-      Java.classpath.concat JARS
+      OPTION_KEYS = DitaaConverter::OPTIONS.keys
 
       def self.included(mod)
         mod.register_format(:png, :image) do |parent, source|
@@ -36,35 +19,14 @@ module Asciidoctor
       end
 
       def ditaa(parent, source, mime_type)
-        Java.load
-
         global_attributes = parent.document.attributes
-
-        options = []
-
-        OPTIONS.keys.each do |key|
+        opts = {}
+        opts['mime_type'] = mime_type
+        OPTION_KEYS.each do |key|
           value = source.attributes.delete(key) || global_attributes["ditaa-option-#{key}"]
-          OPTIONS[key].call(options, value)
+          opts[key] = value if value
         end
-
-        options_string = options.join(' ')
-
-        headers = {
-            'Accept' => mime_type,
-            'X-Options' => options_string
-        }
-
-        response = Java.send_request(
-            :url => '/ditaa',
-            :body => source.to_s,
-            :headers => headers
-        )
-
-        unless response[:code] == 200
-          raise Java.create_error("Ditaa image generation failed", response)
-        end
-
-        response[:body]
+        DitaaConverter.convert(source.to_s, opts)
       end
     end
 

data/lib/asciidoctor-diagram/extensions.rb

@@ -282,7 +282,7 @@ module Asciidoctor
           end
 
           if document.nested? && value.nil?
-            doc_option(docuemnt.parent_document, key)
+            doc_option(document.parent_document, key)
           else
             value
           end
@@ -510,12 +510,49 @@ module Asciidoctor
         def read_code
           if @file_name
             lines = File.readlines(@file_name)
-            lines = ::Asciidoctor::Helpers.normalize_lines(lines)
+            lines = prepare_source_array(lines)
             @parent_block.apply_subs(lines, resolve_diagram_subs).join("\n")
           else
             ''
           end
         end
+
+        private
+
+        # Byte arrays for UTF-* Byte Order Marks
+        BOM_BYTES_UTF_8 = [0xef, 0xbb, 0xbf]
+        BOM_BYTES_UTF_16LE = [0xff, 0xfe]
+        BOM_BYTES_UTF_16BE = [0xfe, 0xff]
+
+        # Prepare the source data Array for parsing.
+        #
+        # Encodes the data to UTF-8, if necessary, and removes any trailing
+        # whitespace from every line.
+        #
+        # If a BOM is found at the beginning of the data, a best attempt is made to
+        # encode it to UTF-8 from the specified source encoding.
+        #
+        # data - the source data Array to prepare (no nil entries allowed)
+        #
+        # returns a String Array of prepared lines
+        def prepare_source_array data
+          return [] if data.empty?
+          if (leading_2_bytes = (leading_bytes = (first = data[0]).unpack 'C3').slice 0, 2) == BOM_BYTES_UTF_16LE
+            data[0] = first.byteslice 2, first.bytesize
+            # NOTE you can't split a UTF-16LE string using .lines when encoding is UTF-8; doing so will cause this line to fail
+            return data.map {|line| (line.encode ::Encoding::UTF_8, ::Encoding::UTF_16LE).rstrip }
+          elsif leading_2_bytes == BOM_BYTES_UTF_16BE
+            data[0] = first.byteslice 2, first.bytesize
+            return data.map {|line| (line.encode ::Encoding::UTF_8, ::Encoding::UTF_16BE).rstrip }
+          elsif leading_bytes == BOM_BYTES_UTF_8
+            data[0] = first.byteslice 3, first.bytesize
+          end
+          if first.encoding == ::Encoding::UTF_8
+            data.map {|line| line.rstrip }
+          else
+            data.map {|line| (line.encode ::Encoding::UTF_8).rstrip }
+          end
+        end
       end
     end
   end

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

@@ -3,6 +3,9 @@ module Asciidoctor
     # @private
     module Cli
       if RUBY_PLATFORM == "java"
+        # Workaround for https://github.com/jruby/jruby/issues/5565
+        #   Kernel.spawn (and as a consequence Open3.capture3 which uses it)
+        #   is not reliable on all versions of JRuby.
         require_relative 'java'
 
         def self.run(*args)

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.12"
+    VERSION = "1.5.13"
   end
 end

data/spec/plantuml_spec.rb

@@ -532,6 +532,60 @@ Foo1 -> Foo2 : To boundary
     expect(File.exist?(File.expand_path(target, 'foo'))).to be true
   end
 
+  it 'should write files to to_dir if set' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="svg"]
+----
+actor Foo1
+boundary Foo2
+Foo1 -> Foo2 : To boundary
+----
+    eos
+
+    d = load_asciidoc doc, {:to_dir => 'foo'}
+    b = d.find { |bl| bl.context == :image }
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(File.exist?(target)).to be false
+    expect(File.exist?(File.expand_path(target, 'foo'))).to be true
+  end
+
+  it 'should write files to to_dir if set when embedded in table' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+|===
+|Type | Example
+
+|graphviz
+a|
+[plantuml, format="svg"]
+----
+actor Foo1
+boundary Foo2
+Foo1 -> Foo2 : To boundary
+----
+|===
+    eos
+
+    d = load_asciidoc doc, {:to_dir => 'foo'}
+    b = d.find { |bl| bl.context == :image }
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(File.exist?(target)).to be false
+    expect(File.exist?(File.expand_path(target, 'foo'))).to be true
+  end
+
   it 'should write files to imagesoutdir if set' do
     doc = <<-eos
 = Hello, PlantUML!

data/spec/test_helper.rb

@@ -40,6 +40,22 @@ module Asciidoctor
       nil
     end
   end
+
+  class Table
+    def find(&block)
+      rows.by_section.each do |section, rows|
+        rows.each do |row|
+          row.each do |cell|
+            inner_doc = cell.inner_document
+            if !inner_doc.nil? && found_block = cell.inner_document.find(&block)
+              return found_block
+            end
+          end
+        end
+      end
+      nil
+    end
+  end
 end
 
 module Asciidoctor

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.5.12
+  version: 1.5.13
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-20 00:00:00.000000000 Z
+date: 2019-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - lib/asciidoctor-diagram/blockdiag.rb
 - lib/asciidoctor-diagram/blockdiag/extension.rb
 - lib/asciidoctor-diagram/ditaa.rb
+- lib/asciidoctor-diagram/ditaa/converter.rb
 - lib/asciidoctor-diagram/ditaa/extension.rb
 - lib/asciidoctor-diagram/erd.rb
 - lib/asciidoctor-diagram/erd/extension.rb