palapala_pdf 0.1.19 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837d0f0eeca4484a6c8e6ccb8f5113889653d6076eb0a25b2ed13997de2c4656
-  data.tar.gz: 34561e1c72d7ff0f363055f0a9264e5a8fe2a30f31888e82679fa62a779fd054
+  metadata.gz: 12be6d622065fdadf2611578279b723532a6ab68b25a2c5b9790692757058c17
+  data.tar.gz: 890152aa05e9ea2823e19ed1a2ec27eade4271951bbb6c948f44bc68d074a09f
 SHA512:
-  metadata.gz: 6402a0c71a59806fd91241118a51a993a1439afdde35f2b969ffb23c6df38bc071685801b08490f4789828536b0f1a10c86f6fe5ce48af79e8a7350fe3ff8b21
-  data.tar.gz: 40f62b4e5c9e14460c92ead8ed7439044a5d69636b670a6cb823349de069cb8e1be855a3cb2480a7dc9ae63d218d2125d2c7708aad856d64e4a06d3b13877e5f
+  metadata.gz: 2d42e1f4c2de6eea69f8b42e57340ff191f9e87f77b42df05c3b4dca4acc21fb6d9847f2aea19085522071f0a5b37c5c62a512f5f4ceaee6e29267dc5638c359
+  data.tar.gz: c61845987b64ba8de756e05c81a7451da67e7eb59e50dd39e0a3c2088d201560fcd4f1723d8193c8e367c3578a7cfe2a475171c07209cbfb00dc4200d9313653

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.4.1

data/README.md

@@ -1,12 +1,10 @@
-# PDF Generation for your Rubies
+# PDF Generation for your Rails and Rubies
 
 <div align="center"><img src="https://raw.githubusercontent.com/palapala-app/palapala_pdf/main/assets/images/logo.webp" alt="Palapala PDF Logo" width="200"></div>
 
-This project is a Ruby gem that provides functionality for generating PDF files from HTML using the Chrome browser. It allows you to easily convert HTML content into PDF documents, making it convenient for tasks such as generating reports, invoices, or any other printable documents. The gem provides a simple and intuitive API for converting HTML to PDF, and it leverages the power and flexibility of the Chrome browser's rendering engine to ensure accurate and high-quality PDF output. With this gem, you can easily integrate PDF generation capabilities into your Ruby applications.
+This project is a Ruby gem that generates PDF files from HTML using the Chrome browser engine, making it convenient for tasks such as generating reports, invoices, or any other printable documents.
 
-At the core, this project leverages the Chrome rendering engine, but with significantly reduced overhead and dependencies. Instead of relying on the full Grover/Puppeteer/NodeJS stack, this project uses a raw web socket to enable direct communication from Ruby to a headless Chrome or Chromium browser. This approach ensures efficieny while providing a streamlined alternative for rendering tasks without sacrificing performance or flexibility.
-
-It leverages work from [Puppeteer](https://pptr.dev/browsers-api/) (@puppeteer/browsers) to install a local Chrome-Headless-Shell if no Chrome is running, but that requires node (npx) to be available.
+On Heroku you just need to install a buildpack for Chrome and the rest is auto-configured.
 
 This is how easy PDF generation can be in Ruby:
 
@@ -14,12 +12,15 @@ This is how easy PDF generation can be in Ruby:
 require "palapala"
 Palapala::Pdf.new("<h1>Hello, world! #{Time.now}</h1>").save('hello.pdf')
 ```
+
 And this while having the most modern HTML/CSS/JS availlable to you: flex, grid, canvas, ...
 
 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)
 
+It leverages work from [Puppeteer](https://pptr.dev/browsers-api/) (@puppeteer/browsers) to install a local Chrome-Headless-Shell if no Chrome is running (requires node/npx to be available).
+
 ## 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:
@@ -33,8 +34,8 @@ Your support is greatly appreciated and helps maintain the project!
 
 To install the gem and add it to your application's Gemfile, execute the following command:
 
-```
-$ bundle add palapala_pdf
+```sh
+bundle add palapala_pdf
 ```
 
 ## Usage Instructions
@@ -179,13 +180,29 @@ Here's an example of how to use `render_to_string` to render a view template to
 ```ruby
 def download_pdf
     html_string = render_to_string(template: "example/template", layout: "print", locals: { } )
-    pdf_data = Palapala::Pdf.new(html_string).binary_data
+    pdf_data = Palapala::Pdf.new(html_string).binary_data(skip_metadata: true)
     send_data pdf_data, filename: "document.pdf", type: "application/pdf"
 end
 ```
 
 In this example, `pdf_data` is the binary data of the PDF file. The `filename` option specifies the name of the file that will be downloaded by the user, and the `type` option specifies the MIME type of the file.
 
+In the below example we generate a PDF with metadata:
+
+```ruby
+def download_pdf
+    html_string = render_to_string(template: "example/template", layout: "print", locals: { } )
+    pdf_data = Palapala::Pdf.new(html_string).binary_data(
+        title: "Hello World from Palapala",
+        author: "Example User",
+        subject: "Sample Document",
+        producer: "Some Company",
+        creator: "PalapalaPDF"
+    )
+    send_data pdf_data, filename: "document.pdf", type: "application/pdf"
+end
+```
+
 ## Docker
 
 TODO
@@ -224,27 +241,25 @@ thread safe in the sense that every web socket get's a new tab in the underlying
 
 ## Heroku
 
-TODO
-
 This buildpack installs chrome and chromedriver (chromedriver is actually not needed, but at least the buildpack is maintained)
 
 ```sh
-https://elements.heroku.com/buildpacks/heroku/heroku-buildpack-google-chrome
+https://github.com/heroku/heroku-buildpack-chrome-for-testing
 ```
 
 ### launch as child process
 
-set `HEADLESS_CHROME_PATH=chrome` as an ENV variable as this buildpacks adds `chrome` to the path.
+This is the current default. If HEROKU is detected, then we set `HEADLESS_CHROME_PATH=chrome` as an ENV variable as the above buildpack adds `chrome` to the path. Basically it should run out of the box as long as the buildpack is added.
 
 ### run seperately
 
-In your `Procfile` adjust the web worker command
+If you prefer to run it next to your Rails app, then in your `Procfile` adjust the web worker command to
 
 ```yaml
 web: bin/start
 ```
 
-Create a bin/start script
+And create a bin/start script
 
 ```sh
 #!/bin/bash
@@ -258,7 +273,7 @@ command_to_start_your_background_app &
 wait -n
 ```
 
-ensure the script is executable
+Ensure the script is executable
 
 ```sh
 chmod +x bin/start

data/examples/paged_css.rb

@@ -180,7 +180,7 @@ end
 
 Palapala::Pdf.new(document,
                   header:,
-                  footer:).save("paged_css.pdf")
+                  footer:).save("paged_css.pdf", title: "Paged CSS", author: "Koen Handekyn", subject: "Paged CSS example")
 
 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", "--remote-debugging-address=0.0.0.0" ]
+        params = [ "--disable-gpu", "--disable-software-rasterizer", "--disable-bluetooth", "--disable-dev-shm-usage", "--remote-debugging-port=9222", "--remote-debugging-address=0.0.0.0" ]
         params.concat(Palapala.chrome_params) if Palapala.chrome_params
         pid = if Palapala.debug
           spawn(chrome_path, *params)
@@ -97,7 +97,7 @@ module Palapala
     end
 
     def self.spawn_chrome_from_path
-      params = [ "--headless", "--disable-gpu", "--remote-debugging-port=9222" ]
+      params = [ "--headless", "--disable-gpu", "--disable-software-rasterizer", "--disable-bluetooth", "--disable-dev-shm-usage", "--remote-debugging-port=9222", "--remote-debugging-address=0.0.0.0"  ]
       params.concat(Palapala.chrome_params) if Palapala.chrome_params
       # Spawn an existing chrome with the path and parameters
       Process.spawn(chrome_path, *params)

data/lib/palapala/helper.rb

@@ -1,8 +1,8 @@
 module Palapala
   module Helper
-    def self.header(left: "", center: "", right: "", margin: "1cm")
+    def self.header(left: "", center: "", right: "", margin: "1cm", font_family: "Arial")
       <<~HTML
-        <div style="display: flex; justify-content: space-between; width: 100%; margin-left: #{margin}; margin-right: #{margin};">
+        <div style="display: flex; justify-content: space-between; width: 100%; margin-left: #{margin}; margin-right: #{margin}; font-family: #{font_family}">
           <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>
@@ -10,13 +10,14 @@ module Palapala
       HTML
     end
 
-    def self.footer(left: "", center: "", right: "", margin: "1cm")
-      self.header(left:, center:, right:, margin:)
+    def self.footer(left: "", center: "", right: "", margin: "1cm", font_family: "Arial")
+      self.header(left:, center:, right:, margin:, font_family:)
     end
 
-    def self.page_number
+    def self.page_number(style: nil)
+      style_attr = style.nil? ? "" : "style='#{style}'"
       <<~HTML
-        <span class="pageNumber"></span>/<span class="totalPages"></span>
+        <span class="pageNumber" #{style_attr}></span>/<span class="totalPages"></span>
       HTML
     end
 

data/lib/palapala/pdf.rb

@@ -1,5 +1,6 @@
 require_relative "./renderer"
 require_relative "./helper"
+require "combine_pdf"
 
 module Palapala
   # Page class to generate PDF from HTML content using Chrome in headless mode in a thread-safe way
@@ -80,21 +81,40 @@ module Palapala
     #
     # @param opts [Hash] the options to pass to the renderer
     # @return [String] the PDF content as a binary string
-    def binary_data
+    def binary_data(title: "", author: "", subject: "", producer: "PalapalaPDF", creator: "PalapalaPDF", skip_metadata: false)
       puts "Rendering PDF with params: #{@opts}" if Palapala.debug
-      Renderer.html_to_pdf(@content, params: @opts)
+      binary_data = Renderer.html_to_pdf(@content, params: @opts)
+
+      if skip_metadata
+        binary_data
+      else
+        # Load the PDF from the string
+        pdf = CombinePDF.parse(binary_data)
+
+        # Set metadata manually
+        info_hash = {
+          Title: title,
+          Author: author,
+          Subject: subject,
+          Producer: producer,
+          Creator: creator
+        }
+
+        # Embed metadata into the PDF
+        pdf.info.merge!(info_hash)
+        pdf.to_pdf
+      end
     rescue StandardError => e
       puts "Error rendering PDF: #{e.message}"
       Renderer.reset
       raise
     end
 
-
     # Save the PDF content to a file
     # @param path [String] the path to save the PDF file
     # @return [void]
-    def save(path)
-      File.binwrite(path, binary_data)
+    def save(path, **opts)
+      File.binwrite(path, binary_data(**opts))
     end
   end
 end

data/lib/palapala/renderer.rb

@@ -3,6 +3,8 @@ require "net/http"
 require "websocket/driver"
 require_relative "./web_socket_client"
 require_relative "./chrome_process"
+require 'tempfile'
+require 'webrick'
 
 module Palapala
   # Render HTML content to PDF using Chrome in headless mode with minimal dependencies
@@ -88,6 +90,8 @@ module Palapala
     # Method to send a CDP command and wait for a specific method to be called
     def send_command_and_wait_for_event(method, event_name:, params: {})
       send_command(method, params:) do
+        # chrome refuses to load pages that are bigger than 2MB and returns a net::ERR_ABORTED error
+        raise "Page cannot be loaded" if @response.dig("result", "errorText") == "net::ERR_ABORTED"
         @response && @response["method"] == event_name
       end
     end
@@ -97,10 +101,17 @@ module Palapala
     # @param html [String] The HTML content to convert to PDF
     # @param params [Hash] Additional parameters to pass to the CDP command
     def html_to_pdf(html, params: {})
-      send_command_and_wait_for_event("Page.navigate", params: { url: data_url_for_html(html) },
-                                                       event_name: "Page.frameStoppedLoading")
-      result = send_command_and_wait_for_result("Page.printToPDF", params:)
-      Base64.decode64(result["data"])
+      server = start_local_server(html)
+      begin
+        url = "http://localhost:#{server[:port]}/"
+        send_command_and_wait_for_event("Page.navigate", params: { url: url },
+                                                             event_name: "Page.frameStoppedLoading")
+        result = send_command_and_wait_for_result("Page.printToPDF", params:)
+        Base64.decode64(result["data"])
+      ensure
+        server[:thread].kill # Stop the server after use
+        server[:file].unlink # Delete the temporary file
+      end
     end
 
     def ping
@@ -143,5 +154,24 @@ module Palapala
     def data_url_for_html(html)
       "data:text/html;base64,#{Base64.strict_encode64(html)}"
     end
+
+    def start_local_server(html)
+      file = Tempfile.new(["html_content", ".html"])
+      file.write(html)
+      file.close
+
+      port = find_available_port
+      server = WEBrick::HTTPServer.new(Port: port, DocumentRoot: File.dirname(file.path), Logger: WEBrick::Log.new("/dev/null"), AccessLog: [])
+      thread = Thread.new { server.start }
+
+      { server: server, thread: thread, file: file, port: port }
+    end
+
+    def find_available_port
+      server = TCPServer.new(0)
+      port = server.addr[1]
+      server.close
+      port
+    end
   end
 end

data/lib/palapala/version.rb

@@ -1,3 +1,3 @@
 module Palapala
-  VERSION = "0.1.19"
+  VERSION = "0.1.23"
 end

data/palapala_pdf.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'base64', '~> 0'
   spec.add_dependency 'websocket-driver', '~> 0'
+  spec.add_dependency 'combine_pdf', '~> 1'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: palapala_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.23
 platform: ruby
 authors:
 - Koen Handekyn
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2025-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -38,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: combine_pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: This gem uses faw web sockets to render HTML into a PDF using Chrom(e)(ium)
   with minimal dependencies.
 email:
@@ -84,7 +97,6 @@ metadata:
   homepage_uri: https://github.com/palapala-app/palapala_pdf
   changelog_uri: https://github.com/palapala-app/palapala_pdf/blob/main/changelog.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Convert HTML into PDF directly from Ruby using Chrome/Chromium.
 test_files: []