emf2svg 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58349fd10f19ee509fc7cf20602f619dcb9c4b45d65e4ac84f9c7a4cddc178fe
-  data.tar.gz: ef2081e0fe533572dfb963816f83ff022b9b1ebe3d9827966d91bb1b9954acb3
+  metadata.gz: 2f40393f8fd1ee8fac3c0bac60dd57cdffa37e7c29fe4c84654a1c09fd3eddc6
+  data.tar.gz: 1177ab6679786bfaa7ee08dec8c38ac52cf7c9367c83a2c8197569950266c7df
 SHA512:
-  metadata.gz: ba52fc1c6c6e285d5d10401fbad1723410f807ac3977b334137cbc9f226afcc32fd505aff2c4f3bce67464bb4583b8368fabf523c2d5e7c07d0a57f365d6325a
-  data.tar.gz: 41da88dbc8a1f9598cffec8750d73f8a3bbf683be8b924373721781f8e055098c56de23ba27049a3bd2840d87f07eab60765020b7609a43d4e5f5a980cafdfed
+  metadata.gz: a969bc6a4061541d00b0385951622f0d640d96f2d03a5a9081e9b583b4b60e4527e331ea88c287a9049ace569e85f9473bfaca9d029a5ed0122091ef43778f5c
+  data.tar.gz: 688381d0362f87e799bbe26a18d673a3eda30f2eaa4e7c2e39d3e925f90304726d97b32d5d8e195c6fd1493c0dddc5643e08e1a0973d710eb3e1dbe2512690f3

data/.github/workflows/main.yml

@@ -1,16 +1,69 @@
-name: Ruby
+name: main
 
-on: [push,pull_request]
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
 
 jobs:
-  build:
-    runs-on: ubuntu-latest
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6.6
         bundler-cache: true
-    - name: Run the default task
-      run: bundle exec rake
+
+    - run: bundle exec rake
+
+  build-gem:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rake build
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: pkg
+          path: pkg/*.gem
+
+  test-gem:
+    needs: build-gem
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-18.04, ubuntu-latest, windows-latest, macos-latest ]
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: pkg
+          path: pkg
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - name: Install gem
+        run: gem install --no-document pkg/emf2svg-*.gem
+
+      - name: Test conversion
+        run: |
+          ruby -remf2svg -e "puts File.write('output.svg', Emf2svg.from_file('spec/examples/image1.emf'), mode: 'wb')"

data/.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-18.04
+    steps:
+      - uses: actions/checkout@v1
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rake
+
+      - name: Publish to rubygems.org
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.METANORMA_CI_RUBYGEMS_API_KEY}}
+        run: |
+          gem install gem-release
+          touch ~/.gem/credentials
+          cat > ~/.gem/credentials << EOF
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          git status
+          gem release

data/.gitignore

@@ -6,6 +6,15 @@
 /pkg/
 /spec/reports/
 /tmp/
+/ports/
+/Gemfile.lock
+*.installed
+*.dll
+*.dylib
+*.so
 
 # rspec failure tracking
 .rspec_status
+
+# remote file cache
+.rubocop-*

data/.rubocop.yml

@@ -1,13 +1,5 @@
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+inherit_from:
+  - 'https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml'
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
+AllCops:
+  TargetRubyVersion: 2.5

data/README.adoc

@@ -22,12 +22,80 @@ Or add it to your `Gemfile`:
 gem 'emf2svg'
 ----
 
+=== Dependencies
+
+* libiconv
+* libpng
+* libfontconfig
+* libfreetype
+
+==== Windows
+
+On Windows all necessary libraries are precompiled but you'll need Visual
+Studio 2019 with C++ Build Tools, which can be downloaded
+https://visualstudio.microsoft.com/downloads/[here], or installed with
+Chocolatey:
+
+[source,sh]
+----
+choco install visualstudio2019buildtools -y --no-progress --package-parameters "--add Microsoft.VisualStudio.Workload.VCTools --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows10SDK.18362"
+----
+
+==== macOS
+
+[source,sh]
+----
+brew install cmake
+----
+
+==== Linux
+
+===== Debian
+
+[source,sh]
+----
+# compiler
+apt-get install gcc g++
+# or
+apt-get install clang
+
+# build deps
+apt-get install cmake pkg-config
+
+# library deps with their headers
+apt-get install libpng-dev libc6-dev libfontconfig1-dev libfreetype6-dev zlib1g-dev
+----
+
+===== Fedora
+
+[source,sh]
+----
+yum install cmake libpng-devel freetype-devel fontconfig-devel gcc-c++ gcc
+----
+
 == Usage
 
 This gem embeds libemf2svg, allowing your Ruby code to utilize EMF to SVG
 conversion facilities.
 
-TODO.
+[source,ruby]
+----
+require "emf2svg"
+
+data = Emf2svg.from_file("example.emf")
+File.write("output.svg", data, mode: "wb")
+----
+
+It also can use content of emf as an input:
+
+[source,ruby]
+----
+require "emf2svg"
+
+emf_content = File.read("example.emf", mode: "rb")
+svg_data = Emf2svg.from_binary_string(emf_content)
+File.write("output.svg", svg_data, mode: "wb")
+----
 
 == Development
 
@@ -41,6 +109,25 @@ release a new version, update the version number in `version.rb`, and then run
 git commits and the created tag, and push the `.gem` file to
 https://rubygems.org[rubygems.org].
 
+=== 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/Rakefile

@@ -10,3 +10,8 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+task :compile do
+  require_relative "ext/extconf"
+end
+task spec: :compile

data/bin/emf2svg

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "emf2svg"
+
+svg = Emf2svg.from_file(ARGV[0])
+File.write(ARGV[1], svg, mode: "wb")

data/emf2svg.gemspec

@@ -17,15 +17,21 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/metanorma/emf2svg-ruby"
   spec.metadata["changelog_uri"] = "https://github.com/metanorma/emf2svg-ruby"
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_runtime_dependency "ffi", "~> 1.0"
+  spec.add_runtime_dependency "mini_portile2", "~> 2.6"
+
+  spec.add_development_dependency "rubocop", "1.5.2"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rails"
+
+  spec.extensions = ["ext/extconf.rb"]
 end

data/exe/emf2svg

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "emf2svg"
+
+svg = Emf2svg.from_file(ARGV[0])
+File.write(ARGV[1], svg, mode: "wb")

data/ext/Makefile

@@ -0,0 +1,4 @@
+# dummy Makefile, it is required to build an extension
+all:
+clean:
+install:

data/ext/extconf.rb

@@ -0,0 +1,6 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), "../lib"))
+
+require "emf2svg/recipe"
+
+recipe = Emf2svg::Recipe.new
+recipe.cook

data/lib/emf2svg/recipe.rb

@@ -0,0 +1,92 @@
+require "mini_portile2"
+require "pathname"
+require "tmpdir"
+
+module Emf2svg
+  class Recipe < MiniPortileCMake
+    ROOT = Pathname.new(File.expand_path("../..", __dir__))
+
+    def initialize
+      super("libemf2svg", "1.3.0")
+
+      @files << {
+        url: "https://github.com/metanorma/libemf2svg/releases/download/1.3.0/libemf2svg.tar.gz",
+        sha256: "aacbf001701e3f863e97c6c117146ee710636283851d866b715de653fb79343e", # rubocop:disable Layout/LineLength
+      }
+
+      @target = ROOT.join(@target).to_s
+      @printed = {}
+    end
+
+    def cook_if_not
+      cook unless File.exist?(checkpoint)
+    end
+
+    def cook
+      super
+
+      FileUtils.touch(checkpoint)
+    end
+
+    def checkpoint
+      File.join(@target, "#{name}-#{version}-#{host}.installed")
+    end
+
+    def configure_defaults
+      opts = []
+
+      opts << "-DCMAKE_BUILD_TYPE=Release"
+
+      if MiniPortile.windows?
+        opts << "-DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake"
+        opts << "-GVisual Studio 16 2019"
+      end
+
+      opts
+    end
+
+    def compile
+      execute("compile", "#{make_cmd} --target emf2svg")
+    end
+
+    def make_cmd
+      "cmake --build #{File.expand_path(work_path)} --config Release"
+    end
+
+    def install
+      libs = if MiniPortile.windows?
+               Dir.glob(File.join(work_path, "Release", "*.dll"))
+             else
+               Dir.glob(File.join(work_path, "libemf2svg.{so,dylib}"))
+                 .grep(/\/(?:lib)?[a-zA-Z0-9\-]+\.(?:so|dylib)$/)
+             end
+
+      FileUtils.cp_r(libs, ROOT.join("lib", "emf2svg"), verbose: true)
+    end
+
+    def execute(action, command, command_opts = {})
+      super(action, command, command_opts.merge(debug: true))
+    end
+
+    def message(text)
+      return super unless text.start_with?("\rDownloading")
+
+      match = text.match(/(\rDownloading .*)\(\s*\d+%\)/)
+      pattern = match ? match[1] : text
+      return if @printed[pattern]
+
+      @printed[pattern] = true
+      super
+    end
+
+    private
+
+    def tmp_path
+      @tmp_path ||= Dir.mktmpdir
+    end
+
+    def port_path
+      "port"
+    end
+  end
+end

data/lib/emf2svg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Emf2svg
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/emf2svg.rb

@@ -1,8 +1,70 @@
 # frozen_string_literal: true
 
+require "ffi"
 require_relative "emf2svg/version"
 
 module Emf2svg
   class Error < StandardError; end
-  # Your code goes here...
+
+  class GeneratorOptions < FFI::Struct
+    layout :nameSpace, :string,
+           :verbose, :bool,
+           :emfplus, :bool,
+           :svgDelimiter, :bool,
+           :imgHeight, :double,
+           :imgWidth, :double
+  end
+
+  extend FFI::Library
+
+  lib_filename = if FFI::Platform.windows?
+                   "emf2svg.dll"
+                 elsif FFI::Platform.mac?
+                   "libemf2svg.dylib"
+                 else
+                   "libemf2svg.so"
+                 end
+
+  ffi_lib File.expand_path("emf2svg/#{lib_filename}", __dir__)
+    .gsub("/", File::ALT_SEPARATOR || File::SEPARATOR)
+
+  attach_function :emf2svg,
+                  [
+                    :pointer,
+                    :size_t,
+                    :pointer,
+                    :pointer,
+                    GeneratorOptions.by_ref,
+                  ],
+                  :int
+
+  class << self
+    def from_file(path)
+      content = File.read(path, mode: "rb")
+      from_binary_string(content)
+    end
+
+    def from_binary_string(content)
+      svg_out = FFI::MemoryPointer.new(:pointer)
+      svg_out_len = FFI::MemoryPointer.new(:pointer)
+      content_ptr = FFI::MemoryPointer.from_string(content)
+
+      ret = emf2svg(content_ptr, content.size, svg_out, svg_out_len, options)
+      raise Error, "emf2svg failed with error code: #{ret}" unless ret == 1
+
+      svg_out.read_pointer.read_bytes(svg_out_len.read_int)
+    end
+
+    private
+
+    def options
+      GeneratorOptions.new.tap do |opts|
+        opts[:verbose] = false
+        opts[:emfplus] = true
+        opts[:svgDelimiter] = true
+        opts[:imgHeight] = 0
+        opts[:imgWidth] = 0
+      end
+    end
+  end
 end

metadata

@@ -1,23 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: emf2svg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ribose
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
-dependencies: []
-description:
+date: 2021-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mini_portile2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
 email:
 - open.source@ribose.com
-executables: []
-extensions: []
+executables:
+- emf2svg
+extensions:
+- ext/extconf.rb
 extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -26,9 +99,14 @@ files:
 - README.adoc
 - Rakefile
 - bin/console
+- bin/emf2svg
 - bin/setup
 - emf2svg.gemspec
+- exe/emf2svg
+- ext/Makefile
+- ext/extconf.rb
 - lib/emf2svg.rb
+- lib/emf2svg/recipe.rb
 - lib/emf2svg/version.rb
 homepage: https://github.com/metanorma/emf2svg-ruby
 licenses: []
@@ -36,7 +114,7 @@ metadata:
   homepage_uri: https://github.com/metanorma/emf2svg-ruby
   source_code_uri: https://github.com/metanorma/emf2svg-ruby
   changelog_uri: https://github.com/metanorma/emf2svg-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Ruby interface to libemf2svg.
 test_files: []