sghtmltopdf 0.1.0

data/lib/sghtmltopdf/server_client.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+module Sghtmltopdf
+  class ServerError < Error; end
+
+  # HTTPサーバモード(`sghtmltopdf server`)へ変換を委譲するクライアント。
+  #
+  #   Sghtmltopdf.configure { |c| c.server_url = "http://pdf.internal:8080" }
+  #   pdf = Sghtmltopdf.render(html, page_size: "A4")
+  class ServerClient
+    DEFAULT_OPEN_TIMEOUT = 5
+    DEFAULT_READ_TIMEOUT = 120
+
+    # 一度に読むチャンクの目安。`?stream=1`のときはこの単位でブロックへ渡る。
+    CHUNK_SIZE = 64 * 1024
+
+    attr_reader :uri, :open_timeout, :read_timeout
+
+    # @param url [String] サーバのベースURL(`http://host:port`)
+    def initialize(url, open_timeout: nil, read_timeout: nil)
+      @uri = parse(url)
+      @open_timeout = (open_timeout || DEFAULT_OPEN_TIMEOUT).to_f
+      @read_timeout = (read_timeout || DEFAULT_READ_TIMEOUT).to_f
+    end
+
+    # HTMLをPDFへ変換する。
+    #
+    # ブロックを渡すと`?stream=1`(chunked transfer encoding)を使い、
+    # サーバがページを確定したそばからチャンクを渡す。ブロックが無ければ
+    # PDF全体をStringで返す。
+    def render(html, options, &block)
+      request = build_request(html, options, stream: !block.nil?)
+      pdf = nil
+      start do |http|
+        # `request`はブロック付きだとレスポンスオブジェクトを返すので、
+        # 結果は外の変数で受ける。
+        http.request(request) do |response|
+          ensure_success!(response)
+          if block
+            response.read_body { |chunk| block.call(chunk.b) }
+          else
+            pdf = read_all(response)
+          end
+        end
+      end
+      pdf
+    end
+
+    # 変換結果を`path`へ書き出す。途中で失敗しても壊れたPDFを残さないよう、
+    # 一時ファイルへ書いてからrenameする(ネイティブ拡張の`FileSink`と同じ
+    # 挙動に揃えている)。
+    def render_to_file(html, options, path)
+      tmp = "#{path}.#{Process.pid}.tmp"
+      begin
+        File.open(tmp, "wb") do |file|
+          render(html, options) { |chunk| file.write(chunk) }
+        end
+      rescue SystemCallError => e
+        File.unlink(tmp) if File.exist?(tmp)
+        raise InputError, "#{path}への書き出しに失敗しました: #{e.message}"
+      rescue StandardError
+        File.unlink(tmp) if File.exist?(tmp)
+        raise
+      end
+      File.rename(tmp, path)
+      nil
+    end
+
+    private
+
+    def parse(url)
+      uri = URI.parse(url.to_s)
+      unless uri.is_a?(URI::HTTP) && uri.host
+        raise ArgumentError, "server_urlにはhttp(s)のURLを指定してください: #{url.inspect}"
+      end
+
+      uri
+    end
+
+    def build_request(html, options, stream:)
+      query = Options.to_query(options)
+      query = stream ? [query, "stream=1"].reject(&:empty?).join("&") : query
+      target = uri.dup
+      target.path = "/pdf"
+      target.query = query.empty? ? nil : query
+
+      request = Net::HTTP::Post.new(target)
+      request["Content-Type"] = "text/html; charset=utf-8"
+      request.body = html.to_s.b
+      request
+    end
+
+    def start(&block)
+      Net::HTTP.start(
+        uri.host, uri.port,
+        use_ssl: uri.scheme == "https",
+        open_timeout: open_timeout,
+        read_timeout: read_timeout,
+        &block
+      )
+    rescue Net::OpenTimeout, Net::ReadTimeout => e
+      raise ServerError, "#{base}への接続がタイムアウトしました: #{e.class}"
+    rescue SocketError, SystemCallError, IOError, OpenSSL::SSL::SSLError => e
+      raise ServerError, "#{base}への接続に失敗しました: #{e.message}"
+    end
+
+    # エラー応答の本文は`text/plain`の日本語メッセージ(CLIと同じ文言)。
+    def ensure_success!(response)
+      return if response.is_a?(Net::HTTPOK)
+
+      message = read_all(response).force_encoding(Encoding::UTF_8).strip
+      raise error_class(response), "#{base}: #{message}"
+    end
+
+    def error_class(response)
+      case response.code.to_i
+      when 400 then UsageError
+      when 413 then InputError
+      when 500 then RenderError
+      # 404/405はパスやメソッドの間違い＝相手がsghtmltopdfのサーバでない
+      # 可能性が高い。503/504はキュー溢れ・キュー待ちのタイムアウト。
+      else ServerError
+      end
+    end
+
+    def read_all(response)
+      buffer = +""
+      response.read_body { |chunk| buffer << chunk }
+      buffer.b
+    end
+
+    def base
+      "#{uri.scheme}://#{uri.host}:#{uri.port}"
+    end
+  end
+end

data/lib/sghtmltopdf/version.rb

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

data/lib/sghtmltopdf/view_helpers.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Sghtmltopdf
+  # Action View用のヘルパ。
+  #
+  # PDFのレンダリングはHTTPサーバを介さないため、`/assets/…`のようなURLは
+  # ローカルファイルとして解決される(`--base-url`の既定は
+  # `Rails.root/public`。[Railtie.default_options])。precompile済みの
+  # 本番環境ではこれで素の`stylesheet_link_tag`もそのまま動くが、開発環境の
+  # ようにアセットがまだ`public/`へ書き出されていない場合は解決できない。
+  #
+  # そこで、
+  #
+  #   <%= sghtmltopdf_stylesheet_link_tag "pdf" %>
+  #
+  # のようにCSSの中身を`<style>`へ展開するヘルパを用意する(wicked_pdfの
+  # `wicked_pdf_stylesheet_link_tag`に相当)。
+  module ViewHelpers
+    # アセットのローカルファイルパスを返す。見つからなければ`nil`。
+    #
+    # 1. `public/`配下(precompile済み。本番環境)
+    # 2. アセットパイプラインのロードパス(開発環境。Propshaft/Sprockets)
+    #
+    # の順に探す。パイプラインの参照はどちらのgemにも依存しないよう
+    # `respond_to?`で分岐している(best effort)。
+    def sghtmltopdf_asset_path(source)
+      path = source.to_s
+      return path if path.start_with?("/") && File.file?(path)
+
+      from_public_dir(path) || from_asset_pipeline(path)
+    end
+
+    # CSSの中身を`<style>`へ展開する。複数指定でき、見つからないものは
+    # 黙って飛ばす(PDF生成そのものは止めない)。
+    def sghtmltopdf_stylesheet_link_tag(*sources)
+      css = sources.flatten.filter_map do |source|
+        path = sghtmltopdf_asset_path(with_extension(source, ".css"))
+        File.read(path) if path
+      end
+      return "".html_safe if css.empty?
+
+      content_tag(:style, css.join("\n").html_safe, type: "text/css")
+    end
+
+    # `image_tag`のsrcをローカルファイルパスへ差し替える。
+    def sghtmltopdf_image_tag(source, options = {})
+      image_tag(sghtmltopdf_asset_path(source) || source, options)
+    end
+
+    private
+
+    # `asset_path`が返すURL(asset_hostが付くこともある)からパス部分だけを
+    # 取り出し、`public/`配下の実ファイルへ対応付ける。
+    def from_public_dir(source)
+      url = respond_to?(:asset_path) ? asset_path(source) : source
+      relative = url.to_s.sub(%r{\Ahttps?://[^/]+}, "").split(/[?#]/).first.to_s
+      return nil if relative.empty?
+
+      candidate = File.join(::Rails.public_path.to_s, relative)
+      File.file?(candidate) ? candidate : nil
+    end
+
+    def from_asset_pipeline(source)
+      assets = ::Rails.application.try(:assets)
+      return nil if assets.nil?
+
+      # Propshaft
+      if assets.respond_to?(:load_path)
+        found = assets.load_path.find(source)
+        return found.path.to_s if found.respond_to?(:path)
+      end
+      # Sprockets
+      if assets.respond_to?(:[])
+        found = assets[source]
+        return found.filename.to_s if found.respond_to?(:filename)
+      end
+      nil
+    end
+
+    def with_extension(source, extension)
+      name = source.to_s
+      name.end_with?(extension) ? name : "#{name}#{extension}"
+    end
+  end
+end

data/lib/sghtmltopdf.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative "sghtmltopdf/version"
+require_relative "sghtmltopdf/options"
+require_relative "sghtmltopdf/configuration"
+require_relative "sghtmltopdf/renderer"
+
+# precompiled gemはRubyのマイナーバージョンごとのディレクトリへ`.so`を置く
+# (rake-compilerのクロスビルドの慣習)。開発中の`rake compile`は
+# `lib/sghtmltopdf/sghtmltopdf.so`に置くので、両方を試す。
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require "sghtmltopdf/#{Regexp.last_match(1)}/sghtmltopdf"
+rescue LoadError
+  require "sghtmltopdf/sghtmltopdf"
+end
+
+# `Error`(ネイティブ拡張が定義)を継承するため、拡張の読み込みより後に書く。
+require_relative "sghtmltopdf/server_client"
+
+module Sghtmltopdf
+  # ブロック付き`render`で1回に渡すバイト数の目安(ローカル変換のみ)。
+  # ページ確定ごとにブロックを呼ぶとGVLの取り直しが増えるため、ここまで
+  # 溜めてから渡す。
+  DEFAULT_CHUNK_SIZE = 64 * 1024
+
+  class << self
+    # HTMLを変換してPDFのバイト列(ASCII-8BITのString)を返す。
+    #
+    # ブロックを渡すと、PDF全体を組み立ててから返す代わりにチャンクごとに
+    # ブロックを呼ぶ(返り値はnil)。Rackの`response.stream`へ流したり、S3の
+    # マルチパートアップロードへ繋いだりするための口(エンジン側は出力先(sink)
+    # を意識しない設計に対応する)。
+    #
+    #   Sghtmltopdf.render(html) { |bytes| response.stream.write(bytes) }
+    #
+    # ローカル・サーバ委譲のどちらでも、PDF全体が組み上がるのを待たずに
+    # 書き出せる(ローカルは確定したページから順に、サーバは`?stream=1`の
+    # chunked transfer encodingをそのまま渡す)。
+    #
+    # ただし逐次になるのはPDFの書き出しだけで、HTMLのパースとレイアウトは
+    # 文書全体に対して先に行う。最初のチャンクが届くのは変換の終盤で、
+    # ピークメモリもブロック無しの場合と変わらない。HTMLを読みながら
+    # ページを確定させたい場合は`streaming: true`と併せて使う
+    # (制約と引き換えにメモリが大きく減る)。
+    #
+    # 1回に渡すバイト数の目安は`chunk_size:`で変えられる(既定64KiB。
+    # ローカル変換のみ。小さくするとGVLの取り直しが増える)。
+    def render(html, **options, &block)
+      client = server_client(options)
+      return client.render(html.to_s, server_options(options), &block) if client
+      return Native.render(html.to_s, argv_for(options)) if block.nil?
+
+      Native.render_each(html.to_s, argv_for(options), block, chunk_size(options))
+      nil
+    end
+
+    # HTMLを変換して`path`へ書き出す。
+    #
+    # 一時ファイルへ書いて成功時だけrenameするため、途中で失敗しても
+    # 壊れたPDFが出力先に残らない(サーバへ委譲する場合も同じ)。
+    def render_to_file(html, path, **options)
+      client = server_client(options)
+      return client.render_to_file(html.to_s, server_options(options), path.to_s) if client
+
+      Native.render_to_file(html.to_s, argv_for(options), path.to_s)
+      nil
+    end
+
+    # グローバルな既定オプション。
+    def configure
+      yield config
+      config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    # 主にテスト用。設定を空に戻す。
+    def reset_config!
+      @config = Configuration.new
+    end
+
+    private
+
+    # グローバル設定 → 呼び出し時オプションの順にマージしてargvにする。
+    def argv_for(options)
+      Options.to_argv(config.to_h.merge(options))
+    end
+
+    # `server_url`があればサーバへ委譲する。タイムアウトも同じ順でマージする。
+    def server_client(options)
+      merged = config.to_h.merge(options)
+      url = merged[:server_url]
+      return nil if url.nil? || url.to_s.empty?
+
+      ServerClient.new(
+        url,
+        open_timeout: merged[:server_open_timeout],
+        read_timeout: merged[:server_read_timeout]
+      )
+    end
+
+    # ブロックへ1回に渡すバイト数の目安(ローカル変換のみ)。
+    def chunk_size(options)
+      value = config.to_h.merge(options)[:chunk_size]
+      value.nil? ? DEFAULT_CHUNK_SIZE : Integer(value)
+    end
+
+    # サーバへ渡すオプション。流し込まれた既定値は外す
+    # (Rails向けの`base_url`・`allow`はローカルのファイル解決のための
+    # 既定値で、サーバモードではリクエストから指定できず400になる。
+    # 明示的に設定した値はそのまま送り、可否はサーバに判断させる)。
+    def server_options(options)
+      config.to_h(with_defaults: false).merge(options)
+    end
+  end
+end
+
+require_relative "sghtmltopdf/railtie" if defined?(::Rails::Railtie)

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: sghtmltopdf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yo_waka
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  wkhtmltopdfの後継として、Chromium/WebKit/Geckoに依存しないRust製の
+  HTML→PDFレンダリングエンジンをRubyから使うためのバインディング。
+  Railsからはwicked_pdf互換のレンダラ(`render pdf: "invoice"`)で使える。
+email:
+- y.wakahara@gmail.com
+executables: []
+extensions:
+- ext/sghtmltopdf/extconf.rb
+extra_rdoc_files: []
+files:
+- Cargo.lock
+- Cargo.toml
+- LICENSE
+- README.md
+- ext/sghtmltopdf/Cargo.toml
+- ext/sghtmltopdf/extconf.rb
+- ext/sghtmltopdf/src/callback_sink.rs
+- ext/sghtmltopdf/src/errors.rs
+- ext/sghtmltopdf/src/gvl.rs
+- ext/sghtmltopdf/src/lib.rs
+- lib/sghtmltopdf.rb
+- lib/sghtmltopdf/configuration.rb
+- lib/sghtmltopdf/options.rb
+- lib/sghtmltopdf/railtie.rb
+- lib/sghtmltopdf/renderer.rb
+- lib/sghtmltopdf/server_client.rb
+- lib/sghtmltopdf/version.rb
+- lib/sghtmltopdf/view_helpers.rb
+homepage: https://github.com/waka/sghtmltopdf
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/waka/sghtmltopdf
+  changelog_uri: https://github.com/waka/sghtmltopdf/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/waka/sghtmltopdf/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Chromium/WebKit/Geckoに依存しないHTML→PDFレンダラー
+test_files: []