svg2img 0.1.0

data/Cargo.toml

@@ -0,0 +1,7 @@
+# This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
+# a Rust project. Your extensions dependencies should be added to the Cargo.toml
+# in the ext/ directory.
+
+[workspace]
+members = ["./ext/svg2img"]
+resolver = "2"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Orvar Segerström
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Svg2img
+
+Convert SVG to image. Uses a bundled native binary, and requires no external dependencies.
+Supported output formats for now:
+
+- png
+- jpg
+- webp
+- gif
+
+## Installation
+
+Add the `svg2img` gem to your Gemfile and run `bundle install`:
+
+```ruby
+gem "svg2img"
+```
+
+Alternatively, you can install the gem manually:
+
+```sh
+gem install svg2img
+```
+
+### Precompiled gems
+
+We recommend installing the `svg2img` precompiled gems available for Linux and macOS. Installing a precompiled gem avoids the need to compile from source code, which is generally slower and less reliable.
+
+When installing the `svg2img` gem for the first time using `bundle install`, Bundler will automatically download the precompiled gem for your current platform. However, you will need to inform Bundler of any additional platforms you plan to use.
+
+To do this, lock your Bundle to the required platforms you will need from the list of supported platforms below:
+
+```sh
+bundle lock --add-platform x86_64-linux # Standard Linux (e.g. Heroku, GitHub Actions, etc.)
+bundle lock --add-platform x86_64-linux-musl # MUSL Linux deployments (i.e. Alpine Linux)
+bundle lock --add-platform aarch64-linux # ARM64 Linux deployments (i.e. AWS Graviton2)
+bundle lock --add-platform x86_64-darwin # Intel MacOS (i.e. pre-M1)
+bundle lock --add-platform arm64-darwin # Apple Silicon MacOS  (i.e. M1)
+```
+
+## Usage
+
+Example usage:
+
+```ruby
+require "svg2img"
+
+circle_svg = <<~SVG
+  <svg xmlns="http://www.w3.org/2000/svg" width="100" height="100">
+    <circle cx="50" cy="50" r="40" stroke="black" stroke-width="3" fill="red" />
+  </svg>
+SVG
+png_path = Svg2Img.process_svg(circle_svg, output_format: :png)
+# png_path is a path to the generated PNG file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/svg2img.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("svg2img.gemspec")
+
+RbSys::ExtensionTask.new("svg2img", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/svg2img"
+end
+
+task default: :compile

data/ext/svg2img/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "svg2img"
+version = "0.1.0"
+edition = "2021"
+authors = ["Orvar Segerström <orvarsegerstrom@gmail.com>"]
+license = "MIT"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+anyhow = "1.0.86"
+image = "0.25.2"
+magnus = { version = "0.6.2" }
+resvg = "0.43.0"
+uuid = { version = "1.10.0", features = ["v4"] }

data/ext/svg2img/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("svg2img/svg2img")

data/ext/svg2img/src/lib.rs

@@ -0,0 +1,195 @@
+use anyhow::Context;
+use image::{DynamicImage, GenericImageView, ImageBuffer};
+use magnus::{function, prelude::*, Error, Ruby};
+use std::panic::{self, AssertUnwindSafe};
+
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("Svg2Img")?;
+    module.define_singleton_method("process_svg", function!(process_svg_rb, 2))?;
+    Ok(())
+}
+
+fn process_svg_rb(svg: String, options: magnus::RHash) -> Result<String, magnus::Error> {
+    let mut format = image::ImageFormat::Png;
+
+    if let Some(format_option) = get_string_option(&options, "format")? {
+        format = match format_option.as_str() {
+            "png" => image::ImageFormat::Png,
+            "jpeg" | "jpg" => image::ImageFormat::Jpeg,
+            "gif" => image::ImageFormat::Gif,
+            "webp" => image::ImageFormat::WebP,
+            format => {
+                return Err(magnus::Error::new(
+                    magnus::exception::arg_error(),
+                    format!("svg2img: Invalid output format: {format}"),
+                ));
+            }
+        };
+    }
+    let options = Options {
+        max_width: get_option(&options, "max_width")?,
+        max_height: get_option(&options, "max_height")?,
+        format,
+        output_path: get_option(&options, "output_path")?,
+    };
+    process_svg(svg, options)
+        .map_err(|err| magnus::Error::new(magnus::exception::runtime_error(), format!("{err:?}")))
+}
+
+fn get_option<T>(options: &magnus::RHash, key: &str) -> Result<Option<T>, magnus::Error>
+where
+    T: magnus::TryConvert,
+{
+    let value = options
+        .get(magnus::Symbol::new(key))
+        .or_else(|| options.get(key));
+    let Some(value) = value else {
+        return Ok(None);
+    };
+    match T::try_convert(value) {
+        Ok(value) => Ok(Some(value)),
+        Err(err) => Err(magnus::Error::new(
+            magnus::exception::arg_error(),
+            format!("svg2img: Invalid option {key}: {err:?}"),
+        )),
+    }
+}
+fn get_string_option(options: &magnus::RHash, key: &str) -> Result<Option<String>, magnus::Error> {
+    // Try get_option with String, then try again with Symbol
+    let string_option = get_option::<String>(options, key);
+    if let Ok(Some(string_option)) = string_option {
+        return Ok(Some(string_option));
+    }
+
+    let symbol_option = get_option::<magnus::Symbol>(options, key)?;
+    if let Some(symbol) = symbol_option {
+        let symbol_string = unsafe {
+            symbol.to_s().map_err(|err| magnus::Error::new(
+            magnus::exception::arg_error(),
+            format!("svg2img: Invalid option {key} (could not convert from Symbol to string): {err:?}"),
+        ))?.into_owned()
+        };
+        return Ok(Some(symbol_string));
+    }
+
+    Ok(None)
+}
+
+struct Options {
+    max_width: Option<u32>,
+    max_height: Option<u32>,
+    format: image::ImageFormat,
+    output_path: Option<String>,
+}
+
+fn process_svg(svg: String, options: Options) -> Result<String, anyhow::Error> {
+    let image = image_from_svg(svg.as_bytes())?;
+    let (old_width, old_height) = image.dimensions();
+
+    let (mut width, mut height) = (old_width, old_height);
+    if let Some(max_width) = options.max_width {
+        if width > max_width {
+            height = height * max_width / width;
+            width = max_width;
+        }
+    }
+    if let Some(max_height) = options.max_height {
+        if height > max_height {
+            width = width * max_height / height;
+            height = max_height;
+        }
+    }
+
+    let mut image = image.resize_exact(width, height, image::imageops::FilterType::Lanczos3);
+
+    if options.format == image::ImageFormat::Jpeg {
+        // Convert from rgba8 to rgb8
+        image = DynamicImage::ImageRgb8(image.into_rgb8())
+    }
+
+    let mut buf = Vec::new();
+    let mut cursor = std::io::Cursor::new(&mut buf);
+    image
+        .write_to(&mut cursor, options.format)
+        .context("Failed to write image to buffer")?;
+
+    let output_path = options.output_path.unwrap_or_else(|| {
+        let random_filename = format!(
+            "svg2img-{}.{}",
+            uuid::Uuid::new_v4(),
+            options
+                .format
+                .extensions_str()
+                .first()
+                .unwrap_or(&"whatever")
+        );
+        std::env::temp_dir()
+            .join(random_filename)
+            .to_string_lossy()
+            .to_string()
+    });
+    std::fs::write(&output_path, buf).context("Failed to write image to file")?;
+
+    Ok(output_path)
+}
+
+fn image_from_svg(bytes: &[u8]) -> Result<DynamicImage, anyhow::Error> {
+    let tree = resvg::usvg::Tree::from_data(bytes, &resvg::usvg::Options::default())
+        .context("Failed to parse SVG")?;
+
+    const TARGET_SIZE: u32 = 512;
+    let mut pixmap = resvg::tiny_skia::Pixmap::new(TARGET_SIZE, TARGET_SIZE)
+        .context("Failed to create Pixmap for SVG rendering")?;
+    let ratio = tree.size().width() / tree.size().height();
+    let scaled_width = if ratio > 1.0 {
+        TARGET_SIZE
+    } else {
+        (TARGET_SIZE as f32 * ratio).round() as u32
+    };
+    let scaled_height = if ratio > 1.0 {
+        (TARGET_SIZE as f32 / ratio).round() as u32
+    } else {
+        TARGET_SIZE
+    };
+
+    // Scale svg and place it centered
+    let transform = resvg::tiny_skia::Transform {
+        sx: scaled_width as f32 / tree.size().width(),
+        sy: scaled_height as f32 / tree.size().height(),
+        tx: (TARGET_SIZE - scaled_width) as f32 / 2.0,
+        ty: (TARGET_SIZE - scaled_height) as f32 / 2.0,
+        ..Default::default()
+    };
+
+    let result = panic::catch_unwind(AssertUnwindSafe(|| {
+        resvg::render(&tree, transform, &mut pixmap.as_mut());
+    }));
+    if let Err(panic) = result {
+        let panic_message = panic
+            .downcast_ref::<String>()
+            .map(String::as_str)
+            .or_else(|| {
+                panic
+                    .downcast_ref::<&'static str>()
+                    .map(std::ops::Deref::deref)
+            })
+            .unwrap_or("Box<Any>");
+        return Err(anyhow::anyhow!("SVG rendering panicked: {}", panic_message));
+    }
+
+    rgba_to_image(pixmap.width(), pixmap.height(), pixmap.data())
+}
+
+fn rgba_to_image(width: u32, height: u32, data: &[u8]) -> Result<DynamicImage, anyhow::Error> {
+    let mut image_data = Vec::with_capacity((width * height * 4) as usize);
+    for pixel in data.chunks(4) {
+        image_data.push(pixel[0]); // R
+        image_data.push(pixel[1]); // G
+        image_data.push(pixel[2]); // B
+        image_data.push(pixel[3]); // A
+    }
+    let buffer = ImageBuffer::from_raw(width, height, image_data)
+        .context("Failed to convert to ImageBuffer")?;
+    Ok(DynamicImage::ImageRgba8(buffer))
+}

data/flake.lock

@@ -0,0 +1,99 @@
+{
+  "nodes": {
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1696426674,
+        "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1694529238,
+        "narHash": "sha256-zsNZZGTGnMOf9YpHKJqMSsa0dXbfmxeoJ7xHlrt+xmY=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "ff7b65b44d01cf9ba6a71320833626af21126384",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1709961763,
+        "narHash": "sha256-6H95HGJHhEZtyYA3rIQpvamMKAGoa8Yh2rFV29QnuGw=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "3030f185ba6a4bf4f18b87f345f104e6a6961f34",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-ruby": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "flake-utils": "flake-utils",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1722577194,
+        "narHash": "sha256-nWLATuXQYs/AHFxC9mi/uo6mVUz6nFYcWNd6flGCxVk=",
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "rev": "b2ac79f24e50faac5d4ce3a878b7a9f0270fa2bd",
+        "type": "github"
+      },
+      "original": {
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs",
+        "nixpkgs-ruby": "nixpkgs-ruby"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/flake.nix

@@ -0,0 +1,62 @@
+{
+  description = "Devshell with all the dependencies needed to develop and build the project";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    nixpkgs-ruby.url = "github:bobvanderlinden/nixpkgs-ruby";
+    nixpkgs-ruby.inputs.nixpkgs.follows = "nixpkgs";
+  };
+
+
+  outputs = { self, nixpkgs, nixpkgs-ruby }:
+    let
+      # Boilerplate function for generating attributes for all systems
+      forAllSystems = function:
+        nixpkgs.lib.genAttrs [
+          "x86_64-linux"
+          "aarch64-linux"
+          "x86_64-darwin"
+          "aarch64-darwin"
+        ]
+          (system:
+            (function (import nixpkgs {
+              inherit system;
+            })) system);
+    in
+    {
+      packages = forAllSystems (pkgs: system:
+        let
+          ruby = nixpkgs-ruby.lib.packageFromRubyVersionFile {
+            file = ./.ruby-version;
+            inherit system;
+          };
+          tools = [ ruby ] ++ (with pkgs; [
+            nodejs_20
+            yarn
+            mprocs
+          ]);
+          gemDependencies = with pkgs; [
+            zstd
+            libxml2
+            libxslt
+            imagemagick
+          ];
+          root = builtins.getEnv "PWD";
+        in
+        {
+          default = pkgs.mkShell {
+            buildInputs = tools ++ gemDependencies;
+            shellHook = ''
+              # https://github.com/sass/sassc-ruby/issues/148#issuecomment-644450274
+              bundle config build.sassc --disable-lto
+              export BUNDLE_BUILD__SASSC="--disable-lto"
+
+              export GEM_HOME="${root}/.bundle"
+              export GEM_PATH="${root}/.bundle"
+              export PATH="${root}/.bundle/bin:$PATH"
+              export RUBY_YJIT_ENABLE=1
+            '';
+          };
+        });
+    };
+}

data/lib/svg2img/version.rb

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

data/lib/svg2img.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "svg2img/version"
+require_relative "svg2img/svg2img"
+
+module Svg2Img
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/svg2img.rbs

@@ -0,0 +1,4 @@
+module Svg2Img
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: svg2img
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Orvar Segerström
+autorequire:
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- orvarsegerstrom@gmail.com
+executables: []
+extensions:
+- ext/svg2img/Cargo.toml
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Cargo.lock
+- Cargo.toml
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/svg2img/Cargo.toml
+- ext/svg2img/extconf.rb
+- ext/svg2img/src/lib.rs
+- flake.lock
+- flake.nix
+- lib/svg2img.rb
+- lib/svg2img/version.rb
+- sig/svg2img.rbs
+homepage: https://github.com/0rvar/svg2img-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/0rvar/svg2img-rb
+  source_code_uri: https://github.com/0rvar/svg2img-rb
+  changelog_uri: https://github.com/0rvar/svg2img-rb/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.11
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Convert svg to png, jpg, or webp
+test_files: []