joechill 1.0.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Michael Sechooler
+
+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,30 @@
+The Chill gem provides a way to fork or spawn a subprocess
+that will die when its parent does. It accomplishes this by
+also spawning a watchdog process. The watchdog and the parent
+are connected by an anonymous pipe; when the pipe is broken
+(because the parent dies), the watchdog will then send a signal
+to the child.
+
+There are some limitations to this. Firstly, the parent must
+maintain the pipe. It cannot, for example, overlay itself
+with another process (through an exec call) that closes all
+open file descriptors. Secondly, there is a minor race
+condition. If the child terminates before the parent, the parent
+reaps the child, and a new process is started with the same PID,
+the watchdog will mistakenly kill this different process when
+the parent dies. This could be avoided by having the watchdog
+spawn the child, but that would complicate the relationship between
+the parent and child.
+
+The easiest way to use the class is to call one of its class methods,
+`::fork` or `::spawn`. You can also construct an instance, which will give
+you control over the signal it issues to the child (by default `SIGTERM`).
+
+This gem was created to quickly solve a problem in a development
+environment. It isn't necessarily ideal for production use. For Linux
+environments, you might want to look into `PR_SET_PDEATHSIG`.
+
+More information is available in the doc directory, which is generated by
+running rdoc against the whole project. An
+[online copy](http://htmlpreview.github.io/?https://github.com/mikesech/chill/blob/master/doc/Chill.html)
+is available.

data/chill.gemspec

@@ -0,0 +1,19 @@
+# encoding: utf-8
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'chill'
+
+Gem::Specification.new do |s|
+  s.name = 'joechill'
+  s.summary = 'Starts a subprocess that dies when its parent does.'
+  s.description = 'Chill starts a subprocess that dies when its parent does.'
+  s.homepage = 'http://github.com/mikesech/chill'
+  s.version = Chill::VERSION
+  s.licenses =  ['MIT']
+
+  s.authors = [ 'Michael Sechooler' ]
+  s.email = [ 'mikesech@gmail.com' ]
+
+  s.require_paths = ['lib']
+  s.files = %w( README.md LICENSE chill.gemspec )
+  s.files += Dir.glob('lib/**/*')
+end

data/lib/chill.rb

@@ -0,0 +1,125 @@
+##
+# Starts a subprocess that dies when its parent does.
+# 
+# The Chill class provides a way to fork or spawn a subprocess
+# that will die when its parent does. It accomplishes this by
+# also spawning a watchdog process. The watchdog and the parent
+# are connected by an anonymous pipe; when the pipe is broken
+# (because the parent dies), the watchdog will then send a signal
+# to the child.
+# 
+# There are some limitations to this. Firstly, the parent must
+# maintain the pipe. It cannot, for example, overlay itself
+# with another process (through an exec call) that closes all
+# open file descriptors. Secondly, there is a minor race
+# condition. If the child terminates before the parent, the parent
+# reaps the child, and a new process is started with the same PID,
+# the watchdog will mistakenly kill this different process when
+# the parent dies. This could be avoided by having the watchdog
+# spawn the child, but that would complicate the relationship between
+# the parent and child.
+# 
+# The easiest way to use this class is to call one of its class methods,
+# ::fork or ::spawn. You can also construct an instance, which will give
+# you control over the signal it issues to the child (by default +SIGTERM+).
+# 
+# This class was created to quickly solve a problem in a development
+# environment. It isn't necessarily ideal for production use. For Linux
+# environments, you might want to look into +PR_SET_PDEATHSIG+.
+# 
+class Chill
+  VERSION = '1.0.0'
+
+  ##
+  # The PID of the spawned subprocess.
+  #
+  attr_reader :pid
+
+  ##
+  # Constructs a new Chill object.
+  #
+  # Also creates a new anonymous pipe to be used as the underlying
+  # signaling mechanism.
+  # 
+  # +signal+::
+  #   The name of the POSIX signal (e.g., "TERM") to issue
+  #   the child when its parent dies.
+  #
+  def initialize(signal = "TERM")
+    @reader, @writer = IO.pipe
+    @signal = signal
+  end
+
+  ##
+  # Forks a child process and executes a block in it.
+  # 
+  # Returns the PID of the child process.
+  # 
+  def fork(&block)
+    raise RuntimeError, "already in use" unless @pid.nil?
+    @pid = Process.fork do
+      # The child doesn't need the pipe, and leaving it open
+      # will keep the pipe alive even after the parent dies.
+      @reader.close
+      @writer.close
+      block.call
+    end
+    spawn_watchdog_process
+    
+    # The parent of the watchdog process (the original parent)
+    # doesn't need to use the pipe. Let's close the other end now.
+    @reader.close
+
+    @pid
+  end
+  ##
+  # Spawns a new process.
+  # See <tt>Kernel::exec</tt> for the arguments accepted.
+  # 
+  # Returns the PID of the child process.
+  # 
+  def spawn(*args)
+    fork do
+      Process.exec(*args)
+    end
+  end
+
+  ##
+  # Forks a child process and executes a block in it.
+  # 
+  # Returns the Chill instance created. The PID of the child process
+  # can be accessed through its +pid+ method.
+  # 
+  def self.fork(&block); x = self.new; x.fork(&block); x; end
+  ##
+  # Spawns a new process.
+  # See <tt>Kernel::exec</tt> for the arguments accepted.
+  # 
+  # Returns the Chill instance created. The PID of the child process
+  # can be accessed through its +pid+ method.
+  # 
+  def self.spawn(*args); x = self.new; x.spawn(*args); x; end
+
+  private
+
+  ##
+  # Spawns a subprocess to monitor the parent.
+  # 
+  # The watchdog process' parent is the original parent.
+  # The watchdog works by waiting for a pipe also held by the parent to
+  # break. When it does, it will issue a signal to the child process.
+  # 
+  def spawn_watchdog_process
+    Process.fork do
+      # If we don't close the write end, the read might never end since the OS doesn't
+      # generate EOFs if there is a write end still open. We use EOF to signal a failure
+      # or abrupt termination of the signaling process.
+      @writer.close
+
+      val = @reader.sysread(1) rescue nil
+      @reader.close
+
+      Process.kill(@signal, @pid) if val.nil?
+    end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: joechill
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Michael Sechooler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Chill starts a subprocess that dies when its parent does.
+email:
+- mikesech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- chill.gemspec
+- lib/chill.rb
+homepage: http://github.com/mikesech/chill
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.28
+signing_key: 
+specification_version: 3
+summary: Starts a subprocess that dies when its parent does.
+test_files: []
+has_rdoc: