parallelize 0.2.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    yard (0.6.8)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Junegunn Choi
+
+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.rdoc

@@ -0,0 +1,52 @@
+= parallelize
+
+Simple multi-threading for Ruby.
+
+== Installation
+  gem install parallelize
+
+== Examples
+  require 'rubygems'
+  require 'parallelize'
+
+  parallelize(4) do
+    puts "I'm a thread"
+
+    # ...
+  end
+
+  # Zero-based thread index
+  parallelize(4) do |thread_idx|
+    puts "I'm thread ##{thread_idx}"
+
+    # ...
+  end
+
+  # Enumerable#peach
+  (0..100).peach(4) do |elem, thread_idx|
+    puts "Thread ##{thread_idx} processing #{elem}"
+  end
+
+=== Collecting exceptions
+  begin
+    parallelize(4, true) do |elem, thread_idx|
+      # Each thread can complete its block even when some other threads throw exceptions
+    end
+  rescue ParallelException => e
+    p e.exceptions
+  end
+
+== Contributing to parallelize
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Junegunn Choi. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "parallelize"
+  gem.homepage = "http://github.com/junegunn/parallelize"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple multi-threading for Ruby}
+  gem.description = %Q{Simple multi-threading for Ruby}
+  gem.email = "junegunn.c@gmail.com"
+  gem.authors = ["Junegunn Choi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/example/example.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'parallelize'
+
+parallelize(4) do
+	puts "I'm a thread"
+end
+
+parallelize(4) do |thread_idx|
+	puts "I'm thread ##{thread_idx}" # thread_idx is zero-based
+	# ...
+end
+
+# Enumerable#peach
+(0..100).peach(4) do |elem, thread_idx|
+	puts "Thread ##{thread_idx} processing #{elem}"
+end
+
+begin
+	parallelize(4, true) do |elem, thread_idx|
+		# Each thread can complete its block even when some other threads throw exceptions
+		raise Exception.new(thread_idx) if thread_idx < 2
+		sleep 3
+	end
+rescue ParallelException => e
+	p e.exceptions
+end
+

data/example/example2.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'parallelize'
+
+TOTAL_SIZE = 1_0000_0000
+SLICE_SIZE = 100000
+
+parallelize(4) do |thread_idx|
+	cnt = 0 
+	sst = Time.now
+	(0...TOTAL_SIZE).each_slice(SLICE_SIZE) do |slice|
+		st = Time.now
+		slice.each do |i| 
+			record = {}
+			record['userid'] = rand(100_0000_0000).to_s(36)
+			record['content'] = '_' * (50 + rand(100))
+			record['reg_dttm'] = Time.now
+
+			cnt += 1
+		end 
+		elapsed = Time.now - st
+		total_elapsed = Time.now - sst 
+		puts "#{thread_idx}: #{cnt} records upserted. #{"%.2f" % (SLICE_SIZE / elapsed)} records/sec. #{"%.2f" % (cnt / total_elapsed)} records/sec"
+	end 
+end 

data/lib/parallelize.rb

@@ -0,0 +1,11 @@
+require 'parallelize/parallel_exception'
+require 'parallelize/enumerable_ext'
+
+# Execute the given block with multiple threads.
+# @return [Array] Threads.
+# @param [Fixnum] num_threads Number of concurrent threads
+# @param [Boolean] collect_exceptions If true, waits for all threads to complete even in case of exception, and throws ParallelException at the end. If false exception is immediately thrown.
+def parallelize num_threads, collect_exceptions = false, &block
+	num_threads.times.map.peach(num_threads, collect_exceptions, &block)
+end
+

data/lib/parallelize/enumerable_ext.rb

@@ -0,0 +1,53 @@
+module Enumerable
+	# Divides the Enumerable objects into pieces and execute with multiple threads
+	# @return [Array] Threads.
+	# @param [Fixnum] num_threads Number of concurrent threads
+	# @param [Boolean] collect_exceptions If true, waits for all threads to complete even in case of exception, and throws ParallelException at the end. If false exception is immediately thrown.
+	def peach num_threads, collect_exceptions = false, &block
+		raise ArgumentError.new("Block not given") unless block_given?
+		raise ArgumentError.new("Invalid number of threads") if num_threads < 1
+
+		threads = []
+		self.each_slice((self.count{true} / num_threads.to_f).ceil) do |slice|
+			threads << 
+				case block.arity
+				when 2
+					Thread.new(slice, threads.length) { |my_slice, thread_idx|
+						my_slice.each { |e| yield e, thread_idx }
+					}
+				when 1
+					Thread.new(slice) { |my_slice|
+						my_slice.each { |e| yield e }
+					}
+				when 0, -1
+					raise ArgumentError.new("Invalid arity: #{block.arity}") if
+						RUBY_VERSION !~ /^1.8\./ && block.arity == -1
+					Thread.new(slice) { |my_slice|
+						my_slice.each { yield }
+					}
+				else
+					raise ArgumentError.new("Invalid arity: #{block.arity}")
+				end
+		end
+
+		exceptions = {}
+		threads.each_with_index do |thr, idx|
+			begin
+				thr.join
+			rescue Exception => e
+				if collect_exceptions
+					exceptions[idx] = e
+				else
+					raise e
+				end
+			end
+		end
+
+		if exceptions.empty?
+			threads
+		else
+			raise ParallelException.new(exceptions)
+		end
+	end
+end
+

data/lib/parallelize/parallel_exception.rb

@@ -0,0 +1,14 @@
+class ParallelException < Exception
+	# @return [Hash] Hash of exceptions thrown. Indexed by thread index.
+	attr_reader :exceptions
+
+	def initialize(exceptions)
+		@exceptions = exceptions
+	end
+
+	def to_s
+		"Exceptions thrown during parallel execution: [#{@exceptions.inspect}]"
+	end
+end
+
+

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'parallelize'
+
+class Test::Unit::TestCase
+end

data/test/test_parallelize.rb

@@ -0,0 +1,130 @@
+require 'helper'
+require 'thread'
+
+class TestParallelize < Test::Unit::TestCase
+	def test_parallelize
+		num_threads = 4
+
+		m = Mutex.new
+		cnt = 0
+		threads = parallelize(num_threads) do
+			m.synchronize do
+				cnt += 1
+			end
+		end
+
+		assert_equal num_threads, threads.length
+		assert_equal num_threads, cnt
+		assert threads.all? { |t| t.is_a? Thread }
+	end
+
+	def test_parallelize_thread_idx
+		num_threads = 4
+
+		m = Mutex.new
+		max_thread_idx = 0
+		threads = parallelize(num_threads) do |thread_idx|
+			m.synchronize do
+				max_thread_idx = [thread_idx, max_thread_idx].max
+			end
+		end
+		assert_equal num_threads - 1, max_thread_idx
+		assert_equal num_threads, threads.length
+		assert threads.all? { |t| t.is_a? Thread }
+	end
+
+	def test_parallelize_exception
+		num_threads = 4
+		delay = 3
+
+		[true, false].each do |collect_exception|
+			st = Time.now
+			begin
+				threads = parallelize(num_threads, collect_exception) do |thread_idx|
+					unknown_method_should_fail if [0, 1].include? thread_idx
+					sleep delay
+				end
+			rescue Exception => e
+				ex = e
+			end
+
+			if collect_exception
+				assert_equal ParallelException, ex.class
+				assert_equal Hash,              ex.exceptions.class
+				assert_equal 2,                 ex.exceptions.length
+				assert_equal [0, 1],            ex.exceptions.keys
+				assert Time.now - st >= delay, "Did not collect exceptions"
+				p e.exceptions
+			else
+				assert_equal NameError, ex.class
+				assert Time.now - st < delay, "Did not return immediately"
+			end
+		end
+	end
+
+	def test_peach
+		count = 110
+		num_threads = 4
+
+		m = Mutex.new
+		r = Hash.new { |h, k| h[k] = [] }
+		range = (0...count)
+		range.peach(num_threads) do |elem, thread_idx|
+			m.synchronize { r[thread_idx] << elem }
+		end
+
+		assert_equal count, r.values.inject(0) { |sum, arr| sum + arr.length }
+		assert_equal range.to_a.sort, r.values.inject([]) { |cc, arr| cc += arr; cc }.sort
+	end
+
+	def test_peach_exception
+		count = 110
+		num_threads = 4
+
+		m = Mutex.new
+		[true, false].each do |collect_exception|
+			r = Hash.new { |h, k| h[k] = [] }
+			range = (0...count)
+			begin
+				range.peach(num_threads, collect_exception) do |elem, thread_idx|
+					unknown_method_should_fail if [0, 1].include? thread_idx
+					m.synchronize { r[thread_idx] << elem }
+				end
+			rescue Exception => e
+				ex = e
+			end
+
+			if collect_exception
+				assert_equal ParallelException, ex.class
+				assert_equal Hash,              ex.exceptions.class
+				assert_equal 2,                 ex.exceptions.length
+				assert_equal [0, 1],            ex.exceptions.keys
+				assert r.values.inject(0) { |sum, arr| sum + arr.length } < count
+				assert r.values.inject(0) { |sum, arr| sum + arr.length } > count / num_threads
+				p e.exceptions
+			else
+				assert_equal NameError, ex.class
+				assert r.values.inject(0) { |sum, arr| sum + arr.length } < count
+			end
+		end
+	end
+
+	def test_peach_invalid_arity_block
+		assert_raise(ArgumentError) {
+			(0..100).peach(4) do |a, b, c|
+
+			end
+		}
+		assert_raise(ArgumentError) {
+			(0..100).peach(4)
+		}
+		assert_raise(ArgumentError) {
+			(0..100).peach(0) do |a|
+			end
+		}
+
+		# Should be ok
+		(0..100).peach(4) do
+		end
+	end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: parallelize
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.1
+platform: ruby
+authors: 
+  - Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-02 00:00:00 Z
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: yard
+    version_requirements: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 0.6.0
+    requirement: *id001
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: bundler
+    version_requirements: &id002 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.0.0
+    requirement: *id002
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: jeweler
+    version_requirements: &id003 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            version: 1.6.4
+    requirement: *id003
+    prerelease: false
+    type: :development
+  - !ruby/object:Gem::Dependency 
+    name: rcov
+    version_requirements: &id004 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    requirement: *id004
+    prerelease: false
+    type: :development
+description: Simple multi-threading for Ruby
+email: junegunn.c@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - LICENSE.txt
+  - README.rdoc
+files: 
+  - .document
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE.txt
+  - README.rdoc
+  - Rakefile
+  - VERSION
+  - example/example.rb
+  - example/example2.rb
+  - lib/parallelize.rb
+  - lib/parallelize/enumerable_ext.rb
+  - lib/parallelize/parallel_exception.rb
+  - test/helper.rb
+  - test/test_parallelize.rb
+homepage: http://github.com/junegunn/parallelize
+licenses: 
+  - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 2
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Simple multi-threading for Ruby
+test_files: []
+