Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

readme and gem files

  • Loading branch information...
commit 2d4af658d9ffcd324c16419faae08d9adb9fccb9 1 parent 4ee1cd7
John Bachir authored
22 LICENSE.txt
View
@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Joseph Bachir
+
+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.
1  Rakefile
View
@@ -0,0 +1 @@
+require "bundler/gem_tasks"
0  sane-timeout.rb → lib/sane_timeout.rb
View
File renamed without changes
33 readme.md
View
@@ -1,4 +1,26 @@
-# Sane Timeout
+# SaneTimeout
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+ gem 'sane_timeout'
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install sane_timeout
+
+## Usage
+
+TODO: Write usage instructions here
+
+
## Open Questions
* on line 69, I had tried doing x.join based on the standard lib doing the
@@ -7,7 +29,14 @@ necessary to wait for x to die. However, doing this causes many things to break.
I haven't been able to figure out why.
* related, is there any reason to kill y before returning x.value?
-# Project Improvement
+## To Do
+* determine best way to install sane_timeout so that it
+ replaces Timeout. possibly offer to modes, one where
+ Timeout is overwritten, another where sane_timeout is
+ invoked in its own namespace (SaneTimeout)
+
+## Project Improvement
+* better name?
* There is redundant code between test_timeout.rb and test_sane_timeout.rb
because I wanted to annotate in the former and be DRY in the latter. Maybe this
can somehow be improved.
18 sane_timeout.gemspec
View
@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+ gem.name = "sane_timeout"
+ gem.version = '0.1'
+ gem.authors = ["John Joseph Bachir"]
+ gem.email = ["john@ganxy.com"]
+ gem.description = %q{Sane Timeout fixes Ruby standard lib Timeout}
+ gem.summary = %q{Sane Timeout fixes Ruby standard lib Timeout}
+ gem.homepage = "https://github.com/jjb/sane_timeout"
+
+ gem.files = `git ls-files`.split($/)
+ # gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+ gem.require_paths = ["lib"]
+end
Please sign in to comment.
Something went wrong with that request. Please try again.