pidly 0.1.0 → 0.1.1

data/ChangeLog.rdoc

@@ -1,4 +1,9 @@
-=== 0.1.0 / 2011-04-04
+=== 0.1.1 / 04/07/2011
+
+* Bug fixes
+* Added Pidly::Control#clean!
+
+=== 0.1.0 / 04/06/2011
 
 * Initial release:
 

data/README.md

@@ -1,7 +1,7 @@
 # pidly
 
-* [Homepage][https://github.com/mephux/pidly]
-* [Documentation][http://rubydoc.info/gems/pidly/frames]
+* [Homepage](https://github.com/mephux/pidly)
+* [Documentation](http://rubydoc.info/github/mephux/pidly/master/frames)
 
 ## Description
 
@@ -10,34 +10,34 @@ daemon without getting in the way with forced verbose output and usage messages.
 
 ## Examples
 
-    require 'pidly'
+	require 'pidly'
 
-		class Test < Pidly::Control
+	class Test < Pidly::Control
 
-		  before_start do
-		    "BEFORE START #{@pid}"
-		  end
+	  before_start do
+	    puts "BEFORE START #{@pid}"
+	  end
 
-		  start :when_daemon_starts
+	  start :when_daemon_starts
 
-		  stop do
-		    "Attempting to kill process: #{@pid}"
-		  end
+	  stop do
+	    puts "Attempting to kill process: #{@pid}"
+	  end
 
-		  after_stop :test_after_daemon_stops
+	  after_stop :test_after_daemon_stops
 
-		  error do
-		    "SENDING EMAIL | Error Count: #{@error_count}"
-		  end
+	  error do
+	    puts "SENDING EMAIL | Error Count: #{@error_count}"
+	  end
 
-		  def when_daemon_starts
-		    loop do
-		      print "TEST FROM #{@pid}"
-		      sleep 2
-		    end
-		  end
+	  def when_daemon_starts
+	    loop do
+	      print "TEST FROM #{@pid}"
+	      sleep 2
+	    end
+	  end
 
-		end
+	end
 
 	@daemon = Test.spawn(
 	  :name => 'Test Daemon',
@@ -46,11 +46,11 @@ daemon without getting in the way with forced verbose output and usage messages.
 	)
 
 	# @daemon.send ARGV.first
-	@daemon.start # stop, status, restart, and kill.
+	@daemon.start # stop, status, restart, clean!, and kill.
 
 ## Install
 
-  $ gem install pidly
+	$ gem install pidly
 
 ## Copyright
 

data/lib/pidly/callbacks.rb

@@ -1,19 +1,19 @@
 module Pidly
   #
   # Pidly before/after callbacks
-  # 
+  #
   module Callbacks
-    
+
     #
     # Before start
-    # 
-    # Right before the daemon is instructed to start the 
+    #
+    # Right before the daemon is instructed to start the
     # following callback will be invoked and executed.
-    # 
+    #
     # @param [Symbol] callback Method name
     # @yield [] Code to be executed upon callback invocation
     #
-    # @example 
+    # @example
     #   before_start :method_name
     #   # OR
     #   before_start { puts "#{@pid} is about to start!" }
@@ -21,53 +21,53 @@ module Pidly
     def before_start(callback=nil, &block)
       add_callback(:before_start, (callback || block))
     end
-    
+
     #
     # Start
-    # 
-    # When the daemon is instructed to start the 
+    #
+    # When the daemon is instructed to start the
     # following callback will be invoked and executed.
-    # 
+    #
     # @param [Symbol] callback Method name
     # @yield [] Code to be executed upon callback invocation
     #
-    # @example 
+    # @example
     #   start :method_name
     #   # OR
     #   start { puts "Daemon Started!" }
-    # 
+    #
     def start(callback=nil, &block)
       add_callback(:start, (callback || block))
     end
-    
+
     #
     # Stop
-    # 
-    # When the daemon is instructed to stop the 
+    #
+    # When the daemon is instructed to stop the
     # following callback will be invoked and executed.
-    # 
+    #
     # @param [Symbol] callback Method name
     # @yield [] Code to be executed upon callback invocation
-    # 
-    # @example 
+    #
+    # @example
     #   stop :method_name
     #   # OR
     #   stop { puts "Attempting to stop #{@name} with pid #{@pid}!" }
-    # 
+    #
     def stop(callback=nil, &block)
       add_callback(:stop, (callback || block))
     end
-    
+
     #
     # After stop
-    # 
-    # Right after the daemon is instructed to stop the 
+    #
+    # Right after the daemon is instructed to stop the
     # following callback will be invoked and executed.
-    # 
+    #
     # @param [Symbol] callback Method name
     # @yield [] Code to be executed upon callback invocation
     #
-    # @example 
+    # @example
     #   after_start :method_name
     #   # OR
     #   after_start { puts "#{@pid} was just killed!" }
@@ -75,17 +75,17 @@ module Pidly
     def after_stop(callback=nil, &block)
       add_callback(:after_stop, (callback || block))
     end
-    
+
     #
     # Error
-    # 
+    #
     # If the daemon encounters an error or an exception is raised
     # the following callback will be invoked and executed.
-    # 
+    #
     # @param [Symbol] callback Method name
     # @yield [] Code to be executed upon callback invocation
     #
-    # @example 
+    # @example
     #   error :send_error_email
     #   # OR
     #   error { puts "ZOMG! #{@name} failed!" }
@@ -96,25 +96,26 @@ module Pidly
 
     #
     # Add callback
-    # 
+    #
     # @param [Symbol] callback Callback method name
     # @param [Symbol, nil] invoke Method to call
     # @yield [] Code to be executed upon callback invocation
-    # 
+    #
     def add_callback(callback, invoke)
-      Control.class_variable_set(:"@@#{callback}", invoke)
+      Control.instance_eval do
+        class_variable_set(:"@@#{callback}", invoke)
+      end
     end
 
     #
     # Extend and include callback methods
-    # 
+    #
     # @param [Class] receiver The calling class
-    # 
+    #
     def self.included(receiver)
-      puts receiver.class
       receiver.extend self
     end
 
   end # modle Callbacks
-  
-end # module Pidly
+
+end # module Pidly

data/lib/pidly/control.rb

@@ -16,7 +16,7 @@ module Pidly
 
     # Include callbacks
     include Pidly::Callbacks
-    
+
     # Include logging helpers
     include Pidly::Logger
 
@@ -28,13 +28,13 @@ module Pidly
     # Initialize control object
     #
     # @param [Hash] options The options to create a controller with.
-    # 
-    # @raise [RuntimeError] 
+    #
+    # @raise [RuntimeError]
     #   Raise exception if path does not exist
-    # 
-    # @raise [RuntimeError] 
+    #
+    # @raise [RuntimeError]
     #   Raise exception if path is not readable or writable.
-    # 
+    #
     def initialize(options={})
 
       @messages = []
@@ -88,28 +88,28 @@ module Pidly
     # Spawn
     #
     # @param [Hash] options The options to create a controller with.
-    # 
+    #
     # @option options [String] :name Daemon name
-    # 
+    #
     # @option options [String] :path Path to create the log/pids directory
-    # 
+    #
     # @option options [String] :pid_file Pid file path
-    # 
+    #
     # @option options [String] :log_file Log file path
-    # 
+    #
     # @option options [true, false] :sync_log Synchronize log files
-    # 
-    # @option options [true, false] :allow_multiple 
+    #
+    # @option options [true, false] :allow_multiple
     #   Allow multiple daemons of the same type
-    # 
+    #
     # @option options [true, false] :sync_log Synchronize log files
-    # 
+    #
     # @option options [String] :signal Trap signal
-    # 
+    #
     # @option options [Integer] :timeout Timeout for Process#wait
-    # 
+    #
     # @option options [true, false] :verbose Display daemon messages
-    # 
+    #
     # @option options [true, false] :logger Enable daemon logging
     #
     # @return [Control] Control object
@@ -117,12 +117,12 @@ module Pidly
     def self.spawn(options={})
       @daemon = new(options)
     end
-    
+
     #
     # Start
-    # 
+    #
     # Validate callbacks and start daemon
-    # 
+    #
     def start
       validate_files_and_paths!
       validate_callbacks!
@@ -156,7 +156,7 @@ module Pidly
             STDOUT.reopen log
             STDERR.reopen STDOUT
           end
-          
+
           trap("TERM") do
             stop
           end
@@ -181,12 +181,12 @@ module Pidly
       STDERR.puts message.backtrace
       execute_callback(:error)
     end
-    
+
     #
     # Stop
-    # 
+    #
     # Stop daemon and remove pid file
-    # 
+    #
     def stop
 
       if running?
@@ -211,19 +211,19 @@ module Pidly
 
       else
         FileUtils.rm(@pid_file) if File.exists?(@pid_file)
-        log(:info, "PID file not found. Is the daemon started?")
+        log(:info, "PID file not found.")
       end
 
     rescue Errno::ENOENT
     end
-    
+
     #
     # Status
-    # 
+    #
     # Return current daemon status and pid
-    # 
+    #
     # @return [String] Status
-    # 
+    #
     def status
       if running?
         log(:info, "#{@name} is running (PID #{@pid})")
@@ -231,21 +231,21 @@ module Pidly
         log(:info, "#{@name} is NOT running")
       end
     end
-    
+
     #
     # Restart
-    # 
+    #
     # Restart the daemon
-    # 
+    #
     def restart
       stop; sleep 1 while running?; start
     end
-    
+
     #
     # Kill
-    # 
+    #
     # @param [String] remove_pid_file Remove the daemon pid file
-    # 
+    #
     def kill(remove_pid_file=true)
       if running?
         log(:info, "Killing #{@name} (PID #{@pid})")
@@ -255,12 +255,12 @@ module Pidly
       FileUtils.rm(@pid_file) if remove_pid_file
     rescue Errno::ENOENT
     end
-    
+
     #
     # Running?
-    # 
+    #
     # @return [true, false] Return the running status of the daemon.
-    # 
+    #
     def running?
       Process.kill 0, @pid
       true
@@ -271,7 +271,18 @@ module Pidly
     rescue
       false
     end
-    
+
+    #
+    # Clean
+    #
+    # Remove all files created by the daemon.
+    #
+    def clean!
+      FileUtils.rm(@log_file)
+      FileUtils.rm(@pid_file)
+    rescue Errno::ENOENT
+    end
+
     def validate_files_and_paths!
       log = Pathname.new(@log_file).dirname
       pid = Pathname.new(@pid_file).dirname
@@ -294,8 +305,7 @@ module Pidly
     def execute_callback(callback_name)
       @error_count += 1 if callback_name == :error
 
-      if Control.class_variable_defined?(:"@@#{callback_name}")
-        callback = Control.class_variable_get(:"@@#{callback_name}")
+      if (callback = fetch_class_var(callback_name))
 
         if callback.kind_of?(Symbol)
 
@@ -323,8 +333,17 @@ module Pidly
       nil
     end
 
+    def fetch_class_var(name)
+      if Control.class_variable_defined?(:"@@#{name}")
+        Control.instance_eval do
+          return class_variable_get(:"@@#{name}")
+        end
+      end
+    end
+
     private :validate_callbacks!, :fetch_pid,
-      :validate_files_and_paths!, :execute_callback
+      :validate_files_and_paths!, :execute_callback,
+      :fetch_class_var
 
   end # class Control
 

data/lib/pidly/version.rb

@@ -1,4 +1,4 @@
 module Pidly
   # pidly version
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/control_spec.rb

@@ -17,49 +17,51 @@ describe Control do
   it "should be running" do
     @daemon.running?.should == true
   end
-  
+
   it "should have an active status, name and pid" do
     @daemon.status
     reply = "#{@daemon.name} is running (PID #{@daemon.pid})"
     @daemon.messages.last.should == reply
   end
-  
+
   it "should have the correct pid path" do
     @daemon.pid_file.should == "/tmp/pids/#{@daemon.name}.pid"
   end
-  
+
   it "should have a pid file that exists" do
     File.exists?("/tmp/pids/#{@daemon.name}.pid").should == true
   end
-  
+
   it "should have the correct log file" do
     @daemon.log_file.should == "/tmp/logs/#{@daemon.name}.log"
   end
-  
+
   it "should have a log file that exists" do
     File.exists?("/tmp/logs/#{@daemon.name}.log").should == true
   end
-  
+
   it "should fail when trying to start another daemon" do
     @daemon.start
     reply = "#{@daemon.name} is already running (PID #{@daemon.pid})"
-    
+
     @daemon.messages.last.should == reply
   end
-  
+
   it "should write to the log file" do
     file = File.open(@daemon.log_file, 'r')
     file.read.should =~ /TEST FROM #{@daemon.pid}/
   end
-  
+
   it "should write to the pid file" do
     file = File.open(@daemon.pid_file, 'r')
     file.read.should =~ /#{@daemon.pid}/
   end
-  
+
   after(:all) do
-    @daemon.kill if @daemon
-    FileUtils.rm @daemon.log_file.to_s
+    if @daemon
+      @daemon.kill
+      @daemon.clean!
+    end
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: pidly
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Dustin Willis Webber
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -04:00
+date: 2011-04-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pidly
-rubygems_version: 1.6.1
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: A super simple daemon library.