puli 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98545dd0b66a7ddefe057d382bea0880e6cae593f991492da264c09858ea051c
-  data.tar.gz: ab41c7149d2c3cb9a8b8447deb75fb323c93b936f4dd59a0317f29a38e1477f1
+  metadata.gz: abb842c2b20ba5419535f1e0fa9cca60d8cb20070c311efe0fe6eda9d603f50d
+  data.tar.gz: 908cc20a1a04a2fdbe68f2afc80d0152fbaf6a77dd1f7092db6183687b6b8edb
 SHA512:
-  metadata.gz: 33612ab356fcdc4f7e3af9d794e78bab489a516b950a0181c304a2dd7f40dabd6733c20ad5230be0ce2c5cb26c95a566b51b2993a78885b0b7d8807c8f0e0f4a
-  data.tar.gz: 03a9baf31d37506a1c6a4d3e9c68fb268d40b5d6bbbe840f183d712d89007c79bef61b506c9085ebcb0add9e8c0a4e64cbc0f60ca470e0852d17f63db239ffb5
+  metadata.gz: d9c65d2ccebfbba7815f86bd118114c68b4382b59904bbf51457d036ff5c840c083c25b2f39bd82d0d606d1d18ea8da1aa3e7889bb1ae2aa8bcbf57d7434e982
+  data.tar.gz: 12c2c372b9261532404126a6a72359dd3037ca0afa21c9b357f754ecfe3c89474660259fbe3fa8a195f7832cf50930acf7d69c567a76f8391caeebb38d64b505

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 1.0.3
+
+* Fix `Puli#map` executing tasks twice
+
+# 1.0.2
+
+* Make sure `Puli#map` returns results in the same order as the payloads for the tasks.
+
 # 1.0.1
 
 * Remove Jeweler and simplify gem building

data/README.md

@@ -35,7 +35,32 @@ end
 # and will also raise TimeoutError up into the caller, regardless of whether
 # Thread.abort_on_exception is set to true.
 ```
- 
+
+# Execution order (`map` vs. `each`)
+
+Since `Puli#each` is presumed to generate side effects and should not slow down execution it yields immediately, so
+the order of execution is undefined:
+
+```ruby
+puli = Puli.new(num_threads: 4, tasks: 1..10.to_a)
+puli.each do |item| # Will yield numbers from 1 to 10 but in arbitrary order
+  fetch_item(item)
+end
+```
+
+However `Puli#map` can "hold" its return value until the ordering can be re-established, and will always return
+the tasks in order they were submitted or in the order the tasks were given in the `tasks:` keyword argument:
+
+
+```ruby
+puli = Puli.new(num_threads: 4, tasks: 1..10.to_a)
+fetched_items = puli.map do |i|
+   # Will run the block in arbitrary order among tasks, due to out-of-order execution
+  fetch_item(i)
+end
+fetched_items #=> [<Item 1>, <Item 2>, ...]_
+```
+
 ## Contributing to puli
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/puli.rb

@@ -1,7 +1,7 @@
 require 'thread'
 
 class Puli
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 
   Task = Struct.new(:payload, :index)
 
@@ -23,8 +23,8 @@ class Puli
     in_execution_order = []
     mux = Mutex.new
     each do |*payload, index:|
-      result = yield(*payload)
-      mux.synchronize { in_execution_order << Task.new(yield(*payload), index) }
+      task_result = yield(*payload)
+      mux.synchronize { in_execution_order << Task.new(task_result, index) }
     end
     in_execution_order.sort_by(&:index).map(&:payload)
   end

data/spec/puli_spec.rb

@@ -52,6 +52,18 @@ describe 'Puli' do
     expect(order_of_execution).to eq(order_as_submitted)
   end
 
+  it 'when mapping, only executes the workload once per task' do
+    order_as_submitted = (1..64).to_a
+    mux = Mutex.new
+    p = Puli.new(num_threads: 4, tasks: order_as_submitted)
+    execution_counter = 0
+    order_of_execution = p.map do |number|
+      sleep(rand / 14)
+      mux.synchronize { execution_counter += 1 }
+    end
+    expect(execution_counter).to eq(order_as_submitted.length)
+  end
+
   it 'allows mapping over the result' do
     p = Puli.new(num_threads: 4)
     20.times {|i| p << i }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puli
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A corded thread pool for bursty threaded workloads