threach 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,66 @@
+# threach
+
+`threach` adds to the Enumerable module to provide a threaded
+version of whatever enumerator you throw at it (`each` by default).
+
+## Use
+
+    # You like #each? You'll love...err..probably like #threach
+    require 'rubygems'
+    require 'threach'
+    
+    # Process with 2 threads. It assumes you want 'each'
+    # as your iterator.
+    (1..10).threach(2) {|i| puts i.to_s}  
+
+    # You can also specify the iterator
+    File.open('mybigfile') do |f|
+      f.threach(2, :each_line) do |line|
+        processLine(line)
+      end
+    end
+
+    # threach does not care what the arity of your block is
+    # as long as it matches the iterator you ask for
+
+    ('A'..'Z').threach(3, :each_with_index) do |letter, index|
+      puts "#{index}: #{letter}"
+    end
+
+    # Or with a hash
+    h = {'a' => 1, 'b'=>2, 'c'=>3}
+    h.threach(2) do |letter, i|
+      puts "#{i}: #{letter}"
+    end
+
+## Why and when to use it?
+
+Well, if you're using stock (MRI) ruby -- you probably shouldn't bother with `threach`. It'll just slow things down. But if you're using a ruby implementation that has real threads, like JRuby, this will give you relatively painless multi-threading.
+
+You can always do something like:
+
+    if defined? JRUBY_VERSION
+      numthreads = 3
+    else
+      numthreads = 0
+    end
+
+    my_enumerable.threach(numthreads) {|i| ...}
+
+Note the "relatively" in front of "painless" up there. The block you pass still has to be thread-safe, and there are many data structures you'll encounter that are *not* thread-safe. Scalars, arrays, and hashes are, though, under JRuby, and that'll get you pretty far.
+
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Bill Dueber. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: threach
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Bill Dueber
@@ -9,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-07 00:00:00 -04:00
+date: 2010-07-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: An addition to the Enumerable module that allows easy use of threaded each and each-like iterators
 email: bill@dueber.com
 executables: []
@@ -50,12 +68,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - features/step_definitions/threach_steps.rb
@@ -74,21 +92,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Threaded each

data/README.rdoc

@@ -1,17 +0,0 @@
-= threach
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Bill Dueber. See LICENSE for details.