cromwell 0.1.2 → 0.2.0

data/README.rdoc

@@ -121,7 +121,11 @@ You can inspect Cromwell's state with two methods:
 
 === Preventing termination
 
-Since version 0.1.2, you can prevent termination of your script even when a signal was caught. To do so, use <code>Cromwell.should_exit = false</code> like that:
+Since version 0.1.2, you can prevent termination of your script even when a signal was caught. To do so, use
+
+  Cromwell.should_exit = false
+
+like that:
 
   puts 'You can try to kill me but I will survive!'
   Cromwell.protect {
@@ -144,17 +148,53 @@ This script will continue working even after <code>^C</code>:
   You're still here?
   $
 
+=== Removing traps
+
+As of version 0.2, any traps that were previously installed are restored by the unprotect method (which is also called by the protect method if a block was given to it, of course). This means if you had some other code installed to handle signals (profiling, debugging etc.) it should be restored. For example:
+
+  Signal.trap("INT") { puts "Original signal handler!" }
+
+  puts 'See you in a while...'
+  Cromwell.protect {
+    sleep 1
+  }
+  puts "Try to ^C now to see original signal handler in action!"
+  sleep 10
+
+When run, it goes like this:
+
+  $ ruby examples/example5.rb
+  See you in a while...
+  [ 1 second passes... ]
+  Try to ^C now to see original signal handler in action!
+  ^COriginal signal handler!
+  ^COriginal signal handler!
+  ^COriginal signal handler!
+  [ ten seconds pass... ]
+  $
+
+Of course, had I press <code>^C</code> right after "See you in a while...", the script would terminate after 1 second at the end of the protected block.
+
 == Compatibility
 
 Works for me. Tested on Mac OS X 10.4--10.6 and a little bit on Debian Linux. If it works for you too, I'd be glad to know. Cromwell's reliability depends heavily on your operating system's signals implementation reliability (which may not be very stable on some systems).
 
 == To Do list
 
-* Remove traps when they are not needed anymore. Currently they remain in place and when you call protect again (even with different signals list), the old ones are still effective.
 * Allow to customize behavior after catching a signal. Right now, the script is terminated after the protected block is done (even if the signal would not normally cause script termination).
-* Play well with other trap handlers that might be installed.
 * Add logger support.
 
+== Changelog
+
+=== 0.2
+
+* Remove traps when they are not needed anymore and restore original traps.
+
+=== 0.1.2
+
+* Allow to prevent termination of your script even when a signal was caught.
+* Ensure that examples use ../lib/cromwell.rb not the installed gem
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/cromwell.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cromwell}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Przemyslaw Kowalczyk"]
-  s.date = %q{2010-01-07}
+  s.date = %q{2010-01-08}
   s.description = %q{A very simple wrapper over Signal#trap method that allows you to easily protect your scripts from being killed while they are doing something that should not be interrupted (e.g. interacting with some non-transactional service) or is too costly to restart (e.g. long computations). }
   s.email = %q{szeryf@negativeiq.pl}
   s.extra_rdoc_files = [
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "examples/example2.rb",
      "examples/example3.rb",
      "examples/example4.rb",
+     "examples/example5.rb",
      "lib/cromwell.rb",
      "test/helper.rb",
      "test/test_cromwell.rb"
@@ -43,7 +44,8 @@ Gem::Specification.new do |s|
      "examples/example1.rb",
      "examples/example2.rb",
      "examples/example3.rb",
-     "examples/example4.rb"
+     "examples/example4.rb",
+     "examples/example5.rb"
   ]
 
   if s.respond_to? :specification_version then

data/examples/example5.rb

@@ -0,0 +1,13 @@
+# ensure that we use ../lib/cromwell.rb, not the installed gem
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cromwell'
+
+Signal.trap("INT") { puts "Original signal handler!" }
+
+puts 'See you in a while...'
+Cromwell.protect {
+  sleep 1
+}
+puts "Try to ^C now to see original signal handler in action!"
+sleep 10

data/lib/cromwell.rb

@@ -35,6 +35,7 @@ class Cromwell
     def unprotect
       @@protected = false
       exit if @@should_exit
+      restore_old_traps
     end
 
     # call-seq:
@@ -47,12 +48,12 @@ class Cromwell
     end
 
     # call-seq:
-    #   Cromwell.should_exit = bool
+    #   Cromwell.should_exit = boolean
     #
     # Set to false to prevent script from termination even if a signal was caught. You can also set
     # this to true to have your script terminated after protected block should you wish so.
-    def should_exit= b
-      @@should_exit = b
+    def should_exit= boolean
+      @@should_exit = boolean
     end
 
     # call-seq:
@@ -69,15 +70,27 @@ class Cromwell
     end
 
     def set_up_trap signal
-      trap signal do
+      old_trap = trap signal do
         if @@protected
-          #puts "Just a minute now."
           @@should_exit = true
           "IGNORE"
         else
           exit
         end
       end
+      stash old_trap, signal
+    end
+
+    def stash old_trap, signal
+      @@old_traps ||= {}
+      @@old_traps[signal] = old_trap
+    end
+
+    def restore_old_traps
+      @@old_traps.each do |signal, old_trap|
+        trap signal, old_trap
+      end
+      @@old_traps = {}
     end
   end
 end

data/test/test_cromwell.rb

@@ -80,6 +80,20 @@ class TestCromwell < Test::Unit::TestCase
     end
   end # general functionality
 
+  context "original traps" do
+    should "be restored" do
+      im_in_ur_blok_touchin_ur_vars = false
+      Signal.trap("HUP") {
+        im_in_ur_blok_touchin_ur_vars = true
+      }
+      Cromwell.protect {
+        im_in_ur_blok_touchin_ur_vars = :maybe?
+      }
+      Process.kill("HUP", $$)
+      assert im_in_ur_blok_touchin_ur_vars
+    end
+  end
+
   context "method protect" do
     should "set up trap with given signals" do
       Cromwell.expects(:set_up_traps).with(["HUP", "TERM"])
@@ -145,5 +159,5 @@ class TestCromwell < Test::Unit::TestCase
       Cromwell.unprotect
     end
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cromwell
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Przemyslaw Kowalczyk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-07 00:00:00 +01:00
+date: 2010-01-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ files:
 - examples/example2.rb
 - examples/example3.rb
 - examples/example4.rb
+- examples/example5.rb
 - lib/cromwell.rb
 - test/helper.rb
 - test/test_cromwell.rb
@@ -91,3 +92,4 @@ test_files:
 - examples/example2.rb
 - examples/example3.rb
 - examples/example4.rb
+- examples/example5.rb