palapala_pdf 0.1.12 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9371e3f5558b6cac6126a9f8004e48dbbf7059e3bfbd230885d66502e1e0f931
-  data.tar.gz: 769a77ca03fb96e858991d98c0c49f2aa3de58ba0dc2e0f33207c264969ce9c4
+  metadata.gz: cb2b592eddfeb0f59e676024799d3042f7244a009ef1df2404ce70b47b917a8e
+  data.tar.gz: 2759e4fdfabc81dcf85271bcd7caaab869dfeea54f2702f8f334a962cbf82168
 SHA512:
-  metadata.gz: 3458400fa50aeb4d2e672f156e8bf81f0a8d6a2384cb4b3d8624ca0cc18adc2c8a38eb905850fcb8d73ac3a72cd61525f77f02c5c1dd26d4a1f32ec87831556c
-  data.tar.gz: f536a148a022ebed055f349362d1f90593de300ac7972e767dc26c20db7be1ee7e1437a1195fa15e4ce5f5b40dc6e623196a64e6c0cc34c3a3fdf61dba080e4e
+  metadata.gz: 39523b9ea30d700456961862236ca0405a9e7311d7c99d81a8c9c0ed73df0b1088b2c9bedf143bc947e95030147cb8da63d9cb4cc102efea34b865919d371e84
+  data.tar.gz: 24958e43641f78b024e4848888f19cb7c6d688304486baad281320ab8a3f1bc443ab012f85a51fff174969b047356b89461436529e07f906d8e7c9b3294c02a2

data/README.md

@@ -75,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**
@@ -97,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
 
@@ -189,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
 
@@ -203,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

@@ -23,7 +23,8 @@ Palapala::Pdf.new(
   footer:,
   margin_top: 1,
   margin_left: 1,
-  margin_bottom: 1).save('headers_and_footers.pdf')
+  margin_bottom: 1,
+  watermark: "CLASSIFIED").save('headers_and_footers.pdf')
 
 puts "Generated headers_and_footers.pdf"
 # `open headers_and_footers.pdf`

data/lib/palapala/helper.rb

@@ -0,0 +1,54 @@
+module Palapala
+  module Helper
+    def self.header(left: "", center: "", right: "", margin: "1cm")
+      <<~HTML
+        <div style="display: flex; justify-content: space-between; width: 100%; margin-left: #{margin}; margin-right: #{margin};">
+          <div style="text-align: left; flex: 1;">#{left}</div>
+          <div style="text-align: center; flex: 1;">#{center}</div>
+          <div style="text-align: right; flex: 1;">#{right}</div>
+      </div>
+      HTML
+    end
+
+    def self.footer(left: "", center: "", right: "", margin: "1cm")
+      self.header(left:, center:, right:, margin:)
+    end
+``
+    def self.page_number
+      <<~HTML
+        <span class="pageNumber"></span>/<span class="totalPages"></span>
+      HTML
+    end
+
+    def self.watermark(watermark, angle: "-15deg", color: "rgba(25,25,25,0.25)", font_size: "72pt")
+      <<~HTML
+        <style>
+          .palapala_pdf_watermark {
+            position: fixed;
+            top: 50%;
+            left: 50%;
+            transform: translate(-50%, -50%) rotate(#{angle});
+            font-size: #{font_size};
+            color: #{color};
+            z-index: 9999;
+          }
+        </style>
+        <span class="palapala_pdf_watermark">#{watermark}</span>
+      HTML
+    end
+
+    def self.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
+  end
+end

data/lib/palapala/pdf.rb

@@ -1,4 +1,5 @@
 require_relative "./renderer"
+require_relative "./helper"
 
 module Palapala
   # Page class to generate PDF from HTML content using Chrome in headless mode in a thread-safe way
@@ -43,13 +44,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 = {}
       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[:headerTemplate]      = header_template      || Helper.hf_template(from: header) || Palapala.defaults[:header_template]
+      @opts[:footerTemplate]      = footer_template      || Helper.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]
@@ -62,25 +64,14 @@ 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 + Helper.watermark(watermark)) if watermark
       @opts[:displayHeaderFooter] = (@opts[:headerTemplate] || @opts[:footerTemplate]) ? true : false
+      @opts[:headerTemplate]    ||= " " if @opts[:displayHeaderFooter]
+      @opts[:footerTemplate]    ||= " " if @opts[:displayHeaderFooter]
       @opts[:encoding]            = :binary
       @opts.compact!
     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/version.rb

@@ -1,3 +1,3 @@
 module Palapala
-  VERSION = "0.1.12"
+  VERSION = "0.1.15"
 end

data/lib/palapala.rb

@@ -1,4 +1,5 @@
 require_relative "palapala/pdf"
+require_relative "palapala/helper"
 require_relative "palapala/version"
 
 module Palapala

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: palapala_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.15
 platform: ruby
 authors:
 - Koen Handekyn
@@ -69,6 +69,7 @@ files:
 - examples/performance_benchmark.rb
 - lib/palapala.rb
 - lib/palapala/chrome_process.rb
+- lib/palapala/helper.rb
 - lib/palapala/pdf.rb
 - lib/palapala/renderer.rb
 - lib/palapala/version.rb