timeout-extensions 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ad2130b411b304b307f17a4db55b4c034ff84ff
+  data.tar.gz: 0566ffbb332db2b4bdf1862474a97f9ec5d6a451
+SHA512:
+  metadata.gz: 61f6d8bb54f5b00b49e14847bce4d219f26faf76fd6854bcfec4e1fe9fab30b747504ebd2411720c680ee940612bca3e1a766d46b8cd1e080d390cb61872c3cd
+  data.tar.gz: 2bf51f1671ebcea3dd664d40141e07ed9a541a3c16a3bf9001a35158bf274efd8a1bc86c15043a8f000396606acf94707ee5ba9725e11da027cf3ce642cb2d03

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tony Arcieri
+
+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,84 @@
+Timeout::Extensions
+===================
+
+The Timeout::Extensions Gem augments Ruby's `timeout.rb` API with support for
+multiple timeout backends which can be mixed and matched within a single app.
+
+It supports pluggable timeout implementations which can selectively hook
+into multiple backend schedulers rather than resorting to running code in a
+separate thread to implement timeouts when there's a better backend available.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'timeout-extensions'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timeout-extensions
+
+## Usage
+
+The Timeout::Extensions gem enhances the Ruby standard library's
+`timeout.rb` API:
+
+```ruby
+require 'timeout/extensions'
+
+Timeout.new(30) do
+  # Times out after 30 seconds raising Timeout::Error
+end
+```
+
+However, where `timeout.rb` provides one implementation, the Timeout Gem
+provides support for multiple, swappable backends:
+
+```ruby
+require 'timeout/extensions'
+
+module MyTimeoutThingy
+  # WARNING: don't use this. It's just a strawman example
+  def self.timeout(secs)
+    current = Thread.current
+    sleeper = Thread.start do
+      begin
+        sleep secs
+      rescue => ex
+        current.raise ex
+      else
+        current.raise Timeout::Error, "execution expired" 
+      end
+    end
+    return yield(secs)
+  ensure
+    if sleeper
+      sleeper.kill
+      sleeper.join
+    end
+  end
+end
+
+Timeout.backend(MyTimeoutThingy) do
+  Timeout.new(30) do
+    # Manage timeouts with MyTimeoutThingy instead of timeout.rb
+    # Plug in your own backend just this easily!
+  end
+end
+```
+
+# Contributing
+
+* Fork this repository on github
+* Make your changes and send us a pull request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access
+
+# License
+
+Copyright (c) 2014-2015 Tony Arcieri, Tiago Cardoso
+Distributed under the MIT License. See LICENSE.txt for further details.

data/Rakefile

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

data/lib/timeout/extensions.rb

@@ -0,0 +1,45 @@
+require 'timeout/extensions/version'
+
+class Thread
+  attr_accessor :timeout_handler
+  attr_accessor :sleep_handler
+end
+
+module Timeout::Extensions
+  def self.extended(mod)
+    mod.singleton_class.class_eval do
+      alias_method :timeout_without_handler, :timeout
+      alias_method :timeout, :timeout_with_handler
+    end
+  end
+
+  def timeout_with_handler(*args, &block)
+    if timeout_handler = Thread.current.timeout_handler
+      timeout_handler.call(*args, &block)
+    else
+      timeout_without_handler(*args, &block)
+    end
+  end
+  module_function :timeout_with_handler
+  public :timeout_with_handler
+end
+
+module Kernel::Extensions
+  def self.included(mod)
+    mod.class_eval do
+      alias_method :sleep_without_handler, :sleep
+      alias_method :sleep, :sleep_with_handler
+    end
+  end
+
+  def sleep_with_handler(*args)
+    if sleep_handler = Thread.current.sleep_handler
+      sleep_handler.call(*args)
+    else
+      sleep_without_handler(*args)
+    end
+  end
+end
+
+Timeout.extend Timeout::Extensions
+include Kernel::Extensions

data/lib/timeout/extensions/version.rb

@@ -0,0 +1,3 @@
+module Timeout::Extensions
+  VERSION = "0.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'logger'
+require 'timeout'
+require 'timeout/extensions'
+require 'celluloid/autostart'
+require 'celluloid/rspec'
+
+logfile = File.open(File.expand_path("../../log/test.log", __FILE__), 'a')
+logfile.sync = true
+
+logger = Celluloid.logger = Logger.new(logfile)
+
+Celluloid.shutdown_timeout = 1 
+
+
+class Celluloid::Actor
+  # Important that these two are left out, or else
+  # timeout calls inside the actor scope will never propagate
+  # to the proper extensions
+  # TODO: eventually remove this if celluloid adopts the gem
+  undef_method :timeout if instance_methods(false).include?(:timeout)
+  undef_method :sleep if instance_methods(false).include?(:sleep)
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before do
+    Celluloid.logger = logger
+    if Celluloid.running?
+      Celluloid.shutdown
+      sleep 0.01
+      Celluloid.internal_pool.assert_inactive
+    end
+
+    Celluloid.boot
+
+    FileUtils.rm("/tmp/cell_sock") if File.exist?("/tmp/cell_sock")
+    include Timeout::Extensions
+  end
+
+  config.order = 'random'
+end
+
+class ExampleActor
+  include Celluloid
+  execute_block_on_receiver :wrap
+
+  def wrap
+    yield
+  end
+end
+
+def within_actor(&block)
+  actor = ExampleActor.new
+  actor.wrap(&block)
+ensure
+  actor.terminate if actor and actor.alive?
+end
+
+

data/spec/timeout/extensions_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Timeout::Extensions do
+  describe "timeout" do
+    let(:dummy_timeout) { double(:meta_timeout) }
+    let(:exception) { double(:exception) }
+    let(:action) { Proc.new{ |t|  } }
+    context "inside and outside of actor" do
+      it "hits the proper timeout handler" do
+        within_actor do
+          Thread.current.timeout_handler = dummy_timeout
+          expect(dummy_timeout).to receive(:call).with(2, exception, &action)
+          timeout(2, exception, &action)
+        end
+        expect(Timeout).to receive(:timeout_without_handler)
+        timeout(2, exception, &action)
+      end
+    end
+  end
+
+  describe "sleep" do
+    let(:dummy_sleep) { double(:meta_sleep) }
+    context "inside and outside of actor" do
+      it "hits the proper sleep handler" do
+        within_actor do
+          Thread.current.sleep_handler = dummy_sleep
+          expect(dummy_sleep).to receive(:call).with(2)
+          sleep(2)
+        end
+        expect(self).to receive(:sleep_without_handler)
+        sleep(2)
+      end
+    end
+  end 
+end

data/timeout-extensions.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'timeout/extensions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "timeout-extensions"
+  spec.version       = Timeout::Extensions::VERSION
+  spec.authors       = ["Tony Arcieri", "Tiago Cardoso"]
+  spec.email         = ["bascule@gmail.com"]
+  spec.summary       = "Extensions to the Ruby standard library's timeout API"
+  spec.description   = "A timeout extension for Ruby which plugs into multiple timeout backends"
+  spec.homepage      = "https://github.com/celluloid/timeout-extensions"
+  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 "rake", 		"~> 10.4.2"
+  spec.add_development_dependency "pry",		"~> 0.10.1"
+  spec.add_development_dependency "rspec", 	 	"~> 2.14.0"
+  spec.add_development_dependency "celluloid",  ">= 0.16.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: timeout-extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tony Arcieri
+- Tiago Cardoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: A timeout extension for Ruby which plugs into multiple timeout backends
+email:
+- bascule@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/timeout/extensions.rb
+- lib/timeout/extensions/version.rb
+- log/.gitkeep
+- spec/spec_helper.rb
+- spec/timeout/extensions_spec.rb
+- timeout-extensions.gemspec
+homepage: https://github.com/celluloid/timeout-extensions
+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.5
+signing_key: 
+specification_version: 4
+summary: Extensions to the Ruby standard library's timeout API
+test_files:
+- spec/spec_helper.rb
+- spec/timeout/extensions_spec.rb