ferrum_pdf 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1356ce4acb8121982cca17f42a53f88595cdf6004101d60e4192d912fb6a699
-  data.tar.gz: 12cfdc58b24168b8a45f6239d668ba49f4443ea928b51554189dd565d34c15d8
+  metadata.gz: 9ad1aec4cf5dc3fd72ee568cc2e963d14be0d1d7934efc082dba0ec92368fd16
+  data.tar.gz: 80a623342478906fc8b2fff9ac7067218387271ac4416c3492f8a1d759c7ec0d
 SHA512:
-  metadata.gz: e9078a7f52c54d9aed0b6b2840a136853c306a9f4414f92cc3c6ca5649e68b31ead2798ab9a8ec91848709222e67be188bebc570d72e150e56a1d697e19acedd
-  data.tar.gz: f7947db380dcc18275a9df3a437240d4affe52a4809d7cabdb50a46a34cbf22b93ea67c7278e3cf6a41bf75a7556cf4481f32a5c6e9bc7fd5333a149b52e70d0
+  metadata.gz: 3ffa22c676e622ee3361ef927c87f3ff91f73e74465f69c63252406cdd27714356fadd66c960b5731ede0262e7af7f4c1649704328768d4e89baab2c6031d508
+  data.tar.gz: e7e1f120c6739e88927ee62dba5974ef480ca715e846835b1d307a16f577667733e53cc6a9afb84cf172616f319a134aeb26a290fb1a6790d1cef4555d2fb293

data/README.md

@@ -6,9 +6,7 @@ Inspired by [Grover](https://github.com/Studiosity/grover), but without the Node
 
 ## Installation
 
-First, make sure Chrome is installed.
-
-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 +20,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 +39,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,
+render ferrum_pdf: {
   pdf_options: {
     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"
+}
 ```
 
 #### Render PDFs
@@ -112,21 +110,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,7 +129,7 @@ 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(
+render ferrum_screenshot: {
   screenshot_options: {
     format: "png" # or "jpeg"
     quality: nil # Integer 0-100 works for jpeg only
@@ -143,8 +138,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"
+}
 ```
 
 See [Ferrum screenshot docs](https://github.com/rubycdp/ferrum?tab=readme-ov-file#screenshotoptions--string--integer) for the full set of options.

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.0.0"
 end

data/lib/ferrum_pdf.rb

@@ -10,12 +10,9 @@ 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 ]
   )
@@ -90,6 +87,7 @@ module FerrumPdf
     #
     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 ||= {}
 
       with_browser(browser) do |browser|
         # Closes page automatically after block finishes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -50,7 +50,6 @@ 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

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