team_effort 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caad20978d09546b723794fedd95ca0d341c1044
+  data.tar.gz: b1fee646c8cae6b0cdf5b10c1441f0df6e454e56
+SHA512:
+  metadata.gz: ebcae5593ecede37d63f3e6711ba2f8b08a28795d9e85c179107e80993396c236b748a69f9930f2fbe6734c0341149ff13b9154272fe7b799eb946ca7144cde3
+  data.tar.gz: 63f51a5f48c662fceecb4823a6d46f45cea15428b21db0ef2b84d6728a52524e65ea84515a7ef0a36ef8da198b0c676c51442a7c4cdcdb5519adcbfab99505be

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+team_effort

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Kelly Felkins
+
+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,63 @@
+# TeamEffort
+
+Team Effort is a module that makes it easy to dispatch work to child
+processes allowing you to speed processing by taking advantage of
+multiple cores.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'team_effort'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install team_effort
+
+## Usage
+
+To do work in child processes just call `TeamEffort.work` with a collection
+of items to process and a block:
+
+```ruby
+class ProcessALotOfStuff
+
+  def some_method
+    # collection = a lot of stuff from somewhere
+    TeamEffort.work(collection) do |item|
+      # do some work on item
+    end
+  end
+  
+end
+```
+
+You may specify the number of child processes with the work method:
+ 
+```ruby
+def some_method
+  # collection = a lot of stuff from somewhere
+  TeamEffort.work(collection, 3) do |item| # do the work using 3 child processes
+    # do some work on item
+  end
+end
+```
+
+The number of child processes defaults to 4.
+
+The work method will create a new child process for each item in the
+enumeration using ruby's Process.fork so there is overhead on each
+item processed. Team Effort works best when there is substantial work
+to be performed on each item to minimize overhead.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test

data/lib/team_effort.rb

@@ -0,0 +1,23 @@
+require "team_effort/version"
+
+module TeamEffort
+  def self.work(enumerable, max_process_count = 4)
+    pids = []
+
+    enumerable.each do |args|
+      if pids.size == max_process_count
+        finished_pid = Process.wait
+        pids.delete finished_pid
+      end
+
+      pids << fork do
+        yield args
+      end
+    end
+
+    while !pids.empty?
+      finished_pid = Process.wait
+      pids.delete finished_pid
+    end
+  end
+end

data/lib/team_effort/version.rb

@@ -0,0 +1,3 @@
+module TeamEffort
+  VERSION = "0.0.2"
+end

data/team_effort.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'team_effort/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "team_effort"
+  spec.version       = TeamEffort::VERSION
+  spec.authors       = ["Kelly Felkins"]
+  spec.email         = ["kelly@restlater.com"]
+  spec.description = <<-EOT
+    Team Effort provides a simple wrapper to ruby's process management for 
+    processing a collection of items in parallel with child processes.
+  EOT
+  spec.summary       = %q{Use child processes to process a collection in parallel}
+  spec.homepage      = "https://github.com/kellyfelkins/team_effort"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

data/test/test_team_effort.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+require_relative '../lib/team_effort'
+require 'tempfile'
+
+describe TeamEffort do
+  describe '#work' do
+    it 'performs work in child processes' do
+      mutex = Mutex.new
+      output_io = Tempfile.new('mumble')
+      output = nil
+      begin
+        data = %w|one two three|
+        TeamEffort.work(data) do |item|
+          mutex.synchronize do
+            output_io.puts Process.pid
+            output_io.flush
+          end
+        end
+        output_io.rewind
+        output = output_io.read
+      ensure
+        output_io.close
+        output_io.unlink
+      end
+
+      lines = output.split(/\n/)
+      lines.size.must_equal 3
+      lines.each do |line|
+        line.must_match /^\d+$/
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: team_effort
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kelly Felkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    Team Effort provides a simple wrapper to ruby's process management
+  for \n    processing a collection of items in parallel with child processes.\n"
+email:
+- kelly@restlater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- LICENSE
+- README.md
+- Rakefile
+- lib/team_effort.rb
+- lib/team_effort/version.rb
+- team_effort.gemspec
+- test/test_team_effort.rb
+homepage: https://github.com/kellyfelkins/team_effort
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Use child processes to process a collection in parallel
+test_files:
+- test/test_team_effort.rb