rolling_timeout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab0add27f838cf73a1d0a0708e3957cc3c5a266e
+  data.tar.gz: b1ed033e339c193b0fc4a9ac5d6514c1003b5d21
+SHA512:
+  metadata.gz: 523cfe37628ebfe04a0af7648bcffbe88d677fc879469053d8e9cd4bbaf3e770c89c40d59046e3d415f1e97eae4edd7039519dccd005aa74e66328b5f4f99db6
+  data.tar.gz: a5d0bd06b8096ac4681c1b922e91ea500807b76e26f7786bf60a391b5f5dc71eefcc657cdb4503753279ac2941a63f8b9d54dab6f3ee76965d0ba93147fef29b

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Will Jessop
+
+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,59 @@
+# RollingTimeout
+
+A timeout class with a rolling window. Call reset to reset the timer back to 0, stop and start do what you might expect.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+		gem 'rolling_timeout'
+
+And then execute:
+
+		$ bundle
+
+Or install it yourself as:
+
+		$ gem install rolling_timeout
+
+## Usage
+
+````ruby
+require 'rolling_timeout'
+
+begin
+	RollingTimeout.new(1) {|timer| # 1 second timeout
+		sleep(0.9)
+		timer.reset # Back to 1 second on the timeout clock
+		sleep(0.9)
+		timer.stop  # The timer is stopped, we can do what we want for as long as we want
+		sleep(0.2)  # This would have taken us over the 1 second timeout if the timer was running
+		timer.start # restart the timer
+		sleep(100)  # This will now timeout quickly
+	}
+rescue Timeout::Error
+	puts "Timed out"
+end
+````
+
+## Requirements
+
+Works with ruby 2.0, probably 1.9.3 too. 1.8.7 YMMV.
+
+## Issues
+
+It's probably not a very accurate (relatively speaking) timer. How the VM schedules the code after the timer thread wakes up will affect how long after the actual time limit expires that the code thread is stopped and an exception raised. Also, if the code finishes at the same time the timeout thread wakes up it's a race to return.
+
+That said, this was accurate enough for my needs. If you need something more accurate please feel free to submit a patch.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Author
+
+* Will Jessop (will@willj.net)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << "test"
+end
+
+task :default => :test

data/examples/example.rb

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.basename(__FILE__), "../lib")
+require 'rolling_timeout'
+
+begin
+	RollingTimeout.new(1) {|timer|
+		sleep(0.5)
+		puts "slept for 0.5 seconds"
+		timer.reset
+		sleep(0.5)
+		puts "slept for 0.5 seconds"
+		timer.reset
+		sleep(0.5)
+		puts "slept for 0.5 seconds"
+		timer.reset
+		sleep(0.5)
+		puts "Slept for 0.5 seconds, 2 total, will now timeout."
+		sleep(100)
+	}
+rescue Timeout::Error
+	puts "Timed out"
+end

data/lib/rolling_timeout.rb

@@ -0,0 +1,39 @@
+require "rolling_timeout/version"
+require 'timeout'
+require 'thread'
+ 
+class RollingTimeout
+	def initialize(time_in_seconds, &block)
+		@time_in_seconds = time_in_seconds
+		start
+		@timed_out = false
+		@code_thread = Thread.new{ yield self }
+		@code_thread.join
+		@timer_thread.join if @timed_out
+
+	end
+
+	def reset
+		stop
+		start
+	end
+
+	def stop
+		@timer_thread.kill
+	end
+
+	def start
+		@timer_thread = new_timer_thread
+	end
+
+	private
+
+	def new_timer_thread
+		Thread.new {
+			sleep(@time_in_seconds)
+			@timed_out = true
+			@code_thread.kill
+			raise Timeout::Error
+		}
+	end
+end

data/lib/rolling_timeout/version.rb

@@ -0,0 +1,3 @@
+class RollingTimeout
+	VERSION = "0.0.1"
+end

data/rolling_timeout.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rolling_timeout/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "rolling_timeout"
+	spec.version       = RollingTimeout::VERSION
+	spec.authors       = ["Will Jessop"]
+	spec.email         = ["will@willj.net"]
+	spec.description   = %q{a timeout with a rolling window that can be moved forward}
+	spec.summary       = %q{a timeout with a rolling window that can be moved forward}
+	spec.homepage      = "https://github.com/wjessop/rolling_timeout"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	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.3"
+	spec.add_development_dependency "rake"
+	spec.add_development_dependency "minitest"
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rolling_timeout'
+
+require 'minitest/autorun'

data/test/test_rolling_timeout.rb

@@ -0,0 +1,57 @@
+require 'minitest_helper'
+
+class TestRollingTimeout < MiniTest::Unit::TestCase
+	def test_that_it_has_a_version_number
+		refute_nil ::RollingTimeout::VERSION
+	end
+
+	def test_it_times_out
+		assert_raises(Timeout::Error) {
+			RollingTimeout.new(0.001) {|timer|
+				sleep(0.002)
+			}
+		}
+	end
+
+	def test_it_completes_with_no_timeout_when_code_completes_within_time_limit
+		marker = false
+		RollingTimeout.new(0.001) {|timer|
+			marker = true
+		}
+		assert(marker)
+	end
+
+	def test_it_rolls_the_timeout_window
+		marker = false
+    RollingTimeout.new(0.003) {|timer|
+			sleep(0.002)
+			timer.reset
+			sleep(0.002)
+			# Now outside the original timeout window
+			marker = true
+		}
+		assert(marker)
+	end
+
+	def test_timer_stop
+		marker = false
+		RollingTimeout.new(0.001) {|timer|
+			timer.stop
+			sleep(0.002)
+			# Now outside the original timeout window
+			timer.start
+			marker = true
+		}
+		assert(marker)
+	end
+
+	def test_timer_start
+		assert_raises(Timeout::Error) {
+			RollingTimeout.new(0.001) {|timer|
+				timer.stop
+				timer.start
+				sleep(0.002)
+			}
+		}
+	end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: rolling_timeout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Jessop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  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 timeout with a rolling window that can be moved forward
+email:
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/example.rb
+- lib/rolling_timeout.rb
+- lib/rolling_timeout/version.rb
+- rolling_timeout.gemspec
+- test/minitest_helper.rb
+- test/test_rolling_timeout.rb
+homepage: https://github.com/wjessop/rolling_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.0.5
+signing_key: 
+specification_version: 4
+summary: a timeout with a rolling window that can be moved forward
+test_files:
+- test/minitest_helper.rb
+- test/test_rolling_timeout.rb