ferrum_pdf 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1356ce4acb8121982cca17f42a53f88595cdf6004101d60e4192d912fb6a699
-  data.tar.gz: 12cfdc58b24168b8a45f6239d668ba49f4443ea928b51554189dd565d34c15d8
+  metadata.gz: e10a66bff6f06cfd7388c12247ca55e92a79bc48ff741e889e0ac0bfde0286e0
+  data.tar.gz: 2a92a79c5a7ca34091644fcd5795d1d1c84d49f7d834f02afd6d9ec462ba892b
 SHA512:
-  metadata.gz: e9078a7f52c54d9aed0b6b2840a136853c306a9f4414f92cc3c6ca5649e68b31ead2798ab9a8ec91848709222e67be188bebc570d72e150e56a1d697e19acedd
-  data.tar.gz: f7947db380dcc18275a9df3a437240d4affe52a4809d7cabdb50a46a34cbf22b93ea67c7278e3cf6a41bf75a7556cf4481f32a5c6e9bc7fd5333a149b52e70d0
+  metadata.gz: c6d4472cb10faebb29ab64634f16063c7aac7927baf76e3e58dc72478d3d21819935138e6595a872f9e0766ff51a17303cad51a1857d62110b2e13fd4877234f
+  data.tar.gz: 9915cadbed613d26c113a57d5a23268ec3758ef9f566b5f6f387469ed4cce948d5348173a840cf9d36a44d935fda1a3e5f7cb06af5c5f042d73f2fb06707a892

data/README.md

@@ -4,11 +4,11 @@ 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. 🎉
 
-## Installation
+<img src="ferrum_pdf.png" alt="logo" style="width:450px;"/>
 
-First, make sure Chrome is installed.
+## Installation
 
-Run the following or add the gem to your Gemfile:
+First, make sure Chrome is installed. Then run the following or add the gem to your Gemfile:
 
 ```ruby
 bundle add "ferrum_pdf"
@@ -22,21 +22,18 @@ You can use FerrumPdf to render [PDFs](#-pdfs) and [Screenshots](#-screenshots)
 
 There are two ways to render PDFs:
 
+* [`render ferrum_pdf: {}` in Rails](#render-pdfs-from-rails-controllers)
 * [FerrumPdf.render_pdf](#render-pdfs)
-* [render_pdf in Rails](#render-pdfs-from-rails-controllers)
 
 #### Render PDFs from Rails controllers
 
-Use the `render_pdf` helper in Rails controllers to render a PDF from the current action.
+Use the `ferrum_pdf` renderer in Rails controllers to render a PDF from the current action.
 
 ```ruby
 def show
   respond_to do |format|
     format.html
-    format.pdf {
-      pdf = render_pdf()
-      send_data pdf, disposition: :inline, filename: "example.pdf"
-    }
+    format.pdf { render ferrum_pdf: {}, disposition: :inline, filename: "example.pdf" }
   end
 end
 ```
@@ -44,14 +41,17 @@ 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_pdf(
-  layout: "pdf,
-  pdf_options: {
+def show
+  render ferrum_pdf: {
     display_header_footer: true,
     header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
     footer_template: FerrumPdf::DEFAULT_FOOTER_TEMPLATE
-  }
-)
+  },
+  layout: "pdf",
+  template: "pdf",
+  disposition: :inline,
+  filename: "example.pdf"
+end
 ```
 
 #### Render PDFs
@@ -112,21 +112,18 @@ See [Chrome DevTools Protocol docs](https://chromedevtools.github.io/devtools-pr
 
 There are two ways to render Screenshots:
 
+* [`render ferrum_screenshot: {}` in Rails](#render-screenshots-from-rails-controllers)
 * [FerrumPdf.render_screenshot](#render-screenshots)
-* [render_screenshot in Rails](#render-screenshots-from-rails-controllers)
 
 #### Render Screenshots from Rails controllers
 
-Use the `render_screenshot` helper in Rails controllers to render a PDF from the current action.
+Use the `ferrum_screenshot` renderer in Rails controllers to render a PDF from the current action.
 
 ```ruby
 def show
   respond_to do |format|
     format.html
-    format.png {
-      screenshot = render_screenshot()
-      send_data screenshot, disposition: :inline, filename: "example.png"
-    }
+    format.png { render ferrum_screenshot: {}, disposition: :inline, filename: "example.png" }
   end
 end
 ```
@@ -134,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_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
@@ -143,8 +140,12 @@ render_screenshot(
     area: nil # Hash area for screenshot, optional. {x: 0, y: 0, width: 100, height: 100}
     scale: nil # Float zoom in/out
     background_color: nil # Ferrum::RGBA.new(0, 0, 0, 0.0)
-  }
-)
+  },
+  layout: "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.
@@ -179,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.
 
@@ -212,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/assets_helper.rb

@@ -1,53 +1,53 @@
 module FerrumPdf
-  module AssetsHelper
-    class BaseAsset
-      def initialize(asset)
-        @asset = asset
-      end
+  class BaseAsset
+    def initialize(asset)
+      @asset = asset
     end
+  end
 
-    class PropshaftAsset < BaseAsset
-      def content_type
-        @asset.content_type.to_s
-      end
+  class PropshaftAsset < BaseAsset
+    def content_type
+      @asset.content_type.to_s
+    end
 
-      def content
-        @asset.content
-      end
+    def content
+      @asset.content
     end
+  end
 
-    class SprocketsAsset < BaseAsset
-      def content_type
-        @asset.content_type
-      end
+  class SprocketsAsset < BaseAsset
+    def content_type
+      @asset.content_type
+    end
 
-      def content
-        @asset.source
-      end
+    def content
+      @asset.source
     end
+  end
 
-    class AssetFinder
-      class << self
-        def find(path)
-          if Rails.application.assets.respond_to?(:load_path)
-            propshaft_asset(path)
-          elsif Rails.application.assets.respond_to?(:find_asset)
-            sprockets_asset(path)
-          else
-            nil
-          end
+  class AssetFinder
+    class << self
+      def find(path)
+        if Rails.application.assets.respond_to?(:load_path)
+          propshaft_asset(path)
+        elsif Rails.application.assets.respond_to?(:find_asset)
+          sprockets_asset(path)
+        else
+          nil
         end
+      end
 
-        def propshaft_asset(path)
-          (asset = Rails.application.assets.load_path.find(path)) ? PropshaftAsset.new(asset) : nil
-        end
+      def propshaft_asset(path)
+        (asset = Rails.application.assets.load_path.find(path)) ? PropshaftAsset.new(asset) : nil
+      end
 
-        def sprockets_asset(path)
-          (asset = Rails.application.assets.find_asset(path)) ? SprocketsAsset.new(asset) : nil
-        end
+      def sprockets_asset(path)
+        (asset = Rails.application.assets.find_asset(path)) ? SprocketsAsset.new(asset) : nil
       end
     end
+  end
 
+  module AssetsHelper
     def ferrum_pdf_inline_stylesheet(path)
       (asset = AssetFinder.find(path)) ? "<style>#{asset.content}</style>".html_safe : nil
     end

data/lib/ferrum_pdf/railtie.rb

@@ -2,13 +2,29 @@ module FerrumPdf
   class Railtie < ::Rails::Railtie
     initializer "ferrum_pdf.assets_helper" do
       ActiveSupport.on_load(:action_view) do
-        include FerrumPdf::AssetsHelper if FerrumPdf.include_assets_helper_module
+        include FerrumPdf::AssetsHelper
       end
     end
 
     initializer "ferrum_pdf.controller" do
       ActiveSupport.on_load(:action_controller) do
-        include FerrumPdf::Controller if FerrumPdf.include_controller_module
+        # 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, base_url: request.base_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, base_url: request.base_url, screenshot_options: screenshot_options)
+          send_data(screenshot, **send_data_options.with_defaults(type: screenshot_options.fetch(:format, :png)))
+        end
       end
     end
   end

data/lib/ferrum_pdf/version.rb

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

data/lib/ferrum_pdf.rb

@@ -10,14 +10,14 @@ module FerrumPdf
   HTML
 
   autoload :AssetsHelper, "ferrum_pdf/assets_helper"
-  autoload :Controller, "ferrum_pdf/controller"
   autoload :HTMLPreprocessor, "ferrum_pdf/html_preprocessor"
 
   mattr_accessor :browser_mutex, default: Mutex.new
-  mattr_accessor :include_assets_helper_module, default: true
-  mattr_accessor :include_controller_module, default: true
   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
@@ -45,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
@@ -64,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
 
@@ -80,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
 
@@ -88,8 +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
+    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
@@ -105,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: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -50,11 +50,9 @@ files:
 - Rakefile
 - lib/ferrum_pdf.rb
 - lib/ferrum_pdf/assets_helper.rb
-- lib/ferrum_pdf/controller.rb
 - 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
@@ -76,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/ferrum_pdf/controller.rb

@@ -1,27 +0,0 @@
-module FerrumPdf
-  module Controller
-    extend ActiveSupport::Concern
-
-    def render_pdf(pdf_options: {}, **rendering, &block)
-      content = render_to_string(**rendering.with_defaults(formats: [ :html ]))
-
-      FerrumPdf.render_pdf(
-        html: content,
-        base_url: request.base_url,
-        pdf_options: pdf_options,
-        &block
-      )
-    end
-
-    def render_screenshot(screenshot_options: {}, **rendering, &block)
-      content = render_to_string(**rendering.with_defaults(formats: [ :html ]))
-
-      FerrumPdf.render_screenshot(
-        html: content,
-        base_url: request.base_url,
-        screenshot_options: screenshot_options,
-        &block
-      )
-    end
-  end
-end

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