pdfgen 0.4.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e28174877f0b28647fd1653c187ecf4bd0fe3b7
-  data.tar.gz: 98e2bbed6e8f2d4bf6252432f612e2cabee4540f
+  metadata.gz: bcdeca0b0cd11c902176aef409ebde2b2be733e3
+  data.tar.gz: 2fff00de1528642236c64bda3fc616b6fe80b838
 SHA512:
-  metadata.gz: a47ffc3ad2f07bee137731ec1187da17e3c5b601ba0797ff6cf3b6613037f096bf8ca217dcf23165fa3a9a16a24a861e810c281dab84279b972bf332247351ac
-  data.tar.gz: 4bdb05250de0ec74f63dbf913387957add058f2c82d693c5a12a5237cf324389631da9bb848d82f288a529f74117addaca8c73519937c927cbcb9c88aff1434e
+  metadata.gz: d80dc52b63bc498f8183ffec8d8d5b554afd21a1ebad8d7e1206c6ade6628ac3a7b45f93ba0d44bd72ec5a9521b322b5064533b767617fd027ad505ab8346e9f
+  data.tar.gz: c27b05d3d6a47f0ce0d79bd65949ae41b879dd9d8ba15fb650257f0c6ba1d59c8ca8f6ddb933454f30430e7e678850f9ccef59ad6f8d1a2e8df450dd5cb0a1d9

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+## Pdfgen 0.8.1 (November 30, 2020)
+
+* Handle deprecation of emulateMedia function.
+
+  This was submitted by https://github.com/maokomioko in
+  https://github.com/romaimperator/pdfgen/pull/2. Thanks for your contribution!
+
+## Pdfgen 0.8.0 (December 17, 2019)
+
+* Allow using a `file://` path as a URL for PDFs
+
+  This was submitted by https://github.com/maokomioko in
+  https://github.com/romaimperator/pdfgen/pull/1. Thanks for your contribution!
+
+## Pdfgen 0.7.0 (June 14, 2019)
+
+* Revert to using setContent but require Puppeteer >= 1.11.0.
+
+  This version of Puppeteer added support to setContent for waiting until browser
+  events fire. The original reason for transitioning away from setContent was lack
+  of that feature and navigating to a data URL is limited to a maximum of 2 megabytes
+  of HTML as that is Chromium's URL length limit.
+
+## Pdfgen 0.6.0 (June 14, 2019)
+
+* Use capture3 to also capture stderror which is where Node error messages are output.
+
+  This allows Pdfgen to include the error from Node in the exception that is raised.
+
+## Pdfgen 0.5.0 (September 3, 2018)
+
+* Changes how the wait for timeout works slightly.
+
+  This new way starts the wait prior to putting the HTML in the page. Now that we can
+  utilize the waitUntil navigation feature in Puppeteer, we might as well start the
+  clock before waiting for that amount of time. This way, the maximum wait time should
+  be roughly the timeout instead of the timeout + how long the page takes to load.
+
+* Changes how static HTML is put into the page.
+
+  This new method allows us to use the navigation wait helpers so there should be
+  almost no need for timeout waiting if passing Pdfgen HTML instead of a URL.
+
+  Sadly, this still does not load assets on the page so inlining your assets is still
+  required.
+
+* Moves emulateMedia and setViewport steps to be before setting content or navigation
+  so that the browser won't need to rerender the content and hopefully we improve
+  performance some.
+
 ## Pdfgen 0.4.2 (June 8, 2018)
 
 * Adds checking of minimum Node version required.

data/README.md

@@ -4,7 +4,7 @@ A tool for creating PDFs using [Puppeteer](https://github.com/GoogleChrome/puppe
 # Dependencies
 This gem requires:
 * Node v7.6 or greater
-* Puppeteer (tested with v1.3.0)
+* Puppeteer v1.11.0 or greater
 
 ### OSX (Homebrew)
 To install node on OSX you can use Homebrew:

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.8.1

data/lib/javascript_bin/make_pdf.js

@@ -41,15 +41,14 @@ stdin.on('end', function () {
     (async() => {
         const browser = await puppeteer.launch(launch_options);
         const page = await browser.newPage();
-
-        if (typeof url !== 'undefined' && url) {
-            await page.goto(url, url_options);
-        } else {
-            await page.setContent(html);
-        }
+        let wait_promise = null;
 
         if (typeof media_type !== 'undefined' && media_type) {
-            await page.emulateMedia(media_type);
+            if (typeof page.emulateMedia !== 'undefined') {
+                await page.emulateMedia(media_type);
+            } else {
+                await page.emulateMediaType(media_type);
+            }
         }
 
         if (typeof viewport_options !== 'undefined' && viewport_options) {
@@ -57,7 +56,21 @@ stdin.on('end', function () {
         }
 
         if (typeof wait_for_timeout !== 'undefined' && wait_for_timeout) {
-            await page.waitFor(wait_for_timeout);
+            wait_promise = page.waitFor(wait_for_timeout);
+        }
+
+        if (typeof url !== 'undefined' && url) {
+            await page.goto(url, url_options);
+        } else {
+            await page.setContent(html, { waitUntil: ["networkidle0", "load"] });
+        }
+
+        // If we were given a wait timeout, we should wait for the rest of the timeout now. That way,
+        // the timeout will act as a minimum amount of time to wait for the page. If it's greater than
+        // how long the waitUntil idle took, it will wait for the extra time. If it is shorter than how
+        // long the page actually needs, then it will not add any time.
+        if (typeof wait_promise !== 'undefined' && wait_promise) {
+            await wait_promise;
         }
 
         if (typeof debug_mode === 'undefined') {

data/lib/pdfgen.rb

@@ -13,7 +13,7 @@ MAKE_PDF_COMMAND = File.expand_path('../javascript_bin/make_pdf.js', __FILE__)
 
 class Pdfgen
   def initialize(html_or_url)
-    if html_or_url =~ /\Ahttp/
+    if html_or_url =~ /\Ahttp|\Afile/
       @url = html_or_url
       @html = nil
     else
@@ -74,21 +74,22 @@ class Pdfgen
     end
 
     pdf_output = nil
+    error_output = nil
     status = nil
     if @html
       file = Tempfile.new('input_html')
       file.write(@html)
       file.close
-      pdf_output, status = Open3.capture2(MAKE_PDF_COMMAND, file.path, stdin_data: stdin_options.to_json)
+      pdf_output, error_output, status = Open3.capture3(MAKE_PDF_COMMAND, file.path, stdin_data: stdin_options.to_json)
       file.unlink
     else
       stdin_options = stdin_options.merge(url: @url)
       stdin_options = stdin_options.merge(url_options: @url_options)
-      pdf_output, status = Open3.capture2(MAKE_PDF_COMMAND, stdin_data: stdin_options.to_json)
+      pdf_output, error_output, status = Open3.capture3(MAKE_PDF_COMMAND, stdin_data: stdin_options.to_json)
     end
 
     unless status.success?
-      raise 'There was an unknown error running node to create the pdf. Check your logs for output that might assist in debugging.'
+      raise "This error was encountered running node to create the pdf: #{error_output}"
     end
     unless pdf_output
       raise 'There was an error creating the temporary file used to pass the HTML to node.'
@@ -98,4 +99,4 @@ class Pdfgen
 end
 
 
-# Use a new API that uses method chaining to configure the PDF and that queues up strings to put in a js file to run puppeteer
+# Use a new API that uses method chaining to configure the PDF and that queues up strings to put in a js file to run puppeteer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pdfgen
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Daniel Fox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Generate PDFs using Puppeteer and headless Chrome