pdf_gem 1.0.2 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6ee1c453af223c06cda4f2785f8a69f02da7c3e9f4c8116be1b40b08165e60
-  data.tar.gz: 43be06726e1ca3e06b0442a810e231f9abd28c12fb2e1dfd3ad29abe3e251d2f
+  metadata.gz: 98f332cd6e3854f2d3d5c4df1947f4aa6c0195e39439d22f9d9766f461e16951
+  data.tar.gz: ea268c17bc32203477eb74502c404d6563fa83fe5967184a59a0c0f53418d889
 SHA512:
-  metadata.gz: 28635eb2f795ce7cd35cda838db9546a612b2d0fae5186cb277105e8d3bfd3100078ba8734948e9395d1797d6a06b9e8d25375a2a8a142d070c6973ebefd5b9c
-  data.tar.gz: cbb3d3bc77429cf93b09b89518c1733b304539dee62199a7cd005e0b87a5d1b5d5bddadd747b15e744a7a6de03a71a7aca2cf234f1e57af582fbba2a0bdf4ceb
+  metadata.gz: 90043a43775a11bdac9d658c1fa3f57b2528839ee517adc30ac7a79ce152caf02875a284b571656aca0d6e637bcaad8c2948750afeefb0f84186bae83cca8af8
+  data.tar.gz: 552baaa16c13c45ffc648b2291cc9f6f3cb275b5b7bd37b782c6834d67bd5fefec219a19ec80391172aa3a800701f53a3879dddbd64e060820dd5ea246bb8da1

data/README.md

@@ -1,5 +1,5 @@
 # PdfGem
-This is a gem for converting HTML in PDF, the rendering engine is 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
 
 
@@ -68,8 +70,15 @@ PdfGem.pdf_from_string(options)
 
 - `options` <[Object]> Options object which might have the following properties:
   - `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.
+  - `waitUntil` <[string]|[Array]<[string]>> When to consider navigation succeeded, defaults to `load`. Given an array of event strings, navigation is considered to be successful after all events have been fired. Events can be either:
+    - `load` - consider navigation to be finished when the `load` event is fired.
+    - `domcontentloaded` - consider navigation to be finished when the `DOMContentLoaded` event is fired.
+    - `networkidle0` - consider navigation to be finished when there are no more than 0 network connections for at least `500` ms.
+    - `networkidle2` - consider navigation to be finished when there are no more than 2 network connections for at least `500` 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]> (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.
@@ -134,6 +143,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.2'
+  VERSION = '1.0.10'
 end

data/lib/pdf_generator.js

@@ -2,22 +2,31 @@ const puppeteer = require('puppeteer');
 const fs = require('fs');
 const crypto = require('crypto');
 const path = require('path');
-(async () => {    
-    const filename = path.join(path.dirname(__filename), 'tmp', crypto.randomBytes(40).toString('hex')+ '.pdf');
+
+(async () => {
+
+    var stdinBuffer = fs.readFileSync(0);
+
+    var tmp = path.join(path.dirname(__filename), 'tmp');
+
+    if (!fs.existsSync(tmp)){
+	fs.mkdirSync(tmp);
+    }
+    
+    const filename = path.join(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: (params.waitUntil != null ? params.waitUntil : 'load'), 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.2
+  version: 1.0.10
 platform: ruby
 authors:
 - Daniel Blasina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,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>