capistrano-puma-sic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6efff22ec3b694a67c03123f8e7ec796bf5fc206
+  data.tar.gz: 508957d9771c96e60e42386213bb18b04fc80369
+SHA512:
+  metadata.gz: a0c98167aa01f468b96545bc97e0d16a828a811de7ea8b3733f905f62b8ed8d089383152c3ba6645aeb551c2a3cfe7547667732ec3245d84fe472ff80a457e60
+  data.tar.gz: 7a14d4abea90a012904373f8e2df17525a362a910329fa582df01d5a3d8cbff826df9715467be7d4f92ac51aae1de5a4a64688596af108fbf177216c2bb1f0de

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Florian Schwab
+
+MIT License
+
+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,53 @@
+[![Gem Version](https://img.shields.io/gem/v/capistrano-puma-sic.svg)](https://rubygems.org/gems/capistrano-puma-sic)
+[![Dependencies](https://img.shields.io/gemnasium/SICSoftwareGmbH/capistrano-puma.svg)](https://gemnasium.com/SICSoftwareGmbH/capistrano-puma)
+[![Code Climate](https://img.shields.io/codeclimate/github/SICSoftwareGmbH/capistrano-puma.svg)](https://codeclimate.com/github/SICSoftwareGmbH/capistrano-puma)
+
+# Capistrano::Puma
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-puma-sic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-puma-sic
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require 'capistrano/puma'
+require 'capistrano/puma/console' # Optional: Adds worker tasks
+```
+
+Configurable options, shown here with defaults:
+
+```ruby
+set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+set :puma_roles, :app
+set :puma_user, nil # triggers usage of sudo
+set :puma_bundle, -> { fetch(:bundle_cmd, :bundle) }
+set :puma_bin, :puma
+set :pumactl_bin, :pumactl
+set :puma_conf, -> { File.join(release_path, 'config', 'puma', "#{fetch(:stage)}.rb") }
+set :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+set :puma_state, -> { File.join(shared_path, 'tmp', 'pids', 'puma.state') }
+set :puma_restart_strategy, :restart # valid values: restart, phased-restart
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/capistrano-puma-sic.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/puma/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'capistrano-puma-sic'
+  spec.version = Capistrano::Puma::VERSION
+  spec.authors = ['Florian Schwab']
+  spec.email = ['florian.schwab@sic-software.com']
+  spec.description = %q{Puma integration for Capistrano 3}
+  spec.summary = %q{Puma integration for Capistrano}
+  spec.homepage = 'https://github.com/SICSoftwareGmbH/capistrano-puma'
+  spec.license = 'MIT'
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files = `git ls-files`.split($/)
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '~> 3.4'
+  spec.add_dependency 'puma' ,      '>= 2.6'
+end

data/lib/capistrano/puma/utility.rb

@@ -0,0 +1,121 @@
+require 'tempfile'
+
+module Capistrano
+  module Puma
+    module Utility
+      def puma_roles
+        fetch(:puma_roles, :app)
+      end
+
+      def puma_cmd(cmd)
+        cmds = []
+
+        if fetch(:puma_bundle)
+          cmds += fetch(:puma_bundle).to_s.split(/\s+/)
+          cmds << 'exec'
+        end
+
+        cmds += fetch(cmd).to_s.split(/\s+/)
+
+        cmds.compact
+      end
+
+      def check_puma_config
+        return if puma_test "[ -f #{fetch(:puma_conf)} ]"
+
+        fail "Puma config file missing: #{fetch(:puma_conf)}"
+      end
+
+      def puma_signal(sig)
+        #unless check_puma_pid
+        #  fail "Puma is not running!"
+        #end
+
+        on roles puma_roles do
+          puma_execute :kill, "-#{sig}", "$( cat #{fetch(:puma_pid)} )"
+        end
+      end
+
+      def puma_execute(*args)
+        check_puma_config
+
+        options = args.extract_options!
+
+        command = [:bash, '-l', '-c', "\"#{args.join(' ')}\""]
+
+        within release_path do
+          with rack_env: fetch(:puma_env), rails_env: fetch(:puma_env) do
+            if puma_user = fetch(:puma_user)
+              execute :sudo, '-u', puma_user, command, options
+            else
+              execute *command, options
+            end
+          end
+        end
+      end
+
+      def puma_test(*args)
+        options = args.extract_options!
+
+        command = [:bash, '-l', '-c', "\"#{args.join(' ')}\""]
+
+        if puma_user = fetch(:puma_user)
+          test :sudo, '-u', puma_user, command, options
+        else
+          test *command, options
+        end
+      end
+
+      def check_puma_pid
+        return false unless test "[ -f #{fetch(:puma_pid)} ]"
+
+        unless puma_test "kill -0 $( cat #{fetch(:puma_pid)} )"
+          puma_execute :rm, fetch(:puma_pid)
+
+          return false
+        end
+
+        true
+      end
+
+      def start_puma
+        puma_execute puma_cmd(:puma_bin), "-C #{fetch(:puma_conf)}", '--daemon'
+      end
+
+      def stop_puma
+        return unless check_puma_pid
+
+        puma_execute puma_cmd(:pumactl_bin), "-S #{fetch(:puma_state)}", :stop
+      end
+
+      def restart_puma
+        if check_puma_pid
+          puma_execute puma_cmd(:pumactl_bin), "-S #{fetch(:puma_state)}", :restart
+        else
+          start_puma
+        end
+      end
+
+      def phased_restart_puma
+        if check_puma_pid
+          puma_execute puma_cmd(:pumactl_bin), "-S #{fetch(:puma_state)}", 'phased-restart'
+        else
+          start_puma
+        end
+      end
+
+      def puma_deploy_restart
+        restart_strategy = fetch(:puma_restart_strategy, :restart).to_s
+
+        case restart_strategy
+        when 'restart'
+          restart_puma
+        when 'phased-restart'
+          phased_restart_puma
+        else
+          fail "Invalid restart strategy: #{restart_strategy}"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/puma/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Puma
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/capistrano/puma/workers.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/workers.cap', __FILE__)

data/lib/capistrano/puma.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/puma.cap', __FILE__)

data/lib/capistrano/tasks/puma.cap

@@ -0,0 +1,63 @@
+require 'capistrano/puma/utility'
+
+include Capistrano::Puma::Utility
+
+namespace :load do
+  task :defaults do
+    # Bin maps
+    set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w( puma pumactl ))
+    set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w( puma pumactl ))
+
+    # Environment
+    set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+    set :puma_roles, :app
+    set :puma_user, nil
+    set :puma_bundle, -> { fetch(:bundle_cmd, :bundle) }
+    set :puma_bin, :puma
+    set :pumactl_bin, :pumactl
+    set :puma_conf, -> { File.join(release_path, 'config', 'puma', "#{fetch(:stage)}.rb") }
+    set :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+    set :puma_state, -> { File.join(shared_path, 'tmp', 'pids', 'puma.state') }
+
+    # Misc
+    set :puma_restart_strategy, :restart
+  end
+end
+
+namespace :puma do
+  desc 'Start puma'
+  task :start do
+    on roles puma_roles do
+      start_puma
+    end
+  end
+
+  desc 'Stop puma'
+  task :stop do
+    on roles puma_roles do
+      stop_puma
+    end
+  end
+
+  desc 'Restart puma'
+  task :restart do
+    on roles puma_roles do
+      restart_puma
+    end
+  end
+
+  desc 'Phased restart puma'
+  task :'phased-restart' do
+    on roles puma_roles do
+      phased_restart_puma
+    end
+  end
+
+  task :deploy_restart do
+    on roles puma_roles do
+      puma_deploy_restart
+    end
+  end
+
+  after 'deploy:publishing', :deploy_restart
+end

data/lib/capistrano/tasks/workers.cap

@@ -0,0 +1,29 @@
+require 'capistrano/puma/utility'
+
+include Capistrano::Puma::Utility
+
+namespace :puma do
+  namespace :workers do
+    desc 'Number of workers'
+    task :count do
+      on roles puma_roles do |host|
+        check_puma_pid
+
+        pid = capture("cat #{fetch(:puma_pid)}").strip
+        workers_count = capture("ps ax | grep -c 'puma: cluster worker [0-9]\\+: #{pid}'").to_i
+
+        log "Workers on #{host.hostname}: #{workers_count}"
+      end
+    end
+
+    desc 'Add a worker'
+    task :add do
+      puma_signal(:TTIN)
+    end
+
+    desc 'Remove a worker'
+    task :remove do
+      puma_signal(:TTOU)
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-puma-sic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florian Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Puma integration for Capistrano 3
+email:
+- florian.schwab@sic-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-puma-sic.gemspec
+- lib/capistrano-puma-sic.rb
+- lib/capistrano/puma.rb
+- lib/capistrano/puma/utility.rb
+- lib/capistrano/puma/version.rb
+- lib/capistrano/puma/workers.rb
+- lib/capistrano/tasks/puma.cap
+- lib/capistrano/tasks/workers.cap
+homepage: https://github.com/SICSoftwareGmbH/capistrano-puma
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Puma integration for Capistrano
+test_files: []