cromwell 0.1.1 → 0.1.2

data/README.rdoc

@@ -12,6 +12,16 @@ For a full signal list supported on your operating system, run <code>Signal.list
 
 This gem is based on real-life production code. It is especially useful for protecting various daemon-like scripts in Rails application that are (might be) restarted with every deploy.
 
+== Installation procedure
+
+Thanks to {Gemcutter}[http://gemcutter.org/gems/cromwell], installation is as simple as:
+
+  sudo gem install cromwell
+
+If you plan on changing anything, you should run tests and tests require two additional gems: shoulda and mocha. Install them with:
+
+  sudo gem install thoughtbot-shoulda mocha
+
 == Usage examples
 
 The most important in Cromwell API is the <code>protect</code> method. It can be called in two ways: with a block and without a block.
@@ -109,6 +119,31 @@ You can inspect Cromwell's state with two methods:
 * <code>Cromwell.protected?</code> returns <code>true</code> when your code is protected, <code>false</code> otherwise.
 * <code>Cromwell.should_exit?</code> returns <code>true</code> when a signal was caught and termination will ocur after the protected code is over.
 
+=== 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:
+
+  puts 'You can try to kill me but I will survive!'
+  Cromwell.protect {
+    begin
+      sleep 10
+    ensure
+      puts "Oh noes! You wanted to kill me! But I'll continue my work!" if Cromwell.should_exit?
+      Cromwell.should_exit = false
+    end
+  }
+  puts "You're still here?"
+
+This script will continue working even after <code>^C</code>:
+
+  $ ruby examples/example4.rb
+  You can try to kill me but I will survive!
+  ^C^C^C
+  [ ten seconds pass... ]
+  Oh noes! You wanted to kill me! But I'll continue my work!
+  You're still here?
+  $
+
 == 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).

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/cromwell.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{cromwell}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Przemyslaw Kowalczyk"]
-  s.date = %q{2010-01-04}
+  s.date = %q{2010-01-07}
   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 = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "examples/example1.rb",
      "examples/example2.rb",
      "examples/example3.rb",
+     "examples/example4.rb",
      "lib/cromwell.rb",
      "test/helper.rb",
      "test/test_cromwell.rb"
@@ -41,7 +42,8 @@ Gem::Specification.new do |s|
      "test/test_cromwell.rb",
      "examples/example1.rb",
      "examples/example2.rb",
-     "examples/example3.rb"
+     "examples/example3.rb",
+     "examples/example4.rb"
   ]
 
   if s.respond_to? :specification_version then

data/examples/example1.rb

@@ -1,4 +1,6 @@
-require 'rubygems'
+# 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'
 
 puts 'See you in a while...'

data/examples/example2.rb

@@ -1,4 +1,6 @@
-require 'rubygems'
+# 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'
 
 puts 'See you in a while...'

data/examples/example3.rb

@@ -1,4 +1,6 @@
-require 'rubygems'
+# 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'
 
 puts "You can't stop me with ^C but you can kill me. My pid is #{$$}."

data/examples/example4.rb

@@ -0,0 +1,15 @@
+# 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'
+
+puts 'You can try to kill me but I will survive!'
+Cromwell.protect {
+  begin
+    sleep 10
+  ensure
+    puts "Oh noes! You wanted to kill me! But I'll continue my work!" if Cromwell.should_exit?
+    Cromwell.should_exit = false
+  end
+}
+puts "You're still here?"

data/lib/cromwell.rb

@@ -46,6 +46,15 @@ class Cromwell
       @@should_exit
     end
 
+    # call-seq:
+    #   Cromwell.should_exit = bool
+    #
+    # 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
+    end
+
     # call-seq:
     #   Cromwell.protected?
     #

data/test/test_cromwell.rb

@@ -132,10 +132,18 @@ class TestCromwell < Test::Unit::TestCase
     end
 
     should "terminate if should_exit is true" do
-      Cromwell.send(:class_variable_set, "@@should_exit", true)
+      Cromwell.should_exit = true
       Cromwell.expects(:exit)
       Cromwell.unprotect
     end
   end # method unprotect
 
+  context "should_exit=" do
+    should "prevent script from terminating if set to false" do
+      Cromwell.should_exit = false
+      Cromwell.expects(:exit).never
+      Cromwell.unprotect
+    end
+  end
+  
 end

metadata

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