distributed_job 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8aa1822c85ccb44521e470a312b430b9409dd537add85122045f7cd71d075ed
-  data.tar.gz: a781158c7699303544cb78185a200059da25013830f677a44a704b6a0c115af8
+  metadata.gz: 2d9474eeee925618320f8a541274a66b68c20648a6ab7e33bd1cc302e97108e9
+  data.tar.gz: d2cf52dc713aca183eda21d4022001533e35d7846fa3fcf76aee9434cbe21089
 SHA512:
-  metadata.gz: 6885d739ae86c615588dfd85ca1b4d0b0b3e4bcdf8cca1ddf1aebcb806a703c1980ca2d1e6f758d22b38a24a3859d5673fa47e7b2438db4635a4e24351bff4eb
-  data.tar.gz: ffbea863763a62d8f22a2e8c2f2b8555a910fc908801e9a93157703a3a2e7e6fbd9bee3b90e6c35971d430b8b720781b02c1d116159e1ea2c3cb00b9fa57b7d4
+  metadata.gz: 5a4e788012c9b9c3bf9afe5d20a3ff835c0260aeca0e90bffd9de80441fb342ca1a30550baf974bbb5efcd85707c31e10b187e4281eab65a1f111cfcd4de6817
+  data.tar.gz: ce00582676f135a1a11f92f59e7cf50147b7ac1ddb8427368d1dc0b7095e40d047a6ef662f5ecf5e1c765acf64c8783bcb7a4e1d8b821d7b74b91adbd19b290b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v2.0.0
+
+* `#push_each` no longer returns an enum when no block is given
+* Renamed `#parts` to `#open_parts`
+
 ## v1.0.0
 
 * Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    distributed_job (1.0.0)
+    distributed_job (2.0.0)
       redis
 
 GEM

data/README.md

@@ -38,6 +38,12 @@ To create a distributed job and add parts, i.e. units of work, to it, simply:
   distributed_job.token # can be used to query the status of the distributed job
 ```
 
+The `part` which is passed to the block is some id for one particular part of
+the distributed job. It must be used in a respective background job to mark
+this part finished after it has been successfully processed. Therefore, when
+all those background jobs have successfully finished, all parts will be marked
+as finished, such that the distributed job will finally be finished as well.
+
 The `token` can be used to keep query the status of the distributed job, e.g.
 on a job summary page or similar. You can show some progress bar in the browser
 or in the terminal, etc:
@@ -48,7 +54,8 @@ distributed_job = Distributed.new(redis: Redis.new, token: params[:token])
 
 distributed_job.total # total number of parts
 distributed_job.count # number of unfinished parts
-distributed_job.finished?
+distributed_job.finished? # whether or not all parts are finished
+distributed_job.open_parts # returns all not yet finished part id's
 ```
 
 Within the background job, you use the passed token and part to query and

data/lib/distributed_job/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DistributedJob
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/distributed_job.rb

@@ -82,8 +82,6 @@ class DistributedJob
   #   end
 
   def push_each(enum)
-    return enum_for(:push_each, enum) unless block_given?
-
     previous_object = nil
     previous_index = nil
 
@@ -101,11 +99,11 @@ class DistributedJob
     yield(previous_object, previous_index.to_s) if previous_index
   end
 
-  # Returns all pushed parts of the distributed job
+  # Returns all parts of the distributed job which are not yet finished.
   #
   # @return [Enumerator] The enum which allows to iterate all parts
 
-  def parts
+  def open_parts
     redis.sscan_each("#{redis_key}:parts")
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: distributed_job
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Benjamin Vetter