thread_man 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/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### v0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kapil
+
+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,74 @@
+## ThreadMan [![Build Status](https://secure.travis-ci.org/kapso/thread_man.png)](http://travis-ci.org/kapso/thread_man)
+
+ThreadMan uses `Celluloid` to abstract out concurrent requests pattern.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thread_man'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thread_man
+
+### Usage
+
+Sample `Celluloid` object:
+
+```ruby
+class Car
+  include Celluloid
+
+  def initialize(start_speed = 10)
+    @start_speed = start_speed
+    @name = "Audi #{rand(10)}"
+  end
+
+  def drive(speed = 80)
+    sleep [1, 1.5, 2].sample
+    { name: @name, current_speed: speed, start_speed: @start_speed }
+  end
+end
+```
+
+ThreadMan usage inside a rails controller to make async requests:
+
+```ruby
+class HomeController < ApplicationController
+  def index
+    car = Car.new(70)
+    tm = ThreadMan.new(car)
+
+    # Async invocation of "drive" method.
+    4.times { tm.submit(:drive, 76) }
+
+    # Check if async tasks are still running.
+    puts "\nTasks running: #{tm.tasks_running?}"
+
+    # Get response of first submitted request. This call will block until a response is returned.
+    first_response = tm.next_response
+
+    # Get all responses for the submitted requests. Blocking call.
+    # Array of responses. Order is the same as the "submit" order.
+    all_responses = tm.response
+
+    # NOTE: This is required for GC. Ideally you will call this inside "ensure"
+    tm.terminate!
+
+    render json: all_responses
+  end
+end
+```
+
+### 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/thread_man/version.rb

@@ -0,0 +1,3 @@
+module ThreadMans
+  VERSION = '0.0.1'
+end

data/lib/thread_man.rb

@@ -0,0 +1,115 @@
+require 'thread_man/version'
+
+class ThreadMan
+  class << self
+    attr_accessor :logger
+  end
+
+  def initialize(actor = nil)
+    raise 'Not a valid actor object' if actor && !actor.is_a?(Celluloid)
+
+    @init_actor = actor
+    @futures = []
+    @actors = []
+    @response = []
+    @next_response_ctr = 0
+  end
+
+  def submit(method, *params)
+    raise 'Not initialized with a valid actor object' if !@init_actor
+
+    @futures << @init_actor.future(method.to_sym, *params)
+    @actors << @init_actor
+  end
+
+  def submit_actor(actor, method, *params)
+    raise 'Not a valid actor object' if !actor || !actor.is_a?(Celluloid)
+
+    @futures << actor.future(method.to_sym, *params)
+    @actors << actor
+  end
+
+  def response
+    if @futures.size <= 0
+      raise 'No actors/requests submitted, cannot process response'
+    elsif @response.size == @futures.size
+      @response
+    else
+      (@next_response_ctr..(@futures.size - 1)).each do |index|
+        @response << process_request(index)
+        @next_response_ctr += 1
+      end
+
+      @response
+    end
+  end
+
+  def next_response
+    if @futures.size <= 0
+      raise 'No actors/requests submitted, cannot process response'
+    elsif @next_response_ctr >= @futures.size
+      nil
+    else
+      value = process_request(@next_response_ctr)
+      @response << value
+      @next_response_ctr += 1
+      value
+    end
+  end
+
+  def terminate!
+    actor_arr = @actors.uniq
+
+    if actor_arr.size > 0
+      actor_arr.each do |actor|
+        begin
+          actor.terminate if actor.alive?
+        rescue => e
+          log "Terminating actor #{actor.inspect}: #{e.message}"
+        end
+      end
+
+      @actors.clear
+      @futures.clear
+      @next_response_ctr = 0
+    end
+  end
+
+  def tasks_running?
+    @actors.uniq.each do |actor|
+      actor.tasks.each { |task| return true if task.running? }
+    end
+
+    false
+  end
+
+  def each_response
+    while resp = next_response
+      yield resp
+    end
+  end
+
+  def any_nil_response?
+    response.include? nil
+  end
+
+  protected
+
+  def process_request(index)
+    if @actors[index].alive?
+      @futures[index].value
+    else
+      raise "Actor is dead possibly due to some earlier exception, cannot process response: #{@actors[index].inspect}"
+    end
+  end
+
+  def log(text)
+    if ThreadMan.logger && ThreadMan.logger.respond_to?(:info)
+      ThreadMan.logger.info("[ThreadMan] #{text}")
+    elsif defined? Rails
+      Rails.logger.info("[ThreadMan] #{text}")
+    else
+      $stdout.print("[ThreadMan] #{text}") and $stdout.flush
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'celluloid'
+require 'thread_man'

data/spec/thread_man_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+class Car
+  include Celluloid
+
+  def initialize(start_speed = 10)
+    @start_speed = start_speed
+    @name = "Audi #{rand(10)}"
+  end
+
+  def drive(speed = 80)
+    sleep [1, 1.5, 2].sample
+    raise "You cannot drive at 100 or more." if speed >= 100
+    { name: @name, current_speed: speed, start_speed: @start_speed }
+  end
+
+  def start_speed
+    @start_speed
+  end
+end
+
+describe ThreadMan do
+  let(:thread_count) { 5 }
+  let(:car_start_speed) { rand(70) }
+  let(:car) { Car.new(car_start_speed) }
+
+  context "single actor object" do
+    let(:tm) { ThreadMan.new(car) }
+
+    it "should return response after submitting single actor requests" do
+      thread_count.times { tm.submit(:drive, rand(90)) }
+      tm.tasks_running?.should == true
+      tm.response.size.should == thread_count
+      tm.tasks_running?.should == false
+      tm.response.first[:start_speed].should == car_start_speed
+      expect { tm.terminate! }.to_not raise_error
+    end
+
+    it "should throw an exception when getting response without submitting actor requests" do
+      expect { tm.response }.to raise_error
+    end
+
+    it "should raise an error on response" do
+      tm.submit(:drive, 100)
+      expect { tm.response }.to raise_error
+    end
+  end
+
+  context "multiple actor objects" do
+    let(:tm) { ThreadMan.new }
+
+    it "should return response after submitting multiple actor requests" do
+      tm.submit_actor(car, :drive, rand(80))
+      thread_count.times { tm.submit_actor(Car.new(rand(20)), :drive, rand(90)) }
+      
+      resp = []
+      while r = tm.next_response
+        resp << r
+      end
+      resp.size.should == thread_count + 1
+
+      tm.response.first[:start_speed].should == car.start_speed
+      tm.response.size.should == thread_count + 1
+
+      expect { tm.terminate! }.to_not raise_error
+    end
+  end
+end

data/thread_man.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'thread_man/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'thread_man'
+  gem.version       = ThreadMans::VERSION
+  gem.authors       = ['Kapil']
+  gem.email         = ['kapil.israni@gmail.com']
+  gem.description   = 'ThreadMan uses Celluloid to abstract out concurrent requests pattern.'
+  gem.summary       = gem.description
+  gem.homepage      = 'http://github.com/kapso/thread_man'
+
+  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_dependency             'celluloid', '~> 0.11.1'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: thread_man
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kapil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ThreadMan uses Celluloid to abstract out concurrent requests pattern.
+email:
+- kapil.israni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/thread_man.rb
+- lib/thread_man/version.rb
+- spec/spec_helper.rb
+- spec/thread_man_spec.rb
+- thread_man.gemspec
+homepage: http://github.com/kapso/thread_man
+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: ThreadMan uses Celluloid to abstract out concurrent requests pattern.
+test_files:
+- spec/spec_helper.rb
+- spec/thread_man_spec.rb