execution_deadline 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26752e57bfd495b67049f6e31c7a5e22c7328d725a9e3495bc386a83245fd048
-  data.tar.gz: 2935a78236bbc642be49b0d25762683de050d894899e94ea15ff6808d83caa85
+  metadata.gz: 7ce574cf89fbb0b9cf89f8fc2df628aa171e89eef75b85f4e3ef5e3fcc5a8cd5
+  data.tar.gz: b1d29c6a81aae730323444e6a302262239d72df16652fd2a592a4f3ea99f1662
 SHA512:
-  metadata.gz: b46c4316e81573501116f7f66a82a95fef09d9461b147b10adf1804954f197f9f343b7a3d157cc63f25e2b1b6406f3d4cabfa863204acef449fd904e8bb8bf47
-  data.tar.gz: ba245b71d80da4eb4cb47e91f70b4973af7cd681053cc3887cb7e321e005d2b81d0cd60ef357126e75c93143e1fbfd7d5305730eb9033d67a5f8a7050fe04dc6
+  metadata.gz: 5a1ea9cc41b1c35c2f72e7cdd2e467b6e3adb9cce912e118f214f4bbf8592bbea623a711440566bcee4a786418476df19f6513473074f0d2f3b536f9a2c78211
+  data.tar.gz: 6bb2ccd7d1d27195ed3782074a2f42872777776e26c50d2423362741626740c27f42c5d9fe298b159166c18f542f95ba122385533cd45cf9401026e86f82986b

data/README.md

@@ -139,6 +139,23 @@ end
 SlowModule.perform # Throws OutOfTime error
 ```
 
+### Method interruption
+Ruby's Timeout module is a bit heavy handed and could terminate operations at any point in your code flow. This gem
+is an attempt at marking interruption points at the start and end of slow methods. It should always be preferred to
+use a more graceful method, but sometimes a hammer is called for.
+
+If you declare a deadline with `interruptible: true`. Ruby's Timeout module will be wrapped around your method set to
+timeout at the remaining deadline time. The error will be replaced with the value of `raises` or the built in classes.
+
+#### Example
+```
+deadline runs_for: 0.6, interruptible: true
+def self.sub_method_1
+  sleep 0.7
+end
+```
+
+
 ### Raised Errors
 `ExecutionDeadline::OutOfTime` - Raised when a deadlined method is called but
   there is less time left then the expected runtime.

data/lib/execution_deadline/deadliner.rb

@@ -1,3 +1,5 @@
+require 'timeout'
+
 module ExecutionDeadline
   module Deadliner
     WRAPPED_METHOD = Proc.new do |options|
@@ -7,10 +9,21 @@ module ExecutionDeadline
           raises: options[:raises]
         )
 
-        ExecutionDeadline.current_deadline&.require_seconds_left!(options[:runs_for]) if options[:runs_for]
-        super(*args, **kwargs, &blk).tap do
-          ExecutionDeadline.current_deadline&.check_deadline_expiration!
+        current_deadline = ExecutionDeadline.current_deadline
+        current_deadline&.require_seconds_left!(options[:runs_for]) if options[:runs_for]
+
+        result = if !options[:interruptible]
+          super(*args, **kwargs, &blk)
+        else
+          Timeout.timeout(current_deadline&.time_left) do
+            super(*args, **kwargs, &blk)
+          rescue => Timeout::Error
+          end
         end
+
+        current_deadline&.check_deadline_expiration!
+
+        result
       ensure
         ExecutionDeadline.clear_deadline! if set_deadline
       end

data/lib/execution_deadline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExecutionDeadline
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: execution_deadline
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Malinconico
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage code deadlines without the hard termination of Timeout