soft_timeout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6dd318cdb43083bbd0126ee660d0fc9a3bbbe93
+  data.tar.gz: cd3cfaa19f1b9e22d8143e58d5c95b9ef0ec34ec
+SHA512:
+  metadata.gz: 343a01526882dd69c21fe660a2660bb67e145b0acf44de11fedc4e5b4bc255f5ed024ead2faa4117d2466878f6cb036ce44ee83094653aa664509b41902f8ae2
+  data.tar.gz: 27563618cabfbe4379ae3ac93636a04c6db12ea13077162e6d15e5bc568e432898973f23a46ed4aef79da945d43481f6f65fbbba4999820ef15edca6633bf3b9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at abhishek.patel131@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soft_timeout.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Abhishek Patel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# SoftTimeout
+
+SoftTimeout provides feature to set soft expiry time before raising actual Timeout Exception.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soft_timeout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soft_timeout
+
+## Usage
+```ruby
+class MyClass
+  def initialize
+    @continue_running = true
+  end
+
+  def some_important_task
+    timeout = SoftTimeout::Timeout.new(10, 20) do
+      @continue_running = false
+    end
+
+    timeout.soft_timeout do
+      100.times do |n|
+        if @continue_running
+          ...
+          some heavy processing (sleep(2))
+          ...
+        else
+          puts 'soft timeout reached'
+          return
+        end
+      end
+    end
+end
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhi-patel/soft_timeout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "soft_timeout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soft_timeout/version.rb

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

data/lib/soft_timeout.rb

@@ -0,0 +1,94 @@
+require "soft_timeout/version"
+require 'timeout'
+module SoftTimeout
+
+  THIS_FILE = /\A#{Regexp.quote(__FILE__)}:/o
+  CALLER_OFFSET = ((c = caller[0]) && THIS_FILE =~ c) ? 1 : 0
+  private_constant :THIS_FILE, :CALLER_OFFSET
+
+  # require 'soft_timeout'
+  #
+  # timeout = SoftTimeout::Timeout.new(10, 20) do
+  #   puts 'Soft timeout reached'
+  # end
+  #
+  # timeout.soft_timeout do
+  #   ...
+  #   Some code
+  #   ...
+  # end
+  class Timeout
+    attr_accessor :soft_expiry, :hard_expiry, :error_class, :on_soft_timeout
+
+    # Initialize
+    #
+    # +soft_expiry+:: Number of seconds to wait to execute +on_soft_timeout+ block
+    # +hard_expiry+:: Number of seconds to wait before raising Timeout Error
+    # +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)
+      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)
+      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|
+        begin
+          original_thread = Thread.current
+          timeout_thread = Thread.start {
+            begin
+              sleep soft_expiry
+            rescue => e
+              original_thread.raise e
+            else
+              on_soft_timeout.call if on_soft_timeout
+            end
+
+            begin
+              sleep hard_expiry - soft_expiry
+            rescue => e
+              original_thread.raise e
+            else
+              original_thread.raise exception, message
+            end
+          }
+          yield(soft_expiry)
+        ensure
+          if timeout_thread
+            timeout_thread.kill
+            timeout_thread.join # make sure timeout_thread is dead.
+          end
+        end
+      end
+    end
+  end
+
+
+end

data/soft_timeout.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soft_timeout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "soft_timeout"
+  spec.version       = SoftTimeout::VERSION
+  spec.authors       = ["Abhishek Patel"]
+  spec.email         = ["abhishek.patel131@gmail.com"]
+
+  spec.summary       = %q{An escape window before Timeout error hits you}
+  spec.description   = %q{Provides a better way to handle timeouts in ruby.}
+  spec.homepage      = "https://github.com/abhi-patel/soft_timeout"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: soft_timeout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abhishek Patel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides a better way to handle timeouts in ruby.
+email:
+- abhishek.patel131@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soft_timeout.rb
+- lib/soft_timeout/version.rb
+- soft_timeout.gemspec
+homepage: https://github.com/abhi-patel/soft_timeout
+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.5.1
+signing_key: 
+specification_version: 4
+summary: An escape window before Timeout error hits you
+test_files: []