RubyGems - page_print - Versions diffs - 0.1.3-x86_64-linux → 0.1.6-x86_64-linux - Mend

page_print 0.1.3-x86_64-linux → 0.1.6-x86_64-linux

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 973330977584d0dfa7c6798ae6291967e2a099b4e8d27207ec23e35806234107
-  data.tar.gz: 5de310014b57028a5da008e434094fb0e28e4fd3733b6835e04d1bc5f8b07aba
+  metadata.gz: 5c4b102152d43feb2342bebd51167ef627964198945a74621060ab724d0cdd09
+  data.tar.gz: bb9dfec69bb3caafb150060247d0201e97fca142102e774295a5edbb3f675ac6
 SHA512:
-  metadata.gz: 4e330acefd8e7b16a1ee685c1570bf0b988dcb3bec3b903c87a8d6de9b01122380601032e0e6f56c1a5b3d2db1dcecb7006fcc97105bd23eda5455716d19eb7f
-  data.tar.gz: a4732c1f33ac859a15f84964976c42aa010cee26c6d0177b32ca097cd027ac4f87870c06a0b722abde013c4b836e4791ac81d2febcecb40662bfcc63de9fbc0b
+  metadata.gz: f99c5d07470b510cdab437c1bf80d690efec59067003cd65515dc35915248016d2e45a7aeee48e7f738e1dd95c5de4f90c7af45b653c42d59a231bc6c0965dcc
+  data.tar.gz: 6d4ec974bb6f0ce44ae515e6574d2362645ef0aaf519421f43fb352a6ddc16c3fb912febc413865a95925ac84f3762bb59007cc3b98ae6eea1ef4b454775ddf9

data/README.md CHANGED Viewed

@@ -1,34 +1,19 @@
 # PagePrint
-`page_print` is a Ruby gem with a native C extension that renders HTML strings to PDF files using the `plutobook` library.
+> [!IMPORTANT]
+> PagePrint is not production-ready yet. The gem is still in active testing, especially around native packaging and platform compatibility.
-## Requirements
-- Ruby 3.0+
-- Native gems are published for `x86_64-linux` and `arm64-darwin`.
-- Native gems vendor PlutoBook but compile the small Ruby extension during install so it links against your local Ruby.
-- Source builds on unsupported platforms require PlutoBook development headers and library files.
-### Source Build Requirements
-On macOS with Homebrew:
+`page_print` renders HTML strings to PDF files from Ruby using the `plutobook` library through a native C extension.
-```sh
-brew install plutobook pkg-config
-```
-If `pkg-config` cannot find `plutobook`, install the gem with explicit include and library paths:
-```sh
-gem install page_print -- --with-plutobook-include=/path/to/include --with-plutobook-lib=/path/to/lib
-```
+It exists as a faster, simpler alternative to PDFKit and other `wkhtmltopdf`-based gems. There is no external renderer process to shell out to, and the public Ruby API is intentionally small.
 ## Installation
 Add PagePrint to your Gemfile:
 ```ruby
-gem "page_print", "~> 0.1.2"
+gem "page_print", "~> 0.1.4"
 ```
 Or install from RubyGems directly:
@@ -37,105 +22,11 @@ Or install from RubyGems directly:
 gem install page_print
 ```
-The native gems bundle PlutoBook and required non-system shared libraries. Optional PlutoBook features for curl, TurboJPEG, and WebP are disabled in native gems to keep the bundled dependency set smaller.
-## Supported Platforms
-| Platform | Install Type |
-|---|---|
-| `x86_64-linux` | Vendored PlutoBook, local Ruby extension build |
-| `arm64-darwin` | Vendored PlutoBook, local Ruby extension build |
-| Other platforms | Source build |
-## Local Build
-Build and install locally:
-```sh
-gem build page_print.gemspec
-gem install ./page_print-*.gem
-```
-## Development
-1. Install development dependencies:
-```sh
-bundle install
-```
-2. Compile the native extension into `lib/page_print`:
-```sh
-bundle exec rake compile
-```
-3. Open an interactive Ruby session against the local checkout:
-```sh
-bundle exec irb -Ilib
-```
-Then load the gem from the repo and try it:
-```ruby
-require "page_print"
-require "tmpdir"
-output_path = File.join(Dir.tmpdir, "page_print-output.pdf")
-PagePrint.html_to_pdf("<html><body><h1>Hello</h1></body></html>", output_path, page_size: :letter, margins: :narrow, media: :screen)
-```
-You can also do a quick one-shot smoke test from the shell:
-```sh
-bundle exec ruby -Ilib -e 'require "tmpdir"; require "page_print"; output_path = File.join(Dir.tmpdir, "page_print-output.pdf"); p PagePrint.html_to_pdf("<html><body><h1>Hello</h1></body></html>", output_path, page_size: :letter, margins: :narrow, media: :screen)'
-```
-Or use the development console, which compiles the native extension first and then starts IRB with `PagePrint` loaded:
-```sh
-bin/console
-```
-## Running Tests
-Run the test suite only:
-```sh
-bundle exec rake test
-```
-Or run the default rake task, which compiles the extension and then runs tests:
-```sh
-bundle exec rake
-```
-## Building Native Gems
-Build an `x86_64-linux` platform gem with a vendored PlutoBook library:
-```sh
-bundle exec rake package:linux
-```
-Build an Apple Silicon macOS platform gem with a vendored PlutoBook library:
-```sh
-bundle exec rake package:darwin_arm64
-```
-These tasks check out PlutoBook `v0.17.0`, build it into `lib/page_print/vendor/<platform>`, and write a platform gem to `pkg/`. Platform gems compile the Ruby extension during gem install to avoid tying the gem to the build machine's Ruby version.
-Native gems bundle PlutoBook and its non-system shared library dependencies. Optional PlutoBook features for curl, TurboJPEG, and WebP are disabled to keep the bundled dependency set smaller.
-The packaging tasks expect PlutoBook's build dependencies to be installed on the build machine, including Meson, Ninja, pkg-config, Cairo, FreeType, HarfBuzz, Fontconfig, Expat, and ICU.
+Native gems are published for `x86_64-linux` and `arm64-darwin`. Other platforms build from source and require PlutoBook development headers and library files.
 ## Rails Usage
-PagePrint is currently optimized for Rails applications using Propshaft. In Rails, PagePrint installs a default Propshaft-backed resource fetcher and uses the current request URL as the default `base_url`.
+PagePrint is optimized for Rails applications using Propshaft. In Rails, PagePrint installs a default Propshaft-backed resource fetcher and uses the current request URL as the default `base_url`.
 Render a PDF from a controller:
@@ -228,6 +119,8 @@ PagePrint.configure do |config|
 end
 ```
+## Options
 Supported keyword options:
 - `base_url:` string used to resolve relative URLs in the HTML
@@ -237,12 +130,156 @@ Supported keyword options:
 - `resource_fetcher:` callable that receives a URL and returns `nil` or `{ content:, mime_type:, text_encoding: nil }`
 - `metadata:` hash with `:title`, `:author`, `:subject`, `:keywords`, `:creation_date`, or `:modification_date`
+Unresolved URLs are not fetched over the network. Provide assets through `resource_fetcher`, or return `nil` to skip a URL.
 `metadata[:creation_date]` and `metadata[:modification_date]` should be ISO-8601 strings, for example `2026-05-10T12:00:00Z`.
 Custom dimensions and margins require `unit:`. Supported units are `:pt`, `:pc`, `:in`, `:cm`, `:mm`, and `:px`.
+## Benchmarking
+```sh
+RUNS=30 WARMUPS=3 bundle exec ruby benchmark/pdf_renderers.rb
+```
+Measured on 2026-05-30 with Ruby 3.4.7 on Apple Silicon:
+| Renderer | Avg wall | P95 wall | Avg CPU | Avg peak RSS | Avg PDF |
+|---|---:|---:|---:|---:|---:|
+| `page_print` | 78.2ms | 89.6ms | 93.4ms | 42.1MB | 33.0KB |
+| PDFKit | 782.2ms | 2127.1ms | 824.8ms | 59.4MB | 27.9KB |
+For options and CSV output, see `benchmark/README.md`.
+## Requirements
+- Ruby 3.2+
+- Native gems are published for `x86_64-linux` and `arm64-darwin`.
+- Native gems vendor PlutoBook but compile the small Ruby extension during install so it links against your local Ruby.
+- Source builds on unsupported platforms require PlutoBook development headers and library files.
+Supported platforms:
+| Platform | Install Type |
+|---|---|
+| `x86_64-linux` | Vendored PlutoBook, local Ruby extension build |
+| `arm64-darwin` | Vendored PlutoBook, local Ruby extension build |
+| Other platforms | Source build |
+Source build requirements on macOS with Homebrew:
+```sh
+brew install plutobook pkg-config
+```
+If `pkg-config` cannot find `plutobook`, install the gem with explicit include and library paths:
+```sh
+gem install page_print -- --with-plutobook-include=/path/to/include --with-plutobook-lib=/path/to/lib
+```
+Native gems bundle PlutoBook and required non-system shared libraries. Optional PlutoBook features for curl, TurboJPEG, and WebP are disabled in native gems to keep the bundled dependency set smaller.
 ## Notes
 - The extension supports writing to a file path with `html_to_pdf` or returning PDF bytes with `html_to_pdf_string`.
 - JavaScript execution is intentionally unsupported.
 - Native gems disable PlutoBook's optional curl, TurboJPEG, and WebP features.
+## Development
+Install development dependencies:
+```sh
+bundle install
+```
+Compile the native extension into `lib/page_print`:
+```sh
+bundle exec rake compile
+```
+Open an interactive Ruby session against the local checkout:
+```sh
+bundle exec irb -Ilib
+```
+Then load the gem from the repo and try it:
+```ruby
+require "page_print"
+require "tmpdir"
+output_path = File.join(Dir.tmpdir, "page_print-output.pdf")
+PagePrint.html_to_pdf("<html><body><h1>Hello</h1></body></html>", output_path, page_size: :letter, margins: :narrow, media: :screen)
+```
+You can also do a quick one-shot smoke test from the shell:
+```sh
+bundle exec ruby -Ilib -e 'require "tmpdir"; require "page_print"; output_path = File.join(Dir.tmpdir, "page_print-output.pdf"); p PagePrint.html_to_pdf("<html><body><h1>Hello</h1></body></html>", output_path, page_size: :letter, margins: :narrow, media: :screen)'
+```
+Or use the development console, which compiles the native extension first and then starts IRB with `PagePrint` loaded:
+```sh
+bin/console
+```
+## Running Tests
+Run the test suite only:
+```sh
+bundle exec rake test
+```
+Or run the default rake task, which compiles the extension and then runs tests:
+```sh
+bundle exec rake
+```
+## Local Build
+Build and install locally:
+```sh
+gem build page_print.gemspec
+gem install ./page_print-*.gem
+```
+## Releasing
+Publish a new version with:
+```sh
+bin/bump 0.1.6
+```
+That updates `lib/page_print/version.rb` and `Gemfile.lock`, commits `Release 0.1.6`, creates annotated tag `v0.1.6`, and pushes `main` plus the tag. Requires a clean worktree on `main`.
+The Package workflow then builds the source and platform gems, pushes them to RubyGems (trusted publishing / OIDC, GitHub environment `release`), and creates a GitHub Release with the gem artifacts and commit notes since the previous `v*` tag.
+## Building Native Gems
+Build an `x86_64-linux` platform gem with a vendored PlutoBook library:
+```sh
+bundle exec rake package:linux
+```
+Build an Apple Silicon macOS platform gem with a vendored PlutoBook library:
+```sh
+bundle exec rake package:darwin_arm64
+```
+These tasks check out PlutoBook `v0.18.0`, build it into `lib/page_print/vendor/<platform>`, and write a platform gem to `pkg/`. Platform gems compile the Ruby extension during gem install to avoid tying the gem to the build machine's Ruby version.
+Native gems bundle PlutoBook and its non-system shared library dependencies. Optional PlutoBook features for curl, TurboJPEG, and WebP are disabled to keep the bundled dependency set smaller.
+The packaging tasks expect PlutoBook's build dependencies to be installed on the build machine, including Meson, Ninja, pkg-config, Cairo, FreeType, HarfBuzz, Fontconfig, Expat, and ICU.

data/ext/page_print/page_print.c CHANGED Viewed

@@ -48,7 +48,7 @@ typedef struct {
     plutobook_page_size_t page_size;
     plutobook_page_margins_t margins;
     plutobook_media_type_t media;
-    const char *base_url;
+    VALUE base_url;
     VALUE resource_fetcher;
     VALUE metadata;
 } pageprint_options_t;
@@ -97,6 +97,11 @@ typedef struct {
     int ok;
 } pageprint_write_pdf_stream_args_t;
+typedef struct {
+    plutobook_t *book;
+    VALUE metadata;
+} pageprint_apply_metadata_args_t;
 static VALUE pageprint_append_pdf_string(VALUE value);
 static plutobook_stream_status_t pageprint_write_pdf_string(void *closure, const char *data, unsigned int length);
 static plutobook_resource_data_t *pageprint_fetch_resource(void *closure, const char *url);
@@ -368,6 +373,15 @@ static void pageprint_apply_metadata(plutobook_t *book, VALUE metadata)
     pageprint_set_metadata_value(book, metadata, id_modification_date, PLUTOBOOK_PDF_METADATA_MODIFICATION_DATE);
 }
+static VALUE pageprint_apply_metadata_with_gvl(VALUE ptr)
+{
+    pageprint_apply_metadata_args_t *args = (pageprint_apply_metadata_args_t *)ptr;
+    pageprint_apply_metadata(args->book, args->metadata);
+    return Qnil;
+}
 static void *pageprint_load_html_without_gvl(void *ptr)
 {
     pageprint_load_html_args_t *args = ptr;
@@ -487,23 +501,26 @@ static plutobook_resource_data_t *pageprint_fetch_resource(void *closure, const
     pageprint_resource_fetch_args_t args;
     int state;
-    args.fetcher = fetcher;
-    args.url = url;
-    args.resource = NULL;
+    if (!NIL_P(fetcher->object)) {
+        args.fetcher = fetcher;
+        args.url = url;
+        args.resource = NULL;
-    state = (int)(intptr_t)rb_thread_call_with_gvl(pageprint_call_resource_fetcher_with_gvl, &args);
+        state = (int)(intptr_t)rb_thread_call_with_gvl(pageprint_call_resource_fetcher_with_gvl, &args);
-    if (state) {
-        fetcher->state = state;
-        plutobook_set_error_message("failed to fetch URL '%s'", url);
-        return NULL;
-    }
+        if (state) {
+            fetcher->state = state;
+            plutobook_set_error_message("failed to fetch URL '%s'", url);
+            return NULL;
+        }
-    if (args.resource) {
-        return args.resource;
+        if (args.resource) {
+            return args.resource;
+        }
     }
-    return plutobook_fetch_url(url);
+    plutobook_set_error_message("network fetch disabled for URL '%s'", url);
+    return NULL;
 }
 static pageprint_options_t pageprint_options_from_value(VALUE options)
@@ -521,7 +538,7 @@ static pageprint_options_t pageprint_options_from_value(VALUE options)
     result.page_size = PLUTOBOOK_PAGE_SIZE_A4;
     result.margins = PLUTOBOOK_PAGE_MARGINS_NORMAL;
     result.media = PLUTOBOOK_MEDIA_TYPE_PRINT;
-    result.base_url = "";
+    result.base_url = Qnil;
     result.resource_fetcher = Qnil;
     result.metadata = Qnil;
@@ -556,7 +573,7 @@ static pageprint_options_t pageprint_options_from_value(VALUE options)
             rb_raise(rb_eTypeError, "base_url must be a String or nil");
         }
-        result.base_url = StringValueCStr(base_url_value);
+        result.base_url = base_url_value;
     }
     if (page_size_value != Qundef) {
@@ -596,6 +613,7 @@ static plutobook_t *pageprint_create_book_from_html(VALUE html, VALUE options, p
     pageprint_options_t pageprint_options;
     const char *html_str;
+    const char *base_url_str;
     long html_len;
     plutobook_t *book;
@@ -628,21 +646,30 @@ static plutobook_t *pageprint_create_book_from_html(VALUE html, VALUE options, p
     resource_fetcher->object = pageprint_options.resource_fetcher;
     resource_fetcher->state = 0;
-    if (!NIL_P(resource_fetcher->object)) {
-        plutobook_set_custom_resource_fetcher(book, pageprint_fetch_resource, resource_fetcher);
-    }
+    plutobook_set_custom_resource_fetcher(book, pageprint_fetch_resource, resource_fetcher);
     /* 2. Load HTML */
     plutobook_clear_error_message();
+    base_url_str = "";
+    if (!NIL_P(pageprint_options.base_url)) {
+        base_url_str = StringValueCStr(pageprint_options.base_url);
+    }
     load_args.book = book;
     load_args.html = html_str;
     load_args.length = (int)html_len;
     load_args.user_style = "";
     load_args.user_script = "";
-    load_args.base_url = pageprint_options.base_url;
+    load_args.base_url = base_url_str;
     load_args.ok = 0;
+    RB_GC_GUARD(html);
+    RB_GC_GUARD(options);
+    RB_GC_GUARD(pageprint_options.base_url);
+    RB_GC_GUARD(pageprint_options.resource_fetcher);
+    RB_GC_GUARD(pageprint_options.metadata);
     rb_thread_call_without_gvl(
         pageprint_load_html_without_gvl,
         &load_args,
@@ -665,7 +692,20 @@ static plutobook_t *pageprint_create_book_from_html(VALUE html, VALUE options, p
         rb_jump_tag(resource_fetcher->state);
     }
-    pageprint_apply_metadata(book, pageprint_options.metadata);
+    {
+        pageprint_apply_metadata_args_t metadata_args;
+        int metadata_state = 0;
+        metadata_args.book = book;
+        metadata_args.metadata = pageprint_options.metadata;
+        rb_protect(pageprint_apply_metadata_with_gvl, (VALUE)&metadata_args, &metadata_state);
+        if (metadata_state) {
+            plutobook_destroy(book);
+            rb_jump_tag(metadata_state);
+        }
+    }
     return book;
 }
@@ -734,6 +774,11 @@ static VALUE pageprint_html_to_pdf(int argc, VALUE *argv, VALUE self) {
     write_args.path = path_str;
     write_args.ok = 0;
+    RB_GC_GUARD(html);
+    RB_GC_GUARD(options);
+    RB_GC_GUARD(resource_fetcher.object);
+    RB_GC_GUARD(path);
     rb_thread_call_without_gvl(
         pageprint_write_pdf_without_gvl,
         &write_args,
@@ -751,10 +796,6 @@ static VALUE pageprint_html_to_pdf(int argc, VALUE *argv, VALUE self) {
         pageprint_raise_plutobook_error_with_path(rb_eRuntimeError, "failed to write PDF to", path_str);
     }
-    RB_GC_GUARD(resource_fetcher.object);
-    RB_GC_GUARD(options);
-    RB_GC_GUARD(path);
     return Qtrue;
 }
@@ -783,6 +824,11 @@ static VALUE pageprint_html_to_pdf_string(int argc, VALUE *argv, VALUE self) {
     write_args.output = &output;
     write_args.ok = 0;
+    RB_GC_GUARD(html);
+    RB_GC_GUARD(options);
+    RB_GC_GUARD(resource_fetcher.object);
+    RB_GC_GUARD(output.output);
     rb_thread_call_without_gvl(
         pageprint_write_pdf_stream_without_gvl,
         &write_args,
@@ -804,10 +850,6 @@ static VALUE pageprint_html_to_pdf_string(int argc, VALUE *argv, VALUE self) {
         pageprint_raise_plutobook_error(rb_eRuntimeError, "failed to write PDF to string");
     }
-    RB_GC_GUARD(resource_fetcher.object);
-    RB_GC_GUARD(options);
-    RB_GC_GUARD(output.output);
     return output.output;
 }

data/lib/page_print/vendor/x86_64-linux/include/plutobook/plutobook.h CHANGED Viewed

@@ -39,7 +39,7 @@ extern "C" {
 #endif
 #define PLUTOBOOK_VERSION_MAJOR 0
-#define PLUTOBOOK_VERSION_MINOR 17
+#define PLUTOBOOK_VERSION_MINOR 18
 #define PLUTOBOOK_VERSION_MICRO 0
 #define PLUTOBOOK_VERSION_ENCODE(major, minor, micro) (((major) * 10000) + ((minor) * 100) + ((micro) * 1))

data/lib/page_print/vendor/x86_64-linux/lib/libglib-2.0.so.0 CHANGED Viewed

Binary file

data/lib/page_print/vendor/x86_64-linux/lib/libplutobook.so CHANGED Viewed

Binary file

data/lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0 CHANGED Viewed

Binary file

data/lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0.18.0 ADDED Viewed

Binary file

data/lib/page_print/vendor/x86_64-linux/lib/{libruby.so.3.0 → libruby.so.3.2} RENAMED Viewed

Binary file

data/lib/page_print/vendor/x86_64-linux/lib/pkgconfig/plutobook.pc CHANGED Viewed

@@ -4,7 +4,7 @@ libdir=${prefix}/lib
 Name: PlutoBook
 Description: Paged HTML rendering library
-Version: 0.17.0
+Version: 0.18.0
 Requires.private: harfbuzz, expat >= 2.1.0, icu-uc >= 57.0, icu-i18n >= 57.0, freetype2 >= 9.7.3, fontconfig >= 2.12.5, cairo >= 1.15.10, cairo-pdf >= 1.15.10, cairo-png >= 1.15.10, cairo-ft >= 1.15.10, cairo-fc >= 1.15.10
 Libs: -L${libdir} -lplutobook
 Libs.private: -pthread -lm

data/lib/page_print/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module PagePrint
-  VERSION = '0.1.3'
+  VERSION = '0.1.6'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_print
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: x86_64-linux
 authors:
 - Dino Maric
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-30 00:00:00.000000000 Z
+date: 2026-07-26 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem with a native extension that renders HTML strings to PDF files
   via the plutobook C library.
@@ -106,9 +106,9 @@ files:
 - lib/page_print/vendor/x86_64-linux/lib/libpixman-1.so.0
 - lib/page_print/vendor/x86_64-linux/lib/libplutobook.so
 - lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0
-- lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0.17.0
+- lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0.18.0
 - lib/page_print/vendor/x86_64-linux/lib/libpng16.so.16
-- lib/page_print/vendor/x86_64-linux/lib/libruby.so.3.0
+- lib/page_print/vendor/x86_64-linux/lib/libruby.so.3.2
 - lib/page_print/vendor/x86_64-linux/lib/libuuid.so.1
 - lib/page_print/vendor/x86_64-linux/lib/libxcb-render.so.0
 - lib/page_print/vendor/x86_64-linux/lib/libxcb-shm.so.0
@@ -135,14 +135,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Render HTML to PDF from Ruby using plutobook

data/lib/page_print/vendor/x86_64-linux/lib/libplutobook.so.0.17.0 DELETED Viewed

Binary file