vectory 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcde8950a26370677a54de04ba44f5737eec9768a0c611fb3788c5169c729d9c
-  data.tar.gz: dcc826fc4ad94fbf07829d52b65625069c2581aa202a2d3016769ad70ac83881
+  metadata.gz: 50efb043c71096f66bc72c7804b8707b6210ab4af071f231d7e81f52a0c66da0
+  data.tar.gz: a3ffda2f587f7796f2033fab1230db852d98e82da88b269d230646dad6acbd39
 SHA512:
-  metadata.gz: 9b2d225eb97cf8b367609be20123e2fd7776fe291ae11005c47fc61fd09be9808b40926991d302092e9c9b64f8d9868d52bfa6f6e3ea4104a51775295a470f85
-  data.tar.gz: 73016cfa8360d5914add0fbd07b7dd811097fe5f956a02ff9403a8b16a1e8c72082c722026db0af7d70ce762dc308df3ba8fc5f3cd80816a372c73ec209f5298
+  metadata.gz: aca9af8bee9a5f916fc0360b9473705307bfeda4b0086ae9fa53929381169a4791a483a126f98f1295574da06d70a2ea92bf3a706cd7359f91fa6b492c305205
+  data.tar.gz: '05286cb944c4235c5d60d5591b63be2d15c43f796fa0d63b00205ced005fe8c84f314c2d468fd5ec2a02336682d4b4c0357fd63bd6757056f95aa727ec8a3884'

data/README.adoc

@@ -173,7 +173,7 @@ link references:
 
 [source,ruby]
 ----
-xml_string = Vectory::SvgMapping.from_path("doc.xml").call
+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

data/lib/vectory/capture.rb

@@ -0,0 +1,115 @@
+require "timeout"
+
+module Vectory
+  module Capture
+    class << self
+      # rubocop:disable all
+      #
+      # Originally from https://gist.github.com/pasela/9392115
+      #
+      # Capture the standard output and the standard error of a command.
+      # Almost same as Open3.capture3 method except for timeout handling and return value.
+      # See Open3.capture3.
+      #
+      #   result = capture3_with_timeout([env,] cmd... [, opts])
+      #
+      # The arguments env, cmd and opts are passed to Process.spawn except
+      # opts[:stdin_data], opts[:binmode], opts[:timeout], opts[:signal]
+      # and opts[:kill_after].  See Process.spawn.
+      #
+      # If opts[:stdin_data] is specified, it is sent to the command's standard input.
+      #
+      # If opts[:binmode] is true, internal pipes are set to binary mode.
+      #
+      # If opts[:timeout] is specified, SIGTERM is sent to the command after specified seconds.
+      #
+      # If opts[:signal] is specified, it is used instead of SIGTERM on timeout.
+      #
+      # If opts[:kill_after] is specified, also send a SIGKILL after specified seconds.
+      # it is only sent if the command is still running after the initial signal was sent.
+      #
+      # The return value is a Hash as shown below.
+      #
+      #   {
+      #     :pid     => PID of the command,
+      #     :status  => Process::Status of the command,
+      #     :stdout  => the standard output of the command,
+      #     :stderr  => the standard error of the command,
+      #     :timeout => whether the command was timed out,
+      #   }
+      def with_timeout(*cmd)
+        spawn_opts = Hash === cmd.last ? cmd.pop.dup : {}
+        opts = {
+          :stdin_data => spawn_opts.delete(:stdin_data) || "",
+          :binmode    => spawn_opts.delete(:binmode) || false,
+          :timeout    => spawn_opts.delete(:timeout),
+          :signal     => spawn_opts.delete(:signal) || :TERM,
+          :kill_after => spawn_opts.delete(:kill_after),
+        }
+
+        in_r,  in_w  = IO.pipe
+        out_r, out_w = IO.pipe
+        err_r, err_w = IO.pipe
+        in_w.sync = true
+
+        if opts[:binmode]
+          in_w.binmode
+          out_r.binmode
+          err_r.binmode
+        end
+
+        spawn_opts[:in]  = in_r
+        spawn_opts[:out] = out_w
+        spawn_opts[:err] = err_w
+
+        result = {
+          :pid     => nil,
+          :status  => nil,
+          :stdout  => nil,
+          :stderr  => nil,
+          :timeout => false,
+        }
+
+        out_reader = nil
+        err_reader = nil
+        wait_thr = nil
+
+        begin
+          Timeout.timeout(opts[:timeout]) do
+            result[:pid] = spawn(*cmd, spawn_opts)
+            wait_thr = Process.detach(result[:pid])
+            in_r.close
+            out_w.close
+            err_w.close
+
+            out_reader = Thread.new { out_r.read }
+            err_reader = Thread.new { err_r.read }
+
+            in_w.write opts[:stdin_data]
+            in_w.close
+
+            result[:status] = wait_thr.value
+          end
+        rescue Timeout::Error
+          result[:timeout] = true
+          pid = spawn_opts[:pgroup] ? -result[:pid] : result[:pid]
+          Process.kill(opts[:signal], pid)
+          if opts[:kill_after]
+            unless wait_thr.join(opts[:kill_after])
+              Process.kill(:KILL, pid)
+            end
+          end
+        ensure
+          result[:status] = wait_thr.value if wait_thr
+          result[:stdout] = out_reader.value if out_reader
+          result[:stderr] = err_reader.value if err_reader
+          out_r.close unless out_r.closed?
+          err_r.close unless err_r.closed?
+        end
+
+        result
+      end
+      # rubocop:enable all
+    end
+  end
+end

data/lib/vectory/svg_mapping.rb

@@ -22,23 +22,30 @@ module Vectory
       "processing-instruction()|.//processing-instruction()".freeze
 
     def self.from_path(path)
-      new(File.read(path))
+      new(Nokogiri::XML(File.read(path)))
     end
 
-    def initialize(xml, local_directory = "")
-      @xml = xml
+    def self.from_xml(xml)
+      new(Nokogiri::XML(xml))
+    end
+
+    def initialize(doc, local_directory = "")
+      @doc = doc
       @local_directory = local_directory
     end
 
     def call
-      xmldoc = Nokogiri::XML(@xml)
-      @namespace = Namespace.new(xmldoc)
+      @namespace = Namespace.new(@doc)
 
-      xmldoc.xpath(@namespace.ns("//svgmap")).each_with_index do |svgmap, index|
+      @doc.xpath(@namespace.ns("//svgmap")).each_with_index do |svgmap, index|
         process_svgmap(svgmap, index)
       end
 
-      xmldoc.to_xml
+      @doc
+    end
+
+    def to_xml
+      call.to_xml
     end
 
     private

data/lib/vectory/system_call.rb

@@ -1,4 +1,5 @@
 require "open3"
+require_relative "capture"
 
 module Vectory
   class SystemCall
@@ -30,9 +31,9 @@ module Vectory
     end
 
     def execute(cmd)
-      result = Utils.capture3_with_timeout(cmd,
-                                           timeout: @timeout,
-                                           kill_after: @timeout)
+      result = Capture.with_timeout(cmd,
+                                    timeout: @timeout,
+                                    kill_after: @timeout)
       @stdout = result[:stdout]
       @stderr = result[:stderr]
       @status = result[:status]

data/lib/vectory/utils.rb

@@ -1,117 +1,99 @@
 # frozen_string_literal: true
 
-require "timeout"
+require "base64"
+require "marcel"
+require "tempfile"
 
 module Vectory
   class Utils
     class << self
-      # rubocop:disable all
+      # Extracted from https://github.com/metanorma/metanorma-utils/blob/v1.5.2/lib/utils/image.rb
       #
-      # Originally from https://gist.github.com/pasela/9392115
-      #
-      # Capture the standard output and the standard error of a command.
-      # Almost same as Open3.capture3 method except for timeout handling and return value.
-      # See Open3.capture3.
-      #
-      #   result = capture3_with_timeout([env,] cmd... [, opts])
-      #
-      # The arguments env, cmd and opts are passed to Process.spawn except
-      # opts[:stdin_data], opts[:binmode], opts[:timeout], opts[:signal]
-      # and opts[:kill_after].  See Process.spawn.
-      #
-      # If opts[:stdin_data] is specified, it is sent to the command's standard input.
-      #
-      # If opts[:binmode] is true, internal pipes are set to binary mode.
-      #
-      # If opts[:timeout] is specified, SIGTERM is sent to the command after specified seconds.
-      #
-      # If opts[:signal] is specified, it is used instead of SIGTERM on timeout.
-      #
-      # If opts[:kill_after] is specified, also send a SIGKILL after specified seconds.
-      # it is only sent if the command is still running after the initial signal was sent.
-      #
-      # The return value is a Hash as shown below.
-      #
-      #   {
-      #     :pid     => PID of the command,
-      #     :status  => Process::Status of the command,
-      #     :stdout  => the standard output of the command,
-      #     :stderr  => the standard error of the command,
-      #     :timeout => whether the command was timed out,
-      #   }
-      def capture3_with_timeout(*cmd)
-        spawn_opts = Hash === cmd.last ? cmd.pop.dup : {}
-        opts = {
-          :stdin_data => spawn_opts.delete(:stdin_data) || "",
-          :binmode    => spawn_opts.delete(:binmode) || false,
-          :timeout    => spawn_opts.delete(:timeout),
-          :signal     => spawn_opts.delete(:signal) || :TERM,
-          :kill_after => spawn_opts.delete(:kill_after),
-        }
+      # sources/plantuml/plantuml20200524-90467-1iqek5i.png
+      # already includes localdir
+      # Check whether just the local path or the other specified relative path
+      # works.
+      def datauri(uri, local_dir = ".")
+        (datauri?(uri) || url?(uri)) and return uri
+
+        path = path_which_exist(uri, local_dir)
+        path and return encode_datauri(path)
 
-        in_r,  in_w  = IO.pipe
-        out_r, out_w = IO.pipe
-        err_r, err_w = IO.pipe
-        in_w.sync = true
+        warn "Image specified at `#{uri}` does not exist."
+        uri # Return original provided location
+      end
 
-        if opts[:binmode]
-          in_w.binmode
-          out_r.binmode
-          err_r.binmode
+      def path_which_exist(uri, local_dir)
+        options = absolute_path?(uri) ? [uri] : [uri, File.join(local_dir, uri)]
+        options.detect do |p|
+          File.file?(p)
         end
+      end
 
-        spawn_opts[:in]  = in_r
-        spawn_opts[:out] = out_w
-        spawn_opts[:err] = err_w
+      def encode_datauri(path)
+        return nil unless File.exist?(path)
 
-        result = {
-          :pid     => nil,
-          :status  => nil,
-          :stdout  => nil,
-          :stderr  => nil,
-          :timeout => false,
-        }
+        type = Marcel::MimeType.for(Pathname.new(path)) ||
+          'text/plain; charset="utf-8"'
+
+        bin = File.binread(path)
+        data = Base64.strict_encode64(bin)
+        "data:#{type};base64,#{data}"
+        # rescue StandardError
+        #   warn "Data-URI encoding of `#{path}` failed."
+        #   nil
+      end
+
+      def datauri?(uri)
+        /^data:/.match?(uri)
+      end
+
+      def url?(url)
+        %r{^[A-Z]{2,}://}i.match?(url)
+      end
+
+      def absolute_path?(uri)
+        %r{^/}.match?(uri) || %r{^[A-Z]:/}.match?(uri)
+      end
+
+      def svgmap_rewrite0_path(src, localdirectory)
+        if /^data:/.match?(src)
+          save_dataimage(src)
+        else
+          File.file?(src) ? src : localdirectory + src
+        end
+      end
 
-        out_reader = nil
-        err_reader = nil
-        wait_thr = nil
-
-        begin
-          Timeout.timeout(opts[:timeout]) do
-            result[:pid] = spawn(*cmd, spawn_opts)
-            wait_thr = Process.detach(result[:pid])
-            in_r.close
-            out_w.close
-            err_w.close
-
-            out_reader = Thread.new { out_r.read }
-            err_reader = Thread.new { err_r.read }
-
-            in_w.write opts[:stdin_data]
-            in_w.close
-
-            result[:status] = wait_thr.value
-          end
-        rescue Timeout::Error
-          result[:timeout] = true
-          pid = spawn_opts[:pgroup] ? -result[:pid] : result[:pid]
-          Process.kill(opts[:signal], pid)
-          if opts[:kill_after]
-            unless wait_thr.join(opts[:kill_after])
-              Process.kill(:KILL, pid)
-            end
-          end
-        ensure
-          result[:status] = wait_thr.value if wait_thr
-          result[:stdout] = out_reader.value if out_reader
-          result[:stderr] = err_reader.value if err_reader
-          out_r.close unless out_r.closed?
-          err_r.close unless err_r.closed?
+      def save_dataimage(uri)
+        %r{^data:(?:image|application)/(?<imgtype>[^;]+);(?:charset=[^;]+;)?base64,(?<imgdata>.+)$} =~ uri # rubocop:disable Layout/LineLength
+        imgtype.sub!(/\+[a-z0-9]+$/, "") # svg+xml
+        imgtype = "png" unless /^[a-z0-9]+$/.match? imgtype
+        Tempfile.open(["image", ".#{imgtype}"]) do |f|
+          f.binmode
+          f.write(Base64.strict_decode64(imgdata))
+          f.path
         end
+      end
+
+      # FIXME: This method should ONLY return 1 type, remove Array wrapper
+      def datauri2mime(uri)
+        output = decode_datauri(uri)
+        return nil unless output && output[:type_detected]
 
-        result
+        [output[:type_detected]]
+      end
+
+      def decode_datauri(uri)
+        %r{^data:(?<mimetype>[^;]+);base64,(?<mimedata>.+)$} =~ uri
+        return nil unless mimetype && mimedata
+
+        data = Base64.strict_decode64(mimedata)
+        {
+          type_declared: mimetype,
+          type_detected: Marcel::MimeType.for(data, declared_type: mimetype),
+          data: data,
+        }
       end
-      # rubocop:enable all
     end
   end
 end

data/lib/vectory/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vectory
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/vectory.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.5.0"
 
   spec.add_runtime_dependency "emf2svg"
+  spec.add_runtime_dependency "marcel", "~> 1.0.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.14"
   spec.add_runtime_dependency "thor", "~> 1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vectory
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-25 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: emf2svg
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -73,6 +87,7 @@ files:
 - Rakefile
 - exe/vectory
 - lib/vectory.rb
+- lib/vectory/capture.rb
 - lib/vectory/cli.rb
 - lib/vectory/datauri.rb
 - lib/vectory/emf.rb