capistrano-good-job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4140969a15fda699411657c78955e661173a0d33099a76b1988a9cbba15a6f98
+  data.tar.gz: fd406a8d7b63a97979c643e3d04f66ccd5e55a7f969b45b600ddfc4c29d07cbe
+SHA512:
+  metadata.gz: a6a0893e9a5b7930be5a6f00415ea30e3c3fab0aea1a7ed1a5382c4f87211c9b8de6faad8c91deec8338a38a55f684d440952db96f44d38cdfdffd2452182bcb
+  data.tar.gz: a365b5627fb50f3fddbcba2637e52908fb422f6652bfc64a3136d7f8f76ec3503168d520246204e818013b3430dc73430492d95e5c8db70ebc52c723db1605ff

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-18
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in capistrano_good_job.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "standard", "~> 1.3"
+
+gem "solargraph"

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    capistrano-good-job (0.1.0)
+      capistrano (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.4.1)
+      sshkit (>= 1.6.1, != 1.7.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    capistrano (3.17.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.2.0)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    net-scp (4.0.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-ssh (7.0.1)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    sshkit (1.21.3)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    standard (1.24.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.44.1)
+      rubocop-performance (= 1.15.2)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  capistrano-good-job!
+  rake (~> 13.0)
+  solargraph
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Martin Tomov
+
+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,93 @@
+# Capistrano Systemd integration for GoodJob
+
+Adds the following capistrano commands:
+
+```sh
+good_job:disable                    # Disable good_job systemd service
+good_job:enable                     # Enable good_job systemd service
+good_job:install                    # Install good_job systemd service
+good_job:reload                     # Reload good_job service via systemd
+good_job:restart                    # Restart good_job service via systemd
+good_job:start                      # Start good_job service via systemd
+good_job:status                     # Get good_job service status via systemd
+good_job:stop                       # Stop good_job service via systemd
+good_job:uninstall                  # Uninstall good_job systemd service
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'capistrano-good-job', github: "mtomov/capistrano-good-job", require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+```ruby
+# Capfile
+
+require 'capistrano/good_job'
+install_plugin Capistrano::GoodJob
+```
+
+To prevent loading [the hooks](lib/capistrano-good-job.rb) of the plugin, add false to the load_hooks param.
+```ruby
+# Capfile
+
+install_plugin Capistrano::GoodJob, load_hooks: false
+```
+
+Then run once
+
+```sh
+bundle exec cap production good_job:install
+```
+
+for the initial setup. This will copy a [`systemd` service definition](lib/capistrano/templates/good_job.service.erb) to `~/.config/systemd/user/symantiq_good_job.service` on your server marked with Capistrano role `db`.
+
+It will also `enable` it in `systemd`, allowing to to then run commands such as:
+
+```sh
+systemctl --user status your_app_good_job_production
+systemctl --user start your_app_good_job_production
+systemctl --user stop your_app_good_job_production
+systemctl --user reload your_app_good_job_production
+systemctl --user restart your_app_good_job_production
+```
+
+through their Capistrano counterparts, ex: `bundle exec cap good_job:restart`.
+
+## Usage
+
+The plugin has registered a Capistrano `hook` to run `bundle exec cap good_job:restart` after deploy:
+
+```ruby
+after "deploy:finished", "good_job:restart"
+```
+
+See [`#register_hooks`](lib/capistrano/good_job.rb:17)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/mtomov/capistrano_good_job.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+The structure and code of the gem are heavily inspired by [`capistrano-puma`](https://github.com/seuros/capistrano-puma)'s [`systemd` tasks](https://github.com/seuros/capistrano-puma/blob/master/lib/capistrano/tasks/systemd.rake)

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "standard/rake"
+
+task default: :standard

data/lib/capistrano/good_job/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CapistranoGoodJob
+  VERSION = "0.1.0"
+end

data/lib/capistrano/good_job.rb

@@ -0,0 +1,26 @@
+module Capistrano
+  class GoodJob < Capistrano::Plugin
+    include PumaCommon
+
+    def set_defaults
+      set_if_empty :good_job_role, "db"
+      set_if_empty :good_job_access_log, -> { File.join(shared_path, "log", "good_job.log") }
+      set_if_empty :good_job_error_log, -> { File.join(shared_path, "log", "good_job.log") }
+      set_if_empty :good_job_service_unit_name, -> { "#{fetch(:application)}_good_job_#{fetch(:stage)}" }
+      set_if_empty :good_job_systemd_conf_dir, -> { File.join("/home/#{fetch(:user)}", ".config", "systemd", "user") }
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path("../tasks/good_job.rake", __FILE__)
+    end
+
+    def register_hooks
+      after "deploy:finished", "good_job:restart"
+    end
+
+    def execute_systemd(*args)
+      command = ["/bin/systemctl", "--user"] + args
+      backend.execute(*command)
+    end
+  end
+end

data/lib/capistrano/tasks/good_job.rake

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+plugin = self
+
+namespace :good_job do
+  desc "Install good_job systemd service"
+  task :install do
+    on roles(fetch(:good_job_role)) do |role|
+      execute :mkdir, "-p", fetch(:systemd_conf_dir)
+
+      service_file = File.expand_path("../../templates/good_job.service.erb", __FILE__)
+      erb = File.read(service_file)
+      file = StringIO.new(ERB.new(erb, trim_mode: "-").result(binding))
+
+      systemd_path = fetch(:good_job_systemd_conf_dir)
+      path = "#{systemd_path}/#{fetch(:good_job_service_unit_name)}.service"
+
+      execute :mkdir, "-p", systemd_path
+      upload! file, path
+
+      # Reload systemd
+      plugin.execute_systemd("daemon-reload")
+      invoke "good_job:enable"
+    end
+  end
+
+  desc "Uninstall good_job systemd service"
+  task :uninstall do
+    invoke "good_job:disable"
+    on roles(fetch(:good_job_role)) do |role|
+      systemd_path = fetch(:good_job_systemd_conf_dir)
+      execute :rm, "-f", "#{systemd_path}/#{fetch(:good_job_service_unit_name)}*"
+
+      plugin.execute_systemd("daemon-reload")
+    end
+  end
+
+  desc "Enable good_job systemd service"
+  task :enable do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("enable", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Disable good_job systemd service"
+  task :disable do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("disable", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Start good_job service via systemd"
+  task :start do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("start", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Stop good_job service via systemd"
+  task :stop do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("stop", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Restart good_job service via systemd"
+  task :restart do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("restart", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Reload good_job service via systemd"
+  task :reload do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("reload", fetch(:good_job_service_unit_name))
+    end
+  end
+
+  desc "Get good_job service status via systemd"
+  task :status do
+    on roles(fetch(:good_job_role)) do
+      plugin.execute_systemd("status", fetch(:good_job_service_unit_name))
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+[Unit]
+Description=GoodJob background job
+After=network.target
+
+[Service]
+Type=simple
+
+WorkingDirectory=<%= current_path %>
+ExecStart=<%= capture(:echo, SSHKit.config.command_map[:bundle]).strip %> exec good_job start
+
+Environment='RAILS_ENV=production'
+
+ExecReload=/bin/kill -s USR2 $MAINPID
+ExecStop=/bin/kill -s TERM $MAINPID
+
+# if we crash, restart
+RestartSec=1
+Restart=on-failure
+
+<%="StandardOutput=append:#{fetch(:good_job_access_log)}" if fetch(:good_job_access_log) %>
+<%="StandardError=append:#{fetch(:good_job_error_log)}" if fetch(:good_job_error_log) %>
+
+SyslogIdentifier=<%= fetch(:good_job_service_unit_name) %>
+
+[Install]
+WantedBy=default.target

data/sig/capistrano_good_job.rbs

@@ -0,0 +1,4 @@
+module CapistranoGoodJob
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-good-job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Tomov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-20 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: Adds support for GoodJob to Capistrano 3.x
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/capistrano-good-job.rb
+- lib/capistrano/good_job.rb
+- lib/capistrano/good_job/version.rb
+- lib/capistrano/tasks/good_job.rake
+- lib/capistrano/templates/good_job.service.erb
+- sig/capistrano_good_job.rbs
+homepage: https://github.com/mtomov/capistrano-good-job
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mtomov/capistrano-good-job
+  source_code_uri: https://github.com/mtomov/capistrano-good-job
+  changelog_uri: https://github.com/mtomov/capistrano-good-job/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.4.6
+signing_key:
+specification_version: 4
+summary: Adds support for GoodJob to Capistrano 3.x
+test_files: []