ferrum_pdf 3.0.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe120091d2cc3eaaf6ce3e7fc5ccb3c34d3fabe59570986fa5b08d89295b58a
-  data.tar.gz: b3923cb2306e1cd27023725ddb088ae9f6ed290aab538db1e0d27bdb032d79cd
+  metadata.gz: 768ac72c382db28aed8f4d0957053bfe432bbdcf6d418f98a6a2940c6b0998cc
+  data.tar.gz: 23902eae3d0173d8db1a165f796d0e9a8437ebf037c623ad5b504d776a523343
 SHA512:
-  metadata.gz: 4e44f85006fc98e28298c2e3720b3066bc59611c32b439791df54d5b70e4dae5eaa62fabe1499d75f7f85599ff79e52ffee60485556f3b1167a1082aeb381702
-  data.tar.gz: 86ad9105c1a8e2bf3c867a91e0a409d045d5ffdbc6755bdfa5af02a7948271c32ab063a138f3ff09903daa3f100642ef8f328aea154cb4e316add75944d07680
+  metadata.gz: 31fa1ab95de7c58f4fb4b2c1afb35b2f8d982302656321c8916429260dc3a2e6d11aa128700e4ea52d602a7c0b15da8a7be263058a23893852b58b395c5f94b1
+  data.tar.gz: 1197dc9b1332b9e3eed2b0a9f5d1536ba426c1eaab2978594b4b97f5311a41521515dc0adf98be18d3f4c471ed25a15fa8785ad848a84c9773754f63002837da

data/README.md

@@ -70,11 +70,13 @@ FerrumPdf.render_pdf(
   url: "https://example.com/page", # Provide a URL to the content
 
   html: content, # or provide HTML
-  display_url: request.original_url, # When supplying content via :html its best to give Chrome a hint of the current url so that it can process relative paths in the document. If you don't provide this, http://example.com will be used instead.
+  display_url: request.original_url, # Base URL for resolving relative paths in :html. Defaults to FerrumPdf.config.page_options.display_url.
 
   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
+  javascript_enabled: true, # Set to false to prevent scripts in the page from running. Note: this does not block network requests (images, stylesheets, iframes) or meta refresh redirects.
 
   pdf_options: {
     landscape: false, # paper orientation
@@ -107,7 +109,7 @@ FerrumPdf.render_pdf(
 )
 ```
 
-See [Chrome DevTools Protocol docs](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF) and [Ferrum's `#pdf` docs](https://github.com/rubycdp/ferrum?tab=readme-ov-file#pdfoptions--string--boolean) for the full set of options.
+See [Chrome DevTools Protocol docs](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF) and [Ferrum's pdf docs](https://docs.rubycdp.com/docs/ferrum/screenshots/#pdfoptions--string--boolean) for the full set of options.
 
 ### 🎆 Screenshots
 
@@ -149,7 +151,7 @@ def show
 end
 ```
 
-See [Ferrum screenshot docs](https://github.com/rubycdp/ferrum?tab=readme-ov-file#screenshotoptions--string--integer) for the full set of options.
+See [Ferrum's screenshot docs](https://docs.rubycdp.com/docs/ferrum/screenshots/#screenshotoptions--string--integer) for the full set of options.
 
 #### Render Screenshots
 
@@ -167,7 +169,7 @@ FerrumPdf.render_screenshot(
   url: "https://example.com/page", # Provide a URL to the content
 
   html: content, # or provide HTML
-  display_url: request.original_url, # When supplying content via :html its best to give Chrome a hint of the current url so that it can process relative paths in the document. If you don't provide this, http://example.com will be used instead.
+  display_url: request.original_url, # Base URL for resolving relative paths in :html. Defaults to FerrumPdf.config.page_options.display_url.
 
   screenshot_options: {
     format: "png" # or "jpeg"
@@ -190,6 +192,9 @@ 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.page_options.javascript_enabled = false
+  config.page_options.display_url = "https://example.org"
 
   config.pdf_options.margin_top = 0.2
   config.pdf_options.margin_bottom = 0.2
@@ -205,7 +210,7 @@ end
 
 You can set the default browser options with the configure block.
 
-See [Ferrum's Customization docs](https://github.com/rubycdp/ferrum?tab=readme-ov-file#customization) for a full list of options.
+See [Ferrum's Customization docs](https://docs.rubycdp.com/docs/ferrum/customization) for a full list of options.
 
 ```ruby
 FerrumPdf.configure do |config|

data/lib/ferrum_pdf/version.rb

@@ -1,3 +1,3 @@
 module FerrumPdf
-  VERSION = "3.0.1"
+  VERSION = "3.2.0"
 end

data/lib/ferrum_pdf.rb

@@ -5,6 +5,9 @@ require "ferrum_pdf/renderers"
 require "ferrum_pdf/version"
 
 module FerrumPdf
+  # Reserved .invalid TLD so relative paths fail fast on DNS instead of hanging
+  # against a domain we don't control.
+  DEFAULT_DISPLAY_URL = "http://ferrum-pdf.invalid"
   DEFAULT_HEADER_TEMPLATE = "<div class='date text left'></div><div class='title text center'></div>"
   DEFAULT_FOOTER_TEMPLATE = <<~HTML
     <div class='url text left grow'></div>
@@ -44,8 +47,9 @@ module FerrumPdf
         yield browser
       else
         browser_mutex.synchronize do
+          discard_unusable_browser
           @@browser ||= Ferrum::Browser.new(config.except(:page_options, :pdf_options, :screenshot_options))
-          @@browser.restart unless @@browser.client.present?
+          @@browser.restart if @@browser.client.nil?
           yield @@browser
         end
       end
@@ -85,20 +89,41 @@ module FerrumPdf
 
     private
 
+    # A browser whose start died between Client.new and Contexts.new keeps a client but no
+    # contexts, and #restart cannot repair it: quit dereferences the nil contexts. Drop it and
+    # release the process and socket it still holds, so the next call builds a fresh browser.
+    def discard_unusable_browser
+      return if @@browser.nil? || @@browser.client.nil? || !@@browser.contexts.nil?
+
+      begin
+        @@browser.process&.stop
+        @@browser.client&.close
+      ensure
+        @@browser = nil
+      end
+    end
+
     # 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: nil, 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, javascript_enabled: 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) if timeout_if_open_connections.nil?
+      viewport ||= config.dig(:page_options, :viewport)
+      display_url ||= config.dig(:page_options, :display_url)
+      javascript_enabled = config.page_options.fetch(:javascript_enabled, true) if javascript_enabled.nil?
 
       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
+
+          # Has to happen before #go_to, otherwise inline scripts have already run.
+          page.disable_javascript unless javascript_enabled
 
           # Load content
           if html
@@ -112,7 +137,7 @@ module FerrumPdf
                 request.respond(body: html.blank? ? " " : html)
               end
             end
-            page.go_to(display_url || "http://example.com")
+            page.go_to(display_url || DEFAULT_DISPLAY_URL)
           else
             page.go_to(url)
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.18
 specification_version: 4
 summary: PDFs & screenshots for Rails using Ferrum & headless Chrome
 test_files: []