capistrano-cable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6b994fb2900c73d5d4afe2a12e7a7432e2a53611fd37ad2ac4534031a3bbd65
+  data.tar.gz: bc7ee8750a36a2d613eaf7c9e8379da3d4d21cf5d69dffb40c5347eb0e8a8b07
+SHA512:
+  metadata.gz: 78ddf453aeeadee09e1bfe8418f7435fbc8565fdfbb9131f47b4e8d8a1d06f6f57f4245ee0cf0d8b77450aab013a8ab9f9b46e82095572843e961bfe701dc7d8
+  data.tar.gz: c094d0a7acda838ad3c219a29deee9226765213099a41a03d0176a98a75a0782ce6e57ae0f902904f4d71998abea30afea634a16d7e94a9a7645180790435f5b

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at brice@codeur.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Codeur SAS
+
+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,82 @@
+# Capistrano::Cable
+
+**Capistrano::Cable** helps to deploy standalone ActionCable server with Puma over `systemd`.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add capistrano-cable
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install capistrano-cable
+
+## Usage
+
+```ruby
+# Capfile
+
+require 'capistrano/cable'
+install_plugin Capistrano::Cable::Systemd
+```
+
+To prevent loading the hooks of the plugin, add false to the load_hooks param.
+```ruby
+# Capfile
+
+install_plugin Capistrano::Cable, load_hooks: false  # Default cable tasks without hooks
+```
+
+To make it work with rvm, rbenv and chruby, install the plugin after corresponding library inclusion.
+```ruby
+# Capfile
+
+require 'capistrano/rbenv'
+require 'capistrano/cable'
+install_plugin Capistrano::Cable
+```
+
+### Config
+
+```ruby
+# config/deploy.rb or config/deploy/<stage>.rb
+set :cable_role, :web
+set :cable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+set :cable_access_log, -> { File.join(shared_path, 'log', 'cable.log') }
+set :cable_error_log, -> { File.join(shared_path, 'log', 'cable.log') }
+
+set :cable_systemctl_bin, -> { fetch(:systemctl_bin, '/bin/systemctl') }
+set :cable_service_unit_name, -> { "#{fetch(:application)}_cable_#{fetch(:stage)}" }
+set :cable_enable_socket_service, false
+# set :cable_bind, ... # Example: ->{ "unix:/path/to/cable.sock" }
+
+set :cable_service_unit_env_files, -> { fetch(:service_unit_env_files, []) }
+set :cable_service_unit_env_vars, -> { fetch(:service_unit_env_vars, []) }
+
+set :cable_systemctl_user, -> { fetch(:systemctl_user, :user) }
+set :cable_enable_lingering, -> { fetch(:cable_systemctl_user) != :system }
+set :cable_lingering_user, -> { fetch(:lingering_user, fetch(:user)) }
+
+set :cable_service_templates_path, fetch(:service_templates_path, 'config/deploy/templates')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/codeur/capistrano-cable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/codeur/capistrano-cable/blob/main/CODE_OF_CONDUCT.md).
+
+Largely inspired from [capistrano-puma](https://github.com/seuros/capistrano-puma) gem.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capistrano::Cable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeur/capistrano-cable/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/capistrano/cable/bind.rb

@@ -0,0 +1,35 @@
+module Capistrano
+  module Cable
+    class Bind < Struct.new(:full_address, :kind, :address)
+      def unix?
+        kind == :unix
+      end
+
+      def ssl?
+        kind == :ssl
+      end
+
+      def tcp
+        kind == :tcp || ssl?
+      end
+
+      def local
+        if unix?
+          self
+        else
+          self.class.new(
+            localize_address(full_address),
+            kind,
+            localize_address(address)
+          )
+        end
+      end
+
+      private
+
+      def localize_address(address)
+        address.gsub(/0\.0\.0\.0(.+)/, "127.0.0.1\\1")
+      end
+    end
+  end
+end

data/lib/capistrano/cable/systemd.rb

@@ -0,0 +1,165 @@
+require "capistrano/plugin"
+require_relative "bind"
+
+module Capistrano
+  module Cable
+    class Systemd < Capistrano::Plugin
+      def register_hooks
+        after "deploy:finished", "cable:smart_restart"
+      end
+
+      def define_tasks
+        eval_rakefile File.expand_path("../../tasks/systemd.rake", __FILE__)
+      end
+
+      def set_defaults
+        set_if_empty :cable_role, :web
+        set_if_empty :cable_port, 29292
+        set_if_empty :cable_dir, -> { File.join(release_path, "cable") }
+        set_if_empty :cable_pidfile, -> { File.join(shared_path, "tmp", "pids", "cable.pid") }
+        set_if_empty :cable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+        set_if_empty :cable_access_log, -> { File.join(shared_path, "log", "cable.access.log") }
+        set_if_empty :cable_error_log, -> { File.join(shared_path, "log", "cable.error.log") }
+
+        # Chruby, Rbenv and RVM integration
+        append :chruby_map_bins, "puma", "pumactl" if fetch(:chruby_map_bins)
+        append :rbenv_map_bins, "puma", "pumactl" if fetch(:rbenv_map_bins)
+        append :rvm_map_bins, "puma", "pumactl" if fetch(:rvm_map_bins)
+
+        # Bundler integration
+        append :bundle_bins, "puma", "pumactl"
+
+        set_if_empty :cable_systemctl_bin, -> { fetch(:systemctl_bin, "/bin/systemctl") }
+        set_if_empty :cable_service_unit_name, -> { "#{fetch(:application)}_cable_#{fetch(:stage)}" }
+        set_if_empty :cable_enable_socket_service, false
+        set_if_empty :cable_socket_unit_name, -> { "#{fetch(:application)}_cable_#{fetch(:stage)}.socket" }
+        # set_if_empty :cable_bind, -> { "unix:/tmp/#{fetch(:app_domain)}.sock" }
+
+        set_if_empty :cable_service_unit_env_files, -> { fetch(:service_unit_env_files, []) }
+        set_if_empty :cable_service_unit_env_vars, -> { fetch(:service_unit_env_vars, []) }
+
+        set_if_empty :cable_systemctl_user, -> { fetch(:systemctl_user, :user) }
+        set_if_empty :cable_enable_lingering, -> { fetch(:cable_systemctl_user) != :system }
+        set_if_empty :cable_lingering_user, -> { fetch(:lingering_user, fetch(:user)) }
+
+        set_if_empty :cable_service_templates_path, fetch(:service_templates_path, "config/deploy/templates")
+      end
+
+      def expanded_bundle_command
+        backend.capture(:echo, SSHKit.config.command_map[:bundle]).strip
+      end
+
+      def fetch_systemd_unit_path
+        if fetch(:cable_systemctl_user) == :system
+          "/etc/systemd/system/"
+        else
+          home_dir = backend.capture :pwd
+          File.join(home_dir, ".config", "systemd", "user")
+        end
+      end
+
+      def systemd_command(*args)
+        command = [fetch(:cable_systemctl_bin)]
+
+        unless fetch(:cable_systemctl_user) == :system
+          command << "--user"
+        end
+
+        command + args
+      end
+
+      def sudo_if_needed(*command)
+        if fetch(:cable_systemctl_user) == :system
+          backend.sudo command.map(&:to_s).join(" ")
+        else
+          backend.execute(*command)
+        end
+      end
+
+      def execute_systemd(*args)
+        sudo_if_needed(*systemd_command(*args))
+      end
+
+      # From Common
+
+      def cable_switch_user(role, &block)
+        user = cable_user(role)
+        if user == role.user
+          block.call
+        else
+          backend.as user do
+            block.call
+          end
+        end
+      end
+
+      def cable_user(role)
+        properties = role.properties
+        properties.fetch(:cable_user) || # local property for cable only
+          fetch(:cable_user) ||
+          properties.fetch(:run_as) || # global property across multiple capistrano gems
+          role.user
+      end
+
+      def cable_bind
+        Array(fetch(:cable_bind)).collect do |bind|
+          "bind '#{bind}'"
+        end.join("\n")
+      end
+
+      def service_unit_type
+        ## Jruby don't support notify
+        return "simple" if RUBY_ENGINE == "jruby"
+        fetch(:cable_service_unit_type,
+          ## Check if sd_notify is available in the bundle
+          Gem::Specification.find_all_by_name("sd_notify").any? ? "notify" : "simple")
+      end
+
+      def puma_options
+        options = []
+        options << "--no-config"
+        # options << "--dir #{fetch(:cable_dir)}" if fetch(:cable_dir) # or change WorkingDirectory in cable.service?
+        if fetch(:cable_ssl_certificate) && fetch(:cable_ssl_certificate_key)
+          options << "--bind 'ssl://0.0.0.0:#{fetch(:cable_port)}?key=#{fetch(:cable_ssl_certificate_key)}&cert=#{fetch(:cable_ssl_certificate)}'"
+          # Can use: &verify_mode=none&ca=...
+        end
+        options << "--environment #{fetch(:cable_env)}"
+        # options << "--port #{fetch(:cable_port)}"
+        options << "--pidfile #{fetch(:cable_pidfile)}" if fetch(:cable_pidfile)
+        options << "--threads #{fetch(:cable_threads)}" if fetch(:cable_threads)
+        options << "--workers #{fetch(:cable_workers)}" if fetch(:cable_workers)
+        options.join(" ")
+      end
+
+      def compiled_template_cable(from, role)
+        @role = role
+        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 upload_template_cable(from, to, role)
+        backend.upload! compiled_template_cable(from, role), to
+      end
+
+      def cable_binds
+        Array(fetch(:cable_bind)).map do |m|
+          etype, address = /(tcp|unix|ssl):\/{1,2}(.+)/.match(m).captures
+          Bind.new(m, etype.to_sym, address)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/cable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Cable
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/cable.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "capistrano/cable/systemd"

data/lib/capistrano/tasks/systemd.rake

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+git_plugin = self
+
+namespace :cable do
+  desc "Install Cable systemd service"
+  task :install do
+    on roles(fetch(:cable_role)) do |role|
+      upload_compiled_template = lambda do |template_name, unit_filename|
+        git_plugin.upload_template_cable template_name, "#{fetch(:tmp_dir)}/#{unit_filename}", role
+        systemd_path = fetch(:cable_systemd_conf_dir, git_plugin.fetch_systemd_unit_path)
+        if fetch(:cable_systemctl_user) == :system
+          sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{systemd_path}"
+        else
+          execute :mkdir, "-p", systemd_path
+          execute :mv, "#{fetch(:tmp_dir)}/#{unit_filename}", systemd_path.to_s
+        end
+      end
+
+      upload_compiled_template.call("cable.service", "#{fetch(:cable_service_unit_name)}.service")
+
+      if fetch(:cable_enable_socket_service)
+        upload_compiled_template.call("cable.socket", fetch(:cable_socket_unit_name))
+      end
+
+      # Reload systemd
+      git_plugin.execute_systemd("daemon-reload")
+      invoke "cable:enable"
+    end
+  end
+
+  desc "Uninstall Cable systemd service"
+  task :uninstall do
+    invoke "cable:disable"
+    on roles(fetch(:cable_role)) do |role|
+      systemd_path = fetch(:cable_systemd_conf_dir, git_plugin.fetch_systemd_unit_path)
+      if fetch(:cable_systemctl_user) == :system
+        sudo "rm -f #{systemd_path}/#{fetch(:cable_service_unit_name)}*"
+      else
+        execute :rm, "-f", "#{systemd_path}/#{fetch(:cable_service_unit_name)}*"
+      end
+      git_plugin.execute_systemd("daemon-reload")
+    end
+  end
+
+  desc "Enable Cable systemd service"
+  task :enable do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("enable", fetch(:cable_service_unit_name))
+      git_plugin.execute_systemd("enable", fetch(:cable_socket_unit_name)) if fetch(:cable_enable_socket_service)
+
+      if fetch(:cable_systemctl_user) != :system && fetch(:cable_enable_lingering)
+        execute :loginctl, "enable-linger", fetch(:cable_lingering_user)
+      end
+    end
+  end
+
+  desc "Disable Cable systemd service"
+  task :disable do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("disable", fetch(:cable_service_unit_name))
+      git_plugin.execute_systemd("disable", fetch(:cable_socket_unit_name)) if fetch(:cable_enable_socket_service)
+    end
+  end
+
+  desc "Start Cable service via systemd"
+  task :start do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("start", fetch(:cable_service_unit_name))
+    end
+  end
+
+  desc "Stop Cable service via systemd"
+  task :stop do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("stop", fetch(:cable_service_unit_name))
+    end
+  end
+
+  desc "Stop Cable socket via systemd"
+  task :stop_socket do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("stop", fetch(:cable_socket_unit_name))
+    end
+  end
+
+  desc "Restarts or reloads Cable service via systemd"
+  task :smart_restart do
+    if fetch(:cable_phased_restart)
+      invoke "cable:reload"
+    else
+      invoke "cable:restart"
+    end
+  end
+
+  desc "Restart Cable service via systemd"
+  task :restart do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("restart", fetch(:cable_service_unit_name))
+    end
+  end
+
+  desc "Restart Cable socket via systemd"
+  task :restart_socket do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("restart", fetch(:cable_socket_unit_name))
+    end
+  end
+
+  desc "Reload Cable service via systemd"
+  task :reload do
+    on roles(fetch(:cable_role)) do
+      service_ok = if fetch(:cable_systemctl_user) == :system
+        execute("#{fetch(:cable_systemctl_bin)} status #{fetch(:cable_service_unit_name)} > /dev/null", raise_on_non_zero_exit: false)
+      else
+        execute("#{fetch(:cable_systemctl_bin)} --user status #{fetch(:cable_service_unit_name)} > /dev/null", raise_on_non_zero_exit: false)
+      end
+      cmd = "reload"
+      unless service_ok
+        cmd = "restart"
+      end
+      if fetch(:cable_systemctl_user) == :system
+        sudo "#{fetch(:cable_systemctl_bin)} #{cmd} #{fetch(:cable_service_unit_name)}"
+      else
+        execute fetch(:cable_systemctl_bin).to_s, "--user", cmd, fetch(:cable_service_unit_name)
+      end
+    end
+  end
+
+  desc "Get Cable service status via systemd"
+  task :status do
+    on roles(fetch(:cable_role)) do
+      git_plugin.execute_systemd("status", fetch(:cable_service_unit_name))
+      git_plugin.execute_systemd("status", fetch(:cable_socket_unit_name)) if fetch(:cable_enable_socket_service)
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# This file tells systemd how to run Cable as a 24/7 long-running daemon.
+#
+# Customize this file based on your bundler location, app directory, etc.
+# Customize and copy this into /usr/lib/systemd/system (CentOS) or /lib/systemd/system (Ubuntu).
+# Then run:
+#   - systemctl enable <%= fetch(:cable_service_unit_name) %>
+#   - systemctl {start,stop,restart} <%= fetch(:cable_service_unit_name) %>
+#
+#
+# Use `journalctl -u <%= fetch(:cable_service_unit_name) %> -rn 100` to view the last 100 lines of log output.
+#
+[Unit]
+Description=Cable HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+<%= "Requires=#{fetch(:cable_socket_unit_name)}" if fetch(:cable_enable_socket_service) %>
+After=syslog.target network.target
+
+[Service]
+Type=<%= service_unit_type %>
+WatchdogSec=30
+<%="User=#{cable_user(@role)}" if fetch(:cable_systemctl_user) == :system %>
+<%="PIDFile=#{fetch(:cable_pidfile)}" if fetch(:cable_pidfile) %>
+WorkingDirectory=<%= current_path %>
+ExecStart=<%= expanded_bundle_command %> exec puma <%= puma_options %> cable/config.ru
+ExecReload=/bin/kill -USR1 $MAINPID
+Environment='RAILS_ENV=<%= fetch(:stage) %>'
+<% fetch(:default_env).reject{ |k, _| k.to_s == 'path' }.each do |variable, value| -%>
+Environment='<%= variable.to_s.upcase %>=<%= value.to_s %>'
+<% end -%>
+<%- Array(fetch(:cable_service_unit_env_files)).each do |file| %>
+<%="EnvironmentFile=#{file}" -%>
+<% end -%>
+<% Array(fetch(:cable_service_unit_env_vars)).each do |environment_variable| %>
+<%="Environment=\"#{environment_variable}\"" -%>
+<% end -%>
+
+# if we crash, restart
+RestartSec=1
+Restart=always
+
+<%="StandardOutput=append:#{fetch(:cable_access_log)}" if fetch(:cable_access_log) %>
+<%="StandardError=append:#{fetch(:cable_error_log)}" if fetch(:cable_error_log) %>
+
+SyslogIdentifier=<%= fetch(:cable_service_unit_name) %>
+[Install]
+WantedBy=<%=(fetch(:cable_systemctl_user) == :system) ? "multi-user.target" : "default.target"%>

data/lib/capistrano/templates/cable.socket.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=Cable Puma HTTP Server Accept Sockets for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+
+[Socket]
+<% cable_binds.each do |bind| -%>
+<%= "ListenStream=#{bind.local.address}" %>
+<% end -%>
+
+# Don't let systemd accept the request, wait for Cable to do that.
+# Systemd will start the cable service upon first request if it wasn't started.
+#
+# You might also want to set your Nginx upstream to have a fail_timeout large enough to accomodate your app's
+# startup time.
+Accept=no
+<%= "NoDelay=true" if fetch(:cable_systemctl_user) == :system %>
+ReusePort=true
+Backlog=1024
+
+SyslogIdentifier=<%= fetch(:cable_socket_unit_name) %>
+
+[Install]
+WantedBy=sockets.target

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-cable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brice TEXIER
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-12 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'
+description: ActionCable integration for Capistrano using Puma and Systemd
+email:
+- brice@codeur.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/capistrano/cable.rb
+- lib/capistrano/cable/bind.rb
+- lib/capistrano/cable/systemd.rb
+- lib/capistrano/cable/version.rb
+- lib/capistrano/tasks/systemd.rake
+- lib/capistrano/templates/cable.service.erb
+- lib/capistrano/templates/cable.socket.erb
+homepage: https://github.com/codeur/capistrano-cable#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codeur/capistrano-cable#readme
+  source_code_uri: https://github.com/codeur/capistrano-cable
+  changelog_uri: https://github.com/codeur/capistrano-cable/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: ActionCable integration for Capistrano
+test_files: []