daemons 1.1.9 → 1.4.1

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.
@@ -50,7 +47,7 @@ require 'timeout'
 #     the potential of acquiring a controlling terminal.
 # 4.  Changes the current working directory to "/".
 # 5.  Clears the file creation mask (sets +umask+ to 0000).
-# 6.  Closes file descriptors (reopens +STDOUT+ and +STDERR+ to point to a logfile if
+# 6.  Closes file descriptors (reopens +$stdout+ and +$stderr+ to point to a logfile if
 #     possible).
 #
 # So what does this mean for your daemons:
@@ -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,54 @@ 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>:pid_delimiter</tt>:: Specifies the separator used when enumerating multiple process names/pid-files. Default is '_num'.
+  # <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>:shush</tt>::     When given (i.e. set to true), turn on silent mode (no output to the terminal)
   # <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>:monitor_interval</tt>:: Interval in sesconds at which to check whether the instances are still running
   # <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>:log_output_syslog</tt>:: When set to true, redirect output into SYSLOG instead of the file. This overrides log_output setting.
   # <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,
+  #     :pid_delimiter      => '.n',
+  #     :ontop              => true,
+  #     :shush              => false,
+  #     :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 +145,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 +164,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 +186,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 +216,13 @@ 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>:monitor</tt>::   Monitor the programs and restart crashed instances
+  # <tt>:monitor_interval</tt>:: Interval in sesconds at which to check whether the instances are still running
+  # <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",
@@ -237,49 +240,52 @@ module Daemons
   #   end
   #
   def call(options = {}, &block)
-    unless block_given?
-      raise "Daemons.call: no block given"
-    end
-    
-    options[:proc] = block
-    options[:mode] = :proc
-    
+    new_app = Daemons.new(options, &block)
+    new_app.start
+    new_app
+  end
+  module_function :call
+
+  # Create a new Daemon application, like <tt>Daemons.call</tt>, but will not start it automatically
+  def new(options = {}, &block)
+    fail 'Daemons.call: no block given' unless block_given?
+
     options[:app_name] ||= 'proc'
-    
+    options[:proc] = Proc.new(&block)
+    options[:mode] = :proc
+    options[:dir_mode] = :normal
+
     @group ||= ApplicationGroup.new(options[:app_name], options)
-    
-    new_app = @group.new_application(options)
-    new_app.start
 
-    return new_app
+    @group.new_application(options)
   end
-  module_function :call
-  
-  
+  module_function :new
+
   # 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)
   # <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>:log_output</tt>:: When given (i.e. set to true), redirect both $stdout and $stdout to a logfile named '[app_name].output' in the pid-file directory
+  # <tt>:log_output_syslog</tt>:: When set to true, redirect output into SYSLOG instead of the file. This overrides log_output setting.
   # -----
-  # 
+  #
   # === Example:
   #   options = {
   #     :backtrace  => true,
@@ -298,18 +304,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

metadata

@@ -1,56 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: daemons
 version: !ruby/object:Gem::Version
-  version: 1.1.9
-  prerelease: 
+  version: 1.4.1
 platform: ruby
 authors:
 - Thomas Uehlinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
-dependencies: []
-description: Daemons provides an easy way to wrap existing ruby scripts (for example
-  a self-written server)  to be run as a daemon and to be controlled by simple start/stop/restart
-  commands.  You can also call blocks as daemons and control them from the parent
-  or just daemonize the current process.  Besides this basic functionality, daemons
-  offers many advanced features like exception  backtracing and logging (in case your
-  ruby script crashes) and monitoring and automatic restarting of your processes if
-  they crash.
-email: th.uehlinger@gmx.ch
+date: 2021-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Daemons provides an easy way to wrap existing ruby scripts (for example a
+      self-written server)  to be run as a daemon and to be controlled by simple
+      start/stop/restart commands.
+
+      You can also call blocks as daemons and control them from the parent or just
+      daemonize the current process.
+
+      Besides this basic functionality, daemons offers many advanced features like
+      exception backtracing and logging (in case your ruby script crashes) and
+      monitoring and automatic restarting of your processes if they crash.
+email: thomas.uehinger@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- Releases
-- TODO
+extra_rdoc_files: []
 files:
-- Rakefile
-- Releases
-- TODO
-- README
 - LICENSE
-- setup.rb
-- lib/daemons.rb
-- lib/daemons/application.rb
-- lib/daemons/application_group.rb
-- lib/daemons/change_privilege.rb
-- lib/daemons/cmdline.rb
-- lib/daemons/controller.rb
-- lib/daemons/daemonize.rb
-- lib/daemons/etc_extension.rb
-- lib/daemons/exceptions.rb
-- lib/daemons/monitor.rb
-- lib/daemons/pid.rb
-- lib/daemons/pidfile.rb
-- lib/daemons/pidmem.rb
+- README.md
+- Releases
+- examples/call/call.rb
+- examples/call/call_monitor.rb
+- examples/daemonize/daemonize.rb
 - examples/run/ctrl_crash.rb
+- examples/run/ctrl_custom_logfiles.rb
 - examples/run/ctrl_exec.rb
 - examples/run/ctrl_exit.rb
 - examples/run/ctrl_hanging.rb
 - examples/run/ctrl_keep_pid_files.rb
 - examples/run/ctrl_monitor.rb
+- examples/run/ctrl_monitor_multiple.rb
+- examples/run/ctrl_monitor_nocrash.rb
 - examples/run/ctrl_multiple.rb
 - examples/run/ctrl_normal.rb
 - examples/run/ctrl_ontop.rb
@@ -65,31 +117,44 @@ files:
 - examples/run/myserver_exiting.rb
 - examples/run/myserver_hanging.rb
 - examples/run/myserver_slowstop.rb
-- examples/call/call.rb
-- examples/call/call_monitor.rb
-- examples/daemonize/daemonize.rb
-homepage: http://daemons.rubyforge.org
-licenses: []
+- lib/daemons.rb
+- lib/daemons/application.rb
+- lib/daemons/application_group.rb
+- lib/daemons/change_privilege.rb
+- lib/daemons/cmdline.rb
+- lib/daemons/controller.rb
+- lib/daemons/daemonize.rb
+- lib/daemons/etc_extension.rb
+- lib/daemons/exceptions.rb
+- lib/daemons/monitor.rb
+- lib/daemons/pid.rb
+- lib/daemons/pidfile.rb
+- lib/daemons/pidmem.rb
+- lib/daemons/reporter.rb
+- lib/daemons/syslogio.rb
+- lib/daemons/version.rb
+homepage: https://github.com/thuehlinger/daemons
+licenses:
+- MIT
+metadata:
+  documentation_uri: http://www.rubydoc.info/gems/daemons
 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: daemons
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 2
+specification_version: 4
 summary: A toolkit to create and control daemons in different ways
 test_files: []