soft_timeout 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6dd318cdb43083bbd0126ee660d0fc9a3bbbe93
-  data.tar.gz: cd3cfaa19f1b9e22d8143e58d5c95b9ef0ec34ec
+  metadata.gz: 3663665657cf0c578776b56b809c364534d28f1d
+  data.tar.gz: c0b0705764ffef24afe1f2fb0eb8861fba512419
 SHA512:
-  metadata.gz: 343a01526882dd69c21fe660a2660bb67e145b0acf44de11fedc4e5b4bc255f5ed024ead2faa4117d2466878f6cb036ce44ee83094653aa664509b41902f8ae2
-  data.tar.gz: 27563618cabfbe4379ae3ac93636a04c6db12ea13077162e6d15e5bc568e432898973f23a46ed4aef79da945d43481f6f65fbbba4999820ef15edca6633bf3b9
+  metadata.gz: 915aca7255047a1e83eaaaec1d21933d778e7f6ae92ca2bc1c4956e8748f9c06c9e93eeea5c210715deaef4d8db8991b10fff7c0057c459426b1e2f427e49e1f
+  data.tar.gz: b08db2bbd08c9b41bfb82746d9d7e4740d6a22739f36de89db84e659cfa81adba387e4ceacc73e6b009216df3f9bf2e908585620ec32524712975addf6f3da74

data/README.md

@@ -1,6 +1,8 @@
 # SoftTimeout
 
-SoftTimeout provides feature to set soft expiry time before raising actual Timeout Exception.
+SoftTimeout provides feature to set soft expiry time before raising actual Timeout Exception. It allows you to run custom code before raising Timeout::Error. 
+
+Takes soft expiry, hard exipry and a block as argument. Executes the block after soft expiry time(so that you can set flags to start wrapping up. See the example below). Raises Timeout error after hard expiry time seconds(as normal Timout behaviour).
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,20 +27,27 @@ class MyClass
   end
 
   def some_important_task
+    # Soft timeout at 10 sec. and Raise Timeout::Error after 20 sec
     timeout = SoftTimeout::Timeout.new(10, 20) do
+      #This block will be executed after soft expiry time is reached(10 secs here)  
       @continue_running = false
     end
 
+    # Keep checkig if flag is still set to true and then process the chunk. else exit gracefully
+    # It will raise Timeout::Error if following block runs for more than hard expiry time(20 secs)
     timeout.soft_timeout do
-      100.times do |n|
+      10.times do |n|
+        # After soft expiry seconds, the (above)block will be executed and the flag will be set to false.
         if @continue_running
           ...
-          some heavy processing (sleep(2))
+          some heavy but critical processing which should not be interepted in between
           ...
         else
           puts 'soft timeout reached'
+          ..Finish work, release locks etc...
           return
         end
+        
       end
     end
 end

data/lib/soft_timeout.rb

@@ -27,39 +27,19 @@ module SoftTimeout
     # +error_class+:: Exception class to raise
     # +block+:: Proc to be run at end of +soft_expiry+
     #
-    def initialize(soft_expiry, hard_expiry, error_class = ::Timeout::Error, &block)
+    def initialize(soft_expiry, hard_expiry, error_class = nil, &block)
       self.soft_expiry = soft_expiry
       self.hard_expiry = hard_expiry
       self.error_class = error_class
       self.on_soft_timeout = block if block_given?
     end
 
-    def soft_timeout(&block)
+    def soft_timeout
       return yield(soft_expiry) if soft_expiry == nil || soft_expiry < 0 || hard_expiry == nil || hard_expiry < 0 || hard_expiry <= soft_expiry
-      run_proc_with_error_handling(build_timeout_proc(&block))
-    end
-
-    #nodoc
-    def run_proc_with_error_handling(timeout_proc)
       message = "execution expired".freeze
-      begin
-        return timeout_proc.call(error_class)
-      rescue error_class => e
-        bt = e.backtrace
-      end
 
-      level = -caller(CALLER_OFFSET).size - 1
-      while THIS_FILE =~ bt[level]
-        bt.delete_at(level)
-      end
-      raise(error_class, message, bt)
-    end
-
-    #nodoc
-    def build_timeout_proc
-      message = "execution expired".freeze
-
-      proc do |exception|
+      e = ::Timeout::Error
+      bl = proc do |exception|
         begin
           original_thread = Thread.current
           timeout_thread = Thread.start {
@@ -79,7 +59,7 @@ module SoftTimeout
               original_thread.raise exception, message
             end
           }
-          yield(soft_expiry)
+          return yield(soft_expiry)
         ensure
           if timeout_thread
             timeout_thread.kill
@@ -87,8 +67,25 @@ module SoftTimeout
           end
         end
       end
-    end
-  end
+
+      # Why this strange Error catch and all. checkout http://stackoverflow.com/questions/35447230/ruby-timeout-behaves-differently-between-2-0-and-2-1
+      if error_class
+        begin
+          bl.call(error_class)
+        rescue error_class => l
+          bt = l.backtrace
+        end
+      else
+        bt = ::Timeout::Error.catch(message, &bl)
+      end
 
 
+      level = -caller(CALLER_OFFSET).size-2
+      while THIS_FILE =~ bt[level]
+        bt.delete_at(level)
+      end
+      raise(e, message, bt)
+    end
+
+  end
 end

data/lib/soft_timeout/version.rb

@@ -1,3 +1,3 @@
 module SoftTimeout
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soft_timeout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Abhishek Patel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler