ferrum_pdf 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ad1aec4cf5dc3fd72ee568cc2e963d14be0d1d7934efc082dba0ec92368fd16
-  data.tar.gz: 80a623342478906fc8b2fff9ac7067218387271ac4416c3492f8a1d759c7ec0d
+  metadata.gz: e10a66bff6f06cfd7388c12247ca55e92a79bc48ff741e889e0ac0bfde0286e0
+  data.tar.gz: 2a92a79c5a7ca34091644fcd5795d1d1c84d49f7d834f02afd6d9ec462ba892b
 SHA512:
-  metadata.gz: 3ffa22c676e622ee3361ef927c87f3ff91f73e74465f69c63252406cdd27714356fadd66c960b5731ede0262e7af7f4c1649704328768d4e89baab2c6031d508
-  data.tar.gz: e7e1f120c6739e88927ee62dba5974ef480ca715e846835b1d307a16f577667733e53cc6a9afb84cf172616f319a134aeb26a290fb1a6790d1cef4555d2fb293
+  metadata.gz: c6d4472cb10faebb29ab64634f16063c7aac7927baf76e3e58dc72478d3d21819935138e6595a872f9e0766ff51a17303cad51a1857d62110b2e13fd4877234f
+  data.tar.gz: 9915cadbed613d26c113a57d5a23268ec3758ef9f566b5f6f387469ed4cce948d5348173a840cf9d36a44d935fda1a3e5f7cb06af5c5f042d73f2fb06707a892

data/README.md

@@ -4,6 +4,8 @@ PDFs & screentshots for Rails using [Ferrum](https://github.com/rubycdp/ferrum)
 
 Inspired by [Grover](https://github.com/Studiosity/grover), but without the Node.js and puppeteer dependencies. 🎉
 
+<img src="ferrum_pdf.png" alt="logo" style="width:450px;"/>
+
 ## Installation
 
 First, make sure Chrome is installed. Then run the following or add the gem to your Gemfile:
@@ -39,8 +41,8 @@ end
 You can also customize which template is rendered. This will render the template to string with `render_to_string` in Rails, then pass it along to Chrome. For example, you can add headers and footers using `pdf_options` and use a specific layout:
 
 ```ruby
-render ferrum_pdf: {
-  pdf_options: {
+def show
+  render ferrum_pdf: {
     display_header_footer: true,
     header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
     footer_template: FerrumPdf::DEFAULT_FOOTER_TEMPLATE
@@ -49,7 +51,7 @@ render ferrum_pdf: {
   template: "pdf",
   disposition: :inline,
   filename: "example.pdf"
-}
+end
 ```
 
 #### Render PDFs
@@ -129,8 +131,8 @@ end
 You can also customize which template is rendered. This will render the template to string with `render_to_string` in Rails, then pass it along to Chrome.
 
 ```ruby
-render ferrum_screenshot: {
-  screenshot_options: {
+def show
+  render ferrum_screenshot: {
     format: "png" # or "jpeg"
     quality: nil # Integer 0-100 works for jpeg only
     full: true # Boolean whether you need full page screenshot or a viewport
@@ -140,10 +142,10 @@ render ferrum_screenshot: {
     background_color: nil # Ferrum::RGBA.new(0, 0, 0, 0.0)
   },
   layout: "example",
-  template: "example"
+  template: "example",
   disposition: :inline,
   filename: "example.png"
-}
+end
 ```
 
 See [Ferrum screenshot docs](https://github.com/rubycdp/ferrum?tab=readme-ov-file#screenshotoptions--string--integer) for the full set of options.
@@ -178,7 +180,28 @@ FerrumPdf.render_screenshot(
 )
 ```
 
-## Configuring the Browser
+## Configuration
+
+You can set default values for page loads, PDF renders, and screenshot renders with the configure block.
+
+```ruby
+FerrumPdf.configure do |config|
+  config.page_options.base_url = "https://example.com/"
+  config.page_options.authorize = { user: "username", password: "password" }
+  config.page_options.wait_for_idle_options = { timeout: 90 }
+  config.page_options.retries = 3
+
+  config.pdf_options.margin_top = 0.2
+  config.pdf_options.margin_bottom = 0.2
+  config.pdf_options.margin_left = 0.2
+  config.pdf_options.margin_right = 0.2
+
+  config.screenshot_options.format = :png
+  config.screenshot_options.full = false
+end
+```
+
+### Configuring the Browser
 
 You can set the default browser options with the configure block.
 
@@ -211,7 +234,7 @@ RUN apt-get update && apt-get install gnupg wget -y && \
     rm -rf /var/lib/apt/lists/*
 ```
 
-### Browser Management
+#### Browser Management
 
 FerrumPdf uses a single browser instance per Ruby process that is automatically created when needed using your configuration settings:
 

data/lib/ferrum_pdf/version.rb

@@ -1,3 +1,3 @@
 module FerrumPdf
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/ferrum_pdf.rb

@@ -14,7 +14,10 @@ module FerrumPdf
 
   mattr_accessor :browser_mutex, default: Mutex.new
   mattr_accessor :config, default: ActiveSupport::OrderedOptions.new.merge(
-    window_size: [ 1920, 1080 ]
+    window_size: [ 1920, 1080 ],
+    page_options: ActiveSupport::OrderedOptions.new,
+    pdf_options: ActiveSupport::OrderedOptions.new,
+    screenshot_options: ActiveSupport::OrderedOptions.new
   )
 
   # This doesn't use mattr_accessor because having a `.browser` getter and also
@@ -42,7 +45,7 @@ module FerrumPdf
         yield browser
       else
         browser_mutex.synchronize do
-          @@browser ||= Ferrum::Browser.new(config)
+          @@browser ||= Ferrum::Browser.new(config.except(:page_options, :pdf_options, :screenshot_options))
           @@browser.restart unless @@browser.client.present?
           yield @@browser
         end
@@ -61,7 +64,7 @@ module FerrumPdf
     def render_pdf(pdf_options: {}, **load_page_args)
       load_page(**load_page_args) do |browser, page|
         yield browser, page if block_given?
-        page.pdf(**pdf_options.with_defaults(encoding: :binary))
+        page.pdf(**pdf_options.with_defaults(encoding: :binary, **config.pdf_options))
       end
     end
 
@@ -77,7 +80,7 @@ module FerrumPdf
     def render_screenshot(screenshot_options: {}, **load_page_args)
       load_page(**load_page_args) do |browser, page|
         yield browser, page if block_given?
-        page.screenshot(**screenshot_options.with_defaults(encoding: :binary, full: true))
+        page.screenshot(**screenshot_options.with_defaults(encoding: :binary, full: true, **config.screenshot_options))
       end
     end
 
@@ -85,9 +88,12 @@ module FerrumPdf
     #
     # This automatically applies HTML preprocessing if `html:` is present
     #
-    def load_page(url: nil, html: nil, base_url: nil, authorize: nil, wait_for_idle_options: nil, browser: nil, retries: 1)
-      try = 0
-      wait_for_idle_options ||= {}
+    def load_page(url: nil, html: nil, base_url: nil, authorize: nil, wait_for_idle_options: nil, browser: nil, retries: nil)
+      try ||= 0
+      authorize ||= config.dig(:page_options, :authorize)
+      base_url ||= config.dig(:page_options, :base_url)
+      retries ||= config.page_options.fetch(:retries, 1)
+      wait_for_idle_options = config.page_options.fetch(:wait_for_idle_options, {}).merge(wait_for_idle_options || {})
 
       with_browser(browser) do |browser|
         # Closes page automatically after block finishes
@@ -103,12 +109,12 @@ module FerrumPdf
           end
 
           # Wait for everything to load
-          page.network.wait_for_idle(**wait_for_idle_options)
+          page.network.wait_for_idle!(**wait_for_idle_options)
 
           yield browser, page
         end
       end
-    rescue Ferrum::DeadBrowserError
+    rescue Ferrum::DeadBrowserError, Ferrum::TimeoutError
       try += 1
       if try <= retries
         with_browser(&:restart)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -53,7 +53,6 @@ files:
 - lib/ferrum_pdf/html_preprocessor.rb
 - lib/ferrum_pdf/railtie.rb
 - lib/ferrum_pdf/version.rb
-- lib/tasks/ferrum_pdf_tasks.rake
 homepage: https://github.com/excid3/ferrum_pdf
 licenses:
 - MIT
@@ -75,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0
+rubygems_version: 3.7.1
 specification_version: 4
 summary: PDFs & screenshots for Rails using Ferrum & headless Chrome
 test_files: []

data/lib/tasks/ferrum_pdf_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :ferrum_pdf do
-#   # Task goes here
-# end