wonko9-i_can_daemonize 0.0.0 → 0.3.0

data/Rakefile

@@ -1,37 +1,8 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rcov/rcovtask'
+# -*- ruby -*-
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "i_can_daemonize"
-    s.summary = "ICanDaemonize makes it dead simple to create daemons of your own"
-    s.email = "wonko9@gmail.com"
-    s.homepage = "http://github.com/wonko9/i_can_daemonize"
-    s.description = "ICanDaemonize makes it dead simple to create daemons of your own"
-    s.authors = ["Adam Pisoni", "Amos Elliston"]
-    s.files =  FileList["[A-Z]*", "{lib,test}/**/*"]
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-Rake::TestTask.new
+require 'rubygems'
+require 'hoe'
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'test'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Hoe.new('ICanDaemonize', '0.6.0') do |p|
+  p.developer('Adam Pisoni', 'wonko9@gmail.com')
 end
-
-Rcov::RcovTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
-
-task :default => :test

data/examples/feature_demo.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'i_can_daemonize'
+
+class ICanDaemonize::FeatureDemo
+  include ICanDaemonize
+  
+  def self.define_args(args)
+    # "See the OptionParser docs for more info on how to define your own args.\n http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/classes/OptionParser.html\n"
+    @options[:nobugs] = true
+    args.on("--scott-rocks=TRUE", "Thanks scott") do |t|
+      @options[:scott_rocks] = t
+    end                   
+    args.on("--nobugs=TRUE", "No bugs flag") do |t|
+      @options[:nobugs] = false if t == "1" or t.downcase == "false"
+    end                   
+  end
+  
+  before do
+    puts "The before block is executed after daemonizing, but before looping over the daemonize block"
+    if @options[:nobugs]
+      puts "Running with no bugs. Pass nobugs=false to run with bugs."
+    else
+      puts "There mite be busg"
+    end
+  end
+
+  after do
+    puts "The after block is executed before the program exits gracefully, but is not run if the program dies."
+  end
+  
+  die_if do
+    puts "The die_if block is executed after every loop and dies if true is returned."
+    false
+  end
+
+  exit_if do
+    puts "The exit_if block is executed after every loop and exits gracefully if true is returned."
+    false
+  end
+  
+  daemonize(:loop_every => 3, :timeout=>2, :die_on_timeout => false) do
+    puts "The daemonize block is called in a loop."
+  end
+  
+end

data/examples/rails_daemon.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'i_can_daemonize'
+begin
+  require File.dirname(__FILE__) + "/../config/environment"
+rescue LoadError
+  puts "\n****** ERROR LOADING RAILS ******\n\trails_daemon.rb should be put in your RAILS_ROOT/script directory so it can find your environment.rb\n\tOr you can change the environment require on line 4.\n*********************************\n\n"
+end
+
+class ICanDaemonize::RailsDaemon
+  include ICanDaemonize
+  
+  before do
+    puts "This daemon has access to your entire rails stack and will log to RAILS_ROOT/log"
+  end
+  
+  daemonize(:loop_every => 3, :timeout=>2, :die_on_timeout => false) do
+    puts "The daemonize block is called in a loop."
+  end
+  
+end

data/examples/simple_daemon.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'i_can_daemonize'
+
+class ICanDaemonize::FeatureDemo
+  include ICanDaemonize
+
+  daemonize(:loop_every => 3) do
+    puts "The daemonize block is called in a loop."
+  end
+
+end

data/examples/starling_queue_daemon.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'pp'
+require 'i_can_daemonize'
+begin
+  require 'starling'
+rescue LoadError
+  puts "\n****** ERROR LOADING STARLING ******\n\tStarling is not installed.  Please run 'sudo gem install starling' before running this script.\n*********************************\n\n"
+end
+
+class ICanDaemonize::StarlingDaemon
+  include ICanDaemonize
+
+  if ARGV.include?('start')
+    puts <<-DOC 
+
+    This daemon will listen to a starling queue called '#{@queue_name}' and print out whatever is added
+    First tail this daemon's log in another window.  
+    The log is @ #{log_file}
+    Run irb at the console and type
+    > require 'rubygems'
+    > require 'starling'
+    > starling = Starling.new('127.0.0.1:22122')
+    > starling.set('#{@queue_name}','Hi there!')
+    Now watch the log file.
+
+    DOC
+  end
+  
+  before do
+    @queue_name = "starlingdeamon"
+    @starling = Starling.new("127.0.0.1:22122")
+    @fetch_count = 0
+  end
+  
+  daemonize(:log_prefix => false) do
+    puts "Trying to fetch from the '#{@queue_name}' queue. Dequeued #{@fetch_count} so far"
+    pp "GOT: ", @starling.get(@queue_name)
+    @fetch_count += 1
+  end
+  
+end

data/i_can_daemonize.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name     = "i_can_daemonize"
+  s.version  = "0.3.0"
+  s.date     = "2009-01-15"
+  s.summary  = "Better way to build daemons"
+  s.email    = "apisoni@yammer-inc.com"
+  s.homepage = "http://github.com/wonko9/i_can_daemonize"
+  s.description = "Better daemonizer."
+  s.has_rdoc = true
+  s.authors  = ["Adam Pisoni", "Amos Elliston"]
+  s.files    = [
+  "History.txt", 
+    "README.txt", 
+    "Rakefile", 
+    "i_can_daemonize.gemspec",
+    "lib/i_can_daemonize.rb",
+    "lib/i_can_daemonize/version.rb",
+    "examples/feature_demo.rb",
+    "examples/rails_daemon.rb",
+    "examples/simple_daemon.rb",
+    "examples/starling_queue_daemon.rb",
+  ]
+
+  s.test_files = ["test/test_i_can_daemonize.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+#  s.add_dependency("diff-lcs", ["> 0.0.0"])
+end
+

data/lib/i_can_daemonize/version.rb

@@ -0,0 +1,10 @@
+module Clay #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end
+

data/lib/i_can_daemonize.rb

@@ -45,12 +45,12 @@ module ICanDaemonize
           options[:loop_every] = value 
         end
 
-        opt.on('-t', '--ontop', 'Stay on top (does not daemonize)') do
-          options[:ontop] = true
+        opt.on('-t', '--ontop', 'Stay on top (does not daemonize)') do |value|
+          options[:ontop] = value
         end
 
         opt.on('--instances=NUM', 'Allow multiple instances to run simultaneously? 0 for infinite. default: 1') do |value|
-          self.instances = value.to_i
+          @instances = value.to_i
         end
 
         opt.on('--log-file=LOGFILE', 'Logfile to log to') do |value|
@@ -61,8 +61,10 @@ module ICanDaemonize
           options[:pid_file] = File.expand_path(value)
         end
 
-        opt.on('--no-log-prefix', 'Do not prefix PID and date/time in log file.') do
-          options[:log_prefix] = false
+        opt.on('--log-prefix=BOOLEAN', 'All output to logfiles will be prefixed with PID and date/time.') do |value|
+          if value.downcase == 'false' or value == '0'
+            options[:log_prefix] = false
+          end
         end
       end
       
@@ -73,14 +75,17 @@ module ICanDaemonize
       end
 
       opts.parse!
+      options[:ontop] ||= !ARGV.include?('start')
       
       if ARGV.include?('stop')                                                         
-        stop_daemons
+        @instances ||= 0
+        stop_daemons(@instances)
       elsif ARGV.include?('restart')
         restart_daemons
-      elsif ARGV.include?('start') or ontop?
-        self.running   = true
-        self.restarted = true if ARGV.include?('HUP')
+      elsif ARGV.include?('start')
+        @instances ||= 1
+        @running     = true
+        @restarted   = true if ARGV.include?("HUP")
       else
         puts opts.help
       end
@@ -99,7 +104,7 @@ module ICanDaemonize
     end
 
     def options
-      @options ||= {}
+      @options ||= {:log_prefix => true}
     end
 
     def config
@@ -160,26 +165,23 @@ module ICanDaemonize
     #  Run this check after each iteration of the loop.   If the block returns true, exit gracefully
     #  You can also define the after block by putting an exit_if do/end block in your class.
     #
-    # <tt>:log_prefix</tt> BOOL (DEFAULT true)
+    # <tt>:log_prefix</tt> BOOL (DEFAULT false)
     #  Prefix log file entries with PID and timestamp
-    def daemonize(opts={}, &block)
+    def daemonize(options={},&block)
       parse_options
       return unless ok_to_start?
 
-      options.merge!(opts)
-      puts "Starting #{instances_to_start} #{script_name} #{pluarlize('instance', instances_to_start)}..."
-      puts "Logging to: #{log_file}" unless ontop?
+      options.merge!(options)
+      puts "Starting #{script_name} instances: #{instances_to_start}  Logging to: #{log_file}"
       
-      unless ontop?
+      if not options[:ontop]
         instances_to_start.times do
           safefork do
-            open(pid_file, 'a+') {|f| f << Process.pid << "\n"}
-            at_exit { remove_pid! }
+            add_pid_to_pidfile
 
-      
-            trap('TERM') { callback!(:sig_term) ; self.running = false     }
-            trap('INT')  { callback!(:sig_int)  ; Process.kill('TERM', $$) }
-            trap('HUP')  { callback!(:sig_hup)  ; restart_self             }
+            trap('TERM') { callback!(:sig_term) ; stop;                     }
+            trap('INT')  { callback!(:sig_int)  ; Process.kill('TERM', $$)  }
+            trap('HUP')  { callback!(:sig_hup)  ; restart_self              }
 
             sess_id = Process.setsid
             reopen_filehandes
@@ -208,7 +210,7 @@ module ICanDaemonize
     
     def run_block(&block)
       loop do
-        break unless running?
+        break unless @running
         if options[:timeout]
           begin
             Timeout::timeout(options[:timeout].to_i) do
@@ -216,9 +218,9 @@ module ICanDaemonize
             end
           rescue Timeout::Error => e
             if options[:die_on_timeout]
-              raise TimeoutError.new("#{self} timed out after #{options[:timeout]} seconds while executing block in loop")
+              raise TimeoutError.new("#{self} Timed out after #{options[:timeout]} seconds while executing block in loop")
             else
-              $stderr.puts "#{self} timed out after #{options[:timeout]} seconds while executing block in loop #{e.backtrace.join("\n")}"
+              $stderr.puts "#{self} Timed out after #{options[:timeout]} seconds while executing block in loop #{e.backtrace.join("\n")}"
             end
           end            
         else
@@ -231,18 +233,17 @@ module ICanDaemonize
           sleep 0.1
         end
         break if should_exit?
-        raise DieTime.new('Die if conditions were met!') if should_die?
+        raise DieTime.new("Die if conditions were met!") if should_die?
       end                    
       exit(0)
     end
 
     def should_die?
-      die_if = options[:die_if]
-      if die_if
-        if die_if.is_a?(Symbol) or die_if.is_a?(String)
-          self.send(die_if)
-        elsif die_if.is_a?(Proc)
-          die_if.call
+      if options[:die_if]
+        if options[:die_if].is_a?(Symbol) or options[:die_if].is_a?(String)
+          self.send(options[:die_if])
+        elsif options[:die_if].is_a?(Proc)
+          options[:die_if].call
         end
       else
         false
@@ -250,12 +251,11 @@ module ICanDaemonize
     end
 
     def should_exit?
-      exit_if = options[:exit_if]
-      if exit_if
-        if exit_if.is_a?(Symbol) or exit_if.is_a?(String)
-          self.send(exit_if.to_sym)
-        elsif exit_if.is_a?(Proc)
-          exit_if.call
+      if options[:exit_if]
+        if options[:exit_if].is_a?(Symbol) or options[:exit_if].is_a?(String)
+          self.send(options[:exit_if].to_sym)
+        elsif options[:exit_if].is_a?(Proc)
+          options[:exit_if].call
         end
       else
         false
@@ -263,27 +263,27 @@ module ICanDaemonize
     end
 
     def instances_to_start
-      return 1 if restarted?
-      instances - pids.size      
+      return 1 if @restarted
+      @instances - read_pid_file.size      
     end
 
     def ok_to_start?
-      return false unless running?
-      return true if restarted?
-
+      return false unless @running
+      return true if @restarted
+      pids = read_pid_file
       living_pids = []
       if pids and pids.any?
         pids.each do |pid|
           if process_alive?(pid)                                                 
             living_pids << pid
           else
-            $stderr.puts "Removing stale pid: #{pid}..."
+            $stderr.puts "Removing stale pid: #{pid}"
             pids -= [pid]
-            self.pids = pids
+            rewrite_pidfile(pids)
           end
         end
-        if instances > 0 and living_pids.size >= instances
-          $stderr.puts "#{script_name} is already running #{living_pids.size} out of #{pluralize('instance', instances)}"
+        if @instances > 0 and living_pids.size >= @instances
+          $stderr.puts "#{script_name} is already running #{living_pids.size} out of #{@instances} instances"
           return false          
         end
       end
@@ -291,37 +291,43 @@ module ICanDaemonize
     end
 
     # stop the daemon, nicely at first, and then forcefully if necessary
-    def stop_daemons
-      self.running = false      
-      puts "Stopping #{instances} #{script_name} #{pluarlize('instance', instances)}..."
+    def stop_daemons(number_of_pids_to_stop=0)      
+      @running = false      
+      pids = read_pid_file            
+      number_of_pids_to_stop = pids.size if number_of_pids_to_stop == 0
+      puts "stopping #{number_of_pids_to_stop} pids"
       if pids.empty?
         $stderr.puts "#{script_name} doesn't appear to be running"
         exit
       end
-      pids.each_with_index do |pid, ii|
+      pids.each_with_index do |pid,ii|
         kill_pid(pid)
-        break if ii == (instances - 1)
+        break if ii == (number_of_pids_to_stop - 1)
       end
     end     
 
     def restart_daemons
-      pids.each do |pid|
+      read_pid_file.each do |pid|
         kill_pid(pid, 'HUP')
       end
     end
     
-    def kill_pid(pid, signal='TERM')
-      $stdout.puts("Stopping pid #{pid} with #{signal}...")
+    def stop
+      @running = false
+    end
+    
+    def kill_pid(pid,signal="TERM")
+      $stdout.puts("stopping pid: #{pid} sig: #{signal} #{script_name}...")
       begin
         Process.kill(signal, pid)             
         if pid_running?(pid, options[:timeout] || 120)
-          $stdout.puts("Using kill -9 #{pid}")
+          $stdout.puts("using kill -9 #{pid}")
           Process.kill(9, pid)
         else
-          $stdout.puts("Process #{pid} stopped")
+          $stdout.puts("process #{pid} has stopped")
         end
       rescue Errno::ESRCH
-       $stdout.puts("Couldn't #{signal} #{pid} as it wasn't running")
+       $stdout.puts("couldn't #{signal} #{pid} as it wasn't running")
       end
     end               
     
@@ -343,21 +349,21 @@ module ICanDaemonize
     end
           
     def restart_self
-      remove_pid!
+      remove_self_from_pidfile
       cmd = "#{@@config.script_path}/#{script_name} "
       cmd << 'HUP ' unless ARGV.include?('HUP')
       cmd << ARGV.join(' ')
-      puts "Restarting #{cmd} pid: #{$$}..."
+      puts "restarting #{cmd} pid: #{$$}"
       system(cmd)        
       Process.kill('TERM', $$)
     end
         
     def safefork(&block)
-      fork_tries ||= 0
+      @fork_tries ||= 0
       fork(&block)
     rescue Errno::EWOULDBLOCK
-      raise if fork_tries >= 20
-      fork_tries += 1
+      raise if @fork_tries >= 20
+      @fork_tries += 1
       sleep 5
       retry
     end
@@ -379,9 +385,9 @@ module ICanDaemonize
       if log_prefix?
         def STDOUT.write(string)
           if @no_prefix
-            @no_prefix = false if string[-1, 1] == "\n"
+            @no_prefix = false if string[-1,1] == "\n"
           else
-            string = LOG_FORMAT % [$$, Time.now.strftime(TIME_FORMAT), string]
+            string = LOG_FORMAT % [$$,Time.now.strftime(TIME_FORMAT),string]
             @no_prefix = true              
           end
           super(string)
@@ -389,64 +395,40 @@ module ICanDaemonize
       end
     end
 
-    def remove_pid!(pid=Process.pid)
-      pids.delete(pid)
-      self.pids = pids
+    # create the PID file and install an at_exit handler
+    def add_pid_to_pidfile
+      open(pid_file, 'a+') {|f| f << Process.pid << "\n"}
+      at_exit { remove_self_from_pidfile }
     end
 
-    def pids=(pids)
+    def rewrite_pidfile(pids)
       if pids.any?
         open(pid_file, 'w') {|f| f << pids.join("\n") << "\n"}
       else
-        File.unlink(pid_file) if File.exists?(pid_file)
+        remove_pidfile
       end
-      @pids = pids
-    end
-
-    def pids
-      @pids ||= begin
-        if File.exist?(pid_file)
-          File.readlines(pid_file).collect {|p| p.to_i}
-        else
-          []
-        end
-      end
-    end
-
-    def instances=(num)
-      @instances = num
-    end
-
-    def instances
-      @instances ||= 1
     end
 
-    def pluarlize(name, num)
-      num == 1 ? name : "#{name}s"
+    def remove_self_from_pidfile
+      pids = read_pid_file
+      pids.delete(Process.pid)
+      rewrite_pidfile(pids)
     end
 
-    def running?
-      @running || false
+    def remove_pidfile
+      File.unlink(pid_file) if File.exists?(pid_file)
     end
 
-    def running=(bool)
-      @running = bool
-    end
-
-    def restarted?
-      @restarted || false
-    end
-
-    def restarted=(bool)
-      @restarted = bool
-    end
-
-    def ontop?
-      options[:ontop]
+    def read_pid_file
+      if File.exist?(pid_file)
+        File.readlines(pid_file).collect {|p| p.to_i}
+      else
+        []
+      end
     end
 
     def log_prefix?
-      options[:log_prefix] || true
+      options[:log_prefix]      
     end                    
     
     LOG_PATHS = ['log/', 'logs/', '../log/', '../logs/', '../../log', '../../logs', '.']
@@ -472,7 +454,7 @@ module ICanDaemonize
     end
 
     def script_name
-      @script_name ||= File.basename($0).gsub('.rb', '')
+      @script_name ||= File.basename($0)
     end
 
     def script_name=(script_name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wonko9-i_can_daemonize
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Adam Pisoni
@@ -10,35 +10,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-19 00:00:00 -08:00
+date: 2009-01-15 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: ICanDaemonize makes it dead simple to create daemons of your own
-email: wonko9@gmail.com
+description: Better daemonizer.
+email: apisoni@yammer-inc.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
-files: 
+extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- Rakefile
 - README.txt
-- lib/i_can_daemonize
-- lib/i_can_daemonize/version.rb
+files: 
+- History.txt
+- README.txt
+- Rakefile
+- i_can_daemonize.gemspec
 - lib/i_can_daemonize.rb
-- test/simple_daemon.rb
-- test/test_helper.rb
-- test/test_i_can_daemonize.rb
+- lib/i_can_daemonize/version.rb
+- examples/feature_demo.rb
+- examples/rails_daemon.rb
+- examples/simple_daemon.rb
+- examples/starling_queue_daemon.rb
+- Manifest.txt
 has_rdoc: true
 homepage: http://github.com/wonko9/i_can_daemonize
 post_install_message: 
 rdoc_options: 
-- --inline-source
-- --charset=UTF-8
+- --main
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -59,6 +62,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: ICanDaemonize makes it dead simple to create daemons of your own
-test_files: []
-
+summary: Better way to build daemons
+test_files: 
+- test/test_i_can_daemonize.rb

data/test/simple_daemon.rb

@@ -1,26 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-require File.dirname(__FILE__) + '/../lib/i_can_daemonize'
-
-class SimpleDaemon
-  include ICanDaemonize
-
-  arg '--test=VALUE', 'Test Arg' do |value|
-    @test = value
-  end
-
-  arg '-s', '--short-test=VALUE', 'Test arg with shortname' do |value|
-    @short_test = value
-  end
-
-  counter = 0
-  daemonize do
-    if @options[:loop_every]
-      counter += 1
-      File.open(TEST_FILE, 'w'){|f| f << counter}
-    elsif @test
-      File.open(TEST_FILE, 'w'){|f| f << "#{@test}|#{@short_test}"}
-    else
-      File.open(TEST_FILE, 'w'){|f| f << "#{log_file}|#{pid_file}"}
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,14 +0,0 @@
-require 'test/unit'
-require 'pp'
-
-TEST_FILE = File.dirname(__FILE__) + '/test.txt' unless defined?(TEST_FILE)
-
-unless Test::Unit::TestCase.respond_to?(:test)
-  class << Test::Unit::TestCase
-    def test(name, &block)
-      test_name = "test_#{name.gsub(/[\s\W]/,'_')}"
-      raise ArgumentError, "#{test_name} is already defined" if self.instance_methods.include? test_name
-      define_method test_name, &block
-    end
-  end
-end