ferrum_pdf 2.1.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e10a66bff6f06cfd7388c12247ca55e92a79bc48ff741e889e0ac0bfde0286e0
-  data.tar.gz: 2a92a79c5a7ca34091644fcd5795d1d1c84d49f7d834f02afd6d9ec462ba892b
+  metadata.gz: efe120091d2cc3eaaf6ce3e7fc5ccb3c34d3fabe59570986fa5b08d89295b58a
+  data.tar.gz: b3923cb2306e1cd27023725ddb088ae9f6ed290aab538db1e0d27bdb032d79cd
 SHA512:
-  metadata.gz: c6d4472cb10faebb29ab64634f16063c7aac7927baf76e3e58dc72478d3d21819935138e6595a872f9e0766ff51a17303cad51a1857d62110b2e13fd4877234f
-  data.tar.gz: 9915cadbed613d26c113a57d5a23268ec3758ef9f566b5f6f387469ed4cce948d5348173a840cf9d36a44d935fda1a3e5f7cb06af5c5f042d73f2fb06707a892
+  metadata.gz: 4e44f85006fc98e28298c2e3720b3066bc59611c32b439791df54d5b70e4dae5eaa62fabe1499d75f7f85599ff79e52ffee60485556f3b1167a1082aeb381702
+  data.tar.gz: 86ad9105c1a8e2bf3c867a91e0a409d045d5ffdbc6755bdfa5af02a7948271c32ab063a138f3ff09903daa3f100642ef8f328aea154cb4e316add75944d07680

data/README.md

@@ -1,6 +1,6 @@
 # 📄 FerrumPdf
 
-PDFs & screentshots for Rails using [Ferrum](https://github.com/rubycdp/ferrum) & headless Chrome.
+PDFs & screenshots for Rails using [Ferrum](https://github.com/rubycdp/ferrum) & headless Chrome.
 
 Inspired by [Grover](https://github.com/Studiosity/grover), but without the Node.js and puppeteer dependencies. 🎉
 
@@ -70,10 +70,11 @@ FerrumPdf.render_pdf(
   url: "https://example.com/page", # Provide a URL to the content
 
   html: content, # or provide HTML
-  base_url: request.base_url, # Preprocesses `html` to convert relative paths and protocols. Example: "https://example.org"
+  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.
 
   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,
 
   pdf_options: {
     landscape: false, # paper orientation
@@ -166,7 +167,7 @@ FerrumPdf.render_screenshot(
   url: "https://example.com/page", # Provide a URL to the content
 
   html: content, # or provide HTML
-  base_url: request.base_url, # Preprocesses `html` to convert relative paths and protocols. Example: "https://example.org"
+  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.
 
   screenshot_options: {
     format: "png" # or "jpeg"
@@ -186,7 +187,6 @@ You can set default values for page loads, PDF renders, and screenshot renders w
 
 ```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

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 = "2.1.0"
+  VERSION = "3.0.1"
 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>"
@@ -9,9 +11,6 @@ module FerrumPdf
     <div class='text right'><span class='pageNumber'></span>/<span class='totalPages'></span></div>
   HTML
 
-  autoload :AssetsHelper, "ferrum_pdf/assets_helper"
-  autoload :HTMLPreprocessor, "ferrum_pdf/html_preprocessor"
-
   mattr_accessor :browser_mutex, default: Mutex.new
   mattr_accessor :config, default: ActiveSupport::OrderedOptions.new.merge(
     window_size: [ 1920, 1080 ],
@@ -57,9 +56,9 @@ module FerrumPdf
     #   render_pdf(url: "https://example.org/receipts/example.pdf")
     #   render_pdf(html: "<h1>Hello world</h1>")
     #
-    # For rendering HTML, we also need the base_url for preprocessing URLs with relative paths & protocols
+    # For rendering HTML, we also need display_url for so that Chrome can interpret URLs with relative paths & protocols
     #
-    #   render_pdf(html: "<h1>Hello world</h1>", base_url: "https://example.org/")
+    #   render_pdf(html: "<h1>Hello world</h1>", display_url: "https://example.org/hello_world")
     #
     def render_pdf(pdf_options: {}, **load_page_args)
       load_page(**load_page_args) do |browser, page|
@@ -73,9 +72,9 @@ module FerrumPdf
     # render_screenshot(url: "https://example.org/receipts/example.pdf")
     # render_screenshot(html: "<h1>Hello world</h1>")
     #
-    # For rendering HTML, we also need the base_url for preprocessing URLs with relative paths & protocols
+    # For rendering HTML, we also need display_url for so that Chrome can interpret URLs with relative paths & protocols
     #
-    #   render_screenshot(html: "<h1>Hello world</h1>", base_url: "https://example.org/")
+    #   render_screenshot(html: "<h1>Hello world</h1>", display_url: "https://example.org/hello_world")
     #
     def render_screenshot(screenshot_options: {}, **load_page_args)
       load_page(**load_page_args) do |browser, page|
@@ -84,16 +83,16 @@ module FerrumPdf
       end
     end
 
+    private
+
     # Loads page into the browser to be used for rendering PDFs or screenshots
     #
-    # 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: 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)
       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 || {})
+      timeout_if_open_connections = config.page_options.fetch(:timeout_if_open_connections, true) if timeout_if_open_connections.nil?
 
       with_browser(browser) do |browser|
         # Closes page automatically after block finishes
@@ -103,13 +102,24 @@ module FerrumPdf
 
           # Load content
           if html
-            page.content = FerrumPdf::HTMLPreprocessor.process(html, base_url)
+            html_intercepted = false
+            page.network.intercept
+            page.on(:request) do |request|
+              if html_intercepted
+                request.continue
+              else
+                html_intercepted = true
+                request.respond(body: html.blank? ? " " : html)
+              end
+            end
+            page.go_to(display_url || "http://example.com")
           else
             page.go_to(url)
           end
 
           # Wait for everything to load
-          page.network.wait_for_idle!(**wait_for_idle_options)
+          idle = page.network.wait_for_idle(**wait_for_idle_options)
+          raise Ferrum::TimeoutError if timeout_if_open_connections && !idle
 
           yield browser, page
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.1
 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,9 +49,7 @@ files:
 - README.md
 - Rakefile
 - lib/ferrum_pdf.rb
-- lib/ferrum_pdf/assets_helper.rb
-- lib/ferrum_pdf/html_preprocessor.rb
-- lib/ferrum_pdf/railtie.rb
+- lib/ferrum_pdf/renderers.rb
 - lib/ferrum_pdf/version.rb
 homepage: https://github.com/excid3/ferrum_pdf
 licenses:
@@ -74,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.6.9
 specification_version: 4
 summary: PDFs & screenshots for Rails using Ferrum & headless Chrome
 test_files: []

data/lib/ferrum_pdf/assets_helper.rb

@@ -1,65 +0,0 @@
-module FerrumPdf
-  class BaseAsset
-    def initialize(asset)
-      @asset = asset
-    end
-  end
-
-  class PropshaftAsset < BaseAsset
-    def content_type
-      @asset.content_type.to_s
-    end
-
-    def content
-      @asset.content
-    end
-  end
-
-  class SprocketsAsset < BaseAsset
-    def content_type
-      @asset.content_type
-    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
-      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
-    end
-  end
-
-  module AssetsHelper
-    def ferrum_pdf_inline_stylesheet(path)
-      (asset = AssetFinder.find(path)) ? "<style>#{asset.content}</style>".html_safe : nil
-    end
-
-    def ferrum_pdf_inline_javascript(path)
-      (asset = AssetFinder.find(path)) ? "<script>#{asset.content}</script>".html_safe : nil
-    end
-
-    def ferrum_pdf_base64_asset(path)
-      return nil unless (asset = AssetFinder.find(path))
-
-      "data:#{asset.content_type};base64,#{Base64.encode64(asset.content).gsub(/\s+/, '')}"
-    end
-  end
-end

data/lib/ferrum_pdf/html_preprocessor.rb

@@ -1,33 +0,0 @@
-module FerrumPdf
-  # Helper module for preparing HTML for conversion
-  #
-  # Sourced from the PDFKit project
-  # @see https://github.com/pdfkit/pdfkit
-  module HTMLPreprocessor
-    # Change relative paths to absolute, and relative protocols to absolute protocols
-    #
-    #   process("Some HTML", "https://example.org")
-    #
-    def self.process(html, base_url)
-      return html if base_url.blank?
-
-      base_url += "/" unless base_url.end_with? "/"
-      protocol = base_url.split("://").first
-      html = translate_relative_paths(html, base_url) if base_url
-      html = translate_relative_protocols(html, protocol) if protocol
-      html
-    end
-
-    def self.translate_relative_paths(html, base_url)
-      # Try out this regexp using rubular http://rubular.com/r/hiAxBNX7KE
-      html.gsub(%r{(href|src)=(['"])/([^/"']([^"']*|[^"']*))?['"]}, "\\1=\\2#{base_url}\\3\\2")
-    end
-    private_class_method :translate_relative_paths
-
-    def self.translate_relative_protocols(body, protocol)
-      # Try out this regexp using rubular http://rubular.com/r/0Ohk0wFYxV
-      body.gsub(%r{(href|src)=(['"])//([^"']*|[^"']*)['"]}, "\\1=\\2#{protocol}://\\3\\2")
-    end
-    private_class_method :translate_relative_protocols
-  end
-end

data/lib/ferrum_pdf/railtie.rb

@@ -1,31 +0,0 @@
-module FerrumPdf
-  class Railtie < ::Rails::Railtie
-    initializer "ferrum_pdf.assets_helper" do
-      ActiveSupport.on_load(:action_view) do
-        include FerrumPdf::AssetsHelper
-      end
-    end
-
-    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, 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
-end