rustyprint 1.0.1-x86_64-linux-musl

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3e0dfdb65a26d83d70076e9a62ae9c7a60025fe247670d77839fc10db006e69
+  data.tar.gz: bd00cbe151125aa267a9a692218ff5a8e1cfe9b9b4abdcc1a6f6bcf264d1cc10
+SHA512:
+  metadata.gz: 0fb682c2df5ee2132926a393e746328a1b1f169c1adfd805758a8fa14d03f8b25fdc76145a436cc14e1ccee9d826606249ca00dc4ff5c83dde8c4167effd71b7
+  data.tar.gz: 3cce9af5b3062fb7c3528909a8a75765820f905e35f6390cc4c8a4d5f404650a07b7709cb75a3401eb3245d1cf4a1c8e8555672bf43a9998ca41e3b0c1dcbc89

data/.yardopts

@@ -0,0 +1,5 @@
+--markup markdown
+--no-private
+lib/**/*.rb
+-
+README.md

data/LICENSE-APACHE

@@ -0,0 +1,176 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Verschuren
+
+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/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2022 The Noto Project Authors (https://github.com/notofonts/latin-greek-cyrillic)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# rustyprint for Ruby
+
+Renders HTML and CSS to PDF with [rustyprint](https://github.com/vryan95/rustyprint), a layout engine of its own written in Rust. It needs no browser, no external runtime and no network access, and the fonts it needs are built in.
+
+```ruby
+gem "rustyprint"
+```
+
+Ruby 3.2 or newer. Each platform has a gem with the native library built in: Linux (glibc and musl) and macOS on x64 and arm64, and Windows (RubyInstaller, UCRT) on x64 and arm64.
+
+## Render
+
+The API documentation, built from the gem's doc comments, is at [rubydoc.info/gems/rustyprint](https://rubydoc.info/gems/rustyprint).
+
+```ruby
+require "rustyprint"
+
+output = Rustyprint.render(html, page_size: "A4", margin: "15mm", title: "Invoice 42",
+                                 assets: { "logo.png" => File.binread("logo.png"),
+                                           "invoice.css" => Pathname("app/pdf/invoice.css") })
+File.binwrite("invoice.pdf", output.pdf)
+output.warnings # => ["invoice.css:12: unsupported property `colr`"]
+```
+
+`render` returns a `Rustyprint::Output` with `pdf`, a binary String, and `warnings`, problems found in the document's CSS and assets, as an Array of Strings.
+
+**Options** are keywords, the JSON options every rustyprint front end shares ([schema/render-options.schema.json](../../schema/render-options.schema.json)):
+
+| Option | Example | Default |
+| --- | --- | --- |
+| `page_size` | `"Letter"`, or `{ width: "100mm", height: "150mm" }` | `"A4"` |
+| `landscape` | `true` | `false` |
+| `margin` | `"15mm"`, `"10mm 20mm"` | `"2cm"` |
+| `title` | `"Invoice 42"` | the document's `<title>` |
+| `stylesheet` | `"body { font-family: sans-serif }"` | none |
+| `remote` | `{ allowed_hosts: ["cdn.example.com"] }` | nothing fetched |
+| `limits` | `{ max_pages: 50, timeout_ms: 10_000 }` | 20 MB of HTML, 500,000 nodes, 2,000 pages, 60 s |
+
+**Assets** are the files the document refers to by relative or root-relative URL: stylesheets, images, fonts and `iframe` documents. Give each by the path the HTML uses, without a leading slash (`/assets/app.css` is the asset `assets/app.css`), as a String, a Pathname or an IO. Nothing else is read, and nothing is fetched from the network unless `remote` allows the host.
+
+**Errors** are `Rustyprint::Error` subclasses, each with a `kind`:
+
+| Class | `kind` | When |
+| --- | --- | --- |
+| `Rustyprint::InvalidOptionsError` | `:invalid_options` | An unknown option, or an invalid value |
+| `Rustyprint::LimitExceededError` | `:limit_exceeded` | The document exceeds a limit |
+| `Rustyprint::TimeoutError` | `:timeout` | Rendering took longer than the deadline |
+| `Rustyprint::InternalError` | `:internal` | A bug in rustyprint |
+
+HTML that is not valid in its encoding raises `ArgumentError`. HTML in another encoding is converted to UTF-8.
+
+**Threads:** a render releases the GVL, so other threads run meanwhile, and renders on several threads run at once.
+
+## In Rails
+
+In a Rails app the gem adds `render pdf:` to controllers. It renders the view to HTML, as `render_to_string` does, and sends the PDF:
+
+```ruby
+def show
+  @invoice = Invoice.find(params[:id])
+
+  respond_to do |format|
+    format.html { render layout: "pdf" }
+    format.pdf do
+      render pdf: "invoice #{@invoice.id}",
+        template: "invoices/show",
+        layout: "pdf",
+        disposition: "inline",
+        formats: [:html]
+    end
+  end
+end
+```
+
+- `pdf` names the file; `.pdf` is added.
+- `disposition` is `"inline"`, the default, or `"attachment"`.
+- `formats` defaults to `[:html]`. `template`, `layout`, `locals` and the rest are passed on to `render_to_string`.
+- The render options, such as `page_size: "Letter"` or `margin: "15mm"`, are the same as for `Rustyprint.render`.
+
+The view uses the usual helpers, such as `stylesheet_link_tag` and `image_tag`. The stylesheets, images and fonts the HTML and its stylesheets refer to by path are read from `public/`, where precompiled assets are. Anything not found there is fetched from the app's asset pipeline, as Propshaft or Sprockets serves it in development. `assets:` adds files of your own, by the path the HTML uses.
+
+Each render is instrumented as `render.rustyprint`, with the asset paths and the warnings, and the warnings are logged.
+
+When `config.asset_host` is set, asset URLs point at another host. The renderer only fetches from hosts that `remote:` allows, so leave `asset_host` unset for PDF views.
+
+[demos/rails](../../demos/rails) is a Rails app that does this. It also has pages that compare the sample documents with how a browser shows them.
+
+## Develop
+
+From this directory, with Rust installed:
+
+```sh
+bundle install
+bundle exec rake          # builds the native library with Cargo, runs the specs, then checks the documentation
+bundle exec rake compile  # only builds the library, into lib/rustyprint/native
+bundle exec rake docs     # fails unless every public class, method and constant is documented
+```
+
+`RUSTYPRINT_LIBRARY` points the gem at a library somewhere else. `rake native PLATFORM=x86_64-linux-gnu LIBRARY=path` builds a platform gem around a library, as the release workflow does for every platform.
+
+## License
+
+MIT or Apache-2.0, at your option ([LICENSE-MIT](https://github.com/vryan95/rustyprint/blob/master/LICENSE-MIT), [LICENSE-APACHE](https://github.com/vryan95/rustyprint/blob/master/LICENSE-APACHE)). The fonts built into the native library are under the SIL Open Font License ([OFL.txt](https://github.com/vryan95/rustyprint/blob/master/fonts/OFL.txt)). The gem carries all three.

data/lib/rustyprint/asset_collector.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module Rustyprint
+  # Finds the files an HTML document refers to, in its tags, its style attributes and blocks,
+  # and the stylesheets it loads, and fetches each once, for {Rustyprint.render}'s assets.
+  #
+  # @example
+  #   collector = AssetCollector.new { |path| File.binread("public#{path}") if File.file?("public#{path}") }
+  #   collector.collect(html) # => { "assets/app-1a2b.css" => "...", "images/logo.png" => "..." }
+  #
+  # The block gets a root-relative path, such as "/assets/app-1a2b.css", and returns the file's
+  # contents, or nil if there is none. The result maps the path the document uses, without its
+  # leading slash, to the contents. Remote and data: URLs are left to the renderer.
+  class AssetCollector
+    TAG = %r{<([a-zA-Z][\w-]*)((?:\s+[^\s=>/]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s>]+))?)*)\s*/?>}
+    ATTRIBUTE = %r{([^\s=>/]+)(?:\s*=\s*("[^"]*"|'[^']*'|[^\s>]+))?}
+    STYLE_BLOCK = %r{<style\b[^>]*>(.*?)</style>}mi
+    CSS_COMMENT = %r{/\*.*?\*/}m
+    CSS_URL = /url\(\s*(?:"([^"]*)"|'([^']*)'|([^)\s]*))\s*\)|@import\s+(?:"([^"]*)"|'([^']*)')/i
+    URL_ATTRIBUTES = %w[src poster data].freeze
+    STYLESHEET = /\A\s*(\S+\s+)*stylesheet(\s+\S+)*\s*\z/i
+    private_constant :TAG, :ATTRIBUTE, :STYLE_BLOCK, :CSS_COMMENT, :CSS_URL, :URL_ATTRIBUTES, :STYLESHEET
+
+    # @yieldparam path [String] a root-relative path the document uses, such as
+    #   `"/assets/app-1a2b.css"`
+    # @yieldreturn [String, nil] the file's contents, or nil if there is none
+    def initialize(&fetch)
+      @fetch = fetch
+    end
+
+    # The files the document refers to.
+    #
+    # @param html [String] the document
+    # @return [Hash{String => String}] each file's contents, by the path the document uses for it,
+    #   without its leading slash
+    def collect(html)
+      @assets = {}
+      @seen = {}
+      html.scan(STYLE_BLOCK) { |(css)| collect_css(css) }
+      html.scan(TAG) { |name, attributes| collect_tag(name.downcase, attributes) }
+      @assets
+    end
+
+    private
+
+    def collect_tag(name, attributes)
+      attributes = attributes.scan(ATTRIBUTE).to_h do |key, value|
+        [key.downcase, CGI.unescapeHTML(value.to_s.delete_prefix('"').delete_prefix("'").chomp('"').chomp("'"))]
+      end
+      URL_ATTRIBUTES.each { |key| add(attributes[key]) if attributes[key] }
+      attributes["srcset"]&.split(",")&.each { |candidate| add(candidate.split.first) }
+      collect_css(attributes["style"]) if attributes["style"]
+      add(attributes["href"], stylesheet: true) if name == "link" && STYLESHEET.match?(attributes["rel"].to_s)
+      add(attributes["href"]) if %w[image use].include?(name) && attributes["href"]
+    end
+
+    def collect_css(css)
+      css.gsub(CSS_COMMENT, "").scan(CSS_URL) do |url, *rest|
+        import = rest[2] || rest[3]
+        add(url || rest[0] || rest[1] || import, stylesheet: !import.nil?)
+      end
+    end
+
+    def add(url, stylesheet: false)
+      path = asset_path(url) or return
+      return if @seen.key?(path)
+
+      @seen[path] = true
+      data = @fetch.call("/#{path}") or return
+      key = decode(path)
+      @assets[key] = data
+      collect_css(data.dup.force_encoding(Encoding::UTF_8).scrub) if stylesheet || key.end_with?(".css")
+    end
+
+    # The URL's path from the document's root, as the renderer resolves it, or nil for remote,
+    # data: and fragment-only URLs and paths that leave the root.
+    def asset_path(url)
+      url = url.to_s.strip.split(/[?#]/, 2).first.to_s
+      return if url.empty? || url.start_with?("//", "\\") || url.match?(/\A[a-z][a-z\d+.-]*:/i)
+
+      segments = url.split("/").reject { |segment| segment.empty? || segment == "." }
+      return if segments.empty? || segments.include?("..")
+
+      segments.join("/")
+    end
+
+    def decode(path)
+      path.b.gsub(/%\h\h/n) { |escape| escape[1..].hex.chr }.force_encoding(Encoding::UTF_8)
+    end
+  end
+end

data/lib/rustyprint/errors.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Rustyprint
+  # A render that failed. Each kind of failure has its own subclass, so rescue
+  # {Rustyprint::Error} for every failure, or a subclass for one kind.
+  class Error < StandardError
+    # @return [Symbol] the kind of failure: `:invalid_options`, `:limit_exceeded`, `:timeout` or
+    #   `:internal`
+    attr_reader :kind
+
+    # @param message [String, nil] what went wrong
+    # @param kind [Symbol] the kind of failure; the subclass's `KIND` by default
+    def initialize(message = nil, kind: self.class::KIND)
+      super(message)
+      @kind = kind
+    end
+  end
+
+  # The options are not valid, such as an unknown option or page size.
+  class InvalidOptionsError < Error
+    # The {Error#kind} of this class's errors.
+    KIND = :invalid_options
+  end
+
+  # The document exceeds one of the limits in the options.
+  class LimitExceededError < Error
+    # The {Error#kind} of this class's errors.
+    KIND = :limit_exceeded
+  end
+
+  # Rendering took longer than the deadline in the options.
+  class TimeoutError < Error
+    # The {Error#kind} of this class's errors.
+    KIND = :timeout
+  end
+
+  # A bug in rustyprint.
+  class InternalError < Error
+    # The {Error#kind} of this class's errors.
+    KIND = :internal
+  end
+end

data/lib/rustyprint/native.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "ffi"
+
+module Rustyprint
+  # The native library's C ABI (crates/rustyprint-ffi/include/rustyprint.h).
+  #
+  # @private
+  module Native
+    extend FFI::Library
+
+    # The library's file name on this platform.
+    def self.file_name
+      case RbConfig::CONFIG["host_os"]
+      when /mswin|mingw|cygwin/ then "rustyprint_ffi.dll"
+      when /darwin/ then "librustyprint_ffi.dylib"
+      else "librustyprint_ffi.so"
+      end
+    end
+
+    # Where the library is: RUSTYPRINT_LIBRARY if set, else the copy in the gem, which a
+    # platform gem ships and `rake compile` builds.
+    def self.path
+      ENV.fetch("RUSTYPRINT_LIBRARY") { File.expand_path("native/#{file_name}", __dir__) }
+    end
+
+    unless File.exist?(path)
+      raise LoadError, "rustyprint's native library is missing at #{path}. Install a platform gem of " \
+                       "rustyprint, run `rake compile` in bindings/ruby, or set RUSTYPRINT_LIBRARY."
+    end
+
+    ffi_lib path
+
+    Status = enum(:status, %i[ok invalid_argument invalid_options limit_exceeded timeout internal])
+
+    attach_function :rp_version, [], :string
+    attach_function :rp_request_new, %i[pointer size_t], :pointer
+    attach_function :rp_request_add_asset, %i[pointer string pointer size_t], :status
+    # Renders release the GVL, so other Ruby threads run meanwhile.
+    attach_function :rp_render, %i[pointer pointer size_t pointer], :status, blocking: true
+    attach_function :rp_result_pdf, %i[pointer pointer], :pointer
+    attach_function :rp_result_warnings_json, %i[pointer pointer], :pointer
+    attach_function :rp_result_error, %i[pointer pointer], :pointer
+    attach_function :rp_result_free, [:pointer], :void
+    attach_function :rp_request_free, [:pointer], :void
+  end
+end

data/lib/rustyprint/pdf_renderer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "rack/mock_request"
+require_relative "asset_collector"
+
+module Rustyprint
+  # Renders a controller's view to PDF, for `render pdf:`.
+  #
+  # @example
+  #   format.pdf do
+  #     render pdf: "invoice #{@invoice.id}", template: "invoices/show", layout: "pdf",
+  #            page_size: "A4", margin: "15mm", disposition: "attachment"
+  #   end
+  #
+  # The view renders as HTML, unless `formats` says otherwise, with the other options a
+  # `render` takes, such as `template`, `layout` and `locals`. The PDF options are those of
+  # {Rustyprint.render}. `pdf` names the file, with `.pdf` added, and `disposition` is "inline"
+  # (the default) or "attachment".
+  #
+  # The stylesheets, images and fonts the HTML refers to by path, such as those
+  # `stylesheet_link_tag` and `image_tag` give, are read from `public/` or else served by the
+  # app's asset pipeline. `assets` adds files of your own, by the path the HTML uses. Each
+  # render is instrumented as "render.rustyprint", with the asset paths and warnings.
+  class PdfRenderer
+    # The options of `render pdf:` that go to {Rustyprint.render}; the others go to the view.
+    PDF_OPTIONS = %i[page_size landscape margin title stylesheet remote limits].freeze
+
+    # @param controller [ActionController::Base] the controller whose view to render
+    def initialize(controller)
+      @controller = controller
+    end
+
+    # Renders the view to PDF and sets the response's content type and disposition.
+    #
+    # @param name [String, Symbol] the file name, with `.pdf` added if it lacks it
+    # @param options [Hash] the options of `render pdf:`
+    # @return [String] the PDF, for the response's body
+    def render(name, options)
+      view = options.except(:pdf, :assets, :disposition, *PDF_OPTIONS)
+      view[:formats] ||= [:html]
+      html = @controller.render_to_string(view)
+
+      payload = { name: name.to_s }
+      output = ActiveSupport::Notifications.instrument("render.rustyprint", payload) do
+        assets = collect(html).merge(options.fetch(:assets, {}).transform_keys(&:to_s))
+        payload[:assets] = assets.keys
+        Rustyprint.render(html, assets: assets, **options.slice(*PDF_OPTIONS)).tap do |rendered|
+          payload[:warnings] = rendered.warnings
+        end
+      end
+      output.warnings.each { |warning| @controller.logger&.warn("rustyprint: #{warning}") }
+
+      @controller.response.charset = false
+      @controller.content_type = Mime[:pdf]
+      @controller.headers["Content-Disposition"] = ActionDispatch::Http::ContentDisposition.format(
+        disposition: options.fetch(:disposition, "inline").to_s, filename: file_name(name)
+      )
+      output.pdf
+    end
+
+    private
+
+    def file_name(name)
+      name = name.to_s
+      name.end_with?(".pdf") ? name : "#{name}.pdf"
+    end
+
+    def collect(html)
+      AssetCollector.new { |path| public_file(path) || pipeline_file(path) }.collect(html)
+    end
+
+    # A file under public/, such as a precompiled asset.
+    def public_file(path)
+      file = ::Rails.public_path.join(path.delete_prefix("/"))
+      File.binread(file) if file.file?
+    end
+
+    # A file the app's asset pipeline serves, as Propshaft and Sprockets do in development.
+    def pipeline_file(path)
+      config = ::Rails.application.config
+      prefix = config.respond_to?(:assets) ? config.assets.prefix : "/assets"
+      return unless path.start_with?("#{prefix}/")
+
+      request = @controller.request
+      # The request's host, so the app's host authorization allows it as it did the request.
+      env = Rack::MockRequest.env_for("#{request.protocol}#{request.host_with_port}#{path}",
+                                      "HTTP_HOST" => request.host_with_port)
+      status, _headers, body = ::Rails.application.call(env)
+      return unless status == 200
+
+      data = +""
+      body.each { |chunk| data << chunk }
+      data
+    ensure
+      body.close if body.respond_to?(:close)
+    end
+  end
+end

data/lib/rustyprint/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "pdf_renderer"
+
+module Rustyprint
+  # Adds `render pdf:` to Rails controllers. Loaded when the gem is required after Rails.
+  class Railtie < ::Rails::Railtie
+    initializer "rustyprint.renderer" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Renderers.add(:pdf) do |name, options|
+          Rustyprint::PdfRenderer.new(self).render(name, options)
+        end
+      end
+    end
+  end
+end

data/lib/rustyprint/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Rustyprint
+  # The workspace version in Cargo.toml, which every rustyprint package shares.
+  VERSION = "1.0.1"
+end

data/lib/rustyprint.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rustyprint/version"
+require_relative "rustyprint/errors"
+require_relative "rustyprint/native"
+require_relative "rustyprint/railtie" if defined?(Rails::Railtie)
+
+# Renders HTML and CSS to PDF.
+#
+# @example
+#   output = Rustyprint.render(html, page_size: "A4", margin: "15mm",
+#                                    assets: { "logo.png" => File.binread("logo.png") })
+#   File.binwrite("invoice.pdf", output.pdf)
+module Rustyprint
+  # A rendered document, as {Rustyprint.render} returns it.
+  #
+  # @!attribute [r] pdf
+  #   @return [String] the PDF, a binary String
+  # @!attribute [r] warnings
+  #   @return [Array<String>] problems found in the document's CSS and assets, such as
+  #     ``"invoice.css:12: unsupported property `colr`"``
+  Output = Data.define(:pdf, :warnings)
+
+  ERRORS = {
+    invalid_options: InvalidOptionsError,
+    limit_exceeded: LimitExceededError,
+    timeout: TimeoutError
+  }.freeze
+  private_constant :ERRORS
+
+  class << self
+    # Renders an HTML document to PDF.
+    #
+    # The options are those of
+    # [render-options.schema.json](https://github.com/vryan95/rustyprint/blob/master/schema/render-options.schema.json),
+    # as keywords. An option left out keeps its default. Nothing is read but the assets, and
+    # nothing is fetched from the network unless `remote` allows the host. Rendering releases the
+    # GVL, so other threads run meanwhile, and renders on several threads run at once.
+    #
+    # @example A4 with a logo and a stylesheet
+    #   output = Rustyprint.render(html, page_size: "A4", margin: "15mm", title: "Invoice 42",
+    #                                    assets: { "logo.png" => File.binread("logo.png"),
+    #                                              "invoice.css" => Pathname("app/pdf/invoice.css") })
+    #   File.binwrite("invoice.pdf", output.pdf)
+    #
+    # @param html [String] the document, in any encoding Ruby can convert to UTF-8
+    # @param assets [Hash{String => String, Pathname, IO}] the files the document refers to by
+    #   relative or root-relative URL, by the path it uses without a leading slash (`/css/app.css`
+    #   is `"css/app.css"`): their contents as a String, a Pathname to read, or an IO to read
+    # @param options [Hash] the render options
+    # @option options [String, Hash] :page_size `"A4"` (the default), `"Letter"` or another named
+    #   size, or `{ width: "100mm", height: "150mm" }`
+    # @option options [Boolean] :landscape turns the page so that it is wider than it is tall;
+    #   `false` by default
+    # @option options [String] :margin the page margins, as CSS: `"15mm"` or `"10mm 20mm"`;
+    #   `"2cm"` by default
+    # @option options [String] :title the PDF's title; the document's `<title>` by default
+    # @option options [String] :stylesheet CSS applied after the document's own
+    # @option options [Hash] :remote the hosts to fetch from, such as
+    #   `{ allowed_hosts: ["cdn.example.com"] }`; nothing is fetched by default
+    # @option options [Hash] :limits bounds on the render, such as
+    #   `{ max_pages: 50, timeout_ms: 10_000 }`; by default 20 MB of HTML, 500,000 nodes, 2,000
+    #   pages and 60 seconds. Exceeding one fails the render, except that larger images are
+    #   skipped with a warning
+    # @return [Output] the PDF and the warnings
+    # @raise [ArgumentError] if the HTML or an asset path is not valid in its encoding, or an asset
+    #   path is not valid
+    # @raise [InvalidOptionsError] if an option is unknown or has an invalid value
+    # @raise [LimitExceededError] if the document exceeds a limit
+    # @raise [TimeoutError] if rendering takes longer than the deadline
+    # @raise [InternalError] if rustyprint has a bug
+    def render(html, assets: {}, **options)
+      html = utf8(html, "html")
+      with_request(options) do |request|
+        assets.each { |path, data| add_asset(request, path, data) }
+        render_request(request, html)
+      end
+    end
+
+    # The native library's version.
+    #
+    # @return [String] the version, the same as {VERSION}
+    def native_version
+      Native.rp_version
+    end
+
+    private
+
+    def utf8(text, what)
+      text = String(text)
+      raise ArgumentError, "#{what} is not valid #{text.encoding}" unless text.valid_encoding?
+
+      text = text.encode(Encoding::UTF_8)
+      raise ArgumentError, "#{what} is not valid UTF-8" unless text.valid_encoding?
+
+      text
+    end
+
+    def bytes(text)
+      pointer = FFI::MemoryPointer.new(:char, [text.bytesize, 1].max)
+      pointer.put_bytes(0, text)
+      pointer
+    end
+
+    def with_request(options)
+      json = JSON.generate(options)
+      request = Native.rp_request_new(bytes(json), json.bytesize)
+      raise InternalError, "the native library could not make a request" if request.null?
+
+      begin
+        yield request
+      ensure
+        Native.rp_request_free(request)
+      end
+    end
+
+    def add_asset(request, path, data)
+      path = utf8(path.to_s, "asset path")
+      data = if data.respond_to?(:to_path) then File.binread(data.to_path)
+             elsif data.respond_to?(:read) then data.read
+             else String(data)
+             end.b
+      status = Native.rp_request_add_asset(request, path, bytes(data), data.bytesize)
+      raise ArgumentError, "invalid asset path #{path.inspect}" unless status == :ok
+    end
+
+    def render_request(request, html)
+      out = FFI::MemoryPointer.new(:pointer)
+      status = Native.rp_render(request, bytes(html), html.bytesize, out)
+      result = out.read_pointer
+      raise InternalError, "the native library could not make a result" if result.null?
+
+      begin
+        raise error(status, result) unless status == :ok
+
+        Output.new(pdf: pdf(result), warnings: JSON.parse(string(result, :rp_result_warnings_json)).freeze)
+      ensure
+        Native.rp_result_free(result)
+      end
+    end
+
+    def pdf(result)
+      len = FFI::MemoryPointer.new(:size_t)
+      pointer = Native.rp_result_pdf(result, len)
+      pointer.read_bytes(len.read(:size_t)).force_encoding(Encoding::BINARY)
+    end
+
+    def string(result, function)
+      len = FFI::MemoryPointer.new(:size_t)
+      pointer = Native.public_send(function, result, len)
+      pointer.null? ? nil : pointer.read_bytes(len.read(:size_t)).force_encoding(Encoding::UTF_8)
+    end
+
+    def error(status, result)
+      message = string(result, :rp_result_error)
+      ERRORS.fetch(status) { InternalError }.new(message)
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rustyprint
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: x86_64-linux-musl
+authors:
+- Ryan Verschuren
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 'rustyprint renders HTML and CSS to PDF with a layout engine of its own,
+  written in Rust: no browser, no external runtime and no network access unless allowed.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- LICENSE-APACHE
+- LICENSE-MIT
+- OFL.txt
+- README.md
+- lib/rustyprint.rb
+- lib/rustyprint/asset_collector.rb
+- lib/rustyprint/errors.rb
+- lib/rustyprint/native.rb
+- lib/rustyprint/native/librustyprint_ffi.so
+- lib/rustyprint/pdf_renderer.rb
+- lib/rustyprint/railtie.rb
+- lib/rustyprint/version.rb
+homepage: https://github.com/vryan95/rustyprint
+licenses:
+- MIT
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/vryan95/rustyprint/tree/master/bindings/ruby
+  documentation_uri: https://rubydoc.info/gems/rustyprint
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Render HTML and CSS to PDF
+test_files: []