rubysl-timeout 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b851871d6cc5edc12c12c5eaf71d61ae588974
+  data.tar.gz: e020b5101fec9ef7b1692af8f44cb513fecd16c7
+SHA512:
+  metadata.gz: 303a74f5e6adc5233db9debee9464699a252579c6833fe02060615895c871c1771d28a015df50cbe54f8498fd4fa4a5a66e4cb21746910fd9316d13079674892
+  data.tar.gz: c54bc54eb6981cd0822b4de838eae00aae68564200beaefba0b25d6c369564f34fadf47b6ba408755893d262d0be66a4b49d86b78eb31a6c3bb5f5617d4a2f81

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,7 @@
+language: ruby
+env:
+  - RUBYLIB=lib
+script: bundle exec mspec
+rvm:
+  - 1.8.7
+  - rbx-nightly-18mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2013, Brian Shirai
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the library nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+# Rubysl::Timeout
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubysl-timeout'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysl-timeout
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rubysl/timeout.rb

@@ -0,0 +1,2 @@
+require "rubysl/timeout/version"
+require "rubysl/timeout/timeout"

data/lib/rubysl/timeout/timeout.rb

@@ -0,0 +1,197 @@
+#--
+# = timeout.rb
+#
+# execution timeout
+#
+# = Copyright
+#
+# Copyright - (C) 2008  Evan Phoenix
+# Copyright:: (C) 2000  Network Applied Communication Laboratory, Inc.
+# Copyright:: (C) 2000  Information-technology Promotion Agency, Japan
+#
+#++
+#
+# = Description
+#
+# A way of performing a potentially long-running operation in a thread, and
+# terminating it's execution if it hasn't finished within fixed amount of
+# time.
+#
+# Previous versions of timeout didn't use a module for namespace. This version
+# provides both Timeout.timeout, and a backwards-compatible #timeout.
+#
+# = Synopsis
+#
+#   require 'timeout'
+#   status = Timeout::timeout(5) {
+#     # Something that should be interrupted if it takes too much time...
+#   }
+#
+
+require 'thread'
+
+module Timeout
+
+  ##
+  # Raised by Timeout#timeout when the block times out.
+
+  class Error < Interrupt
+  end
+
+  # A mutex to protect @requests
+  @mutex = Mutex.new
+
+  # All the outstanding TimeoutRequests
+  @requests = []
+
+  # Represents +thr+ asking for it to be timeout at in +secs+
+  # seconds. At timeout, raise +exc+.
+  class TimeoutRequest
+    def initialize(secs, thr, exc)
+      @left = secs
+      @thread = thr
+      @exception = exc
+    end
+
+    attr_reader :thread, :left
+
+    # Called because +time+ seconds have gone by. Returns
+    # true if the request has no more time left to run.
+    def elapsed(time)
+      @left -= time
+      @left <= 0
+    end
+
+    # Raise @exception if @thread.
+    def cancel
+      if @thread and @thread.alive?
+        @thread.raise @exception, "execution expired"
+      end
+
+      @left = 0
+    end
+
+    # Abort this request, ie, we don't care about tracking
+    # the thread anymore.
+    def abort
+      @thread = nil
+      @left = 0
+    end
+  end
+
+  @chan = Rubinius::Channel.new
+
+  def self.watch_channel
+    reqs = []
+
+    while true
+      begin
+        while reqs.empty?
+          req = @chan.receive
+          reqs << req if req
+        end
+
+        min = reqs.min { |a,b| a.left <=> b.left }
+        new_req = nil
+
+        if min.left > 0
+          before = Time.now
+
+          new_req = @chan.receive_timeout(min.left)
+
+          slept_for = Time.now - before
+        else
+          slept_for = 0
+        end
+
+        reqs.delete_if do |r|
+          if r.elapsed(slept_for)
+            r.cancel
+            true
+          else
+            false
+          end
+        end
+        reqs << new_req if new_req
+
+      rescue Exception => e
+        e.render("ERROR IN TIMEOUT THREAD")
+      end
+    end
+  end
+
+  # Spin up the thread up front to avoid a thread collision problem spinning
+  # it up lazily.
+  @controller = Thread.new { watch_channel }
+
+  def self.add_timeout(time, exc)
+    r = TimeoutRequest.new(time, Thread.current, exc)
+    @chan << r
+    return r
+  end
+
+  ##
+  # Executes the method's block. If the block execution terminates before +sec+
+  # seconds has passed, it returns true. If not, it terminates the execution
+  # and raises +exception+ (which defaults to Timeout::Error).
+  #
+  # Note that this is both a method of module Timeout, so you can 'include
+  # Timeout' into your classes so they have a #timeout method, as well as a
+  # module method, so you can call it directly as Timeout.timeout().
+
+  def timeout(sec, exception=Error)
+    return yield if sec == nil or sec.zero?
+    raise ThreadError, "timeout within critical session" if Thread.respond_to?(:critical) && Thread.critical
+
+    req = Timeout.add_timeout sec, exception
+
+    begin
+      yield sec
+    ensure
+      req.abort
+    end
+  end
+
+  module_function :timeout
+
+end
+
+##
+# Identical to:
+#
+#   Timeout::timeout(n, e, &block).
+#
+# Defined for backwards compatibility with earlier versions of timeout.rb, see
+# Timeout#timeout.
+
+def timeout(n, e=Timeout::Error, &block) # :nodoc:
+  Timeout.timeout(n, e, &block)
+end
+
+##
+# Another name for Timeout::Error, defined for backwards compatibility with
+# earlier versions of timeout.rb.
+
+TimeoutError = Timeout::Error # :nodoc:
+
+if __FILE__ == $0
+  p timeout(5) {
+    45
+  }
+  p timeout(5, TimeoutError) {
+    45
+  }
+  p timeout(nil) {
+    54
+  }
+  p timeout(0) {
+    54
+  }
+  p timeout(5) {
+    loop {
+      p 10
+      sleep 1
+    }
+  }
+end
+

data/lib/rubysl/timeout/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module Timeout
+    VERSION = "1.0.0"
+  end
+end

data/lib/timeout.rb

@@ -0,0 +1 @@
+require "rubysl/timeout"

data/rubysl-timeout.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+require './lib/rubysl/timeout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-timeout"
+  spec.version       = RubySL::Timeout::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library timeout.}
+  spec.summary       = %q{Ruby standard library timeout.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-timeout"
+  spec.license       = "BSD"
+
+  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", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+end

data/spec/error_spec.rb

@@ -0,0 +1,15 @@
+require 'timeout'
+
+describe "Timeout::Error" do
+  ruby_version_is ""..."1.9" do
+    it "is a subclass of Interrupt" do
+      Interrupt.should be_ancestor_of(Timeout::Error)
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "is a subclass of RuntimeError" do
+      RuntimeError.should be_ancestor_of(Timeout::Error)
+    end
+  end
+end

data/spec/timeout_spec.rb

@@ -0,0 +1,36 @@
+require 'timeout'
+
+describe "Timeout.timeout" do
+  it "raises Timeout::Error when it times out with no specified error type" do
+    lambda {
+      Timeout.timeout(1) do
+        sleep 3
+      end
+    }.should raise_error(Timeout::Error)
+  end
+
+  it "raises specified error type when it times out" do
+    lambda do
+      Timeout.timeout(1, StandardError) do
+        sleep 3
+      end
+    end.should raise_error(StandardError)
+  end
+
+  it "does not wait too long" do
+    before_time = Time.now
+    lambda do
+      Timeout.timeout(1, StandardError) do
+        sleep 3
+      end
+    end.should raise_error(StandardError)
+
+    Time.now.to_f.should be_close(before_time.to_f, 1.2)
+  end
+
+  it "returns back the last value in the block" do
+    Timeout.timeout(1) do
+      42
+    end.should == 42
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: rubysl-timeout
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Shirai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 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: '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: mspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Ruby standard library timeout.
+email:
+- brixen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rubysl/timeout.rb
+- lib/rubysl/timeout/timeout.rb
+- lib/rubysl/timeout/version.rb
+- lib/timeout.rb
+- rubysl-timeout.gemspec
+- spec/error_spec.rb
+- spec/timeout_spec.rb
+homepage: https://github.com/rubysl/rubysl-timeout
+licenses:
+- BSD
+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.7
+signing_key: 
+specification_version: 4
+summary: Ruby standard library timeout.
+test_files:
+- spec/error_spec.rb
+- spec/timeout_spec.rb