vectory 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c46e34eee9accc66e136b741440e46269744e0f9cf8a1125382fe3ec1959b320
-  data.tar.gz: 95a3dcf51104cc31ab37af1b0ecc39861c7717399056b0116cfd94562a66126a
+  metadata.gz: 865823bf5ac58c0780cdffc76abf7d396c2b481bcf292c807e419c0983f44646
+  data.tar.gz: cd29b9a6f1c3a851e37fa207427474a60656ad8a1ba6f27d954d08d2ded47f5d
 SHA512:
-  metadata.gz: 8775fc8bda0a86df3bc2c4bde5ab303d861a6d5812764f8b2c40a540a0f0369a42b55cd1bac655acc3ccf37348aa976620709ae41c35d26680ae221579e416e9
-  data.tar.gz: c880d981f9c7a26182bacf9a0ee0d0df0f5147d493f79de45bade50e813c25d258400157be70b8987f605b3d4a9b4c3217b7974d40da174503de6e074183e573
+  metadata.gz: 01ee6626bca7c7a61f14dffa639355171e052637f9b1c58d4dfb39721a7b7a815e6b11cd5c1deb76b4faecba37abf873e45661c16ebd2eaf7434cb9031a6deff
+  data.tar.gz: 6706861380815c36d273445cc970db3b01693024208596c8072e9661ab301908db5c6c81e7d707826b501263aac8dbcc4b65f553fc62857a773cb45404d53de4

data/Gemfile

@@ -9,4 +9,6 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.22"
+gem "rubocop-performance", "~> 1.10"
+gem "rubocop-rails", "~> 2.9"

data/README.adoc

@@ -27,6 +27,9 @@ Vectory relies on the following software to be installed:
 * https://inkscape.org[Inkscape]
 * https://www.ghostscript.com/[Ghostscript]
 
+NOTE: Inkscape 1.3.1 does not work properly with EPS/PS on Windows. To avoid
+this issue, the 1.3.0 version of Inkscape can be used.
+
 
 === Gem install
 
@@ -157,6 +160,131 @@ 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:
+
+[source,ruby]
+----
+xml_string = Vectory::SvgMapping.from_path("doc.xml").call
+----
+
+In order to do that an initial XML should support the `svgmap` tag with links
+mapping. For example, it can convert XML like this:
+
+[source,xml]
+----
+<svgmap id="_4072bdcb-5895-4821-b636-5795b96787cb">
+  <figure><image src="action_schemaexpg1.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>
+----
+
+.action_schemaexpg1.svg
+[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">
+  <style type="text/css">
+          #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>
+  <a xlink: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"/>
+  </a>
+</svg>
+----
+
+into XML containing inline SVG tags. Notice changes in the `id` attributes and
+the `a` tags:
+
+[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>
+    <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>
+    <a xlink: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'/>
+    </a>
+  </svg>
+</figure>
+----
+
+It also supports SVG in a form of an inline tag:
+
+[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"/>
+      </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:
+
+[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'/>
+  </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>
+----
+
+
 ==== File system operations
 
 An image object contains information where it is written. It can be obtained
@@ -202,6 +330,28 @@ vector.initial_path # => "storage/images/img.eps"
 ----
 
 
+== Development
+
+=== Releasing
+
+Releasing is done automatically with GitHub Actions. Just bump and tag with
+`gem-release`.
+
+For a patch release (0.0.x) use:
+
+[source,sh]
+----
+gem bump --version patch --tag --push
+----
+
+For a minor release (0.x.0) use:
+
+[source,sh]
+----
+gem bump --version minor --tag --push
+----
+
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at:

data/lib/vectory/image.rb

@@ -19,5 +19,9 @@ module Vectory
     def initialize(content)
       @content = content
     end
+
+    private
+
+    attr_writer :content
   end
 end

data/lib/vectory/inkscape_converter.rb

@@ -19,8 +19,8 @@ module Vectory
 
       call = SystemCall.new(cmd).call
 
-      output_path = "#{uri}.#{output_extension}"
-      raise_conversion_error(call) unless File.exist?(output_path)
+      output_path = find_output(uri, output_extension)
+      raise_conversion_error(call) unless output_path
 
       # and return Vectory::Utils::datauri(file)
 
@@ -36,19 +36,46 @@ module Vectory
     end
 
     def inkscape_path
-      cmd = "inkscape"
-      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      @inkscape_path ||= find_inkscape
+    end
+
+    def find_inkscape
+      cmds.each do |cmd|
+        extensions.each do |ext|
+          paths.each do |path|
+            exe = File.join(path, "#{cmd}#{ext}")
 
-      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
-        exts.each do |ext|
-          exe = File.join(path, "#{cmd}#{ext}")
-          return exe if File.executable?(exe) && !File.directory?(exe)
+            return exe if File.executable?(exe) && !File.directory?(exe)
+          end
         end
       end
 
       nil
     end
 
+    def cmds
+      ["inkscapecom", "inkscape"]
+    end
+
+    def extensions
+      ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+    end
+
+    def paths
+      ENV["PATH"].split(File::PATH_SEPARATOR)
+    end
+
+    def find_output(source_path, output_extension)
+      basenames = [File.basename(source_path, ".*"),
+                   File.basename(source_path)]
+
+      paths = basenames.map do |basename|
+        "#{File.join(File.dirname(source_path), basename)}.#{output_extension}"
+      end
+
+      paths.find { |p| File.exist?(p) }
+    end
+
     def raise_conversion_error(call)
       raise Vectory::ConversionError,
             "Could not convert with Inkscape. " \

data/lib/vectory/svg.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "nokogiri"
+
 module Vectory
   class Svg < Vector
-    SVG = { "m" => "http://www.w3.org/2000/svg" }.freeze
+    SVG_NS = "http://www.w3.org/2000/svg"
 
     def self.default_extension
       "svg"
@@ -12,6 +14,10 @@ module Vectory
       "image/svg+xml"
     end
 
+    def content
+      @document&.to_xml || @content
+    end
+
     def to_emf
       convert_with_inkscape("--export-type=emf", Emf)
     end
@@ -23,5 +29,82 @@ module Vectory
     def to_ps
       convert_with_inkscape("--export-type=ps", Ps)
     end
+
+    def namespace(suffix, links, xpath_to_remove)
+      remap_links(links)
+      suffix_ids(suffix)
+      remove_xpath(xpath_to_remove)
+    end
+
+    def remap_links(map)
+      document.xpath(".//m:a", "m" => SVG_NS).each do |a|
+        href_attrs = ["xlink:href", "href"]
+        href_attrs.each do |p|
+          a[p] and x = map[File.expand_path(a[p])] and a[p] = x
+        end
+      end
+
+      self
+    end
+
+    def suffix_ids(suffix)
+      ids = collect_ids
+      return if ids.empty?
+
+      update_ids_attrs(ids, suffix)
+      update_ids_css(ids, suffix)
+
+      self
+    end
+
+    def remove_xpath(xpath)
+      document.xpath(xpath).remove
+
+      self
+    end
+
+    private
+
+    def content=(content)
+      if @document
+        @document = Nokogiri::XML(content)
+      else
+        @content = content
+      end
+    end
+
+    def document
+      @document ||= begin
+        doc = Nokogiri::XML(@content)
+        @content = nil
+        doc
+      end
+    end
+
+    def collect_ids
+      document.xpath("./@id | .//@id").map(&:value)
+    end
+
+    def update_ids_attrs(ids, suffix)
+      document.xpath(". | .//*[@*]").each do |a|
+        a.attribute_nodes.each do |x|
+          ids.include?(x.value) and x.value += sprintf("_%09d", suffix)
+        end
+      end
+    end
+
+    def update_ids_css(ids, suffix)
+      document.xpath("//m:style", "m" => SVG_NS).each do |s|
+        c = s.children.to_xml
+        ids.each do |i|
+          c = c.gsub(%r[##{i}\b],
+                     sprintf("#%<id>s_%<suffix>09d", id: i, suffix: suffix))
+            .gsub(%r(\[id\s*=\s*['"]?#{i}['"]?\]),
+                  sprintf("[id='%<id>s_%<suffix>09d']", id: i, suffix: suffix))
+        end
+
+        s.children = c
+      end
+    end
   end
 end

data/lib/vectory/svg_mapping.rb

@@ -0,0 +1,118 @@
+require_relative "svg"
+
+module Vectory
+  class SvgMapping
+    class Namespace
+      def initialize(xmldoc)
+        @namespace = xmldoc.root.namespace
+      end
+
+      def ns(path)
+        return path if @namespace.nil?
+
+        path.gsub(%r{/([a-zA-z])}, "/xmlns:\\1")
+          .gsub(%r{::([a-zA-z])}, "::xmlns:\\1")
+          .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1")
+          .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
+      end
+    end
+
+    SVG_NS = "http://www.w3.org/2000/svg".freeze
+    PROCESSING_XPATH =
+      "processing-instruction()|.//processing-instruction()".freeze
+
+    def self.from_path(path)
+      new(File.read(path))
+    end
+
+    def initialize(xml, local_directory = "")
+      @xml = xml
+      @local_directory = local_directory
+    end
+
+    def call
+      xmldoc = Nokogiri::XML(@xml)
+      @namespace = Namespace.new(xmldoc)
+
+      xmldoc.xpath(@namespace.ns("//svgmap")).each_with_index do |svgmap, index|
+        process_svgmap(svgmap, index)
+      end
+
+      xmldoc.to_xml
+    end
+
+    private
+
+    def process_svgmap(svgmap, suffix)
+      image = extract_image_tag(svgmap)
+      return unless image
+
+      content = generate_content(image, svgmap, suffix)
+      return unless content
+
+      image.replace(content)
+
+      simplify_svgmap(svgmap)
+    end
+
+    def extract_image_tag(svgmap)
+      image = svgmap.at(@namespace.ns(".//image"))
+      return image if image && image["src"] && !image["src"].empty?
+
+      svgmap.at(".//m:svg", "m" => SVG_NS)
+    end
+
+    def generate_content(image, svgmap, suffix)
+      vector = build_vector(image)
+      return unless vector
+
+      links_map = from_targets_to_links_map(svgmap)
+      vector.namespace(suffix, links_map, PROCESSING_XPATH)
+
+      vector.content
+    end
+
+    def build_vector(image)
+      return Vectory::Svg.from_content(image.to_xml) if image.name == "svg"
+
+      return unless image.name == "image"
+
+      src = image["src"]
+      return Vectory::Datauri.new(src).to_vector if /^data:/.match?(src)
+
+      path = @local_directory.empty? ? src : File.join(@local_directory, src)
+      return unless File.exist?(path)
+
+      Vectory::Svg.from_path(path)
+    end
+
+    def from_targets_to_links_map(svgmap)
+      targets = svgmap.xpath(@namespace.ns("./target"))
+      targets.each_with_object({}) do |target_tag, m|
+        target = link_target(target_tag)
+        next unless target
+
+        href = File.expand_path(target_tag["href"])
+        m[href] = target
+
+        target_tag.remove
+      end
+    end
+
+    def link_target(target_tag)
+      xref = target_tag.at(@namespace.ns("./xref"))
+      return "##{xref['target']}" if xref
+
+      link = target_tag.at(@namespace.ns("./link"))
+      return unless link
+
+      link["target"]
+    end
+
+    def simplify_svgmap(svgmap)
+      return if svgmap.at(@namespace.ns("./target/eref"))
+
+      svgmap.replace(svgmap.at(@namespace.ns("./figure")))
+    end
+  end
+end

data/lib/vectory/system_call.rb

@@ -2,10 +2,13 @@ require "open3"
 
 module Vectory
   class SystemCall
+    TIMEOUT = 60
+
     attr_reader :status, :stdout, :stderr, :cmd
 
-    def initialize(cmd)
+    def initialize(cmd, timeout = TIMEOUT)
       @cmd = cmd
+      @timeout = timeout
     end
 
     def call
@@ -27,7 +30,13 @@ module Vectory
     end
 
     def execute(cmd)
-      @stdout, @stderr, @status = Open3.capture3(cmd)
+      result = Utils.capture3_with_timeout(cmd,
+                                           timeout: @timeout,
+                                           kill_after: @timeout)
+      Vectory.ui.error(result.inspect)
+      @stdout = result[:stdout]
+      @stderr = result[:stderr]
+      @status = result[:status]
     rescue Errno::ENOENT => e
       raise SystemCallError, e.inspect
     end

data/lib/vectory/utils.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "marcel"
+require "timeout"
+
 module Vectory
   class Utils
     # Extracted from https://github.com/metanorma/metanorma-utils/blob/v1.5.2/lib/utils/image.rb
@@ -49,6 +52,114 @@ module Vectory
       def absolute_path?(uri)
         %r{^/}.match?(uri) || %r{^[A-Z]:/}.match?(uri)
       end
+
+      # 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 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),
+        }
+
+        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/vector.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "tempfile"
 require_relative "inkscape_converter"
 
 module Vectory
@@ -44,7 +45,7 @@ module Vectory
 
     def write(path = nil)
       target_path = path || @path || tmp_path
-      File.binwrite(target_path, @content)
+      File.binwrite(target_path, content)
       @path = File.expand_path(target_path)
 
       self
@@ -59,7 +60,7 @@ module Vectory
     def with_file(input_extension)
       Dir.mktmpdir do |dir|
         input_path = File.join(dir, "image.#{input_extension}")
-        File.binwrite(input_path, @content)
+        File.binwrite(input_path, content)
 
         yield input_path
       end

data/lib/vectory/version.rb

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

data/lib/vectory.rb

@@ -10,6 +10,7 @@ require_relative "vectory/eps"
 require_relative "vectory/ps"
 require_relative "vectory/emf"
 require_relative "vectory/svg"
+require_relative "vectory/svg_mapping"
 
 module Vectory
   class Error < StandardError; end