timeout-extensions 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ad2130b411b304b307f17a4db55b4c034ff84ff
-  data.tar.gz: 0566ffbb332db2b4bdf1862474a97f9ec5d6a451
+  metadata.gz: ac5f8d21d026acd98f1d9dd234e7a580a8efa2bc
+  data.tar.gz: fa3e5860cf5f98d836d8e3cb1350913453163dbf
 SHA512:
-  metadata.gz: 61f6d8bb54f5b00b49e14847bce4d219f26faf76fd6854bcfec4e1fe9fab30b747504ebd2411720c680ee940612bca3e1a766d46b8cd1e080d390cb61872c3cd
-  data.tar.gz: 2bf51f1671ebcea3dd664d40141e07ed9a541a3c16a3bf9001a35158bf274efd8a1bc86c15043a8f000396606acf94707ee5ba9725e11da027cf3ce642cb2d03
+  metadata.gz: 326430abdffa6d8a8c21dc101a802cb193545fc1648b2c345c392aca3d899a1b648cf49f0d9e2885387358d8d6667cbd62c95fb012faab8365d5b84f0f20c878
+  data.tar.gz: 50a5b3f7b721d8f181dd533ecf53d2c2b0c4fcb417b8530af6b5fe060e9c5b4de7c5ec90e5d0737e27fb233385440716b6fb6f17e1aca4e9634a3a68ddaf957c

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  DisplayCopNames: true
+
+#
+# Style
+#
+
+LineLength:
+  Max: 128
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+#
+# Metrics
+#
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+sudo: false
+
+bundler_args: --without development doc
+
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - 2.3.1
+  - jruby-9.1.0.0
+  - jruby-head
+  - ruby-head
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+    - rvm: rbx-2
+  fast_finish: true
+
+branches:
+  only:
+    - master

data/CHANGES.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2016-07-02)
+
+* Initial release.

data/Gemfile

@@ -1,4 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in timeout.gemspec
 gemspec
+
+group :development, :test do
+  gem "rake"
+end
+
+group :test do
+  gem "rspec", "~> 3", require: false
+  gem "rubocop", "0.41.1", require: false
+end

data/README.md

@@ -1,6 +1,10 @@
 Timeout::Extensions
 ===================
 
+[![Gem Version](https://badge.fury.io/rb/timeout-extensions.svg)](http://rubygems.org/gems/timeout-extensions)
+[![Build Status](https://secure.travis-ci.org/celluloid/timeout-extensions.svg?branch=master)](http://travis-ci.org/celluloid/timeout-extensions)
+[![Code Climate](https://codeclimate.com/github/celluloid/timeout-extensions.svg)](https://codeclimate.com/github/celluloid/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.
 
@@ -71,6 +75,18 @@ Timeout.backend(MyTimeoutThingy) do
 end
 ```
 
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+versions:
+
+* Ruby 2.1
+* Ruby 2.2
+* Ruby 2.3
+* JRuby 9.1
+
+If something doesn't work on one of these versions, it's a bug.
+
 # Contributing
 
 * Fork this repository on github
@@ -80,5 +96,5 @@ end
 
 # License
 
-Copyright (c) 2014-2015 Tony Arcieri, Tiago Cardoso
+Copyright (c) 2014-2016 Tony Arcieri, Tiago Cardoso
 Distributed under the MIT License. See LICENSE.txt for further details.

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+task default: %w(spec rubocop)

data/lib/timeout/extensions.rb

@@ -1,45 +1,50 @@
-require 'timeout/extensions/version'
+require "timeout/extensions/version"
 
+# Core extensions to Thread
+#
+# Adds accessors to customize timeout and sleep within a thread,
+# if you have a better friendlier implementation of both methods,
+# or if your code breaks with the stdlib implementations.
+#
 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
+  module TimeoutMethods
+    def timeout(*args, &block)
+      if (timeout_handler = Thread.current.timeout_handler)
+        timeout_handler.call(*args, &block)
+      else
+        super
+      end
     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)
+  module KernelMethods
+    def sleep(*args)
+      if (sleep_handler = Thread.current.sleep_handler)
+        sleep_handler.call(*args)
+      else
+        super
+      end
     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
+  # in order for prepend to work, I have to do it in the Timeout module singleton class
+  class << ::Timeout
+    prepend TimeoutMethods
   end
 
-  def sleep_with_handler(*args)
-    if sleep_handler = Thread.current.sleep_handler
-      sleep_handler.call(*args)
-    else
-      sleep_without_handler(*args)
-    end
+  # ditto for Kernel
+  class << ::Kernel
+    prepend KernelMethods
   end
-end
 
-Timeout.extend Timeout::Extensions
-include Kernel::Extensions
+  # this is an hack so that calling "sleep(2)" works. Amazingly, the message doesn't get
+  # sent to Kernel.sleep code path.
+  # https://bugs.ruby-lang.org/issues/12535
+  #
+  ::Object.prepend KernelMethods
+end

data/lib/timeout/extensions/version.rb

@@ -1,3 +1,3 @@
 module Timeout::Extensions
-  VERSION = "0.0.0"
+  VERSION = "0.1.0".freeze
 end

data/spec/spec_helper.rb

@@ -1,65 +1,22 @@
-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
-
+require "rubygems"
+require "bundler/setup"
+require "logger"
+require "timeout"
+require "timeout/extensions"
 
 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'
+  config.order = "random"
 end
 
-class ExampleActor
-  include Celluloid
-  execute_block_on_receiver :wrap
-
-  def wrap
+def within_thread
+  Thread.new do
     yield
-  end
+  end.join
 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

@@ -1,35 +1,31 @@
-require 'spec_helper'
+require "spec_helper"
 
-describe Timeout::Extensions do
-  describe "timeout" do
+RSpec.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
+    let(:action) { proc { |t| } }
+    context "inside and outside of thread" do
       it "hits the proper timeout handler" do
-        within_actor do
+        within_thread 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
+  describe ".sleep" do
     let(:dummy_sleep) { double(:meta_sleep) }
-    context "inside and outside of actor" do
+    context "inside and outside of thread" do
       it "hits the proper sleep handler" do
-        within_actor do
+        within_thread 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
 end

data/timeout-extensions.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'timeout/extensions/version'
+require "timeout/extensions/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "timeout-extensions"
@@ -18,8 +18,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.required_ruby_version = ">= 2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeout-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Tony Arcieri
@@ -9,64 +9,8 @@ authors:
 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
+date: 2016-07-03 00:00:00.000000000 Z
+dependencies: []
 description: A timeout extension for Ruby which plugs into multiple timeout backends
 email:
 - bascule@gmail.com
@@ -76,6 +20,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,7 +45,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -106,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Extensions to the Ruby standard library's timeout API