pigeon 0.1.0 → 0.2.0

data/README.rdoc

@@ -48,7 +48,6 @@ An example would look like:
     engine = engine
 
     options = {
-      :dir_mode => :normal,
       :dir => engine.pid_dir,
       :debug => true, # ((ENV['RAILS_ENV'] == 'production') ? ENV['PINGITY_DEBUG'] : true),
       :modules => [ ]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/launcher.example

@@ -4,7 +4,6 @@ COMMAND_NAME = 'launcher'
 engine = engine
 
 options = {
-  :dir_mode => :normal,
   :dir => engine.pid_dir,
   :debug => true, # ((ENV['RAILS_ENV'] == 'production') ? ENV['PINGITY_DEBUG'] : true),
   :modules => [ ]

data/lib/pigeon/engine.rb

@@ -45,7 +45,13 @@ class Pigeon::Engine
 
   def self.launch_with_options(options = nil)
     EventMachine.run do
-      new(options_with_defaults(options)).run
+      engine = new(options_with_defaults(options))
+
+      Signal.trap('INT') do
+        engine.terminate
+      end
+
+      engine.run
     end
   end
   
@@ -63,29 +69,37 @@ class Pigeon::Engine
     end
 
     pid_file(options).create!(pid)
-    yield(pid.to_i)
+
+    yield(pid) if (block_given?)
+    
+    pid
   end
 
   def self.run(options = nil)
-    yield($$)
+    yield($$) if (block_given?)
+
     launch_with_options((options || { }).merge(:foreground => true))
   end
   
   def self.stop(options = nil)
     pf = pid_file(options)
-    pid = pf.contents
+    pid = pf.running
     
     if (pid)
       begin
-        Process.kill('QUIT', pid)
+        Process.kill('INT', pid)
       rescue Errno::ESRCH
         # No such process exception
         pid = nil
       end
       pf.remove!
     end
+    
+    pid = pid.to_i if (pid)
 
-    yield(pid)
+    yield(pid) if (block_given?)
+    
+    pid
   end
 
   def self.restart(options = nil)
@@ -94,7 +108,11 @@ class Pigeon::Engine
   end
   
   def self.status(options = nil)
-    yield(pid_file(options).contents)
+    pid = pid_file(options).running
+    
+    yield(pid) if (block_given?)
+    
+    pid
   end
 
   def self.sql_logger
@@ -192,7 +210,9 @@ class Pigeon::Engine
   
   # Shuts down the engine.
   def terminate
+    run_chain(:before_stop)
     EventMachine.stop_event_loop
+    run_chain(:after_stop)
   end
   
   # Used to queue a block for immediate processing on a background thread.

data/lib/pigeon/pidfile.rb

@@ -1,5 +1,9 @@
 class Pigeon::Pidfile
   # == Constants ============================================================
+
+  # == Properties ===========================================================
+  
+  attr_reader :path 
   
   # == Class Methods ========================================================
   
@@ -11,7 +15,19 @@ class Pigeon::Pidfile
     @path += '.pid' unless (@path.match(/\./))
   end
   
-  def contents
+  def running?
+    !!self.running
+  end
+  
+  def running
+    pid = self.saved_pid
+
+    (pid and Process.kill(0, pid)) ? pid : nil
+  rescue Errno::ESRCH
+    nil
+  end
+  
+  def saved_pid
     File.read(@path).to_i
   rescue Errno::ENOENT
     nil
@@ -19,17 +35,17 @@ class Pigeon::Pidfile
   
   def create!(pid = nil)
     open(@path, 'w') do |fh|
-      fh.puts pid || $$
+      fh.puts(pid || $$)
     end
   end
   
   def remove!
-    return unless (exists?)
+    return unless (exist?)
 
     File.unlink(@path)
   end
   
-  def exists?
+  def exist?
     File.exist?(@path)
   end
 end

data/pigeon.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pigeon}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["tadman"]
-  s.date = %q{2010-10-01}
+  s.date = %q{2010-10-05}
   s.default_executable = %q{launcher.example}
   s.description = %q{Pigeon is a simple way to get started building an EventMachine engine that's intended to run as a background job.}
   s.email = %q{github@tadman.ca}

data/test/test_pigeon_engine.rb

@@ -20,8 +20,44 @@ class TestEngine < Pigeon::Engine
   end
 end
 
+class ShutdownEngine < Pigeon::Engine
+  after_start do
+    self.terminate
+  end
+end
+
+class CallbackTestEngine < Pigeon::Engine
+  after_initialize do
+    self.track(:after_initialize)
+  end
+  
+  before_start do
+    self.track(:before_start)
+  end
+  
+  after_start do
+    self.track(:after_start)
+  end
+  
+  before_stop do
+    self.track(:before_stop)
+  end
+  
+  after_stop do
+    self.track(:after_stop)
+    @options[:pipe].close
+  end
+  
+  def track(callback)
+    pipe = @options[:pipe]
+
+    pipe.puts(callback.to_s)
+    pipe.flush
+  end
+end
+
 class TestPigeonEngine < Test::Unit::TestCase
-  def test_create_subclass
+  def test_example_subclass
     engine_pid = nil
     
     read_fd, write_fd = IO.pipe
@@ -31,6 +67,8 @@ class TestPigeonEngine < Test::Unit::TestCase
       engine_pid = pid
     end
     
+    write_fd.close
+    
     Timeout::timeout(5) do
       assert_equal "STARTED\n", read_fd.readline
     end
@@ -47,4 +85,83 @@ class TestPigeonEngine < Test::Unit::TestCase
       assert_equal nil, pid
     end
   end
+
+  def test_example_subclass_without_blocks
+    engine_pid = nil
+    
+    read_fd, write_fd = IO.pipe
+    
+    engine_pid = TestEngine.start(:pipe => write_fd)
+    
+    write_fd.close
+    
+    assert engine_pid
+    
+    Timeout::timeout(5) do
+      assert_equal "STARTED\n", read_fd.readline
+    end
+    
+    running_pid = TestEngine.status
+    
+    assert_equal engine_pid, running_pid
+    
+    assert_equal engine_pid, TestEngine.stop
+
+    assert_equal nil, TestEngine.status
+  end
+  
+  def test_callbacks
+    engine_pid = nil
+    
+    read_fd, write_fd = IO.pipe
+    
+    CallbackTestEngine.start(:pipe => write_fd) do |pid|
+      assert pid
+      engine_pid = pid
+    end
+    
+    write_fd.close
+    
+    CallbackTestEngine.status do |pid|
+      assert_equal engine_pid, pid
+    end
+    
+    CallbackTestEngine.stop do |pid|
+      assert_equal engine_pid, pid
+    end
+
+    CallbackTestEngine.status do |pid|
+      assert_equal nil, pid
+    end
+    
+    expected_callbacks = [
+      :after_initialize,
+      :before_start,
+      :after_start,
+      :before_stop,
+      :after_stop
+    ].freeze
+    
+    assert_equal expected_callbacks, read_fd.read.split(/\n/).collect(&:to_sym)
+  end
+  
+  def test_shutdown_engine
+    engine_pid = nil
+    
+    ShutdownEngine.start do |pid|
+      engine_pid = pid
+    end
+    
+    assert engine_pid
+    
+    sleep(1)
+    
+    running_pid = nil
+    
+    ShutdownEngine.status do |pid|
+      running_pid = pid
+    end
+    
+    assert_equal nil, running_pid
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - tadman
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-01 00:00:00 -04:00
+date: 2010-10-05 00:00:00 -04:00
 default_executable: launcher.example
 dependencies: 
 - !ruby/object:Gem::Dependency