vectory 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29078da81dfd3def401e196f9c13654a5b2ccc4eefed851c261796cca0e8e9d2
-  data.tar.gz: 602ba638f3ff426687d778c87d4f93bde391cd7aaaa565902374bede727e0bd5
+  metadata.gz: fc294acc45e36e018340d14a047047d5addc5c712fabc42fec2642b82bc77aa8
+  data.tar.gz: '09b35052e8b019a2553eaa34ae14c6fce0344c5fc8d0e61b42fc4bb574bbe569'
 SHA512:
-  metadata.gz: 32c32817c07c2578914427b923f82f97cbfd71249d11d10c07dcab6ad051d647679bd7cffdcaf6b104a6bd928dc8fe71bba32e686ebb00d1fa2c2b3758b93cd0
-  data.tar.gz: 3636e536af14c71d4efd99136c0408528412a20b7e50e12efd33147d8c7e5bea1bb70128c35af71b9b439febd2ab3636c29a58984e04b49ecb146c292891180e
+  metadata.gz: ffb21fcdc31b15763547be90085ec49288588c7fabc9d9a2f803f5a0fcf5f958c3bf020e7f5aa96abeb2d31de2c1077e6cb9b9fa57b108e28355328e2fa64eb3
+  data.tar.gz: 989f2bb3ade3b0416571b67d7cf8262def78291e9730ee73050052ecc3fa84639be2f93d21af392fc7f7b2a0eb3be3aedd19afe7628598aa60f01afcd4d4f5ae

data/.github/workflows/rake.yml

@@ -15,5 +15,7 @@ permissions:
 jobs:
   rake:
     uses: metanorma/ci/.github/workflows/inkscape-rake.yml@main
+    with:
+      private-fonts: 'false'
     secrets:
       pat_token: ${{ secrets.CLARICLE_CI_PAT_TOKEN }}

data/Gemfile

@@ -6,6 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "canon", "~> 0.1.7"
+gem "connection_pool", "~> 2.0"
 gem "openssl", "~> 3.0"
 gem "rake"
 gem "rspec"

data/README.adoc

@@ -169,15 +169,49 @@ Vectory::Eps.from_path("img.eps").to_uri.content
 ==== SVG mapping (for the metanorma project)
 
 Vectory can integrate SVG files into XML or HTML, respecting internal id and
-link references:
+link references. It supports ID disambiguation for multi-document and multi-svgmap
+scenarios.
+
+===== Basic usage
 
 [source,ruby]
 ----
 xml_string = Vectory::SvgMapping.from_path("doc.xml").to_xml
 ----
 
-In order to do that an initial XML should support the `svgmap` tag with links
-mapping. For example, it can convert XML like this:
+===== ID suffixing for uniqueness
+
+When processing multiple documents or multiple svgmaps within a document,
+SVG IDs must be unique to avoid conflicts. Vectory applies two types of suffixes:
+
+*ID suffix* (Cross-document uniqueness)::
+An optional suffix derived from document or container identity (e.g., `_ISO_17301-1_2016`).
+This provides uniqueness across documents or collections.
+
+*Index suffix* (Multi-svgmap uniqueness)::
+Automatically applied based on the svgmap's position in the document (0, 1, 2, ...).
+Formatted as a 9-digit zero-padded number (e.g., `_000000000`, `_000000001`).
+This provides uniqueness when a document contains multiple svgmaps.
+
+.Final ID composition
+[source]
+----
+Original ID:  fig1
+With ID suffix only:  fig1_ISO_17301-1_2016
+With both suffixes:   fig1_ISO_17301-1_2016_000000000
+----
+
+===== Usage with ID suffix
+
+[source,ruby]
+----
+mapping = Vectory::SvgMapping.new(doc, "", id_suffix: "_ISO_17301-1_2016")
+xml_string = mapping.call.to_xml
+----
+
+===== Input format
+
+The input XML must support the `svgmap` tag with link mapping.
 
 [source,xml]
 ----
@@ -187,8 +221,8 @@ mapping. For example, it can convert XML like this:
     <xref target="ref1">Computer</xref>
   </target>
   <target href="http://www.example.com">
-    <link target="http://www.example.com">Phone</link><
-  /target>
+    <link target="http://www.example.com">Phone</link>
+  </target>
 </svgmap>
 ----
 
@@ -196,16 +230,12 @@ mapping. For example, it can convert XML like this:
 [source,xml]
 ----
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 25.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 595.28 841.89" style="enable-background:new 0 0 595.28 841.89;" xml:space="preserve">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
   <style type="text/css">
-          #Layer_1 { fill:none }
-          svg[id = 'Layer_1'] { fill:none }
+    #Layer_1 { fill:none }
+    svg[id = 'Layer_1'] { fill:none }
     .st0{fill:none;stroke:#000000;stroke-miterlimit:10;}
   </style>
-  <image style="overflow:visible;" width="368" height="315" xlink:href="data:image/gif;base64,R0lG..ommited to save space" transform="matrix(1 0 0 1 114 263.8898)">
-  </image>
   <a xlink:href="mn://action_schema" xlink:dummy="Layer_1">
     <rect x="123.28" y="273.93" class="st0" width="88.05" height="41.84"/>
   </a>
@@ -218,15 +248,14 @@ mapping. For example, it can convert XML like this:
 </svg>
 ----
 
-into XML containing inline SVG tags. Notice changes in the `id` attributes and
-the `a` tags:
+===== Output format
 
 [source,xml]
 ----
 <figure>
-  <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' version='1.1' id='Layer_1_000000001' x='0px' y='0px' viewBox='0 0 595.28 841.89' style='enable-background:new 0 0 595.28 841.89;' xml:space='preserve'>
-    <style> ..ommited to save space </style>
-    <image> ..ommited </image>
+  <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' version='1.1'
+       id='Layer_1_000000001' x='0px' y='0px' viewBox='0 0 595.28 841.89'>
+    <style> #Layer_1_000000001 { fill:none }</style>
     <a xlink:href='#ref1' xlink:dummy='Layer_1_000000001'>
       <rect x='123.28' y='273.93' class='st0' width='88.05' height='41.84'/>
     </a>
@@ -240,53 +269,39 @@ the `a` tags:
 </figure>
 ----
 
-It also supports SVG in a form of an inline tag:
+===== Inline SVG support
+
+SVG can also be provided inline within the svgmap:
 
 [source,xml]
 ----
 <svgmap id="_60dadf08-48d4-4164-845c-b4e293e00abd">
   <figure>
-    <svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' version='1.1' id='Layer_1' x='0px' y='0px' viewBox='0 0 595.28 841.89' style='enable-background:new 0 0 595.28 841.89;' xml:space='preserve'>
-      <a href="mn://action_schema" >
-        <rect x="123.28" y="273.93" class="st0" width="88.05" height="41.84"/>
-      </a>
-      <a href="mn://basic_attribute_schema" >
-        <rect x="324.69" y="450.52" class="st0" width="132.62" height="40.75"/>
-      </a>
-      <a xlink:href="mn://support_resource_schema" >
-        <rect x="324.69" y="528.36" class="st0" width="148.16" height="40.75"/>
+    <svg xmlns='http://www.w3.org/2000/svg' id='Layer_1'>
+      <a href="mn://action_schema">
+        <rect x="123.28" y="273.93" class="st0"/>
       </a>
     </svg>
   </figure>
   <target href="mn://action_schema">
     <xref target="ref1">Computer</xref>
   </target>
-  <target href="http://www.example.com">
-    <link target="http://www.example.com">Phone</link>
-  </target>
 </svgmap>
 ----
 
-and datauri:
+===== Data URI support
+
+Images can be provided as data URIs:
 
 [source,xml]
 ----
 <svgmap id="_60dadf08-48d4-4164-845c-b4e293e00abd">
   <figure>
-    <image src='data:image/svg+xml;base64,PD94..ommited to save space' id='__ISO_17301-1_2016' mimetype='image/svg+xml' height='auto' width='auto' alt='Workmap1'/>
+    <image src='data:image/svg+xml;base64,PD94...'/>
   </figure>
   <target href="href1.htm">
     <xref target="ref1">Computer</xref>
   </target>
-  <target href="mn://basic_attribute_schema">
-    <link target="http://www.example.com">Phone</link>
-  </target>
-  <target href="mn://support_resource_schema">
-    <eref type="express" bibitemid="express_action_schema" citeas="">
-      <localityStack><locality type="anchor"><referenceFrom>action_schema.basic</referenceFrom></locality></localityStack>
-      Coffee
-    </eref>
-  </target>
 </svgmap>
 ----
 
@@ -355,7 +370,7 @@ Vector#width
 
 == Development
 
-=== Regenerating Test Fixtures
+=== Regenerating test fixtures
 
 Some test fixtures are generated by external tools (Ghostscript, Inkscape, cairo).
 When these tools are updated, the reference files may need to be regenerated.

data/docs/reference/api.adoc

@@ -339,7 +339,7 @@ rescue Vectory::ConversionError => e
 end
 ----
 
-=== Dimension Query
+=== Dimension query
 
 [source,ruby]
 ----
@@ -348,7 +348,89 @@ width, height = eps.dimensions
 puts "Dimensions: #{width}x#{height}"
 ----
 
-## See Also
+== SVG mapping
+
+Integrates SVG content into XML documents with ID disambiguation for multi-document scenarios.
+
+=== Vectory::SvgMapping
+
+Processes XML documents containing `<svgmap>` elements, extracting and integrating SVG content.
+
+[source,ruby]
+----
+# Basic usage
+xml_string = Vectory::SvgMapping.from_path("doc.xml").to_xml
+
+# With ID suffix for cross-document uniqueness
+mapping = Vectory::SvgMapping.new(doc, "", id_suffix: "_ISO_17301-1_2016")
+xml_string = mapping.call.to_xml
+----
+
+**Factory methods**:
+
+* `Vectory::SvgMapping.from_path(path)` - Load from file path
+* `Vectory::SvgMapping.from_xml(xml)` - Load from XML string
+* `Vectory::SvgMapping.new(doc, local_directory, id_suffix: nil)` - Direct instantiation
+
+**Parameters**:
+
+* `doc` - Nokogiri XML Document containing svgmap elements
+* `local_directory` - Directory for resolving relative file paths
+* `id_suffix` - Optional suffix for cross-document ID uniqueness (e.g., "_ISO_17301-1_2016")
+
+**Methods**:
+
+* `#call` - Process all svgmap elements, returns processed document
+* `#to_xml` - Process and return XML string
+
+=== Vectory::SvgDocument
+
+Represents an SVG document and handles ID suffixing for uniqueness.
+
+[source,ruby]
+----
+# Create from SVG content
+svg_doc = Vectory::SvgDocument.new(svg_content)
+
+# Apply both ID suffix and index suffix
+svg_doc.namespace(index, links, xpath_to_remove, id_suffix: "_ISO_17301-1_2016")
+result = svg_doc.content
+----
+
+**Constructor**:
+
+* `Vectory::SvgDocument.new(content)` - Create from SVG XML string
+
+**Methods**:
+
+* `namespace(index_suffix, links, xpath_to_remove, id_suffix: nil)` - Apply transformations
+** `index_suffix` - Position-based suffix (0, 1, 2...) formatted as 9-digit zero-padded
+** `links` - Hash mapping hrefs to targets
+** `xpath_to_remove` - XPath for elements to remove (processing instructions)
+** `id_suffix` - Optional identity-based suffix for cross-document uniqueness
+
+* `content` - Returns processed SVG as XML string
+* `remap_links(map)` - Remap internal links
+* `apply_id_suffix(id_suffix)` - Apply ID suffix
+* `apply_index_suffix(index)` - Apply index suffix
+
+=== ID Suffixing
+
+SVG IDs are suffixed in two stages:
+
+[source]
+----
+# Stage 1: ID suffix (cross-document uniqueness)
+fig1 → fig1_ISO_17301-1_2016
+
+# Stage 2: Index suffix (multi-svgmap uniqueness)
+fig1_ISO_17301-1_2016 → fig1_ISO_17301-1_2016_000000000
+----
+
+* **ID suffix** (`id_suffix` parameter): Derived from document/container identity. Optional.
+* **Index suffix** (`index_suffix` parameter): Zero-padded position (0, 1, 2... → _000000000, _000000001). Automatically applied.
+
+== See Also
 
 * link:../guides/error-handling/[Error Handling Guide] - Common errors and solutions
 * link:../understanding/architecture/[Architecture] - Design patterns

data/lib/vectory/cli.rb

@@ -1,6 +1,5 @@
 require "thor"
-require_relative "../vectory"
-require_relative "file_magic"
+require "vectory"
 
 module Vectory
   class CLI < Thor

data/lib/vectory/conversion/ghostscript_strategy.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../ghostscript_wrapper"
-require_relative "strategy"
-
 module Vectory
   module Conversion
     # Ghostscript-based conversion strategy

data/lib/vectory/conversion/inkscape_strategy.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../inkscape_wrapper"
-require_relative "strategy"
-
 module Vectory
   module Conversion
     # Inkscape-based conversion strategy

data/lib/vectory/conversion.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "conversion/strategy"
-require_relative "conversion/inkscape_strategy"
-require_relative "conversion/ghostscript_strategy"
-
 module Vectory
   # Conversion module provides strategy-based conversion interface
   #
@@ -16,6 +12,10 @@ module Vectory
   # @example Get available strategies for a conversion
   #   Vectory::Conversion.strategies_for(:svg, :eps)
   module Conversion
+    # Autoload strategy classes
+    autoload :Strategy, "vectory/conversion/strategy"
+    autoload :InkscapeStrategy, "vectory/conversion/inkscape_strategy"
+    autoload :GhostscriptStrategy, "vectory/conversion/ghostscript_strategy"
     class << self
       # Convert content from one format to another
       #

data/lib/vectory/eps.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "ghostscript_wrapper"
-require_relative "pdf"
-
 module Vectory
   class Eps < Vector
     def self.default_extension

data/lib/vectory/ghostscript_wrapper.rb

@@ -2,18 +2,18 @@
 
 require "tempfile"
 require "fileutils"
-require_relative "errors"
-require_relative "system_call"
-require_relative "platform"
+require "ukiryu"
 
 module Vectory
   # GhostscriptWrapper converts PS and EPS files to PDF using Ghostscript
+  #
+  # Uses Ukiryu for platform-adaptive command execution.
   class GhostscriptWrapper
     SUPPORTED_INPUT_FORMATS = %w[ps eps].freeze
 
     class << self
       def available?
-        ghostscript_path
+        ghostscript_tool
         true
       rescue GhostscriptNotFoundError
         false
@@ -22,9 +22,8 @@ module Vectory
       def version
         return nil unless available?
 
-        cmd = [ghostscript_path, "--version"]
-        call = SystemCall.new(cmd).call
-        call.stdout.strip
+        tool = ghostscript_tool
+        tool.version
       rescue StandardError
         nil
       end
@@ -49,15 +48,22 @@ module Vectory
           # Close output file so GhostScript can write to it
           output_file.close
 
-          cmd = build_command(input_file.path, output_file.path,
-                              eps_crop: eps_crop)
+          # Get the tool and execute
+          tool = ghostscript_tool
+          params = build_convert_params(input_file.path, output_file.path,
+                                        eps_crop: eps_crop)
 
-          call = nil
-          begin
-            call = SystemCall.new(cmd).call
-          rescue SystemCallError => e
+          result = tool.execute(:convert,
+                                execution_timeout: Configuration.instance.timeout,
+                                **params)
+
+          unless result.success?
             raise ConversionError,
-                  "GhostScript conversion failed: #{e.message}"
+                  "GhostScript conversion failed. " \
+                  "Command: #{result.command}, " \
+                  "Exit status: #{result.status}, " \
+                  "stdout: '#{result.stdout.strip}', " \
+                  "stderr: '#{result.stderr.strip}'"
           end
 
           unless File.exist?(output_file.path)
@@ -71,9 +77,9 @@ module Vectory
           if output_content.size < 100
             raise ConversionError,
                   "GhostScript created invalid PDF (#{output_content.size} bytes). " \
-                  "Command: #{cmd.join(' ')}, " \
-                  "stdout: '#{call&.stdout&.strip}', " \
-                  "stderr: '#{call&.stderr&.strip}'"
+                  "Command: #{result.command}, " \
+                  "stdout: '#{result.stdout.strip}', " \
+                  "stderr: '#{result.stderr.strip}'"
           end
 
           output_content
@@ -86,74 +92,91 @@ module Vectory
         end
       end
 
-      private
+      # Convert PDF content to PostScript
+      #
+      # This is useful as a fallback when Inkscape's PDF import fails.
+      # Ghostscript can reliably convert PDF to EPS, and Inkscape can then
+      # import the EPS file.
+      #
+      # @param pdf_content [String] the PDF content to convert
+      # @return [String] the EPS content
+      # @raise [Vectory::ConversionError] if conversion fails
+      # @raise [Vectory::GhostscriptNotFoundError] if Ghostscript is not available
+      def pdf_to_eps(pdf_content)
+        raise GhostscriptNotFoundError unless available?
+
+        input_file = Tempfile.new(["pdf_input", ".pdf"])
+        output_file = Tempfile.new(["eps_output", ".eps"])
+
+        begin
+          input_file.binmode
+          input_file.write(pdf_content)
+          input_file.flush
+          input_file.close
+          output_file.close
 
-      def ghostscript_path
-        # First try common installation paths specific to each platform
-        if Platform.windows?
-          # Check common Windows installation directories first
-          common_windows_paths = [
-            "C:/Program Files/gs/gs*/bin/gswin64c.exe",
-            "C:/Program Files (x86)/gs/gs*/bin/gswin32c.exe",
-          ]
-
-          common_windows_paths.each do |pattern|
-            Dir.glob(pattern).sort.reverse.each do |path|
-              return path if File.executable?(path)
-            end
+          tool = ghostscript_tool
+          params = {
+            inputs: [input_file.path],
+            device: :eps2write,
+            output: output_file.path,
+            batch: true,
+            no_pause: true,
+            quiet: true,
+          }
+
+          result = tool.execute(:convert,
+                                execution_timeout: Configuration.instance.timeout,
+                                **params)
+
+          unless result.success?
+            raise ConversionError,
+                  "GhostScript PDF to EPS conversion failed. " \
+                  "Command: #{result.command}, " \
+                  "Exit status: #{result.status}, " \
+                  "stdout: '#{result.stdout.strip}', " \
+                  "stderr: '#{result.stderr.strip}'"
           end
 
-          # Then try PATH for Windows executables
-          ["gswin64c.exe", "gswin32c.exe", "gs"].each do |cmd|
-            path = find_in_path(cmd)
-            return path if path
+          unless File.exist?(output_file.path)
+            raise ConversionError,
+                  "GhostScript did not create output file: #{output_file.path}"
           end
-        else
-          # On Unix-like systems, check PATH
-          path = find_in_path("gs")
-          return path if path
-        end
 
-        raise GhostscriptNotFoundError
+          File.binread(output_file.path)
+        ensure
+          input_file.close unless input_file.closed?
+          input_file.unlink
+          output_file.close unless output_file.closed?
+          output_file.unlink
+        end
       end
 
-      def find_in_path(cmd)
-        # If command already has an extension, try it as-is first
-        if File.extname(cmd) != ""
-          Platform.executable_search_paths.each do |path|
-            exe = File.join(path, cmd)
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
-        end
+      private
 
-        # Try with PATHEXT extensions
-        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
-        Platform.executable_search_paths.each do |path|
-          exts.each do |ext|
-            exe = File.join(path, "#{cmd}#{ext}")
-            return exe if File.executable?(exe) && !File.directory?(exe)
-          end
-        end
-        nil
+      # Get the Ghostscript tool from Ukiryu
+      def ghostscript_tool
+        Ukiryu::Tool.get("ghostscript")
+      rescue Ukiryu::Errors::ToolNotFoundError => e
+        # Tool not found - raise the original GhostscriptNotFoundError
+        raise GhostscriptNotFoundError, "Ghostscript not available: #{e.message}"
       end
 
-      def build_command(input_path, output_path, options = {})
-        cmd_parts = []
-        cmd_parts << ghostscript_path
-        cmd_parts << "-sDEVICE=pdfwrite"
-        cmd_parts << "-dNOPAUSE"
-        cmd_parts << "-dBATCH"
-        cmd_parts << "-dSAFER"
-        # Use separate arguments for output file to ensure proper path handling
-        cmd_parts << "-sOutputFile=#{output_path}"
-        cmd_parts << "-dEPSCrop" if options[:eps_crop]
-        cmd_parts << "-dAutoRotatePages=/None"
-        cmd_parts << "-dQUIET"
-        # Use -f to explicitly specify input file
-        cmd_parts << "-f"
-        cmd_parts << input_path
-
-        cmd_parts
+      # Build convert parameters for Ukiryu
+      def build_convert_params(input_path, output_path, options = {})
+        params = {
+          inputs: [input_path],
+          device: :pdfwrite,
+          output: output_path,
+          batch: true,
+          no_pause: true,
+          quiet: true,
+        }
+
+        # Add EPS crop option
+        params[:eps_crop] = true if options[:eps_crop]
+
+        params
       end
     end
   end