emf2svg 1.4.0-x86_64-darwin → 1.4.1-x86_64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d6aef7d3b38378da721516ed04964f29704848dff6a5b8c4ad3874de99192ab
-  data.tar.gz: '018b4fd896e429ed836eaae6282dcc7f66a8f4dac3aeed813169f3bbb98867ff'
+  metadata.gz: f51b9e4b995e2b4e7e3c1d566ceee3c2bf74d110fc5192bb2cb457b582ea547a
+  data.tar.gz: 3e7e74e94f5ce9ef21ca0371bf096975f1e9cfdd06f80dec6d1b849e5621a177
 SHA512:
-  metadata.gz: 5398c6033cc91d4f5e010298de5d332791bdf0688f3c9717d21a592f797593af74b050a28d05ead793ef2024d30e37636fb16bde5b5e6d3e6231b55eb596ae2d
-  data.tar.gz: 137af5ee5023efca8938b6c760c897dd024cd43f2356e7a87def288eac22c9711ad0755f335a6bd759fc68f409cc088e01a63b1be0117a073498d24a0b25029e
+  metadata.gz: d4e36a17c578cbc8559308b580b4c2ebb03f2f24edf86bdddd45a97998784c0e5126fa7f95c70dfeca10170d362b91e139aaf4dd7b1754d82c046a010c88e0da
+  data.tar.gz: f3f0f8a217eedf30e8807df233858401b9770fff1e07a482a6f2ba6ba6991a3cf629b4f174e1bb70c407c47af64740ea8e6cc0f5e4923b1cc3114fbb236beb1c

data/.github/workflows/build.yml

@@ -38,6 +38,7 @@ jobs:
     - run: bundle exec rake
 
   build:
+    name: build ${{ matrix.os }}, ${{ matrix.ruby-version }}, ${{ matrix.platform }}
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -46,18 +47,23 @@ jobs:
           - os: ubuntu-18.04
             platform: any
             ruby-version: '2.7'
+            file: 'skip'
           - os: ubuntu-18.04
             platform: x86_64-linux
             ruby-version: '2.7'
+            file: 'ELF 64-bit LSB shared object, x86-64'
           - os: windows-latest
             platform: x64-mingw32
             ruby-version: '2.7'
+            file: 'skip'
           - os: windows-latest
             platform: x64-mingw-ucrt
             ruby-version: '3.1'
+            file: 'skip'
           - os: macos-latest
             platform: x86_64-darwin
             ruby-version: '2.7'
+            file: 'Mach-O 64-bit dynamically linked shared library x86_64'
     steps:
     - uses: actions/checkout@v3
 
@@ -86,6 +92,10 @@ jobs:
       run: |
         ruby -remf2svg -e "puts File.write('output.svg', Emf2svg.from_file('spec/examples/image1.emf'), mode: 'wb')"
 
+    - name: Check file format
+      if: matrix.file != 'skip'
+      run: file $(ls pkg/*/lib/emf2svg/libemf2svg.*) | grep "${{ matrix.file }}"
+
   test-build:
     needs: build
     runs-on: ${{ matrix.os }}
@@ -149,16 +159,20 @@ jobs:
         ruby -remf2svg -e "puts File.write('output.svg', Emf2svg.from_file('spec/examples/image1.emf'), mode: 'wb')"
 
   cross:
+    name: build ${{ matrix.os }}, ${{ matrix.ruby-version }}, ${{ matrix.platform }}
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         include:
           - os: ubuntu-latest
             platform: aarch64-linux
             ruby-version: '2.7'
+            file: 'ELF 64-bit LSB shared object, ARM aarch64'
           - os: macos-latest
             platform: arm64-darwin
             ruby-version: '2.7'
+            file: 'Mach-O 64-bit dynamically linked shared library arm64'
     steps:
     - uses: actions/checkout@v3
 
@@ -182,3 +196,6 @@ jobs:
 
     - name: Install gem
       run: gem install -b pkg/emf2svg-*.gem
+
+    - name: Check file format
+      run: file $(ls pkg/*/lib/emf2svg/libemf2svg.*) | grep "${{ matrix.file }}"

data/README.adoc

@@ -1,18 +1,23 @@
+= emf2svg Ruby gem for EMF to SVG conversion
+
 image:https://github.com/metanorma/emf2svg-ruby/actions/workflows/build.yml/badge.svg["Build", link="https://github.com/metanorma/emf2svg-ruby/actions/workflows/build.yml"]
 image:https://badge.fury.io/rb/emf2svg.svg["Gem Version", link="https://badge.fury.io/rb/emf2svg"]
 
+== Purpose
+
+The `emf2svg` Ruby gem provides a Ruby interface to the
+https://github.com/kakwa/libemf2svg[libemf2svg] EMF-to-SVG conversion library.
+
+NOTE: This gem currently uses the
+https://github.com/metanorma/libemf2svg[Metanorma fork of libemf2svg]
+until feature up-streaming is complete.
 
-= emf2svg
+== Prerequisites
 
-== Overview
-emf2svg-ruby provides Ruby front-end to emf to svg converter https://github.com/kakwa/libemf2svg (temporarily using
-the https://github.com/metanorma/libemf2svg[Metanorma fork] until upstreaming
-is complete).
+* Ruby version >= 2.6
 
-== Requirements:
-Ruby >= 2.6
+== Install
 
-== Installation
 Install the gem directly:
 
 [source,sh]
@@ -27,28 +32,100 @@ Or add it to your `Gemfile`:
 gem 'emf2svg'
 ----
 
-=== Packaging
-We distribute pre-compiled libraries for a set of machine architecture. On supported platforms, this removes the need
-for compiling the C extension and installation of system dependencies. This results in much faster and more reliable installation.
+NOTE: For more information on how to install by compiling from source, see
+<<install-from-source>>.
+
+
+== Usage
+
+This gem provides an interface to `libemf2svg`, allowing your Ruby code to
+directly utilize EMF to SVG conversion facilities.
+
+There are two ways to provide EMF data to `emf2svg`.
+
+=== Loading from file
+
+`Emf2svg.from_file`:: Loads an EMF file directly from the filesystem.
+
+[example]
+.Example of using `Emf2svg.from_file` and exporting an SVG file
+====
+[source,ruby]
+----
+require "emf2svg"
+
+data = Emf2svg.from_file("example.emf")
+File.write("output.svg", data, mode: "wb")
+----
+====
+
+=== Loading binary data
+
+`Emf2svg.from_binary_string`:: Loads EMF content from binary form.
+
+[example]
+.Example of using `Emf2svg.from_binary_string` and exporting an SVG file
+====
+[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")
+----
+====
+
+
+[[packaging]]
+== Packaging
+
+=== Pre-compiled extensions or building from source
+
+This gem is distributed with pre-compiled native extensions for a set of
+supported machine architectures.
+
+On supported platforms, this removes the need for compiling the C extension and
+the installation of system dependencies. This results in much faster and a more
+reliable installation step.
+
+The pre-compiled platforms are:
 
-==== Native extensions
-* x86_64-linux   (GNU and musl flavors)
-* aarch64-linux  (GNU and musl flavors)
-* x86_64-darwin
-* arm64-darwin
-* x64-mingw32
-* x64-mingw-ucrt
+* `x86_64-linux` (GNU and `musl` flavors)
+* `aarch64-linux` (GNU and `musl` flavors)
+* `x86_64-darwin`
+* `arm64-darwin`
+* `x64-mingw32`
+* `x64-mingw-ucrt`
 
-=== Building GEM from source
-emf2svg build script maintaince and installs all required libraries and other dependencies using vcpkg package manager
-You still need to install appropriate build system (like gcc, clang or Visual Studio) and cmake
-On Debian systems there is vcpkg bug [https://github.com/microsoft/vcpkg/issues/15931] that needs to be addressed by installing gperf package:
+When installing the gem, Ruby will automatically select a pre-compiled version
+suitable for your platform, or opt to install from source if the platform
+is not supported.
+
+[[install-from-source]]
+=== Installing from source
+
+==== General
+
+For platforms that require compilation, the `emf2svg` build script will
+automatically compile the native extension locally.
+
+The `emf2svg` build script maintains and installs all required libraries and
+other dependencies using the `vcpkg` package manager.
+
+Prior to installation, the system must already have install the appropriate
+build system (such as `gcc`, `clang` or Visual Studio), and CMake.
+
+==== Build prerequisites by platform
 
 ==== 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:
+On Windows, while all necessary libraries are already pre-compiled, Visual
+Studio 2019 with C++ Build Tools still need to be installed.
+
+They can be downloaded
+https://visualstudio.microsoft.com/downloads/[here], or installed with
+Chocolatey:
 
 [source,sh]
 ----
@@ -57,56 +134,45 @@ choco install visualstudio2019buildtools -y --no-progress --package-parameters "
 
 ==== macOS
 
+On macOS, CMake needs to be installed.
+
 [source,sh]
 ----
 brew install cmake
 ----
 
-==== Linux
+==== Linux: Debian
 
-===== Debian
+On Debian, the following build tools need to be installed.
 
 [source,sh]
 ----
-# compiler
+# Choose your preferred compiler
+# GCC
 apt-get install gcc g++ gperf cmake pkg-config
 # or
+# clang
 apt-get install clang gperf cmake pkg-config
 ----
 
-===== Fedora
+NOTE: On Debian systems, there exists a
+https://github.com/microsoft/vcpkg/issues/15931[vcpkg bug] that needs to be
+addressed by installing the `gperf` package in addition to other build tools.
 
-[source,sh]
-----
-yum install cmake gcc-c++ gcc
-----
-
-== Usage
-
-This gem embeds libemf2svg, allowing your Ruby code to utilize EMF to SVG
-conversion facilities.
+==== Linux: Fedora
 
-[source,ruby]
-----
-require "emf2svg"
+On Fedora, the following build tools need to be installed.
 
-data = Emf2svg.from_file("example.emf")
-File.write("output.svg", data, mode: "wb")
+[source,sh]
 ----
-
-It also can use content of emf as an input:
-
-[source,ruby]
+yum install cmake gcc-c++ gcc
 ----
-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
 
+=== Basic steps
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
 `rake spec` to run the tests. You can also run `bin/console` for an interactive
 prompt that will allow you to experiment.
@@ -117,6 +183,7 @@ 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
@@ -136,6 +203,7 @@ For a minor release (0.x.0) use:
 gem bump --version minor --tag --push
 ----
 
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at
@@ -144,6 +212,7 @@ safe, welcoming space for collaboration, and contributors are expected to adhere
 to the
 https://github.com/metanorma/emf2svg-ruby/blob/master/CODE_OF_CONDUCT.md[code of conduct].
 
+
 == Code of Conduct
 
 Everyone interacting in the emf2svg project's codebases, issue trackers, chat

data/lib/emf2svg/recipe.rb

@@ -99,7 +99,7 @@ module Emf2svg
       opts << "-DLONLY=ON"
 
       unless target_triplet.nil? || drop_target_triplet?
-        opts << " -DVCPKG_TARGET_TRIPLET=#{target_triplet}"
+        opts << "-DVCPKG_TARGET_TRIPLET=#{target_triplet}"
       end
 
       opts << "-DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake"

data/lib/emf2svg/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emf2svg
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: x86_64-darwin
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi