job-iteration 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99e26756140f1346b646a3931dc6cc8de1181a67a27916d9a0d85deb1d4dddeb
-  data.tar.gz: '058d65ec35e8cebbf74ba37c2227aa63cb1b5fbf183c81ee4c1b4f1cc3a9d033'
+  metadata.gz: 1a4821d55797f7597b3c916d6fbca2195c054bd3aab0ffcc40c9ce21ae0b1ec4
+  data.tar.gz: e71ce0fb7ec744b502f018ccfc7ea5e819bfe06f9fb2ca5a32c70cc1b875abc7
 SHA512:
-  metadata.gz: 86a6a0f8ef55ab7502215fc4efcd6bc6e7b7a0b4737decf470db964d2302705d42ab1d16eff904e0d2c914f7ac30ca66cd2b99fffcb6aeaf1db904619fd89418
-  data.tar.gz: 7d9c9d5023f56365e2a1040fc7ccbb57f01c73f50c7addeaaedcf64edc2dab5cf2383d56cda46b832cdc6acce367abf87757dbd1113971335f51d675883e4141
+  metadata.gz: 943795fabf60cff76fa7b8678f1f5d5a83bd98340194e142092dc891ff1abe991c0410572cebd09155c6c220ff96aa5530fb27e1b4fe119c6bbbf22fe12670ef
+  data.tar.gz: 11ea6f0165aa31350c6486236a33d66c94316a08f52905aeaab049388b433c229ccf52e69ae3e43eb8bca9a5c56dc4aae46803aae4add9d2a052d5d49af14d8d

data/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 #### Bug fix
 
+## v1.1.9 (January 6, 2021)
+
+- [61](https://github.com/Shopify/job-iteration/pull/61) Call `super` in `method_added`
+
 ## v1.1.8 (June 8, 2020)
 
 - Preserve ruby2_keywords tags in arguments on Ruby 2.7

data/README.md

@@ -9,7 +9,7 @@ Meet Iteration, an extension for [ActiveJob](https://github.com/rails/rails/tree
 Imagine the following job:
 
 ```ruby
-class SimpleJob < ActiveJob::Base
+class SimpleJob < ApplicationJob
   def perform
     User.find_each do |user|
       user.notify_about_something
@@ -43,7 +43,7 @@ And then execute:
 In the job, include `JobIteration::Iteration` module and start describing the job with two methods (`build_enumerator` and `each_iteration`) instead of `perform`:
 
 ```ruby
-class NotifyUsersJob < ActiveJob::Base
+class NotifyUsersJob < ApplicationJob
   include JobIteration::Iteration
 
   def build_enumerator(cursor:)
@@ -64,7 +64,9 @@ end
 Check out more examples of Iterations:
 
 ```ruby
-class BatchesJob < ActiveJob::Iteration
+class BatchesJob < ApplicationJob
+  include JobIteration::Iteration
+
   def build_enumerator(product_id, cursor:)
     enumerator_builder.active_record_on_batches(
       Product.find(product_id).comments,
@@ -81,7 +83,9 @@ end
 ```
 
 ```ruby
-class ArrayJob < ActiveJob::Iteration
+class ArrayJob < ApplicationJob
+  include JobIteration::Iteration
+
   def build_enumerator(cursor:)
     enumerator_builder.array(['build', 'enumerator', 'from', 'any', 'array'], cursor: cursor)
   end
@@ -93,7 +97,9 @@ end
 ```
 
 ```ruby
-class CsvJob < ActiveJob::Iteration
+class CsvJob < ApplicationJob
+  include JobIteration::Iteration
+
   def build_enumerator(import_id, cursor:)
     import = Import.find(import_id)
     JobIteration::CsvEnumerator.new(import.csv).rows(cursor: cursor)
@@ -153,7 +159,7 @@ There a few configuration assumptions that are required for Iteration to work wi
 **My job has a complex flow. How do I write my own Enumerator?** Iteration API takes care of persisting the cursor (that you may use to calculate an offset) and controlling the job state. The power of Enumerator object is that you can use the cursor in any way you want. One example is a cursorless job that pops records from a datastore until the job is interrupted:
 
 ```ruby
-class MyJob < ActiveJob::Base
+class MyJob < ApplicationJob
   include JobIteration::Iteration
 
   def build_enumerator(cursor:)

data/guides/custom-enumerator.md

@@ -72,3 +72,5 @@ end
 ```
 
 We recommend that you read the implementation of the other enumerators that come with the library (`CsvEnumerator`, `ActiveRecordEnumerator`) to gain a better understanding of building Enumerator objects.
+
+Code that is written after the `yield` in a custom enumerator is not guaranteed to execute. In the case that a job is forced to exit ie `job_should_exit?` is true, then the job is re-enqueued during the yield and the rest of the code in the enumerator does not run. You can follow that logic [here](https://github.com/Shopify/job-iteration/blob/9641f455b9126efff2214692c0bef423e0d12c39/lib/job-iteration/iteration.rb#L128-L131).

data/lib/job-iteration/iteration.rb

@@ -22,6 +22,7 @@ module JobIteration
     module ClassMethods
       def method_added(method_name)
         ban_perform_definition if method_name.to_sym == :perform
+        super
       end
 
       def on_start(*filters, &blk)

data/lib/job-iteration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JobIteration
-  VERSION = "1.1.8"
+  VERSION = "1.1.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord