capistrano-ops 0.2.12 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6192691d485f5348cadfb470f7c06c7e86e4aca51daedcb1ffe33be9923a2d
-  data.tar.gz: 469cba09f0f444133aa54451d8e7f06fac4430d3ab9cc67bc52714f76402949f
+  metadata.gz: cec4486500e5ddac70640e6f3d074b51b361d649079e98f9ef6d337712c3de23
+  data.tar.gz: ac8df454d33822890a673e800db7492bc7d4d2a7f54c0fe91378648fa163a2f8
 SHA512:
-  metadata.gz: 0bca2a6b0dd5e2b7dd724c623ea1f9f22bb6c05ca16ee654f805253fac5dedbf955c1c729dac8aa3c4d66822eead8b38cb7a62645dca5d7b11fe034cf860b3ca
-  data.tar.gz: 74c95eea7b0f4bc7b95b24010f7a651a987a06234f455c63e68d9e8cac3961930a2fe0cc9dee105be44401b40aef01a40ba274734cd1bf9cc3255884dfe6766c
+  metadata.gz: c97bd7b0f7b0f9968b30d81a8807da57d690a4700e6674596f64b970727e4d99606af7ac8e192691fae63a0e5cf67ee54936bda0d1d06d935c37e068b3afdf41
+  data.tar.gz: aac3a0d13aa1c8f78ab77f5943b2ee5944c561829831c117afd8dc1cfd0e0e638406c9bcda52f92c1cc53b1f8eeef455e9d62e1929ffe984e3408812a22de4eb

data/README.md

@@ -264,6 +264,34 @@ sudo apt-get install logrotate
 
 Once logrotate is installed, you can use the capistrano-ops tasks to manage it.
 
+## Wkhtmltopdf Setup
+
+This script is used to setup `wkhtmltopdf-binary` in your deployment environment. It is designed to work with Capistrano.
+
+The main task `setup` is hooked to run after the `deploy:symlink:release` task.
+It performs the following operations:
+
+- unzip the necessary binary file
+
+- set the binary file permissions
+
+The script assumes, that you have a intializer file for `wicked_pdf` gem, which sets the path to the binary file.
+for example:
+
+```ruby
+# config/initializers/wicked_pdf.rb
+WickedPdf.config = {
+  exe_path: "#{Bundler.bundle_path}/gems/wkhtmltopdf-binary-0.12.6.6/bin/wkhtmltopdf_ubuntu_18.04_amd64",
+}
+```
+
+To use this script, include it in your Capistrano tasks and it will automatically run during deployment.
+
+```ruby
+# Capfile
+require 'capistrano/ops/wkhtmltopdf'
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/zauberware/capistrano-ops/fork )

data/lib/capistrano/ops/capistrano/tasks/wkhtmltopdf.rake

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+namespace :wkhtmltopdf do
+  after 'deploy:symlink:release', 'wkhtmltopdf:setup'
+
+  desc 'unzip wkhtmltopdf if necessary'
+  task :setup do
+    on roles(:app) do
+      within release_path do
+        binary_path, version = binary_path_and_version
+        info("setup wkhtmltopdf version #{version}")
+        check_file_and_permissions(binary_path, version)
+      end
+    end
+  end
+end
+def binary_path_and_version
+  # get the binary path of wkhtmltopdf-binary
+  gem_path = capture(:bundle, 'show', 'wkhtmltopdf-binary').strip
+  binary_path = "#{gem_path}/bin"
+
+  # get the use wkhtmltopdf_ubuntu version from the wicked_pdf initializer
+  version = capture(:cat, 'config/initializers/wicked_pdf.rb').scan(/wkhtmltopdf_ubuntu_(\d+\.\d+)_amd64/).flatten.first
+
+  [binary_path, version]
+end
+
+def check_file_and_permissions(binary_path, version)
+  binary_file = "#{binary_path}/wkhtmltopdf_ubuntu_#{version}_amd64"
+
+  if test("[ -f #{binary_file} ]")
+    info('wkhtmltopdf binary already extracted')
+
+    if test("[ $(stat -c '%a' #{binary_file}) = '777' ]")
+      info('wkhtmltopdf binary has already the right permissions')
+    else
+      info('adding right permissions to wkhtmltopdf binary')
+      execute("chmod 777 #{binary_file}")
+    end
+  else
+    info('extracting wkhtmltopdf binary')
+    # extract the binary but keep the gzip file
+    execute("cd #{binary_path} && gzip -dk  wkhtmltopdf_ubuntu_#{version}_amd64.gz")
+    # add execute permission to the binary
+    execute("chmod 777 #{binary_file}")
+  end
+  info('wkhtmltopdf setup finished')
+end

data/lib/capistrano/ops/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Ops
-    VERSION = '0.2.12'
+    VERSION = '0.2.13'
   end
 end

data/lib/capistrano/ops/wkhtmltopdf.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+load File.expand_path('capistrano/tasks/wkhtmltopdf.rake', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ops
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.13
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -120,6 +120,7 @@ files:
 - lib/capistrano/ops/backup/s3.rb
 - lib/capistrano/ops/backup/s3_helper.rb
 - lib/capistrano/ops/capistrano.rb
+- lib/capistrano/ops/capistrano/tasks/wkhtmltopdf.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup/backup_helper.rb
 - lib/capistrano/ops/capistrano/v3/tasks/backup/database/create.rake
@@ -147,6 +148,7 @@ files:
 - lib/capistrano/ops/tasks/storage/backup.rake
 - lib/capistrano/ops/tasks/storage/remove_old_backups.rake
 - lib/capistrano/ops/version.rb
+- lib/capistrano/ops/wkhtmltopdf.rb
 homepage: https://github.com/zauberware/capistrano-ops
 licenses:
 - MIT