forker 1.0.1

data/README.md

@@ -0,0 +1,57 @@
+# Goals
+
+* Simplest code possible to daemonize code, redirect output and manage the
+  pidfile.
+
+## Usage
+
+    require 'forker'
+    Forker.fork(
+      :log   => "/dev/null",                         # Default value
+      :pid   => "/var/run/#{File.basename($0)}.pid", # Default value
+      :chdir => false,                               # Default value
+      :umask => false                                # Default value
+    )
+
+    # Do stuff in daemonized proc...
+
+## Or for a simple start/stop script
+
+    #!/usr/bin/env ruby
+    # Example usage from command line:
+    # ./bin/myscript start --logfile LOGFILE --pidfile PIDFILE
+    # ./bin/myscript stop  --logfile LOGFILE --pidfile PIDFILE
+
+    require 'forker'
+    Forker::CLI.run(ARGV)
+
+## Example bin/worker script for Resque
+
+    #!/usr/bin/env ruby
+
+    # Default to production, this script can't be passed env vars on the prod servers
+    ENV['RAILS_ENV'] ||= 'production'
+
+    # Simulate calling rake environment
+    $rails_rake_task = true
+
+    # Load rails env
+    require File.expand_path("../config/environment", File.dirname(__FILE__))
+
+    require 'forker'
+    Forker::CLI.run(ARGV)
+
+    worker = nil
+    queues = (ENV['QUEUES'] || ENV['QUEUE'] || '*').to_s.split(',')
+
+    begin
+      worker = Resque::Worker.new(*queues)
+      worker.verbose = ENV['LOGGING'] || ENV['VERBOSE']
+      worker.very_verbose = ENV['VVERBOSE']
+    rescue Resque::NoQueueError
+      abort "set QUEUE env var, e.g. $ QUEUE=critical,high,low rake resque:work"
+    end
+
+    puts "*** Starting worker in #{ENV['RAILS_ENV']} environment: #{worker}"
+
+    worker.work(ENV['INTERVAL'] || 5) # interval, will block

data/lib/forker.rb

@@ -0,0 +1,124 @@
+# This gem follows best practices for daemonizing processes in a UNIX
+# environment with as little fluff as possible. Forks once, calls `setsid`,
+# and forks again. STDIN, STDOUT, STDERR are all redirected to /dev/null by
+# default. We'll manage the pidfile also.
+#
+# `chdir` and `umask` are optional precautions:
+#
+# * `chdir` is a safeguard against problems that would occur is you tried to
+#   launch a daemon process on a mounted filesystem
+# * `umask` gives your daemon process more control over file creation
+#   permissions
+#
+# Notes
+# $$ = Process.pid
+
+require 'system_timer'
+
+module Forker
+  module CLI
+    # You can use this if your daemon is simple enough or write your own and
+    # use Forker#fork! directly
+    def self.run(argv)
+      require 'optparse'
+      options = {}
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [start|stop] -p /path/to/pidfile.pid"
+
+        opts.on("-l", "--logfile LOGFILE", "redirect output to this location") do |logfile|
+          options[:log] = logfile
+        end
+
+        opts.on("-p", "--pidfile PIDFILE", "save pidfile to this location") do |pidfile|
+          options[:pid] = pidfile
+        end
+      end
+      opts.parse!(argv)
+
+      if options[:pid].nil?
+        puts opts
+        exit
+      end
+
+      case argv.first
+      when "start"
+        Forker.fork!(options)
+      when "stop"
+        Forker.kill(options)
+        exit
+      else
+        puts opts
+        exit
+      end
+    end
+  end
+
+  def self.fork!(opts={})
+    opts = { :log => "/dev/null", :pid => "/var/run/#{File.basename($0)}.pid" }.merge(opts)
+
+    $stdout.sync = $stderr.sync = true
+    $stdin.reopen("/dev/null")
+
+    exit if fork
+
+    Process.setsid
+
+    exit if fork
+
+    Dir.chdir("/")   if opts[:chdir]
+    File.umask(0000) if opts[:umask]
+
+    if File.exist?(opts[:pid])
+      begin
+        existing_pid = File.read(opts[:pid]).to_i
+        Process.kill(0, existing_pid) # See if proc exists
+        abort "error: existing process #{existing_pid} using this pidfile, exiting"
+      rescue Errno::ESRCH
+        puts "warning: removing stale pidfile with pid #{existing_pid}"
+      end
+    end
+
+    File.open(opts[:pid], 'w') { |f| f.write($$) }
+
+    at_exit do
+      ( File.read(opts[:pid]).to_i == $$ and File.unlink(opts[:pid]) ) rescue nil
+    end
+
+    puts "forked process is #{$$}"
+    puts "output redirected to #{opts[:log]}"
+
+    $stdout.reopen(opts[:log], 'a')
+    $stderr.reopen(opts[:log], 'a')
+    $stdout.sync = $stderr.sync = true
+  end
+
+  def self.kill(opts={})
+    begin
+      pid = File.read(opts[:pid]).to_i
+      sec = 60 # Seconds to wait before force killing
+      Process.kill("TERM", pid)
+
+      begin
+        SystemTimer.timeout(sec) do
+          loop do
+            puts "waiting #{sec} seconds for #{pid} before sending KILL"
+            Process.kill(0, pid) # See if proc exists
+
+            sec -= 1
+            sleep 1
+          end
+        end
+      rescue Errno::ESRCH
+        puts "killed process #{pid}"
+      rescue Timeout::Error
+        Process.kill("KILL", pid)
+        puts "force killed process #{pid}"
+      end
+
+    rescue Errno::ENOENT
+      puts "warning: pidfile #{opts[:pid]} does not exist"
+    rescue Errno::ESRCH
+      puts "warning: process #{pid} does not exist"
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: forker
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ben Marini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: SystemTimer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id001
+description: Fork your ruby code with confidence
+email: bmarini@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/forker.rb
+- README.md
+has_rdoc: true
+homepage: http://github.com/bmarini/forker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fork your ruby code with confidence
+test_files: []
+