basic_daemon 0.9.1 → 1.0.0

data/README.rdoc

@@ -1,21 +1,28 @@
-A basic library for creating daemonized processes
-  (c) 2009 Samuel Mullen (samullen)
+= BasicDaemon
+
+http://github.com/samullen/basic_daemon
 
-  http://github.com/samullen/basic_daemon
+A basic library for creating daemonized processes
 
 This library works with Ruby 1.8, Ruby 1.9, and JRuby and is licensed under the MIT License.
 
-Installation
+== Installation
 
-sudo gem install basic_daemon
+The basic_daemon gem is hosted on GemCutter (http://gemcutter.org). This
+requires that you have http://gemcutter.org in your gem sources.
 
-Gettings Started
+Install the basic_daemon gem: 
 
-There are currently two ways of using the basic_daemon library: 1) Objected Oriented; 2) Functional.
+  sudo gem install basic_daemon
 
-Object Oriented 
+== Gettings Started
 
-The basic idea here is to subclass BasicDaemon and overwrite the "run" method.
+There are currently two ways of using the basic_daemon library: 1) Objected
+Oriented; 2) Functional.
+
+=== Object Oriented 
+
+The basic idea here is to subclass BasicDaemon and overwride the "run" method.
 
   require 'basic_daemon'
 
@@ -49,7 +56,7 @@ The basic idea here is to subclass BasicDaemon and overwrite the "run" method.
     exit!
   end
 
-Functional
+=== Functional
 
 Rather than subclassing BasicDaemon, a block is just passed to the start method.
 
@@ -57,8 +64,7 @@ Rather than subclassing BasicDaemon, a block is just passed to the start method.
 
   daemon = BasicDaemon.new
 
-  if ARGV[0] == 'start'
-    daemon.start do
+  process = Proc.new do
       foo = open("/tmp/out", "w")
 
       i = 1
@@ -71,24 +77,36 @@ Rather than subclassing BasicDaemon, a block is just passed to the start method.
         i += 1
       end
     end
+
+  if ARGV[0] == 'start'
+    daemon.start &process
   elsif ARGV[0] == 'stop'
     daemon.stop
     exit!
   elsif ARGV[0] == 'restart'
-    daemon.restart
+    daemon.restart &process
   else
     STDERR.puts "Usage: foo_daemon.rb <start|stop|restart>"
     exit!
   end
 
-Arguments
+=== Arguments
 
-BasicDaemon creates file to store the process ID (PID). By default, this file is given the same name as the calling script sans the file extension and is stored in the /tmp directory. Also by default, the directory the calling script is working in is changed to the root directory ('/').
+BasicDaemon creates file to store the process ID (PID). By default, this file
+is given the same name as the calling script sans the file extension and is
+stored in the /tmp directory. Also by default, the directory the calling script
+is working in is changed to the root directory ('/').
 
-Each argument, :pidfile, :piddir, :workingdir, can be changed upon instantiation of the class. 
+Each argument, :pidfile, :piddir, :workingdir, can be changed upon
+instantiation of the class. 
 
-Example:
+==== Example:
 
 Most Linux users will want to instantiate thusly:
 
   BasicDaemon.new(:piddir => '/var/lock')
+
+== Copyright
+
+Copyright(c) 2009 Samuel Mullen (samullen). See LICENSE for details
+

data/Rakefile

@@ -20,7 +20,6 @@ gem_spec = Gem::Specification.new do |s|
   s.test_files = Dir['test/**/*.rb']
   s.description = false
   s.files = [
-    "History.rdoc",
     "LICENSE",
     "README.rdoc",
     "Rakefile",

data/examples/functional.rb

@@ -7,6 +7,8 @@ pidfile = File.basename($PROGRAM_NAME, File.extname($PROGRAM_NAME))
 
 d = BasicDaemon.new({:pidfile => pidfile, :piddir => basedir, :workingdir => basedir})
 
+# for restarts to work properly, you can't use anonymous blocks. In other
+# words, blocks have to be assigned to a variable
 process = Proc.new do
   i = 1
   foo = open(basedir + "/out", "w")

data/lib/basic_daemon.rb

@@ -1,7 +1,7 @@
 class BasicDaemon
   attr_accessor :workingdir, :pidfile, :piddir, :process
 
-  VERSION = '0.9.1'
+  VERSION = '1.0.0'
 
   DEFAULT_OPTIONS = {
     :pidfile => File.basename($PROGRAM_NAME, File.extname($PROGRAM_NAME)),
@@ -9,14 +9,14 @@ class BasicDaemon
     :workingdir => '/'
   }
 
-  # Instantiate a new BasicDaemon
-  #
-  # Takes an optional hash with the following symbol keys:
-  # - :piddir = Directory to store the PID file in. Default is /tmp
-  # - :pidfile = name of the file to store the PID in. default is the script 
-  #   name sans extension.
-  # - :workingdir = Directory to work from. Default is "/" and should probably 
-  #   be left as such.
+# Instantiate a new BasicDaemon
+#
+# Takes an optional hash with the following symbol keys:
+# - :piddir = Directory to store the PID file in. Default is /tmp
+# - :pidfile = name of the file to store the PID in. default is the script 
+#   name sans extension.
+# - :workingdir = Directory to work from. Default is "/" and should probably 
+#   be left as such.
   def initialize(*args)
     opts = {}
 
@@ -77,22 +77,13 @@ class BasicDaemon
         fork && exit!
 
         at_exit do
-          delpidfile
+          remove_pidfile
         end
 
         Dir::chdir(@workingdir) #----- chdir to working directory
         File::umask(0) #----- clear out file mode creation mask
 
-        begin
-          open(self.pidpath, "w") do |f|
-            @pid = Process.pid
-            f.puts @pid
-          end
-        rescue => e
-          STDERR.puts "Error: Unable to open #{self.pidpath} for writing:\n\t" +
-            "(#{e.class}) #{e.message}"
-          exit!
-        end
+        create_pidfile
 
         STDIN.reopen("/dev/null", 'r')
         STDOUT.reopen("/dev/null", "w")
@@ -169,8 +160,22 @@ class BasicDaemon
 
   private
 
-  #----------------------------------------------------------------------------#
-  def delpidfile
+  # Writes the process ID to the pidfile and defines @pid as such
+  def create_pidfile
+    begin
+      open(self.pidpath, "w") do |f|
+        @pid = Process.pid
+        f.puts @pid
+      end
+    rescue => e
+      STDERR.puts "Error: Unable to open #{self.pidpath} for writing:\n\t" +
+        "(#{e.class}) #{e.message}"
+      exit!
+    end
+  end
+
+  # removes the pidfile. Called on exit
+  def remove_pidfile
     begin
       File.unlink(self.pidpath)
     rescue => e

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: basic_daemon
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Samuel Mullen
@@ -22,7 +27,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- History.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -45,18 +49,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A simple ruby library for daemonizing processes

data/History.rdoc

@@ -1,57 +0,0 @@
-= 0.9.0 - 20100216
-
-* Bumped the version to 0.9.0 because it's just about ready for a 1.0 release.
-* cleaned up tests and added a restart test to oo and function
-* Still need to work on documentation and fix the Rakefile
-
-= 0.1.5 - 20100118
-
-Doing some refactoring and broke out code which determines the PID into its
-own method "pid".
-
-Added LICENSE and updated TODO
-
-Updated Rakefile and tests
-
-= 0.1.4 - 20100115
-
-Provided basic documentation for the methods.
-
-= 0.1.3 - 20091230
-
-Breaking out tests
-
-* Broke out tests to organize by functionality
-
-= 0.1.2 - 20091230
-
-Switched back to Test::Unit
-
-* Migrated all RSpec tests to Test::Unit
-* Expanded tests to handle calling blocks
-
-= 0.1.1 - 20090925
-
-RSpec testing expansion.
-
-* continuing to add tests to the spec.
-* added a method to the library to determine if a PID is alive
-
-= 0.1.0 - 20090923
-
-Major bug fixes 
-
-* The daemon now correctly forks off from the calling process.
-* The procedural means of executing a daemon have been eliminated.
-
-= 0.0.5 - 20090921
-
-Began moving tests to RSpec. 
-
-= 0.0.5 - 20090812
-
-Started recording changes to the repository in to line up with git commit
-messages.
-
-* addition of License.txt and History.txt, though mostly empty
-* Initial gemspec was created. The daemon is now gemable