RubyGems - page_print - Versions diffs - 0.1.1-arm64-darwin - Mend

page_print 0.1.1-arm64-darwin

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 (37) hide show

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1eaf3500d56f56b9eee208cb6600c815ac97ca92089a892c8c1fced4f29de95
+  data.tar.gz: 81d56eca9a927445ee5173b617e82ded78a379c6e07a2141c71daeddc586b0a3
+SHA512:
+  metadata.gz: 95151debb73305f8b8bf853d5beb1cfb9c97bbce1708a036410a0316fac9a6c9b99c7990865c2731650a27d69b10d48582b6ffdf1c21cf37270e2bc8fac70645
+  data.tar.gz: 59e951ac436ca402fc83651405fa576429ba1f11fe67f5a8f03a91b1bce648e69a6c7da94462b2d14e3bf6c500c7e764d1ace6e7c42fd8d51e5a80350669c95f

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2026 Dino Maric
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,247 @@
+# PagePrint
+`page_print` is a Ruby gem with a native C extension that renders HTML strings to PDF files using the `plutobook` library.
+## Requirements
+- Ruby 3.0+
+- Native gems are published for `x86_64-linux` and `arm64-darwin`.
+- Source builds on unsupported platforms require PlutoBook development headers and library files.
+### 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
+```
+## Installation
+Add PagePrint to your Gemfile:
+```ruby
+gem "page_print", "~> 0.1.1"
+```
+Or install from RubyGems directly:
+```sh
+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` | Native gem |
+| `arm64-darwin` | Native gem |
+| 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>`, compile the PagePrint native extension against that vendored build, and write a platform gem to `pkg/`.
+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.
+## 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`.
+Render a PDF from a controller:
+```ruby
+class PrintsController < ApplicationController
+  def pdf
+    html = render_to_string(template: "prints/pdf", formats: [:html], layout: "pdf")
+    pdf = PagePrint.html_to_pdf_string(
+      html,
+      page_size: :a4,
+      margins: :normal,
+      media: :print,
+      metadata: { title: "Print PDF", author: "PagePrint" }
+    )
+    send_data pdf, filename: "print.pdf", type: "application/pdf", disposition: "inline"
+  end
+end
+```
+Use normal Rails asset helpers in the PDF template or layout:
+```erb
+<%= stylesheet_link_tag "pdf" %>
+<%= image_tag "logo.png" %>
+```
+During controller actions, PagePrint defaults `base_url` to `request.base_url`. The default Rails resource fetcher resolves `/assets/...` through Propshaft or `public/assets`, avoiding HTTP requests back to the Rails app.
+You can still override `base_url` explicitly:
+```ruby
+pdf = PagePrint.html_to_pdf_string(html, base_url: "https://example.com")
+```
+Override the fetcher only when needed:
+```ruby
+# config/initializers/page_print.rb
+PagePrint.configure do |config|
+  config.resource_fetcher = MyResourceFetcher.new
+end
+```
+## Ruby Usage
+```ruby
+require "page_print"
+require "tmpdir"
+html = <<~HTML
+  <html>
+    <body>
+      <h1>Hello</h1>
+      <p>This PDF was generated by PagePrint.</p>
+    </body>
+  </html>
+HTML
+output_path = File.join(Dir.tmpdir, "page_print-output.pdf")
+PagePrint.html_to_pdf(html, output_path, base_url: "https://example.com")
+```
+To get the generated PDF as a binary string instead of writing directly to a file:
+```ruby
+pdf = PagePrint.html_to_pdf_string(html, base_url: "https://example.com")
+```
+Use custom page dimensions and margins when a preset is not enough:
+```ruby
+pdf = PagePrint.html_to_pdf_string(
+  html,
+  page_size: { width: 100, height: 150, unit: :mm },
+  margins: { top: 5, right: 6, bottom: 7, left: 8, unit: :mm }
+)
+```
+You can configure default options once, for example to provide a resource fetcher used by all renders:
+```ruby
+PagePrint.configure do |config|
+  config.resource_fetcher = lambda do |url|
+    next unless url == "asset:pdf.css"
+    { content: "body { font-family: sans-serif; }", mime_type: "text/css" }
+  end
+end
+```
+Supported keyword options:
+- `base_url:` string used to resolve relative URLs in the HTML
+- `page_size:` one of `:a3`, `:a4`, `:a5`, `:b4`, `:b5`, `:letter`, `:legal`, `:ledger`, or `{ width:, height:, unit: }`
+- `margins:` one of `:none`, `:normal`, `:narrow`, `:moderate`, `:wide`, or `{ top:, right:, bottom:, left:, unit: }`
+- `media:` one of `:print`, `:screen`
+- `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`
+`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`.
+## 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.

data/ext/page_print/extconf.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require 'mkmf'
+def page_print_native_platform
+  platform = Gem::Platform.local
+  if platform.os == 'linux' && platform.cpu == 'x86_64'
+    'x86_64-linux'
+  else
+    platform.to_s
+  end
+end
+project_root = File.expand_path('../..', __dir__)
+vendor_platform = ENV.fetch('PAGE_PRINT_VENDOR_PLATFORM', page_print_native_platform)
+vendor_dir = File.join(project_root, 'lib', 'page_print', 'vendor', vendor_platform)
+vendor_include_dir = File.join(vendor_dir, 'include')
+vendor_lib_dir = File.join(vendor_dir, 'lib')
+if File.directory?(vendor_include_dir) && File.directory?(vendor_lib_dir)
+  dir_config('plutobook', vendor_include_dir, vendor_lib_dir)
+  if vendor_platform.end_with?('-linux')
+    $LDFLAGS = "-Wl,-rpath,\\$$ORIGIN/vendor/#{vendor_platform}/lib #{$LDFLAGS}"
+  elsif vendor_platform.end_with?('-darwin')
+    $LDFLAGS = "-Wl,-rpath,@loader_path/vendor/#{vendor_platform}/lib #{$LDFLAGS}"
+  end
+else
+  pkg_config('plutobook')
+end
+dir_config('plutobook')
+['/opt/homebrew/opt/plutobook', '/usr/local/opt/plutobook'].each do |prefix|
+  next unless File.directory?(prefix)
+  dir_config('plutobook', File.join(prefix, 'include'), File.join(prefix, 'lib'))
+  break
+end
+unless have_header('plutobook/plutobook.h')
+  abort 'plutobook header not found. Install plutobook or pass --with-plutobook-include=/path/to/include'
+end
+unless have_library('plutobook', 'plutobook_create')
+  abort 'plutobook library not found. Install plutobook or pass --with-plutobook-lib=/path/to/lib'
+end
+create_makefile('page_print/page_print')