ferrum_pdf 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c9bdbd12753b4efc5b29bb208908735218fc2614e45eb74e57b6623ca61688
-  data.tar.gz: cb96c86e8c45a34037db93555c9ac5d692f7ccc4d0f37c88e211e6dcb17f7aa1
+  metadata.gz: '09655ccad2a5a6cbf6fa1d2d2e4bb34443a0bf29501265571207079b7a689482'
+  data.tar.gz: 06f33b09c785e64e1c99dd68ef98ae2d7ea28b9460350d5d6d34e54efce3e1d0
 SHA512:
-  metadata.gz: b3e3efc16d9c2601e6ef725d9d1aa6f73d631c8dcfaff8a4aa76a2254e933d7205e33f00a98ac780c7cf0b99fa074e2d820abee42de372fb68966a00fb533faa
-  data.tar.gz: 292b03680170140e5e901f8e84128970cb88a17e17147b57142ad686edca9c31da24c327e8c733505e6188a50310cac7d112a3ce1f92f89ed50b301ec7a0cd9b
+  metadata.gz: '09d27b9a48ef1c126b473930e300b8ae62339404a1a7593910eae32a679106c0a9b5479d8d66ec101ca6ce7a62741665a7d350527f6990600e12181b38544c35'
+  data.tar.gz: e0d5644936b52536b70c39c96d42e7a73f4548096797bab50d076fca3dd4068fad3fa7b03c54249d87f01c3c3ca5faa03d85ba28643fff1111f38fb8dfe4a355

data/README.md

@@ -75,6 +75,7 @@ FerrumPdf.render_pdf(
   authorize: { user: "username", password: "password" }, # Used for authenticating with basic auth
   wait_for_idle_options: { connections: 0, duration: 0.05, timeout: 5 }, # Used for setting network wait_for_idle options
   timeout_if_open_connections: true,
+  viewport: { width: 1200, height: 800, scale_factor: 3 } # Used for setting the viewport dimensions and device scale factor (DPR) when rendering the page
 
   pdf_options: {
     landscape: false, # paper orientation
@@ -190,6 +191,7 @@ FerrumPdf.configure do |config|
   config.page_options.authorize = { user: "username", password: "password" }
   config.page_options.wait_for_idle_options = { timeout: 90 }
   config.page_options.retries = 3
+  config.page_options.viewport = { width: 1200, height: 800, scale_factor: 3 }
 
   config.pdf_options.margin_top = 0.2
   config.pdf_options.margin_bottom = 0.2

data/lib/ferrum_pdf/renderers.rb

@@ -0,0 +1,19 @@
+ActiveSupport.on_load(:action_controller) do
+  # render ferrum_pdf: { pdf options }, template: "whatever", disposition: :inline, filename: "example.pdf"
+  ActionController.add_renderer :ferrum_pdf do |pdf_options, options|
+    send_data_options = options.extract!(:disposition, :filename, :status)
+    url = pdf_options.delete(:url)
+    html = render_to_string(**options.with_defaults(formats: [ :html ])) if url.blank?
+    pdf = FerrumPdf.render_pdf(html: html, display_url: request.original_url, url: url, pdf_options: pdf_options)
+    send_data(pdf, **send_data_options.with_defaults(type: :pdf))
+  end
+
+  # render ferrum_screenshot: { pdf options }, template: "whatever", disposition: :inline, filename: "example.png"
+  ActionController.add_renderer :ferrum_screenshot do |screenshot_options, options|
+    send_data_options = options.extract!(:disposition, :filename, :status)
+    url = screenshot_options.delete(:url)
+    html = render_to_string(**options.with_defaults(formats: [ :html ])) if url.blank?
+    screenshot = FerrumPdf.render_screenshot(url: url, html: html, display_url: request.original_url, screenshot_options: screenshot_options)
+    send_data(screenshot, **send_data_options.with_defaults(type: screenshot_options.fetch(:format, :png)))
+  end
+end

data/lib/ferrum_pdf/version.rb

@@ -1,3 +1,3 @@
 module FerrumPdf
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/ferrum_pdf.rb

@@ -1,6 +1,8 @@
-require "ferrum_pdf/version"
-require "ferrum_pdf/railtie"
 require "ferrum"
+require "action_controller"
+
+require "ferrum_pdf/renderers"
+require "ferrum_pdf/version"
 
 module FerrumPdf
   DEFAULT_HEADER_TEMPLATE = "<div class='date text left'></div><div class='title text center'></div>"
@@ -81,20 +83,24 @@ module FerrumPdf
       end
     end
 
+    private
+
     # Loads page into the browser to be used for rendering PDFs or screenshots
     #
-    def load_page(url: nil, html: nil, display_url: nil, authorize: nil, wait_for_idle_options: nil, timeout_if_open_connections: true, browser: nil, retries: nil)
+    def load_page(url: nil, html: nil, display_url: nil, authorize: nil, wait_for_idle_options: nil, timeout_if_open_connections: nil, browser: nil, retries: nil, viewport: nil)
       try ||= 0
       authorize ||= config.dig(:page_options, :authorize)
       retries ||= config.page_options.fetch(:retries, 1)
       wait_for_idle_options = config.page_options.fetch(:wait_for_idle_options, {}).merge(wait_for_idle_options || {})
-      timeout_if_open_connections ||= config.page_options.fetch(:timeout_if_open_connections, true)
+      timeout_if_open_connections = config.page_options.fetch(:timeout_if_open_connections, true) if timeout_if_open_connections.nil?
+      viewport ||= config.dig(:page_options, :viewport)
 
       with_browser(browser) do |browser|
         # Closes page automatically after block finishes
         # https://github.com/rubycdp/ferrum/blob/main/lib/ferrum/browser.rb#L169
         browser.create_page do |page|
           page.network.authorize(**authorize) { |req| req.continue } if authorize
+          page.set_viewport(**viewport) if viewport
 
           # Load content
           if html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -49,7 +49,7 @@ files:
 - README.md
 - Rakefile
 - lib/ferrum_pdf.rb
-- lib/ferrum_pdf/railtie.rb
+- lib/ferrum_pdf/renderers.rb
 - lib/ferrum_pdf/version.rb
 homepage: https://github.com/excid3/ferrum_pdf
 licenses:
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.2
 specification_version: 4
 summary: PDFs & screenshots for Rails using Ferrum & headless Chrome
 test_files: []

data/lib/ferrum_pdf/railtie.rb

@@ -1,25 +0,0 @@
-module FerrumPdf
-  class Railtie < ::Rails::Railtie
-    initializer "ferrum_pdf.controller" do
-      ActiveSupport.on_load(:action_controller) do
-        # render ferrum_pdf: { pdf options }, template: "whatever", disposition: :inline, filename: "example.pdf"
-        ActionController.add_renderer :ferrum_pdf do |pdf_options, options|
-          send_data_options = options.extract!(:disposition, :filename, :status)
-          url = pdf_options.delete(:url)
-          html = render_to_string(**options.with_defaults(formats: [ :html ])) if url.blank?
-          pdf = FerrumPdf.render_pdf(html: html, display_url: request.original_url, url: url, pdf_options: pdf_options)
-          send_data(pdf, **send_data_options.with_defaults(type: :pdf))
-        end
-
-        # render ferrum_screenshot: { pdf options }, template: "whatever", disposition: :inline, filename: "example.png"
-        ActionController.add_renderer :ferrum_screenshot do |screenshot_options, options|
-          send_data_options = options.extract!(:disposition, :filename, :status)
-          url = screenshot_options.delete(:url)
-          html = render_to_string(**options.with_defaults(formats: [ :html ])) if url.blank?
-          screenshot = FerrumPdf.render_screenshot(url: url, html: html, display_url: request.original_url, screenshot_options: screenshot_options)
-          send_data(screenshot, **send_data_options.with_defaults(type: screenshot_options.fetch(:format, :png)))
-        end
-      end
-    end
-  end
-end