sumi-ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9316b4bb6bf6bef389065fc6c958137747810f368093293951a9e78534ad993
+  data.tar.gz: 0d06594b46fe42130c8c352ae33a7893f1fb4ba5c7e7867b18ef2e05638f7676
+SHA512:
+  metadata.gz: 4a1728eddcdb67b32ae71ccd191282c81129847b4386b0e5e37142ae33e6581e3732d9d31477f3ead5f02348ef1332e7dfcf134bcb333c661bed29c22efb4c87
+  data.tar.gz: 6cd2df269185d77558cf8614c8eb07f9402abfffa446d863b3b634e4dda6458ffccd7b2a26588d074085ca2a37cb1ae057c92ebe441899fd37f56cc16e7fdd46

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Junya Ishihara
+
+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,85 @@
+# sumi-ruby
+
+[sumi](https://github.com/champierre/sumi)（PDF の色をグレースケールや白黒に変換する CLI）のビルド済み実行ファイルを同梱した gem です。
+`bundle install` だけで sumi が入り、`Gemfile.lock` で開発環境・CI・本番のバージョンがそろいます。
+
+gem のバージョンは、同梱している sumi のバージョンと同じです。
+
+## インストール
+
+```ruby
+# Gemfile
+gem "sumi-ruby"
+```
+
+```bash
+bundle install
+```
+
+## 使い方
+
+```bash
+bundle exec sumi input.pdf -o output.pdf
+```
+
+Ruby からは `Sumi::Ruby.executable` で実行ファイルの絶対パスを取得できます。
+
+```ruby
+require "open3"
+require "sumi/ruby"
+
+_stdout, stderr, status = Open3.capture3(
+  Sumi::Ruby.executable, "input.pdf", "-o", "output.pdf", "--report", "json"
+)
+```
+
+オプションや JSON レポートの形式は、[sumi の README](https://github.com/champierre/sumi#cli) を参照してください。
+
+## 対応プラットフォーム
+
+| gem のプラットフォーム | 同梱している実行ファイル |
+|---|---|
+| `x86_64-linux-gnu` `x86_64-linux-musl` | `sumi-x86_64-unknown-linux-musl` |
+| `aarch64-linux-gnu` `aarch64-linux-musl` | `sumi-aarch64-unknown-linux-musl` |
+| `x86_64-darwin` | `sumi-x86_64-apple-darwin` |
+| `arm64-darwin` | `sumi-aarch64-apple-darwin` |
+| `x64-mingw-ucrt` | `sumi-x86_64-pc-windows-msvc` |
+
+実行ファイルは [GitHub Releases](https://github.com/champierre/sumi/releases) で配布しているものと同じです。
+Linux 版は静的リンク（musl）なので、glibc の環境でも musl（Alpine など）の環境でも動きます。
+Linux 向けの gem には RubyGems 3.3.22 以降が必要です。Ruby 3.1.3 以降に付属する RubyGems なら満たしています（それより前の Ruby では `gem update --system` で更新してください）。
+
+### `Gemfile.lock` のプラットフォーム
+
+Bundler は `Gemfile.lock` の `PLATFORMS` にあるプラットフォームの gem を選びます。
+開発に使う Mac と本番の Linux のように環境が分かれる場合は、使うプラットフォームを追加しておきます。
+
+```bash
+bundle lock --add-platform x86_64-linux-gnu aarch64-linux-gnu arm64-darwin
+```
+
+`PLATFORMS` に `ruby` しかないと、実行ファイルを含まない gem が入り、実行時にエラーになります。
+
+### 対応していない環境
+
+上の表にない環境では、sumi をソースからビルドし、そのディレクトリを環境変数 `SUMI_INSTALL_DIR` で指定してください。
+`SUMI_INSTALL_DIR` を指定すると、同梱の実行ファイルより優先されます。
+
+```bash
+cargo install --git https://github.com/champierre/sumi sumi-cli
+export SUMI_INSTALL_DIR="$HOME/.cargo/bin"
+```
+
+## 開発
+
+```bash
+cd ruby
+bundle install
+bundle exec rake test          # テスト
+bundle exec rake gem:local     # この環境向けの gem を cargo build --release からビルド（pkg/ に出力）
+bundle exec rake gem:release[../dist]   # リリースのアーカイブからすべての gem をビルド
+```
+
+## ライセンス
+
+[MIT](https://github.com/champierre/sumi/blob/main/LICENSE)

data/exe/sumi

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Runs the sumi executable bundled with the sumi-ruby gem, passing all arguments through.
+
+require "sumi/ruby"
+
+begin
+  executable = Sumi::Ruby.executable
+rescue Sumi::Ruby::Error => e
+  warn "sumi-ruby: #{e.message}"
+  exit 1
+end
+
+exec(executable, *ARGV)

data/lib/sumi/ruby/platforms.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sumi
+  module Ruby
+    # Gem platforms with a native gem, and the Rust target whose release archive supplies the
+    # executable. The Linux executables are statically linked against musl, so the same binary
+    # runs on both glibc and musl systems.
+    PLATFORMS = {
+      "x86_64-linux-gnu" => "x86_64-unknown-linux-musl",
+      "x86_64-linux-musl" => "x86_64-unknown-linux-musl",
+      "aarch64-linux-gnu" => "aarch64-unknown-linux-musl",
+      "aarch64-linux-musl" => "aarch64-unknown-linux-musl",
+      "x86_64-darwin" => "x86_64-apple-darwin",
+      "arm64-darwin" => "aarch64-apple-darwin",
+      "x64-mingw-ucrt" => "x86_64-pc-windows-msvc"
+    }.freeze
+  end
+end

data/lib/sumi/ruby/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Sumi
+  module Ruby
+    # Always the same as the version of the bundled sumi CLI (`Cargo.toml`).
+    VERSION = "0.2.0"
+  end
+end

data/lib/sumi/ruby.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "ruby/version"
+require_relative "ruby/platforms"
+
+module Sumi
+  module Ruby
+    class Error < StandardError; end
+    class UnsupportedPlatformError < Error; end
+    class ExecutableNotFoundError < Error; end
+    class DirectoryNotFoundError < Error; end
+
+    GEM_NAME = "sumi-ruby"
+    INSTALL_DIR_ENV = "SUMI_INSTALL_DIR"
+    DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "..", "exe"))
+
+    class << self
+      # Returns the absolute path of the sumi executable.
+      #
+      # Native gems carry the executable in `exe/<platform>/`. Setting `SUMI_INSTALL_DIR` to a
+      # directory that contains `sumi` (or `sumi.exe`) uses that executable instead, for
+      # example on a platform without a native gem.
+      def executable(exe_path: DEFAULT_DIR)
+        install_dir = ENV[INSTALL_DIR_ENV]
+        if install_dir && !install_dir.empty?
+          unless File.directory?(install_dir)
+            raise DirectoryNotFoundError, "#{INSTALL_DIR_ENV} is set to #{install_dir}, but that directory does not exist"
+          end
+
+          file = executable_in(File.expand_path(install_dir))
+          return file if file
+
+          raise ExecutableNotFoundError, "#{INSTALL_DIR_ENV} is set to #{install_dir}, but it does not contain a sumi executable"
+        end
+
+        file = Dir.glob(File.join(exe_path, "*")).sort.find do |dir|
+          File.directory?(dir) && platform_matches?(File.basename(dir)) && executable_in(dir)
+        end
+        return executable_in(file) if file
+
+        platform = PLATFORMS.keys.find { |name| platform_matches?(name) }
+        unless platform
+          raise UnsupportedPlatformError, <<~MESSAGE
+            #{GEM_NAME} does not ship a sumi executable for #{Gem::Platform.local}.
+            Supported platforms: #{PLATFORMS.keys.join(", ")}.
+            Build sumi from source (https://github.com/champierre/sumi) and set #{INSTALL_DIR_ENV} to the directory that contains it.
+          MESSAGE
+        end
+
+        raise ExecutableNotFoundError, <<~MESSAGE
+          Cannot find the sumi executable for #{Gem::Platform.local} in #{exe_path}.
+          Bundler may have installed the platform-independent #{GEM_NAME} gem. Add the platform to the lockfile and install again:
+            bundle lock --add-platform #{platform}
+            bundle install
+          Or set #{INSTALL_DIR_ENV} to a directory that contains the sumi executable.
+        MESSAGE
+      end
+
+      private
+
+      def executable_in(dir)
+        ["sumi", "sumi.exe"]
+          .map { |name| File.join(dir, name) }
+          .find { |path| File.file?(path) && File.executable?(path) }
+      end
+
+      def platform_matches?(name)
+        Gem::Platform.match_gem?(Gem::Platform.new(name), GEM_NAME)
+      end
+    end
+  end
+end

data/lib/sumi-ruby.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Lets `Bundler.require` load the gem by its name.
+require_relative "sumi/ruby"

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: sumi-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Junya Ishihara
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Ships the prebuilt sumi executable for each platform, so that `bundle install` installs the
+  same version of sumi in development, CI and production. sumi converts the colors of a PDF
+  to grayscale or monochrome while keeping text and vector graphics.
+executables:
+- sumi
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- exe/sumi
+- lib/sumi-ruby.rb
+- lib/sumi/ruby.rb
+- lib/sumi/ruby/platforms.rb
+- lib/sumi/ruby/version.rb
+homepage: https://github.com/champierre/sumi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/champierre/sumi
+  source_code_uri: https://github.com/champierre/sumi/tree/main/ruby
+  changelog_uri: https://github.com/champierre/sumi/releases
+  bug_tracker_uri: https://github.com/champierre/sumi/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: The sumi CLI, which converts PDFs to grayscale or monochrome, packaged as
+  a gem
+test_files: []