capistrano-ops 0.2.12 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c6192691d485f5348cadfb470f7c06c7e86e4aca51daedcb1ffe33be9923a2d
-  data.tar.gz: 469cba09f0f444133aa54451d8e7f06fac4430d3ab9cc67bc52714f76402949f
+  metadata.gz: 72b073b9c2ecb5026ab9f56c3953f9bd664e5537087a07c7a22cd390a69fe7da
+  data.tar.gz: 60e5b8b52641c59bd1c6c3ec1b99aef79e90269a2ca11deb23b39283348b00e1
 SHA512:
-  metadata.gz: 0bca2a6b0dd5e2b7dd724c623ea1f9f22bb6c05ca16ee654f805253fac5dedbf955c1c729dac8aa3c4d66822eead8b38cb7a62645dca5d7b11fe034cf860b3ca
-  data.tar.gz: 74c95eea7b0f4bc7b95b24010f7a651a987a06234f455c63e68d9e8cac3961930a2fe0cc9dee105be44401b40aef01a40ba274734cd1bf9cc3255884dfe6766c
+  metadata.gz: 6bff0e67cad4a819dd93400b7de6b8acbec6642df2bc15e569cfd3a3a2ae6ec38a70f38eb09483f90b335cc423da5ef3ef9e2a912b036fe576911b35f26f1bfa
+  data.tar.gz: eb67fd7c492534f4e4086327631ea52c391802f76f3ac17b17525313483eff0ec8e54441a08f045a78d75714ab4fc9691a71de47706ffa7a03ce56786b85900d

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-performance
+  - rubocop-rails
 AllCops:
   NewCops: disable
   TargetRubyVersion: 2.7
@@ -19,3 +22,7 @@ Metrics/PerceivedComplexity:
   Max: 25
 Style/Documentation:
   Enabled: false
+Rails/RakeEnvironment:
+  Enabled: false
+Rails/Output:
+  Enabled: false

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/capistrano-ops.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'rails'
   s.add_development_dependency 'bundler', '~> 2.4.12'
   s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rubocop', '~> 1.56.2' # rubocop ruby
+  s.add_development_dependency 'rubocop-performance', '~> 1.19.0' # speed up rubocop
 end

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/capistrano/v3/tasks/figaro_yml/compare.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'figaro_yaml_helper'
+
+namespace :figaro_yml do
+  include FigaroYmlHelper
+  rake_roles = fetch(:rake_roles, :app)
+
+  desc 'compare and set the figaro_yml file on the server'
+  task :compare do
+    env = fetch(:stage).to_s
+    # Read and parse local application.yml
+    local = local_yaml
+
+    # Split into stage-specific and global configurations
+    local_global_env, local_stage_env = configs(local, env)
+
+    # puts local_global_env.to_yaml
+    # puts "\n\n\n"
+    # puts({ env => local_stage_env }.to_yaml)
+    on roles(rake_roles) do
+      # Read and parse remote application.yml
+      remote = YAML.safe_load(capture("cat #{shared_path}/config/application.yml"))
+      remote_global_env, remote_stage_env = configs(remote, env)
+
+      # puts remote_global_env.to_yaml
+      # puts "\n\n\n"
+      # puts({ env => remote_stage_env }.to_yaml)
+      # puts "Comparing local and remote application.yml for '#{env}' environment..."
+
+      # Compare hashes and handle nil results with empty hashes
+      differences_global = compare_hashes(local_global_env, remote_global_env)
+      differences_stage = compare_hashes(local_stage_env, remote_stage_env)
+
+      print_changes(differences_global, 'Local application.yml has extra/different global entries compared to remote.')
+      print_changes(differences_stage, "Local application.yml has extra/different entries in #{env} section compared to remote.") if differences_stage
+
+      puts 'No Differences found between remote and local application.yml' unless differences_global || differences_stage
+
+      # ask to overwrite remote yml if differences found
+      overwrite_remote = ask_to_overwrite('Overwrite remote application.yml') if differences_global || differences_stage
+      puts 'Nothing written to remote application.yml' unless overwrite_remote
+
+      exit unless overwrite_remote
+      # sort local yml before updating remote
+      puts 'Preparing local application.yml before updating remote...'
+      invoke 'figaro_yml:sort_local'
+      puts 'Local application.yml is ready to be updated.'
+
+      # update remote yml
+      invoke 'figaro_yml:setup'
+      ##
+      # TODO: restart server after updating remote yml
+      # let user choose to restart server after updating remote yml
+      # let user choose to restart server now or later if they choose to restart now
+      # ask for time to restart server if he chooses to restart later
+      # restart server after the time given
+      ##
+      puts 'Remote application.yml has been updated.'
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/figaro_yaml_helper.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module FigaroYmlHelper
+  def environments
+    Dir.glob('config/deploy/*.rb')
+  end
+
+  def local_yaml
+    YAML.safe_load(File.read('config/application.yml')) || {}
+  end
+
+  def write_to_file(file, content)
+    File.open(file, 'w') do |f|
+      f.write(content)
+    end
+  end
+
+  def write_combined_yaml(yamls_combined)
+    if yamls_combined.empty?
+      info 'No data to write.'
+    else
+      # write to new file
+      info 'writing to config/application.yml'
+      write_to_file('config/application.yml', yamls_combined.to_yaml)
+    end
+  end
+
+  def compare_hashes(hash1, hash2)
+    all_keys = hash1.keys | hash2.keys # Union of all keys from both hashes
+    all_keys.each_with_object({}) do |key, changes_hash|
+      old_value = hash2[key].nil? ? 'nil' : hash2[key].to_s
+      new_value = hash1[key].nil? ? 'nil' : hash1[key].to_s
+
+      changes_hash[key] = { old: old_value, new: new_value } if old_value != new_value
+    end.tap { |changes| return changes.empty? ? nil : changes }
+  end
+
+  def print_changes(changes, message)
+    return unless changes
+
+    puts "#{message}:\n\n"
+    changes.each do |key, diff|
+      puts "#{key}: #{diff[:old]} => #{diff[:new]}"
+    end
+    puts "\n"
+  end
+
+  def ask_to_overwrite(question)
+    answer = ''
+    until %w[y n].include?(answer)
+      print "#{question}? (y/N): "
+      answer = $stdin.gets.strip.downcase
+    end
+    answer == 'y'
+  end
+
+  def configs(yaml, env)
+    stage_yml = yaml[env.to_s]&.sort.to_h
+    global_yml = remove_nested(yaml)&.sort.to_h
+    [global_yml, stage_yml]
+  end
+
+  def remove_nested(hash)
+    hash.each_with_object({}) do |(key, value), new_hash|
+      new_hash[key] = value unless value.is_a?(Hash)
+    end
+  end
+
+  def sort_with_nested(hash)
+    hash.each_with_object({}) do |(key, value), new_hash|
+      new_hash[key] = value.is_a?(Hash) ? sort_with_nested(value) : value
+    end.sort.to_h
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/get.rake

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'figaro_yaml_helper'
+
+namespace :figaro_yml do
+  include FigaroYmlHelper
+
+  rake_roles = fetch(:rake_roles, :app)
+  desc 'get the `application.yml` file from server and create local if it does not exist'
+  task :get do
+    env = fetch(:stage)
+    if !File.exist?('config/application.yml')
+      run_locally do
+        puts "found #{environments.count} stages"
+        yamls_combined = {}
+
+        stages.each do |f|
+          stage = File.basename(f, '.rb')
+          puts "download #{stage} application.yml"
+          begin
+            res = capture "cap #{stage} figaro_yml:get_stage"
+            stage_yaml = YAML.safe_load(res)
+            stage_yaml[stage.to_s] = stage_yaml[stage.to_s].sort.to_h
+            yamls_combined.merge!(stage_yaml) if stage_yaml
+          rescue StandardError
+            puts "could not get #{stage} application.yml"
+          end
+        end
+
+        write_combined_yaml(yamls_combined.sort.to_h)
+      end
+    else
+      on roles(rake_roles) do
+        local_yml = local_yaml.sort.to_h
+        local_global, local_stage = configs(local_yml, env)
+
+        remote = capture("cat #{shared_path}/config/application.yml")
+        remote_yml = YAML.safe_load(remote).sort.to_h
+        remote_global, remote_stage = configs(remote_yml, env)
+
+        differences_global = compare_hashes(remote_global, local_global || {})
+        differences_stage = compare_hashes(remote_stage, local_stage || {})
+
+        print_changes(differences_global,
+                      'Remote application.yml has extra/different global entries compared to local.')
+        print_changes(differences_stage, "Remote application.yml has extra/different entries in #{env} section compared to local.") if differences_stage
+
+        puts 'No Differences found between remote and local application.yml' unless differences_global || differences_stage
+
+        # ask to overwrite local yml if differences found
+        stage_overwrite = ask_to_overwrite("Overwrite local application.yml #{env} section") if differences_stage
+        global_overwrite = ask_to_overwrite('Overwrite local application.yml globals') if differences_global
+        puts 'Nothing written to local application.yml' unless stage_overwrite || global_overwrite
+        exit unless stage_overwrite || global_overwrite
+
+        # compose new yml
+        composed_yml = {}
+        composed_yml.merge!(local_yml) # local yml is always included to avoid losing any data
+        composed_yml.merge!(local_global) unless global_overwrite
+        composed_yml.merge!(remote_global) if global_overwrite
+        composed_yml[env.to_s] = stage_overwrite ? remote_stage : local_stage
+
+        # write to new file
+        write_combined_yaml(composed_yml.sort.to_h)
+      end
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/get_stage.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'figaro_yaml_helper'
+
+namespace :figaro_yml do
+  rake_roles = fetch(:rake_roles, :app)
+
+  task :get_stage do
+    on roles(rake_roles) do
+      puts capture "cat #{shared_path}/config/application.yml"
+    end
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/sort_local.rake

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'figaro_yaml_helper'
+
+namespace :figaro_yml do
+  include FigaroYmlHelper
+
+  task :sort_local do
+    run_locally do
+      info 'Sorting local application.yml...'
+      local = local_yaml
+      sorted_local = sort_with_nested(local)
+      write_combined_yaml(sorted_local)
+    end
+  end
+
+  task :sort do
+    invoke 'figaro_yml:sort_local'
+  end
+end

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir.glob("#{File.expand_path(__dir__)}/figaro_yml/**/*.rake").each { |f| load f }

data/lib/capistrano/ops/capistrano.rb

@@ -5,12 +5,14 @@ require 'capistrano/version'
 if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
   load File.expand_path('capistrano/v3/tasks/whenever.rake', __dir__)
   load File.expand_path('capistrano/v3/tasks/backup.rake', __dir__)
-  load File.expand_path('capistrano/v3/tasks/figaro_yml.rake', __dir__)
+  load File.expand_path('capistrano/v3/tasks/figaro_yml.rb', __dir__)
+
   load File.expand_path('capistrano/v3/tasks/invoke.rake', __dir__)
   path = File.expand_path(__dir__)
   Dir.glob("#{path}/capistrano/v3/tasks/backup/**/*.rake").each { |f| load f }
   Dir.glob("#{path}/capistrano/v3/tasks/logrotate/**/*.rake").each { |f| load f }
   Dir.glob("#{path}/capistrano/v3/tasks/logs/**/*.rake").each { |f| load f }
+
 else
   puts 'Capistrano 3 is required to use this gem'
 end

data/lib/capistrano/ops/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Ops
-    VERSION = '0.2.12'
+    VERSION = '0.2.14'
   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.14
 platform: ruby
 authors:
 - Florian Crusius
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -94,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.56.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.56.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.19.0
 description: A collection of devops tasks for rails applications
 email:
 - florian@zauberware.com
@@ -120,13 +148,19 @@ 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
 - lib/capistrano/ops/capistrano/v3/tasks/backup/database/pull.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup/storage/create.rake
 - lib/capistrano/ops/capistrano/v3/tasks/backup/storage/pull.rake
-- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rake
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rb
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/compare.rake
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/figaro_yaml_helper.rb
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/get.rake
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/get_stage.rake
+- lib/capistrano/ops/capistrano/v3/tasks/figaro_yml/sort_local.rake
 - lib/capistrano/ops/capistrano/v3/tasks/invoke.rake
 - lib/capistrano/ops/capistrano/v3/tasks/logrotate/check.rake
 - lib/capistrano/ops/capistrano/v3/tasks/logrotate/disable.rake
@@ -147,6 +181,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

data/lib/capistrano/ops/capistrano/v3/tasks/figaro_yml.rake

@@ -1,139 +0,0 @@
-# frozen_string_literal: true
-
-# rubocop:disable Metrics/BlockLength
-namespace :figaro_yml do
-  # Defaults to :app role
-  rake_roles = fetch(:rake_roles, :app)
-
-  desc 'get the `application.yml` file from server and create local if it does not exist'
-  task :get do
-    env = fetch(:stage)
-    if !File.exist?('config/application.yml')
-      puts 'config/application.yml does not exist, creating it from all stages'
-      run_locally do
-        yamls = {}
-        stages = Dir.glob('config/deploy/*.rb')
-        puts "found #{stages.count} stages"
-        stages.map do |f|
-          stage = File.basename(f, '.rb')
-          puts "download #{stage} application.yml"
-          begin
-            res = capture "cap #{stage} figaro_yml:get_stage"
-            yamls = yamls.merge(YAML.safe_load(res))
-          rescue StandardError
-            puts "could not get #{stage} application.yml"
-          end
-          yamls
-        end
-        # write to new file
-        puts 'writing to config/application.yml'
-        write_to_file('config/application.yml', yamls.to_yaml)
-      end
-    else
-      local_yml = YAML.safe_load(File.read('config/application.yml'))
-      on roles(rake_roles) do
-        remote = capture("cat #{shared_path}/config/application.yml")
-        remote_yml = YAML.safe_load(remote)
-        remote_stage = remote_yml[env.to_s]
-        puts "remote application.yml stage '#{env}':\n\n"
-        puts "#{remote}\r\n"
-        puts "\r\n"
-        loop do
-          print "Overwrite local application.yml stage '#{env}'? (y/N): "
-          input = $stdin.gets.strip.downcase
-          answer = (input.empty? ? 'N' : input).downcase.to_s
-
-          next unless %w[y n].include?(answer)
-
-          if answer == 'y'
-            puts 'Updating local application.yml'
-            local_yml[env.to_s] = remote_stage
-            write_to_file('config/application.yml', local_yml.to_yaml)
-            exit
-          end
-          break
-        end
-        puts 'Nothing written to local application.yml'
-        exit
-      end
-    end
-  end
-
-  task :get_stage do
-    on roles(rake_roles) do
-      puts capture "cat #{shared_path}/config/application.yml"
-    end
-  end
-
-  desc 'compare and set the figaro_yml file on the server'
-  task :compare do
-    env = fetch(:stage)
-    # read local application.yml
-    local = File.read('config/application.yml')
-
-    # convert to hash
-    local_global_env = YAML.safe_load(local)
-
-    # split into stage and global
-    local_stage_env = local_global_env[env.to_s]
-    local_global_env.delete('staging')
-    local_global_env.delete('production')
-
-    on roles(rake_roles) do
-      # read remote application.yml
-      remote = capture("cat #{shared_path}/config/application.yml")
-
-      remote_global_env = YAML.safe_load(remote)
-      remote_stage_env = remote_global_env[env.to_s]
-      remote_global_env.delete(env.to_s)
-
-      puts "with command 'cap #{env} figaro_yml:setup', following variables will be overwritten:"
-      puts '--------------------------------------------------------------------------------'
-      result1 = compare_hashes(local_global_env, remote_global_env)
-      result2 = compare_hashes(local_stage_env, remote_stage_env)
-      if !result1.empty? || !result2.empty?
-        loop do
-          print 'Update remote application.yml? (y/N): '
-          input = $stdin.gets.strip.downcase
-          answer = (input.empty? ? 'N' : input).downcase.to_s
-
-          next unless %w[y n].include?(answer)
-
-          if answer == 'y'
-            puts 'Updating remote application.yml'
-            invoke 'figaro_yml:setup'
-            exit
-          end
-          break
-        end
-        puts 'remote application.yml not updated'
-        exit
-      end
-      puts 'remote application.yml is up to date'
-    end
-  end
-  def compare_hashes(hash1, hash2)
-    changes = false
-    local_server = hash1.to_a - hash2.to_a
-    server_local = hash2.to_a - hash1.to_a
-
-    [local_server + server_local].flatten(1).to_h.each_key do |k|
-      new_value = hash1[k].to_s
-      new_value = new_value.empty? ? 'nil' : new_value
-      old_value = hash2[k].to_s
-      old_value = old_value.empty? ? 'nil' : old_value
-
-      if old_value != new_value
-        puts "#{k}: #{old_value} => #{new_value} \r\n"
-        changes = true
-      end
-    end
-  end
-
-  def write_to_file(file, content)
-    File.open(file, 'w') do |f|
-      f.write(content)
-    end
-  end
-end
-# rubocop:enable Metrics/BlockLength