celluloid-pmap 0.1.0

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 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+script: rake
+rvm:
+- 1.9.3
+- ruby-head
+- jruby-19mode
+- jruby-head
+- rbx-19mode 

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jesse Wolgamott
+
+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,103 @@
+# Celluloid::Pmap
+
+[![Build Status](https://travis-ci.org/jwo/celluloid-pmap.png?branch=master)](https://travis-ci.org/jwo/celluloid-pmap) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jwo/celluloid-pmap)
+
+Parallel Mapping using Celluloid
+
+Celluloid Futures are wicked sweet, and when combined with a `pmap`
+implementation AND a supervisor to keep the max threads down, you can be wicked
+sweet too!
+
+### How does this happen?
+![celluloid](https://f.cloud.github.com/assets/123075/109654/7584c1fa-6a8c-11e2-9ad6-114818b7fbe4.png)
+
+We use Celluloid Futures and Celluloid pool to execute blocks in parallel. 
+
+The pmap will return an array of values when all of the Futures have completed and return values (or return nil).
+
+The pool can help to make sure you don't exceed your connection resources. A common use case for this is in Rails, you can easily exceed the default ActiveRecord connection size.
+
+### Inspiration for this code
+
+Tony Arcieri created [celluloid](http://celluloid.io/), and the [simple_pmap example](https://github.com/celluloid/celluloid/blob/master/examples/simple_pmap.rb) from which this codebase started
+
+### Is this production ready?
+
+I've used this implementation in several production systems over the last year. All complexity is with Celluloid (not 1.0 yet, but in my experience has been highly stable.)
+
+### Why is this a gem?
+
+Because I've been implementing the same initializer code in every project I've worked on for the last 6 months. It was time to take a stand, man.
+
+### What rubies will this run on?
+
+* 1.9.3
+* ruby-head (2.0)
+* jruby-19mode
+* jruby-head
+* rbx-19mode
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'celluloid-pmap'
+
+## Usage
+
+Default usage will execute in parallel. Simply pass a block to an Enumerable
+(like an Array)
+
+```
+puts "You'll see the puts happen instantly, and the sleep in parallel"
+
+[55,65,75,85].pmap{|speed_limit| puts "I can't drive _#{speed_limit}_";
+sleep(rand)}
+
+=> You'll see the puts happen instantly, and the sleep in parallel
+"I can't drive _55_ ""I can't drive _65_ "
+"I can't drive _75_ "
+"I can't drive _85_ "
+```
+
+Problem: When using with ActiveRecord, you can quickly run out of connections. 
+Answer: Specify the max number of threads (actors) to create at once!
+
+```
+puts "You should see two distinct groups of timestamps, 3 seconds apart"
+puts [1,2,3].pmap(2){|speed_limit| puts Time.now.tap { sleep(3) }}
+
+=> You should see two distinct groups of timestamps, 3 seconds apart
+2013-01-29 21:15:01 -0600
+2013-01-29 21:15:01 -0600
+2013-01-29 21:15:04 -0600
+```
+
+We default pmap's threads to the number of Celluloid cores in the system.
+
+## When will this help?
+
+* When the blocks are IO bound (like database or web queries)
+* When you're running JRuby or Rubinius
+* When you're running C Extensions
+
+## So what will this not help with?
+
+* Pure math or ruby computations
+
+## Image Credit
+
+Ben Scheirman (@subdigital) originally used the awesome Celluloid He-Man image
+in a presentation on background workers. "He-Man and the Masters of the
+Universe," AND "She-Ra: Princess of Power" are copyright Mattel.
+
+More information on He-Man can be found at the unspeakably wow site: http://castlegrayskull.org
+
+## 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/celluloid-pmap.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'celluloid/pmap/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "celluloid-pmap"
+  gem.version       = Celluloid::Pmap::VERSION
+  gem.authors       = ["Jesse Wolgamott"]
+  gem.email         = ["jesse@comalproductions.com"]
+  gem.description   = %q{Easy Parallel Executing using Celluloid}
+  gem.summary       = %q{ Celluloid Futures are wicked sweet, and when combined with a #pmap implementation AND a supervisor to keep the max threads down, you can be wicked sweet too!}
+  gem.homepage      = "https://github.com/jwo/celluloid-pmap"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('celluloid', '~> 0.12')
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/celluloid/pmap.rb

@@ -0,0 +1,24 @@
+require 'celluloid'
+require 'celluloid/pmap/parallel_map_worker'
+require "celluloid/pmap/version"
+
+module Celluloid
+  module Pmap
+
+    def self.included(base)
+      base.class_eval do
+
+        def pmap(size=Celluloid.cores, &block)
+          pool = Pmap::ParallelMapWorker.pool(size: size)
+          futures = map { |elem| pool.future :yielder, elem, &block }
+          futures.map { |future| future.value }
+        end
+
+      end
+    end
+  end
+end
+
+module Enumerable
+  include Celluloid::Pmap
+end

data/lib/celluloid/pmap/parallel_map_worker.rb

@@ -0,0 +1,12 @@
+require 'celluloid'
+module Celluloid::Pmap
+
+  class ParallelMapWorker
+    include Celluloid
+
+    def yielder(element=nil, &block)
+      yield element
+    end
+  end
+
+end

data/lib/celluloid/pmap/version.rb

@@ -0,0 +1,5 @@
+module Celluloid
+  module Pmap
+    VERSION = "0.1.0"
+  end
+end

data/spec/celluloid/pmap/parallel_map_worker_spec.rb

@@ -0,0 +1,14 @@
+require 'celluloid/pmap/parallel_map_worker'
+
+describe Celluloid::Pmap::ParallelMapWorker do
+
+  it "should execute the block we send" do
+    result = subject.yielder { 6 + 3 }
+    result.should eq(9)
+  end
+
+  it "should send in the argument to the block" do
+    result = subject.yielder(6) {|e| e + 3 }
+    result.should eq(9)
+  end
+end

data/spec/celluloid/pmap_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Celluloid::Pmap do
+
+  it 'should have a version number' do
+    Celluloid::Pmap::VERSION.should_not be_nil
+  end
+
+  it 'should still map correctly' do
+    [4,5,6,7].map{|x| x + 1}.should eq([5,6,7,8])
+  end
+
+  it 'should have same results when pmap' do
+    [4,5,6,7].pmap{|x| x + 1}.should eq([5,6,7,8])
+  end
+
+  it 'should sleep in sequence for map' do
+    expect {
+      [1,2,3].map{|x| x; sleep(1) }
+    }.to take_approximately(3).seconds
+  end
+
+  it 'should sleep in parallel for pmap' do
+    Celluloid.stub(:cores) { 4 }
+    expect {
+      [1,2,3].pmap{|x| x; sleep(1) }
+    }.to take_approximately(1).seconds
+  end
+
+  it 'should default to the number of cores on the machine' do
+    Celluloid.stub(:cores) { 4 }
+    expect {
+      [1,2,3,4,5,6].pmap{|x| x; sleep(1) }
+    }.to take_approximately(2).seconds
+  end
+
+  it 'can be set to many threads at once' do
+    expect {
+      [1,2,3,4,5,6].pmap(10) {|x| x; sleep(1) }
+    }.to take_approximately(1).seconds
+  end
+
+  it 'should be included in enumerable' do
+    Enumerable.ancestors.should include(Celluloid::Pmap)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'celluloid/pmap'
+require 'support/benchmark_spec'

data/spec/support/benchmark_spec.rb

@@ -0,0 +1,26 @@
+require 'benchmark'
+
+RSpec::Matchers.define :take_approximately do |n|
+  chain :seconds do; end
+
+  match do |block|
+    @elapsed = Benchmark.realtime do
+      block.call
+    end
+    @elapsed.should be_within(0.2).of(n)
+  end
+
+  failure_message_for_should do |actual|
+    "expected block to take about #{expected} seconds, but took #{@elapsed}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected block to not take about #{expected} seconds, but took #{@elapsed}"
+  end
+
+  description do
+    "take approximately #{expectely} seconds to execute"
+  end
+
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: celluloid-pmap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jesse Wolgamott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-30 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.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !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'
+- !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'
+description: Easy Parallel Executing using Celluloid
+email:
+- jesse@comalproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- celluloid-pmap.gemspec
+- lib/celluloid/pmap.rb
+- lib/celluloid/pmap/parallel_map_worker.rb
+- lib/celluloid/pmap/version.rb
+- spec/celluloid/pmap/parallel_map_worker_spec.rb
+- spec/celluloid/pmap_spec.rb
+- spec/spec_helper.rb
+- spec/support/benchmark_spec.rb
+homepage: https://github.com/jwo/celluloid-pmap
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1634678292580827716
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1634678292580827716
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'Celluloid Futures are wicked sweet, and when combined with a #pmap implementation
+  AND a supervisor to keep the max threads down, you can be wicked sweet too!'
+test_files:
+- spec/celluloid/pmap/parallel_map_worker_spec.rb
+- spec/celluloid/pmap_spec.rb
+- spec/spec_helper.rb
+- spec/support/benchmark_spec.rb