mwotton-daemons 1.0.11

data/LICENSE

@@ -0,0 +1,29 @@
+Copyright (c) 2005-2007 Thomas Uehlinger
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+This license does not apply to daemonize.rb, which is was written by 
+Travis Whitton und published under the following license:
+
+The Daemonize extension module is copywrited free software by Travis Whitton
+<whitton@atlantic.net>. You can redistribute it under the terms specified in
+the COPYING file of the Ruby distribution.

data/README

@@ -0,0 +1,223 @@
+= Daemons Version 1.0.11
+
+(See Releases for release-specific information)
+
+== What is Daemons?
+
+Daemons provides an easy way to wrap existing ruby scripts (for example a self-written server) 
+to be <i>run as a daemon</i> and to be <i>controlled by simple start/stop/restart commands</i>.
+
+If you want, you can also use daemons to <i>run blocks of ruby code in a daemon process</i> and to control
+these processes from the main application.
+
+Besides this basic functionality, daemons offers many advanced features like <i>exception backtracing</i> 
+and logging (in case your ruby script crashes) and <i>monitoring</i> and automatic restarting of your processes
+if they crash.
+
+Daemons includes the <tt>daemonize.rb</tt> script written by <i>Travis Whitton</i> to do the daemonization
+process.
+
+== Basic Usage
+
+You can use Daemons in four differet ways:
+
+=== 1. Create wrapper scripts for your server scripts or applications
+
+Layout: suppose you have your self-written server <tt>myserver.rb</tt>:
+
+  # this is myserver.rb
+  # it does nothing really useful at the moment
+  
+  loop do
+    sleep(5)
+  end
+  
+To use <tt>myserver.rb</tt> in a production environment, you need to be able to
+run <tt>myserver.rb</tt> in the _background_ (this means detach it from the console, fork it
+in the background, release all directories and file descriptors).
+
+Just create <tt>myserver_control.rb</tt> like this:
+
+  # this is myserver_control.rb
+  
+  require 'rubygems'        # if you use RubyGems
+  require 'daemons'
+  
+  Daemons.run('myserver.rb')
+  
+And use it like this from the console:
+
+  $ ruby myserver_control.rb start
+      (myserver.rb is now running in the background)
+  $ ruby myserver_control.rb restart
+      (...)
+  $ ruby myserver_control.rb stop
+  
+For testing purposes you can even run <tt>myserver.rb</tt> <i>without forking</i> in the background:
+
+  $ ruby myserver_control.rb run
+
+An additional nice feature of Daemons is that you can pass <i>additional arguments</i> to the script that 
+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
+  
+=== 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.
+
+  # this is my_app.rb
+  
+  require 'rubygems'        # if you use RubyGems
+  require 'daemons'
+  
+  task1 = Daemons.call(:multiple => true) do
+    # first server task
+    
+    loop {
+      conn = accept_conn()
+      serve(conn)
+    }
+  end
+  
+  task2 = Daemons.call do
+    # second server task
+    
+    loop {
+      something_different()
+    }
+  end
+  
+  # the parent process continues to run
+  
+  # we can even control our tasks, for example stop them
+  task1.stop
+  task2.stop
+  
+  exit
+  
+=== 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)
+
+  # this is my_daemons.rb
+  
+  require 'rubygems'        # if you use RubyGems
+  require 'daemons'
+  
+  # Initialize the app while we're not a daemon
+  init()
+  
+  # Become a daemon
+  Daemons.daemonize
+  
+  # The server loop
+  loop {
+    conn = accept_conn()
+    serve(conn)
+  }
+
+  
+<b>For further documentation, refer to the module documentation of Daemons.</b>
+
+  
+== Download and Installation
+
+*Download*: just go to http://rubyforge.org/projects/daemons/
+
+Installation *with* RubyGems:
+  $ su
+  # gem install daemons
+  
+Installation *without* RubyGems:
+  $ tar xfz daemons-x.x.x.tar.gz
+  $ cd daemons-x.x.x
+  $ su
+  # ruby setup.rb
+  
+== Documentation
+
+For further documentation, refer to the module documentation of Daemons (click on Daemons).
+
+The RDoc documentation is also online at http://daemons.rubyforge.org
+
+
+== Author
+
+Written in 2005-2008 by Thomas Uehlinger <mailto:th.uehlinger@gmx.ch>.
+
+== License
+
+Copyright (c) 2005-2008 Thomas Uehlinger
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+This license does not apply to daemonize.rb, which is was written by 
+Travis Whitton und published under the following license:
+
+The Daemonize extension module is copywrited free software by Travis Whitton
+<whitton@atlantic.net>. You can redistribute it under the terms specified in
+the COPYING file of the Ruby distribution.
+
+== Feedback and other resources
+
+At http://rubyforge.org/projects/daemons.

data/Rakefile

@@ -0,0 +1,88 @@
+require 'rubygems'
+Gem::manage_gems
+
+require 'rake/gempackagetask'
+#require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+
+$LOAD_PATH << './lib'
+require 'daemons'
+
+
+PKG_NAME = "daemons"
+
+PKG_FILES = FileList[
+  "Rakefile", "Releases", "TODO", "README", "LICENSE",
+  "setup.rb",
+  "lib/**/*.rb",
+  #"test/**/*",
+  "examples/**/*"
+]
+#PKG_FILES.exclude(%r(^test/tmp/.+))
+PKG_FILES.exclude(%r(\.pid$))
+PKG_FILES.exclude(%r(\.log$))
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = Daemons::VERSION
+  s.author = "Thomas Uehlinger"
+  s.email = "th.uehlinger@gmx.ch"
+  s.rubyforge_project = "daemons"
+  s.homepage = "http://daemons.rubyforge.org"
+  s.platform  = Gem::Platform::RUBY
+  s.summary = "A toolkit to create and control daemons in different ways"
+  s.description = <<-EOF
+    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.
+  EOF
+    
+  #s.files = FileList["{test,lib}/**/*"].exclude("rdoc").to_a
+  s.files = PKG_FILES
+  s.require_path = "lib"
+  s.autorequire = "daemons"
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "Releases", "TODO"]
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end
+
+
+#Rake::PackageTask.new("package") do |p|
+#  p.name = PKG_NAME
+#  p.version = Daemons::VERSION
+#  p.need_tar = true
+#  p.need_zip = true
+#  p.package_files = PKG_FILES
+#end
+
+ 
+task :default => [:package]
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end
+
+task :upload do
+  sh "scp -r html/* uehli@rubyforge.org:/var/www/gforge-projects/daemons"
+end
+
+
+desc "Create the RDOC html files"
+rd = Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.title    = "Daemons"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main' << 'README'
+  rdoc.rdoc_files.include('README', 'TODO', 'Releases')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/Releases

@@ -0,0 +1,126 @@
+= Daemons Release History
+
+== Release 1.0.10: November 16, 2007
+
+* By default, we now delete stray pid-files (i.e. pid-files which result for 
+  example from a killed daemon) automatically. This function can be deactivated by
+  passing :keep_pid_files => true as an option.
+* All pid files of :multiple daemons new get deleted correctly upon exit of the daemons (reported by Han Holl).
+* Use the signal 'KILL' instead of 'TERM' on Windows platforms.
+* Use exit! in trap('TERM') instead of exit when option :hard_exit is given (thanks to Han Holl).
+* Did some clarification on the exception log.
+
+== Release 1.0.9: October 29, 2007
+
+* fixed a severe bug in the new Pid.running? function: function returned true if the process did not exist (thanks to Jeremy Lawler).
+
+== Release 1.0.8: September 24, 2007
+
+* new Pid.running? function. Checking whether a process exists by sending signal '0' (thanks to Dru Nelson).
+
+== Release 1.0.7: July 7, 2007
+
+* Patch to fix wrong ARGV when using :exec (in def start_exec: Kernel.exec(script(), *(@app_argv || []))) (thanks to Alex McGuire).
+
+== Release 1.0.6: Mai 8, 2007
+
+* New option to pass an ARGV-style array to run and run_proc (thanks to Marc Evans).
+* Additional patches for '/var/log' (thanks to Marc Evans).
+
+== Release 1.0.5: February 24, 2007
+
+* Applied patch that makes daemons to use '/var/log' as logfile 
+  directory if you use :dir_mode = :system (thanks to Han Holl).
+* Daemons should now work with Ruby 1.9 (at least the basic features).
+
+== Release 1.0.4: January 17, 2007
+
+* Document the :log_output option (thanks to Andrew Kuklewicz).
+* Set STDOUT.sync = true when redirecting to a logfile (thanks to Andrew Kuklewicz).
+* Should now run also correctly when there is no working 'ps ax' on the system (thanks to Daniel Kehoe).
+
+== Release 1.0.3: November 1, 2006
+
+* Set the app_name correctly also for the monitor process (thanks to Ilya Novoselov).
+
+== Release 1.0.2: September 26, 2006
+
+* Changed the 'ps -ax' call back to 'ps ax'.
+* Fixed the documentation for the :normal :dir_mode.
+* As a default for Daemons.run_proc, the pid file is now saved in the current directory.
+* In :ontop mode for running a proc (this is equal to calling something like 'ruby ctrl_proc.rb run'), 
+  the proc now runs directly in the calling script, not in a forked process anymore (thanks to Paul Butcher).
+* Set $0 to app_name in the daemons (thanks to Ilya Novoselov).
+
+== Release 1.0.1: August 30, 2006
+
+* Fixed a regex for parsing the 'ps ax' system call. (thanks to Garance Alistair Drosehn)
+
+== Release 1.0.0: August 29, 2006
+
+* Fix the parsing of the 'ps ax' system call. (thanks to Garance Alistair Drosehn)
+
+== 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
+  on calling Daemons.run. This will be used to contruct the name of the pid files
+  and log files. Defaults to the basename of the script. (thanks to Stephen R. Veit)
+
+* Bugfix: Handle the case where no controller options are given when calling Daemons, 
+  just options after "--". (thanks to Stephen R. Veit)
+
+
+== Release 0.4.2: November 15, 2005
+
+* Bugfix for problem with :normal pid-file directory mode (pid.rb), fixed (thanks to Stephen R. Veit)
+
+
+== Release 0.4.1: September 11, 2005
+
+* Bugfix for 'run' command line mode: didn't work anymore in 0.4.0, fixed
+
+
+== Release 0.4.0: July 30, 2005
+
+* Two completely new operation modes:
+  1. Call a block as a daemon (<tt>Daemons.call { my_daemon_code }</tt>)
+     and control it from the parent process.
+  2. Daemonize the currently running process (<tt>Daemons.daemonize</tt>)
+  plus the already existing mode to control your scripts (<tt>Daemons.run("script.rb")</tt>)
+* Improved documentation (for example "How does the daemonization process work?")
+* Improved "simulation mode" (<tt>:ontop</tt> option)
+* Some minor bugfixes
+
+
+== Release 0.3.0: April 21, 2005
+
+* New monitor functionality: automatic restarting of your applications if they crash
+* 'restart' command fixed
+* '--force' command modifier (please refer to the documentation)
+* Some more bugfixes and improvements
+
+
+== Release 0.2.1: Mar 21, 2005
+
+* Bugfix for a problem with the 'status' command
+
+
+== Release 0.2.0: Mar 21, 2005
+
+* Exception backtrace functionality added
+* Exec functionality added
+* More examples added
+* New commands: status, zap
+
+
+== Release 0.0.1: Feb 8, 2005
+
+* Initial release