capistrano3_featureset 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 231ac973fe34af91da551956ba5e43bd31fe2e689814fd40b87ddfdebd101f63
+  data.tar.gz: 708e8403c5c5dcf2805a2c9ad4f016df31bc7a38dbe536fb4d418c73b2891a29
+SHA512:
+  metadata.gz: 81c2fc24ef4eab4e70d2b67f5b9e1efb45f8909b7be4f4837bffccc682896fffad2a420ea5ae803883afe957c6b41223574aeda2b47e29f234b1e74117c2f5ea
+  data.tar.gz: 33f91074feb41afbcec62dadea1f6adaa8e4926f33e30b732d558a8103723959202d0ad748ed71c51f09ced2f92af45d53ac0c0d3f54910b8c8402c3f4ccd1e9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in m3_capistrano3.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Georg Limbach
+
+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,52 @@
+# Capistrano3 - Feature set
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'capistrano3_featureset'
+```
+
+And then execute:
+
+    $ bundle install
+
+Add this to your deployment files:
+
+```ruby
+# Capfile
+
+require 'capistrano3_featureset/default'
+
+# Load custom tasks from `lib/capistrano/tasks` if you have any defined
+Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }
+```
+
+```ruby
+# config/deploy.rb
+
+# config valid for current version and patch releases of Capistrano
+lock '~> 3.11.2'
+
+set :application, 'application-name'
+set :repo_url, 'git@github.com:your-repo.git'
+set :deploy_to, '/srv/application-name'
+
+set :rvm_ruby_version, '3.1.1'
+
+# set :enable_delayed_job, false # default is false
+# set :enable_solid_queue, false # default is false
+# set :enable_whenever, false # default is false
+# set :enable_unicorn, false # default is false
+# set :enable_puma, false # default is false
+# set :systemd_usage, true # default is true
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Integration of Capistrano 3.7.1+ rsync plugin
+
+see https://github.com/infovore/capistrano-rsync-plugin

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano3_featureset.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano3_featureset'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Georg Limbach', 'Tom Armitage', 'Stefan Daschek']
+  spec.email         = ['georg.limbach@lichtbit.com']
+
+  spec.summary       = 'Capistrano3 feature set'
+  spec.description   = 'Capistrano3 feature set'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) { `git ls-files -z`.split("\x0") }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.0'
+  spec.add_dependency 'capistrano-rails'
+  spec.add_dependency 'capistrano-rvm'
+  spec.add_dependency 'ed25519' #  to use modern ssh key ciphers
+  spec.add_dependency 'bcrypt_pbkdf' #  to use modern ssh key ciphers
+end

data/lib/capistrano/rsync.rb

@@ -0,0 +1,91 @@
+require 'capistrano/scm/plugin'
+
+class Capistrano::SCM
+  class Rsync < ::Capistrano::SCM::Plugin
+    def set_defaults
+       # command-line options for rsync
+      set_if_empty :rsync_options, %w[--archive --delete --exclude=.git*]
+
+      # Local cache (Git checkout will be happen here, resulting files then get rsynced to the remote server)
+      set_if_empty :rsync_local_cache, 'tmp/.capistrano-rsync-deploy'
+
+      # Remote cache on the server. Will be synced with the local cache before each release, and then used as
+      # source for the release. Saves needing to transfer all the source files for each release.
+      set_if_empty :rsync_remote_cache, 'rsync-deploy'
+
+      # Git fetch automaticly submodules
+      set_if_empty :rsync_git_submodules, true
+    end
+
+    def define_tasks
+      namespace :rsync do
+        desc <<-DESC
+            Copy application source code from (remote) cache to release path.
+
+            If a :rsync_deploy_build_path is set, only that relative path will \
+            be copied to the release path.
+        DESC
+        task create_release: :update_remote_cache do
+          on release_roles :all do
+            execute :rsync, '--archive', "#{fetch(:deploy_to)}/#{fetch(:rsync_remote_cache)}/#{fetch(:rsync_deploy_build_path)}", "#{release_path}/"
+          end
+        end
+
+        desc <<-DESC
+            Update remote cache of application source code.
+
+            This will be rsynced to :rsync_remote_cache, using rsync options set in \
+            :rsync_options
+        DESC
+        task update_remote_cache: :update_local_cache do
+          on release_roles :all do |role|
+            host_spec = role.hostname
+            host_spec = "#{role.user}@#{host_spec}" if role.user
+            run_locally do
+              execute :rsync, *fetch(:rsync_options), "#{fetch(:rsync_local_cache)}/", "#{host_spec}:#{fetch(:deploy_to)}/#{fetch(:rsync_remote_cache)}/"
+            end
+          end
+        end
+
+        desc <<-DESC
+            Update local cache of application source code.
+
+            This will be checked out to :rsync_local_cache.
+        DESC
+        task :update_local_cache do
+          run_locally do
+            unless File.exist?("#{fetch(:rsync_local_cache)}/.git")
+              FileUtils.mkdir_p(fetch(:rsync_local_cache))
+              recursive_submodules = fetch(:rsync_git_submodules) ? '--recurse-submodules' : ''
+              execute :git, :clone, recursive_submodules, '--quiet', repo_url, fetch(:rsync_local_cache)
+            end
+            within fetch(:rsync_local_cache) do
+              execute :git, :fetch, '--quiet', '--all', '--prune'
+              execute :git, :checkout, fetch(:branch)
+              execute :git, :reset, '--quiet', '--hard', "origin/#{fetch(:branch)}"
+              execute :git, :submodule, :update, '--recursive', '--init' if fetch(:rsync_git_submodules)
+            end
+          end
+        end
+
+        desc <<-DESC
+            Determine version of code that rsync will deploy.
+
+            By default, this is the latest version of the code on branch :branch.
+        DESC
+        task :set_current_revision do
+          run_locally do
+            within fetch(:rsync_local_cache) do
+              set :current_revision, capture(:git, "rev-list --max-count=1 #{fetch(:branch)}")
+            end
+          end
+        end
+      end
+    end
+
+    def register_hooks
+      after 'deploy:new_release_path', 'rsync:create_release'
+      before 'deploy:set_current_revision', 'rsync:set_current_revision'
+    end
+  end
+end

data/lib/capistrano3_featureset/default.rb

@@ -0,0 +1,19 @@
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# Include rsync with remote cache
+require 'capistrano/rsync'
+install_plugin Capistrano::SCM::Rsync
+
+require 'capistrano/rvm'
+require 'capistrano/rails'
+begin
+  require 'whenever/capistrano'
+rescue StandardError, LoadError
+  nil
+end
+
+load File.expand_path('tasks/featureset.rake', __dir__)

data/lib/capistrano3_featureset/tasks/featureset.rake

@@ -0,0 +1,153 @@
+namespace :featureset do
+  desc 'generate static error 500 pages'
+  task :generate_static_500_html do
+    on roles(:web) do |host|
+      next unless host.properties.error_500_url
+
+      within release_path do
+        execute :curl, '-sk', host.properties.error_500_url, '-o', 'public/500.html'
+      end
+    end
+  end
+
+  desc 'generate static error pages'
+  task :generate_static_error_html do
+    on roles(:web) do |host|
+      next unless host.properties.static_error_urls
+      next unless host.properties.static_error_urls.is_a?(Hash)
+
+      within release_path do
+        host.properties.static_error_urls.each do |name, url|
+          execute :curl, '-sk', url, '-o', name
+        end
+      end
+    end
+  end
+
+  desc 'load full schema to prevent old migration errors'
+  task :db_load_schema do
+    on roles(:db) do
+      within release_path do
+        with(
+          rails_env: fetch(:rails_env),
+          rails_groups: fetch(:rails_assets_groups),
+          disable_database_environment_check: 1,
+        ) do
+          execute :rake, 'db:environment:set'
+          execute :rake, 'db:schema:load'
+        end
+      end
+    end
+  end
+
+  %w[start stop restart upgrade].each do |command|
+    desc "#{command} unicorn (init.d)"
+    task :"unicorn_#{command}" do
+      on roles(:app) do
+        unless fetch(:enable_unicorn)
+          info 'Unicorn disabled'
+          next
+        end
+
+        if fetch(:systemd_usage)
+          command = 'reload' if command == 'upgrade'
+          execute "sudo", "/usr/sbin/service unicorn_#{fetch(:application)}", command
+        else
+          execute "/etc/init.d/unicorn_#{fetch(:application)}", command
+        end
+      end
+    end
+  end
+
+  %w[start stop restart reload].each do |command|
+    desc "#{command} puma"
+    task :"puma_#{command}" do
+      on roles(:app) do
+        unless fetch(:enable_puma)
+          info 'Puma disabled'
+          next
+        end
+
+        execute "sudo", "/usr/sbin/service puma_#{fetch(:application)}", command
+      end
+    end
+  end
+
+  %w[start stop restart].each do |command|
+    desc "#{command} delayed_job process"
+    task :"delayed_job_#{command}" do
+      on roles(:app) do
+        unless fetch(:enable_delayed_job)
+          info 'Delayed job disabled'
+          next
+        end
+          
+        if fetch(:systemd_usage)
+          execute "sudo", "/usr/sbin/service delayed_job_#{fetch(:application)}", command
+        else
+          execute "/usr/local/bin/#{fetch(:application)}.delayed_job", command
+        end
+      end
+    end
+  end
+
+  %w[start stop restart].each do |command|
+    desc "#{command} solid_queue process"
+    task :"solid_queue_#{command}" do
+      on roles(:app) do
+        unless fetch(:enable_solid_queue)
+          info 'Solid queue disabled'
+          next
+        end
+          
+        execute "sudo", "/usr/sbin/service solid_queue_#{fetch(:application)}", command
+      end
+    end
+  end
+
+  desc 'Symlink linked directories'
+  task :linked_dirs do
+    on release_roles :all do
+      fetch(:more_linked_dirs).each do |target, source|
+        target_path = release_path.join(target)
+        source_path = shared_path.join(source)
+        execute :mkdir, '-p', target_path.dirname
+        next if test "[ -L #{target_path} ]"
+
+        execute :rm, '-rf', target_path if test "[ -d #{target_path} ]"
+        execute :ln, '-s', source_path, target_path
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    rsync_excludes = %w[.git* spec rspec test Capfile config/deploy config/deploy.rb]
+    set :rsync_options, "-azc --delete --delete-excluded --exclude #{rsync_excludes.join(' --exclude ')}"
+
+    set :rvm_type, :user
+
+    set :enable_delayed_job, false
+    set :enable_solid_queue, false
+    set :enable_whenever, false
+    set :enable_unicorn, false
+    set :enable_puma, false
+
+    set :systemd_usage, true
+
+    append :linked_dirs, 'public/uploads'
+    append :linked_dirs, 'private'
+    append :linked_dirs, 'log'
+    set :more_linked_dirs, 'tmp/pids' => 'pids'
+  end
+end
+
+before 'deploy:migrate', 'featureset:db_load_schema' unless ENV['FIRST_DEPLOYMENT'].nil?
+after 'deploy:publishing', 'featureset:puma_reload'
+after 'deploy:publishing', 'featureset:unicorn_upgrade'
+after 'featureset:unicorn_upgrade', 'featureset:generate_static_500_html'
+after 'featureset:unicorn_upgrade', 'featureset:generate_static_error_html'
+after 'deploy:publishing', 'featureset:delayed_job_restart'
+after 'deploy:publishing', 'featureset:solid_queue_restart'
+after 'deploy:symlink:linked_dirs', 'featureset:linked_dirs'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3_featureset
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Georg Limbach
+- Tom Armitage
+- Stefan Daschek
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-rvm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano3 feature set
+email:
+- georg.limbach@lichtbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano3_featureset.gemspec
+- lib/capistrano/rsync.rb
+- lib/capistrano3_featureset.rb
+- lib/capistrano3_featureset/default.rb
+- lib/capistrano3_featureset/tasks/featureset.rake
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Capistrano3 feature set
+test_files: []