metanorma-plugin-plantuml 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82db5cce760911ac43ad666a3d25e800341ff7b4f591d0905562f2e8bccb99e2
-  data.tar.gz: 170923ac6b7ace25020922e57904417ced9a3ef6d6f311a83be9ce0ab65b281f
+  metadata.gz: 07e9ee8fdf5e99900198be1e8ea51dd948957c62475694b0b40660fd25bff4d2
+  data.tar.gz: c6b49a7ec9b20d96e45c6600f2a368c3b5df542e6ee3bcc3f75ed17dd7d929bc
 SHA512:
-  metadata.gz: 1347f4e1aab08371499c23dd2b39dfdc3aa3371f1db258ffa36ad557513a915e30b70e470df5f37d5766df38ca106dc54cbaad146f09cb135dfa1c41cab5e5f7
-  data.tar.gz: 1bb6c111325ab23cbe83f3c1903701740c31573f1baa80760c03f467559c07111b81ab80fc99afbda6de0445e5dab9e1c4cf58f96fb92e24a8552f7e1946a1d6
+  metadata.gz: f9903747e63488c1af15f954441acbdaaa17c715935b1d0d390d515173f5e052df6defc0828de335e6491e019c69b9fa915365850a91a91155e5d68e3ee60376
+  data.tar.gz: 73e6bac1cfc02b057d52eb39913bfb833f0b70237fb8d00323424ef17a6b5ea302baf57faae486dda1779f0254035a4b449e0abb9648c21ceb18e30a39234778

data/Gemfile

@@ -13,9 +13,11 @@ rescue StandardError
 end
 
 gem "byebug"
+gem "canon"
 gem "debug"
 gem "metanorma"
-gem "metanorma-standoc", github: "metanorma/metanorma-standoc", branch: "feature/extract-plantuml"
+gem "metanorma-standoc", github: "metanorma/metanorma-standoc",
+                         branch: "feature/extract-plantuml"
 gem "rake"
 gem "rspec"
 gem "rspec-html-matchers"
@@ -25,4 +27,3 @@ gem "simplecov"
 gem "timecop"
 gem "vcr"
 gem "webmock"
-gem "canon"

data/Rakefile

@@ -10,7 +10,7 @@ task default: [
 ]
 
 def uri_open(url)
-  require 'open-uri'
+  require "open-uri"
   URI.parse(url).open
 end
 
@@ -29,7 +29,7 @@ file "data/plantuml.jar" do |file|
 end
 
 desc "Download PlantUML JAR file"
-task :download_jar => "data/plantuml.jar"
+task download_jar: "data/plantuml.jar"
 
 desc "Clean downloaded JAR file"
 task :clean_jar do

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

@@ -23,22 +23,26 @@ module Metanorma
             Wrapper.available?
           end
 
-          def generate_file(parent, reader, format_override = nil)
+          def generate_file(parent, reader, format_override = nil) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
             ldir, imagesdir, fmt = generate_file_prep(parent)
             fmt = format_override if format_override
             plantuml_content = prep_source(reader)
 
             # Extract filename from PlantUML source if specified
+            filename = generate_unique_filename(fmt)
             extracted_filename = extract_plantuml_filename(plantuml_content)
 
+            if extracted_filename
+              filename = "#{extracted_filename}.#{fmt}"
+            end
+
             absolute_path, relative_path = path_prep(ldir, imagesdir)
-            filename = extracted_filename ? "#{extracted_filename}.#{fmt}" : generate_unique_filename(fmt)
             output_file = File.join(absolute_path, filename)
 
             result = Wrapper.generate(
               plantuml_content,
               format: fmt,
-              output_file: output_file
+              output_file: output_file,
             )
 
             unless result[:success]
@@ -68,24 +72,32 @@ module Metanorma
           def generate_file_prep(parent)
             ldir = localdir(parent)
             imagesdir = parent.document.attr("imagesdir")
-            fmt = parent.document.attr("plantuml-image-format")&.strip&.downcase || "png"
+            fmt = parent
+              .document.attr("plantuml-image-format")&.strip&.downcase || "png"
             [ldir, imagesdir, fmt]
           end
 
           def localdir(parent)
             ret = Utils.localdir(parent.document)
-            File.writable?(ret) or
-              raise "Destination directory #{ret} not writable for PlantUML!"
-            ret
+            return ret if File.writable?(ret)
+
+            raise "Destination directory #{ret} not writable for PlantUML!"
           end
 
           def path_prep(localdir, imagesdir)
             path = Pathname.new(File.join(localdir, "_plantuml_images"))
             sourcepath = imagesdir ? File.join(localdir, imagesdir) : localdir
             path.mkpath
-            File.writable?(path) or
+
+            unless File.writable?(path)
               raise "Destination path #{path} not writable for PlantUML!"
-            [path, Pathname.new(path).relative_path_from(Pathname.new(sourcepath)).to_s]
+            end
+
+            [
+              path,
+              Pathname.new(path)
+                .relative_path_from(Pathname.new(sourcepath)).to_s,
+            ]
           end
 
           def prep_source(reader)
@@ -106,8 +118,9 @@ module Metanorma
 
           private
 
-          def validate_plantuml_delimiters(src)
-            # Find @start... pattern (case insensitive, support all PlantUML diagram types)
+          def validate_plantuml_delimiters(src) # rubocop:disable Metrics/MethodLength
+            # Find @start... pattern
+            # (case insensitive, support all PlantUML diagram types)
             start_match = src.match(/^@start(\w+)/i)
             unless start_match
               raise "PlantUML content must start with @start... directive!"
@@ -117,14 +130,16 @@ module Metanorma
             end_pattern = "@end#{diagram_type}"
 
             # Look for matching @end... directive (case insensitive)
-            unless src.match(/#{Regexp.escape(end_pattern)}\s*$/mi)
-              raise "@start#{diagram_type} without matching #{end_pattern} in PlantUML!"
+            unless /#{Regexp.escape(end_pattern)}\s*$/mi.match?(src)
+              raise "@start#{diagram_type} without matching #{end_pattern} " \
+                    "in PlantUML!"
             end
           end
 
           def extract_plantuml_filename(plantuml_content)
             # Extract filename from any @start... line if specified
-            # Only match when filename is on the same line as @start... (no newlines)
+            # Only match when filename is on the same line as @start...
+            # (no newlines)
             lines = plantuml_content.lines
             first_line = lines.first&.strip
             return nil unless first_line
@@ -142,11 +157,12 @@ module Metanorma
           def sanitize_filename(filename)
             # Remove quotes and sanitize for filesystem
             filename = filename.gsub(/^["']|["']$/, "")
-            # Replace any non-alphanumeric characters (except dash, underscore, dot) with underscore
+            # Replace any non-alphanumeric characters
+            # (except dash, underscore, dot) with underscore
             filename.gsub(/[^\w\-.]/, "_")
-                    .gsub(/\.{2,}/, "_")  # Replace multiple dots with underscore
-                    .gsub(/_{2,}/, "_")   # Replace multiple underscores with single
-                    .gsub(/^[_\-\.]+|[_\-\.]+$/, "")  # Remove leading/trailing special chars
+              .gsub(/\.{2,}/, "_")  # Replace multiple dots with underscore
+              .gsub(/_{2,}/, "_")   # Replace multiple underscores with single
+              .gsub(/^[_\-.]+|[_\-.]+$/, "") # Remove leading/trailing chars
           end
 
           def generate_unique_filename(format)

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

@@ -20,11 +20,11 @@ module Metanorma
           create_listing_block(
             parent,
             reader.source,
-            (attrs.reject { |k, _v| k.to_s.match?(/^\d+$/) })
+            attrs.reject { |k, _v| k.to_s.match?(/^\d+$/) },
           )
         end
 
-        def process(parent, reader, attrs)
+        def process(parent, reader, attrs) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
           # Check for document-level disable flag
           if parent.document.attr("plantuml-disabled")
             return abort(parent, reader, attrs, "PlantUML processing disabled")
@@ -41,21 +41,21 @@ module Metanorma
           if formats.length == 1
             # Single format - original behavior
             filename = Backend.generate_file(parent, reader, formats.first)
-            through_attrs = Backend.generate_attrs attrs
+            through_attrs = Backend.generate_attrs(attrs)
             through_attrs["target"] = filename
-            create_image_block parent, through_attrs
           else
             # Multiple formats - generate multiple files
-            through_attrs = Backend.generate_multiple_files(parent, reader, formats, attrs)
-            create_image_block parent, through_attrs
+            through_attrs = Backend
+              .generate_multiple_files(parent, reader, formats, attrs)
           end
+          create_image_block parent, through_attrs
         rescue StandardError => e
           abort(parent, reader, attrs, e.message)
         end
 
         private
 
-        def parse_formats(attrs, document)
+        def parse_formats(attrs, document) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
           # Check for formats attribute (multiple formats)
           if attrs["formats"]
             formats = attrs["formats"].split(",").map(&:strip).map(&:downcase)
@@ -69,7 +69,8 @@ module Metanorma
           end
 
           # Fall back to document attribute or default
-          default_format = document.attr("plantuml-image-format")&.strip&.downcase || "png"
+          default_format = document
+            .attr("plantuml-image-format")&.strip&.downcase || "png"
           [default_format]
         end
 

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

@@ -17,7 +17,7 @@ module Metanorma
           options = [
             "-Xss5m",
             "-Xmx#{memory_limit}",
-            "-Djava.awt.headless=true"
+            "-Djava.awt.headless=true",
           ]
 
           if RbConfig::CONFIG["host_os"].match?(/darwin|mac os/)

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

@@ -12,16 +12,21 @@ module Metanorma
 
       class JarNotFoundError < PlantumlError
         def initialize(jar_path = nil)
-          message = jar_path ?
-            "PlantUML JAR file not found at: #{jar_path}" :
-            "PlantUML JAR file not found"
+          message = if jar_path
+                      "PlantUML JAR file not found at: #{jar_path}"
+                    else
+                      "PlantUML JAR file not found"
+                    end
           super(message)
         end
       end
 
       class JavaNotFoundError < PlantumlError
         def initialize
-          super("Java runtime not found. Please ensure Java is installed and available in PATH")
+          super(
+            "Java runtime not found. Please ensure Java is installed and " \
+            "available in PATH",
+          )
         end
       end
 
@@ -34,7 +39,10 @@ module Metanorma
 
       class InvalidFormatError < PlantumlError
         def initialize(format, available_formats)
-          super("Invalid format '#{format}'. Available formats: #{available_formats.join(', ')}")
+          super(
+            "Invalid format '#{format}'. Available formats: " \
+            "#{available_formats.join(', ')}",
+          )
         end
       end
     end

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

@@ -13,14 +13,6 @@ module Metanorma
               document.attributes["docdir"] ||
               File.dirname(document.attributes["docfile"] || ".")
           end
-
-          def relative_file_path(document, file_path)
-            return file_path if Pathname.new(file_path).absolute?
-
-            docdir = document.attributes["docdir"] || Dir.pwd
-            File.expand_path(file_path, docdir)
-          end
-
         end
       end
     end

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

@@ -1,8 +1,8 @@
 module Metanorma
   module Plugin
     module Plantuml
-      VERSION = "1.0.0"
-      PLANTUML_JAR_VERSION = "1.2025.4"
+      VERSION = "1.0.1".freeze
+      PLANTUML_JAR_VERSION = "1.2025.4".freeze
     end
   end
 end

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

@@ -12,11 +12,14 @@ module Metanorma
   module Plugin
     module Plantuml
       class Wrapper
-        PLANTUML_JAR_NAME = "plantuml.jar"
-        PLANTUML_JAR_PATH = File.join(File.dirname(__FILE__), "..", "..", "..", "..", "data", PLANTUML_JAR_NAME)
+        PLANTUML_JAR_NAME = "plantuml.jar".freeze
+        PLANTUML_JAR_PATH = File.join(
+          File.dirname(__FILE__), "..", "..", "..",
+          "..", "data", PLANTUML_JAR_NAME
+        )
 
         SUPPORTED_FORMATS = %w[png svg pdf txt eps].freeze
-        DEFAULT_FORMAT = "png"
+        DEFAULT_FORMAT = "png".freeze
 
         class << self
           def jvm_options
@@ -29,7 +32,12 @@ module Metanorma
             options
           end
 
-          def generate(content, format: DEFAULT_FORMAT, output_file: nil, base64: false, **options)
+          def generate( # rubocop:disable Metrics/MethodLength
+            content,
+            format: DEFAULT_FORMAT,
+            output_file: nil,
+            base64: false, **options
+          )
             validate_format!(format)
             ensure_jar_available!
             ensure_java_available!
@@ -47,27 +55,30 @@ module Metanorma
             { success: false, error: e }
           end
 
-          def generate_from_file(input_file, format: DEFAULT_FORMAT, output_file: nil, base64: false, **options)
+          def generate_from_file(
+            input_file, format: DEFAULT_FORMAT,
+            output_file: nil, base64: false, **options
+          )
             unless File.exist?(input_file)
               raise GenerationError.new("Input file not found: #{input_file}")
             end
 
             content = File.read(input_file)
-            generate(content, format: format, output_file: output_file, base64: base64, **options)
+            generate(content, format: format, output_file: output_file,
+                              base64: base64, **options)
           end
 
           def version
             return nil unless available?
 
-            cmd = [configuration.java_path, *jvm_options, "-jar", PLANTUML_JAR_PATH, "-version"]
-            output, error, status = Open3.capture3(*cmd)
+            cmd = [configuration.java_path, *jvm_options, "-jar",
+                   PLANTUML_JAR_PATH, "-version"]
+            output, _, status = Open3.capture3(*cmd)
 
             if status.success?
               # Extract version from output
               version_match = output.match(/PlantUML version ([\d.]+)/)
               version_match ? version_match[1] : PLANTUML_JAR_VERSION
-            else
-              nil
             end
           rescue StandardError
             nil
@@ -75,6 +86,7 @@ module Metanorma
 
           def available?
             return false if ENV["PLANTUML_DISABLED"] == "true"
+
             File.exist?(PLANTUML_JAR_PATH) && java_available?
           end
 
@@ -122,23 +134,28 @@ module Metanorma
             execute_plantuml(content, format, output_file, options)
 
             unless File.exist?(output_file)
-              raise GenerationError.new("Output file was not created: #{output_file}")
+              raise GenerationError.new(
+                "Output file was not created: #{output_file}",
+              )
             end
 
             { output_path: File.expand_path(output_file) }
           end
 
-          def generate_to_base64(content, format, options)
-            Tempfile.create(['plantuml_output', ".#{format}"]) do |temp_file|
+          def generate_to_base64(content, format, options) # rubocop:disable Metrics/MethodLength
+            Tempfile.create(["plantuml_output", ".#{format}"]) do |temp_file|
               temp_file.close
 
               execute_plantuml(content, format, temp_file.path, options)
 
               unless File.exist?(temp_file.path)
-                raise GenerationError.new("Temporary output file was not created")
+                raise GenerationError.new(
+                  "Temporary output file was not created",
+                )
               end
 
-              encoded_content = Base64.strict_encode64(File.read(temp_file.path))
+              encoded_content = Base64
+                .strict_encode64(File.read(temp_file.path))
               { base64: encoded_content }
             end
           end
@@ -151,26 +168,32 @@ module Metanorma
             generate_to_file(content, format, output_file, options)
           end
 
-          def execute_plantuml(content, format, output_file, options)
-            Tempfile.create(['plantuml_input', '.puml']) do |input_file|
+          def execute_plantuml(content, format, output_file, options) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize, Metrics/MethodLength
+            Tempfile.create(["plantuml_input", ".puml"]) do |input_file| # rubocop:disable Metrics/BlockLength
               input_file.write(content)
               input_file.close
 
-              # PlantUML generates output files based on filename specified in @start... line
+              # PlantUML generates output files based on filename specified in
+              # @start... line
               # We need to use a temp directory and then move the file
-              Dir.mktmpdir do |temp_dir|
+              Dir.mktmpdir do |temp_dir| # rubocop:disable Metrics/BlockLength
                 cmd = build_command(input_file.path, format, temp_dir, options)
 
                 output, error, status = Open3.capture3(*cmd)
 
                 unless status.success?
-                  error_message = error.empty? ? "Unknown PlantUML error" : error.strip
+                  error_message = if error.empty?
+                                    "Unknown PlantUML error"
+                                  else
+                                    error.strip
+                                  end
                   raise GenerationError.new(error_message, error)
                 end
 
                 # Find the generated file and move it to the desired location
                 if output_file
-                  generated_file = find_generated_file(temp_dir, content, format)
+                  generated_file = find_generated_file(temp_dir, content,
+                                                       format)
                   if generated_file && File.exist?(generated_file)
                     FileUtils.mv(generated_file, output_file)
                   else
@@ -178,7 +201,9 @@ module Metanorma
                     generated_files = Dir.glob(File.join(temp_dir, "*"))
                     error_msg = "Generated file not found in temp directory. "
                     error_msg += "Expected: #{generated_file}. "
-                    error_msg += "Found files: #{generated_files.map { |f| File.basename(f) }.join(', ')}"
+                    error_msg += "Found files: #{generated_files.map do |f|
+                      File.basename(f)
+                    end.join(', ')}"
                     raise GenerationError.new(error_msg)
                   end
                 end
@@ -188,8 +213,9 @@ module Metanorma
             end
           end
 
-          def find_generated_file(temp_dir, content, format)
-            # PlantUML generates files based on the filename specified in @start... line
+          def find_generated_file(temp_dir, content, format) # rubocop:disable Metrics/MethodLength
+            # PlantUML generates files based on the filename specified in
+            # @start... line
             extension = format.to_s.downcase
 
             # First, try to extract filename from PlantUML content
@@ -197,17 +223,19 @@ module Metanorma
 
             if plantuml_filename
               # Look for file with PlantUML-specified name
-              generated_file = File.join(temp_dir, "#{plantuml_filename}.#{extension}")
+              generated_file = File.join(temp_dir,
+                                         "#{plantuml_filename}.#{extension}")
               return generated_file if File.exist?(generated_file)
             end
 
-            # Fallback: scan directory for any generated files with correct extension
+            # Fallback: scan directory for any generated files with
+            # the correct extension
             Dir.glob(File.join(temp_dir, "*.#{extension}")).first
           end
 
           def extract_plantuml_filename_from_content(content)
             # Extract the raw filename from @start... line (don't sanitize)
-            match = content.match(/^@start\w+\s+(.+)$/mi)
+            match = content.match(/^@start\w+\s+(.{1,999})$/mi)
             return nil unless match
 
             filename = match[1].strip.split("\n").first&.strip
@@ -217,7 +245,7 @@ module Metanorma
             filename.gsub(/^["']|["']$/, "")
           end
 
-          def build_command(input_file, format, output_dir, options)
+          def build_command(input_file, format, output_dir, _options) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
             cmd = [
               configuration.java_path,
               *jvm_options,
@@ -225,17 +253,9 @@ module Metanorma
             ]
 
             # Add format-specific options
-            case format.to_s.downcase
-            when "png"
-              cmd << "-tpng"
-            when "svg"
-              cmd << "-tsvg"
-            when "pdf"
-              cmd << "-tpdf"
-            when "txt"
-              cmd << "-ttxt"
-            when "eps"
-              cmd << "-teps"
+            format_str = format.to_s.downcase
+            if SUPPORTED_FORMATS.include?(format_str)
+              cmd << "-t#{format_str}"
             end
 
             # Add output directory option

data/lib/metanorma-plugin-plantuml.rb

@@ -1,4 +1,3 @@
-
 module Metanorma
   module Plugin
     module Plantuml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-plantuml
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor