ironpress 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfcd5dc3040d841312793e77a4119d49c14db383e9dcc7970182159c1989e206
-  data.tar.gz: e25587f9d4d4569b59cdff1da629d342bee5fc3b5e2c16832a0c5bea2809289c
+  metadata.gz: de16d91489579bd1a6504fba837207713dc4d3c14bec2296fe833e8a2774af12
+  data.tar.gz: 72442b9c4915bcd663ab4f40adbed9dbccb037d70e93d95fb91bb11242b37d5b
 SHA512:
-  metadata.gz: 1b608a05c7b569eb4282776226568d01a314f36f61d530a3db3c367622d83a11e16c1d3b915c653a9b9915bd13f99ec9fc6c0f51d88366e8b06a7bed07c6db2f
-  data.tar.gz: c9b9d71b037da3b8df4086e076b968075e34a10f03d56dbbc0263a6d9cdd473e3012b73320e548ea99599678c762385bececfae69d2969440cfff21425e5f99e
+  metadata.gz: 0d4b9d5cc663f7ea20912d4b76f6ad0f301b61415b9309de8e2632f7d63857297fadd6ebbc76f0e58e489c97b48233d9d7f11cc81db89f4e068ce7b9a311c7bc
+  data.tar.gz: 896be52ca3c08cf024ae4d31b8ffdbfb2e9a59f94b84b00769cd699a5e9e4ec1c9d0deb5a500437167fa87dfd9137b2aa95b47064968d93e11ba9bc81fa9e81f

data/README.md

@@ -1,58 +1,89 @@
-# Ironpress for Ruby
+# ironpress for Ruby
 
-Generate PDF bytes from HTML or Markdown without launching a browser.
+Generate PDF output from HTML or Markdown with a native Rust renderer. No
+browser process or system PDF dependency is required.
 
-## Installation
+[Read the complete Ruby getting-started guide](https://gastongouron.github.io/ironpress/get-started/ruby/).
 
-```ruby
-gem "ironpress"
+## Requirements
+
+- Ruby 3.0 or later
+- Linux, macOS, or Windows
+
+Releases include supported native gems plus a source gem.
+
+## Install
+
+```bash
+bundle add ironpress
 ```
 
-Ironpress supports Ruby 3.0 and later. Releases include a source gem and native
-gems for Linux, macOS, and Windows.
+Or install the gem globally:
 
-## Usage
+```bash
+gem install ironpress
+```
+
+## Create your first PDF
 
 ```ruby
 require "ironpress"
 
-pdf = Ironpress.html_to_pdf("<h1>Hello</h1>")
+pdf = Ironpress.html_to_pdf("<h1>Hello from Ruby</h1>")
 File.binwrite("output.pdf", pdf)
 ```
 
-Configuration methods return the converter, so policies can be composed in an
-idiomatic chain:
+The result is a binary Ruby `String`. Write it with `File.binwrite`, return it
+from a web response, or store it in your application.
+
+## Render Markdown
+
+```ruby
+pdf = Ironpress.markdown_to_pdf("# Release notes\n\nEverything shipped.")
+```
+
+## Configure and reuse a converter
 
 ```ruby
 converter = Ironpress::HtmlConverter.new
   .page_size("Letter")
-  .margin_sides(36, 54, 36, 54)
+  .margin_sides(36, 48, 36, 48)
   .header("Quarterly report")
   .footer("Page {page} of {pages}")
-  .sanitize(true)
+
+# Use header_html/footer_html for sanitized images, tables, and styled markup.
+converter.header_html("<strong>Quarterly report</strong>")
 
 pdf = converter.convert("<h1>Results</h1>")
+markdown_pdf = converter.convert_markdown("# Results")
 ```
 
-The converter supports page geometry, PDF and image quality, sanitization,
-headers and footers, custom TTF fonts, and optional CJK or emoji packs. Native
-Ruby also supports constrained local resources through `base_path` and
-`resource_root`, plus direct file output.
-
-See the [binding capability matrix](../README.md) for the contract shared with
-Rust, Python, and WebAssembly.
+Configuration methods return the converter, so policies compose in an idiomatic
+chain. Use `convert_to_file` or `convert_markdown_to_file` for direct output.
 
-## Font packs
+## Local resources and fonts
 
-Ironpress never downloads fallback fonts while rendering. Download the artifact
-your application needs, verify it as part of deployment, then install its bytes:
+Local URLs are denied until a canonical boundary is configured:
 
 ```ruby
-converter = Ironpress::HtmlConverter.new.add_font_pack(
-  "cjk-jp",
-  File.binread("ironpress-font-cjk-jp.ttf")
-)
-pdf = converter.convert("<p lang='ja'>日本語</p>")
+converter = Ironpress::HtmlConverter.new
+  .base_path("templates")
+  .resource_root(".")
+  .add_font("Inter", File.binread("assets/Inter.ttf"))
 ```
 
-Valid pack names are `cjk-jp`, `cjk-kr`, `cjk-sc`, `cjk-tc`, and `emoji`.
+Optional fallback packs enter through `add_font_pack`. Valid names are
+`cjk-jp`, `cjk-kr`, `cjk-sc`, `cjk-tc`, and `emoji`. Rendering never downloads
+a font pack.
+
+## Limits and errors
+
+- Invalid named settings raise `ArgumentError`.
+- Conversion failures raise `RuntimeError`.
+- HTML sanitization is enabled by default.
+- The binding has no async or streaming conversion API.
+- Remote HTTP document resources are not available.
+- JavaScript and browser DOM execution are not supported.
+
+See the [binding capability matrix](../README.md) for the contract shared with
+Rust, Python, browser WebAssembly, and Node.js.

data/ext/ironpress/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ironpress-ruby"
-version = "1.5.3"
+version = "1.6.0"
 edition = "2024"
 publish = false
 description = "Ruby bindings for the Ironpress HTML-to-PDF engine"
@@ -12,6 +12,6 @@ name = "ironpress_ruby"
 crate-type = ["cdylib"]
 
 [dependencies]
-ironpress-core = { version = "=1.5.3", package = "ironpress" }
+ironpress-core = { version = "=1.6.0", package = "ironpress" }
 magnus = "0.7"
 rb-sys = { version = "0.9", default-features = false, features = ["stable-api-compiled-fallback"] }

data/ext/ironpress/src/lib.rs

@@ -138,10 +138,18 @@ impl NativeConverter {
         self.configured(|converter| converter.header(text))
     }
 
+    fn header_html(&self, html: String) -> Self {
+        self.configured(|converter| converter.header_html(html))
+    }
+
     fn footer(&self, text: String) -> Self {
         self.configured(|converter| converter.footer(text))
     }
 
+    fn footer_html(&self, html: String) -> Self {
+        self.configured(|converter| converter.footer_html(html))
+    }
+
     fn convert(ruby: &Ruby, this: &Self, html: String) -> Result<RString, Error> {
         let pdf = this
             .converter
@@ -220,7 +228,9 @@ fn init(_ruby: &Ruby) -> Result<(), Error> {
     class.define_method("base_path", method!(NativeConverter::base_path, 1))?;
     class.define_method("resource_root", method!(NativeConverter::resource_root, 1))?;
     class.define_method("header", method!(NativeConverter::header, 1))?;
+    class.define_method("header_html", method!(NativeConverter::header_html, 1))?;
     class.define_method("footer", method!(NativeConverter::footer, 1))?;
+    class.define_method("footer_html", method!(NativeConverter::footer_html, 1))?;
     class.define_method("convert", method!(NativeConverter::convert, 1))?;
     class.define_method(
         "convert_markdown",

data/lib/ironpress/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ironpress
-  VERSION = "1.5.3"
+  VERSION = "1.6.0"
 end

data/lib/ironpress.rb

@@ -36,7 +36,9 @@ module Ironpress
       base_path
       resource_root
       header
+      header_html
       footer
+      footer_html
     ].freeze
 
     def initialize

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ironpress
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Paul Gaston Gouron
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-20 00:00:00.000000000 Z
+date: 2026-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys
@@ -42,7 +42,9 @@ files:
 homepage: https://github.com/gastongouron/ironpress
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://gastongouron.github.io/ironpress/get-started/ruby/
+  source_code_uri: https://github.com/gastongouron/ironpress
 post_install_message:
 rdoc_options: []
 require_paths: