safe_timeout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 784f00b2fc676fe36b98359e8eebdf9177f2e9dd
+  data.tar.gz: 7ffbf4ed29ad028e4b29b79d24bb9d9feb8970e2
+SHA512:
+  metadata.gz: 13b8a264e3449535013dda188788fe3828d76426e342a9742623fec65f4f7bfc39dd62b2611199f3b9203417e45b16a00968f97706d53cf79c5362efd560c8a8
+  data.tar.gz: d0789e190f7ebcff48514fbae29670f8b73f87e74803d5e28508cb8e5cdcc88f938ad5327d362b45cec4ab754c461b973dff47e22892c7b0d6cd0fbbac357323

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 David McCullars
+
+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,50 @@
+# SafeTimeout
+
+A safer alternative to Ruby's Timeout that uses unix processes instead of threads
+
+[![Circle CI](https://circleci.com/gh/david-mccullars/safe_timeout/tree/master.svg?style=svg)](https://circleci.com/gh/david-mccullars/safe_timeout/tree/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'safe_timeout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safe_timeout
+
+## Usage
+
+SafeTimeout is a drop-in replacement for Ruby's Timeout.
+
+    SafeTimeout.timeout(2) do
+      # Something that may take a while
+      # Possible Timeout::Error raised
+    end
+
+or
+
+    SafeTimeout.timeout(10, CustomTimeoutError) do
+      # Something that may take a while
+      # Possible CustomTimeoutError raised
+    end
+
+If one wishes this to be even more of a drop-in replacement one
+could add the following to the top of an application:
+
+    Timeout = SafeTimeout
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/safe_timeout/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/circle.yml

@@ -0,0 +1,12 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.8.7 bundle install'
+    - 'rvm-exec 1.9.3 bundle install'
+    - 'rvm-exec 2.1.2 bundle install'
+    - 'rvm-exec 2.2.0 bundle install'
+test:
+  override:
+    - 'rvm-exec 1.8.7 bundle exec rake'
+    - 'rvm-exec 1.9.3 bundle exec rake'
+    - 'rvm-exec 2.1.2 bundle exec rake'
+    - 'rvm-exec 2.2.0 bundle exec rake'

data/lib/safe_timeout.rb

@@ -0,0 +1,15 @@
+# Ruby's Timeout is broken and highly dangerous. To avoid this risk we
+# instead use a child process to handle the timeout. We fork it and let
+# it issue a SIGINT (Ctrl-C) to the parent if the timeout is reached.
+module SafeTimeout
+
+  autoload :InterruptingChildProcess, 'safe_timeout/interrupting_child_process'
+
+  def self.timeout(sec, klass=nil, &block)
+    InterruptingChildProcess.new(
+      :timeout => sec,
+      :on_timeout => lambda { |_| raise(klass || Timeout::Error) }
+    ).start(&block)
+  end
+
+end

data/lib/safe_timeout/interrupting_child_process.rb

@@ -0,0 +1,40 @@
+module SafeTimeout
+  class InterruptingChildProcess
+
+    def initialize(options={})
+      @expiration = Time.now.to_f + options.fetch(:timeout)
+      @on_timeout = options.fetch(:on_timeout)
+    end
+
+    def start(&block)
+      Signal.trap("TRAP", &@on_timeout)
+      Kernel.fork { wait_for_expiration }
+      yield
+    ensure
+      stop rescue nil
+    end
+
+    def stop
+      # Tell that child to stop interrupting!
+      Process.kill("HUP", @child_pid)
+    end
+
+    def wait_for_expiration
+      Signal.trap("HUP") { exit 0 }
+
+      # If the parent dies unexpectedly and the child is never told to
+      # stop, it becomes an orphan and is given to the init process (1)
+      # or worse yet it becomes a zombie with parent 0. In either case,
+      # stop interrupting!
+      while Process.ppid > 1
+        sleep 0.1
+        if Time.now.to_f > @expiration
+          Process.kill("TRAP", Process.ppid)
+          return
+        end
+      end
+    end
+
+  end
+
+end

data/lib/safe_timeout/version.rb

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

data/safe_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 'safe_timeout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safe_timeout"
+  spec.version       = SafeTimeout::VERSION
+  spec.authors       = ["David McCullars"]
+  spec.email         = ["david.mccullars@gmail.com"]
+  spec.summary       = %q{A safer alternative to Ruby's Timeout that uses unix processes instead of threads.}
+  spec.description   = %q{A safer alternative to Ruby's Timeout that uses unix processes instead of threads.}
+  spec.homepage      = "https://github.com/david-mccullars/safe_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", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/spec/lib/safe_timeout_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe SafeTimeout do
+  context '.timeout' do
+
+    it 'should process its block' do
+      result = nil
+      expect do
+        result = SafeTimeout.timeout(5) { :success }
+      end.to_not raise_error
+      expect(result).to eq(:success)
+    end
+
+    it 'should timeout if block takes too long' do
+      result = nil
+      expect do
+        result = SafeTimeout.timeout(0.4) { sleep 3 and :failure }
+      end.to raise_error(Timeout::Error)
+      expect(result).to be_nil
+    end
+
+    it 'should not leave orphaned child process' do
+      child = fork do
+        SafeTimeout.timeout(5) { sleep 5 }
+      end
+      :loop until grand_child = all_processes[child].first
+      expect(grand_child).to be > child
+
+      Process.kill('TERM', child)
+      expect(is_process_still_running? grand_child).to be false
+    end
+
+    private
+
+    # Returns a hash of all running processes and their children
+    def all_processes
+      `ps -eo pid,ppid`.lines.reduce(Hash.new []) do |hash, line|
+        pid, ppid = line.split.map(&:to_i)
+        hash[ppid] = [] unless hash.key?(ppid)
+        hash[ppid] << pid
+        hash
+      end
+    end
+
+    # Wait for up to 1 second for process to quit and report on
+    # whether it did or not.
+    def is_process_still_running?(pid)
+      10.times do
+        sleep 0.1
+        begin
+          Process.kill(0, pid)
+        rescue Errno::ESRCH
+          return false
+        end
+      end
+      true
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler.require
+
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+    mocks.syntax = :expect
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: safe_timeout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David McCullars
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 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: '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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A safer alternative to Ruby's Timeout that uses unix processes instead
+  of threads.
+email:
+- david.mccullars@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/safe_timeout.rb
+- lib/safe_timeout/interrupting_child_process.rb
+- lib/safe_timeout/version.rb
+- safe_timeout.gemspec
+- spec/lib/safe_timeout_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/david-mccullars/safe_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.2.2
+signing_key: 
+specification_version: 4
+summary: A safer alternative to Ruby's Timeout that uses unix processes instead of
+  threads.
+test_files:
+- spec/lib/safe_timeout_spec.rb
+- spec/spec_helper.rb