daemons 0.4.3 → 0.4.4

data/README

@@ -1,4 +1,4 @@
-= Daemons Version 0.4.3
+= Daemons Version 0.4.4
 
 (See Releases for release-specific information)
 
@@ -19,7 +19,7 @@ process.
 
 == Basic Usage
 
-You can use Daemons in three differet ways:
+You can use Daemons in four differet ways:
 
 === 1. Create wrapper scripts for your server scripts or applications
 
@@ -62,8 +62,45 @@ should be daemonized by seperating them by two _hyphens_:
   
   $ ruby myserver_control.rb start -- --file=anyfile --a_switch another_argument
   
+
+=== 2. Create wrapper scripts that include your server procs
+
+Layout: suppose you have some code you want to run in the background and control that background process
+from a script:
+
+  # this is your code
+  # it does nothing really useful at the moment
+  
+  loop do
+    sleep(5)
+  end
+  
+To run this code as a daemon create <tt>myproc_control.rb</tt> like this and include your code:
+
+  # this is myproc_control.rb
+  
+  require 'rubygems'        # if you use RubyGems
+  require 'daemons'
+  
+  Daemons.run_proc('myproc.rb') do
+    loop do
+      sleep(5)
+    end
+  end
+  
+And use it like this from the console:
+
+  $ ruby myproc_control.rb start
+      (myproc.rb is now running in the background)
+  $ ruby myproc_control.rb restart
+      (...)
+  $ ruby myproc_control.rb stop
+  
+For testing purposes you can even run <tt>myproc.rb</tt> <i>without forking</i> in the background:
+
+  $ ruby myproc_control.rb run
   
-=== 2. Control a bunch of daemons from another application
+=== 3. Control a bunch of daemons from another application
 
 Layout: you have an application <tt>my_app.rb</tt> that wants to run a bunch of 
 server tasks as daemon processes.
@@ -98,7 +135,7 @@ server tasks as daemon processes.
   
   exit
   
-=== 3. Daemonize the currently running process
+=== 4. Daemonize the currently running process
 
 Layout: you have an application <tt>my_daemon.rb</tt> that wants to run as a daemon
 (but without the ability to be controlled by daemons via start/stop commands)

data/Releases

@@ -1,5 +1,13 @@
 = Daemons Release History
 
+== Release 0.4.4: February 14, 2006
+
+* Several fixes that allow us to use the Daemons::Controller 
+  with a proc instead of wrapping a script file. This gives us all the
+  PID file management, monitoring, command line options, etc. without having
+  to specify a path to our script which can be tricky, especially when using
+  RubyGems. (thanks to John-Mason Shackelford)
+
 == Release 0.4.3: November 29, 2005
 
 * New Option: You can specify the name of the application with :app_name

data/examples/run/ctrl_proc.rb

@@ -0,0 +1,25 @@
+lib_dir = File.expand_path(File.join(File.split(__FILE__)[0], '../../lib'))
+
+if File.exists?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  require 'rubygems' rescue nil
+end
+
+require 'daemons'
+
+
+options = {
+             :multiple   => false,
+             :ontop      => false,
+             :backtrace  => true,
+             :log_output => true,
+             :monitor    => true
+           }
+           
+Daemons.run_proc('ctrl_proc.rb', options) do
+  loop do
+    puts 'ping from proc!'
+    sleep(3)
+  end
+end

data/lib/daemons.rb

@@ -15,19 +15,25 @@ require 'daemons/controller'
 
 # All functions and classes that Daemons provides reside in this module.
 #
-# Daemons is normally invoked by on of the following three ways:
+# Daemons is normally invoked by one of the following four ways:
 #
 # 1.  <tt>Daemons.run(script, options)</tt>:
 #     This is used in wrapper-scripts that are supposed to control other ruby scripts or
 #     external applications. Control is completely passed to the daemons library.
-#     Such wrapper script should be invoked with command line options like 'start' or 'stop'
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
 #     to do anything useful.
 #
-# 2.  <tt>Daemons.call(options) { block }</tt>:
+# 2.  <tt>Daemons.run_proc(app_name, options) { (...) }</tt>:
+#     This is used in wrapper-scripts that are supposed to control a proc. 
+#     Control is completely passed to the daemons library.
+#     Such wrapper script need to be invoked with command line options like 'start' or 'stop'
+#     to do anything useful.
+#
+# 3.  <tt>Daemons.call(options) { block }</tt>:
 #     Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
 #     after spawning the daemon with the new Application object as a return value.
 #
-# 3.  <tt>Daemons.daemonize(options)</tt>:
+# 4.  <tt>Daemons.daemonize(options)</tt>:
 #     Daemonize the currently runnig process, i.e. the calling process will become a daemon.
 #
 # == What does daemons internally do with my daemons?
@@ -59,7 +65,7 @@ require 'daemons/controller'
 #
 module Daemons
 
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
   
   require 'daemons/daemonize'
   
@@ -120,8 +126,6 @@ module Daemons
     options[:script] = script
     @controller = Controller.new(options, ARGV)
     
-    #pp @controller
-    
     @controller.catch_exceptions {
       @controller.run
     }
@@ -132,6 +136,54 @@ module Daemons
   module_function :run
   
   
+  # Passes control to Daemons.
+  # This function does the same as Daemons.run except that not a script but a proc
+  # will be run as a daemon while this script provides command line options like 'start' or 'stop'
+  # and the whole pid-file management to control the proc.
+  #
+  # +app_name+::  The name of the application. This will be
+  #               used to contruct the name of the pid files
+  #               and log files. Defaults to the basename of
+  #               the script.
+  # 
+  # +options+::   A hash that may contain one or more of the options listed in the documentation for Daemons.run
+  #
+  # A block must be given to this function. The block will be used as the :proc entry in the options hash.
+  # -----
+  # 
+  # === Example:
+  #
+  #   Daemons.run_proc('myproc.rb') do
+  #     loop do
+  #       accept_connection()
+  #       read_request()
+  #       send_response()
+  #       close_connection()
+  #     end
+  #   end
+  #
+  def run_proc(app_name, options = {}, &block)
+    options[:app_name] = app_name
+    options[:mode] = :proc
+    options[:proc] = block
+    
+    if [nil, :script].include? options[:dir_mode]
+      options[:dir_mode] = :normal
+      options[:dir] = File.split(__FILE__)[0]
+    end
+    
+    @controller = Controller.new(options, ARGV)
+    
+    @controller.catch_exceptions {
+      @controller.run
+    }
+    
+    # I don't think anybody will ever use @group, as this location should not be reached under non-error conditions
+    @group = @controller.group
+  end
+  module_function :run_proc
+  
+  
   # Execute the block in a new daemon. <tt>Daemons.call</tt> will return immediately
   # after spawning the daemon with the new Application object as a return value.
   #
@@ -205,8 +257,6 @@ module Daemons
   #   }
   #
   def daemonize(options = {})
-    #Daemonize::daemonize
-    
     @group ||= ApplicationGroup.new('self', options)
     
     @group.new_application(:mode => :none).start

data/lib/daemons/application_group.rb

@@ -50,9 +50,7 @@ module Daemons
     # all running instances of the application and populates the application array.
     #
     def setup
-      if script
-        @applications = find_applications(pidfile_dir())
-      end
+      @applications = find_applications(pidfile_dir())
     end
     
     def pidfile_dir

data/lib/daemons/controller.rb

@@ -32,6 +32,8 @@ module Daemons
         @app_name ||= File.split(@script)[1]
       end
     
+      @app_name = options[:app_name] if options[:app_name]
+      
       @command, @controller_part, @app_part = Controller.split_argv(argv)
     
       #@options[:dir_mode] ||= :script

data/lib/daemons/pid.rb

@@ -18,7 +18,8 @@ module Daemons
     # If no valid directory is found, returns nil.
     #
     def Pid.dir(dir_mode, dir, script)
-      return nil unless script
+      # nil script parameter is allowed so long as dir_mode is not :script
+      return nil if dir_mode == :script && script.nil?                         
       
       case dir_mode
         when :normal

metadata

@@ -1,10 +1,10 @@
-!ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification 
 rubygems_version: 0.8.11
 specification_version: 1
 name: daemons
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
-date: 2005-11-29 00:00:00 +01:00
+  version: 0.4.4
+date: 2006-04-07 00:00:00 +02:00
 summary: A toolkit to create and control daemons in different ways
 require_paths: 
 - lib
@@ -56,10 +56,13 @@ files:
 - examples/run/ctrl_exit.rb
 - examples/run/ctrl_multiple.rb
 - examples/run/myserver_crashing.rb.output
+- examples/run/ctrl_proc.output
 - examples/run/ctrl_normal.rb
 - examples/run/ctrl_monitor.rb
 - examples/run/myserver.rb
 - examples/run/myserver_crashing.rb
+- examples/run/ctrl_proc.rb
+- examples/run/ctrl_proc.rb.output
 - examples/run/ctrl_ontop.rb
 - examples/run/myserver_exiting.rb
 - examples/run/ctrl_crash.rb