capistrano-puma-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 650914f5ac733277163d698a04666d4d645b063c
+  data.tar.gz: 597cbbaac95d8df23b8228d49bd59a10bee48cdd
+SHA512:
+  metadata.gz: 87516c16ed5b310896f1e51b394fb2582c2ddcc99ce8772a86ebbdad9ace2113edc073707af57e1dcbc775b5b4da68b0c650672265c8cd70c3259e2e926f8724
+  data.tar.gz: b969599b4631222c2f2d391f7138458b9d4e289cf5dca3e8039ce5b831c8d68a05865497b5a79b0c634d6f06fb38907ce67f5ab6e6e8bc307d9811451d2ac549

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,60 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  DisplayCopNames: true
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExtraSpacing:
+  Enabled: false
+
+Style/GuardClause:
+  MinBodyLength: 5
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/IndentationConsistency:
+  EnforcedStyle: rails
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  Exclude:
+    - "**/*.rake"
+    - "Rakefile"
+
+Metrics/LineLength:
+  Max: 160
+  Exclude:
+    - "db/migrate/*.rb"
+
+NumericLiterals:
+  MinDigits: 7
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/BlockAlignment:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 12

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 hirocaster
+
+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,75 @@
+# Capistrano::PumaSimple
+
+Puma control by Capistrano
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-puma-simple'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-puma-simple
+
+## Usage
+
+```
+# in Capfile
+require "capistrano/puma-simple"
+
+```
+
+then you can use `cap -T` to list tasks
+
+```
+cap puma:config          # Setup puma config file
+cap puma:halt            # Halt puma
+cap puma:phased-restart  # Phased-restart puma
+cap puma:restart         # Restart puma
+cap puma:start           # Start puma
+cap puma:status          # Status puma
+cap puma:stop            # Stop puma
+cap puma:template        # Export template file
+```
+
+you may want to customize `puma.rb` export template file
+
+```
+cap puma:template        # Export template file
+``
+
+customize to `config/deploy/templates/puma.rb.erb`
+
+Configurable options, shown here with defaults:
+
+```
+set :puma_role, :app
+set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+set :puma_rackup, -> { File.join(current_path, "config.ru") }
+set :puma_conf, -> { File.join(shared_path, "puma.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_access_log, -> { File.join(shared_path, "log", "puma_access.log") }
+set :puma_error_log, -> { File.join(shared_path, "log", "puma_error.log") }
+set :puma_threads, [0, 16]
+set :puma_workers, 0
+set :puma_bind, "tcp://0.0.0.0:9292"
+set :puma_default_control_app, -> { File.join("unix://#{shared_path}", "tmp", "sockets", "pumactl.sock") }
+set :puma_tag, -> { fetch(:application) }
+set :puma_worker_timeout, 60
+set :puma_init_active_record, false
+set :puma_preload_app, false
+```
+
+## 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-simple.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-simple/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-puma-simple"
+  spec.version       = Capistrano::PumaSimple::VERSION
+  spec.authors       = ["hirocaster"]
+  spec.email         = ["hohtsuka@gmail.com"]
+  spec.description   = "Puma simple integration for Capistrano3"
+  spec.summary       = "Puma simple integration for Capistrano3"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/puma-simple/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module PumaSimple
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano/puma-simple.rb

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

data/lib/capistrano/tasks/puma.rake

@@ -0,0 +1,180 @@
+namespace :load do
+  task :defaults do
+    set :puma_default_hooks, true
+    set :puma_role, :app
+    set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+    set :puma_rackup, -> { File.join(current_path, "config.ru") }
+    set :puma_conf, -> { File.join(shared_path, "puma.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_access_log, -> { File.join(shared_path, "log", "puma_access.log") }
+    set :puma_error_log, -> { File.join(shared_path, "log", "puma_error.log") }
+    set :puma_threads, [0, 16]
+    set :puma_workers, 0
+    set :puma_bind, "tcp://0.0.0.0:9292"
+    set :puma_default_control_app, -> { File.join("unix://#{shared_path}", "tmp", "sockets", "pumactl.sock") }
+    set :puma_tag, -> { fetch(:application) }
+    set :puma_worker_timeout, 60
+    set :puma_init_active_record, false
+    set :puma_preload_app, false
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_puma_hooks do
+    invoke "puma:add_default_hooks" if fetch(:puma_default_hooks)
+  end
+end
+
+namespace :puma do
+  task :add_default_hooks do
+    after "deploy:check", "puma:check"
+    after "deploy:finished", "puma:smart_restart"
+  end
+
+  task :check do
+    on roles fetch(:puma_role) do |_role|
+      unless  test "[ -f #{fetch(:puma_conf)} ]"
+        warn "puma.rb NOT FOUND!"
+        invoke "puma:config"
+        info "puma.rb generated"
+      end
+    end
+  end
+
+  desc "Export template file"
+  task :template do
+    FileUtils.mkdir_p "config/deploy/templates/" unless File.exist? "config/deploy/templates/"
+    FileUtils.cp File.expand_path("../../templates/puma.rb.erb", __FILE__), "config/deploy/templates/puma.rb.erb"
+  end
+
+  desc "Setup puma config file"
+  task :config do
+    on roles(fetch(:puma_role)) do |role|
+      template_puma role
+    end
+  end
+
+  desc "Start puma"
+  task :start do
+    on roles fetch(:puma_role) do |role|
+      puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_conf)} ]"
+          info "using conf file #{fetch(:puma_conf)}"
+        else
+          invoke "puma:config"
+        end
+        within current_path do
+          with rack_env: fetch(:puma_env) do
+            execute :bundle, :exec, :puma, "-C #{fetch(:puma_conf)} --daemon"
+          end
+        end
+      end
+    end
+  end
+
+  %w(halt stop status).map do |command|
+    desc "#{command.capitalize} puma"
+    task command do
+      on roles fetch(:puma_role) do |role|
+        within current_path do
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]"
+                if test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+                  execute :bundle, :exec, :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+                else
+                  # delete invalid pid file , process is not running.
+                  execute :rm, fetch(:puma_pid)
+                end
+              else
+                # pid file not found, so puma is probably not running or it using another pidfile
+                warn "Puma not running"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w(phased-restart restart).map do |command|
+    desc "#{command.capitalize} puma"
+    task command do
+      on roles fetch(:puma_role) do |role|
+        within current_path do
+          puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if (test "[ -f #{fetch(:puma_pid)} ]") && (test :kill, "-0 $( cat #{fetch(:puma_pid)} )")
+                # NOTE pid exist but state file is nonsense, so ignore that case
+                execute :bundle, :exec, :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+              else
+                # Puma is not running or state file is not present : Run it
+                invoke "puma:start"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  task :smart_restart do
+    if !fetch(:puma_preload_app) && fetch(:puma_workers).to_i > 1
+      invoke "puma:phased-restart"
+    else
+      invoke "puma:restart"
+    end
+  end
+
+  def puma_bind
+    Array(fetch(:puma_bind)).collect do |bind|
+      "bind '#{bind}'"
+    end.join("\n")
+  end
+
+  def puma_switch_user(role, &block)
+    user = puma_user(role)
+    if user == role.user
+      block.call
+    else
+      as user do
+        block.call
+      end
+    end
+  end
+
+  def puma_user(role)
+    properties = role.properties
+    properties.fetch(:puma_user) || # local property for puma only
+      fetch(:puma_user) ||
+      properties.fetch(:run_as) || # global property across multiple capistrano gems
+      role.user
+  end
+
+  def template_puma(role)
+    templates_path(role).each do |path|
+      if File.file? path
+        erb = File.read path
+        upload! StringIO.new(ERB.new(erb).result(binding)), fetch(:puma_conf)
+        break
+      else
+        next
+      end
+    end
+  end
+
+  def templates_path(role)
+    [
+      "config/deploy/templates/puma-#{fetch(:stage)}-#{role.hostname}.rb.erb",
+      "config/deploy/templates/puma-#{role.hostname}.rb.erb",
+      "config/deploy/templates/puma-#{fetch(:stage)}.rb.erb",
+      "config/deploy/templates/puma.rb.erb",
+      "lib/capistrano/templates/puma-#{fetch(:stage)}-#{role.hostname}.rb.erb",
+      "lib/capistrano/templates/puma-#{role.hostname}.rb.erb",
+      "lib/capistrano/templates/puma-#{fetch(:stage)}.rb.erb",
+      "lib/capistrano/templates/puma.rb.erb",
+      File.expand_path("../../templates/puma.rb.erb", __FILE__)
+    ]
+  end
+end

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

@@ -0,0 +1,42 @@
+#!/usr/bin/env puma
+
+directory '<%= current_path %>'
+rackup "<%=fetch(:puma_rackup)%>"
+environment '<%= fetch(:puma_env) %>'
+<% if fetch(:puma_tag) %>
+  tag '<%= fetch(:puma_tag)%>'
+<% end %>
+pidfile "<%=fetch(:puma_pid)%>"
+state_path "<%=fetch(:puma_state)%>"
+stdout_redirect '<%=fetch(:puma_access_log)%>', '<%=fetch(:puma_error_log)%>', true
+
+
+threads <%=fetch(:puma_threads).join(',')%>
+
+<%= puma_bind %>
+<% if fetch(:puma_control_app) %>
+activate_control_app "<%= fetch(:puma_default_control_app) %>"
+<% end %>
+workers <%= fetch(:puma_workers) %>
+<% if fetch(:puma_worker_timeout) %>
+worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
+<% end %>
+
+<% if fetch(:puma_preload_app) %>
+preload_app!
+<% else %>
+prune_bundler
+<% end %>
+
+on_restart do
+  puts 'Refreshing Gemfile'
+  ENV["BUNDLE_GEMFILE"] = "<%= fetch(:bundle_gemfile, "#{current_path}/Gemfile") %>"
+end
+
+<% if fetch(:puma_preload_app) && fetch(:puma_init_active_record) %>
+on_worker_boot do
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::Base.establish_connection
+  end
+end
+<% end %>

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-puma-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hirocaster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Puma simple integration for Capistrano3
+email:
+- hohtsuka@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-puma-simple.gemspec
+- lib/capistrano/puma-simple.rb
+- lib/capistrano/puma-simple/version.rb
+- lib/capistrano/tasks/puma.rake
+- lib/capistrano/templates/puma.rb.erb
+homepage: ''
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Puma simple integration for Capistrano3
+test_files: []