celluloid-pmap 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd8a1f6f0315f3acd623701b984e804bb3f1d282
+  data.tar.gz: b352db781fc66bedf019e7e70eca037731a382fe
+SHA512:
+  metadata.gz: 5221c5887556d0530b0a8c3f5bf13f9f5c17d49fd8a970899d19eff295d62a73f8978d7c64829e6b29638597869a30e198c6e5bd891c25b3b191ac2b684c230e
+  data.tar.gz: 30c8b6a0c707ebb2f1f919d2146c6a1b3095055b513ea283f0de7bf873f483325e294486cc563bfcfb996ab4c28b03251338d040c81d6c1dcb80be81173ae991

data/.travis.yml

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

data/README.md

@@ -1,6 +1,7 @@
 # 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)
+[![Build Status](https://travis-ci.org/jwo/celluloid-pmap.png?branch=master)](https://travis-ci.org/jwo/celluloid-pmap)
+[![Code Climate](https://codeclimate.com/github/jwo/celluloid-pmap.png)](https://codeclimate.com/github/jwo/celluloid-pmap)
 
 Parallel Mapping using Celluloid
 
@@ -17,6 +18,19 @@ The pmap will return an array of values when all of the Futures have completed a
 
 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.
 
+### Use with ActiveRecord
+
+Some users have reported connection leaking with using ActiveRecord objects in a
+pmap. You can reuse a connection with this code below. You can read the backstory
+on the [decision to not include an AR dependency](https://github.com/jwo/celluloid-pmap/pull/2).
+
+```ruby
+users.pmap(4) do |user|
+  ActiveRecord::Base.connection_pool.with_connection { user.do_hefty_stuff! }
+end
+```
+
+
 ### 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
@@ -31,11 +45,11 @@ Because I've been implementing the same initializer code in every project I've w
 
 ### What rubies will this run on?
 
-* 1.9.3
-* ruby-head (2.0)
+* 2.0.0
+* 2.1.3
+* 2.2.0
 * jruby-19mode
 * jruby-head
-* rbx-19mode
 
 
 ## Installation
@@ -52,16 +66,20 @@ Default usage will execute in parallel. Simply pass a block to an Enumerable
 ```
 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)}
+[55,65,75,85].pmap{|limit| puts "I can't drive #{limit}!"; sleep(rand)}
+```
+
+Or something more real-world?
 
-=> 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_ "
+```
+User.active.all.pmap do |user| 
+  stripe_user = Stripe::Customer.retrieve user.stripe_customer_token
+  user.invoices = BuildsInvoicesFromStripeUser.build(stripe_user)
+  user.save
+end
 ```
 
-Problem: When using with ActiveRecord, you can quickly run out of connections. 
+Problem: When using with ActiveRecord, you can quickly run out of connections.  
 Answer: Specify the max number of threads (actors) to create at once!
 
 ```
@@ -76,15 +94,21 @@ puts [1,2,3].pmap(2){|speed_limit| puts Time.now.tap { sleep(3) }}
 
 We default pmap's threads to the number of Celluloid cores in the system.
 
-## When will this help?
+### When should you use pmap over Sidekiq or Actors?
+
+When you need the response right away. (well, right away in the workflow sense). This is crazy good in IRB too. Destroying multiple records in parallel is nice.
+
+### When will this help performance?
 
 * 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?
+### So what will this not speed things up?
 
-* Pure math or ruby computations
+* Pure math or ruby computations*
+
+\*except if you're on JRuby or Rubinius, where this will still speed those along quite nicely.
 
 ## Image Credit
 
@@ -94,6 +118,10 @@ 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
 
+## Contributors
+
+* [Jason Voegele](https://github.com/jvoegele)
+
 ## Contributing
 
 1. Fork it

data/celluloid-pmap.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('celluloid', '~> 0.12')
+  gem.add_dependency('celluloid', '~> 0.16')
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", "2.99"
+  gem.add_development_dependency "pry"
 end

data/lib/celluloid/pmap.rb

@@ -8,9 +8,13 @@ module Celluloid
     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 }
+        def pmap(pool_or_size=Celluloid.cores, &block)
+          pool = if pool_or_size.class.ancestors.include?(Celluloid::PoolManager)
+                   pool_or_size
+                 else
+                   Pmap::ParallelMapWorker.pool(size: pool_or_size)
+                 end
+          futures = map { |elem| pool.future(:yielder, elem, block) }
           futures.map { |future| future.value }
         end
 

data/lib/celluloid/pmap/parallel_map_worker.rb

@@ -4,8 +4,8 @@ module Celluloid::Pmap
   class ParallelMapWorker
     include Celluloid
 
-    def yielder(element=nil, &block)
-      yield element
+    def yielder(element=nil, block)
+      block.call(element)
     end
   end
 

data/lib/celluloid/pmap/version.rb

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

data/spec/celluloid/pmap/parallel_map_worker_spec.rb

@@ -3,12 +3,12 @@ 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 = subject.yielder(proc { 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 = subject.yielder(6, ->(e) { e + 3 })
     result.should eq(9)
   end
 end

data/spec/celluloid/pmap_spec.rb

@@ -40,6 +40,13 @@ describe Celluloid::Pmap do
     }.to take_approximately(1).seconds
   end
 
+  let(:pool) { Celluloid::Pmap::ParallelMapWorker.pool(size: 10) }
+  it 'can reuse an existing thread pool' do
+    expect {
+      [1,2,3,4,5,6].pmap(pool) {|x| x; sleep(1) }
+    }.to take_approximately(1).seconds
+  end
+
   it 'should be included in enumerable' do
     Enumerable.ancestors.should include(Celluloid::Pmap)
   end

data/spec/support/benchmark_spec.rb

@@ -1,15 +1,17 @@
 require 'benchmark'
 
-RSpec::Matchers.define :take_approximately do |n|
+RSpec::Matchers.define :take_approximately do |expected|
   chain :seconds do; end
 
   match do |block|
     @elapsed = Benchmark.realtime do
       block.call
     end
-    @elapsed.should be_within(0.2).of(n)
+    @elapsed.should be_within(0.2).of(expected)
   end
 
+  supports_block_expectations if respond_to? :supports_block_expectations
+
   failure_message_for_should do |actual|
     "expected block to take about #{expected} seconds, but took #{@elapsed}"
   end
@@ -19,7 +21,7 @@ RSpec::Matchers.define :take_approximately do |n|
   end
 
   description do
-    "take approximately #{expectely} seconds to execute"
+    "take approximately #{expected} seconds to execute"
   end
 
 end

metadata

@@ -1,62 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: celluloid-pmap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Jesse Wolgamott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-30 00:00:00.000000000 Z
+date: 2015-03-31 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'
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.16'
 - !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: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    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
@@ -66,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,34 +91,27 @@ files:
 homepage: https://github.com/jwo/celluloid-pmap
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
-summary: ! 'Celluloid Futures are wicked sweet, and when combined with a #pmap implementation
+specification_version: 4
+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