postdoc 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74295695d3dbf550fa41c48f13ed409547fc0e30559d4baa215c5d8875ec291d
-  data.tar.gz: f4e09afaa99866596a382fc7d4dea72c1cbbfe6df972ca336da97949f2c6f637
+  metadata.gz: 99100709b8c080b91123f7196ad2da2fa499bdd35c63e300442191c585527104
+  data.tar.gz: 9958e7e9d1601f4c0e2c1141a8f733cdb29d121bcee3e68e0a65b5a4fb13ec37
 SHA512:
-  metadata.gz: 7cc297db02152057e2bfa61042430e29d67a0d10e4bd109e70791ea5bf065324d0cb25df9c6fd305f8671fbe9583b3c7470c8a843744ed76a972777ce7e331b4
-  data.tar.gz: 19395b879f1a9837e11986eba31f832818f8765f05f13861c09f00141bc3d2da41712845984fef87e476a2d3daf09347124e6e63a11456ae8e9f65ec1bd2432b
+  metadata.gz: beb118c9f143dfc9801770c0a34908a5f50640c1d11fa4d051a5a3d9f26c5573445342df95615dad76ff8ac8bcaf5ab357439535bea246b97f97227cfe7982c5
+  data.tar.gz: 2d17c30f6604bd94eeaea2c482bf6d7a7f228a3bfc50ae5853e8c783c9098bb2cc0326ab0bf4cd29a00b528841963745d03a1e3e1721f7ba6953228fcc53bd50

data/lib/postdoc/batch.rb

@@ -0,0 +1,34 @@
+require 'postdoc/print_settings'
+require 'postdoc/job'
+
+module Postdoc
+  # This module represents a batch. At times we want to render multiple PDF's in
+  # series and batching saves a lot of overhead by not restarting chrome over
+  # and over. Practical applications are  "stitching" PDF's together to get
+  # around markup constraints in chrome or rendering a batch of reports all at
+  # once.
+  class Batch
+    def initialize(jobs: [])
+      @jobs = jobs
+    end
+
+    # Creates a job from a document and add to the jobs.
+    def add_document(document, settings: {})
+      settings = PrintSettings.new(**settings)
+      @jobs << Job.new(document, settings: settings)
+    end
+
+    def add_job(job)
+      @jobs << job
+    end
+
+    # returns the output of the config. Requires a {Postdoc::Client Client}
+    def result(client)
+      @jobs.map { |job| job.result(client) }
+    end
+
+    def cleanup
+      @jobs.each(&:cleanup)
+    end
+  end
+end

data/lib/postdoc/chrome_process.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Postdoc
+  # Spins up a Chrome process.
   class ChromeProcess
     attr_reader :pid, :port
 
@@ -17,8 +18,10 @@ module Postdoc
     end
 
     def kill
-      Process.kill 'KILL', pid
+      Process.kill 'INT', pid
       Process.wait pid
+    rescue
+      true
     end
 
     def client

data/lib/postdoc/client.rb

@@ -3,6 +3,7 @@
 require 'chrome_remote'
 
 module Postdoc
+
   class Client
     attr_accessor :client
 
@@ -12,26 +13,25 @@ module Postdoc
       raise 'ChromeClient couldn\'t launch' if @client.blank?
     end
 
+    # We should move away from passing options like this and collect them in
+    # the prinbt settings.
     def print_pdf_from_html(file_path,
-        header_template: false,
-        footer_template: false,
-        **options)
+        settings: PrintSettings.new)
 
       client.send_cmd 'Page.enable'
       client.send_cmd 'Page.navigate', url: "file://#{file_path}"
       client.wait_for 'Page.loadEventFired'
 
-      response = client.send_cmd 'Page.printToPDF', {
-        landscape: options[:landscape] || false,
-        printBackground: true,
-        marginTop: options[:margin_top] || 1,
-        marginBottom: options[:margin_bottom] || 1,
-        marginLeft: options[:margin_left] || 1,
-        marginRight: options[:margin_right] || 1,
-        displayHeaderFooter: !!(header_template || footer_template),
-        headerTemplate: header_template || '',
-        footerTemplate: footer_template || ''
-      }
+      response = client.send_cmd 'Page.printToPDF', settings.to_cmd
+
+      Base64.decode64 response['data']
+    end
+
+    def print_document(file_path, settings: PrintSettings.new)
+      client.send_cmd 'Page.enable'
+      client.send_cmd 'Page.navigate', url: "file://#{file_path}"
+      client.wait_for 'Page.loadEventFired'
+      response = client.send_cmd 'Page.printToPDF', settings.to_cmd
 
       Base64.decode64 response['data']
     end
@@ -41,7 +41,7 @@ module Postdoc
     def setup_connection_or_wait
       @client = ChromeRemote.client(port: @port)
       true
-    rescue Exception
+    rescue
       sleep(0.1)
       false
     end

data/lib/postdoc/html_document.rb

@@ -8,7 +8,7 @@ module Postdoc
 
     delegate :path, to: :file
 
-    def initialize(content, path: nil, **_options)
+    def initialize(content, path: nil)
       path ||= Rails.root&.join('tmp') || '/tmp'
       @file = Tempfile.new ['input', '.html'], path
 

data/lib/postdoc/job.rb

@@ -0,0 +1,18 @@
+module Postdoc
+  # A job is a single "print" in a batch and binds a document to a setting.
+  class Job
+    def initialize(document, settings: PrintSettings.new)
+      @settings = settings
+      @document = HTMLDocument.new(document)
+    end
+
+    # Return the result of the job.
+    def result(client)
+      client.print_document(@document.path, settings: @settings)
+    end
+
+    def cleanup
+      @document.cleanup
+    end
+  end
+end

data/lib/postdoc/print_settings.rb

@@ -0,0 +1,43 @@
+module Postdoc
+  # Different prints require different settings. This class is used instead of
+  # passing options arguments throughout all of the code.
+  class PrintSettings
+    def initialize(
+        header_template: '',
+        footer_template: '',
+        landscape: false,
+        print_background: true,
+        margin_top: 1,
+        margin_bottom: 1,
+        margin_left: 1,
+        margin_right: 1
+    )
+      @header_template = header_template
+      @footer_template = footer_template
+      @landscape = landscape
+      @print_background = print_background
+      @margin_top = margin_top
+      @margin_bottom = margin_bottom
+      @margin_left = margin_left
+      @margin_right = margin_right
+    end
+
+    def to_cmd
+      { landscape: @landscape,
+        printBackground: true,
+        marginTop: @margin_top,
+        marginBottom: @margin_bottom,
+        marginLeft: @margin_left,
+        marginRight: @margin_right,
+        displayHeaderFooter: display_header_and_footer?,
+        headerTemplate: @header_template,
+        footerTemplate: @footer_template }
+    end
+
+    private
+
+    def display_header_and_footer?
+      @header_template.present? || @footer_template.present?
+    end
+  end
+end

data/lib/postdoc.rb

@@ -4,6 +4,8 @@ require 'action_controller'
 require 'postdoc/chrome_process'
 require 'postdoc/client'
 require 'postdoc/html_document'
+require 'postdoc/print_settings'
+require 'postdoc/batch'
 
 module Postdoc
   ActionController::Renderers.add :pdf do |_filename, options|
@@ -11,12 +13,42 @@ module Postdoc
   end
 
   def self.render_from_string(content, **options)
+    print_settings = PrintSettings.new(**options)
     server = ChromeProcess.new(**options)
-    html_file = HTMLDocument.new(content, **options)
+    html_file = HTMLDocument.new(content)
     server.client
-        .print_pdf_from_html(html_file.path, **options)
+        .print_pdf_from_html(html_file.path,
+            settings: print_settings)
   ensure
+    if server.client.client.present?
+      server.client.client.send_cmd 'Browser.close'
+    end
     server.kill
     html_file.cleanup
   end
+
+  # A clean and easy way to render a batch:
+  # ```
+  # html_string_1
+  # html_string_2
+  # with_footer = Postdoc::PrintSettings.new(footer_template: footer_template)
+
+  # result = Postdoc.batch do |batch|
+  #   batch.add_document doc1
+  #   batch.add_document doc2, settings: with_footer
+  # end
+  # ```
+  def self.batch(batch: Batch.new)
+    yield(batch)
+    begin
+      server = ChromeProcess.new
+      batch.result(server.client)
+    ensure
+      if server.client.client.present?
+        server.client.client.send_cmd 'Browser.close'
+      end
+      server.kill
+      batch.cleanup
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Frank Groeneveld
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chrome_remote
@@ -33,7 +33,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -68,9 +68,12 @@ files:
 - LICENSE
 - Rakefile
 - lib/postdoc.rb
+- lib/postdoc/batch.rb
 - lib/postdoc/chrome_process.rb
 - lib/postdoc/client.rb
 - lib/postdoc/html_document.rb
+- lib/postdoc/job.rb
+- lib/postdoc/print_settings.rb
 homepage: https://github.com/ivaldi/postdoc
 licenses:
 - BSD-2-Clause