palapala_pdf 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 230cc525cd5e4bbc4d2ce9ddb0a418486bc27ad6163cef9834a67d7e23442b41
-  data.tar.gz: b283d90551ef07efe3384148b061ec0a6a18cb3bdbc9485c1e8717e6bc4979f3
+  metadata.gz: 3a5231c5a9994723db5fafc42682644a6320a69813444bc0939e179225e7181b
+  data.tar.gz: 5f3600f8fb867ee059e1a67fcda2eeeff0d7f290c8621d8bc055e6fb4cbda39c
 SHA512:
-  metadata.gz: cfcf738f7171f679d419349cce4ce0441bb3be54fc355fa9592222b04c63654d6646c6103310f8ddf56e7112a3ccc95b30ddb92db86e0ff48a12b221f8be039c
-  data.tar.gz: efa8277743d960b0d3e869ab970c8248a2f901b572d4451bf0c479c311eabbd2a810e678efad489913ced8ab2ada14e8ce7d4b4fbb7d3ccad61ce98f419ee1b2
+  metadata.gz: a50a38a6482f04f7af087b0469d0fcf0d5bc02e79f3ad2fe26a91c5b06aa07345fe15b99472355eab1daef95c3069d54e1d9990820b401872681172b278f43d2
+  data.tar.gz: 2697106dfcad72207bd20fcad857c9a474ffacf49a67fa10e1d2801a8b5c41226e9d9b7145066b78f6dc002dc951f706c1f5fd83c346b196674f59294d124bc0

data/README.md

@@ -18,6 +18,8 @@ And this while having the most modern HTML/CSS/JS availlable to you: flex, grid,
 
 A core goal of this project is performance, and it is designed to be exceptionally fast. By leveraging **direct communication** with a headless Chrome or Chromium browser via a **raw web socket**, the gem minimizes overhead and dependencies, enabling PDF generation at speeds that significantly outperform other solutions. Whether generating simple or complex documents, this gem ensures that your Ruby applications can handle PDF tasks efficiently and at scale.
 
+[Example: paged_css.pdf](https://raw.githubusercontent.com/palapala-app/palapala_pdf/main/examples/paged_css.pdf)
+
 ## Sponsor This Project
 
 If you find this project useful and would like to support its development, consider sponsoring or buying a coffee to help keep it going:
@@ -73,7 +75,7 @@ HEADLESS_CHROME_URL=http://192.168.1.1:9222 ruby examples/performance_benchmark.
 ```
 
 ```sh
-CHROME_HEADLESS_PATH=/var/to/chrome ruby examples/performance_benchmark.rb
+HEADLESS_CHROME_PATH=/var/to/chrome ruby examples/performance_benchmark.rb
 ```
 
 **Create a PDF from HTML**
@@ -95,6 +97,7 @@ binary_data = Palapala::Pdf.new("<h1>Hello, world! #{Time.now}</h1>").binary_dat
 ## Advanced Examples
 
 - headers and footers
+- watermark
 - paged css for paper sizes, paper margins, pages breaks, etc
 - js based rendering
 
@@ -187,7 +190,29 @@ In this example, `pdf_data` is the binary data of the PDF file. The `filename` o
 
 TODO
 
-*It has also been reported that the Chrome process repeatedly crashes when running inside a Docker container on an M1 Mac. Chrome should work as expected when deployed to a Docker container on a non-M1 Mac.*
+```Dockerfile
+# Install Nodejs and Chromium, to import the chrome headless shell dependencies easily (chrome itself is not used)
+RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - && apt-get install --no-install-recommends -y nodejs chromium && \
+    rm -rf /var/lib/apthet/lists /var/cache/apt/archives
+
+# Install Chrome Headless Shell
+RUN npx --yes @puppeteer/browsers install chrome-headless-shell@stable
+```
+
+Use a script like the below, to launch chrome headless shell from e.g. docker entrypoint script.
+
+*launch_chrome_headless_shell.rb*
+
+```sh
+#!/bin/bash
+# find the installation path of chrome headless shell (latest version)
+export CHROME_PATH=$(npx --yes @puppeteer/browsers install chrome-headless-shell@stable | awk '{print $2}')
+# start chrome headless with remote debugging on
+$CHROME_PATH --disable-gpu --remote-debugging-port=9222 --disable-software-rasterizer --disable-bluetooth --no-sandbox
+```
+
+*It has also been reported that the Chrome process repeatedly crashes when running inside a Docker container on an M1 Mac. Chrome should work asexpected when deployed to a Docker container on a non-M1 Mac.*
+
 
 ## Thread-safety
 
@@ -201,12 +226,40 @@ thread safe in the sense that every web socket get's a new tab in the underlying
 
 TODO
 
-possible buildpacks
+This buildpack installs chrome and chromedriver (chromedriver is actually not needed, but at least the buildpack is maintained)
 
-https://github.com/heroku/heroku-buildpack-chrome-for-testing
+```sh
+https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-google-chrome
+```
 
-this buildpack install chrome and chromedriver, which is actually not needed, but it's maintained
+### launch as child process
 
-https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-google-chrome
+set `HEADLESS_CHROME_PATH=chrome` as an ENV variable as this buildpacks adds `chrome` to the path.
 
-this buildpack installs chrome, which is all we need, but it's deprecated
+### run seperately
+
+In your `Procfile` adjust the web worker command
+
+```yaml
+web: bin/start
+```
+
+Create a bin/start script
+
+```sh
+#!/bin/bash
+# Start Rails app
+bundle exec rails server -p $PORT -e $RAILS_ENV &
+
+# Start the background app
+command_to_start_your_background_app &
+
+# Wait for all processes to finish
+wait -n
+```
+
+ensure the script is executable
+
+```sh
+chmod +x bin/start
+```

data/examples/headers_and_footers.rb

@@ -3,18 +3,28 @@
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'palapala'
 
-header_template =
-  '<div style="text-align: center; font-size: 12pt; padding: 1rem; width: 100%;">Page <span class="pageNumber"></span> of <span class="totalPages"></span></div>'
+header =
+  '<div class="center">Page <span class="pageNumber"></span> of <span class="totalPages"></span></div>'
 
-footer_template =
-  '<div style="text-align: center; font-size: 12pt; padding: 1rem; width: 100%;">Generated with Palapala PDF</div>'
+left_center_right = <<~HTML
+<div style="display: flex; justify-content: space-between; width: 100%; margin-left: 1cm; margin-right: 1cm;">
+    <div style="text-align: left; flex: 1;">Left Text</div>
+    <div style="text-align: center; flex: 1;">Center Text</div>
+    <div style="text-align: right; flex: 1;">Page <span class="pageNumber"></span> of <span class="totalPages"></span></div>
+</div>
+HTML
+
+footer =
+  '<span>Generated at&nbsp;<span class="date"></span></span>'
 
 Palapala::Pdf.new(
   "<h1>Title</h1><p>Hello world #{Time.now}</>",
-  header_template:,
-  footer_template:,
-  margin_top: 3,
-  margin_bottom: 3).save('headers_and_footers.pdf')
+  header: left_center_right,
+  footer:,
+  margin_top: 1,
+  margin_left: 1,
+  margin_bottom: 1,
+  watermark: "DRAFT").save('headers_and_footers.pdf')
 
 puts "Generated headers_and_footers.pdf"
 # `open headers_and_footers.pdf`

data/examples/paged_css.rb

@@ -43,6 +43,7 @@ document = <<~HTML
         margin: 0;
         padding: 0;
         font-family: Arial, sans-serif;
+        /* background-color: yellow; */
       }
       h1 {
         page-break-before: always;
@@ -165,21 +166,21 @@ end
 def header_footer_template(debug_color: nil)
   <<~HTML
   #{ debug(color: debug_color) if debug_color }
-  <div style="text-align: center; font-size: 12pt; padding: 1rem; width: 100%;">#{yield}</div>
+  <div style="font-size: 12pt;">#{yield}</div>
   HTML
 end
 
-footer_template = header_footer_template do
+footer = header_footer_template do
   "Page <span class='pageNumber'></span> of <span class='totalPages'></span>"
 end
 
-header_template = header_footer_template do
+header = header_footer_template do
   "Generated with Palapala PDF"
 end
 
 Palapala::Pdf.new(document,
-                  header_template:,
-                  footer_template:).save("paged_css.pdf")
+                  header:,
+                  footer:).save("paged_css.pdf")
 
 puts "Generated paged_css.pdf"
 

data/lib/palapala/chrome_process.rb

@@ -82,7 +82,7 @@ module Palapala
         # Display the version
         system("#{chrome_path} --version") if Palapala.debug
         # Launch chrome-headless-shell with the --remote-debugging-port parameter
-        params = [ "--disable-gpu", "--remote-debugging-port=9222" ]
+        params = [ "--disable-gpu", "--remote-debugging-port=9222", "--remote-debugging-address=0.0.0.0" ]
         params.merge!(Palapala.chrome_params) if Palapala.chrome_params
         pid = if Palapala.debug
           spawn(chrome_path, *params)

data/lib/palapala/pdf.rb

@@ -12,8 +12,10 @@ module Palapala
     #
     # @param content [String] the HTML content to convert to PDF
     # @param footer_html [String] the HTML content for the footer
+    # @param footer [String] the footer content that is centered
     # @param generate_tagged_pdf [Boolean] whether to generate a tagged PDF
     # @param header_html [String] the HTML content for the header
+    # @param header [String] the header content that is centered
     # @param landscape [Boolean] whether to use landscape orientation
     # @param margin_bottom [Integer] the bottom margin in inches
     # @param margin_left [Integer] the left margin in inches
@@ -27,8 +29,10 @@ module Palapala
     # @param scale [Float] the scale of the PDF rendering
     def initialize(content,
                    footer_template: nil,
+                   footer: nil,
                    generate_tagged_pdf: nil,
                    header_template: nil,
+                   header: nil,
                    landscape: nil,
                    margin_bottom: nil,
                    margin_left: nil,
@@ -39,11 +43,14 @@ module Palapala
                    paper_width: nil,
                    prefer_css_page_size: nil,
                    print_background: nil,
-                   scale: nil)
+                   scale: nil,
+                   watermark: nil)
       @content = content || raise(ArgumentError, "Content is required and can't be nil")
       @opts = {}
-      @opts[:headerTemplate]      = header_template      || Palapala.defaults[:header_template]
-      @opts[:footerTemplate]      = footer_template      || Palapala.defaults[:footer_template]
+      raise(ArgumentError, "Either footer or footer_template is expected") if !footer_template.nil? && !footer.nil?
+      raise(ArgumentError, "Either header or header_template is expected") if !header_template.nil? && !header.nil?
+      @opts[:headerTemplate]      = header_template      || hf_template(from: header) || Palapala.defaults[:header_template]
+      @opts[:footerTemplate]      = footer_template      || hf_template(from: footer) || Palapala.defaults[:footer_template]
       @opts[:pageRanges]          = page_ranges          || Palapala.defaults[:page_ranges]
       @opts[:generateTaggedPDF]   = generate_tagged_pdf  || Palapala.defaults[:generate_tagged_pdf]
       @opts[:paperWidth]          = paper_width          || Palapala.defaults[:paper_width]
@@ -56,11 +63,43 @@ module Palapala
       @opts[:preferCSSPageSize]   = prefer_css_page_size || Palapala.defaults[:prefer_css_page_size]
       @opts[:printBackground]     = print_background     || Palapala.defaults[:print_background]
       @opts[:scale]               = scale                || Palapala.defaults[:scale]
+      @opts[:headerTemplate]      = (@opts[:headerTemplate].to_s + watermark(watermark)) if watermark
       @opts[:displayHeaderFooter] = (@opts[:headerTemplate] || @opts[:footerTemplate]) ? true : false
       @opts[:encoding]            = :binary
       @opts.compact!
     end
 
+    def watermark(watermark, angle: "-15deg", color: "rgba(25,25,25,0.25)")
+      <<~HTML
+        <style>
+          .palapala_pdf_watermark {
+            position: fixed;
+            top: 50%;
+            left: 50%;
+            transform: translate(-50%, -50%) rotate(#{angle});
+            font-size: 8em;
+            color: #{color};
+            z-index: 9999;
+          }
+        </style>
+        <span class="palapala_pdf_watermark">#{watermark}</span>
+      HTML
+    end
+
+    def hf_template(from:)
+      return if from.nil?
+      style = <<~HTML.freeze
+        <style>
+          #header, #footer {
+            font-size: 10pt;
+            display: flex;
+            justify-content: center;
+          }
+        </style>
+      HTML
+      style + from
+    end
+
     # Render the PDF content to a binary string.
     #
     # The params from the initializer are converted to the expected casing and merged with the options passed to this method.

data/lib/palapala/renderer.rb

@@ -103,8 +103,20 @@ module Palapala
       Base64.decode64(result["data"])
     end
 
+    def ping
+      result = send_command_and_wait_for_result("Runtime.evaluate", params: { expression: "1 + 1" })
+      raise "Ping failed" unless result["result"]["value"] == 2
+    end
+
     def self.html_to_pdf(html, params: {})
       thread_local_instance.html_to_pdf(html, params: params)
+    rescue StandardError
+      reset # Reset the renderer on error, the websocket connection might be broken
+      thread_local_instance.html_to_pdf(html, params: params) # Retry (once)
+    end
+
+    def self.ping
+      thread_local_instance.ping
     end
 
     def close

data/lib/palapala/version.rb

@@ -1,3 +1,3 @@
 module Palapala
-  VERSION = "0.1.11"
+  VERSION = "0.1.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palapala_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - Koen Handekyn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64