simple_timeout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9c4d635e206f6ea8a80a54447edbb3c233155ad
+  data.tar.gz: 4199f3c59fab78b2e718cb7e1a014cd04a823787
+SHA512:
+  metadata.gz: 8f1d6da8fe70ff826797553618a231b7ae6c02d2020b59028941784e9b8ba8039e568bf15a4defd0b15feb4b61051d292efcd386d9c2bdf917ef2f014ecfcb9c
+  data.tar.gz: a37bb78b1b74a8cafff326f04f49a4caaeab2415de108168dc2033985e9627b9e4c09576df69d86bc9bca9647d0956d5dbdb60c40c7d622de485aa1e001aec28

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.3
+gemfile:
+  - Gemfile
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+MIT License
+
+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,58 @@
+# Simple Timeout
+
+A simple implementation of Timeout.
+
+The standard `Timeout::timeout` will always wait until the block finishes execution, and then, when the thread where the block is been executed can't be killed for some reason, your whole program get blocked. `SimpleTimeout::timeout` lets you choose if you want to wait for the block to finish execution or not. By default it won't wait.
+
+## Usage
+
+Basic usage:
+
+```ruby
+SimpleTimeout::Timeout(5) do
+  # Some code that should not take more than 5 seconds
+end
+```
+
+## Options
+
+`SimpleTimeout::timeout` receives 4 parameters:
+
+```ruby
+def self.timeout(seconds,timeout_error_class=SimpleTimeout::Error,wait_for_block=false,&block)
+  # the implementation ...
+end
+```
+
+* **seconds:** How much seconds to wait before raise `timeout_error_class`.
+* **timeout_error_class:** The error to raise in case of timeout.
+* **wait_for_block:** This one is the main reason for me to implement this gem. The standard `Timeout::timeout` will always wait until the block finishes execution, and then, when the thread where the block is been executed can't be killed for some reason, your whole program get blocked. `SimpleTimeout::timeout` lets you choose if you want to wait for the block to finish execution or not. By default it won't wait.
+* **block:** The block to execute.
+
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'simple_timeout'
+```
+sadfasdf
+And then execute:
+
+```sh
+bundle
+```
+asdasdf
+## History
+
+View the [changelog](https://github.com/simon0191/simple_timeout/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/simon0191/simple_timeout/issues)
+- Fix bugs and [submit pull requests](https://github.com/simon0191/simple_timeout/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/simple_timeout.rb

@@ -0,0 +1,85 @@
+module SimpleTimeout
+  def self.timeout(seconds,timeout_error_class=SimpleTimeout::Error,wait_for_block=false,&block)
+    if seconds == 0
+      raise timeout_error_class.new, "execution expired"
+    end
+
+    if seconds.nil? || !seconds.is_a?(Numeric) || seconds < 0
+      raise ArgumentError.new, "seconds must be an Integer number greater or equal to 0"
+    end
+
+    if block_given?
+      control = SimpleTimeout::Control.new(seconds,timeout_error_class)
+
+      block_thread = build_block_thread(control,&block)
+
+      timeout_thread = build_timeout_thread(control)
+
+      while control.status == :waiting;end
+      
+      timeout_thread.kill if timeout_thread.alive?
+      block_thread.kill if block_thread.alive?
+
+      if wait_for_block
+        block_thread.join
+      end
+
+      handle_control_status control
+
+    end
+  end
+
+  class Error < ::StandardError; end
+
+  private
+
+    class Control
+      attr_accessor :mutex,:status,:result,:error,:timeout_in_seconds,:timeout_error_class
+      def initialize(timeout_in_seconds,timeout_error_class)
+        self.timeout_in_seconds = timeout_in_seconds
+        self.timeout_error_class = timeout_error_class
+        self.status = :waiting
+        self.mutex = Mutex.new
+        self.result = nil
+        self.error = nil
+      end
+    end
+
+    def self.build_block_thread(control,&block)
+      Thread.new(control) do |control|
+        begin
+          control.result = block.call
+        rescue Exception => e
+          control.error = e
+        end
+        control.mutex.synchronize do
+          if control.status == :waiting
+            control.status = :finished
+          end
+        end
+      end
+    end
+
+    def self.build_timeout_thread(control)
+      Thread.new(control) do |control|
+        sleep(control.timeout_in_seconds)
+        control.mutex.synchronize do
+          if control.status == :waiting
+            control.status = :timeout
+          end
+        end
+      end
+    end
+
+    def self.handle_control_status(control)
+      if control.status == :finished
+        if control.error.nil?
+          return control.result
+        else
+          raise control.error.class.new, control.error.message
+        end
+      else
+        raise control.timeout_error_class.new, "execution expired"
+      end
+    end
+end

data/lib/simple_timeout/version.rb

@@ -0,0 +1,3 @@
+module SimpleTimeout
+  VERSION = "0.0.1"
+end

data/simple_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 "simple_timeout/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_timeout"
+  spec.version       = SimpleTimeout::VERSION
+  spec.authors       = ["Simon Soriano"]
+  spec.email         = ["simon0191@gmail.com"]
+  spec.summary       = "A simple implementation of timeout"
+  spec.description   = "A simple implementation of timeout"
+  spec.homepage      = "https://github.com/simon0191/simple_timeout"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+end

data/spec/simple_timeout_spec.rb

@@ -0,0 +1,111 @@
+require_relative "spec_helper"
+
+RSpec.describe SimpleTimeout do
+
+  let(:small_timeout) { 0.1 }
+  let(:medium_timeout) { 0.4 }
+  let(:big_timeout) { 1 }
+
+  describe "#timeout" do
+    context "0 seconds" do
+      it "should raise a SimpleTimeout::Error" do
+        expect {SimpleTimeout.timeout(0)}.to raise_error(SimpleTimeout::Error)
+      end
+    end
+    context "negative seconds" do
+      it "should raise an ArgumentError" do
+        expect {SimpleTimeout.timeout(-1)}.to raise_error(ArgumentError)
+      end
+    end
+    context "nil seconds" do
+      it "should raise an ArgumentError" do
+        expect {SimpleTimeout.timeout(nil)}.to raise_error(ArgumentError)
+      end
+    end
+    context "non Integer seconds" do
+      it "should raise an ArgumentError" do
+        expect {SimpleTimeout.timeout( {} )}.to raise_error(ArgumentError)
+      end
+    end
+    context "block is not given" do
+      it "should return nil" do
+        expect(SimpleTimeout.timeout(small_timeout)).to be_nil
+      end
+    end
+    context "block raise an Error" do
+      it "should raise the Error" do
+        class SomeError < StandardError;end
+        message = "Some message"
+        expect do
+          SimpleTimeout.timeout(big_timeout) { raise SomeError.new(message) }
+        end.to raise_error(SomeError,message)
+      end
+    end
+    context "block execution takes more time than timeout" do
+      it "should kill block thread" do
+        thread_spy = spy('thread')
+        allow(SimpleTimeout).to receive(:build_block_thread).and_return(thread_spy)
+        begin
+          SimpleTimeout.timeout(small_timeout) {  }
+          fail
+        rescue SimpleTimeout::Error => e
+          expect(thread_spy).to have_received(:kill)
+        end
+      end
+
+      it "should raise SimpleTimeout::Error" do
+        expect do
+          SimpleTimeout.timeout(small_timeout) { sleep(big_timeout) }
+        end.to raise_error(SimpleTimeout::Error)
+      end
+
+      context "and is given a custom error class" do
+        it "should raise SimpleTimeout::Error" do
+          class SomeError < StandardError;end
+          expect do
+            SimpleTimeout.timeout(small_timeout,SomeError) { sleep(big_timeout) }
+          end.to raise_error(SomeError)
+        end
+      end
+
+      context "and block execution can't be killed" do
+        it "should finish and raise SimpleTimeout::Error" do
+          thread_stub = Thread.new { while true; end }
+          allow(SimpleTimeout).to receive(:build_block_thread).and_return(thread_stub)
+          allow(thread_stub).to receive(:kill).and_return(nil)
+          expect{ SimpleTimeout.timeout(small_timeout) {  } }.to raise_error(SimpleTimeout::Error)
+        end
+
+        context "and wait_for_block is true" do
+          it "should wait until the block finishes execution" do
+            thread_spy = spy('thread')
+            allow(SimpleTimeout).to receive(:build_block_thread).and_return(thread_spy)
+
+            expect{
+              SimpleTimeout.timeout(small_timeout,SimpleTimeout::Error,true) {  }
+            }.to raise_error(SimpleTimeout::Error)
+            
+            expect(thread_spy).to have_received(:join)
+          end
+        end
+      end
+
+
+    end
+    context "block execution finishes before timeout" do
+      it "should return what the block returned" do
+        expected_return = "Expected return value"
+        expect(
+          SimpleTimeout.timeout(big_timeout,SomeError) { expected_return }
+        ).to eq expected_return
+      end
+      it "should kill timeout thread" do
+        thread_spy = spy('thread')
+        allow(SimpleTimeout).to receive(:build_timeout_thread).and_return(thread_spy)
+        SimpleTimeout.timeout(small_timeout) {  }
+        expect(thread_spy).to have_received(:kill)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "rspec"
+require "byebug"
+
+RSpec.configure do |config|
+  config.color = true
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: simple_timeout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Simon Soriano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: byebug
+  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: A simple implementation of timeout
+email:
+- simon0191@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_timeout.rb
+- lib/simple_timeout/version.rb
+- simple_timeout.gemspec
+- spec/simple_timeout_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simon0191/simple_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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple implementation of timeout
+test_files:
+- spec/simple_timeout_spec.rb
+- spec/spec_helper.rb