pidly 0.1.2 → 0.1.3

data/ChangeLog.rdoc

@@ -1,3 +1,8 @@
+=== 0.1.3 / 04/07/2011
+
+* Refactor callback validations
+* log/pid files now return a Pathname object
+
 === 0.1.2 / 04/07/2011
 
 * Callbacks#add_callback should be private

data/lib/pidly/control.rb

@@ -29,6 +29,31 @@ module Pidly
     #
     # @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
+    #   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
+    #
     # @raise [RuntimeError]
     #   Raise exception if path does not exist
     #
@@ -43,10 +68,10 @@ module Pidly
 
       @name = options.fetch(:name)
 
-      if options.has_key?(:path)
-        @path = Pathname.new(options.fetch(:path))
+      @path = if options.has_key?(:path)
+        Pathname.new(options.fetch(:path))
       else
-        @path = Pathname.new('/tmp')
+        Pathname.new('/tmp')
       end
 
       unless @path.directory?
@@ -57,19 +82,19 @@ module Pidly
         raise('Path must be readable and writable.')
       end
 
-      if options.has_key?(:pid_file)
-        @pid_file = options.fetch(:pid_file)
+      @pid_file = if options.has_key?(:pid_file)
+        Pathname.new(options.fetch(:pid_file))
       else
-        @pid_file = File.join(@path.to_s, 'pids', @name + '.pid')
+        Pathname.new(File.join(@path.to_s, 'pids', @name + '.pid'))
       end
 
-      if options.has_key?(:log_file)
-        @log_file = options.fetch(:log_path)
+      @log_file = if options.has_key?(:log_file)
+        Pathname.new(options.fetch(:log_file))
       else
-        @log_file = File.join(@path.to_s, 'logs', @name + '.log')
+        Pathname.new(File.join(@path.to_s, 'logs', @name + '.log'))
       end
 
-      @pid = fetch_pid if File.file?(@pid_file)
+      @pid = fetch_pid
 
       @sync_log = options.fetch(:sync_log, true)
 
@@ -82,38 +107,27 @@ module Pidly
       @verbosity = options.fetch(:verbose, true)
 
       @logger = options.fetch(:logger, true)
+
+      validate_callbacks!
+
+      validate_files_and_paths!
     end
 
     #
     # 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
-    #   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
+    # 
+    # @param [Hash] options Control object options
     #
     # @return [Control] Control object
     #
+    # @see initialize
+    # 
+    # @example
+    #   Test.spawn(
+    #     :path => '/tmp',
+    #     :verbose => true
+    #   )
+    # 
     def self.spawn(options={})
       @daemon = new(options)
     end
@@ -124,8 +138,6 @@ module Pidly
     # Validate callbacks and start daemon
     #
     def start
-      validate_files_and_paths!
-      validate_callbacks!
 
       unless @allow_multiple
         if running?
@@ -284,22 +296,50 @@ module Pidly
     rescue Errno::ENOENT
     end
 
-    def validate_files_and_paths!
-      log = Pathname.new(@log_file).dirname
-      pid = Pathname.new(@pid_file).dirname
+    #
+    # Fetch Class Variable
+    #
+    # @param [Symbol] name Callback name
+    #
+    # @return [Symbol, Proc, nil]
+    #   Returns either a method or block of code to be executed when
+    #   the callback is called. If no value is accossiated with the
+    #   call variable `nil` will be returned to the caller.
+    #
+    def fetch_class_var(name)
+      Control.instance_eval do
+        return nil unless class_variable_defined?(:"@@#{name}")
+
+        class_variable_get(:"@@#{name}")
+      end
+    end
 
-      unless File.directory?(log)
-        FileUtils.mkdir_p(log.to_s)
+    def validate_files_and_paths!
+      unless @log_file.directory?
+        FileUtils.mkdir_p(@log_file.dirname)
       end
 
-      unless File.directory?(pid)
-        FileUtils.mkdir_p(pid.to_s)
+      unless @pid_file.directory?
+        FileUtils.mkdir_p(@pid_file.dirname)
       end
     end
 
     def validate_callbacks!
-      unless Control.class_variable_defined?(:"@@start")
-        raise('You must define a "start" callback.')
+      parent = self
+      Control.instance_eval do
+
+        unless class_variable_defined?(:"@@start")
+          raise('You must define a "start" callback.')
+        end
+
+        class_variables.each do |cvar|
+          value = class_variable_get(:"#{cvar}")
+
+          next unless value.is_a?(Symbol)
+          next if parent.respond_to?(value)
+
+          raise("Undefined callback method: #{value}")
+        end
       end
     end
 
@@ -309,23 +349,14 @@ module Pidly
       if (callback = fetch_class_var(callback_name))
 
         if callback.kind_of?(Symbol)
-
-          unless self.respond_to?(callback.to_sym)
-            raise("Undefined callback method: #{callback}")
-          end
-
           self.send(callback.to_sym)
-
         elsif callback.respond_to?(:call)
-
           self.instance_eval(&callback)
-
         else
           nil
         end
 
       end
-
     end
 
     def fetch_pid
@@ -334,17 +365,8 @@ 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,
-      :fetch_class_var
+      :validate_files_and_paths!, :execute_callback
 
   end # class Control
 

data/lib/pidly/version.rb

@@ -1,4 +1,4 @@
 module Pidly
   # pidly version
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/control_spec.rb

@@ -20,12 +20,13 @@ describe Control do
 
   it "should have an active status, name and pid" do
     @daemon.status
-    reply = "#{@daemon.name} is running (PID #{@daemon.pid})"
+    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"
+    @daemon.pid_file.to_s.should == "/tmp/pids/#{@daemon.name}.pid"
   end
 
   it "should have a pid file that exists" do
@@ -33,7 +34,7 @@ describe Control do
   end
 
   it "should have the correct log file" do
-    @daemon.log_file.should == "/tmp/logs/#{@daemon.name}.log"
+    @daemon.log_file.to_s.should == "/tmp/logs/#{@daemon.name}.log"
   end
 
   it "should have a log file that exists" do
@@ -42,7 +43,7 @@ describe Control do
 
   it "should fail when trying to start another daemon" do
     @daemon.start
-    reply = "#{@daemon.name} is already running (PID #{@daemon.pid})"
+    reply = "\"#{@daemon.name}\" is already running (PID: #{@daemon.pid})"
 
     @daemon.messages.last.should == reply
   end
@@ -56,6 +57,30 @@ describe Control do
     file = File.open(@daemon.pid_file, 'r')
     file.read.should =~ /#{@daemon.pid}/
   end
+  
+  it "should not have a start callback defined" do
+    test_callback(:start, true).should == true
+  end
+  
+  it "should not have a stop callback defined" do
+    test_callback(:stop).should == "Attempting to kill process: "
+  end
+  
+  it "should not have a before_start callback defined" do
+    test_callback(:before_start).should == "BEFORE START "
+  end
+  
+  it "should not have a after_stop callback defined" do
+    test_callback(:after_stop).should == :test_after_daemon_stops
+  end
+  
+  it "should have an error callback defined" do
+    test_callback(:error).should == "SENDING EMAIL | Error Count: "
+  end
+  
+  it "should not have a kill callback defined" do
+    test_callback(:kill).should == nil
+  end
 
   after(:all) do
     if @daemon

data/spec/spec_helper.rb

@@ -29,5 +29,28 @@ class Test < Pidly::Control
       sleep 2
     end
   end
+  
+  def test_after_daemon_stops
+    puts "AFTER STOP"
+  end
+
+end
 
+def test_callback(callback, defined=false)
+  test = @daemon.fetch_class_var(callback.to_sym)
+  
+  if defined
+    return true if test
+    false
+  else
+    
+    if test.kind_of?(Symbol)
+      test
+    elsif test.respond_to?(:call)
+      test.call
+    else
+      nil
+    end
+    
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: pidly
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Dustin Willis Webber