ferrum_pdf 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ea0c6aba4254ef7d958dec7d9f51048ce82e106ab068a413c1e3b83ec470b01
-  data.tar.gz: e34df1014f457e4ad42a41a5a29ab9a0d0ab42027cb8d8374aeacf6557a49833
+  metadata.gz: f7537d25768b2cf12df0322c63ad643c5a56dfbce85d812db0cab2f46e5f280a
+  data.tar.gz: b36728c8686eacf59543f756ff2c3daddc20a4d9eb806580dd87faa732471cf0
 SHA512:
-  metadata.gz: 68e840f65f0c0821cb8dfe6f3e249e2b5b567f8d3655c1a71a59f143beb25241aedea29fe33d95b18763a32fd5eea88bec9f6a9f4b0b6181df082544cc2453c2
-  data.tar.gz: 123f094697e37dcee391c157ca5ba379b1b9557e8a4e7c017cb7b45861936bf24e484bec74092793dd3e64e36ffaee0a98bc613f56ed9a5e4e2dfefdbf7f1ac1
+  metadata.gz: 8f1b5d33362700a1ed42ff99068b968dc696fdb6f573b5c59f1f7be0207dc891cad8dd13994d8881fcb8a49ed774ed7aa7312445ccc15955f243dea30a8b66ce
+  data.tar.gz: 702c650ee2f84c7eee9562cd989cb938dac2e7ca3dfe2d0e800b9315882e6309817743c639e1f8b9b47ecb2d775a1cb023a33cc68f4ef84f526aa62247358e3d

data/README.md

@@ -28,10 +28,20 @@ end
 You can also customize which template is rendered:
 
 ```ruby
-render_pdf(name = action_name, formats: [ :html ])
+render_pdf(name = action_name, formats: [ :html ], pdf_options: {})
 ```
 
-This will render the template to string, then pass it along to FerrumPdf.
+This will render the template to string with `render_to_string` in Rails, then pass it along to FerrumPdf.
+
+For example, you can add headers and footers using `pdf_options`
+
+```ruby
+render_pdf(pdf_options: {
+  display_header_footer: true,
+  header_template: FerrumPdf::DEFAULT_HEADER_TEMPLATE,
+  footer_template: FerrumPdf::DEFAULT_FOOTER_TEMPLATE
+})
+```
 
 ### Directly with HTML
 
@@ -47,10 +57,14 @@ You can also pass host and protocol to convert any relative paths to full URLs.
 FerrumPdf.render_pdf(
   html: content,
   host: request.host_with_port,
-  protocol: request.protocol
+  protocol: request.protocol,
+  pdf_options: {}
 )
 ```
 
+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
+
 ## Contributing
 
 If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.

data/lib/ferrum_pdf/version.rb

@@ -1,3 +1,3 @@
 module FerrumPdf
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/ferrum_pdf.rb

@@ -4,22 +4,25 @@ require "ferrum_pdf/railtie"
 require "ferrum"
 
 module FerrumPdf
+  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>
+    <div class='text right'><span class='pageNumber'></span>/<span class='totalPages'></span></div>
+  HTML
+
   def self.browser(**options)
     @browser ||= Ferrum::Browser.new(options)
   end
 
-  def self.render_pdf(host:, protocol:, html: nil, url: nil)
-    Tempfile.create do |file|
-      browser.create_page do |page|
-        if html
-          page.content = FerrumPdf::HTMLPreprocessor.process(html, host, protocol)
-          page.network.wait_for_idle
-        else
-          page.go_to(url)
-        end
-        page.pdf(path: file.path)
-        file.read
+  def self.render_pdf(host:, protocol:, html: nil, url: nil, pdf_options: {})
+    browser.create_page do |page|
+      if html
+        page.content = FerrumPdf::HTMLPreprocessor.process(html, host, protocol)
+        page.network.wait_for_idle
+      else
+        page.go_to(url)
       end
+      page.pdf(**pdf_options.with_defaults(encoding: :binary))
     end
   end
 
@@ -51,13 +54,14 @@ module FerrumPdf
   module Controller
     extend ActiveSupport::Concern
 
-    def render_pdf(name = action_name, formats: [ :html ])
+    def render_pdf(name = action_name, formats: [ :html ], pdf_options: {})
       content = render_to_string(name, formats: formats)
 
       FerrumPdf.render_pdf(
         html: content,
         host: request.host_with_port,
-        protocol: request.protocol
+        protocol: request.protocol,
+        pdf_options: pdf_options
       )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: PDFs for Rails using Ferrum & headless Chrome