html2pdf-rails 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c933b1cfb11343837f0b30972a1062ffe7dc3e4d03e089a0734dfea617e320c
-  data.tar.gz: 20eb371e7da0b2795e2d9eea78487b5e7cad9e7e7f00317613b69fa2428ee660
+  metadata.gz: 3651940b4f5e82b4b9016f5ee19bb796445247b2f7f6b47e4f7e61b9bb77c57d
+  data.tar.gz: 51f9ab1f57f30e455053a06f37aac4599ea30ff1dcb36b8deff32ee283411456
 SHA512:
-  metadata.gz: 121de0d8ceb2c4d40474ae991fa4c286794c67db29d477f7214ca923743afc86acda4fa02313b7b7d31ce81d4bc31694d12f8464a3e3332aafb7f0f6a860eb6f
-  data.tar.gz: 94b153953fbc58c413140555b499bf4e3967d9c7d857520adef5f85299b39708805f841b9a2744737471eeaaa0a4f4c3d407053c9d7b96614bb6e6a73c6b2bfa
+  metadata.gz: 44b1e70af04a620a235a53091b3ab6b6b6b02d556da30e3dccabe6001cdd32566820c72671d14843720cfebf1ab9cc41757cfc090158519a1ad99d4ca5e8d8ba
+  data.tar.gz: 1148efd75a6d2ca35bd16259082d9dc301f12bd9bc2979c7b0566d419e74179403af2c7c1742f4d58ac84d15dfa09728d379ad4ce828fe6de6548e5948a5b496

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4', '4.0']
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+
+    - name: Run tests
+      run: bundle exec rspec -fp

data/README.md

@@ -1,3 +1,5 @@
+![CI](https://github.com/SonicGarden/html2pdf-rails/actions/workflows/ci.yml/badge.svg)
+
 # html2pdf-rails
 
 PDF generator (from HTML) gem for Ruby on Rails.
@@ -59,6 +61,40 @@ You can get signed url of Cloud Storage if your Cloud Funciton code support it.
   redirect_to pdf_url
 ```
 
+### Attach PDF to an email (ActionMailer)
+
+`render_to_pdf_string` is available in all mailers. It renders a template, converts it to PDF, and returns the PDF binary.
+
+```ruby
+class OrderMailer < ApplicationMailer
+  def receipt(order)
+    @order = order
+    attachments['receipt.pdf'] = render_to_pdf_string
+    mail(to: order.user.email)
+  end
+end
+```
+
+By default, the template is inferred from `<mailer_name>/<action_name>` and `formats: [:pdf]` is used. So the example above renders `order_mailer/receipt.pdf.erb`. You can override these defaults:
+
+```ruby
+attachments['receipt.pdf'] = render_to_pdf_string(
+  template: 'order_mailer/receipt_pdf',
+  layout: 'pdf',
+  pdf_options: { margin: { top: '30px' } }
+)
+```
+
+### Generate PDF from arbitrary HTML
+
+If you already have an HTML string (for example, in a background job or PORO), use the low-level API:
+
+```ruby
+html = ApplicationController.render(template: 'invoices/show', assigns: { invoice: invoice })
+pdf = Html2Pdf::Rails.generate(html: html, pdf_options: { margin: { top: '30px' } })
+File.binwrite('invoice.pdf', pdf)
+```
+
 ### Advanced Usage with all available options
 
 ```ruby
@@ -130,6 +166,30 @@ Html2Pdf.configure do |config|
 end
 ```
 
+### `html2pdf_base_tag` in mailers / jobs
+
+`html2pdf_base_tag` resolves the base URL in this order (matches Rails `url_for`):
+
+1. Explicit `host:` / `protocol:` argument
+2. `HTTP_X_ORIGINAL_HOST` request header (host only, for Ngrok-style proxying)
+3. View-context `url_options[:host]` / `[:protocol]`:
+   - In a controller view: `config.action_controller.default_url_options` merged over `request.host` / `request.protocol` (config wins, request as fallback — same behavior as Rails `url_for`)
+   - In a mailer view: `config.action_mailer.default_url_options`
+4. `Rails.application.routes.default_url_options[:host]` / `[:protocol]` (final fallback)
+
+Most Rails apps already configure `config.action_mailer.default_url_options` for mailer URL helpers, so no extra setup is usually required:
+
+```ruby
+# config/environments/production.rb
+config.action_mailer.default_url_options = { host: 'example.com', protocol: 'https' }
+```
+
+If you want to override per-call (e.g. multi-tenant), pass arguments:
+
+```erb
+<%= html2pdf_base_tag host: 'tenant.example.com', protocol: 'https' %>
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/SonicGarden/html2pdf-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/html2pdf/rails/helper.rb

@@ -3,11 +3,64 @@
 module Html2Pdf
   module Rails
     module Helper
-      def html2pdf_base_tag
-        # NOTE: for Ngrok
-        host = request.headers['HTTP_X_ORIGINAL_HOST'] || request.host
-        base_url = "#{request.protocol}#{host}"
-        tag.base href: base_url
+      # Resolves the base URL in the same order as Rails' `url_for`, with one
+      # gem-specific addition (HTTP_X_ORIGINAL_HOST). See `_html2pdf_default_url_options`
+      # for the source of `options`.
+      def html2pdf_base_tag(host: nil, protocol: nil)
+        req = _html2pdf_request
+        options = _html2pdf_default_url_options
+
+        # HTTP_X_ORIGINAL_HOST overrides options because dev tunneling (Ngrok) sets
+        # this header to the externally-visible host that puppeteer must reach,
+        # which doesn't match request.host or any configured default.
+        host ||= req && req.headers['HTTP_X_ORIGINAL_HOST']
+        host ||= options[:host]
+        if host.blank?
+          raise ArgumentError,
+                'html2pdf_base_tag: host is not available. Pass `host:` or configure default_url_options (e.g. config.action_mailer.default_url_options).'
+        end
+
+        # options[:protocol] from controller's url_options is "https://" (with trailing
+        # "://" — request.protocol convention), while config and mailer values are
+        # bare "https". Normalize.
+        protocol ||= options[:protocol]&.to_s&.delete_suffix('://')
+        protocol ||= 'https'
+
+        tag.base href: "#{protocol}://#{host}"
+      end
+
+      private
+
+      def _html2pdf_request
+        respond_to?(:request) ? request : nil
+      end
+
+      # Mirrors how Rails' `url_for` resolves URL options, so this helper produces
+      # the same host/protocol as `url_for` would in the same context.
+      #
+      # `view.url_options` delegates to `controller.url_options`:
+      # https://github.com/rails/rails/blob/v8.1.2/actionview/lib/action_view/routing_url_for.rb#L124
+      #
+      # In a controller this returns
+      # `{ host: request.host, protocol: request.protocol, ... }.merge!(super)`:
+      # https://github.com/rails/rails/blob/v8.1.2/actionpack/lib/action_controller/metal/url_for.rb#L37
+      # `merge!` lets class-level `default_url_options` win over request info.
+      # In a mailer it returns the class-level `default_url_options` directly
+      # (no request to merge in).
+      #
+      # `RouteSet#url_for` then does `default_url_options.merge(options)`, so
+      # routes' default is the base under everything else. We replicate that here:
+      # https://github.com/rails/rails/blob/v8.1.2/actionpack/lib/action_dispatch/routing/route_set.rb#L856
+      #
+      # Note: `config.action_mailer.default_url_options` and
+      # `config.action_controller.default_url_options` populate the *class*
+      # `default_url_options`, NOT `Rails.application.routes.default_url_options` —
+      # they are three separate hashes. Reading only the routes hash would miss the
+      # typical mailer setup.
+      def _html2pdf_default_url_options
+        routes_options = ::Rails.application&.routes&.default_url_options || {}
+        context_options = respond_to?(:url_options) ? url_options : {}
+        routes_options.merge(context_options)
       end
     end
   end

data/lib/html2pdf/rails/mailer_rendering.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Html2Pdf
+  module Rails
+    module MailerRendering
+      def render_to_pdf_string(template: nil, layout: false, formats: [:pdf], handlers: nil, pdf_options: {})
+        # When :template is omitted, Rails resolves the template from `_prefixes`
+        # (= [mailer_name]) and `action_name` via `_process_render_template_options`:
+        # https://github.com/rails/rails/blob/v8.1.2/actionview/lib/action_view/rendering.rb#L177
+        render_opts = { template: template, layout: layout, formats: formats, handlers: handlers }.compact
+        html = render_to_string(**render_opts)
+        Html2Pdf::Rails.generate(html: html, pdf_options: pdf_options)
+      end
+    end
+  end
+end

data/lib/html2pdf/rails/railtie.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'rails'
 require 'html2pdf/rails/rendering'
+require 'html2pdf/rails/mailer_rendering'
 require 'html2pdf/rails/helper'
 
 module Html2Pdf
@@ -10,6 +12,10 @@ module Html2Pdf
         ActionController::Base.prepend Rendering
       end
 
+      ActiveSupport.on_load(:action_mailer) do
+        ActionMailer::Base.include MailerRendering
+      end
+
       ActiveSupport.on_load(:action_view) do
         ActionView::Base.include Helper
       end

data/lib/html2pdf/rails/rendering.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'retryable'
-require 'html2pdf/rails/client'
-
 module Html2Pdf
   module Rails
     module Rendering
@@ -28,9 +25,15 @@ module Html2Pdf
 
       def _html2_pdf_render_pdf_and_get_url(pdf_name, options = {})
         options = _html2pdf_default_options(pdf_name, options)
-        options[:put_to_storage] = true
-        json = JSON.parse(_html2pdf_make_pdf(options))
-        json['url']
+        html = _html2pdf_render_html(options)
+        response = Html2Pdf::Rails.generate(
+          html: html,
+          pdf_options: options[:pdf_options],
+          put_to_storage: true,
+          file_name: options[:file_name],
+          disposition: options[:disposition]
+        )
+        JSON.parse(response)['url']
       end
 
       def _html2pdf_make_and_send_pdf(pdf_name, options = {})
@@ -40,24 +43,15 @@ module Html2Pdf
           render_opts = options.slice(:template, :layout, :formats, :handlers)
           render(render_opts.merge({ content_type: 'text/html' }))
         else
-          pdf_content = _html2pdf_make_pdf(options)
+          html = _html2pdf_render_html(options)
+          pdf_content = Html2Pdf::Rails.generate(html: html, pdf_options: options[:pdf_options])
           send_data(pdf_content, filename: options[:file_name], type: 'application/pdf', disposition: options[:disposition])
         end
       end
 
-      def _html2pdf_make_pdf(options = {})
+      def _html2pdf_render_html(options)
         render_opts = options.slice(:template, :layout, :formats, :handlers)
-        html = render_to_string(**render_opts)
-
-        Retryable.retryable(tries: 3, on: Html2Pdf::Rails::ServiceUnavailableError) do
-          Client.post(
-            html: html,
-            put_to_storage: options[:put_to_storage],
-            file_name: options[:file_name],
-            disposition: options[:disposition],
-            pdf_options: options[:pdf_options]
-          )
-        end
+        render_to_string(**render_opts)
       end
     end
   end

data/lib/html2pdf/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Html2Pdf
   module Rails
-    VERSION = '0.5.0'
+    VERSION = '0.7.0'
   end
 end

data/lib/html2pdf/rails.rb

@@ -1,12 +1,17 @@
-require 'active_support/configurable'
+require 'retryable'
 require 'html2pdf/rails/version'
+require 'html2pdf/rails/errors'
+require 'html2pdf/rails/client'
 require 'html2pdf/rails/railtie'
 
 module Html2Pdf
   class Config
-    include ActiveSupport::Configurable
-    config_accessor :endpoint
-    config_accessor :app
+    attr_accessor :endpoint, :app
+
+    def initialize
+      @endpoint = nil
+      @app = nil
+    end
   end
 
   class << self
@@ -18,4 +23,18 @@ module Html2Pdf
       @config ||= Config.new
     end
   end
+
+  module Rails
+    def self.generate(html:, pdf_options: {}, put_to_storage: false, file_name: nil, disposition: nil)
+      Retryable.retryable(tries: 3, on: ServiceUnavailableError) do
+        Client.post(
+          html: html,
+          pdf_options: pdf_options,
+          put_to_storage: put_to_storage,
+          file_name: file_name,
+          disposition: disposition
+        )
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: html2pdf-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - aki77
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,10 +86,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -103,6 +102,7 @@ files:
 - lib/html2pdf/rails/client.rb
 - lib/html2pdf/rails/errors.rb
 - lib/html2pdf/rails/helper.rb
+- lib/html2pdf/rails/mailer_rendering.rb
 - lib/html2pdf/rails/railtie.rb
 - lib/html2pdf/rails/rendering.rb
 - lib/html2pdf/rails/version.rb
@@ -110,7 +110,6 @@ homepage: https://github.com/SonicGarden/html2pdf-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: PDF generator (from HTML) gem for Ruby on Rails
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-before_install: gem install bundler -v 1.16.6