capistrano-sidekiq 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61bb07339f25aae4a39fa10cb0dad5b696b13d89bb29e2c626d4d930cab246dc
-  data.tar.gz: fca70af00d2a413d6bd84d7ab9f40ff678000f32f6699b5bbb221704ab72eccc
+  metadata.gz: 40ec2af554f334c8b2ee7251460a2cb530490bdaa84467d4f7b799bbd91708bd
+  data.tar.gz: 47863fe4c06843041874692ab5f45a6e352bc6367bec5de23138f2311bad8e41
 SHA512:
-  metadata.gz: 3e5ebaa925990b9e6896328a3d78e0a187c3f794870ef5ed47fb0828f7a709236817020918aee2cd0cb7601e7b3bc739b36060a686abebd0988ed81f611d7a1e
-  data.tar.gz: 9325d11d20b43003c085dd645e66d9028b30d87ed8c8422bdd01996afdd7fb6b35cc9e34ecf794f410c10d6499e426620f44a1ec1bd3f34ec53e641fcffb082f
+  metadata.gz: 67b0f52888ea111e29d797f0565c11415a8eb8806bf3809c3d4229cd369175ee665fe43570bbc7d2317949fe876ff42e7d585345b2a3ee8c2f997cfb7b12763e
+  data.tar.gz: 8b3a5307a8221910c346f1967e05c7cfe1be65e0dfae9f996b53226ed28a8ee0fb3e3b7cf3c742c2769e0d67fc90942d181e0116078e656fa768dcc1672dc176

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Changelog
 
-## [Unreleased](https://github.com/seuros/capistrano-sidekiq/compare/v3.1.0...master)
+## [Unreleased](https://github.com/seuros/capistrano-sidekiq/compare/v3.2.0...master)
+
+## [3.2.0](https://github.com/seuros/capistrano-sidekiq/compare/v3.1.0...v3.2.0) - 2025-06-22
+
+### Changed
+- Harmonized interface with capistrano-puma for better ecosystem consistency
+- Aligned configuration variable naming patterns
+- Unified systemd command execution methods  
+- Standardized template search order across both gems
+- Added documentation reference to example application
 
 ## [3.1.0](https://github.com/seuros/capistrano-sidekiq/compare/v3.0.0...v3.1.0) - 2025-06-22
 

data/README.md

@@ -5,6 +5,15 @@
 
 Sidekiq integration for Capistrano - providing systemd service management and deployment coordination for Sidekiq 7+.
 
+## Example Application
+
+For a complete working example of this gem in action, see the [capistrano-example-app](https://github.com/seuros/capistrano-example-app) which demonstrates:
+- Rails 8.0 deployment with Capistrano
+- Sidekiq 7.0 with Redis 7+
+- Systemd service management
+- rbenv integration
+- Complete deployment guide
+
 ## Installation
 
 Add to your Gemfile:

data/lib/capistrano/sidekiq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Capistrano
-  SIDEKIQ_VERSION = '3.1.0'
+  SIDEKIQ_VERSION = '3.2.0'
 end

data/lib/capistrano/sidekiq.rb

@@ -5,22 +5,31 @@ require 'capistrano/plugin'
 
 module Capistrano
   module SidekiqCommon
-    def compiled_template(config_file = 'sidekiq.yml')
+    def compiled_template_sidekiq(from, role, config_file = 'sidekiq.yml')
+      @role = role
       @config_file = config_file
-      local_template_directory = fetch(:sidekiq_service_templates_path)
-      search_paths = [
-        File.join(local_template_directory, 'sidekiq.service.capistrano.erb'),
-        File.expand_path(
-          File.join(*%w[.. templates sidekiq.service.capistrano.erb]),
-          __FILE__
-        )
-      ]
-      template_path = search_paths.detect { |path| File.file?(path) }
-      template = File.read(template_path)
-      ERB.new(template, trim_mode: '-').result(binding)
+      file = [
+          "lib/capistrano/templates/#{from}-#{role.hostname}-#{fetch(:stage)}.rb",
+          "lib/capistrano/templates/#{from}-#{role.hostname}.rb",
+          "lib/capistrano/templates/#{from}-#{fetch(:stage)}.rb",
+          "lib/capistrano/templates/#{from}.rb.erb",
+          "lib/capistrano/templates/#{from}.rb",
+          "lib/capistrano/templates/#{from}.erb",
+          "config/deploy/templates/#{from}.rb.erb",
+          "config/deploy/templates/#{from}.rb",
+          "config/deploy/templates/#{from}.erb",
+          File.expand_path("../templates/#{from}.erb", __FILE__),
+          File.expand_path("../templates/#{from}.rb.erb", __FILE__)
+      ].detect { |path| File.file?(path) }
+      erb = File.read(file)
+      StringIO.new(ERB.new(erb, trim_mode: '-').result(binding))
     end
 
-    def expanded_bundle_path
+    def template_sidekiq(from, to, role, config_file = 'sidekiq.yml')
+      backend.upload! compiled_template_sidekiq(from, role, config_file), to
+    end
+
+    def expanded_bundle_command
       backend.capture(:echo, SSHKit.config.command_map[:bundle]).strip
     end
 
@@ -28,12 +37,12 @@ module Capistrano
       "--config config/#{@config_file}" if @config_file != 'sidekiq.yml'
     end
 
-    def switch_user(role, &)
+    def sidekiq_switch_user(role, &block)
       su_user = sidekiq_user(role)
       if su_user == role.user
         yield
       else
-        backend.as(su_user, &)
+        backend.as(su_user, &block)
       end
     end
 
@@ -42,9 +51,11 @@ module Capistrano
         fetch(:sidekiq_user)
       else
         properties = role.properties
-        properties.fetch(:sidekiq_user, nil) || # local property for sidekiq only
+        return role.user unless properties
+        
+        properties.fetch(:sidekiq_user) || # local property for sidekiq only
           fetch(:sidekiq_user, nil) ||
-          properties.fetch(:run_as, nil) || # global property across multiple capistrano gems
+          properties.fetch(:run_as) || # global property across multiple capistrano gems
           role.user
       end
     end
@@ -63,7 +74,7 @@ module Capistrano
       set_if_empty :sidekiq_configs, %w[sidekiq] # sidekiq.yml
 
       set_if_empty :sidekiq_log, -> { File.join(shared_path, 'log', 'sidekiq.log') }
-      set_if_empty :sidekiq_error_log, -> { File.join(shared_path, 'log', 'sidekiq.log') }
+      set_if_empty :sidekiq_error_log, -> { File.join(shared_path, 'log', 'sidekiq_error.log') }
 
       set_if_empty :sidekiq_config_files, ['sidekiq.yml']
 

data/lib/capistrano/tasks/systemd.rake

@@ -13,7 +13,7 @@ namespace :sidekiq do
     desc description
     task command do
       on roles fetch(:sidekiq_roles) do |role|
-        git_plugin.switch_user(role) do
+        git_plugin.sidekiq_switch_user(role) do
           git_plugin.config_files(role).each do |config_file|
             git_plugin.execute_systemd(command, git_plugin.sidekiq_service_file_name(config_file))
           end
@@ -25,7 +25,7 @@ namespace :sidekiq do
   desc 'Quiet Sidekiq (stop fetching new tasks from Redis)'
   task :quiet do
     on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
+      git_plugin.sidekiq_switch_user(role) do
         git_plugin.quiet_sidekiq(role)
       end
     end
@@ -34,7 +34,7 @@ namespace :sidekiq do
   desc 'Install Sidekiq systemd service'
   task :install do
     on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
+      git_plugin.sidekiq_switch_user(role) do
         git_plugin.create_systemd_template(role)
       end
     end
@@ -45,7 +45,7 @@ namespace :sidekiq do
   task :uninstall do
     invoke 'sidekiq:disable'
     on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
+      git_plugin.sidekiq_switch_user(role) do
         git_plugin.rm_systemd_service(role)
       end
     end
@@ -87,10 +87,10 @@ namespace :sidekiq do
     backend.execute :mkdir, '-p', systemd_path if fetch(:sidekiq_systemctl_user) != :system
 
     config_files(role).each do |config_file|
-      ctemplate = compiled_template(config_file)
+      ctemplate = compiled_template_sidekiq('sidekiq.service.capistrano', role, config_file)
       temp_file_name = File.join('/tmp', "sidekiq.#{config_file}.service")
       systemd_file_name = File.join(systemd_path, sidekiq_service_file_name(config_file))
-      backend.upload!(StringIO.new(ctemplate), temp_file_name)
+      backend.upload!(ctemplate, temp_file_name)
       if fetch(:sidekiq_systemctl_user) == :system
         warn "Installing #{systemd_file_name} as root"
         backend.execute :sudo, :mv, temp_file_name, systemd_file_name

data/lib/capistrano/templates/sidekiq.service.capistrano.erb

@@ -21,9 +21,9 @@ WatchdogSec=10
 <%="User=#{sidekiq_user}" if fetch(:sidekiq_systemctl_user) == :system %>
 WorkingDirectory=<%= current_path %>
 <% if fetch(:sidekiq_use_login_shell) %>
-ExecStart=/bin/bash -lc '<%= expanded_bundle_path %> exec <%= fetch(:sidekiq_command) %> <%= fetch(:sidekiq_command_args) %> <%= sidekiq_config %>'
+ExecStart=/bin/bash -lc '<%= expanded_bundle_command %> exec <%= fetch(:sidekiq_command) %> <%= fetch(:sidekiq_command_args) %> <%= sidekiq_config %>'
 <% else %>
-ExecStart=<%= expanded_bundle_path %> exec <%= fetch(:sidekiq_command) %> <%= fetch(:sidekiq_command_args) %> <%= sidekiq_config %>
+ExecStart=<%= expanded_bundle_command %> exec <%= fetch(:sidekiq_command) %> <%= fetch(:sidekiq_command_args) %> <%= sidekiq_config %>
 <% end %>
 
 # Use `systemctl kill -s TSTP <% sidekiq_service_unit_name(@config_file) %>` to quiet the Sidekiq process

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Abdelkader Boudih