sghtmltopdf 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1499a656547e32a6705ad42ee938b6e0574ccbb4e18ddbb928e49260146d09df
-  data.tar.gz: fbe40320575ab0b91399c9cddb3096bd1979412fed6332f892b7a36a0793e1cf
+  metadata.gz: ccb7358464b7e2b54de35755d1aaf2a278b59dddee9716101cdf3715eebf51cc
+  data.tar.gz: 4c653cda8ba36f061a2d2253f59b4877ee39e2f9f7157cc84e05ab4ec978ad1f
 SHA512:
-  metadata.gz: ee10d218e238c0095787768f1afe5a2bb06fc4268339d35f65e4c193a06bdbf61d8dbbd039fc4ff4988565418cc58bf4606e2957d7acc733a121092f018f4c55
-  data.tar.gz: ed9dfec4010a673570b27835b8452b83e9954f09956a1196b5f92a31379a5ca21dd90657cfba8f0428b4275b61e5958e3681569260166bd37c51241292777034
+  metadata.gz: 1f861dc645c65f74dee61b47a000395e10da29746bb27941079bdb0e34a69828fd424b2033f67692679f3500f6386ee0c2c5ada72bb048fdae593a167f35051a
+  data.tar.gz: 616b41944d6a37a7110cf807dab0d2feaf3aeda1861d5c254276d6c59ace03e530c29c03a07b10cff4131ed6f04e4dcd2f284abb6cfcf1c6ff48d87a8f3c6170

data/Cargo.lock

@@ -951,9 +951,9 @@ dependencies = [
 
 [[package]]
 name = "rustls-webpki"
-version = "0.103.15"
+version = "0.103.16"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f3c3cf1d8b1e7d4927e2d154c3fcb02979afb9939629c62cd9048d4f07b60ac2"
+checksum = "4443b1b6d39d7c663139942cc4558262562d2c84123bb6282ef177009ca8b281"
 dependencies = [
  "ring",
  "rustls-pki-types",
@@ -1050,7 +1050,7 @@ dependencies = [
 
 [[package]]
 name = "sghtmltopdf"
-version = "0.6.0"
+version = "0.7.0"
 dependencies = [
  "base64",
  "clap",
@@ -1077,7 +1077,7 @@ dependencies = [
 
 [[package]]
 name = "sghtmltopdf-ruby"
-version = "0.6.0"
+version = "0.7.0"
 dependencies = [
  "magnus",
  "rb-sys",
@@ -1395,9 +1395,9 @@ dependencies = [
 
 [[package]]
 name = "webpki-roots"
-version = "1.0.9"
+version = "1.0.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7dcd9d09a39985f5344844e66b0c530a33843579125f23e21e9f0f220850f22a"
+checksum = "1c1c8e20c8a38fc7d65abfe74eb7280e4aa667e8eec8bc84996d2874810748d9"
 dependencies = [
  "rustls-pki-types",
 ]

data/README.md

@@ -13,13 +13,22 @@ The engine runs inside your process through a native extension (magnus + rb-sys)
 gem "sghtmltopdf"
 ```
 
-Precompiled native gems are published for `x86_64-linux`, `aarch64-linux`, `x86_64-linux-musl`, `aarch64-linux-musl`, `arm64-darwin`, and `x86_64-darwin`.
+Precompiled native gems are published for `x86_64-linux`, `aarch64-linux`, `x86_64-linux-musl`, `aarch64-linux-musl`, `arm64-darwin`, `x86_64-darwin`, and Windows `x64-mingw-ucrt`.
 There is no build step on those platforms.
 
-Elsewhere (Windows) the gem cannot run in-process — the source gem does not carry the Rust core and will refuse to build with an explanatory message.
+Elsewhere the source gem does not carry the Rust core and will refuse to build with an explanatory message.
 Point those environments at a separate `sghtmltopdf server` process instead; see [Delegating to a server](#delegating-to-a-server).
 
-Requires Ruby >= 3.2.
+Requires Ruby >= 3.2. The precompiled gems bundle extensions for Ruby 3.2, 3.3,
+3.4, and 4.0. On Windows, use 64-bit RubyInstaller UCRT (`x64-mingw-ucrt`).
+
+For contributors building from a repository checkout on Windows, use RubyInstaller
+with its Devkit, the Rust GNU toolchain (`stable-x86_64-pc-windows-gnu`), and LLVM
+with `libclang.dll`. Set `RUSTUP_TOOLCHAIN=stable-x86_64-pc-windows-gnu`, set
+`LIBCLANG_PATH` to the LLVM `bin` directory, add it to `PATH`, and set
+`BINDGEN_EXTRA_CLANG_ARGS=--target=x86_64-w64-windows-gnu`.
+Run the build through `ridk exec bundle exec rake compile`. The precompiled gem
+does not need these tools.
 
 ## Usage
 
@@ -89,6 +98,8 @@ end
 ```
 
 View-rendering keys (`template`, `layout`, `locals`, …) go to `render_to_string`, response keys (`filename`, `disposition`, `status`) go to `send_data`, `show_as_html: true` returns the HTML instead of a PDF, and everything else is passed to the converter.
+
+`render_to_string(pdf: "invoice", template: "invoices/show")` returns PDF bytes without setting the controller response. You can then pass those bytes to `send_data` or save them elsewhere; response options such as `filename`, `disposition`, and `status` only apply to `render pdf:`.
 Converter keys are flat CLI flag names, so wicked_pdf's nested `margin: {top: 10}` becomes `margin_top: "10mm"` (with the unit spelled out); the [migration guide](https://waka.github.io/sghtmltopdf/en/migration/wicked-pdf.html) maps every key one by one.
 
 ### Assets

data/ext/sghtmltopdf/Cargo.toml

@@ -2,7 +2,7 @@
 # The package name differs from the library name on purpose: the core crate is published as
 # `sghtmltopdf`, and two packages with the same name cannot be written to one lockfile.
 name = "sghtmltopdf-ruby"
-version = "0.6.0"
+version = "0.7.0"
 edition = "2021"
 publish = false
 description = "Ruby binding for sghtmltopdf (see bindings/ruby)"

data/ext/sghtmltopdf/extconf.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "mkmf"
-require "rb_sys/mkmf"
-
 core = File.expand_path("../../../../core", __dir__)
 unless File.exist?(File.join(core, "Cargo.toml"))
   abort <<~MESSAGE
@@ -13,9 +10,13 @@ unless File.exist?(File.join(core, "Cargo.toml"))
     so a build from source was attempted, but the source gem does not include the
     Rust core and cannot be built.
 
-    Supported platforms: x86_64-linux / aarch64-linux / x86_64-linux-musl / aarch64-linux-musl / arm64-darwin / x86_64-darwin
+    Supported platforms: x86_64-linux / aarch64-linux / x86_64-linux-musl / aarch64-linux-musl / arm64-darwin / x86_64-darwin / x64-mingw-ucrt
+    Supported Ruby ABIs: 3.2 / 3.3 / 3.4 / 4.0
   MESSAGE
 end
 
+require "mkmf"
+require "rb_sys/mkmf"
+
 # Built as `lib/sghtmltopdf/sghtmltopdf.so`.
 create_rust_makefile("sghtmltopdf/sghtmltopdf")

data/lib/sghtmltopdf/options.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "date"
+# `Time#iso8601` comes from here before Ruby 3.4 (Rails loads it, a plain Ruby script may not).
+require "time"
 require "uri"
 
 module Sghtmltopdf
@@ -78,6 +81,11 @@ module Sghtmltopdf
       when true then [[name, nil]]
       # An array means the same option repeated. The same rule applies to each element.
       when Array then value.flat_map { |element| pairs_for(key, element) }
+      # `creation_date:` takes a moment in time. The CLI wants it as ISO 8601, so it is
+      # converted to UTC here rather than left to `to_s`, which would drop the zone for a Time
+      # and the subsecond part of a DateTime.
+      when Time, DateTime then [[name, value.to_time.getutc.iso8601]]
+      when Date then [[name, value.iso8601]]
       when Hash
         # Nesting such as wicked_pdf's `margin: {top: 10}` is not accepted. There is no
         # corresponding CLI flag, and flattening it mechanically would let even misspelled

data/lib/sghtmltopdf/renderer.rb

@@ -10,6 +10,19 @@ module Sghtmltopdf
   #
   # It is a pure Ruby class with no dependency on Rails, so it can be unit tested without Rails.
   class Renderer
+    module RenderToString
+      def render_to_string(*args, &block)
+        options = args.first.is_a?(Hash) ? args.first : args[1]
+        return super unless options.is_a?(Hash) && options.key?(:pdf)
+
+        normalized_args = args.map { |arg| arg.is_a?(Hash) ? arg.dup : arg }
+        options = _normalize_args(*normalized_args, &block)
+        renderer = Renderer.new(options.delete(:pdf), options, default_name: action_name)
+        html = super(**renderer.render_options, &block)
+        renderer.body_for(html)
+      end
+    end
+
     # The keys passed straight to `render_to_string`.
     RAILS_RENDER_KEYS = %i[
       action assigns body collection file formats handlers html inline layout
@@ -39,6 +52,7 @@ module Sghtmltopdf
     # Register the renderer with `ActionController::Renderers.add(:pdf)`.
     # Called from the Railtie's Action Controller load hook (`on_load`).
     def self.register!
+      ::ActionController::Rendering.prepend(RenderToString)
       ::ActionController::Renderers.add(:pdf) do |name, options|
         renderer = ::Sghtmltopdf::Renderer.new(name, options, default_name: action_name)
         html = render_to_string(**renderer.render_options)

data/lib/sghtmltopdf/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sghtmltopdf
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - yo_waka