Project

html2pdf-rails

0.0
No release in over 3 years
Low commit activity in last 3 years
html2pdf-railssonicgarden/html2pdf-railsHomepageDocumentationSource CodeBug TrackerWiki
PDF generator (from HTML) gem for Ruby on Rails
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
61,756
Stars
6
Forks
0
Watchers
14
 Releases
Current version
0.4.0
Total releases
6
First release
2018-10-26
Latest release
2021-10-26
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
2
Merged Pull Requests
10
Pull Request Acceptance Rate
83%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-05-29
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
rake
>= 0
rspec
>= 0

Runtime

rails
>= 5.2.0
retryable
>= 0
 Project Readme

html2pdf-rails

PDF generator (from HTML) gem for Ruby on Rails.

Installation

Add this line to your application's Gemfile:

gem 'html2pdf-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install html2pdf-rails

Usage

Basic Usage

Controller

class ThingsController < ApplicationController
  def show
    respond_to do |format|
      format.html
      format.pdf do
        render_to_pdf pdf: 'file_name'   # Excluding ".pdf" extension.
      end
    end
  end
end

Layout

!!!
%html
  %head
    %meta{ charset: 'utf-8' }
    = html2pdf_base_tag
    = stylesheet_link_tag 'pdf', media: 'all'
  %body
    #header= image_tag 'logo.jpg'
    #content= yield

Put PDF to Cloud Storage and return signed url

You can get signed url of Cloud Storage if your Cloud Funciton code support it.

  pdf_url = render_pdf_and_get_url pdf: 'file_name'
  redirect_to pdf_url

Advanced Usage with all available options

class ThingsController < ApplicationController
  def show
    respond_to do |format|
      format.html
      format.pdf do
        render_to_pdf(
          pdf: 'file_name',                   # Excluding ".pdf" extension.
          disposition: 'attachment',          # default 'inline'
          template: 'things/show',
          layout: 'pdf',                      # for a pdf.pdf.erb file
          show_as_html: params.key?('debug'), # allow debugging based on url param
          pdf_options: {                      # SEE: https://pptr.dev/api/puppeteer.pdfoptions
            margin: {
              top: '30px',
              bottom: '30px',
            }
          }
        )
      end
    end
  end
end

Cloud Functions for Firebase Sample

const functions = require("firebase-functions");
const puppeteer = require("puppeteer");

const runOptions = {
  timeoutSeconds: 20,
  memory: "1GB"
};
exports.html2pdf = functions
  .runWith(runOptions)
  .https.onRequest(
    async ({ method, body: { html = "", putToStorage = false, pdfOptions = {} } }, res) => {
      const browser = await puppeteer.launch({
        headless: true,
        args: ["--no-sandbox"]
      });
      const page = await browser.newPage();
      await page.emulateMedia("print");
      await page.goto("data:text/html;charset=UTF-8," + html, {
        waitUntil: "networkidle0"
      });
      const pdf = await page.pdf(pdfOptions);
      if (putToStorage) {
        // Code for Cloud Storage is omitted.
      } else {
        res.header({ "Content-Type": "application/pdf" });
        res.send(pdf);
      }
    }
  );

Configuration

In config/initializers/html2pdf_rails.rb, you can configure the following values.

Html2Pdf.configure do |config|
  config.endpoint = 'YOUR_HTTP_TRIGGER_ENDPOINT'
end

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.