capistrano3-puma 3.0.2 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2d6d5723170d3691d85ccab8996a4f3d933c6cbe
-  data.tar.gz: cf71691c34d8f677ba375aedd3cc10bba20eb1dd
+SHA256:
+  metadata.gz: e9e8a658109b9d4bae5177d3fe539a2354c343904916a779cc2e9a16ad337cf2
+  data.tar.gz: f70546d3675eeb4fc0998574f07c75355f25e236c2f53d45a187ae75babac5c5
 SHA512:
-  metadata.gz: 227f4e7aa92e32912054004fdb6148dbb4133f9899ddcc1883ccaa0bc05183dcbec5664c1ce2ad00c47ebe1069d3fff69c84fdb9252237e47c5c0be7453b440e
-  data.tar.gz: 44cf805c5ccf839f6c204c75942cbb7384a41e34db31990cd690e5c2f16081d7330ca717c75c9587a00551666829f91e62d4b847f6d286b0e35e4a3041e40519
+  metadata.gz: d16d5ac8433ab8aa783efaffa734b0b8843034f349727cec57c5d9f47e247d7ef38afdcddb4f8bc08ef465c69153fc51aa94969b3c8fb85ffe40373a93665182
+  data.tar.gz: e8be34856e21d6ed840f9fe9d72428a11668b239f60aeb1b4ae1eff66661cb793fe284884f97a41d76dee43b0573fb55bf3acce45ea79de810f3032f1057bb12

data/CHANGELOG.md

@@ -1,14 +1,21 @@
 ## Changelog
+- 5.0.0:
+  - Support puma 5.0
+  - Support SystemD service manager
+- 4.0.0:
+  - Support puma 4.x
+- 3.1.0:
+  - Don't load puma hooks by default.
 - 3.0.0:
- - Require capistrano 3.7+
- - Implement the plugin system
- - don't fail if puma was already running
- - Added :puma_daemonize option (default is false)
+   - Require capistrano 3.7+
+   - Implement the plugin system
+   - don't fail if puma was already running
+   - Added :puma_daemonize option (default is false)
 
 - 2.0.0: 
- - Require puma 3.4+
- - Require Capistrano 3.5+
- - Require capistrano-bundler
+   - Require puma 3.4+
+   - Require Capistrano 3.5+
+   - Require capistrano-bundler
  
 - 1.2.0: add support for puma user for puma user @mcb & @seuros
 - 1.1.0: Set :puma_preload_app to false; Reload Monit after uploading any monit configuration; Always refresh Gemfile @rafaelgoulart @suhailpatel @sime

data/CONTRIBUTORS.md

@@ -1,54 +1,48 @@
 ## Contributors
 
-Abdelkader Boudih
-André Arko
-Ariel Zerahia
-Barack Obama
-Bart de Water
-Benjamin Kim
-Bin Huang
-Bryan Liles
-Claudio Poli
-Cyril Rohr
-Eric
-Fritz Lee
-Hnat Kubov
-Ivan Schneider
-James-Hendrickson
-Jens Hausherr
-Jeremy Rottman
-Jesse Cooke
-Johan Lind
-Jordan Hollinger
-Jun Lin
-Kamil Giszczak
-Kevin Collignon
-Konstantin Papkovskiy
-Kyle Decot
-Lisa Hagemann
-Lonre Wang
-Lucas Alves
-Marcos Chicote
-Matias De Santi
-Michael C. Beck
-Molfar
-Neil Bartley
-Peter
-Philippe Nénert
-Ponomarev Nikolay
-Rafael Goulart
-RavWar
-Ruslan
-SHIMADA Koji
-Sergey Ponomarev
-Shane O'Grady
-Simon Males
-Steve Madere
-Suhail Patel
-Suraj Shirvankar
-ayaya
-dfang
-marshall-lee
-mizukmb
-msbrigna
-ruohan.chen
+- Abdelkader Boudih
+- André Arko
+- Ariel Zerahia
+- Barack Obama
+- Bart de Water
+- Benjamin Kim
+- Bin Huang
+- Bryan Liles
+- Claudio Poli
+- Cyril Rohr
+- Fritz Lee
+- Feña Agar
+- Hnat Kubov
+- Ivan Schneider
+- James-Hendrickson
+- Jens Hausherr
+- Jeremy Rottman
+- Jesse Cooke
+- Johan Lind
+- Jordan Hollinger
+- Jun Lin
+- Kamil Giszczak
+- Kevin Collignon
+- Konstantin Papkovskiy
+- Kyle Decot
+- Lisa Hagemann
+- Lonre Wang
+- Lucas Alves
+- Marcos Chicote
+- Mario Celit log
+- Matias De Santi
+- Michael C. Beck
+- Neil Bartley
+- Philippe Nénert
+- Ponomarev Nikolay
+- Rafael Goulart
+- SHIMADA Koji
+- Sergey Ponomarev
+- Shane O'Grady
+- Simon Males
+- Steve Madere
+- Suhail Patel
+- Suraj Shirvankar
+- marshall-lee
+- ruohan chen
+- ayaya zhao

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2017 Abdelkader Boudih
+Copyright (c) 2013-2020 Abdelkader Boudih
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -20,11 +20,38 @@ And then execute:
     # Capfile
 
     require 'capistrano/puma'
+    install_plugin Capistrano::Puma  # Default puma tasks
     install_plugin Capistrano::Puma::Workers  # if you want to control the workers (in cluster mode)
     install_plugin Capistrano::Puma::Jungle # if you need the jungle tasks
     install_plugin Capistrano::Puma::Monit  # if you need the monit tasks
     install_plugin Capistrano::Puma::Nginx  # if you want to upload a nginx site template
 ```
+You will need to select your service manager
+```ruby
+install_plugin Capistrano::Puma::Daemon  # If you using puma daemonized (not supported in Puma 5+)
+```
+or
+```ruby
+install_plugin Capistrano::Puma::Systemd  # if you use SystemD 
+```
+
+To prevent loading the hooks of the plugin, add false to the load_hooks param.
+```ruby
+    # Capfile
+
+    require 'capistrano/puma'
+    install_plugin Capistrano::Puma, load_hooks: false  # Default puma tasks without hooks
+    install_plugin Capistrano::Puma::Monit, load_hooks: false  # Monit 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/puma'
+    install_plugin Capistrano::Puma
+```
 
 ### Config
 
@@ -32,9 +59,9 @@ To list available tasks use `cap -T`
 
 To upload puma config use:
 ```ruby
-cap puma:config 
+cap production puma:config
 ```
-By default the file located in  `shared/puma.config`
+By default the file located in  `shared/puma.rb`
 
 
 Ensure that `tmp/pids` and ` tmp/sockets log` are shared (via `linked_dirs`):
@@ -45,7 +72,7 @@ Ensure that `tmp/pids` and ` tmp/sockets log` are shared (via `linked_dirs`):
 
 To upload a nginx site config (eg. /etc/nginx/sites-enabled/) use:
 ```ruby
-cap puma:nginx_config
+cap production puma:nginx_config
 ```
 
 To customize these two templates locally before uploading use:
@@ -76,13 +103,26 @@ For Jungle tasks (beta), these options exist:
     set :puma_run_path, '/usr/local/bin/run-puma'
 ```
 
+### Systemd
+
+Install Systemd plugin in `Capfile`:
+```ruby
+install_plugin Capistrano::Puma
+install_plugin Capistrano::Puma::Systemd
+```
+
+To generate unit file use:
+```
+cap production puma:systemd:config puma:systemd:enable
+```
+
 ### Multi bind
 
 Multi-bind can be set with an array in the puma_bind variable
 ```ruby
   set :puma_bind, %w(tcp://0.0.0.0:9292 unix:///tmp/puma.sock)
 ```
-    * Listening on tcp://0.0.0.0:9220
+    * Listening on tcp://0.0.0.0:9292
     * Listening on unix:///tmp/puma.sock
 
 ### Active Record
@@ -102,6 +142,7 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_state, "#{shared_path}/tmp/pids/puma.state"
     set :puma_pid, "#{shared_path}/tmp/pids/puma.pid"
     set :puma_bind, "unix://#{shared_path}/tmp/sockets/puma.sock"    #accept array for multi-bind
+    set :puma_control_app, false
     set :puma_default_control_app, "unix://#{shared_path}/tmp/sockets/pumactl.sock"
     set :puma_conf, "#{shared_path}/puma.rb"
     set :puma_access_log, "#{shared_path}/log/puma_access.log"
@@ -113,9 +154,28 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_worker_timeout, nil
     set :puma_init_active_record, false
     set :puma_preload_app, false
-    set :puma_daemonize, true
+    set :puma_daemonize, false
     set :puma_plugins, []  #accept array of plugins
+    set :puma_tag, fetch(:application)
+    set :puma_restart_command, 'bundle exec puma'
+
+    set :nginx_config_name, "#{fetch(:application)}_#{fetch(:stage)}"
+    set :nginx_flags, 'fail_timeout=0'
+    set :nginx_http_flags, fetch(:nginx_flags)
+    set :nginx_server_name, "localhost #{fetch(:application)}.local"
+    set :nginx_sites_available_path, '/etc/nginx/sites-available'
+    set :nginx_sites_enabled_path, '/etc/nginx/sites-enabled'
+    set :nginx_socket_flags, fetch(:nginx_flags)
+    set :nginx_ssl_certificate, "/etc/ssl/certs/#{fetch(:nginx_config_name)}.crt"
+    set :nginx_ssl_certificate_key, "/etc/ssl/private/#{fetch(:nginx_config_name)}.key"
     set :nginx_use_ssl, false
+    set :nginx_use_http2, true
+    set :nginx_downstream_uses_ssl, false
+```
+
+__Notes:__ If you are setting values for variables that might be used by other plugins, use `append` instead of `set`. For example:
+```ruby
+append :rbenv_map_bins, 'puma', 'pumactl'
 ```
 
 ## Contributing

data/capistrano3-puma.gemspec

@@ -5,7 +5,7 @@ require 'capistrano/puma/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'capistrano3-puma'
-  spec.version = Capistrano::PumaVERSION
+  spec.version = Capistrano::PUMAVERSION
   spec.authors = ['Abdelkader Boudih']
   spec.email = ['Terminale@gmail.com']
   spec.description = %q{Puma integration for Capistrano 3}
@@ -20,9 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'capistrano', '~> 3.7'
   spec.add_dependency 'capistrano-bundler'
-  spec.add_dependency 'puma' , '~> 3.4'
+  spec.add_dependency 'puma' , '>= 4.0', '< 6.0'
   spec.post_install_message = %q{
-    [capistrano-puma] Plugins need to be explicitly installed with install_plugin.
+    All plugins need to be explicitly installed with install_plugin.
     Please see README.md
   }
 end

data/lib/capistrano/puma.rb

@@ -8,7 +8,7 @@ module Capistrano
       if user == role.user
         block.call
       else
-        as user do
+        backend.as user do
           block.call
         end
       end
@@ -42,6 +42,7 @@ module Capistrano
           "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)
       backend.upload! StringIO.new(ERB.new(erb, nil, '-').result(binding)), to
@@ -66,6 +67,7 @@ module Capistrano
       set_if_empty :puma_state, -> { File.join(shared_path, 'tmp', 'pids', 'puma.state') }
       set_if_empty :puma_pid, -> { File.join(shared_path, 'tmp', 'pids', 'puma.pid') }
       set_if_empty :puma_bind, -> { File.join("unix://#{shared_path}", 'tmp', 'sockets', 'puma.sock') }
+      set_if_empty :puma_control_app, false
       set_if_empty :puma_default_control_app, -> { File.join("unix://#{shared_path}", 'tmp', 'sockets', 'pumactl.sock') }
       set_if_empty :puma_conf, -> { File.join(shared_path, 'puma.rb') }
       set_if_empty :puma_access_log, -> { File.join(shared_path, 'log', 'puma_access.log') }
@@ -73,6 +75,8 @@ module Capistrano
       set_if_empty :puma_init_active_record, false
       set_if_empty :puma_preload_app, false
       set_if_empty :puma_daemonize, false
+      set_if_empty :puma_tag, ''
+      set_if_empty :puma_restart_command, 'bundle exec puma'
 
       # Chruby, Rbenv and RVM integration
       append :chruby_map_bins, 'puma', 'pumactl'
@@ -85,7 +89,6 @@ module Capistrano
 
     def register_hooks
       after 'deploy:check', 'puma:check'
-      after 'deploy:finished', 'puma:smart_restart'
     end
 
     def puma_workers
@@ -107,13 +110,14 @@ module Capistrano
     end
 
     def upload_puma_rb(role)
-      template_puma 'puma.rb', fetch(:puma_conf), role
+      template_puma 'puma', fetch(:puma_conf), role
     end
   end
 end
-install_plugin Capistrano::Puma
 
 require 'capistrano/puma/workers'
+require 'capistrano/puma/daemon'
+require 'capistrano/puma/systemd'
 require 'capistrano/puma/monit'
 require 'capistrano/puma/jungle'
-require 'capistrano/puma/nginx'
+require 'capistrano/puma/nginx'

data/lib/capistrano/puma/daemon.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  class Puma::Daemon < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:smart_restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/daemon.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/puma/jungle.rb

@@ -11,20 +11,12 @@ module Capistrano
       eval_rakefile File.expand_path('../../tasks/jungle.rake', __FILE__)
     end
 
-    private
-
-    def debian_install
-      template_puma 'puma-deb', "#{fetch(:tmp_dir)}/puma", @role
-      execute "chmod +x #{fetch(:tmp_dir)}/puma"
-      sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
-      sudo 'update-rc.d -f puma defaults'
+    def debian_install(role)
+      template_puma 'puma-deb', "#{fetch(:tmp_dir)}/puma", role
     end
 
-    def rhel_install
-      template_puma 'puma-rpm', "#{fetch(:tmp_dir)}/puma", @role
-      execute "chmod +x #{fetch(:tmp_dir)}/puma"
-      sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
-      sudo 'chkconfig --add puma'
+    def rhel_install(role)
+      template_puma 'puma-rpm', "#{fetch(:tmp_dir)}/puma", role
     end
   end
 end

data/lib/capistrano/puma/monit.rb

@@ -22,10 +22,13 @@ module Capistrano
 
     def sudo_if_needed(command)
       if fetch(:puma_monit_use_sudo)
-        sudo command
+        backend.sudo command
       else
-        execute command
+        puma_role = fetch(:puma_role)
+        backend.on(puma_role) do
+          backend.execute command
+        end
       end
     end
   end
-end
+end

data/lib/capistrano/puma/nginx.rb

@@ -11,6 +11,8 @@ module Capistrano
       set_if_empty :nginx_http_flags, fetch(:nginx_flags)
       set_if_empty :nginx_socket_flags, fetch(:nginx_flags)
       set_if_empty :nginx_use_ssl, false
+      set_if_empty :nginx_use_http2, true
+      set_if_empty :nginx_downstream_uses_ssl, false
     end
 
     def define_tasks

data/lib/capistrano/puma/systemd.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  class Puma::Systemd < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/systemd.rake', __FILE__)
+    end
+
+    def set_defaults
+      set_if_empty :puma_systemd_conf_dir, '/etc/systemd/system'
+      set_if_empty :puma_systemctl_bin, '/bin/systemctl'
+      set_if_empty :puma_service_unit_name, 'puma'
+    end
+  end
+end

data/lib/capistrano/puma/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  PumaVERSION = '3.0.2'
+  PUMAVERSION = '5.0.0.beta1'
 end