rails-pdf-renderer 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c649a492ecbdff7b6e611300aaf1fa1fe742327e36335fa4d61f37dca76b9dfb
-  data.tar.gz: 36552f2510d272ae0e01aa795b6f368a59f11f52fa21733113e5d9411957ef42
+  metadata.gz: f0faa43dcdd14e5f3c7455270aaca26f5f0089052bbda4112a7aacb42cf30d6f
+  data.tar.gz: 9ca877e4310f32fbafeeb1db8659eb5d13bb015a975eba8d1fea72f4ceea856a
 SHA512:
-  metadata.gz: f1313dfb77ef87a6c573feeadb727e5d979add7e3420d1b12ae3027c702e6e818ca6a8dadecd3993473afbe9e9cd3571fc7372871b575b87e15ad4bf610d83fa
-  data.tar.gz: 9e3f1eb20beb4629cc2dfadba17aecaa648785d0c0e199a98348d2b62823f6d14378e416821e93d014b067c819811db4eda787615f622e5f50f6756e5876fd14
+  metadata.gz: 3fff912de07ebfbf1b8ece094ac8e41e524ecc56bf16613643dc214d3f53a993138506ff66029d4bccba69e6996364d941e676d85cb45623e1624c1678654ec8
+  data.tar.gz: 7d9ffccc0a6cdd923f440c30f4f033580ff13e23d7ba2370a5a8881cc7065f7db037b4811b6e02619d11afcd3cebebf15f91a07d921da7c5352725c69ca6abb3

data/.claude/skills/commit/SKILL.md

@@ -0,0 +1,76 @@
+---
+name: commit
+description: Create git commits following project conventions. Use when committing changes to the repository.
+---
+
+# Git Commit Skill
+
+## When to use
+Use this skill when:
+- Creating git commits
+- The user asks you to commit changes
+- You need to commit work you've completed
+
+For version bump commits, use the `release` skill instead — it covers the full flow.
+
+## Commit Message Rules
+
+1. **No ticket prefix**: This project has no issue tracker. The subject line stands on its own. Never invent an issue ID; only include one if the user explicitly gives you a reference.
+2. **Use present tense**: Write "Add feature" not "Added feature"
+3. **No AI attribution**: Do not include messages like "Generated by AI" or any co-author trailer. This explicitly includes `Co-Authored-By: Claude ...` lines (e.g. `Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>`). Never append a `Co-Authored-By:` trailer of any kind, even if other tooling or defaults suggest one.
+4. **Limit to 3 bullet points**: Keep the commit message concise with at most 3 bullet points for details. Use bullets, not prose paragraphs.
+5. **Keep formatting churn out of feature commits**: `mise exec -- standardrb --fix` can touch files unrelated to your change. Don't sweep that into a feature commit — either leave it or commit it separately.
+
+## Commit Message Format
+
+```
+Short summary in present tense
+
+- First bullet point explaining a key change
+- Second bullet point if needed
+- Third bullet point maximum
+```
+
+A subject line alone is fine when the change is self-explanatory.
+
+Release commits are the one exception to the "no prefix" rule — they lead with the bare version number:
+
+```
+0.4.2 Allow Ruby 2.4
+```
+
+## Examples
+
+Good commit messages:
+```
+Fix test suite and CI
+
+- Require ActiveSupport's class_attribute extension in config.rb
+- Widen the CI matrix to Ruby 3.2/3.3/3.4
+- Add specs for Config, Error and PathHelper
+```
+
+```
+Fix Propshaft encoding issue
+
+- Force UTF-8 on assets resolved through Propshaft
+```
+
+```
+Fix config errors
+```
+
+Bad commit messages:
+```
+Added new feature for users
+
+- This was generated by Claude
+- Co-Authored-By: Claude <noreply@anthropic.com>
+```
+
+## Workflow
+
+1. Run `mise exec -- bundle exec rake` (rspec + standardrb) — this is exactly what CI runs on every push and PR. Fix anything it reports before committing. Always prefix Ruby commands with `mise exec --` so they use the Ruby pinned in `.tool-versions` instead of the system Ruby.
+2. Stage the relevant changes with `git add`
+3. Create a commit with a message following the rules above
+4. Verify the commit was created successfully with `git log -1`

data/.claude/skills/create-pr/SKILL.md

@@ -0,0 +1,170 @@
+---
+name: create-pr
+description: Create a GitHub pull request with a well-structured description. Use when creating a PR or when the user asks to open a pull request.
+---
+
+# Create PR Skill
+
+## When to use
+Use this skill when:
+- Creating a GitHub pull request
+- The user asks you to open or create a PR
+
+## Workflow
+
+1. **Gather context**: Run `git log main..HEAD --oneline` and `git diff main...HEAD --stat` to understand all changes
+2. **Read changed files** if needed to understand the intent behind the changes
+3. **Write the PR description** following the format below
+4. **Create the PR** using `gh pr create --base main`
+
+PRs target `main` unless the user says otherwise (stacked PRs onto another feature branch happen, but are the exception). Branches are lowercase kebab-case with no namespace prefix — `fix-tests-and-ci`, `allow-ruby-2-4`.
+
+## PR Title Format
+
+```
+Short summary in present tense
+```
+
+No ticket prefix and no conventional-commit prefix. In practice the title matches the branch's commit subject. Keep it under 70 characters.
+
+## PR Description Format
+
+```markdown
+## Summary
+
+Brief description of what this PR does and why. Focus on the intent and approach,
+not a mechanical list of file changes. 2-5 sentences.
+
+## Verification
+
+- [ ] `mise exec -- bundle exec rake` passes (rspec + standardrb)
+- [ ] Any extra checks specific to this change
+```
+
+`mise exec -- bundle exec rake` is the project's gate — CI runs it on Ruby 3.3, 3.4 and 4.0. Run Ruby commands through `mise exec --` so they use the Ruby pinned in `.tool-versions` rather than the system Ruby. If you ran it against more than one Ruby version, or deleted `Gemfile.lock` to simulate a clean checkout, say so.
+
+Only claim a check you actually ran.
+
+## Bug fix PRs
+
+For bug fixes, frame the description around behavior, not code. A reviewer wants to know
+what triggered the bug, what we expected, and what actually happened — not what was wrong with
+the old code. Use this format:
+
+```markdown
+## Summary
+
+One or two sentences describing the problem and the fix.
+
+**Steps to reproduce**
+1. ...
+2. ...
+
+**Expected:** what should happen
+**Actual:** what happened instead (the bug)
+
+## Verification
+
+- [ ] ...
+```
+
+Rules for the reproduction steps:
+
+- **Minimal**: include only the steps needed to trigger the bug. Eliminate as many
+  factors as possible so the cause is isolated.
+- **Reproducible from a clean checkout**: this is a gem, so the repro is code-level — a
+  short snippet, a specific config, a Ruby or Rails version, an asset pipeline setup.
+  Name the versions involved when they matter.
+- **Start from a known state**: e.g. "in a fresh Rails 8.1 app with Propshaft" rather
+  than assuming the reader's local setup.
+
+Keep the `## Verification` section in addition — it confirms the fix works, while the
+reproduction steps document the bug.
+
+## Rules
+
+1. **No AI attribution**: Do not include "Generated by Claude Code", co-author lines, or similar
+2. **Summary should explain why, not just what**: Describe the problem being solved and the approach taken
+3. **Describe behavior, not code internals**: For bug fixes, give what triggered the bug, what we expected, and what actually happened. Do not explain in detail what was wrong with the old code or what it was before — that's irrelevant to a reviewer
+4. **Verification is what you actually ran**: Name the commands and their results. Don't list checks you skipped
+5. **Skip the verification section** if there is nothing meaningful to report (e.g. doc-only changes)
+6. **Use present tense**: Write "Add feature" not "Added feature"
+7. **Keep it concise**: The description should be helpful, not exhaustive
+
+## Examples
+
+Good PR description:
+```markdown
+## Summary
+
+The suite never got past loading, both locally and on CI: `config.rb` calls `class_attribute`
+but nothing required ActiveSupport's core extension, so requiring `rails/pdf/renderer`
+standalone (as `spec_helper` does) raised `NoMethodError`. Adding that one require is the
+actual fix. The default `rake` task also chains `standard`, which was reporting 75 offenses
+and aborting the task, so this applies `standard:fix` across the lib and gemspec. CI moves to
+`actions/checkout@v4` and widens the matrix from a single `3.2.2` pin to Ruby 3.2/3.3/3.4.
+
+## Verification
+
+- [ ] `mise exec -- bundle exec rake` passes on Ruby 4.0.6 — 19 examples, 0 failures
+- [ ] Passes from scratch with `Gemfile.lock` deleted, simulating a clean CI checkout
+```
+
+Good bug-fix PR description (reproduce / expected / actual):
+```markdown
+## Summary
+
+Rendering a PDF in a Rails app on Propshaft raised an encoding error when a stylesheet
+contained non-ASCII characters. Assets resolved through Propshaft are now forced to UTF-8.
+
+**Steps to reproduce**
+1. In a Rails 7.1 app using Propshaft, add a stylesheet containing a non-ASCII character
+2. Render any PDF that includes that stylesheet
+
+**Expected:** the PDF renders with the stylesheet applied
+**Actual:** `Encoding::CompatibilityError` is raised during rendering
+
+## Verification
+
+- [ ] `mise exec -- bundle exec rake` passes
+- [ ] Rendering a PDF with a non-ASCII stylesheet succeeds in a Propshaft app
+```
+
+Good PR description (no verification section needed):
+```markdown
+## Summary
+
+Point the gemspec's homepage, source_code_uri and changelog_uri at `gembero/rails-pdf-renderer`.
+They were pointing at a bare `github.com/erikaxel/` URL from before the repo moved to the org.
+```
+
+Bad PR description:
+```markdown
+## Summary
+
+Updated files to fix the bug.
+
+## Verification
+
+- [ ] Run the tests
+- [ ] Check CI passes
+
+🤖 Generated with Claude Code
+```
+
+## Creating the PR
+
+Use `gh pr create` with a HEREDOC for the body:
+
+```bash
+gh pr create --base main --title "Title here" --body "$(cat <<'EOF'
+## Summary
+
+...
+
+## Verification
+
+- [ ] ...
+EOF
+)"
+```

data/.claude/skills/release/SKILL.md

@@ -0,0 +1,77 @@
+---
+name: release
+description: Cut a new version of the rails-pdf-renderer gem — bump the version, update the changelog, and publish to rubygems.org. Use when releasing a new version or bumping the gem version.
+---
+
+# Release Skill
+
+## When to use
+Use this skill when:
+- The user asks to cut, ship, or publish a release
+- The user asks to bump the gem version
+
+## Before you start
+
+Check that the last release actually shipped:
+
+```bash
+git tag                                   # tags are v-prefixed: v0.4.1
+cat lib/rails/pdf/renderer/version.rb     # VERSION = "0.4.2"
+```
+
+If `version.rb` is ahead of the newest tag, a previous version was committed but never
+released. Ask the user whether to release that version as-is or to bump past it — don't
+silently skip it.
+
+Also confirm you're releasing from `main` and that it's up to date with `origin/main`.
+
+## Steps
+
+1. **Bump the version** in `lib/rails/pdf/renderer/version.rb`. The gemspec reads
+   `RailsPdfRenderer::VERSION` from this file — it's the single source of truth. Follow
+   semver: patch for fixes, minor for backwards-compatible features, major for breaking
+   changes.
+
+2. **Add a `CHANGELOG.md` entry.** This step is not optional — the changelog was skipped
+   for the entire 0.4.x line and is stale as a result. Match the existing format:
+
+   ```markdown
+   ## [0.5.0]
+   ### New Features
+   - Description of the feature
+
+   ### Fixes
+   - Description of the fix
+   ```
+
+   Newest version goes at the top, directly under the header block. Use `### New Features`
+   and `### Fixes` sections with dash bullets; include only the sections that apply.
+
+3. **Run the gate**: `mise exec -- bundle exec rake` (rspec + standardrb). It must be green
+   before you release. CI runs this on Ruby 3.3, 3.4 and 4.0.
+
+4. **Commit** the version bump and changelog together, with the version as the subject
+   prefix (see the `commit` skill for the general rules — no AI attribution, present tense):
+
+   ```
+   0.5.0 Add support for custom page sizes
+   ```
+
+   A bare version subject (`0.4.0`) is acceptable when the release has no single headline
+   change, but a short description is better.
+
+5. **Publish**: `mise exec -- bundle exec rake release`. This comes from `bundler/gem_tasks` and will:
+   - create the `v0.5.0` git tag
+   - push the commit and tag to `origin`
+   - build the gem and push it to rubygems.org
+
+   It needs rubygems credentials and it is not reversible — a published version cannot be
+   replaced, only yanked. Confirm with the user before running it.
+
+## Notes
+
+- The local Ruby version is pinned in `.tool-versions`. Run every Ruby command through
+  `mise exec --` so it doesn't fall back to the system Ruby.
+- `Gemfile.lock` is gitignored, so there's no lockfile to update.
+- `mise exec -- bundle exec rake build` produces the gem locally under `pkg/` without
+  publishing — useful for a dry run.

data/.tool-versions

@@ -0,0 +1 @@
+ruby 4.0.6

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.5.0]
+### New Features
+- Added the `html:` option for already-rendered HTML. The string is sent to the PDF
+  service verbatim and is never compiled as a template, so `<%= %>` in the content
+  cannot execute as Ruby on the server. `layout:`, `locals:`, `assigns:`, `formats:`
+  and `handlers:` do not apply to `html:`, and passing both `html:` and `inline:`
+  raises `ArgumentError`.
+- `type:` is now forwarded to ActionView when rendering `inline:` templates, so a
+  non-ERB handler can be used (for example `type: :raw` or `type: :haml`).
+- Documented `inline:` (an ERB template) versus `html:` (finished HTML) in the README.
+
+### Fixes
+- Declare `activesupport` (>= 7.0) as a runtime dependency. It is required at
+  load time by `RailsPdfRenderer::Config`, but was previously only pulled in
+  through the host application.
+- `status:` is now forwarded to the response for both PDF and `show_as_html:` renders.
+  It was previously accepted and silently ignored, so those responses always returned 200.
+- `RailsPdfRenderer::ActionControllerHelper` now requires the standard library and
+  ActiveSupport extensions it uses instead of relying on the host application.
+
+### Breaking changes
+- Dropped support for end-of-life Ruby versions. `required_ruby_version` is now
+  `>= 3.3.0`. Only Ruby versions still supported by the Ruby core team are
+  supported (currently 3.3, 3.4 and 4.0).
+
 ## [0.3.0]
 ### Fixes
 Fix Propshaft encoding issue

data/CLAUDE.md

@@ -0,0 +1,91 @@
+# CLAUDE.md
+
+Guidance for Claude Code working in this repository.
+
+## What this gem is
+
+`rails-pdf-renderer` is a Rails gem that renders a controller view to HTML and then
+POSTs that HTML to an **external PDF rendering service** (a headless-Chrome-style
+server), which returns the PDF bytes. It does *not* shell out to a local binary.
+This is the main architectural difference from [wicked_pdf](https://github.com/mileszs/wicked_pdf/),
+from which much of the asset-handling code was adapted.
+
+Usage in an app looks like `render pdf: "filename", template: "..."` — the gem
+intercepts `render`/`render_to_string` when the options hash contains a `:pdf` key.
+
+## Ruby toolchain
+
+The local Ruby version is managed by [mise](https://mise.jdx.dev) and pinned in `.tool-versions`
+(Ruby 4.0). The gem itself supports Ruby 3.3+; CI covers 3.3, 3.4 and 4.0.
+
+**Always run Ruby commands through `mise exec --`** so they use the pinned Ruby instead of
+the system Ruby. If `mise install` hasn't been run in a fresh checkout, run it first.
+
+## Commands
+
+```bash
+mise exec -- bin/setup                    # bundle install
+mise exec -- bundle exec rake             # default task: rspec + standardrb (what CI runs)
+mise exec -- bundle exec rake spec        # tests only
+mise exec -- bundle exec rspec            # tests only
+mise exec -- standardrb                   # lint only; add --fix to autocorrect
+mise exec -- bin/console                  # IRB with the gem loaded
+```
+
+CI (`.github/workflows/main.yml`) runs `bundle exec rake` against Ruby 3.3, 3.4 and 4.0,
+matching the gemspec's `required_ruby_version >= 3.3.0`.
+
+## Code layout
+
+All code lives under `lib/rails/pdf/renderer/`, namespaced under the top-level
+**class** `RailsPdfRenderer` (a class, not a module — `class RailsPdfRenderer` is
+required when reopening it).
+
+- `railtie.rb` — wiring. Prepends `ActionControllerHelper` onto `ActionController::Base`
+  and includes `ActionViewHelper` into views via `ActiveSupport.on_load`. Also
+  registers the `application/pdf` MIME type. Everything is guarded by
+  `if defined?(Rails.env)` so the gem can be required outside Rails.
+- `action_controller_helper.rb` — the `render`/`render_to_string` overrides,
+  `make_pdf`, and `pdf_from_server` (the HTTP call to the PDF service).
+- `action_view_helper.rb` — the bulk of the code: `pdf_asset_path`,
+  `pdf_stylesheet_link_tag`, `pdf_image_tag`, `pdf_*_base64`, etc. These inline
+  assets into the HTML so the remote renderer can resolve them. Supports Sprockets,
+  Propshaft, and Webpacker/Shakapacker; each has its own branch in `find_asset`
+  and `webpacker_source_url`. Touching one branch usually means checking the others.
+- `config.rb` — configuration, built on `class_attribute`.
+- `error.rb` — `RailsPdfRenderer::Error`, wraps the failed `Net::HTTP` response.
+- `path_helper.rb`, `version.rb`.
+
+## Things that will bite you
+
+- **Config is global class state.** `Config` uses `class_attribute`, and
+  `RailsPdfRenderer.configuration` memoizes a single instance, so assigning a
+  value mutates the class default for the whole process. Tests that change
+  configuration must restore it.
+- **`pdf_server_params` unconditionally reads `options[:margin][:top]`** and the
+  other margin keys. The default `margin` hash comes from `Config.default_options`,
+  which is merged in by `render`. Any code path that builds options without that
+  merge will `NoMethodError` on `nil`.
+- **`auth_key` is base64-encoded before being sent** as `Authorization: Bearer <base64>`.
+  A missing `auth_key` raises a plain `RuntimeError`, not `RailsPdfRenderer::Error`.
+- The controller helper's `make_pdf` calls `render_to_string` recursively — the
+  override checks for the `:pdf` key to avoid infinite recursion, so never leave
+  `:pdf` in the options hash passed downward (`make_pdf` deletes it explicitly).
+- Assets read from disk or over HTTP are `force_encoding('UTF-8')`'d — this was a
+  deliberate fix for Propshaft (see CHANGELOG 0.3.0), don't remove it.
+- `raise_on_missing_assets` defaults to `true`, so a missing stylesheet or image
+  raises rather than silently rendering a blank PDF.
+
+## Style
+
+`standard` (standardrb) is the linter and part of the default rake task, but
+existing code in `action_controller_helper.rb` and `action_view_helper.rb` uses
+hashrocket syntax and single quotes inherited from wicked_pdf. Match the
+surrounding file rather than reformatting; run `standardrb` before committing and
+keep unrelated formatting churn out of diffs.
+
+## Releasing
+
+1. Bump `VERSION` in `lib/rails/pdf/renderer/version.rb`.
+2. Add an entry to `CHANGELOG.md`.
+3. `mise exec -- bundle exec rake release` (tags, pushes, publishes to rubygems.org).

data/README.md

@@ -1,5 +1,14 @@
 # RailsPdfRenderer
 
+## Ruby support
+
+This gem only supports Ruby versions that are still supported by the Ruby core
+team. When a Ruby version reaches end-of-life it is dropped from the CI matrix
+and `required_ruby_version` is raised in the next release, which may happen in a
+minor version bump.
+
+The currently supported versions are Ruby 3.3, 3.4 and 4.0.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -8,17 +17,100 @@ Install the gem and add to the application's Gemfile by executing:
 
 ## Usage
 
+Render the current controller action as a PDF:
+
+```ruby
+class InvoicesController < ApplicationController
+  def show
+    render pdf: "invoice-#{@invoice.number}"
+  end
+end
+```
+
+Or get the PDF back as a string:
+
+```ruby
+pdf = ApplicationController.renderer.render_to_string(pdf: true, template: "invoices/show")
+```
+
+### `inline:` vs `html:`
+
+These two options look similar and are **not** interchangeable:
+
+| Option    | Content                           | Processed by                               |
+| --------- | --------------------------------- | ------------------------------------------ |
+| `inline:` | An **ERB template** source string | ActionView - `<%= %>` is evaluated as Ruby |
+| `html:`   | **Finished HTML**                 | Nothing - sent to the PDF service verbatim |
+
+Use `html:` whenever the HTML has already been rendered - ViewComponent output, a
+`render_to_string` from elsewhere, a stored email body, or any content influenced by user
+input:
+
+```ruby
+html = InvoiceComponent.new(invoice: @invoice).render_in(view_context)
+ApplicationController.renderer.render_to_string(pdf: true, html: html)
+```
 
+> **Security:** passing already-rendered HTML to `inline:` makes ActionView compile it as an
+> ERB template, so any `<%= ... %>` in the content executes as Ruby on your server. Always use
+> `html:` for content you did not author as a template.
+
+`html:` is sent as-is, so `layout:`, `locals:`, `assigns:`, `formats:` and `handlers:` are
+ignored, and passing both `html:` and `inline:` raises `ArgumentError`.
+
+If you need a non-ERB *template* language for `inline:`, pass `type:` - it is forwarded to
+ActionView's handler lookup, e.g. `type: :raw` or `type: :haml`.
+
+### Options
+
+| Option | Description |
+| ------ | ----------- |
+| `pdf:` | Filename without the `.pdf` extension, when using `render` |
+| `html:` | Finished HTML, sent to the PDF service verbatim |
+| `inline:` | ERB template source |
+| `template:`, `layout:`, `locals:`, `assigns:`, `formats:`, `handlers:`, `file:`, `type:` | Standard ActionView rendering options |
+| `show_as_html:` | Render the HTML in the browser instead of a PDF, for debugging |
+| `status:` | HTTP status for the response |
+| `disposition:` | `"inline"` (default) or `"attachment"` |
+| `save_to_file:` | Also write the PDF to this path |
+| `save_only:` | Write the PDF to `save_to_file:` without sending a response |
+| `orientation:`, `pageSize:`, `zoom:`, `height:`, `width:`, `margin:`, `footerTemplate:` | Forwarded to the PDF service |
+
+### Configuration
+
+```ruby
+RailsPdfRenderer.configure do |config|
+  config.url = "https://your-pdf-service.example.com/render"
+  config.auth_key = Rails.application.credentials.pdf_service_key
+  config.default_options = {margin: {top: "10mm", bottom: "10mm", left: "0mm", right: "0mm"}}
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The local Ruby version is managed with [mise](https://mise.jdx.dev) and pinned in
+`.tool-versions`. Install it once with `mise install`, and run every command through mise so it
+uses the pinned Ruby rather than the system one:
+
+    $ mise install
+    $ mise exec -- bin/setup
+
+If you have mise activated in your shell (`mise activate`), the `mise exec --` prefix is
+unnecessary — the pinned Ruby is already on your `PATH`. The examples below spell it out so
+they work either way.
+
+Run the tests with `mise exec -- rake spec`, or `mise exec -- bundle exec rake` for the full
+gate (rspec + standardrb) that CI runs. You can also run `mise exec -- bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `mise exec -- bundle exec rake install`.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Development happens on Ruby 4.0 even though the gem supports 3.3 and up; CI is what covers
+the rest of the matrix.
 
 ## Releasing new gems
 1. Update version.rb
-2. Run `rake release` to release a new gem
+2. Run `mise exec -- bundle exec rake release` to release a new gem
 
 ## Contributing
 

data/lib/rails/pdf/renderer/action_controller_helper.rb

@@ -1,11 +1,11 @@
+require "base64"
+require "json"
+require "net/http"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/string/output_safety"
+
 class RailsPdfRenderer
   module ActionControllerHelper
-    def self.prepended(base)
-      # Protect from trying to augment modules that appear
-      # as the result of adding other gems.
-      return if base != ActionController::Base
-    end
-
     def render(*args)
       options = args.first
       if options.is_a?(Hash) && options.key?(:pdf)
@@ -29,44 +29,62 @@ class RailsPdfRenderer
     def make_pdf(options = {})
       options.delete :pdf # We dont use the filename when rendering to string
 
-      render_opts = {
-        :template => options[:template],
-        :layout => options[:layout],
-        :formats => options[:formats],
-        :handlers => options[:handlers],
-        :assigns => options[:assigns]
-      }
-      render_opts[:inline] = options[:inline] if options[:inline]
-      render_opts[:locals] = options[:locals] if options[:locals]
-      render_opts[:file] = options[:file] if options[:file]
-      html_string = render_to_string(render_opts)
-      pdf_from_server(html_string, options)
+      return pdf_from_server(raw_html(options), options) if options.key?(:html)
+
+      pdf_from_server(render_to_string(view_render_options(options)), options)
     end
 
     def make_and_send_pdf(pdf_name, options = {})
       options[:layout] ||= false
       options[:template] ||= File.join(controller_path, action_name)
-      options[:disposition] ||= 'inline'
+      options[:disposition] ||= "inline"
       if options[:show_as_html]
-        render_opts = {
-          :template => options[:template],
-          :layout => options[:layout],
-          :formats => options[:formats],
-          :handlers => options[:handlers],
-          :assigns => options[:assigns],
-          :content_type => 'text/html'
-        }
-        render_opts[:inline] = options[:inline] if options[:inline]
-        render_opts[:locals] = options[:locals] if options[:locals]
-        render_opts[:file] = options[:file] if options[:file]
+        render_opts = if options.key?(:html)
+          {html: raw_html(options).html_safe, layout: false, content_type: "text/html"}
+        else
+          view_render_options(options).merge(content_type: "text/html")
+        end
+        render_opts[:status] = options[:status] if options[:status]
         render(render_opts)
       else
         pdf_content = make_pdf(options)
-        File.open(options[:save_to_file], 'wb') { |file| file << pdf_content } if options[:save_to_file]
-        send_data(pdf_content, :filename => pdf_name + '.pdf', :type => 'application/pdf', :disposition => options[:disposition]) unless options[:save_only]
+        File.open(options[:save_to_file], "wb") { |file| file << pdf_content } if options[:save_to_file]
+        unless options[:save_only]
+          send_opts = {filename: pdf_name + ".pdf", type: "application/pdf", disposition: options[:disposition]}
+          send_opts[:status] = options[:status] if options[:status]
+          send_data(pdf_content, send_opts)
+        end
       end
     end
 
+    # Already-rendered HTML supplied by the caller through the :html option. Unlike
+    # :inline it is never compiled as a template, so `<%= %>` in the content cannot
+    # execute as Ruby on the server.
+    def raw_html(options)
+      if options.key?(:inline)
+        raise ArgumentError, "rails-pdf-renderer: :html and :inline are mutually exclusive. " \
+          ":html is finished HTML, :inline is an ERB template."
+      end
+      options[:html].to_s
+    end
+
+    # Options for rendering through ActionView. Everything here goes through a template
+    # handler - :inline defaults to ERB unless :type says otherwise.
+    def view_render_options(options)
+      render_opts = {
+        template: options[:template],
+        layout: options[:layout],
+        formats: options[:formats],
+        handlers: options[:handlers],
+        assigns: options[:assigns]
+      }
+      render_opts[:inline] = options[:inline] if options[:inline]
+      render_opts[:locals] = options[:locals] if options[:locals]
+      render_opts[:file] = options[:file] if options[:file]
+      render_opts[:type] = options[:type] if options[:type]
+      render_opts
+    end
+
     def pdf_from_server(html, options)
       payload = pdf_server_params(html, options)
 
@@ -77,10 +95,10 @@ class RailsPdfRenderer
       raise "auth_key is not set, you need to set it for rails-pdf-renderer to work" if auth_key.blank?
 
       uri = URI(url)
-      headers = { 'Content-Type': 'application/json', "Authorization": "Bearer #{auth_key64}" }
+      headers = {"Content-Type": "application/json", Authorization: "Bearer #{auth_key64}"}
       response = Net::HTTP.post(uri, payload.to_json, headers)
 
-      if response.kind_of? Net::HTTPSuccess
+      if response.is_a? Net::HTTPSuccess
         response.body
       else
         raise RailsPdfRenderer::Error.new(response)

data/lib/rails/pdf/renderer/action_view_helper.rb

@@ -1,7 +1,7 @@
-require 'net/http'
-require 'delegate'
-require 'stringio'
-require_relative 'path_helper'
+require "net/http"
+require "delegate"
+require "stringio"
+require_relative "path_helper"
 
 class RailsPdfRenderer
   module ActionViewHelper
@@ -60,7 +60,7 @@ class RailsPdfRenderer
       end
 
       def content_type
-        Mime::Type.lookup_by_extension(File.extname(path).delete('.'))
+        Mime::Type.lookup_by_extension(File.extname(path).delete("."))
       end
 
       def to_s
@@ -76,7 +76,7 @@ class RailsPdfRenderer
       asset = find_asset(path)
       raise MissingLocalAsset, path if asset.nil?
 
-      base64 = Base64.encode64(asset.to_s).gsub(/\s+/, '')
+      base64 = Base64.encode64(asset.to_s).gsub(/\s+/, "")
       "data:#{asset.content_type};base64,#{Rack::Utils.escape(base64)}"
     end
 
@@ -86,7 +86,7 @@ class RailsPdfRenderer
       response = Net::HTTP.get_response(URI(url))
 
       if response.is_a?(Net::HTTPSuccess)
-        base64 = Base64.encode64(response.body).gsub(/\s+/, '')
+        base64 = Base64.encode64(response.body).gsub(/\s+/, "")
         "data:#{response.content_type};base64,#{Rack::Utils.escape(base64)}"
       else
         Rails.logger.warn("[pdf] #{response.code} #{response.message}: #{url}")
@@ -96,12 +96,12 @@ class RailsPdfRenderer
 
     def pdf_stylesheet_link_tag(*sources)
       stylesheet_contents = sources.collect do |source|
-        source = PathHelper.add_extension(source, 'css')
+        source = PathHelper.add_extension(source, "css")
         "<style type='text/css'>#{read_asset(source)}</style>"
       end.join("\n")
 
       stylesheet_contents.gsub(ASSET_URL_REGEX) do
-        if Regexp.last_match[1].starts_with?('data:')
+        if Regexp.last_match[1].starts_with?("data:")
           "url(#{Regexp.last_match[1]})"
         else
           "url(#{pdf_asset_path(Regexp.last_match[1])})"
@@ -116,7 +116,7 @@ class RailsPdfRenderer
         stylesheet_pack_tag(*sources)
       else
         css_text = sources.collect do |source|
-          source = PathHelper.add_extension(source, 'css')
+          source = PathHelper.add_extension(source, "css")
           pdf_stylesheet_link_tag(webpacker_source_url(source))
         end.join("\n")
         css_text.respond_to?(:html_safe) ? css_text.html_safe : css_text
@@ -130,7 +130,7 @@ class RailsPdfRenderer
         javascript_pack_tag(*sources)
       else
         sources.collect do |source|
-          source = PathHelper.add_extension(source, 'js')
+          source = PathHelper.add_extension(source, "js")
           "<script type='text/javascript'>#{read_asset(webpacker_source_url(source))}</script>"
         end.join("\n").html_safe
       end
@@ -141,19 +141,19 @@ class RailsPdfRenderer
     end
 
     def pdf_javascript_src_tag(jsfile, options = {})
-      jsfile = PathHelper.add_extension(jsfile, 'js')
+      jsfile = PathHelper.add_extension(jsfile, "js")
       javascript_include_tag pdf_asset_path(jsfile), options
     end
 
     def pdf_javascript_include_tag(*sources)
       sources.collect do |source|
-        source = PathHelper.add_extension(source, 'js')
+        source = PathHelper.add_extension(source, "js")
         "<script type='text/javascript'>#{read_asset(source)}</script>"
       end.join("\n").html_safe
     end
 
     def pdf_asset_path(asset)
-      if (pathname = asset_pathname(asset).to_s) =~ URI_REGEXP
+      if URI_REGEXP.match?(pathname = asset_pathname(asset).to_s)
         pathname
       else
         "file:///#{pathname}"
@@ -179,11 +179,11 @@ class RailsPdfRenderer
       if precompiled_or_absolute_asset?(source)
         asset = asset_path(source)
         pathname = prepend_protocol(asset)
-        if pathname =~ URI_REGEXP
+        if URI_REGEXP.match?(pathname)
           # asset_path returns an absolute URL using asset_host if asset_host is set
           pathname
         else
-          File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ''))
+          File.join(Rails.public_path, asset.sub(/\A#{Rails.application.config.action_controller.relative_url_root}/, ""))
         end
       else
         asset = find_asset(source)
@@ -198,7 +198,7 @@ class RailsPdfRenderer
 
     def find_asset(path)
       if Rails.application.assets.respond_to?(:find_asset)
-        Rails.application.assets.find_asset(path, :base_path => Rails.application.root.to_s)
+        Rails.application.assets.find_asset(path, base_path: Rails.application.root.to_s)
       elsif defined?(Propshaft::Assembly) && Rails.application.assets.is_a?(Propshaft::Assembly)
         PropshaftAsset.new(Rails.application.assets.load_path.find(path))
       elsif Rails.application.respond_to?(:assets_manifest)
@@ -208,7 +208,7 @@ class RailsPdfRenderer
         asset_path = File.join(Rails.application.assets_manifest.dir, relative_asset_path)
         LocalAsset.new(asset_path) if File.file?(asset_path)
       else
-        SprocketsEnvironment.find_asset(path, :base_path => Rails.application.root.to_s)
+        SprocketsEnvironment.find_asset(path, base_path: Rails.application.root.to_s)
       end
     end
 
@@ -219,7 +219,7 @@ class RailsPdfRenderer
         assets.find do |asset, _v|
           directory = File.dirname(asset)
           asset_path = File.basename(asset, File.extname(asset))
-          asset_path = File.join(directory, asset_path) if directory != '.'
+          asset_path = File.join(directory, asset_path) if directory != "."
 
           asset_path == path
         end&.last
@@ -231,11 +231,11 @@ class RailsPdfRenderer
     # will prepend a http or default_protocol to a protocol relative URL
     # or when no protcol is set.
     def prepend_protocol(source)
-      protocol = RailsPdfRenderer.configuration.default_protocol || 'http'
-      if source[0, 2] == '//'
-        source = [protocol, ':', source].join
-      elsif source[0] != '/' && !source[0, 8].include?('://')
-        source = [protocol, '://', source].join
+      protocol = RailsPdfRenderer.configuration.default_protocol || "http"
+      if source[0, 2] == "//"
+        source = [protocol, ":", source].join
+      elsif source[0] != "/" && !source[0, 8].include?("://")
+        source = [protocol, "://", source].join
       end
       source
     end
@@ -243,13 +243,13 @@ class RailsPdfRenderer
     def precompiled_or_absolute_asset?(source)
       !Rails.configuration.respond_to?(:assets) ||
         Rails.configuration.assets.compile == false ||
-        source.to_s[0] == '/' ||
-        source.to_s.match(/\Ahttps?\:\/\//)
+        source.to_s[0] == "/" ||
+        source.to_s.match(/\Ahttps?:\/\//)
     end
 
     def read_asset(source)
       asset = find_asset(source)
-      return asset.to_s.force_encoding('UTF-8') if asset
+      return asset.to_s.force_encoding("UTF-8") if asset
 
       unless precompiled_or_absolute_asset?(source)
         raise MissingLocalAsset, source if RailsPdfRenderer.configuration.raise_on_missing_assets
@@ -258,7 +258,7 @@ class RailsPdfRenderer
       end
 
       pathname = asset_pathname(source)
-      if pathname =~ URI_REGEXP
+      if URI_REGEXP.match?(pathname)
         read_from_uri(pathname)
       elsif File.file?(pathname)
         IO.read(pathname)
@@ -277,7 +277,7 @@ class RailsPdfRenderer
       end
 
       asset = response.body
-      asset.force_encoding('UTF-8') if asset
+      asset&.force_encoding("UTF-8")
       asset = gzip(asset) if RailsPdfRenderer.configuration.expect_gzipped_remote_assets
       asset
     end
@@ -294,9 +294,9 @@ class RailsPdfRenderer
       return unless webpacker_version
 
       # In Webpacker 3.2.0 asset_pack_url is introduced
-      if webpacker_version >= '3.2.0'
+      if webpacker_version >= "3.2.0"
         if (host = Rails.application.config.asset_host)
-          asset_pack_path(source, :host => host)
+          asset_pack_path(source, host: host)
         else
           asset_pack_url(source)
         end
@@ -320,12 +320,12 @@ class RailsPdfRenderer
 
     def webpacker_version
       if defined?(Shakapacker)
-        require 'shakapacker/version'
+        require "shakapacker/version"
         Shakapacker::VERSION
       elsif defined?(Webpacker)
-        require 'webpacker/version'
+        require "webpacker/version"
         Webpacker::VERSION
       end
     end
   end
-end
+end

data/lib/rails/pdf/renderer/config.rb

@@ -1,3 +1,5 @@
+require "active_support/core_ext/class/attribute"
+
 class RailsPdfRenderer
   class Config
     class_attribute :auth_key, instance_accessor: true
@@ -15,4 +17,4 @@ class RailsPdfRenderer
       }
     }
   end
-end
+end

data/lib/rails/pdf/renderer/error.rb

@@ -10,4 +10,4 @@ class RailsPdfRenderer
       "Got error when trying to fetch PDF from server. HTTP error #{@http_response.code} #{@http_response.message}"
     end
   end
-end
+end

data/lib/rails/pdf/renderer/path_helper.rb

@@ -1,7 +1,7 @@
 class RailsPdfRenderer
   module PathHelper
     def self.add_extension(filename, extension)
-      filename.to_s.split('.').include?(extension) ? filename : "#{filename}.#{extension}"
+      filename.to_s.split(".").include?(extension) ? filename : "#{filename}.#{extension}"
     end
   end
-end
+end

data/lib/rails/pdf/renderer/railtie.rb

@@ -1,15 +1,15 @@
-require_relative 'action_controller_helper'
-require_relative 'action_view_helper'
+require_relative "action_controller_helper"
+require_relative "action_view_helper"
 
 class RailsPdfRenderer
   if defined?(Rails.env)
     class RailsPdfRendererRailtie < Rails::Railtie
-      initializer 'rails-pdf-renderer.register' do |_app|
+      initializer "rails-pdf-renderer.register" do |_app|
         ActiveSupport.on_load(:action_controller) { ActionController::Base.send :prepend, RailsPdfRenderer::ActionControllerHelper }
         ActiveSupport.on_load(:action_view) { include RailsPdfRenderer::ActionViewHelper }
       end
     end
 
-    Mime::Type.register('application/pdf', :pdf) if Mime::Type.lookup_by_extension(:pdf).nil?
+    Mime::Type.register("application/pdf", :pdf) if Mime::Type.lookup_by_extension(:pdf).nil?
   end
 end

data/lib/rails/pdf/renderer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RailsPdfRenderer
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-pdf-renderer
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Erik Axel Nielsen
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -86,8 +100,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/skills/commit/SKILL.md"
+- ".claude/skills/create-pr/SKILL.md"
+- ".claude/skills/release/SKILL.md"
 - ".rspec"
+- ".tool-versions"
 - CHANGELOG.md
+- CLAUDE.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -99,7 +118,6 @@ files:
 - lib/rails/pdf/renderer/path_helper.rb
 - lib/rails/pdf/renderer/railtie.rb
 - lib/rails/pdf/renderer/version.rb
-- rails-pdf-renderer.gemspec
 homepage: https://github.com/erikaxel/
 licenses:
 - MIT
@@ -114,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Create PDFs directly from Rails.
 test_files: []

data/rails-pdf-renderer.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/rails/pdf/renderer/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "rails-pdf-renderer"
-  spec.version = RailsPdfRenderer::VERSION
-  spec.authors = ["Erik Axel Nielsen"]
-  spec.email = ["erikaxel.nielsen@gmail.com"]
-
-  spec.summary = "Create PDFs directly from Rails."
-  spec.description = "Helper library to generate PDFs from Rails."
-  spec.homepage = "https://github.com/erikaxel/"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/erikaxel/"
-  spec.metadata["changelog_uri"] = "https://github.com/erikaxel/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency 'rails'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency 'standard'
-end