workload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68f84c27c7e35d59c365cf9a57a3311e2bda1201
+  data.tar.gz: 38bb93842bbc692abd4cbed1c7ba76f4221034d7
+SHA512:
+  metadata.gz: 3272e29e17818a405b50bde1d3c73afdd55078e2065a6afb73973284ddd613992a6aaf3e11932d549fab00d2e55d4fa7687dd228f0ec67b87fd50f9c7e9d2429
+  data.tar.gz: 49a97815d287e89d0c9b5ccab5e53f8e87bc1f5e2751c2a74e52cd0788cae703d3f462694bd99292c302bab68b440f5f6041350511acfb727efb1209b07f0c8a

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in workload.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tymon Tobolski, Monterail.com, LLC
+
+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.

data/README.md

@@ -0,0 +1,69 @@
+# Workload
+
+Distribute simple tasks to multiple threads with ease.
+
+This is an dead simple implementation of multithreaded [producer-consumer](http://en.wikipedia.org/wiki/Producer%E2%80%93consumer_problem) pattern we at [Monterail](http://monterail.com/) are using quite often during imports/exports and all sort of data migration between systems. I'm just tired of writing all that again and again so that's why I put that into a 80LOC gem.
+
+
+![Schema](https://dl.dropboxusercontent.com/s/8dfzs3k2qajcico/2013-10-25%20at%2012.12%20AM.png)
+
+Each `producer` and `consumer` instance gets it's own thread.
+
+## Installation
+
+```bash
+$ gem install workload
+```
+
+## Usage
+
+Let's say we have some big file that we need to read and then do something
+with every line of that file and that processing can be done in parallel.
+
+```ruby
+# job.rb
+require "rubygems"
+require "workload"
+
+Workload.run do |p|
+  p.produce(1) do |queue|       # 1 is the default number of producer threads
+    while line = STDIN.gets
+      queue << line             # The pipe is simple ruby Queue
+    end
+  end
+
+  p.consume(5) do |line|        # Here we are spawning 5 consumer threads
+    print "[#{Thread.current[:id]}] consuming line: #{line}"
+    # do something useful with that input
+  end
+end
+```
+
+and then just run
+
+```
+$ cat huge-file.txt | ruby job.rb
+```
+
+## FAQ
+
+- What about distributing using sidekiq (or any other queue)?
+  - It's too much for such simple task and usually requires some storage (e.g. redis)
+
+- So why not celluloid?
+  - It's also too big and complicated
+
+- What about thread safety?
+  - There is none. I mean, ruby's [Queue](http://ruby-doc.org/stdlib-2.0.0/libdoc/thread/rdoc/Queue.html) is thread safe and all that but if you use some global state inside `produce` or `consume` blocks than you gonna have a bad time.
+
+- Error handling?
+  - If something bad happen inside `consume` block it will be recorded and all errors will be displayed at the end of execution
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/workload/version.rb

@@ -0,0 +1,3 @@
+module Workload
+  VERSION = "0.1.0"
+end

data/lib/workload.rb

@@ -0,0 +1,83 @@
+require "workload/version"
+
+module Workload
+  class Gen
+    DEFAULT_OPTS = {
+      :sleep => 0.1
+    }.freeze
+
+    def initialize(opts = {}, &block)
+      @opts = DEFAULT_OPTS.merge(opts)
+      @queue = Queue.new
+      @errors = []
+
+      block.call(self)
+    end
+
+    def produce(n = 1, &block)
+      @producers_num = n
+      @produce = block
+    end
+
+    def consume(n = 1, &block)
+      @consumers_num = n
+      @consume = block
+    end
+
+    def make_producers
+      @producers_num.times.map do |i|
+        Thread.new do
+          @produce.call(@queue)
+        end
+      end
+    end
+
+    def make_consumers
+      @consumers_num.times.map do |i|
+        Thread.new(i) do |j|
+          Thread.current[:id] = j
+          while @keep || !@queue.empty?
+            begin
+              item = @queue.pop(true)
+              @consume.call(item)
+            rescue ThreadError => ex
+              sleep @opts[:sleep]
+            rescue => ex
+              print "ERROR: #{item} => #{ex}\n"
+              @errors << [item, ex]
+            end
+          end
+        end
+      end
+    end
+
+    def display_errors
+      unless @errors.empty?
+        puts "\nErrors:\n"
+        @errors.each do |item, ex|
+          puts "Item #{item} errored with: #{ex.message}"
+          puts ex.backtrace.map {|e| "  #{e}"}.join("\n")
+          puts
+        end
+
+        exit 1
+      end
+    end
+
+    def run!
+      @keep = true
+      @producers = make_producers
+      @consumers = make_consumers
+
+      @producers.each(&:join)
+      @keep = false
+      @consumers.each(&:join)
+
+      display_errors
+    end
+  end
+
+  def self.run(opts = {}, &block)
+    Gen.new(opts, &block).run!
+  end
+end

data/workload.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "workload"
+  spec.version       = Workload::VERSION
+  spec.authors       = ["Tymon Tobolski"]
+  spec.email         = ["tymon.tobolski@monterail.com"]
+  spec.description   = %q{Distribute simple tasks to multiple threads with ease}
+  spec.summary       = %q{Distribute simple tasks to multiple threads with ease}
+  spec.homepage      = "http://github.com/monterail/workload"
+  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

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: workload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tymon Tobolski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-24 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: Distribute simple tasks to multiple threads with ease
+email:
+- tymon.tobolski@monterail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workload.rb
+- lib/workload/version.rb
+- workload.gemspec
+homepage: http://github.com/monterail/workload
+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.1.3
+signing_key: 
+specification_version: 4
+summary: Distribute simple tasks to multiple threads with ease
+test_files: []
+has_rdoc: