daemons 1.1.9 → 1.2.1

data/examples/run/ctrl_monitor.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
   :monitor => true
 }

data/examples/run/ctrl_monitor_multiple.rb

@@ -0,0 +1,17 @@
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../../lib'))
+
+if File.exist?(File.join(lib_dir, 'daemons.rb'))
+  $LOAD_PATH.unshift lib_dir
+else
+  begin; require 'rubygems'; rescue ::Exception; end
+end
+
+require 'daemons'
+
+options = {
+  :multiple => true,
+  :monitor => true,
+  :log_output => true,
+}
+
+Daemons.run(File.join(File.dirname(__FILE__), 'myserver_crashing.rb'), options)

data/examples/run/ctrl_multiple.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
   :multiple => true
 }

data/examples/run/ctrl_ontop.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-
 options = {
   :ontop => true
 }

data/examples/run/ctrl_optionparser.rb

@@ -11,7 +11,6 @@ require 'optparse'
 require 'logger'
 require 'ostruct'
 
-
 class MyApp < Logger::Application
   def initialize(args)
     super(self.class)
@@ -19,15 +18,15 @@ class MyApp < Logger::Application
     opts = OptionParser.new do |opts|
       opts.banner = 'Usage: myapp [options]'
       opts.separator ''
-      opts.on('-N','--no-daemonize',"Don't run as a daemon") do
+      opts.on('-N', '--no-daemonize', "Don't run as a daemon") do
         @options.daemonize = false
       end
     end
     @args = opts.parse!(args)
   end
-  
+
   def run
-    Daemons.run_proc('myapp',{:ARGV => @args, :ontop => !@options.daemonize}) do
+    Daemons.run_proc('myapp', :ARGV => @args, :ontop => !@options.daemonize) do
       puts "@options.daemonize: #{@options.daemonize}"
       STDOUT.sync = true
       loop do
@@ -38,6 +37,5 @@ class MyApp < Logger::Application
   end
 end
 
-
 myapp = MyApp.new(ARGV)
-myapp.run
+myapp.run

data/examples/run/ctrl_proc.rb

@@ -8,18 +8,17 @@ end
 
 require 'daemons'
 
-
 options = {
-             :multiple   => false,
-             :ontop      => false,
-             :backtrace  => true,
-             :log_output => true,
-             :monitor    => true
-           }
-           
+  :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
+end

data/examples/run/ctrl_proc_multiple.rb

@@ -8,15 +8,13 @@ end
 
 require 'daemons'
 
-
 options = {
   :log_output => true,
-  :multiple => true, 
+  :multiple => true,
 }
 
-
 Daemons.run_proc('ctrl_proc_multiple.rb', options) do
-  puts "hello"
+  puts 'hello'
   sleep(5)
-  puts "done"
-end
+  puts 'done'
+end

data/examples/run/ctrl_proc_rand.rb

@@ -6,10 +6,8 @@ else
   begin; require 'rubygems'; rescue ::Exception; end
 end
 
-
 require 'daemons'
 
-
 Daemons.run_proc('myscript') do
   loop do
     file = File.open('/tmp/myscript.log', 'a')
@@ -17,7 +15,7 @@ Daemons.run_proc('myscript') do
     # file.write(Random.new.rand)  # works without seeding
     # file.write(rand) # also works, but this is Kernel.rand() so its different
     file.write("\n")
-    file.close()
+    file.close
     sleep 2
   end
-end
+end

data/examples/run/ctrl_proc_simple.rb

@@ -8,7 +8,6 @@ end
 
 require 'daemons'
 
-           
 Daemons.run_proc('ctrl_proc_simple.rb') do
   loop do
     puts 'ping from proc!'

data/examples/run/myserver.rb

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-
 # This is myserver.rb, an example server that is to be controlled by daemons
 # and that does nothing really useful at the moment.
 #

data/examples/run/myserver_crashing.rb

@@ -5,10 +5,10 @@
 
 loop do
   puts 'ping from myserver.rb!'
-  puts 'this example server will crash in 3 seconds...'
-  
-  sleep(3)
-  
+  puts 'this example server will crash in 10 seconds...'
+
+  sleep(10)
+
   puts 'CRASH!'
-  raise 'CRASH!'
+  fail 'CRASH!'
 end

data/examples/run/myserver_exiting.rb

@@ -1,8 +1,8 @@
 loop do
   puts 'ping from myserver.rb!'
   puts 'this example server will exit in 3 seconds...'
-  
+
   sleep(3)
-  
+
   Process.exit
 end

data/examples/run/myserver_hanging.rb

@@ -1,19 +1,18 @@
 #!/usr/bin/env ruby
 
-
 # This is myserver.rb, an example server that is to be controlled by daemons
 # and that does nothing really useful at the moment.
 #
 # Don't run this script by yourself, it can be controlled by the ctrl*.rb scripts.
 
-trap('TERM') {
-  puts "received TERM"
-  
+trap('TERM') do
+  puts 'received TERM'
+
   loop do
     puts 'hanging!'
     sleep(3)
   end
-}
+end
 
 loop do
   puts 'ping from myserver.rb!'

data/examples/run/myserver_slowstop.rb

@@ -1,19 +1,18 @@
 #!/usr/bin/env ruby
 
-
 # This is myserver_slowstop.rb, an example server that is to be controlled by daemons
 # and that does nothing really useful at the moment.
 #
 # Don't run this script by yourself, it can be controlled by the ctrl*.rb scripts.
 
-trap('TERM') {
-  puts "received TERM"
-  
+trap('TERM') do
+  puts 'received TERM'
+
   # simulate the slow stopping
   sleep(10)
-  
+
   exit
-}
+end
 
 loop do
   puts 'ping from myserver.rb!'

data/lib/daemons.rb

@@ -1,19 +1,16 @@
 require 'optparse'
 require 'optparse/time'
 
-
-require 'daemons/pidfile'  
+require 'daemons/version'
+require 'daemons/pidfile'
 require 'daemons/cmdline'
 require 'daemons/exceptions'
 require 'daemons/monitor'
 
-
 require 'daemons/application'
 require 'daemons/application_group'
 require 'daemons/controller'
 
-require 'timeout'
-
 # All functions and classes that Daemons provides reside in this module.
 #
 # Daemons is normally invoked by one of the following four ways:
@@ -25,7 +22,7 @@ require 'timeout'
 #     to do anything useful.
 #
 # 2.  <tt>Daemons.run_proc(app_name, options) { (...) }</tt>:
-#     This is used in wrapper-scripts that are supposed to control a proc. 
+#     This is used in wrapper-scripts that are supposed to control a proc.
 #     Control is completely passed to the daemons library.
 #     Such wrapper scripts need to be invoked with command line options like 'start' or 'stop'
 #     to do anything useful.
@@ -65,12 +62,8 @@ require 'timeout'
 # called <i>PidFiles</i> are stored.
 #
 module Daemons
-
-  VERSION = "1.1.9"
-  
   require 'daemons/daemonize'
-  
-  
+
   # Passes control to Daemons.
   # 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.
@@ -82,7 +75,7 @@ module Daemons
   #             Also note that Daemons cannot detect the directory in which the controlling
   #             script resides, so this has to be either an absolute path or you have to run
   #             the controlling script from the appropriate directory. Your script name should not
-  #             end with _monitor because that name is reserved for a monitor process which is 
+  #             end with _monitor because that name is reserved for a monitor process which is
   #             there to restart your daemon if it crashes.
   #
   # +options+:: A hash that may contain one or more of the options listed below
@@ -97,44 +90,48 @@ module Daemons
   #                       These are assumed to be separated by an array element '--', .e.g.
   #                       ['start', 'f', '--', 'param1_for_script', 'param2_for_script'].
   #                       If not given, ARGV (the parameters given to the Ruby process) will be used.
-  # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing the pid files to 
+  # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing the pid files to
   #                       given by <tt>:dir</tt> is interpreted relative
-  #                       to the script location given by +script+, the default) or <tt>:normal</tt> (the directory given by 
-  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt> 
+  #                       to the script location given by +script+, the default) or <tt>:normal</tt> (the directory given by
+  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt>
   #                       (<tt>/var/run</tt> is used as the pid file directory)
   #
   # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
   # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
   #                       same time
-  # <tt>:ontop</tt>::     When given (i.e. set to true), stay on top, i.e. do not daemonize the application 
+  # <tt>:ontop</tt>::     When given (i.e. set to true), stay on top, i.e. do not daemonize the application
   #                       (but the pid-file and other things are written as usual)
   # <tt>:mode</tt>::      <tt>:load</tt> Load the script with <tt>Kernel.load</tt>;
   #                       note that :stop_proc only works for the :load (and :proc) mode.
   #                       <tt>:exec</tt> Execute the script file with <tt>Kernel.exec</tt>
-  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the
   #                       pid-file directory if the application exits due to an uncaught exception
   # <tt>:monitor</tt>::   Monitor the programs and restart crashed instances
   # <tt>:log_dir</tt>::   A specific directory to put the log files into (when not given, resort to the default
   #                       location as derived from the :dir_mode and :dir options
-  # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile named '[app_name].output' in the pid-file directory
+  # <tt>:logfilename</tt>:: Specifiy a custom log file name
+  # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile named '[app_name].output' (or as given in :output_logfilename) in the pid-file directory
+  # <tt>:output_logfilename</tt>:: Specifiy a custom output redirection file name
   # <tt>:keep_pid_files</tt>:: When given do not delete lingering pid-files (files for which the process is no longer running).
   # <tt>:hard_exit</tt>:: When given use exit! to end a daemons instead of exit (this will for example
   #                       not call at_exit handlers).
   # <tt>:stop_proc</tt>:: A proc that will be called when the daemonized process receives a request to stop (works only for :load and :proc mode)
   #
   # -----
-  # 
+  #
   # === Example:
   #   options = {
-  #     :app_name   => "my_app",
-  #     :ARGV       => ['start', '-f', '--', 'param_for_myscript']
-  #     :dir_mode   => :script,
-  #     :dir        => 'pids',
-  #     :multiple   => true,
-  #     :ontop      => true,
-  #     :mode       => :exec,
-  #     :backtrace  => true,
-  #     :monitor    => true
+  #     :app_name           => "my_app",
+  #     :ARGV               => ['start', '-f', '--', 'param_for_myscript']
+  #     :dir_mode           => :script,
+  #     :dir                => 'pids',
+  #     :multiple           => true,
+  #     :ontop              => true,
+  #     :mode               => :exec,
+  #     :backtrace          => true,
+  #     :monitor            => true,
+  #     :logfilename        => 'custom_logfile.log',
+  #     :output_logfilename => 'custom_outputfile.txt'
   #   }
   #
   #   Daemons.run(File.join(File.dirname(__FILE__), 'myscript.rb'), options)
@@ -142,17 +139,16 @@ module Daemons
   def run(script, options = {})
     options[:script] = script
     @controller = Controller.new(options, options[:ARGV] || ARGV)
-    
-    @controller.catch_exceptions {
+
+    @controller.catch_exceptions do
       @controller.run
-    }
-    
+    end
+
     # 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
-  
-  
+
   # 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'
@@ -162,13 +158,13 @@ module Daemons
   #               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
@@ -184,25 +180,24 @@ module Daemons
     options[:app_name] = app_name
     options[:mode] = :proc
     options[:proc] = block
-    
+
     # we do not have a script location so the the :script :dir_mode cannot be used, change it to :normal
     if [nil, :script].include? options[:dir_mode]
       options[:dir_mode] = :normal
       options[:dir] ||= File.expand_path('.')
     end
-    
+
     @controller = Controller.new(options, options[:ARGV] || ARGV)
-    
-    @controller.catch_exceptions {
+
+    @controller.catch_exceptions do
       @controller.run
-    }
-    
+    end
+
     # 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.
   #
@@ -215,11 +210,11 @@ module Daemons
   # === Options:
   # <tt>:multiple</tt>::  Specifies whether multiple instances of the same script are allowed to run at the
   #                       same time
-  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
-  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the
   #                       pid-file directory if the application exits due to an uncaught exception
   # -----
-  # 
+  #
   # === Example:
   #   options = {
   #     :app_name   => "myproc",
@@ -238,40 +233,39 @@ module Daemons
   #
   def call(options = {}, &block)
     unless block_given?
-      raise "Daemons.call: no block given"
+      fail 'Daemons.call: no block given'
     end
-    
+
     options[:proc] = block
     options[:mode] = :proc
-    
+
     options[:app_name] ||= 'proc'
-    
+
     @group ||= ApplicationGroup.new(options[:app_name], options)
-    
+
     new_app = @group.new_application(options)
     new_app.start
 
-    return new_app
+    new_app
   end
   module_function :call
-  
-  
+
   # Daemonize the currently runnig process, i.e. the calling process will become a daemon.
   #
   # +options+:: A hash that may contain one or more of the options listed below
   #
   # === Options:
-  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application 
-  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the 
+  # <tt>:ontop</tt>::     When given, stay on top, i.e. do not daemonize the application
+  # <tt>:backtrace</tt>:: Write a backtrace of the last exceptions to the file '[app_name].log' in the
   #                       pid-file directory if the application exits due to an uncaught exception
   # <tt>:app_name</tt>::  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.
-  # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing files to 
+  # <tt>:dir_mode</tt>::  Either <tt>:script</tt> (the directory for writing files to
   #                       given by <tt>:dir</tt> is interpreted relative
-  #                       to the script location given by +script+, the default) or <tt>:normal</tt> (the directory given by 
-  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt> 
+  #                       to the script location given by +script+, the default) or <tt>:normal</tt> (the directory given by
+  #                       <tt>:dir</tt> is interpreted as a (absolute or relative) path) or <tt>:system</tt>
   #                       (<tt>/var/run</tt> is used as the file directory)
   #
   # <tt>:dir</tt>::       Used in combination with <tt>:dir_mode</tt> (description above)
@@ -279,7 +273,7 @@ module Daemons
   #                       location as derived from the :dir_mode and :dir options
   # <tt>:log_output</tt>:: When given (i.e. set to true), redirect both STDOUT and STDERR to a logfile named '[app_name].output' in the pid-file directory
   # -----
-  # 
+  #
   # === Example:
   #   options = {
   #     :backtrace  => true,
@@ -298,18 +292,22 @@ module Daemons
   #
   def daemonize(options = {})
     options[:script] ||= File.basename(__FILE__)
-    
+
     @group ||= ApplicationGroup.new(options[:app_name] || options[:script], options)
-    
+
     @group.new_application(:mode => :none).start
   end
   module_function :daemonize
-  
+
   # Return the internal ApplicationGroup instance.
-  def group; @group; end
+  def group
+    @group
+  end
   module_function :group
-  
+
   # Return the internal Controller instance.
-  def controller; @controller; end
+  def controller
+    @controller
+  end
   module_function :controller
-end 
+end