asciidoctor-diagram 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c2f34fcc568a14ae6c72579b4a9e8ef429cbc1b023ae9c20945084a212ad844
-  data.tar.gz: 7a11bdd3d63d22c3e472671b9a3e74ea3945edf80757350aaf6bfde690a9c392
+  metadata.gz: 0c7b68569773e4811496a15d962840a88567ec7e7890d91d38a38c742477c24b
+  data.tar.gz: 7f7f72e9433adbbc0ee21537db7d96b5469b22979b9f82930d97d4a70614e6a4
 SHA512:
-  metadata.gz: ec745e7abc74b9ab114922de70fcc2fe01cd367cb60b1d47e90ee28ce120c7082400fa7d7176c2b0c9f47ea0a643a19dde64861d63460920b19e4157ff1aa706
-  data.tar.gz: 9bc01b94478a69b8782e5fe7c3ffffa95cc9dbdbbc5092f64f3dfc340f84bdc65d0cb62c72445fbb3dbcce12befe2f4d6011782542ade71681e2a9636393872d
+  metadata.gz: b9b65b14640274daf2a670f44330d261a2712df4d3ee696cd4a0fe8df395258716d2213d9d8de143117e67b1d66750b8bb5c8c892888e6477c1171a81ac53904
+  data.tar.gz: 96cc74fbfa0649906618089719b3d204f6d6127b0b81c648b6ae7f86279df54a0cdd23533a74bc898ea84ecb2653a626d58a0b82078f39710d47108c3f2a0d0c

data/CHANGELOG.adoc

@@ -4,6 +4,12 @@
 
 Enhancements::
 
+* Issue #399: Add support for PlantUML theme attribute
+
+== 2.2.3
+
+Enhancements::
+
 * Issue #373: Add support for rendering Ditaa diagrams via PlantUML using ditaamini
 * Issue #383: Allow bullet characters for Ditaa to be overridden
 

data/docs/modules/ROOT/pages/index.adoc

@@ -5,7 +5,7 @@ include::partial$uris.adoc[]
 
 Asciidoctor Diagram is a set of Asciidoctor extensions that enable you to add diagrams, which you describe using plain text, to your AsciiDoc document.
 
-The extensions supports the {uri-a2s}[AsciiToSVG], BlockDiag ({uri-blockdiag}[BlockDiag], {uri-seqdiag}[SeqDiag], {uri-actdiag}[ActDiag], {uri-nwdiag}[NwDiag]), {uri-bytefield}[Bytefield-SVG], {uri-ditaa}[Ditaa], {uri-dpic}[dpic], {uri-erd}[Erd], {uri-gnuplot}[Gnuplot], {uri-dot}[GraphViz], {uri-mermaid}[Mermaid], {uri-mscgen}[Msc], {uri-nomnoml}[Nomnoml], {uri-pikchr}[Pikchr], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-smcat}[State Machine Cat], {uri-svgbob}[SvgBob], {uri-symbolator}[Symbolator], {uri-syntrax}[Syntrax] / {uri-jsyntrax}[JSyntrax], {uri-umlet}[UMLet], {uri-vega}[Vega], {uri-vegalite}[Vega-Lite] and {uri-wavedrom}[WaveDrom] syntax.
+The extensions support the {uri-a2s}[AsciiToSVG], BlockDiag ({uri-blockdiag}[BlockDiag], {uri-seqdiag}[SeqDiag], {uri-actdiag}[ActDiag], {uri-nwdiag}[NwDiag]), {uri-bytefield}[Bytefield-SVG], {uri-ditaa}[Ditaa], {uri-dpic}[dpic], {uri-erd}[Erd], {uri-gnuplot}[Gnuplot], {uri-dot}[GraphViz], {uri-mermaid}[Mermaid], {uri-mscgen}[Msc], {uri-nomnoml}[Nomnoml], {uri-pikchr}[Pikchr], {uri-plantuml}[PlantUML], {uri-shaape}[Shaape], {uri-smcat}[State Machine Cat], {uri-svgbob}[SvgBob], {uri-symbolator}[Symbolator], {uri-syntrax}[Syntrax] / {uri-jsyntrax}[JSyntrax], {uri-umlet}[UMLet], {uri-vega}[Vega], {uri-vegalite}[Vega-Lite] and {uri-wavedrom}[WaveDrom] syntax.
 
 Each extension runs the diagram processor to generate an SVG, PNG, or TXT file from the input text.
 The generated file is then inserted into your converted document.
@@ -18,4 +18,4 @@ include::partial$create_diagram.adoc[]
 
 include::partial$generate.adoc[]
 
-include::partial$advanced.adoc[]
+include::partial$advanced.adoc[]

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

@@ -20,7 +20,7 @@ require 'asciidoctor-diagram/<extension_name>'
 
 Requiring one or more of these files will automatically register the extensions for all processed documents.
 
-If you need more fine grained control over when the extensions are enabled, `asciidoctor-diagram/<extension_name>/extension` can be used instead.
+If you need more fine-grained control over when the extensions are enabled, `asciidoctor-diagram/<extension_name>/extension` can be used instead.
 This loads the extensions but does not register it in the Asciidoctor extension registry.
 You can then manually register the extensions at the appropriate times using the `Asciidoctor::Extensions` API.
 
@@ -54,13 +54,13 @@ When Asciidoctor Diagram writes images to disk it will go over the following opt
 The image generation also outputs metadata files that by default are located in `.asciidoctor/diagram`.
 To place them in different location, Asciidoctor Diagram checks for (in this order).
 
-. `\{cachedir\}` attribute is specified  in the block header (ie. `[plantuml, png, cachedir=my-cache]`)
+. `\{cachedir\}` attribute is specified  in the block header (i.e. `[plantuml, png, cachedir=my-cache]`)
 . `\{diagram-cachedir\}` if the `diagram-cachedir` attribute has been specified
 . `\{outdir\}/\{imagesdir\}`
 
 === Specifying Diagram Generator Paths
 
-Asciidoctor Diagram depends on external tools to generates images.
+Asciidoctor Diagram depends on external tools to generate images.
 In most cases it will locate these tools automatically for you by looking for specific executables in each directory in the `PATH` environment variable.
 In case you've installed a tool in a way where the executable is not in the `PATH`, you can override its location manually using document attributes.
 The following table lists the tools that are required for each diagram type, the location where they can be downloaded and the document attribute you can use to override their locations.
@@ -110,7 +110,7 @@ If for instance you installed `actdiag` in `/home/me/actdiag/bin` and this path
 === The Meme Extension
 
 The meme extension provides a basic '`Advice Animal`' style image generator.
-It's usage is easiest to explain with an example.
+Its usage is easiest to explain with an example.
 
 ----
 meme::yunoguy.jpg[Doc writers,Y U NO // AsciiDoc]
@@ -144,7 +144,7 @@ Barcode macros can be specified using blocks, inline macros or block macros usin
 <2> Barcode attributes (see the <<barcode_attributes>> attributes section)
 <3> The content to encode in the barcode
 
-By default the `content` field of the barcode macros will be interpreted as the barcode content.
+By default, the `content` field of the barcode macros will be interpreted as the barcode content.
 This works fine for simple barcodes, but for complex data (e.g., a vCard encoded as a QR code) this is not practical.
 If the `external` attribute is set on a barcode macro, the target is interpreted as a file path.
 The barcode content will then be obtained by reading the contents of the referenced file.
@@ -320,6 +320,7 @@ No specific attributes.
 |===
 |Name            |Default value   |Description
 |config          |unspecified     |Path to a config file to pass to PlantUML.
+|theme           |unspecified     |PlantUML theme to use.
 |size-limit      |4096            |The maximum dimensions (width and height) of generated diagrams.
 |includedir      |unspecified     |sets a common directory for puml includes (plantuml.include.path)
 |preprocess      |true            |Preprocess PlantUML code before rendering the diagram.

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

@@ -20,6 +20,26 @@ module Asciidoctor
         raise "background attribute is required" unless bg_img
 
         options = source.attr('options', '').split(',')
+        margin = source.attr('margin', '')
+        margin_parts = margin.split(' ')
+        case margin_parts.length
+          when 0
+            ml = mr = mt = mb = nil
+          when 1
+            ml = mr = mt = mb = margin_parts[0]
+          when 2
+            mt = mb = margin_parts[0]
+            ml = mr = margin_parts[1]
+          when 3
+            mt = margin_parts[0]
+            ml = mr = margin_parts[1]
+            mb = margin_parts[2]
+          else
+            mt = margin_parts[0]
+            mr = margin_parts[1]
+            mb = margin_parts[2]
+            ml = margin_parts[3]
+        end
 
         {
             :bg_img => bg_img,
@@ -29,6 +49,12 @@ module Asciidoctor
             :stroke_color => source.attr(['strokecolor', 'stroke-color']),
             :stroke_width => source.attr(['strokewidth', 'stroke-width']),
             :font => source.attr('font', 'Impact'),
+            :font_size => source.attr('font_size', nil),
+            :alignment => source.attr('alignment', nil),
+            :margin_left => ml,
+            :margin_right => mr,
+            :margin_top => mt,
+            :margin_bottom => mb,
             :noupcase => options.include?('noupcase'),
         }
       end

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

@@ -25,7 +25,7 @@ module Asciidoctor
       Java.classpath.concat PLANTUML_JARS
 
       def wrap_source(source)
-        PlantUMLPreprocessedSource.new(source, self.class.tag)
+        PlantUMLPreprocessedSource.new(source, self)
       end
 
       def supported_formats
@@ -33,9 +33,42 @@ module Asciidoctor
       end
 
       def collect_options(source)
-        {
+        options = {
             :size_limit => source.attr('size-limit', '4096')
         }
+
+        theme = source.attr('theme', nil)
+        options[:theme] = theme if theme
+
+        options
+      end
+
+      def should_preprocess(source)
+        source.attr('preprocess', 'true') == 'true'
+      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(source, format, options)
@@ -60,11 +93,13 @@ module Asciidoctor
             '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
           headers['X-Graphviz'] = ::Asciidoctor::Diagram::Platform.host_os_path(dot)
@@ -97,9 +132,9 @@ module Asciidoctor
     end
 
     class PlantUMLPreprocessedSource < SimpleDelegator
-      def initialize(source, tag)
+      def initialize(source, converter)
         super(source)
-        @tag = tag
+        @converter = converter
       end
 
       def code
@@ -111,24 +146,13 @@ module Asciidoctor
 
         code = __getobj__.code
 
-        code = "@start#{@tag}\n#{code}\n@end#{@tag}" unless code.index("@start") && code.index("@end")
-
-        should_preprocess = attr('preprocess', 'true') == 'true'
+        tag = @converter.class.tag
+        code = "@start#{tag}\n#{code}\n@end#{tag}" unless code.index("@start") && code.index("@end")
 
-        if should_preprocess
+        if @converter.should_preprocess(self)
           headers = {}
-
-          config_file = attr('plantumlconfig', nil, true) || 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 = attr('includedir')
-          if include_dir
-            headers['X-PlantUML-IncludeDir'] = Platform.native_path(File.expand_path(include_dir, base_dir))
-          end
+          @converter.add_common_headers(headers, self)
+          @converter.add_theme_header(headers, @converter.collect_options(self)[:theme])
 
           response = Java.send_request(
             :url => '/plantumlpreprocessor',

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

@@ -28,8 +28,10 @@ module Asciidoctor
 
         viewbox = root.attributes['viewBox']
         if (v = VIEWBOX_REGEX.match(viewbox)) && width.nil? && height.nil?
-          width = to_numeric(v[:width])
-          height = to_numeric(v[:height])
+          min_x = to_numeric(v[:min_x])
+          min_y = to_numeric(v[:min_y])
+          width ||= to_numeric(v[:width]) - min_x
+          height ||= to_numeric(v[:height]) - min_y
         end
 
         if viewbox.nil? && width && height
@@ -76,7 +78,7 @@ module Asciidoctor
       end
 
       WIDTH_HEIGHT_REGEX = /^\s*(?<value>\d+(?:\.\d+)?)\s*(?<unit>[a-zA-Z]+)?\s*$/
-      VIEWBOX_REGEX = /^\s*\d+(?:\.\d+)?\s*\d+(?:\.\d+)?\s*(?<width>\d+(?:\.\d+)?)\s*(?<height>\d+(?:\.\d+)?)\s*$/
+      VIEWBOX_REGEX = /^\s*(?<min_x>-?\d+(?:\.\d+)?)\s*(?<min_y>-?\d+(?:\.\d+)?)\s*(?<width>\d+(?:\.\d+)?)\s*(?<height>\d+(?:\.\d+)?)\s*$/
 
       def self.to_px_factor(unit)
         case unit

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "2.2.3"
+    VERSION = "2.2.4"
   end
 end

data/spec/plantuml_spec.rb

@@ -253,6 +253,34 @@ skinparam ArrowColor #DEADBE
     expect(svg).to match(/<[^<]+ fill=["']#DEADBE["']/)
   end
 
+  it 'should use plantuml theme when specified as a document attribute' do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+:plantuml-format: svg
+:plantuml-theme: spacelab
+
+== First Section
+
+[plantuml]
+----
+actor Foo1
+boundary Foo2
+Foo1 -> Foo2 : To boundary
+----
+    eos
+
+    d = load_asciidoc doc
+    b = d.find { |bl| bl.context == :image }
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(File.exist?(target)).to be true
+
+    svg = File.read(target, :encoding => Encoding::UTF_8)
+    expect(svg).to match(/<[^<]+ fill=["']url\(#gvl9ibi66ipfc0\)["']/)
+  end
+
   it 'should use plantuml include dir when specified as a document attribute' do
     doc = <<-eos
 = Hello, PlantUML!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-21 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,7 +204,7 @@ files:
 - lib/asciidoctor-diagram/plantuml.rb
 - lib/asciidoctor-diagram/plantuml/converter.rb
 - lib/asciidoctor-diagram/plantuml/extension.rb
-- lib/asciidoctor-diagram/plantuml/plantuml-1.3.21.jar
+- lib/asciidoctor-diagram/plantuml/plantuml-1.3.22.jar
 - lib/asciidoctor-diagram/salt.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/converter.rb
@@ -282,7 +282,7 @@ homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -297,8 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A family of Asciidoctor extensions that generate images from a broad range
   of embedded plain text diagram descriptions, including PlantUML, ditaa, Kroki, and