vectory 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865823bf5ac58c0780cdffc76abf7d396c2b481bcf292c807e419c0983f44646
-  data.tar.gz: cd29b9a6f1c3a851e37fa207427474a60656ad8a1ba6f27d954d08d2ded47f5d
+  metadata.gz: 2f51d610adc333c06f92e8e28ca9722a890f12b03668bf12e96ce057d2574dea
+  data.tar.gz: 792bc815a0b86a6211b83268f16b9abe7a138aba0081a2d7a95242c5e9a7af82
 SHA512:
-  metadata.gz: 01ee6626bca7c7a61f14dffa639355171e052637f9b1c58d4dfb39721a7b7a815e6b11cd5c1deb76b4faecba37abf873e45661c16ebd2eaf7434cb9031a6deff
-  data.tar.gz: 6706861380815c36d273445cc970db3b01693024208596c8072e9661ab301908db5c6c81e7d707826b501263aac8dbcc4b65f553fc62857a773cb45404d53de4
+  metadata.gz: 249d3f2fa7df2d216cdf5d046647507b81a55bd5db56a603a90a3890501adb10e8a03f41b272385c65a8de48c50b8b52db743ec5ddc20be88e4e5aab6ed21ca6
+  data.tar.gz: 5ed331050b3c4a3231cabc7ba061695f017de5ea44a3056bf01537144b12c96cf5587c0a52793d3d435d961052210aefed73a52c4afc9c3563695fca8e23c91d

data/README.adoc

@@ -329,6 +329,23 @@ 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
 

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/inkscape_converter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "singleton"
+require "tmpdir"
 require_relative "system_call"
 
 module Vectory
@@ -12,7 +13,7 @@ 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})
@@ -27,12 +28,20 @@ module Vectory
       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
@@ -95,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/system_call.rb

@@ -33,7 +33,6 @@ module Vectory
       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]

data/lib/vectory/vector.rb

@@ -28,6 +28,28 @@ module Vectory
       @initial_path = initial_path
     end
 
+    def mime
+      self.class.mimetype
+    end
+
+    def size
+      content.bytesize
+    end
+
+    def file_size
+      raise(NotWrittenToDiskError) unless @path
+
+      File.size(@path)
+    end
+
+    def height
+      InkscapeConverter.instance.height(content, self.class.default_extension)
+    end
+
+    def width
+      InkscapeConverter.instance.width(content, self.class.default_extension)
+    end
+
     def to_uri
       Datauri.from_vector(self)
     end

data/lib/vectory/version.rb

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

data/lib/vectory.rb

@@ -21,6 +21,8 @@ module Vectory
 
   class InkscapeNotFoundError < Error; end
 
+  class InkscapeQueryError < Error; end
+
   class NotImplementedError < Error; end
 
   class NotWrittenToDiskError < Error; end

data/spec/support/matchers.rb

@@ -1,3 +1,15 @@
+RSpec::Matchers.define :be_eps do
+  match do |actual|
+    actual.start_with?("%!PS-Adobe-3.0")
+  end
+end
+
+RSpec::Matchers.define :be_svg do
+  match do |actual|
+    actual.include?("<svg")
+  end
+end
+
 RSpec::Matchers.define :be_equivalent_eps_to do |expected|
   match do |actual|
     e = sub_time_and_version(expected)

data/spec/vectory/cli_spec.rb

@@ -11,10 +11,11 @@ RSpec.describe Vectory::CLI do
     shared_examples "converter" do |format|
       it "creates file of a chosen format" do
         matcher = case format
-                  when "eps", "ps" then "be_equivalent_eps_to"
-                  when "svg" then "be_equivalent_svg_to"
+                  when "eps", "ps" then "be_eps"
+                  when "svg" then "be_svg"
                   else "be_equivalent_to"
                   end
+
         with_tmp_dir do |dir|
           output = File.join(dir, "output.#{format}")
           status = described_class.start(["-f", format, "-o", output, input])

data/spec/vectory/datauri_spec.rb

@@ -98,4 +98,84 @@ RSpec.describe Vectory::Datauri do
       end
     end
   end
+
+  describe "#mime" do
+    context "incorrect data" do
+      let(:not_a_datauri) { "123abc" }
+
+      it "raises conversion error" do
+        expect { described_class.new(not_a_datauri).mime }
+          .to raise_error(Vectory::ConversionError)
+      end
+    end
+
+    context "eps" do
+      let(:input) { "spec/examples/eps2emf/img.eps.datauri" }
+
+      it "returns eps" do
+        expect(described_class.from_path(input).mime)
+          .to eq "application/postscript"
+      end
+    end
+
+    context "emf" do
+      let(:input) { "spec/examples/emf2eps/img.emf.datauri" }
+
+      it "returns emf" do
+        expect(described_class.from_path(input).mime).to eq "image/emf"
+      end
+    end
+
+    context "svg" do
+      let(:input) { "spec/examples/svg2emf/img.svg.datauri" }
+
+      it "returns svg" do
+        expect(described_class.from_path(input).mime).to eq "image/svg+xml"
+      end
+    end
+  end
+
+  describe "dimensions (#height / #width)" do
+    context "incorrect data" do
+      let(:not_a_datauri) { "123abc" }
+
+      it "raises conversion error" do
+        expect { described_class.new(not_a_datauri).height }
+          .to raise_error(Vectory::ConversionError)
+
+        expect { described_class.new(not_a_datauri).width }
+          .to raise_error(Vectory::ConversionError)
+      end
+    end
+
+    context "eps" do
+      let(:input) { "spec/examples/eps2emf/img.eps.datauri" }
+
+      it "returns height and width" do
+        expect(described_class.from_path(input).height)
+          .to eq 707
+
+        expect(described_class.from_path(input).width)
+          .to eq 649
+      end
+    end
+
+    context "emf" do
+      let(:input) { "spec/examples/emf2eps/img.emf.datauri" }
+
+      it "returns height and width" do
+        expect(described_class.from_path(input).height).to eq 90
+        expect(described_class.from_path(input).width).to eq 90
+      end
+    end
+
+    context "svg" do
+      let(:input) { "spec/examples/svg2emf/img.svg.datauri" }
+
+      it "returns height and width" do
+        expect(described_class.from_path(input).height).to eq 90
+        expect(described_class.from_path(input).width).to eq 90
+      end
+    end
+  end
 end

data/spec/vectory/emf_spec.rb

@@ -35,4 +35,28 @@ RSpec.describe Vectory::Emf do
         .to be_equivalent_eps_to File.read(reference)
     end
   end
+
+  describe "#mime" do
+    let(:input) { "spec/examples/emf2eps/img.emf" }
+
+    it "returns emf" do
+      expect(described_class.from_path(input).mime).to eq "image/emf"
+    end
+  end
+
+  describe "#height" do
+    let(:input) { "spec/examples/emf2eps/img.emf" }
+
+    it "returns height" do
+      expect(described_class.from_path(input).height).to eq 90
+    end
+  end
+
+  describe "#width" do
+    let(:input) { "spec/examples/emf2eps/img.emf" }
+
+    it "returns width" do
+      expect(described_class.from_path(input).width).to eq 90
+    end
+  end
 end

data/spec/vectory/eps_spec.rb

@@ -3,16 +3,18 @@ require "spec_helper"
 RSpec.describe Vectory::Eps do
   shared_examples "converter" do |format|
     it "returns content of a chosen format" do
+      to_format_method = "to_#{format}"
+      content = described_class.from_path(input)
+        .public_send(to_format_method)
+        .content
+
       matcher = case format
-                when "eps", "ps" then "be_equivalent_eps_to"
-                when "svg" then "be_equivalent_svg_to"
+                when "eps", "ps" then "be_eps"
+                when "svg" then "be_svg"
                 else "be_equivalent_to"
                 end
 
-      to_format_method = "to_#{format}"
-      expect(described_class.from_path(input)
-                            .public_send(to_format_method)
-                            .content)
+      expect(content)
         .to public_send(matcher, File.read(reference))
     end
   end
@@ -37,4 +39,29 @@ RSpec.describe Vectory::Eps do
 
     it_behaves_like "converter", "emf"
   end
+
+  describe "#mime" do
+    let(:input) { "spec/examples/eps2emf/img.eps" }
+
+    it "returns postscript" do
+      expect(described_class.from_path(input).mime)
+        .to eq "application/postscript"
+    end
+  end
+
+  describe "#height" do
+    let(:input) { "spec/examples/eps2emf/img.eps" }
+
+    it "returns height" do
+      expect(described_class.from_path(input).height).to eq 707
+    end
+  end
+
+  describe "#width" do
+    let(:input) { "spec/examples/eps2emf/img.eps" }
+
+    it "returns width" do
+      expect(described_class.from_path(input).width).to eq 649
+    end
+  end
 end

data/spec/vectory/ps_spec.rb

@@ -30,4 +30,29 @@ RSpec.describe Vectory::Ps do
         .to be_equivalent_svg_to File.read(reference)
     end
   end
+
+  describe "#mime" do
+    let(:input) { "spec/examples/ps2emf/img.ps" }
+
+    it "returns postscript" do
+      expect(described_class.from_path(input).mime)
+        .to eq "application/postscript"
+    end
+  end
+
+  describe "#height" do
+    let(:input) { "spec/examples/ps2emf/img.ps" }
+
+    it "returns height" do
+      expect(described_class.from_path(input).height).to eq 707
+    end
+  end
+
+  describe "#width" do
+    let(:input) { "spec/examples/ps2emf/img.ps" }
+
+    it "returns width" do
+      expect(described_class.from_path(input).width).to eq 649
+    end
+  end
 end

data/spec/vectory/svg_spec.rb

@@ -38,4 +38,36 @@ RSpec.describe Vectory::Svg do
         .to be_equivalent_eps_to File.read(reference)
     end
   end
+
+  describe "#mime" do
+    let(:input) { "spec/examples/svg2emf/img.svg" }
+
+    it "returns svg" do
+      expect(described_class.from_path(input).mime).to eq "image/svg+xml"
+    end
+  end
+
+  describe "#height" do
+    let(:input) { "spec/examples/svg2emf/img.svg" }
+
+    it "returns height" do
+      expect(described_class.from_path(input).height).to eq 90
+    end
+
+    context "incorrect data" do
+      let(:command) { described_class.from_content("incorrect123svg") }
+
+      it "raises query error" do
+        expect { command.height }.to raise_error(Vectory::InkscapeQueryError)
+      end
+    end
+  end
+
+  describe "#width" do
+    let(:input) { "spec/examples/svg2emf/img.svg" }
+
+    it "returns width" do
+      expect(described_class.from_path(input).width).to eq 90
+    end
+  end
 end

data/spec/vectory/vector_spec.rb

@@ -56,5 +56,42 @@ RSpec.describe Vectory::Vector do
         expect { image.path }.to raise_error(Vectory::NotWrittenToDiskError)
       end
     end
+
+    context "written to disk" do
+      before { image.write }
+
+      it "returns path on a disk" do
+        expect(image.path).to include(Dir.tmpdir)
+      end
+    end
+  end
+
+  describe "#size" do
+    let(:image) { Vectory::Emf.from_path("spec/examples/emf2svg/img.emf") }
+
+    it "returns content size" do
+      expect(image.size).to eq 1060
+    end
+  end
+
+  describe "#file_size" do
+    let(:image) { Vectory::Eps.from_path("spec/examples/eps2emf/img.eps") }
+
+    context "not written to disk" do
+      it "raises not-written error" do
+        expect { image.file_size }
+          .to raise_error(Vectory::NotWrittenToDiskError)
+      end
+    end
+
+    context "written to disk" do
+      before { image.write }
+
+      it "returns file size" do
+        expect(image.file_size).to satisfy("be either 2926 or 3125") do |v|
+          [2926, 3125].include?(v) # depends on file system
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vectory
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: emf2svg