axle-producer_consumer 0.0.1

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 producer_consumer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Gibbons
+
+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,68 @@
+# ProducerConsumer
+
+Threaded [producer/consumer](http://en.wikipedia.org/wiki/Producer-consumer_problem) model. Useful when you have an expensive data producer, such as fetching data over many http connections, and an expensive consumer, such as ingesting into a database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'axle-producer_consumer', :require => 'producer_consumer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install axle-producer_consumer
+
+## Usage
+
+A simple example with simulated expense using an array as the iterator.
+
+    require 'producer_consumer/core_ext/enumerable'
+
+    results = []
+    array = ('a'..'z').to_a
+
+    array.produce(3) do |item|
+      sleep 1
+      "--#{item}--"
+    end.consume(2) do |item|
+      sleep 0.2
+      results << item
+    end
+
+    results.inspect #=> ["--a--", "--b--", "--c--", "--d--" ...
+
+In the above we have used three threads to produce each item, sleeping for one second between each iteration of the array. The data is consumed in an additional two threads sleeping for 0.2 seconds between each new item produced by the producers.
+
+Or use the `WorkerPool` and `ConsumerPool` classes directly.
+
+    require 'open-uri'
+    require 'net/smtp'
+    require 'producer_consumer'
+    include ProducerConsumer
+
+    urls = ['http://www.google.com', 'http://www.yahoo.com', 'http://www.bing.com']
+
+    producer = WorkerPool.new(urls, 3)
+    producer.run do |url|
+      [url.gsub('http://', ''), open(url).read]
+    end
+
+    consumer = ConsumerPool.new(producer, 1)
+    consumer.run do |(page, page_content)|
+      File.open("#{page}.html", "w") { |f| f << page_content }
+    end
+
+    producer.wait
+    consumer.wait
+
+## 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/producer_consumer.rb

@@ -0,0 +1,3 @@
+require "thread"
+require "producer_consumer/version"
+require "producer_consumer/consumer_pool"

data/lib/producer_consumer/consumer_pool.rb

@@ -0,0 +1,21 @@
+require 'producer_consumer/worker_pool'
+
+module ProducerConsumer
+
+  # A ConsumerPool is a special type of worker pool where the input is
+  # another WorkerPool instance.
+  class ConsumerPool < WorkerPool
+
+    def initialize(producer, number_of_threads=1)
+      @producer = producer
+      super([], number_of_threads)
+    end
+
+    def do_work
+      while @producer.alive? || (not @producer.output_queue.empty?)
+        @output_queue << yield(@producer.output_queue.pop)
+      end
+    end
+
+  end
+end

data/lib/producer_consumer/core_ext/enumerable.rb

@@ -0,0 +1,16 @@
+require 'producer_consumer'
+
+module Enumerable
+  def produce(number_of_threads=1, &blk)
+    @producer_pool = ProducerConsumer::WorkerPool.new(self, number_of_threads)
+    @producer_pool.run(&blk)
+    self
+  end
+
+  def consume(number_of_threads=1, &blk)
+    @consumer_pool = ProducerConsumer::ConsumerPool.new(@producer_pool, number_of_threads)
+    @consumer_pool.run(&blk)
+    @producer_pool.wait
+    @consumer_pool.wait
+  end
+end

data/lib/producer_consumer/version.rb

@@ -0,0 +1,3 @@
+module ProducerConsumer
+  VERSION = "0.0.1"
+end

data/lib/producer_consumer/worker_pool.rb

@@ -0,0 +1,41 @@
+module ProducerConsumer
+  class WorkerPool
+    include Enumerable
+    attr_reader :output_queue
+
+    def initialize(input, number_of_threads=1)
+      @input = input
+      @number_of_threads = number_of_threads
+      @workers = []
+      @worker_input_queue = Queue.new
+      @output_queue = Queue.new
+    end
+
+    def run(&blk)
+      # put input's items into queue for thread safe access
+      @input.each { |item| @worker_input_queue << item }
+
+      @number_of_threads.times do 
+        @workers << Thread.new do
+          do_work(&blk)
+        end
+      end
+    end
+
+    # worker's unit of work, can be overriden
+    def do_work
+      until @worker_input_queue.empty?
+        @output_queue << yield(@worker_input_queue.pop)
+      end
+    end
+
+    def alive?
+      @workers.any? { |t| t.alive? }
+    end
+
+    def wait
+      @workers.each { |t| t.join }
+    end
+
+  end
+end

data/producer_consumer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'producer_consumer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "axle-producer_consumer"
+  gem.version       = ProducerConsumer::VERSION
+  gem.authors       = ["Alex Gibbons"]
+  gem.email         = ["alex.gibbons@gmail.com"]
+  gem.description   = %q{Threaded producer/consumer model. Useful when you have an expensive data producer, such as fetching data over many http connections, and an expensive consumer, such as ingesting into a database.}
+  gem.summary       = %q{Simple producer/consumer model.}
+  gem.homepage      = "https://github.com/alexgb/producer_consumer"
+
+  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"]
+
+  gem.add_development_dependency "rspec", "~> 2.6"
+end

data/spec/producer_consumer_spec.rb

@@ -0,0 +1,32 @@
+require 'producer_consumer'
+require 'producer_consumer/core_ext/enumerable'
+
+describe ProducerConsumer do
+
+  describe Array do
+
+    subject { ('a'..'z').to_a }
+
+    it "should respond to produce" do
+      should respond_to(:produce)
+    end
+
+    it "should respond to consume" do
+      should respond_to(:consume)
+    end
+
+    it "should iterate through all items through producer and consumer" do
+      results = []
+      subject.produce(3) do |item|
+        "--#{item}--"
+      end.consume do |item|
+        results << item
+      end
+
+      results.size.should eql(26)
+      results.all? { |i| i =~ /--\w--/ }.should be
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: axle-producer_consumer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Gibbons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Threaded producer/consumer model. Useful when you have an expensive data
+  producer, such as fetching data over many http connections, and an expensive consumer,
+  such as ingesting into a database.
+email:
+- alex.gibbons@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/producer_consumer.rb
+- lib/producer_consumer/consumer_pool.rb
+- lib/producer_consumer/core_ext/enumerable.rb
+- lib/producer_consumer/version.rb
+- lib/producer_consumer/worker_pool.rb
+- producer_consumer.gemspec
+- spec/producer_consumer_spec.rb
+homepage: https://github.com/alexgb/producer_consumer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.24
+signing_key: 
+specification_version: 3
+summary: Simple producer/consumer model.
+test_files:
+- spec/producer_consumer_spec.rb