capistrano-runit-puma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41d1ad3edcb0ea6b5f08c8c0b86a000010358141
+  data.tar.gz: 5cd2de426525c85aeac0da6bad8b54c59ae14782
+SHA512:
+  metadata.gz: 468cec02588887fba78d19a0a048f5238b97a8fa54c2340883a8397ef9bc4bf454cf17a0a7acd9fd1c57b8b8ba2482723acc5c1b8df0c6f5b0bd350c6d13260d
+  data.tar.gz: 5e71bcb197935816cacdede308805e38da7fd63e93ad92212e143a38c3a69fa68b3ab6dad2161c89b438bf8eded7f539b0bee8edcb0187b1926a51aca0cb9f2c

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alexander Simonov
+
+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,62 @@
+# capistrano-runit-puma
+
+Capistrano3 tasks for manage puma via runit supervisor.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-runit-puma'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-runit-puma
+
+## Usage
+
+Add this line in `Capfile`:
+```
+require 'capistrano/runit/puma'
+```
+
+## Tasks
+
+* `runit:puma:setup` -- setup puma runit service.
+* `runit:puma:enable` -- enable and autostart service.
+* `runit:puma:disable` -- stop and disable service.
+* `runit:puma:start` -- start service.
+* `runit:puma:stop` -- stop service.
+* `runit:puma:restart` -- restart service.
+* `runit:puma:phased_restart` -- run phased restart.
+* `runit:puma:force_restart` -- run forced restart.
+
+## Variables
+
+* `runit_puma_role` -- what host roles uses runit to run puma. Default value: `:app`
+* `runit_puma_default_hooks` -- run default hooks for runit puma or not. Default value: `true`.
+* `runit_puma_run_template` -- path to ERB template of `run` file. Default value: `nil`.
+* `runit_puma_workers` -- number of puma workers. Default value: 1.
+* `runit_puma_threads_min` -- minimal threads to use. Default value: 0.
+* `runit_puma_threads_max` -- maximal threads to use. Default value: 16.
+* `runit_puma_bind` -- bind URI. Examples: tcp://127.0.0.1:8080, unix:///tmp/puma.sock. Default value: nil.
+* `runit_puma_rackup` -- Path to application's rackup file. Default value: `File.join(current_path, 'config.ru')`
+* `runit_puma_state`  -- Path to puma's state file. Default value: `File.join(shared_path, 'tmp', 'pids', 'puma.state')`
+* `runit_puma_pid` -- Path to pid file. Default value: `File.join(shared_path, 'tmp', 'pids', 'puma.pid')`
+* `runit_puma_bind` -- Puma's bind string. Default value: `File.join('unix://', shared_path, 'tmp', 'sockets', 'puma.sock')`
+* `runit_puma_conf` -- Path to puma's config file. Default value: `File.join(shared_path, 'puma.rb')`
+* `runit_puma_access_log` -- Path to puma's access log. Default value: `File.join(shared_path, 'log', 'puma_access.log')`
+* `runit_puma_error_log` -- Path to puma's error log. Default value: `File.join(shared_path, 'log', 'puma_access.log')`
+* `runit_puma_init_active_record` -- Enable or not establish ActiveRecord connection. Default value: `false`
+* `runit_puma_preload_app` -- Preload application. Default value: `true`
+
+## Contributing
+
+1. Fork it ( https://github.com/capistrano-runit/capistrano-runit-puma/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-runit-puma.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name        = "capistrano-runit-puma"
+  spec.version     = '0.1.0'
+  spec.author      = ['Oleksandr Simonov', 'Anton Ageev']
+  spec.email       = ['alex@simonov.me', 'antage@gmail.com']
+  spec.summary     = %q{Capistrano3 tasks for manage puma via runit supervisor.}
+  spec.description = %q{Capistrano3 tasks for manage puma via runit supervisor.}
+  spec.homepage    = 'http://capistrano-runit.github.io'
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'capistrano-runit-core', '~> 0.1.0'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/runit/puma.rb

@@ -0,0 +1,3 @@
+require 'erb'
+require 'stringio'
+load File.expand_path('../../tasks/puma.rake', __FILE__)

data/lib/capistrano/tasks/puma.rake

@@ -0,0 +1,150 @@
+require 'capistrano/runit'
+include ::Capistrano::Runit
+
+namespace :load do
+  task :defaults do
+    set :runit_puma_role, -> { :app }
+    set :runit_puma_default_hooks, -> { true }
+    set :runit_puma_run_template, nil
+    set :runit_puma_workers, 1
+    set :runit_puma_threads_min, 0
+    set :runit_puma_threads_max, 16
+    set :runit_puma_rackup, -> { File.join(current_path, 'config.ru') }
+    set :runit_puma_state, -> { File.join(shared_path, 'tmp', 'pids', 'puma.state') }
+    set :runit_puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
+    set :runit_puma_bind, -> { File.join('unix://', shared_path, 'tmp', 'sockets', 'puma.sock') }
+    set :runit_puma_conf, -> { File.join(shared_path, 'puma.rb') }
+    set :runit_puma_conf_in_repo, -> { false }
+    set :runit_puma_access_log, -> { File.join(shared_path, 'log', 'puma_access.log') }
+    set :runit_puma_error_log, -> { File.join(shared_path, 'log', 'puma_error.log') }
+    set :runit_puma_init_active_record, false
+    set :runit_puma_preload_app, true
+    # Rbenv and RVM integration
+    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))
+  end
+end
+
+namespace :deploy do
+  before :starting, :runit_check_puma_hooks do
+    invoke 'runit:puma:add_default_hooks' if fetch(:runit_puma_default_hooks)
+  end
+end
+
+namespace :runit do
+  namespace :puma do
+
+    def puma_enabled_service_dir
+      enabled_service_dir_for('puma')
+    end
+
+    def puma_service_dir
+      service_dir_for('puma')
+    end
+
+    def collect_puma_run_command
+      array = []
+      array << env_variables
+      array << "exec #{SSHKit.config.command_map[:bundle]} exec puma"
+      puma_conf_path = if fetch(:runit_puma_conf_in_repo)
+                         "#{release_path}/config/puma.rb"
+                       else
+                         fetch(:runit_puma_conf)
+                       end
+      array << "-C #{puma_conf_path}"
+      array.compact.join(' ')
+    end
+
+    def create_puma_default_conf
+      warn 'puma.rb NOT FOUND!'
+      path = File.expand_path('../../templates/puma.rb.erb', __FILE__)
+      if File.file?(path)
+        template = ERB.new(File.read(path))
+        stream   = StringIO.new(template.result(binding))
+        upload! stream, "#{fetch(:runit_puma_conf)}"
+        info 'puma.rb generated'
+      end
+    end
+
+    task :add_default_hooks do
+      after 'deploy:check', 'runit:puma:check'
+      after 'deploy:finished', 'runit:puma:restart'
+    end
+
+    task :check do
+      check_service('puma')
+      on roles fetch(:runit_puma_role) do
+        if test "[ -d #{puma_enabled_service_dir} ]"
+          # Create puma.rb for new deployments if not in repo
+          if !fetch(:runit_puma_conf_in_repo) && !test("[ -f #{fetch(:runit_puma_conf)} ]")
+            create_puma_default_conf
+          end
+        else
+          error "Puma runit service isn't enabled."
+        end
+      end
+    end
+
+    desc 'Setup puma runit service'
+    task :setup do
+      # requirements
+      if fetch(:runit_puma_bind).nil?
+        $stderr.puts "You should set 'runit_puma_bind' variable."
+        exit 1
+      end
+      setup_service('puma', collect_sidekiq_run_command)
+    end
+
+    desc 'Enable puma runit service'
+    task :enable do
+      enable_service('puma')
+    end
+
+    desc 'Disable puma runit service'
+    task :disable do
+      disable_service('puma')
+    end
+
+    desc 'Start puma runit service'
+    task :start do
+      start_service('puma')
+    end
+
+    desc 'Stop puma runit service'
+    task :stop do
+      stop_service('puma')
+    end
+
+    desc 'Restart puma runit service'
+    task :restart do
+      on roles fetch(:runit_puma_role) do
+        if test "[ -d #{puma_enabled_service_dir} ]"
+          if test("[ -f #{fetch(:runit_puma_pid)} ]") && test("kill -0 $( cat #{fetch(:runit_puma_pid)} )")
+            within current_path do
+              execute :bundle, :exec, :pumactl, "-S #{fetch(:runit_puma_state)} restart"
+            end
+          else
+            info 'Puma is not running'
+            if test("[ -f #{fetch(:runit_puma_pid)} ]")
+              info 'Removing broken pid file'
+              execute :rm, '-f', fetch(:runit_puma_pid)
+            end
+            execute "#{fetch(:runit_sv_path)} start #{puma_enabled_service_dir}"
+          end
+        else
+          error "Puma runit service isn't enabled."
+        end
+      end
+    end
+
+    desc 'Force restart puma runit service'
+    task :force_restart do
+      restart_service('puma')
+    end
+
+    desc 'Run phased restart puma runit service'
+    task :phased_restart do
+      kill_hup_service('puma')
+    end
+  end
+end

data/lib/capistrano/templates/puma.rb.erb

@@ -0,0 +1,28 @@
+directory   '<%= current_path %>'
+environment '<%= fetch(:rack_env, fetch(:rails_env, "production")) %>'
+daemonize false
+quiet
+pidfile '<%= fetch(:runit_puma_pid)%>'
+state_path '<%= fetch(:runit_puma_state)%>'
+stdout_redirect '<%= fetch(:runit_puma_access_log)%>', '<%= fetch(:runit_puma_error_log)%>', true
+
+workers <%= fetch(:runit_puma_workers, 1) %>
+threads <%= fetch(:runit_puma_threads_min, 0) %>, <%= fetch(:runit_puma_threads_max, 16) %>
+bind "<%= fetch(:runit_puma_bind) %>"
+
+<% if fetch(:runit_puma_preload_app) %>
+preload_app!
+<% end %>
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{current_path}/Gemfile") %>"
+end
+
+on_worker_boot do
+  <% if fetch(:runit_puma_init_active_record) %>
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+  <% end %>
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-runit-puma
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleksandr Simonov
+- Anton Ageev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano-runit-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano3 tasks for manage puma via runit supervisor.
+email:
+- alex@simonov.me
+- antage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-runit-puma.gemspec
+- lib/capistrano-runit-puma.rb
+- lib/capistrano/runit/puma.rb
+- lib/capistrano/tasks/puma.rake
+- lib/capistrano/templates/puma.rb.erb
+homepage: http://capistrano-runit.github.io
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Capistrano3 tasks for manage puma via runit supervisor.
+test_files: []