pdf_gem 1.0.1 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10af893a52c091022ff0544911751cc04cd09dbd0ce2dd45c3aca4cee493affd
-  data.tar.gz: ec3e961a45fa96c8fbbe45e1d671f84367600b00f1a4dfd0cfc74c50067b3e7e
+  metadata.gz: 3ae377666e9721fcf26fda08d4791500e0d8e28e6eaddcbac702e1238c5815d9
+  data.tar.gz: e749a87289fa44a1ce4e47c7549855932400512b0877bd72e9e32eb606652ce1
 SHA512:
-  metadata.gz: fd9be56c9327a4894059cb4a174b485d33c1c1c3c8ab744d5b788abd663311769fab3f87f37cc1c60d2c7f6749640b39308330b3840abb1fbb9d3e64ae3892ea
-  data.tar.gz: caaf28b437e0ba053b8bed3271619d1561ce5cbbc07ec2f93a034b9a8be614498099bfe7613d5bc84730580048a2bae526bd0fe645d94292ddb8e52b12fdb5df
+  metadata.gz: c3dac5f68aa57d4f32781b7937b27b5dadb7cda557e6d802c9c1015bf23a78a4db952a797ca9e15a5f4db142a34de6b3a6fae48cae229a6358c7140a3df0811b
+  data.tar.gz: 78bb021dcac458206a562b8dc6a423823765f591d69a86f76dd1eb7cca10e5141e733a0fd8e40bb4f43c38b1e98a0c70c2d9fdfa64edcbf399f0e2df04cb5b2f

data/README.md

@@ -1,5 +1,5 @@
 # PdfGem
-This is a gem for generating PDF from HTML, and is rendered from Chromium Browser
+This is a gem for converting HTML to PDF, the rendering engine is Chromium Browser
 
 ## Prerequisites
 This package depends on node.js and puppeteer run this command for installing them:
@@ -29,7 +29,7 @@ You may need to add
 ```ruby
 Mime::Type.register "application/pdf", :pdf
 ```
-to config/initializers/mime_types.rb
+to `config/initializers/mime_types.rb`
 
 
 ## Usage
@@ -49,6 +49,8 @@ class TestController < ApplicationController
 end
 ```
 
+> **NOTE** If your layout include other refernces like images, css or javascript you must provide the absolute path to the files, you can set config.action_controller.asset_host = "assets.example.com" in that way rails will include the full path for assets, more on https://apidock.com/rails/v6.0.0/ActionView/Helpers/AssetUrlHelper
+
 ### Available lib methods
 
 
@@ -67,11 +69,13 @@ PdfGem.pdf_from_string(options)
 ## Options
 
 - `options` <[Object]> Options object which might have the following properties:
-  - `url` <[string]> (Use only for PdfGem.pdf_from_url) This is the url to render.
-  - `html` <[string]> (Use only for PdfGem.pdf_from_string) This is the html string to render.
+  - `url` <[string]> (Used only for PdfGem.pdf_from_url) This is the url to render.
+  - `timeout` <[number]> Maximum navigation time in ms, default is 3000 ms.
+  - `html` <[string]> (Used only for PdfGem.pdf_from_string) This is the html string to render.
   - `disposition` <[string]> (Use only for controller render) Disposition string (inline/attachment).
+  - `formats` <[string]> (Use only for controller render) Force to load view of a particular format (pdf, html, xml).
   - `filename` <[string]> (Use only for controller render) Filename of the file.
-  - `destination` <[string]> The file path to save the PDF to. If no destination is provided, will be returned a binary string
+  - `destination` <[string]> (Use only for PdfGem.pdf_from_url and PdfGem.pdf_from_string) The file path to save the PDF to. If no destination is provided, will be returned a binary string
   - `scale` <[number]> Scale of the webpage rendering. Defaults to `1`. Scale amount must be between 0.1 and 2.
   - `displayHeaderFooter` <[boolean]> Display header and footer. Defaults to `false`.
   - `headerTemplate` <[string]> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
@@ -94,8 +98,6 @@ PdfGem.pdf_from_string(options)
     - `left` <[string]|[number]> Left margin, accepts values labeled with units.
   - `preferCSSPageSize` <[boolean]> Give any CSS `@page` size declared in the page priority over what is declared in `width` and `height` or `format` options. Defaults to `false`, which will scale the content to fit the paper size.
 
-> **NOTE** Generating a pdf is currently only supported in Chrome headless.
-
 > **NOTE** By default, generates a pdf with modified colors for printing. Use the [`-webkit-print-color-adjust`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to force rendering of exact colors.
 
 
@@ -136,6 +138,11 @@ The `format` options are:
 > 1. Script tags inside templates are not evaluated.
 > 2. Page styles are not visible inside templates.
 
+## Troubleshooting
+In development enviroment if the server runs in single thead mode the app will go in deadlock. Youm must run the server in multithread mode. If you use puma as dev server you can start the server with `puma -w 3`
+
+## Contributing
+You are welcome to contribute.
 
 ## License
 The gem is available as open source under the terms of the [Apach e2.0 License](https://opensource.org/licenses/Apache-2.0).

data/lib/pdf_gem.rb

@@ -5,16 +5,18 @@ require 'renderer'
 
 module PdfGem 
   def self.pdf_from_url(params)
-    stdout, stderr = Open3.capture3("node #{File.join(File.dirname(__FILE__), 'pdf_generator.js').to_s} #{Base64.strict_encode64(params.to_json).to_s}")  
-    if(stdout.present? and stderr.empty?)
+    stdout, stderr, s = Open3.capture3("node #{File.join(File.dirname(__FILE__), 'pdf_generator.js').to_s}", stdin_data: Base64.strict_encode64(params.to_json).to_s)
+    if(s.success?) 
       if(params[:destination].present?)
-        self.save_to_file(params[:destination], stdout)
+        FileUtils.mv(stdout, params[:destination])
       else
-        return Base64.decode64(stdout)
+        res = File.open(stdout, 'rb').read
+        File.delete(stdout) if File.exist?(stdout)
+        return res
       end
     else
       raise stderr.present? ? stderr : "error"
-    end   
+    end
   end
 
   def self.pdf_from_string(params)
@@ -29,10 +31,4 @@ module PdfGem
     File.delete(html_file) if File.exist?(html_file)
     return result
   end
-
-  def self.save_to_file(destination, data)   
-    File.open(destination, "wb") do |f|
-      f.write(Base64.decode64(data))
-    end
-  end
 end

data/lib/pdf_gem/version.rb

@@ -1,3 +1,3 @@
 module PdfGem
-  VERSION = '1.0.1'
+  VERSION = '1.0.9'
 end

data/lib/pdf_generator.js

@@ -2,22 +2,24 @@ const puppeteer = require('puppeteer');
 const fs = require('fs');
 const crypto = require('crypto');
 const path = require('path');
-(async () => {    
+
+(async () => {
+
+    var stdinBuffer = fs.readFileSync(0);
     const filename = path.join(path.dirname(__filename), 'tmp', crypto.randomBytes(40).toString('hex')+ '.pdf');
     const browser = await puppeteer.launch();
     try{
-	const params = {...JSON.parse(Buffer.from(process.argv.slice(2)[0], 'base64').toString('utf-8')), ...{path: filename}};	
+	const params = {...JSON.parse(Buffer.from(stdinBuffer.toString(), 'base64').toString('utf-8')), ...{path: filename}};	
 	const page = await browser.newPage();
-	await page.goto(params.url);
+	await page.goto(params.url, {waitUntil: 'networkidle2', timeout: (params.timeout == null ? 30000 : params.timeout)});
 	await page.pdf(params);
-	console.log(Buffer.from(fs.readFileSync(filename, 'binary'), 'binary').toString('base64'))	
+	process.stdout.write(filename)
     }
     catch(e){
 	console.error(e)
 	process.exit(1);
     }
     finally{
-	fs.unlinkSync(filename)
 	await browser.close();
 	process.exit(0);
     }

data/lib/renderer.rb

@@ -1,11 +1,27 @@
-module PdfGem 
-  ActionController::Renderers.add :pdf do |template, options|
-    params = options.except(:prefixes, :template, :disposition, :url, :html, :filename)
-    params[:html] = render_to_string(template.present? ? template : options.template)
-    send_data PdfGem::pdf_from_string(params), type: Mime[:pdf],  disposition: (params[:disposition].present? ? params[:disposition] : 'inline'), :filename => options[:filename]
-  end
+module PdfGem
+
+  class PdfGemRailtie < Rails::Railtie
+    initializer "my_railtie.configure_rails_initialization" do
+
+      ActionController::Renderers.add :pdf do |template, options|       
+        params = options.except(:prefixes, :template, :disposition, :url, :html, :filename, :formats)
+        params[:html] = render_to_string(:action => (template.present? ? template : options.template), formats: options[:formats].present? ? options[:formats] : [:pdf] )
+        send_data PdfGem::pdf_from_string(params), type: Mime[:pdf],  disposition: (params[:disposition].present? ? params[:disposition] : 'inline'), :filename => options[:filename]
+      end
 
-  if Mime::Type.lookup_by_extension(:pdf).nil?
-    Mime::Type.register('application/pdf', :pdf)
+      ActionController::Renderers.add :pdf2 do |template, options|       
+        params = options.except(:prefixes, :template, :disposition, :url, :html, :filename, :formats)
+        params[:html] = render_to_string(:action => (template.present? ? template : options.template), formats: options[:formats].present? ? options[:formats] : [:pdf] )
+        send_data PdfGem::pdf_from_string(params), type: Mime[:pdf],  disposition: (params[:disposition].present? ? params[:disposition] : 'inline'), :filename => options[:filename]
+      end
+      if Mime::Type.lookup_by_extension(:pdf).nil?
+        Mime::Type.register('application/pdf', :pdf)
+      end
+    end
   end
+
+
+ 
+  
+ 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdf_gem
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.9
 platform: ruby
 authors:
 - Daniel Blasina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Gem based on chrome browser
+description: This is a gem for converting HTML in PDF, the rendering engine is Chromium
+  Browser
 email:
 - blzk100@gmailcom
 executables: []
@@ -52,12 +53,6 @@ files:
 - lib/pdf_gem/version.rb
 - lib/pdf_generator.js
 - lib/renderer.rb
-- lib/tmp/1zlgz1o22datkhezl9dp5j803ocavkyc6wtpmbiz.html
-- lib/tmp/512m1i0cteoydwdoju0e6qdjbm0qttswr711igtr.html
-- lib/tmp/evziomgjof3tg36lz6t6x429rbni8ipjefmxjilq.html
-- lib/tmp/j56oa22hog5nnt1wwebf1xv5nbieeitn5l1nshws.html
-- lib/tmp/kjn1jl9z22l3kdl1vgjdezivta47rlgos30wxx1q.html
-- lib/tmp/nllfaomxczkbqfj470n6r478vva66thutkj7kymn.html
 homepage: https://github.com/blasko03/pdf_gem
 licenses:
 - Apache-2.0

data/lib/tmp/1zlgz1o22datkhezl9dp5j803ocavkyc6wtpmbiz.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>

data/lib/tmp/512m1i0cteoydwdoju0e6qdjbm0qttswr711igtr.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>

data/lib/tmp/evziomgjof3tg36lz6t6x429rbni8ipjefmxjilq.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>

data/lib/tmp/j56oa22hog5nnt1wwebf1xv5nbieeitn5l1nshws.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>

data/lib/tmp/kjn1jl9z22l3kdl1vgjdezivta47rlgos30wxx1q.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>

data/lib/tmp/nllfaomxczkbqfj470n6r478vva66thutkj7kymn.html

@@ -1,13 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>Test HTML File</title>
-
-</head>
-<body>
-
-<p>This is a simple HTML file.</p>
-
-
-
-</body></html>