mina-ng-puma 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d7ff92738b7a21a7e6a6cd66258201ef8c42e399ffd2bb2e59bca8d70a9a8b9e
+  data.tar.gz: c056becb525af7c2b690052e18695c743697b4195152be752b060d97422e4a44
+SHA512:
+  metadata.gz: 4716a49a617df7a5f525cc32581fc8c8666ff33b285895af3b633f2e28c333ceb8a7c3432cd79f2a8505a2b3fb5e849528d510d36779ff9115ec0d1d0f25235e
+  data.tar.gz: 062cf312f432336561393d685c00d2f9cef45fbc6923728de0f76126bda0df4a4ba6e6de4fab527cf1676f2bea47582a713d4d9326cf75524115f5dc86b015ae

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tobias Sandelius
+
+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,101 @@
+# Next Generation Mina Puma
+
+I refactor mina-puma( https://github.com/untitledkingdom/mina-puma ) because of the below:
+
+1. `phased_restart` and `restart` need start puma correctly when puma is down.
+2. `phased_restart` and `restart` should confirm puma restart successfully.
+3. check `puma_pid` instead of `pumactl_socket`.
+
+[Mina](https://github.com/nadarei/mina) tasks for handle with
+[Puma](https://github.com/puma/puma).
+
+This gem provides several mina tasks:
+
+    mina puma:phased_restart  # Restart puma (using phased restart)
+    mina puma:hard_restart    # Restart puma (using stop, then start)
+    mina puma:restart         # Restart puma (using pumactl)
+    mina puma:start           # Start puma
+    mina puma:stop            # Stop puma
+    mina puma:status          # Get status
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mina-ng-puma', require: false
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mina-ng-puma
+
+Note: by just including this gem, does not mean your development server will be Puma, for that, you need explicitly add `gem 'puma'` to your Gemfile.
+
+## Usage
+
+Run:
+```
+mina init
+```
+to generate `config/deploy.rb` file if you have not configured it yet.
+
+Add this to your `config/deploy.rb` file:
+
+    require 'mina/puma'
+
+Make sure the following settings are set in your `config/deploy.rb`:
+
+* `deploy_to`   - deployment path
+
+Make sure the following directories exists on your server:
+
+* `shared/tmp/sockets` - directory for socket files.
+* `shared/tmp/pids` - directory for pid files.
+
+OR you can set other directories by setting follow variables:
+
+* `puma_socket` - puma socket file, default is `shared/tmp/sockets/puma.sock`
+* `puma_pid` - puma pid file, default `shared/tmp/pids/puma.pid`
+* `puma_state` - puma state file, default `shared/tmp/sockets/puma.state`
+* `puma_stdout` - puma redirect path for stdout, default `shared/log/puma.log`
+* `puma_stderr` - puma redirect path for stderr, default `shared/log/puma.log`
+* `pumactl_socket` - pumactl socket file, default `shared/tmp/sockets/pumactl.sock`
+* `puma_root_path` - puma command execute root path, default `current`
+
+Then:
+
+```
+$ bundle exec mina puma:start
+```
+
+## Example
+```ruby
+require 'mina/puma'
+
+# Add pids and sockets directories to shared dirs
+set :shared_dirs, fetch(:shared_dirs, []).push('log', 'tmp/pids', 'tmp/sockets')
+
+task :deploy do
+  deploy do
+    invoke :'git:clone'
+    invoke :'deploy:link_shared_paths'
+    ...
+
+    on :launch do
+      ...
+      invoke :'puma:phased_restart'
+    end
+  end
+end
+```
+
+## 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/lib/mina/puma.rb

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

data/lib/mina/puma/tasks.rake

@@ -0,0 +1,156 @@
+require 'mina/bundler'
+require 'mina/rails'
+
+namespace :puma do
+  set :web_server, :puma
+
+  set :puma_role,      -> { fetch(:user) }
+  set :puma_env,       -> { fetch(:rails_env, 'production') }
+  set :puma_config,    -> { "#{fetch(:shared_path)}/config/puma.rb" }
+  set :puma_socket,    -> { "#{fetch(:shared_path)}/tmp/sockets/puma.sock" }
+  set :puma_state,     -> { "#{fetch(:shared_path)}/tmp/sockets/puma.state" }
+  set :puma_pid,       -> { "#{fetch(:shared_path)}/tmp/pids/puma.pid" }
+  set :puma_stdout,    -> { "#{fetch(:shared_path)}/log/puma.log" }
+  set :puma_stderr,    -> { "#{fetch(:shared_path)}/log/puma.log" }
+  set :puma_cmd,       -> { "#{fetch(:bundle_prefix)} puma" }
+  set :pumactl_cmd,    -> { "#{fetch(:bundle_prefix)} pumactl" }
+  set :pumactl_socket, -> { "#{fetch(:shared_path)}/tmp/sockets/pumactl.sock" }
+  set :puma_root_path, -> { fetch(:current_path) }
+
+  desc 'Start puma'
+  task :start do
+    puma_port_option = "-p #{fetch(:puma_port)}" if set?(:puma_port)
+
+    comment "Starting Puma..."
+    command %[
+      if [ -e "#{fetch(:puma_pid)}"  ] && kill -0 "$(cat #{fetch(:puma_pid)})" 2> /dev/null; then
+        echo 'Puma is already running!';
+      else
+        if [ -e "#{fetch(:puma_config)}" ]; then
+          cd #{fetch(:puma_root_path)} && #{fetch(:puma_cmd)} -q -d -e #{fetch(:puma_env)} -C #{fetch(:puma_config)}
+        else
+          cd #{fetch(:puma_root_path)} && #{fetch(:puma_cmd)} -q -d -e #{fetch(:puma_env)} -b "unix://#{fetch(:puma_socket)}" #{puma_port_option} -S #{fetch(:puma_state)} --pidfile #{fetch(:puma_pid)} --control 'unix://#{fetch(:pumactl_socket)}' --redirect-stdout "#{fetch(:puma_stdout)}" --redirect-stderr "#{fetch(:puma_stderr)}"
+        fi
+      fi
+    ]
+  end
+
+  desc 'Stop puma'
+  task :stop do
+    comment "Stopping Puma..."
+    pumactl_command 'stop'
+    command %[rm -f '#{fetch(:pumactl_socket)}']
+  end
+
+  desc 'Restart puma'
+  task :restart do
+    comment "Restart Puma...."
+    pumactl_restart_command 'restart'
+  end
+
+  desc 'Restart puma (phased restart)'
+  task :phased_restart do
+    comment "Restart Puma -- phased..."
+    pumactl_restart_command 'phased-restart'
+  end
+
+  desc 'Restart puma (hard restart)'
+  task :hard_restart do
+    comment "Restart Puma -- hard..."
+    invoke 'puma:stop'
+    wait_quit_or_force_quit_command
+    invoke 'puma:start'
+  end
+
+  desc 'Get status of puma'
+  task :status do
+    comment "Puma status..."
+    pumactl_command 'status'
+  end
+
+  def pumactl_command(command)
+    cmd =  %{
+      if [ -e "#{fetch(:puma_pid)}"  ]; then
+        if kill -0 "$(cat #{fetch(:puma_pid)})" 2> /dev/null; then
+          if [ -e "#{fetch(:puma_config)}" ]; then
+            cd #{fetch(:puma_root_path)} && #{fetch(:pumactl_cmd)} -F #{fetch(:puma_config)} #{command}
+          else
+            cd #{fetch(:puma_root_path)} && #{fetch(:pumactl_cmd)} -S #{fetch(:puma_state)} -C "unix://#{fetch(:pumactl_socket)}" --pidfile #{fetch(:puma_pid)} #{command}
+          fi
+        else
+          rm "#{fetch(:puma_pid)}"
+        fi
+      else
+        echo 'Puma is not running!';
+      fi
+    }
+    command cmd
+  end
+
+  def pumactl_restart_command(command)
+    puma_port_option = "-p #{fetch(:puma_port)}" if set?(:puma_port)
+
+    cmd =  %{
+      if [ -e "#{fetch(:puma_pid)}"  ] && kill -0 "$(cat #{fetch(:puma_pid)})" 2> /dev/null; then
+        if [ -e "#{fetch(:puma_config)}" ]; then
+          cd #{fetch(:puma_root_path)} && #{fetch(:pumactl_cmd)} -F #{fetch(:puma_config)} #{command}
+        else
+          cd #{fetch(:puma_root_path)} && #{fetch(:pumactl_cmd)} -S #{fetch(:puma_state)} -C "unix://#{fetch(:pumactl_socket)}" --pidfile #{fetch(:puma_pid)} #{command}
+        fi
+      else
+        echo "Puma is not running, restarting";
+        if [ -e "#{fetch(:puma_config)}" ]; then
+          cd #{fetch(:puma_root_path)} && #{fetch(:puma_cmd)} -q -d -e #{fetch(:puma_env)} -C #{fetch(:puma_config)}
+        else
+          cd #{fetch(:puma_root_path)} && #{fetch(:puma_cmd)} -q -d -e #{fetch(:puma_env)} -b "unix://#{fetch(:puma_socket)}" #{puma_port_option} -S #{fetch(:puma_state)} --pidfile #{fetch(:puma_pid)} --control 'unix://#{fetch(:pumactl_socket)}' --redirect-stdout "#{fetch(:puma_stdout)}" --redirect-stderr "#{fetch(:puma_stderr)}"
+        fi
+      fi
+    }
+    command cmd
+  end
+
+  def wait_quit_or_force_quit_command
+    cmd = %{
+      quit_flag=false
+      times=3
+      while [ $times -gt 0 ]; do
+        if [ -e "#{fetch(:puma_pid)}" ]; then
+          #echo ">>> sleep 1"
+          sleep 1
+          times=$[$times -1]
+        else
+          quit_flag=true
+          break
+        fi
+      done
+
+      if [ $quit_flag == false ]; then
+        echo "Friendly quit fail, force quit..."
+
+        #echo "kill -9 $(cat #{fetch(:puma_pid)})"
+        kill -9 $(cat "#{fetch(:puma_pid)}") 2> /dev/null
+
+        force_quit_flag=false
+        force_times=3
+        while [ $force_times -gt 0 ]; do
+          if [ -e "#{fetch(:puma_pid)}" ] && kill -0 $(cat "#{fetch(:puma_pid)}") 2> /dev/null; then
+            sleep 1
+            force_times=$[$force_times -1]
+          else
+            force_quit_flag=true
+            echo "Force quit successfully"
+            break
+          fi
+        done
+
+        if [ "$force_quit_flag" == false ]; then
+          echo "Force quit fail too, please check the script!!!"
+          exit 1
+        fi
+      else
+        echo "Friendly quit successfully"
+      fi
+    }
+    command cmd
+  end
+end

data/lib/mina/puma/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Puma
+    VERSION = "1.2.0"
+  end
+end

data/mina-ng-puma.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/puma/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-ng-puma'
+  spec.version       = Mina::Puma::VERSION
+  spec.authors       = ['windy']
+  spec.email         = ['lyfi2003@gmail.com']
+  spec.description   = %q{Next Generation Puma tasks for Mina}
+  spec.summary       = %q{Next Generation Puma tasks for Mina}
+  spec.homepage      = 'https://github.com/windy/mina-ng-puma'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'mina', '~> 1.2.0'
+  spec.add_dependency 'puma', '>= 2.13'
+
+  spec.add_development_dependency 'bundler', '>= 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: mina-ng-puma
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- windy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !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: Next Generation Puma tasks for Mina
+email:
+- lyfi2003@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mina/puma.rb
+- lib/mina/puma/tasks.rake
+- lib/mina/puma/version.rb
+- mina-ng-puma.gemspec
+homepage: https://github.com/windy/mina-ng-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Next Generation Puma tasks for Mina
+test_files: []