asciidoctor-diagram 2.2.6 → 2.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3f3bffc76f761832b6e762e2dca5dc6cbfb026a452284b7841daaf4575c66c3
-  data.tar.gz: 70fa27583dfd7190bd3c7fffee3320ea5b2ac5240757bab8bbb5940146714229
+  metadata.gz: 6d16a4ceac53c9b8aa223e3b22a061ee0c92cc6876b24522c224530f7559c6d9
+  data.tar.gz: 86d434f86830db71ea4369b2e1e08d05b0ca8d6ed8f3ed4927c90cb5458f0154
 SHA512:
-  metadata.gz: 6a847622189aefde984b76476839f63fd6c05746ed9bd4b6a84f8d72a63ac0b105525399381db4074f3288ce5db807fc3569adf61971a46ac31e28f051b376b8
-  data.tar.gz: 62d9c498b3c566353f6510b243b2fb262070dde468f19fbf6eaf9f2f436d00d62c0df32a84089b20e86a87c047feab56236310ab211a532381ed6abe8e2d4dd0
+  metadata.gz: d365c1149d8b2d7ce00a0aecdf0d40435518aeda247448adb4bfe81bc7b4c9cefe69477c3c3a6e3cb1fcbd703dc7efe2ad4e519d49aa4f32a10a51ecf523eaab
+  data.tar.gz: 567f9ba04c8bb97e09e6e2d70bfde26cd51700777257a5dd8a7a683ce101f6b0341f00d6729d12116400b620f38d5f4b3bea1113623641989c9d44a26110c04b

data/CHANGELOG.adoc

@@ -1,5 +1,11 @@
 = Asciidoctor-diagram Changelog
 
+== 2.2.7
+
+Enhancements::
+
+* Issue #407: Add https://d2lang.com[D2] support
+
 == 2.2.6
 
 Enhancements::

data/docs/modules/ROOT/partials/advanced.adoc

@@ -74,6 +74,7 @@ The following table lists the tools that are required for each diagram type, the
    |bpmn         |{uri-bpmn}[bpmn-js-cmd]                                               |`bpmn`
    |bytefield    |{uri-bytefield}[bytefield-svg]                                        |`bytefield-svg`
    |diagrams     |{uri-python}[Python]                                                  |`diagrams-python`
+   |D2           |{uri-d2}[D2]                                                          |`d2`
    |ditaa        |{uri-java}[Java]                                                      |`java`
    |dpic         |{uri-dpic}[dpic]                                                      |`dpic`
    |erd          |{uri-erd}[Erd] or {uri-erd-go}[Erd Go]                                |`erd`
@@ -234,6 +235,21 @@ If the maximum size is exceeded, POST requests are used instead
 |width        |1024            |The target width of the diagram. Does not apply for output type `svg`.
 |===
 
+==== D2
+
+[cols=">,<,<",options="header"]
+|===
+|Name            |Default value                 |Description
+|layout          |dagre                         |Set the diagram layout engine
+|theme           |0                             |Set the diagram theme ID
+|pad             |100                           |Pixels padded around the rendered diagram
+|animate-interval|                              |If given, multiple boards are packaged as 1 SVG which transitions through each board at the interval (in milliseconds). Can only be used with SVG exports.
+|sketch          |false                         |Renders the diagram to look like it was sketched by hand
+|font-regular    |Source Sans Pro Regular       |Path to .ttf file to use for the regular font
+|font-italic     |Source Sans Pro Regular-Italic|Path to .ttf file to use for the italic font
+|font-bol        |Source Sans Pro Bold          |Path to .ttf file to use for the bold font
+|===
+
 ==== Diagrams
 
 No specific attributes.

data/docs/modules/ROOT/partials/create_diagram.adoc

@@ -27,6 +27,7 @@ The following diagram types and output formats are available:
 |{uri-blockdiag}[blockdiag]        |       |{check}|{check}|{check}|
 |{uri-bpmn}[bpmn]                  |       |{check}|{check}|{check}|
 |{uri-bytefield}[bytefield]        |       |       |       |{check}|
+|{uri-d2}[D2]                      |       |{check}|{check}|{check}|
 |{uri-diagrams}[diagrams]          |       |{check}|{check}|{check}|
 |{uri-ditaa}[ditaa]                |       |       |{check}|{check}|{check}
 |{uri-dpic}[dpic]                  |       |       |       |{check}|

data/docs/modules/ROOT/partials/uris.adoc

@@ -5,6 +5,7 @@
 :uri-blockdiag: http://blockdiag.com
 :uri-bpmn: https://github.com/gtudan/bpmn-js-cmd
 :uri-bytefield: https://github.com/Deep-Symmetry/bytefield-svg
+:uri-d2: https://d2lang.com
 :uri-diagrams: https://diagrams.mingrammer.com
 :uri-ditaa: http://ditaa.sourceforge.net/
 :uri-dpic: https://gitlab.com/aplevich/dpic

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

@@ -0,0 +1,49 @@
+require_relative '../diagram_converter'
+require_relative '../util/cli_generator'
+require_relative '../util/platform'
+
+module Asciidoctor
+  module Diagram
+    # @private
+    class D2Converter
+      include DiagramConverter
+      include CliGenerator
+
+      def supported_formats
+        [:svg, :png, :pdf]
+      end
+
+      def collect_options(source)
+        {
+          :layout => source.attr('layout'),
+          :theme => source.attr('theme'),
+          :pad => source.attr('pad'),
+          :animate_interval => source.attr('animate-interval'),
+          :sketch => source.attr('sketch'),
+          :font_regular => source.attr('font-regular'),
+          :font_italic => source.attr('font-italic'),
+          :font_bold => source.attr('font-bold')
+        }.delete_if { |key, value| value.nil? }
+      end
+
+      def convert(source, format, options)
+        generate_file(source.find_command('d2'), "d2", format.to_s, source.code) do |tool_path, input_path, output_path|
+          args = [tool_path, '--browser', 'false']
+
+          options.each_pair do |key, value|
+            args << "--#{key.to_s.gsub('_', '-')}"
+
+            if key.to_s.start_with?('font')
+              args << Platform.native_path(value)
+            else
+              args << value
+            end
+          end
+
+          args << Platform.native_path(input_path)
+          args << Platform.native_path(output_path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'converter'
+require_relative '../diagram_processor'
+
+module Asciidoctor
+  module Diagram
+    class D2BlockProcessor < DiagramBlockProcessor
+      use_converter D2Converter
+    end
+
+    class D2BlockMacroProcessor < DiagramBlockMacroProcessor
+      use_converter D2Converter
+    end
+
+    class D2InlineMacroProcessor < DiagramInlineMacroProcessor
+      use_converter D2Converter
+    end
+  end
+end

data/lib/asciidoctor-diagram/d2.rb

@@ -0,0 +1,8 @@
+require 'asciidoctor/extensions'
+require_relative 'd2/extension'
+
+Asciidoctor::Extensions.register do
+  block Asciidoctor::Diagram::D2BlockProcessor, :d2
+  block_macro Asciidoctor::Diagram::D2BlockMacroProcessor, :d2
+  inline_macro Asciidoctor::Diagram::D2InlineMacroProcessor, :d2
+end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.6"
+    VERSION = "2.2.7"
   end
 end

data/lib/asciidoctor-diagram.rb

@@ -3,6 +3,7 @@ require_relative 'asciidoctor-diagram/barcode'
 require_relative 'asciidoctor-diagram/blockdiag'
 require_relative 'asciidoctor-diagram/bpmn'
 require_relative 'asciidoctor-diagram/bytefield'
+require_relative 'asciidoctor-diagram/d2'
 require_relative 'asciidoctor-diagram/diagrams'
 require_relative 'asciidoctor-diagram/ditaa'
 require_relative 'asciidoctor-diagram/dpic'

data/spec/d2_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'test_helper'
+
+D2_CODE = <<-eos
+# Actors
+hans: Hans Niemann
+
+defendants: {
+  mc: Magnus Carlsen
+  playmagnus: Play Magnus Group
+  chesscom: Chess.com
+  naka: Hikaru Nakamura
+
+  mc -> playmagnus: Owns majority
+  playmagnus <-> chesscom: Merger talks
+  chesscom -> naka: Sponsoring
+}
+
+# Accusations
+hans -> defendants: 'sueing for $100M'
+
+# Offense
+defendants.naka -> hans: Accused of cheating on his stream
+defendants.mc -> hans: Lost then withdrew with accusations
+defendants.chesscom -> hans: 72 page report of cheating
+eos
+
+describe Asciidoctor::Diagram::D2InlineMacroProcessor, :broken_on_windows do
+  include_examples "inline_macro", :d2, D2_CODE, [:svg]
+end
+
+describe Asciidoctor::Diagram::D2BlockMacroProcessor, :broken_on_windows do
+  include_examples "block_macro", :d2, D2_CODE, [:svg]
+end
+
+describe Asciidoctor::Diagram::D2BlockProcessor, :broken_on_windows do
+  include_examples "block", :d2, D2_CODE, [:svg]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.2.7
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,9 @@ files:
 - lib/asciidoctor-diagram/bytefield.rb
 - lib/asciidoctor-diagram/bytefield/converter.rb
 - lib/asciidoctor-diagram/bytefield/extension.rb
+- lib/asciidoctor-diagram/d2.rb
+- lib/asciidoctor-diagram/d2/converter.rb
+- lib/asciidoctor-diagram/d2/extension.rb
 - lib/asciidoctor-diagram/diagram_converter.rb
 - lib/asciidoctor-diagram/diagram_processor.rb
 - lib/asciidoctor-diagram/diagram_source.rb
@@ -252,6 +255,7 @@ files:
 - spec/blockdiag_spec.rb
 - spec/bpmn_spec.rb
 - spec/bytefield_spec.rb
+- spec/d2_spec.rb
 - spec/diagrams_spec.rb
 - spec/ditaa_spec.rb
 - spec/dpic_spec.rb
@@ -309,6 +313,7 @@ test_files:
 - spec/blockdiag_spec.rb
 - spec/bpmn_spec.rb
 - spec/bytefield_spec.rb
+- spec/d2_spec.rb
 - spec/diagrams_spec.rb
 - spec/ditaa_spec.rb
 - spec/dpic_spec.rb