asciidoctor-diagram 2.2.14 → 2.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2447be8f4a47717d6ef4856ed210cbf44eaa09cd0ae154bb64119f3e309384d
-  data.tar.gz: 8e40700cddd6d026c7ae4cd7cfafdf22704e01b4941eba2d274db91e103d700e
+  metadata.gz: 23e0718c877d72f84af027588bb5a9d100dda3568b34e89655f26c7cf7a4eb07
+  data.tar.gz: a4ecd6791f531cb9654651ae982e7e52406a462075814a78106188729388f45e
 SHA512:
-  metadata.gz: 2e4c640aaa5ce31f00f94a10398d9ab9a29eca0a97359073645a82cd777ec860ad2a90ebc5ed549e65186a88d3e1c43a9f39250c1d2b6ba2745f31d4b3dd3679
-  data.tar.gz: 9f54def1db4fd022b510a46daf33328b4854fb0d1dd7d3ba4bbc5a5dc1c966e4a37f548fdaa82c626024fdb31bdbf62218e1edbb1e8bdf1a7bf43fbf10116567
+  metadata.gz: 5982bee6e194b651cac1b55af22fb0cc7ccc51341e952f08f70c978efbf2a58d1392f2095607e574ab3078bc4c3b4c9b2424f75c0420f2bad7f8e033c45b52ee
+  data.tar.gz: 402707bbd842e2ec8fcf3da65ee60287d08dcbb0f5b0610313ca05985899c03d06a1199aab25632b06239df57d83408f7be73b53981653aaaa49c4f4884df4b8

data/CHANGELOG.adoc

@@ -1,5 +1,28 @@
 = Asciidoctor-diagram Changelog
 
+== 2.2.17
+
+Bugfixes::
+
+* Issue #455: Fix regression in reading of UTF-8 source files introduced in 2.2.15
+
+== 2.2.16
+
+Bugfixes::
+
+* Issue #453: Avoid internal error when WaveDrom cannot be located
+
+== 2.2.15
+
+Enhacements::
+
+* Issue #453: Improve error message when WaveDrom cannot be located
+
+Bugfixes::
+
+* Issue #428: Improve support for reading UTF-16 encoded source files
+* Issue #449: Fix resolving of relative `!include` paths in Structurizr DSL input.
+
 == 2.2.14
 
 Bugfixes::

data/README.adoc

@@ -23,16 +23,16 @@ The example below shows an embedded Ditaa diagram block.
 ---------
 [ditaa]
 ----
-              +-------------+
-              | asciidoctor |-----------+
-              |  diagram    |           |
-              +-------------+           | image
-                    ^                   |
-                    | diagram source    |
-                    |                   v
- +--------+   +-----+-------+    /---------------\
- |  adoc  |-->+ asciidoctor +    | HTML + image  |
- +--------+   +-------------+    \---------------/
+                  +-------------+
+                  | asciidoctor |---------------+
+                  |  diagram    |               |
+                  +-------------+               | image
+                         ^                      |
+                         | diagram source       |
+                         |                      v
+ +--------+       +------+------+        /--------------\
+ |  adoc  |------>+ asciidoctor +------->| HTML + image |
+ +--------+       +-------------+  html  \--------------/
 ----
 ---------
 

data/lib/asciidoctor-diagram/diagram_source.rb

@@ -138,9 +138,10 @@ module Asciidoctor
 
           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
+
+        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
 
         cmd_path
@@ -305,8 +306,7 @@ module Asciidoctor
 
       def load_code
         if @file_name
-          lines = File.readlines(@file_name)
-          lines = prepare_source_array(lines)
+          lines = prepare_source_array(File.read(@file_name, :mode => 'rb'))
           @parent_block.apply_subs(lines, resolve_diagram_subs).join("\n")
         else
           ''
@@ -315,39 +315,33 @@ module Asciidoctor
 
       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]
+      # Raw binary strings for UTF-* Byte Order Marks
+      BOM_BYTES_UTF_8 = String.new("\xef\xbb\xbf", :encoding => Encoding::ASCII_8BIT)
+      BOM_BYTES_UTF_16LE = String.new("\xff\xfe", :encoding => Encoding::ASCII_8BIT)
+      BOM_BYTES_UTF_16BE = String.new("\xfe\xff", :encoding => Encoding::ASCII_8BIT)
 
-      # Prepare the source data Array for parsing.
+      # Prepare the source data for parsing.
       #
-      # Encodes the data to UTF-8, if necessary, and removes any trailing
+      # Encodes the data to UTF-8 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)
+      # data - the source data to prepare
       #
       # 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}
+
+        if data.start_with?(BOM_BYTES_UTF_16LE)
+          utf8_data = data.byteslice(2, data.bytesize).encode(::Encoding::UTF_8, ::Encoding::UTF_16LE)
+        elsif data.start_with?(BOM_BYTES_UTF_16BE)
+          utf8_data = data.byteslice(2, data.bytesize).encode(::Encoding::UTF_8, ::Encoding::UTF_16BE)
+        elsif data.start_with?(BOM_BYTES_UTF_8)
+          utf8_data = data.byteslice(3, data.bytesize).force_encoding(::Encoding::UTF_8)
         else
-          data.map {|line| (line.encode ::Encoding::UTF_8).rstrip}
+          utf8_data = data.force_encoding(::Encoding::UTF_8)
         end
+
+        utf8_data.lines.map {|line| line.rstrip}
       end
     end
   end

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

@@ -49,6 +49,8 @@ module Asciidoctor
           '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',

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.14"
+    VERSION = "2.2.17"
   end
 end

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

@@ -9,48 +9,53 @@ module Asciidoctor
       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|
+        wavedrom = source.find_command('wavedrom-cli', :attrs => ['wavedrom'], :raise_on_error => false)
+
+        unless wavedrom
+          wavedrom = source.find_command('wavedrom', :raise_on_error => false)
+        end
+
+        unless wavedrom
+          if ::Asciidoctor::Diagram::Platform.os == :macosx
+            wavedrom = source.find_command('WaveDromEditor.app', :alt_cmds => ['wavedrom-editor.app'], :attrs => ['WaveDromEditorApp'], :path => ['/Applications'], :raise_on_error => false)
+            if wavedrom
+              wavedrom = File.join(wavedrom, 'Contents/MacOS/nwjs')
+            end
+          else
+            wavedrom = source.find_command('WaveDromEditor', :raise_on_error => false)
+          end
+        end
+
+        unless wavedrom
+          source.find_command('wavedrom-cli', :attrs => ['wavedrom'])
+        end
+
+        if wavedrom.end_with?('-cli')
+          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
             {
               :args => [Platform.native_path(tool_path), '--input', Platform.native_path(input_path), "--#{format.to_s}", Platform.native_path(output_path)],
               :chdir => source.base_dir
             }
           end
+        elsif wavedrom.include?('WaveDromEditor')
+          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+            {
+              :args => [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)],
+              :chdir => source.base_dir
+            }
+          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|
-              {
-                :args => [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)],
-                :chdir => source.base_dir
-              }
-            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|
-              {
-                :args => [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)],
-                :chdir => source.base_dir
-              }
-            end
+          phantomjs = source.find_command('phantomjs', :alt_attrs => ['phantomjs_2'])
+          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+            {
+              :args => [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)],
+              :chdir => source.base_dir
+            }
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.2.14
+  version: 2.2.17
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-20 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,7 +211,7 @@ files:
 - lib/asciidoctor-diagram/structurizr/converter.rb
 - lib/asciidoctor-diagram/structurizr/extension.rb
 - lib/asciidoctor-diagram/structurizr/renderers.rb
-- lib/asciidoctor-diagram/structurizr/structurizr-2.0.3.jar
+- lib/asciidoctor-diagram/structurizr/structurizr-2.0.5.jar
 - lib/asciidoctor-diagram/svgbob.rb
 - lib/asciidoctor-diagram/svgbob/converter.rb
 - lib/asciidoctor-diagram/svgbob/extension.rb