sumi-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9316b4bb6bf6bef389065fc6c958137747810f368093293951a9e78534ad993
-  data.tar.gz: 0d06594b46fe42130c8c352ae33a7893f1fb4ba5c7e7867b18ef2e05638f7676
+  metadata.gz: b48d59134097ed8d4ed5b68ac008461a4017cc60f6ed0b0a2339e15e7be31326
+  data.tar.gz: ebb9023421ccb1c1963217ed1693aaa13b814cc77772aa6b78e92e1cee24a8c7
 SHA512:
-  metadata.gz: 4a1728eddcdb67b32ae71ccd191282c81129847b4386b0e5e37142ae33e6581e3732d9d31477f3ead5f02348ef1332e7dfcf134bcb333c661bed29c22efb4c87
-  data.tar.gz: 6cd2df269185d77558cf8614c8eb07f9402abfffa446d863b3b634e4dda6458ffccd7b2a26588d074085ca2a37cb1ae057c92ebe441899fd37f56cc16e7fdd46
+  metadata.gz: dfda0e889f94a1345913978fcb7efbad43bf51b1c87e78e0e9a229dbc433a1cad8280614ced9e4e65c4a304c994e422394c370a372e55846b666cd50c899bf19
+  data.tar.gz: '086cef5f1cb634d4d80df31adff8a8224de8b97c26c2674deb521275f5bd6557c552ff0f52bbe346b66bee23c2be5a75742ef8e8549e08c0de86af048e2ad188'

data/README.md

@@ -22,7 +22,19 @@ bundle install
 bundle exec sumi input.pdf -o output.pdf
 ```
 
-Ruby からは `Sumi::Ruby.executable` で実行ファイルの絶対パスを取得できます。
+Ruby からは `Sumi.convert` で、PDF のバイト列を変換できます。
+キーワード引数は sumi のオプションになります。`gray_model: "colorimetric"` は `--gray-model colorimetric`、`strict: true` は `--strict` として渡し、`false` や `nil` のオプションは渡しません。
+sumi が失敗すると、sumi のエラー出力をメッセージにした `Sumi::ConversionError` を投げます。
+
+```ruby
+require "sumi/ruby"
+
+pdf = File.binread("input.pdf")
+gray = Sumi.convert(pdf, gray_model: "colorimetric", strict: true)
+File.binwrite("output.pdf", gray)
+```
+
+ファイルを直接指定したい場合や、`--report json` の出力を受け取りたい場合は、`Sumi::Ruby.executable` で実行ファイルの絶対パスを取得して実行します。
 
 ```ruby
 require "open3"

data/lib/sumi/conversion.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Sumi
+  class ConversionError < Ruby::Error; end
+
+  class << self
+    # Converts the PDF in `pdf` (a String of its bytes) and returns the converted PDF as a String.
+    #
+    # Each keyword becomes a sumi option: `gray_model: "colorimetric"` is passed as
+    # `--gray-model colorimetric`, `strict: true` as `--strict`, and `false` or `nil` leaves the
+    # option out. The keywords are not checked here, so options added to sumi can be used without
+    # updating this gem; sumi itself rejects unknown ones.
+    #
+    # Raises ConversionError with sumi's error output when sumi exits with a non-zero status.
+    def convert(pdf, **options)
+      output, error, status = Open3.capture3(Ruby.executable, "-", "-o", "-", *command_options(options),
+                                             stdin_data: pdf, binmode: true)
+      unless status.success?
+        message = error.strip
+        message = "sumi exited with status #{status.exitstatus}" if message.empty?
+        raise ConversionError, message
+      end
+
+      output
+    end
+
+    private
+
+    def command_options(options)
+      options.flat_map do |name, value|
+        flag = "--#{name.to_s.tr("_", "-")}"
+        case value
+        when true then [flag]
+        when false, nil then []
+        else [flag, value.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/sumi/ruby/version.rb

@@ -3,6 +3,6 @@
 module Sumi
   module Ruby
     # Always the same as the version of the bundled sumi CLI (`Cargo.toml`).
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/sumi/ruby.rb

@@ -70,3 +70,5 @@ module Sumi
     end
   end
 end
+
+require_relative "conversion"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sumi-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Junya Ishihara
@@ -22,6 +22,7 @@ files:
 - README.md
 - exe/sumi
 - lib/sumi-ruby.rb
+- lib/sumi/conversion.rb
 - lib/sumi/ruby.rb
 - lib/sumi/ruby/platforms.rb
 - lib/sumi/ruby/version.rb