capistrano-background 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92d9c499944e773fd9b37ec7102c37c2a3f8bfbe
+  data.tar.gz: 6d32e91a44c96a1b90d19b09eebcbaacd3be8387
+SHA512:
+  metadata.gz: 6889436465b54c390d6a7f366ae43089999367e34234d1c44f70d2b4a4c8758218faccd5808e29649c03155804ce1ce712267ad310adf657a8857f4000b5afc2
+  data.tar.gz: 267fde493740a83512412d6fdf893355887f04e5b2271de398702670e99ad95e12e2fe0f1185acd456870537868c97086c906a8033557e9bf61a86f38b2b51e6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chen Yi-Cyuan
+
+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,45 @@
+# capistrano-background
+
+Run background process for capistrano.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-background'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install capistrano-background
+
+## Usage
+Require in your Capfile
+```Ruby
+require 'capistrano/background'
+```
+Add your background processes.
+```Ruby
+add_background_process({
+  :id => :scheduler,
+  :execute => [:rake, 'scheduler']
+})
+```
+It will run `rake scheduler` in background when deploy. You can also use command:
+
+    cap production background:start
+    cap production background:stop
+    cap production background:restart
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/capistrano-background  
+Author: emn178@gmail.com

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/background"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-background.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/background/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-background"
+  spec.version       = Capistrano::Background::VERSION
+  spec.authors       = ["Chen Yi-Cyuan"]
+  spec.email         = ["emn178@gmail.com"]
+
+  spec.summary       = %q{Run background process for capistrano.}
+  spec.description   = %q{Run background process for capistrano.}
+  spec.homepage      = "https://github.com/emn178/capistrano-background.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/capistrano/background.rb

@@ -0,0 +1,3 @@
+if Gem::Specification.find_by_name('capistrano').version >= Gem::Version.new('3.0.0')
+  load File.expand_path('../tasks/background.rake', __FILE__)
+end

data/lib/capistrano/background/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Background
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/tasks/background.rake

@@ -0,0 +1,98 @@
+module SSHKit
+  class Command
+    alias_method :orig_in_background, :in_background
+
+    def in_background(&_block)
+      return yield unless options[:run_in_background]
+      pid_file = options[:pid_file]
+      if pid_file.nil?
+        orig_in_background(&_block)
+      else
+        sprintf("( nohup %s > /dev/null & \\echo $! > #{pid_file})", yield)
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :background_processes, []
+  end
+end
+
+namespace :background do
+  processes = []
+
+  def get_pid_file(options)
+    options[:pid_file] || File.join(shared_path, 'tmp', 'pids', "#{options[:id]}.pid")
+  end
+
+  def pid_process_exists?(pid_file)
+    file_exists?(pid_file) and test(*("kill -0 $( cat #{pid_file} )").split(' '))
+  end
+
+  def file_exists?(file)
+    test(*("[ -f #{file} ]").split(' '))
+  end
+
+  def start_process(pid_file, options)
+    stage = fetch :stage
+    args = options[:execute]
+    args << {:pid_file => pid_file}
+    with(:RAILS_ENV => "#{stage} && ") do
+      background *args
+    end
+  end
+
+  def stop_process(pid_file)
+    if file_exists? pid_file
+      background "kill -TERM `cat #{pid_file}`" 
+      execute "rm #{pid_file}"
+    end
+  end
+
+  task :add_default_hooks do
+    after 'deploy:starting', 'background:quiet'
+    after 'deploy:updated', 'background:stop'
+    after 'deploy:reverted', 'background:stop'
+    after 'deploy:published', 'background:start'
+  end
+
+  desc 'Stop background processes'
+  task :stop do
+    background_processes = fetch :background_processes
+    background_processes.each do |options|
+      role = options[:role] || :app
+      on roles role do
+        within release_path do
+          stop_process(get_pid_file(options))
+        end
+      end
+    end
+  end
+
+  desc 'Start background processes'
+  task :start do
+    background_processes = fetch :background_processes
+    background_processes.each do |options|
+      role = options[:role] || :app
+      on roles role do
+        within release_path do
+          pid_file = get_pid_file(options)
+          start_process(pid_file, options) unless pid_process_exists?(pid_file)
+        end
+      end
+    end
+  end
+
+  desc 'Restart background processes'
+  task :restart do
+    invoke 'background:stop'
+    invoke 'background:start'
+  end
+end
+
+def add_background_process(options)
+  background_processes = fetch :background_processes
+  background_processes << options
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-background
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chen Yi-Cyuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Run background process for capistrano.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-background.gemspec
+- lib/capistrano/background.rb
+- lib/capistrano/background/version.rb
+- lib/capistrano/tasks/background.rake
+homepage: https://github.com/emn178/capistrano-background.git
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Run background process for capistrano.
+test_files: []