timeouter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f10b6b4a402f7a2eda65f18f71e14bcf5745616a81f7793b9051a1dd3b09501
+  data.tar.gz: 916cb40b55973b7343abdb134ce16f2068828f5dee28a4c9205290b767046ea9
+SHA512:
+  metadata.gz: 716982b408f28ff28d656917e6085c4731a9b57ac3238673997399285315311e96d3ddc2f48c6077f7a61de08808a561a0dc2b264ed184cbe28f48be30e42873
+  data.tar.gz: b89ee00299bf83fb6a7bfb269eff51727e24288346acae5f22dfb9630ad3c3a16576b71c2159e80acfbff8f13696741b206088007192998a40004886aa113de9

data/README.md

@@ -0,0 +1,77 @@
+# Timeouter
+
+Timeouter is advisory timeout helper without any background threads.
+
+# Usage
+
+Typical usage scenario:
+
+```ruby
+require 'timeouter'
+
+Timeouter::run(3) do |t|
+  sleep 1 # do some work
+
+  puts t.elapsed    # 1.00011811
+  puts t.left       # 3.99985717 or nil if timeout was 0
+  puts t.exhausted? # false or nil if timeout was 0
+  puts t.running?   # true
+  puts t.running!   # true
+
+  sleep 3 # do another work
+
+  puts t.elapsed    # 4.000177464
+  puts t.left       # 0 or nil if timeout was 0
+  puts t.exhausted? # true or nil if timeout was 0
+  puts t.running?   # false
+  puts t.running!   # raise Timeouter::TimeoutError.new('execution expired')
+end
+```
+
+You can pass exception class and message on creation or on checking:
+
+```ruby
+Timeouter::run(1, eclass: RuntimeError, emessage: 'error') do |t|
+  sleep 2
+  puts t.running!(eclass: MyError, emessage: 'myerror')
+end
+```
+
+Loop helper:
+
+```ruby
+# just loop 3 seconds
+Timeouter::loop(3) do |t|
+  puts "i'am in loop"
+  sleep 1
+end
+
+# just loop 3 seconds and raise exception then
+Timeouter::loop!(3, eclass: MyError) do |t|
+  puts "i'am in loop and not raised yet"
+  sleep 1
+end
+
+# Break the loop after some success and retuel value
+result = Timeouter::loop!(3) do |t|
+  puts "i'am in loop and not raised yet"
+  if t.elapsed > 1
+    puts "work done breaking loop"
+    break "RESULT"
+  end
+  sleep 1
+end
+```
+
+# Installation
+
+It's a gem:
+```bash
+  gem install timeouter
+```
+There's also the wonders of [the Gemfile](http://bundler.io):
+```ruby
+  gem 'timeouter'
+```
+
+

data/lib/timeouter/timer.rb

@@ -0,0 +1,56 @@
+require 'timeout'
+
+module Timeouter
+  class Timer
+
+    attr_reader :started_at, :exhausted_at
+
+    def initialize(timeout = 0, eclass: Timeouter::TimeoutError, emessage: 'execution expired')
+      # ensure only positive timeouts
+      timeout ||= 0
+      timeout = [timeout, 0].max
+
+      @eclass = eclass
+      @emessage = emessage
+
+      @started_at = Time.now
+      @exhausted_at = timeout > 0 ? @started_at + timeout : nil
+    end
+
+    # elapsed time from creation
+    def elapsed
+      Time.now - @started_at
+    end
+
+    # time left to be exhausted or nil if timeout was 0
+    def left
+      @exhausted_at && [@exhausted_at - Time.now, 0].max
+    end
+
+    # is timeout exhausted? or nil when timeout was 0
+    def exhausted?
+      @exhausted_at && (@exhausted_at < Time.now)
+    end
+
+    # is timeout NOT exhausted? or true when timeout was 0
+    def running?
+      !exhausted?
+    end
+
+    # ensure timeout NOT exhausted raise exception otherwise
+    def running!(eclass = @eclass, message: @emessage)
+      !exhausted? || (raise eclass.new(message))
+    end
+
+    # run block in loop until timeout reached. Use break for returning result
+    def loop
+      yield(self) while self.running?
+    end
+
+    def loop!(eclass = @eclass, message: @emessage)
+      yield(self) while self.running!(eclass, message: message)
+    end
+
+  end
+end
+

data/lib/timeouter/version.rb

@@ -0,0 +1,6 @@
+module Timeouter
+
+  VERSION = '0.1.0'.freeze
+
+end
+

data/lib/timeouter.rb

@@ -0,0 +1,25 @@
+require_relative 'timeouter/timer'
+
+
+module Timeouter
+
+  TimeoutError = Timeout::Error
+
+  class << self
+
+    def run(timeout = 0, eclass: Timeouter::TimeoutError, emessage: 'execution expired')
+      yield(Timeouter::Timer.new(timeout, eclass: eclass, emessage: emessage))
+    end
+
+    def loop(timeout = 0, eclass: Timeouter::TimeoutError, emessage: 'execution expired', &block)
+      Timeouter::Timer.new(timeout, eclass: eclass, emessage: emessage).loop(&block)
+    end
+
+    def loop!(timeout = 0, eclass: Timeouter::TimeoutError, emessage: 'execution expired', &block)
+      Timeouter::Timer.new(timeout, eclass: eclass, emessage: emessage).loop!(&block)
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: timeouter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samoilenko Yuri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Timeouter is advisory timeout helper
+email:
+- kinnalru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/timeouter.rb
+- lib/timeouter/timer.rb
+- lib/timeouter/version.rb
+homepage: https://github.com/RnD-Soft/timeouter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Timeouter is advisory timeout helper
+test_files: []