metanorma-plugin-plantuml 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16e8bf4ddf357ba4f08740382237313dd48cbee2fcfca80601c2f1a578f2d902
-  data.tar.gz: 2480aedc5cafcdc41d20a52766bf65b4ce39418def0cd660b0147ff335c0b13d
+  metadata.gz: 231d4ad0a53b48775c54c4920f7a9b55eff8853809e79597af91980065ea21ae
+  data.tar.gz: 5dcdb1e04b32ca5e3f22577b395953b26872a2cc5620c961838833eb6192e2c1
 SHA512:
-  metadata.gz: f9217b009f4ba58ef78d676073d80606723e03010950d9ec0128b3e0f0ebbeb444e99883fcd9dd5b5fbec1047829dd4ccd790dcd27f091482c5d3072ebb5d449
-  data.tar.gz: ea90a7d62d74ac7aaa3facba46e8d8950a934e185f9a541cc76c600e7fccf9ad3a0d166e1bac4cd5838fab532a014f28f42dc42c8e1ccef0f9c2f27ceab27d1b
+  metadata.gz: 3568b612e0fca38d1645fb19807bf345abaf955342e81fdee15a874c29295fce91c14b2d47e943e706ba8922d9f31da364b21daf0483154d3f85d66bb1677b44
+  data.tar.gz: 810dab27b571e16623bfff0cd36b7cdc4fa643fe2592a3b87cdb5568296df45fa60746595c19c99c1e7afdb53f17a071e92a595f9aa7d3fc218bd9180a632263

data/.gitignore

@@ -0,0 +1,41 @@
+# Ignore bundler config
+/.bundle/
+
+# Ignore all logfiles and tempfiles
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore vendor directory
+/vendor/
+
+# Ignore Gemfile.lock (for gems)
+/Gemfile.lock
+
+# Ignore pkg directory
+/pkg/
+
+# Ignore OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Ignore IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Ignore test coverage
+/coverage/
+/.simplecov
+
+# Ignore local development files
+.env
+.env.local

data/README.adoc

@@ -89,6 +89,7 @@ Generally, the command syntax is more suitable for referencing external PlantUML
 files.
 
 
+[[command-syntax]]
 === Command syntax for external diagrams
 
 PlantUML diagrams can be directly referenced from external files using the
@@ -104,7 +105,7 @@ plantuml_image::{plantuml-source.puml}[{options}]
 Where,
 
 `{plantuml-source.puml}`:: Path to the PlantUML source file, relative to the
-path of the current file.
+path of the document root file.
 
 `{options}`:: (Optional) Comma-separated list of options to customize diagram
 generation.
@@ -140,6 +141,35 @@ The file `foo/bar.puml` is the same as above.
 The `format=svg` option specifies the output format as SVG.
 ====
 
+The path to the PlantUML source file is relative to the document root file,
+which is illustrated in the following example.
+
+.PlantUML source file path is relative to document root
+[example]
+====
+Given the following directory structure:
+
+[source]
+----
+dir/
+dir/sources/document.adoc
+dir/sources/sections/section_1.adoc
+dir/sources/plantuml/my_diagram.puml
+----
+
+Where:
+
+* `document.adoc` includes `sections/section_1.adoc`
+* `section_1.adoc` contains the `plantuml_image` command.
+
+The path to the PlantUML source file in `section_1.adoc` is specified relative
+to `document.adoc`, the document root, which is `plantuml/my_diagram.puml`:
+
+[source,asciidoc]
+----
+plantuml_image::plantuml/my_diagram.puml[]
+----
+====
 
 
 === Block syntax for inline diagrams
@@ -452,6 +482,15 @@ Syntax:
 :plantuml-includedirs: {path1};{path2};...
 ----
 
+Where,
+
+`{path1}`, `{path2}`, etc.:: paths to directories (relative to document root)
+containing PlantUML files to be included, delimited by semicolons.
++
+NOTE: All paths passed to `includedirs` must be relative to the document root
+file, see <<command-syntax>> on how to determine the document root.
+
+
 .Resolving PlantUML includes with document-level `includedirs` attribute
 [example]
 ====

data/lib/metanorma/plugin/plantuml/backend.rb

@@ -112,8 +112,15 @@ module Metanorma
                     reader.source
                   else
                     # get content from ImageBlockMacroProcessor
-                    docdir = parent.document.attributes["docdir"]
-                    File.read(File.join(docdir, reader))
+                    docfile_directory = File.dirname(
+                      parent.document.attributes["docfile"] || ".",
+                    )
+
+                    resolved_path = parent.document
+                      .path_resolver
+                      .system_path(reader, docfile_directory)
+
+                    File.read(resolved_path)
                   end
 
             # Validate that we have matching start/end pairs

data/lib/metanorma/plugin/plantuml/image_block_macro_processor.rb

@@ -33,7 +33,9 @@ module Metanorma
 
         def add_image_path_to_includedirs(document, image_path, includedirs)
           docdir = document.attributes["docdir"]
-          includedirs << File.dirname(File.join(docdir, image_path))
+          includedirs << File.dirname(
+            document.path_resolver.system_path(image_path, docdir),
+          )
           includedirs.compact.uniq
         end
 

data/lib/metanorma/plugin/plantuml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Plantuml
-      VERSION = "1.0.5".freeze
+      VERSION = "1.0.7".freeze
       PLANTUML_JAR_VERSION = "1.2025.7".freeze
     end
   end

data/lib/metanorma/plugin/plantuml/wrapper.rb

@@ -14,8 +14,8 @@ module Metanorma
       class Wrapper
         PLANTUML_JAR_NAME = "plantuml.jar".freeze
         PLANTUML_JAR_PATH = File.join(
-          File.dirname(__FILE__), "..", "..", "..",
-          "..", "data", PLANTUML_JAR_NAME
+          Gem::Specification.find_by_name("metanorma-plugin-plantuml").gem_dir,
+          "data", PLANTUML_JAR_NAME
         )
 
         SUPPORTED_FORMATS = %w[png svg pdf txt eps].freeze
@@ -213,7 +213,9 @@ module Metanorma
                   # find local include file in includedirs
                   found_include_file = nil
                   options[:includedirs].each do |includedir|
-                    include_file_path = File.join(includedir, include_file)
+                    include_file_path = Pathname.new(includedir)
+                      .join(include_file).to_s
+
                     if File.exist?(include_file_path)
                       found_include_file = include_file_path
                       break
@@ -222,7 +224,9 @@ module Metanorma
 
                   if found_include_file
                     # create include file in temp directory
-                    temp_include_file = File.join(temp_dir, include_file)
+                    temp_include_file = Pathname.new(temp_dir)
+                      .join(include_file).to_s
+
                     FileUtils.mkdir_p(File.dirname(temp_include_file))
 
                     File.open(temp_include_file, "w") do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.7
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-10 00:00:00.000000000 Z
+date: 2025-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -48,6 +48,7 @@ files:
 - ".github/workflows/plantuml-version-sync.yml"
 - ".github/workflows/rake.yml"
 - ".github/workflows/release.yml"
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.adoc