vectory 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c46e34eee9accc66e136b741440e46269744e0f9cf8a1125382fe3ec1959b320
-  data.tar.gz: 95a3dcf51104cc31ab37af1b0ecc39861c7717399056b0116cfd94562a66126a
+  metadata.gz: 2f51d610adc333c06f92e8e28ca9722a890f12b03668bf12e96ce057d2574dea
+  data.tar.gz: 792bc815a0b86a6211b83268f16b9abe7a138aba0081a2d7a95242c5e9a7af82
 SHA512:
-  metadata.gz: 8775fc8bda0a86df3bc2c4bde5ab303d861a6d5812764f8b2c40a540a0f0369a42b55cd1bac655acc3ccf37348aa976620709ae41c35d26680ae221579e416e9
-  data.tar.gz: c880d981f9c7a26182bacf9a0ee0d0df0f5147d493f79de45bade50e813c25d258400157be70b8987f605b3d4a9b4c3217b7974d40da174503de6e074183e573
+  metadata.gz: 249d3f2fa7df2d216cdf5d046647507b81a55bd5db56a603a90a3890501adb10e8a03f41b272385c65a8de48c50b8b52db743ec5ddc20be88e4e5aab6ed21ca6
+  data.tar.gz: 5ed331050b3c4a3231cabc7ba061695f017de5ea44a3056bf01537144b12c96cf5587c0a52793d3d435d961052210aefed73a52c4afc9c3563695fca8e23c91d

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
@@ -201,6 +329,45 @@ purposes.
 vector.initial_path # => "storage/images/img.eps"
 ----
 
+==== Additional properties
+
+The following additional properties are supported:
+
+[source,ruby]
+----
+Datauri#mime
+Datauri#height
+Datauri#width
+Vector (Eps, Ps, Svg, Emf)
+Vector#mime
+Vector#size
+Vector#file_size
+Vector#height
+Vector#width
+----
+
+
+== 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
 

data/lib/vectory/datauri.rb

@@ -18,6 +18,19 @@ module Vectory
       new("data:#{mimetype};base64,#{data}")
     end
 
+    def mime
+      match = parse_datauri(@content)
+      match[:mimetype]
+    end
+
+    def height
+      to_vector.height
+    end
+
+    def width
+      to_vector.width
+    end
+
     def to_vector
       match = parse_datauri(@content)
       content = Base64.strict_decode64(match[:data])

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "singleton"
+require "tmpdir"
 require_relative "system_call"
 
 module Vectory
@@ -12,43 +13,78 @@ module Vectory
     end
 
     def convert(uri, output_extension, option)
-      exe = inkscape_path_or_raise_error(uri)
+      exe = inkscape_path_or_raise_error
       uri = external_path uri
       exe = external_path exe
       cmd = %(#{exe} #{option} #{uri})
 
       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)
 
       output_path
     end
 
+    def height(content, format)
+      query_integer(content, format, "--query-height")
+    end
+
+    def width(content, format)
+      query_integer(content, format, "--query-width")
+    end
+
     private
 
-    def inkscape_path_or_raise_error(path)
+    def inkscape_path_or_raise_error
       inkscape_path or raise(InkscapeNotFoundError,
                              "Inkscape missing in PATH, unable to " \
-                             "convert image #{path}. Aborting.")
+                             "convert image. Aborting.")
     end
 
     def inkscape_path
-      cmd = "inkscape"
-      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      @inkscape_path ||= find_inkscape
+    end
 
-      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)
+    def find_inkscape
+      cmds.each do |cmd|
+        extensions.each do |ext|
+          paths.each do |path|
+            exe = File.join(path, "#{cmd}#{ext}")
+
+            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. " \
@@ -68,5 +104,40 @@ module Vectory
         path
       end
     end
+
+    def query_integer(content, format, options)
+      query(content, format, options).to_f.round
+    end
+
+    def query(content, format, options)
+      exe = inkscape_path_or_raise_error
+
+      with_file(content, format) do |path|
+        cmd = "#{external_path(exe)} #{options} #{external_path(path)}"
+
+        call = SystemCall.new(cmd).call
+        raise_query_error(call) if call.stdout.empty?
+
+        call.stdout
+      end
+    end
+
+    def with_file(content, extension)
+      Dir.mktmpdir do |dir|
+        path = File.join(dir, "image.#{extension}")
+        File.binwrite(path, content)
+
+        yield path
+      end
+    end
+
+    def raise_query_error(call)
+      raise Vectory::InkscapeQueryError,
+            "Could not query with Inkscape. " \
+            "Inkscape cmd: '#{call.cmd}',\n" \
+            "status: '#{call.status}',\n" \
+            "stdout: '#{call.stdout.strip}',\n" \
+            "stderr: '#{call.stderr.strip}'."
+    end
   end
 end

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,12 @@ module Vectory
     end
 
     def execute(cmd)
-      @stdout, @stderr, @status = Open3.capture3(cmd)
+      result = Utils.capture3_with_timeout(cmd,
+                                           timeout: @timeout,
+                                           kill_after: @timeout)
+      @stdout = result[:stdout]
+      @stderr = result[:stderr]
+      @status = result[:status]
     rescue Errno::ENOENT => e
       raise SystemCallError, e.inspect
     end