chromium-pdf 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e69272be5a3fdd74fe47708fbd938dd4970abb1e5e665eacbbd4c6f16c048052
+  data.tar.gz: d8cc59b9a10b591286c184cd94afb9b3e8f08311909d6b0cb71e98e9a1b11489
+SHA512:
+  metadata.gz: c00facb71c117edd74b88472cc2c8d136d913e2ab91c92fc21d9b2888740b4f5d5f9fa7986850eadc18c6ff84da121956a79be18a2089fef2e79839d0465a7fb
+  data.tar.gz: 042e68a56a4f7c09822827428fcfce1bee747ac7f7c916cba23f26ded142a4d3245619131e3de67f6731e2712337faa13ff59da8a5b33fe39561e50747f39ee2

data/.rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - vendor/**/*
+    - config/**/*
+    - tmp/**/*
+    - env.rb
+  NewCops: enable
+
+Metrics:
+  Severity: refactor
+
+# Hard to make this pass always and want to keep flexibility
+Layout/ArrayAlignment:
+  Enabled: false
+
+# Best Practices for readability
+Layout:
+  Severity: refactor
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Lint/UnusedMethodArgument:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UnusedBlockArgument:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UselessAssignment:
+  Severity: refactor
+  AutoCorrect: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Lint/Loop:
+  Enabled: false
+
+Lint/SuppressedException:
+  Enabled: false
+
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+
+Style:
+  Severity: refactor
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+# It is ok to use inject at times
+Style/EachWithObject:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-14
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Andy Cohen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# Chromium::Pdf
+
+A gem wrapping the Chrome print-to-pdf functionality used for creating pdf files.
+
+It includes generators for establishing a template framework for implementing the generation into GoodJobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'chromium-pdf', github: 'RoleModel/chromium-pdf'
+```
+
+And then execute:
+```shell
+bundle
+```
+
+## Usage
+
+Run the installation generator to create dependency templates with:
+```shell
+bin/rails g chromium:pdf:install
+```
+
+This will create an example job file, GoodJobs initializer, and app.json.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RoleModel/chromium-pdf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/print_landscape.md

@@ -0,0 +1,39 @@
+# Print Landscape
+
+It is possible to dynamically configure a web page to be printed in landscape orientation using scss.
+
+Example:
+
+```scss
+  @page landscape {
+    size: 11in 8.5in;
+  }
+
+  .print-landscape {
+    page: landscape;
+    .app__content {
+      max-width: 100%;
+    }
+  }
+```
+
+This class can then be added conditionally to the body of the application view:
+
+```slim
+  body.app-body class="#{'print-landscape' if @print_landscape}"
+    = turbo_frame_tag 'modal'
+    = render 'confirm'
+    /...
+```
+
+And this can then be controlled by passing the `@print_landscape` variable from any controller.
+
+## Scaling
+
+Printing in landscape orientation this way effectively scales up the web page compared to portrait orientation. This can be rectified with the following class:
+
+```scss
+  .landscape-scale {
+    zoom: 0.77; // Letter size difference, 8.5in / 11in = 77%
+  }
+```

data/lib/chromium/pdf/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Chromium
+  module Pdf
+    VERSION = '1.0.0.pre'
+  end
+end

data/lib/chromium/pdf.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'railtie' if defined?(Rails::Railtie)
+require_relative 'pdf/version'
+require 'active_support/concern'
+
+module Chromium
+  module Pdf
+    extend ActiveSupport::Concern
+
+    ##
+    # @param unescaped_filename [String] The filename to save the PDF as.
+    # @param print_url [String] The URL of the page you want to be processed.
+    # @param arguments [Array<String>] An array of arguments to pass to the Chrome binary.
+    # @yield [file, filename] Yields the file object and the filename to the block.
+    #
+    def generate_pdf!(unescaped_filename, print_url, arguments: ['--headless --disable-gpu'])
+      chrome_path = ENV.fetch('GOOGLE_CHROME_BIN', nil)
+      filename = unescaped_filename.gsub('&', 'and')
+
+      Dir.mktmpdir do |path|
+        filepath = "#{path}/#{filename}"
+
+        chrome_print chrome_path, print_url, filename, filepath, arguments
+      end
+    end
+
+    protected
+
+    def chrome_print(chrome_path, print_url, filename, filepath, arguments)
+      system("LD_PRELOAD='' #{chrome_path} --print-to-pdf='#{filepath}' #{arguments.join(' ')} #{print_url}")
+
+      File.open(filepath) do |file|
+        yield file, filename
+      end
+    end
+  end
+end

data/lib/chromium/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Chromium
+  module Pdf
+    class Railtie < ::Rails::Railtie
+      generators do
+        require 'generators/chromium/pdf/install/install_generator'
+      end
+    end
+  end
+end

data/lib/generators/chromium/pdf/install/install_generator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module Chromium
+  module Pdf
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc 'Create template files for pdf generation job'
+        source_root File.expand_path('templates', __dir__)
+
+        def create_pdf_job_templates
+          copy_file 'app/jobs/generate_pdf_job.rb'
+          copy_file 'config/initializers/good_job.rb'
+        end
+
+        def include_chrome_buildpack_in_app_json
+          say(<<~SAY, :yellow)
+            N.B. app.json changes are only applied to new heroku apps.
+            In the case where your app already exists make sure to manually add the buildpack by running the command:
+            `heroku buildpacks:add heroku-community/chrome-for-testing`
+          SAY
+          add_buildpack_to_app_json
+        end
+
+        private
+
+        def add_buildpack_to_app_json
+          in_root do
+            update_json_file('app.json') do |data|
+              if data['buildpacks'].none? { |entry| entry['url'] == 'heroku-community/chrome-for-testing' }
+                data['buildpacks'] << { 'url' => 'heroku-community/chrome-for-testing' }
+              end
+            end
+          end
+        end
+
+        def update_json_file(file_name)
+          data = if File.exist?(file_name)
+                   ActiveSupport::JSON.decode(File.read(file_name))
+                 else
+                   {}
+                 end
+          data['buildpacks'] ||= []
+
+          yield data
+
+          File.write(file_name, pretty_json(data))
+        end
+
+        def pretty_json(data)
+          require 'json'
+          JSON.pretty_generate(data)
+        end
+      end
+    end
+  end
+end

data/lib/generators/chromium/pdf/install/templates/app/jobs/generate_pdf_job.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class GeneratePdfJob < ApplicationJob
+  JobTimeoutError = Class.new(StandardError)
+  include GoodJob::ActiveJobExtensions::Concurrency
+  include Chromium::Pdf
+
+  queue_as :pdf
+  retry_on Errno::ENOENT, wait: :polynomially_longer, attempts: 3
+  retry_on JobTimeoutError, wait: :polynomially_longer, attempts: 3
+
+  good_job_control_concurrency_with(
+    enqueue_limit: 1,
+    perform_limit: 1,
+    key: arguments.first.id
+  )
+
+  around_perform do |_job, block|
+    Timeout.timeout(180.seconds, JobTimeoutError) do
+      block.call
+    end
+  end
+
+  def perform(model)
+    # Any pre-generation logic
+    return if model.attachment.attached?
+
+    generate_pdf!(model.filename, model.print_url) do |file, filename|
+      # What to do with the generated file
+      model.attachment.attach(io: File.open(file.path), filename: filename, content_type: 'application/pdf')
+    end
+  end
+end

data/lib/generators/chromium/pdf/install/templates/config/initializers/good_job.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# NOTE: queues - Configuring queues is an important part of prioritization. GoodJob uses
+# multiple ways to override. 12factor override used here with fallback to a common queue
+# override example/pattern for Heroku apps using pdf generation limiting to serial
+# processing to constrain resource [memory] limitations
+
+# NOTE: execution_mode - development defaults to async but has known to hang in certain
+# [unidentified] situations so use external which gives devs more control on running too
+
+Rails.application.configure do
+  config.good_job = {
+    smaller_number_is_higher_priority: true, # new default in V4 and for all of ActiveJob
+    queues: ENV.fetch('GOOD_JOB_QUEUES', 'pdf:1;-pdf'), # see note above
+    execution_mode: Rails.env.test? ? :inline : :external # see note above
+    # enable_cron: true,
+    # cron: {
+    #   <cron_label>: {
+    #     cron: 'every friday at 12pm EST',
+    #     class: '<class_name>'
+    #   }
+    # }
+  }
+end

data/sig/chromium/pdf.rbs

@@ -0,0 +1,6 @@
+module Chromium
+  module Pdf
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chromium-pdf
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- RoleModel Software
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-20 00:00:00.000000000 Z
+dependencies: []
+description: Add support for generating PDFs with chrome to a rails app
+email:
+- it-support@rolemodelsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/print_landscape.md
+- lib/chromium/pdf.rb
+- lib/chromium/pdf/version.rb
+- lib/chromium/railtie.rb
+- lib/generators/chromium/pdf/install/install_generator.rb
+- lib/generators/chromium/pdf/install/templates/app/jobs/generate_pdf_job.rb
+- lib/generators/chromium/pdf/install/templates/config/initializers/good_job.rb
+- sig/chromium/pdf.rbs
+homepage: https://github.com/RoleModel/chromium-pdf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RoleModel/chromium-pdf
+  source_code_uri: https://github.com/RoleModel/chromium-pdf
+  changelog_uri: https://github.com/RoleModel/chromium-pdf/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.17
+signing_key:
+specification_version: 4
+summary: A wrapper around headless Chrome's print-to-pdf functionality.
+test_files: []