vectory 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd1ad8c12e153372b1c44c17aa68f499734f0e88b2023a8a48a6ad1572dbac75
-  data.tar.gz: 65f684b929a644409e2ac52a825e01dd2b56b1f74bc4b9db7e6dc41eb8107dfa
+  metadata.gz: c46e34eee9accc66e136b741440e46269744e0f9cf8a1125382fe3ec1959b320
+  data.tar.gz: 95a3dcf51104cc31ab37af1b0ecc39861c7717399056b0116cfd94562a66126a
 SHA512:
-  metadata.gz: 15b53a73c27c63f3205f536a8a75d39a898ff3fffa0704096636003198ebda42a4ec016b62615d4ae949bbcc766721fe1da99e04c826c8b1d21b299fe7a0cfb6
-  data.tar.gz: 9db936c9a9e3a17faec138d5dd05eaa70ca016fa399135f5aad68f3138f5fbfe131fb01a9c29ce2cd8c80a8218726f81f9f8b149a4d1b973b88f55e8269f6478
+  metadata.gz: 8775fc8bda0a86df3bc2c4bde5ab303d861a6d5812764f8b2c40a540a0f0369a42b55cd1bac655acc3ccf37348aa976620709ae41c35d26680ae221579e416e9
+  data.tar.gz: c880d981f9c7a26182bacf9a0ee0d0df0f5147d493f79de45bade50e813c25d258400157be70b8987f605b3d4a9b4c3217b7974d40da174503de6e074183e573

data/.github/workflows/rake.yml

@@ -10,6 +10,6 @@ on:
 
 jobs:
   rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    uses: metanorma/ci/.github/workflows/inkscape-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+Gemfile.lock
+.rspec_status
+.rubocop-*

data/README.adoc

@@ -11,6 +11,11 @@ image:https://img.shields.io/github/commits-since/metanorma/vectory/latest.svg["
 Vectory is a Ruby gem that performs pairwise vector image conversions for common
 vector image formats (EPS, PS, EMF, SVG).
 
+[quote]
+____
+Vectory shall give you a glorious vectory over EPS files.
+____
+
 
 == Installation
 
@@ -20,6 +25,7 @@ Vectory relies on the following software to be installed:
 
 * https://github.com/metanorma/emf2svg-ruby[emf2svg-ruby]
 * https://inkscape.org[Inkscape]
+* https://www.ghostscript.com/[Ghostscript]
 
 
 === Gem install
@@ -43,7 +49,157 @@ Where,
 
 `format`:: the desired output format (one of: `svg`, `eps`, `ps`, `emf`)
 `input-file-name`:: file path to the input file
-`output-file-name`:: file path to the desired output file (with the file extension)
+`output-file-name`:: file path to the desired output file (with the
+file extension) (default: writes to a current directory by the input filename
+with an extension changed to a desired format)
+
+
+=== Using the Ruby library
+
+Some examples:
+
+Take EMF as a path to a file and return SVG as a string:
+
+[source,ruby]
+----
+path = "path/to/file.emf"
+
+Vectory::Emf.from_path(path).to_svg.content
+----
+
+Take EPS as a string and return EMF as a path to a file:
+
+[source,ruby]
+----
+# NOTE: content is shortened for readability
+content = "%!PS-Adobe-3.0 EPSF-3.0\n ... %%Trailer"
+
+Vectory::Eps.from_content(content).to_emf.write.path
+----
+
+Take SVG as a datauri and return EMF as a datauri:
+
+[source,ruby]
+----
+# NOTE: datauri is shortened for readability
+uri = "data:image/svg+xml;charset=utf-8;base64,PHN2ZyB4bWxucz0iaHR0 ... GRkYiLz48L3N2Zz4="
+
+Vectory::Datauri.new(uri).to_vector.to_emf.to_uri.content
+----
+
+
+==== What is supported?
+
+There are several vector classes which support conversion between each other:
+
+[source,ruby]
+----
+Vectory::Eps
+Vectory::Ps
+Vectory::Emf
+Vectory::Svg
+----
+
+Each of them can be instantiated in several ways:
+
+[source,ruby]
+----
+Vectory::Eps.from_path("images/img.eps")
+Vectory::Eps.from_content("%!PS-Adobe-3.0...")
+----
+
+Converting to other formats:
+
+[source,ruby]
+----
+Vectory::Eps.from_content(content).to_ps
+Vectory::Eps.from_content(content).to_emf
+Vectory::Eps.from_content(content).to_svg
+----
+
+Several ways of getting content of an object:
+
+[source,ruby]
+----
+Vectory::Eps.from_content(content).to_svg.content
+Vectory::Eps.from_content(content).to_svg.to_uri.content # as datauri
+Vectory::Eps.from_content(content).to_svg.write.path
+----
+
+
+==== Datauri
+
+Also there is the `Vectory::Datauri` class which represents vectory images in
+the datauri format.
+
+Convert an SVG datauri to a plain SVG:
+
+[source,ruby]
+----
+# NOTE: datauri is shortened for readability
+uri = "data:image/svg+xml;charset=utf-8;base64,PHN2ZyB4bWxucz0iaHR0 ... GRkYiLz48L3N2Zz4="
+Vectory::Datauri.new(uri).to_vector.content
+----
+
+Convert an EPS file to its datauri representation:
+
+[source,ruby]
+----
+eps = Vectory::Eps.from_path("img.eps")
+Vectory::Datauri.from_vector(eps).content
+----
+
+There is also a simplified API for this case:
+
+[source,ruby]
+----
+Vectory::Eps.from_path("img.eps").to_uri.content
+----
+
+
+==== File system operations
+
+An image object contains information where it is written. It can be obtained
+with the `#path` API:
+
+[source,ruby]
+----
+vector = Vectory::Eps.from_path("img.eps")
+vector.path
+----
+
+Before the first write it raises the `NotWrittenToDiskError` error:
+
+[source,ruby]
+----
+vector.path # => raise NotWrittenToDiskError
+----
+
+After writing it returns a path of the image on a disk:
+
+[source,ruby]
+----
+vector.write
+vector.path # => "/tmp/xxx/yyy"
+----
+
+By default it writes to a temporary directory but it can be changed by
+providing an argument with a desired path:
+
+[source,ruby]
+----
+vector.write("images/img.eps")
+vector.path # => "images/img.eps"
+----
+
+Since an image can be initially read from a disk, it also keeps an initial
+path. To avoid accidental overwrite, this path is used only for read-only
+purposes.
+
+[source,ruby]
+----
+vector.initial_path # => "storage/images/img.eps"
+----
 
 
 == Contributing

data/Rakefile

@@ -5,6 +5,10 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+task :inkscape_version do
+  system('inkscape --version')
+end
+
 task default: :spec
 
 # require "rubocop/rake_task"

data/bin/vectory

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "vectory/cli"
+
+Vectory.ui.level = Logger::INFO
+
+status_code = Vectory::CLI.start(ARGV)
+exit status_code.is_a?(Integer) ? status_code : Vectory::CLI::STATUS_UNKNOWN_ERROR

data/emf.emf

@@ -0,0 +1 @@
+AQAAAMgAAAAAAAAAAAAAAPsEAAD7BAAAAAAAAAAAAACLCgAAiwoAACBFTUYAAAEAJAQAACgAAAACAAAALgAAAGwAAAAAAAAA3ScAAH0zAADYAAAAFwEAAAAAAAAAAAAAAAAAAMBLAwDYQQQASQBuAGsAcwBjAGEAcABlACAAMQAuADAAIAAoADQAMAAzADUAYQA0AGYALAAgADIAMAAyADAALQAwADUALQAwADEAKQAgAAAAbwBkAGYALgBlAG0AZgAAAAAAAAARAAAADAAAAAEAAAAkAAAAJAAAAAAAgD8AAAAAAAAAAAAAgD8AAAAAAAAAAAIAAABGAAAALAAAACAAAABTY3JlZW49MTAyMDV4MTMxODFweCwgMjE2eDI3OW1tAEYAAAAwAAAAIwAAAERyYXdpbmc9MTAwLjB4MTAwLjBweCwgMjYuNXgyNi41bW0AABIAAAAMAAAAAQAAABMAAAAMAAAAAgAAABYAAAAMAAAAGAAAABgAAAAMAAAAAAAAABQAAAAMAAAADQAAACcAAAAYAAAAAQAAAAAAAAAAAJkABgAAACUAAAAMAAAAAQAAADsAAAAIAAAAGwAAABAAAACkBAAAcQIAAAUAAAA0AAAAAAAAAAAAAAD//////////wMAAACkBAAAqAMAAKgDAACkBAAAcQIAAKQEAAAFAAAANAAAAAAAAAAAAAAA//////////8DAAAAOgEAAKQEAAA/AAAAqAMAAD8AAABxAgAABQAAADQAAAAAAAAAAAAAAP//////////AwAAAD8AAAA6AQAAOgEAAD8AAABxAgAAPwAAAAUAAAA0AAAAAAAAAAAAAAD//////////wMAAACoAwAAPwAAAKQEAAA6AQAApAQAAHECAAA9AAAACAAAADwAAAAIAAAAPgAAABgAAAAAAAAAAAAAAP//////////JQAAAAwAAAAFAACAKAAAAAwAAAABAAAAJwAAABgAAAABAAAAAAAAAP///wAGAAAAJQAAAAwAAAABAAAAOwAAAAgAAAAbAAAAEAAAAJ0BAABFAQAANgAAABAAAADPAwAARQEAAAUAAAA0AAAAAAAAAAAAAAD//////////wMAAABfBAAA7QEAAGQEAADjAgAA2wMAAJEDAAAFAAAANAAAAAAAAAAAAAAA//////////8DAAAAUgMAAD4EAABhAgAAcwQAAJ0BAAAOBAAANgAAABAAAACdAQAAyQIAADYAAAAQAAAA4gIAAMkCAAA2AAAAEAAAAOICAAAaAgAANgAAABAAAACdAQAAGgIAAD0AAAAIAAAAPAAAAAgAAAA+AAAAGAAAAAAAAAAAAAAA//////////8lAAAADAAAAAUAAIAoAAAADAAAAAEAAAAOAAAAFAAAAAAAAAAAAAAAJAQAAA==

data/lib/vectory/cli.rb

@@ -0,0 +1,140 @@
+require "thor"
+require_relative "../vectory"
+require_relative "file_magic"
+
+module Vectory
+  class CLI < Thor
+    STATUS_SUCCESS = 0
+    STATUS_UNKNOWN_ERROR = 1
+    STATUS_UNSUPPORTED_INPUT_FORMAT_ERROR = 2
+    STATUS_UNSUPPORTED_OUTPUT_FORMAT_ERROR = 3
+    STATUS_CONVERSION_ERROR = 4
+    STATUS_SYSTEM_CALL_ERROR = 5
+    STATUS_INKSCAPE_NOT_FOUND_ERROR = 6
+
+    MAP_ERROR_TO_STATUS = {
+      Vectory::ConversionError => STATUS_CONVERSION_ERROR,
+      Vectory::InkscapeNotFoundError => STATUS_INKSCAPE_NOT_FOUND_ERROR,
+      Vectory::SystemCallError => STATUS_SYSTEM_CALL_ERROR,
+    }.freeze
+
+    module SupportedInputFormats
+      EPS = :eps
+      PS  = :ps
+      SVG = :svg
+      EMF = :emf
+
+      def self.all
+        constants.map { |x| const_get(x) }
+      end
+    end
+
+    module SupportedOutputFormats
+      EPS = "eps".freeze
+      PS  = "ps".freeze
+      SVG = "svg".freeze
+      EMF = "emf".freeze
+
+      def self.all
+        constants.map { |x| const_get(x) }
+      end
+    end
+
+    def self.exit_on_failure?
+      false
+    end
+
+    desc "convert INPUT_FILE_NAME",
+         "Perform pairwise vector image conversions for common vector image " \
+         "formats (EPS, PS, EMF, SVG)"
+    option :format,
+           aliases: :f,
+           required: true,
+           desc: "the desired output format (one of: svg, eps, ps, emf)"
+
+    option :output,
+           aliases: :o,
+           desc: "file path to the desired output file (with the file " \
+                 "extension)"
+    def convert(file)
+      unless supported_format?(options[:format])
+        return unsupported_format_error(options[:format])
+      end
+
+      input_format = detect_input_format(file)
+      unless supported_input_format?(input_format)
+        return unsupported_input_format_error
+      end
+
+      object = source_object(file, input_format)
+
+      convert_to_format(object, options)
+    end
+    default_task :convert
+
+    private
+
+    def supported_format?(format)
+      SupportedOutputFormats.all.include?(format)
+    end
+
+    def unsupported_format_error(format)
+      formats = SupportedOutputFormats.all.map { |v| "'#{v}'" }.join(", ")
+
+      Vectory.ui.error(
+        "Unsupported output format '#{format}'. " \
+        "Please choose one of: #{formats}.",
+      )
+
+      STATUS_UNSUPPORTED_OUTPUT_FORMAT_ERROR
+    end
+
+    def detect_input_format(file)
+      FileMagic.detect(file)
+    end
+
+    def supported_input_format?(format)
+      SupportedInputFormats.all.include?(format)
+    end
+
+    def unsupported_input_format_error
+      formats = SupportedInputFormats.all.map { |v| "'#{v}'" }.join(", ")
+      Vectory.ui.error(
+        "Could not detect input format. " \
+        "Please provide file of the following formats: #{formats}.",
+      )
+
+      STATUS_UNSUPPORTED_INPUT_FORMAT_ERROR
+    end
+
+    def source_object(file, format)
+      Vectory.const_get(format.capitalize).from_path(file)
+    end
+
+    def convert_to_format(object, options)
+      path = options[:output] || current_dir_path(object.initial_path,
+                                                  options[:format])
+      to_format(object, options[:format]).write(path)
+      Vectory.ui.info("Output file was written to #{path}")
+
+      STATUS_SUCCESS
+    rescue Vectory::Error => e
+      handle_vectory_error(e)
+    end
+
+    def handle_vectory_error(exception)
+      Vectory.ui.error(exception.message)
+
+      MAP_ERROR_TO_STATUS[exception.class] || raise(exception)
+    end
+
+    def current_dir_path(input_path, output_format)
+      File.join(Dir.pwd, "#{File.basename(input_path, '.*')}.#{output_format}")
+    end
+
+    def to_format(object, format)
+      method_name = "to_#{format}"
+      object.public_send(method_name)
+    end
+  end
+end

data/lib/vectory/datauri.rb

@@ -0,0 +1,48 @@
+require "base64"
+
+module Vectory
+  class Datauri < Image
+    REGEX = %r{^
+      data:
+      (?<mimetype>[^;]+);
+      (?:charset=[^;]+;)?
+      base64,
+      (?<data>.+)
+    $}x.freeze
+
+    def self.from_vector(vector)
+      mimetype = vector.class.mimetype
+      content = vector.content.gsub("\r\n", "\n")
+      data = Base64.strict_encode64(content)
+
+      new("data:#{mimetype};base64,#{data}")
+    end
+
+    def to_vector
+      match = parse_datauri(@content)
+      content = Base64.strict_decode64(match[:data])
+      image_class = detect_image_class(match[:mimetype])
+
+      image_class.from_content(content)
+    end
+
+    private
+
+    def parse_datauri(uri)
+      match = REGEX.match(uri)
+      return match if match
+
+      raise ConversionError, "Could not parse datauri: '#{uri.slice(0, 30)}'."
+    end
+
+    def detect_image_class(image_type)
+      case image_type
+      when Eps.mimetype then return Eps
+      when Emf.mimetype then return Emf
+      when Svg.mimetype then return Svg
+      end
+
+      raise ConversionError, "Could not detect image type '#{image_type}'."
+    end
+  end
+end

data/lib/vectory/emf.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "emf2svg"
+
+module Vectory
+  class Emf < Vector
+    def self.default_extension
+      "emf"
+    end
+
+    def self.mimetype
+      "image/emf"
+    end
+
+    def to_svg
+      with_file("emf") do |input_path|
+        content = Emf2svg.from_file(input_path).sub(/<\?[^>]+>/, "")
+
+        Svg.from_content(content)
+      end
+    end
+
+    def to_eps
+      convert_with_inkscape("--export-type=eps", Eps)
+    end
+
+    def to_ps
+      convert_with_inkscape("--export-type=ps", Ps)
+    end
+  end
+end

data/lib/vectory/eps.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Vectory
+  class Eps < Vector
+    def self.default_extension
+      "eps"
+    end
+
+    def self.mimetype
+      "application/postscript"
+    end
+
+    def to_ps
+      convert_with_inkscape("--export-type=ps", Ps)
+    end
+
+    def to_svg
+      convert_with_inkscape("--export-plain-svg --export-type=svg", Svg)
+    end
+
+    def to_emf
+      convert_with_inkscape("--export-type=emf", Emf)
+    end
+
+    private
+
+    def imgfile_suffix(uri, suffix)
+      "#{File.join(File.dirname(uri), File.basename(uri, '.*'))}.#{suffix}"
+    end
+  end
+end

data/lib/vectory/file_magic.rb

@@ -0,0 +1,53 @@
+module Vectory
+  class FileMagic
+    EPS_30_MAGIC = "\x25\x21\x50\x53\x2d\x41\x64\x6f\x62\x65\x2d\x33\x2e\x30" \
+                   "\x20\x45\x50\x53\x46\x2d\x33\x2e\x30"
+      .force_encoding("BINARY") # "%!PS-Adobe-3.0 EPSF-3.0"
+
+    EPS_31_MAGIC = "\x25\x21\x50\x53\x2d\x41\x64\x6f\x62\x65\x2d\x33\x2e\x31" \
+                   "\x20\x45\x50\x53\x46\x2d\x33\x2e\x30"
+      .force_encoding("BINARY") # "%!PS-Adobe-3.1 EPSF-3.0"
+
+    PS_MAGIC = "\x25\x21\x50\x53\x2d\x41\x64\x6f\x62\x65\x2d\x33\x2e\x30"
+      .force_encoding("BINARY") # "%!PS-Adobe-3.0"
+
+    EMF_MAGIC = "\x01\x00\x00\x00".force_encoding("BINARY")
+
+    def self.detect(path)
+      new(path).detect
+    end
+
+    def initialize(path)
+      @path = path
+    end
+
+    def detect
+      beginning = File.read(@path, 100, mode: "rb")
+
+      eps_slice = beginning.byteslice(0, EPS_30_MAGIC.size)
+      Vectory.ui.debug("File magic is '#{to_bytes(beginning)}' of '#{@path}'.")
+
+      return :eps if [EPS_30_MAGIC, EPS_31_MAGIC].include?(eps_slice)
+
+      ps_slice = beginning.byteslice(0, PS_MAGIC.size)
+      return :ps if ps_slice == PS_MAGIC
+
+      emf_slice = beginning.byteslice(0, EMF_MAGIC.size)
+      return :emf if emf_slice == EMF_MAGIC
+
+      return :svg if contain_svg_tag?
+    end
+
+    private
+
+    def to_bytes(str)
+      str.unpack("c*").map { |e| "\\x#{e.to_s(16).rjust(2, '0')}" }.join
+    end
+
+    def contain_svg_tag?
+      content = File.read(@path, 4096)
+
+      return :svg if content.include?("<svg")
+    end
+  end
+end

data/lib/vectory/image.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+
+module Vectory
+  class Image
+    class << self
+      def from_path(path)
+        new(File.read(path, mode: "rb"))
+      end
+
+      def from_content(content)
+        new(content)
+      end
+    end
+
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+  end
+end

data/lib/vectory/inkscape_converter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "singleton"
+require_relative "system_call"
+
+module Vectory
+  class InkscapeConverter
+    include Singleton
+
+    def self.convert(uri, output_extension, option)
+      instance.convert(uri, output_extension, option)
+    end
+
+    def convert(uri, output_extension, option)
+      exe = inkscape_path_or_raise_error(uri)
+      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)
+
+      # and return Vectory::Utils::datauri(file)
+
+      output_path
+    end
+
+    private
+
+    def inkscape_path_or_raise_error(path)
+      inkscape_path or raise(InkscapeNotFoundError,
+                             "Inkscape missing in PATH, unable to " \
+                             "convert image #{path}. Aborting.")
+    end
+
+    def inkscape_path
+      cmd = "inkscape"
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+
+      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)
+        end
+      end
+
+      nil
+    end
+
+    def raise_conversion_error(call)
+      raise Vectory::ConversionError,
+            "Could not convert with Inkscape. " \
+            "Inkscape cmd: '#{call.cmd}',\n" \
+            "status: '#{call.status}',\n" \
+            "stdout: '#{call.stdout.strip}',\n" \
+            "stderr: '#{call.stderr.strip}'."
+    end
+
+    def external_path(path)
+      win = !!((RUBY_PLATFORM =~ /(win|w)(32|64)$/) ||
+               (RUBY_PLATFORM =~ /mswin|mingw/))
+      if win
+        path.gsub!(%{/}, "\\")
+        path[/\s/] ? "\"#{path}\"" : path
+      else
+        path
+      end
+    end
+  end
+end

data/lib/vectory/ps.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Vectory
+  class Ps < Vector
+    def self.default_extension
+      "ps"
+    end
+
+    def self.mimetype
+      "application/postscript"
+    end
+
+    def to_eps
+      convert_with_inkscape("--export-type=eps", Eps)
+    end
+
+    def to_emf
+      convert_with_inkscape("--export-type=emf", Emf)
+    end
+
+    def to_svg
+      convert_with_inkscape("--export-type=svg", Svg)
+    end
+  end
+end