job-iteration 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 744271afc9d1de8f525a2228d4969e182118affa
-  data.tar.gz: fa9d46fc8fbafba32134de730525d2ada4efc784
+  metadata.gz: 86ee54cb82b9d6c5e1b97b9bf2e01eed332ce87c
+  data.tar.gz: f05e54ca8459b37f472bfcd4f9cf47d9a005dc8b
 SHA512:
-  metadata.gz: 83e1ca25924c4d273b1ed5a19eed81565479f90aaebdadd50c12c5c19643437bfc330798328dc10abc1a10f7fc63b755cbcbd2c5d34e162a4ff723979757edb9
-  data.tar.gz: 34b83d31905e210800ca4237bb786c1492842e80e3aeadad137dae40e96b9eb92d675521c8941c4c43ae419e2e0967d2b1389220164c803954eb800abc449ef8
+  metadata.gz: aabb890775e006f0097bb886fddd6c9bdbeb442616e5fbb0c12d96ad8fe453ca1119ac1018cab36b9756188a0ccd28944a3e836032b1099a899f54b078c7ba64
+  data.tar.gz: 5133e2eff873e88d009aa255d3eb01bde85b589e24e9f1f660dbe60f15022c24585dded574b3a397ff8fb503dc97fda55b13f1ad24be5fadd1917a94c474c564

data/.travis.yml

@@ -11,4 +11,5 @@ before_install:
 script:
   - bundle exec rake test
   - bundle exec rubocop
+  - bundle exec yardoc --no-output --no-save --no-stats --fail-on-warning
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    job-iteration (0.9.1)
+    job-iteration (0.9.2)
       activejob (~> 5.2)
 
 GEM

data/lib/job-iteration.rb

@@ -11,9 +11,30 @@ module JobIteration
 
   extend self
 
-  attr_accessor :max_job_runtime, :interruption_adapter
+  # Use this to _always_ interrupt the job after it's been running for more than N seconds.
+  # @example
+  #
+  #   JobIteration.max_job_runtime = 5.minutes
+  #
+  # This setting will make it to always interrupt a job after it's been iterating for 5 minutes.
+  # Defaults to nil which means that jobs will not be interrupted except on termination signal.
+  attr_accessor :max_job_runtime
+
+  # Used internally for hooking into job processing frameworks like Sidekiq and Resque.
+  attr_accessor :interruption_adapter
   self.interruption_adapter = -> { false }
 
+  # Set if you want to use your own enumerator builder instead of default EnumeratorBuilder.
+  # @example
+  #
+  #   class MyOwnBuilder < JobIteration::EnumeratorBuilder
+  #     # ...
+  #   end
+  #
+  #   JobIteration.enumerator_builder = MyOwnBuilder
+  attr_accessor :enumerator_builder
+  self.enumerator_builder = JobIteration::EnumeratorBuilder
+
   def load_integrations
     loaded = nil
     INTEGRATIONS.each do |integration|

data/lib/job-iteration/enumerator_builder.rb

@@ -94,12 +94,11 @@ module JobIteration
     #        WHERE (created_at > '$LAST_CREATED_AT_CURSOR'
     #          OR (created_at = '$LAST_CREATED_AT_CURSOR' AND (id > '$LAST_ID_CURSOR')))
     #        ORDER BY created_at, id LIMIT 100
-    def build_active_record_enumerator_on_records(scope, cursor:, columns: nil, batch_size: nil)
+    def build_active_record_enumerator_on_records(scope, cursor:, **args)
       enum = build_active_record_enumerator(
         scope,
         cursor: cursor,
-        columns: columns,
-        batch_size: batch_size,
+        **args
       ).records
       wrap(self, enum)
     end
@@ -110,12 +109,11 @@ module JobIteration
     # +batch_size:+ sets how many records will be fetched in one batch. Defaults to 100.
     #
     # For the rest of arguments, see documentation for #build_active_record_enumerator_on_records
-    def build_active_record_enumerator_on_batches(scope, cursor:, columns: nil, batch_size: nil)
+    def build_active_record_enumerator_on_batches(scope, cursor:, **args)
       enum = build_active_record_enumerator(
         scope,
         cursor: cursor,
-        columns: columns,
-        batch_size: batch_size,
+        **args
       ).batches
       wrap(self, enum)
     end
@@ -128,18 +126,15 @@ module JobIteration
 
     private
 
-    def build_active_record_enumerator(scope, cursor:, columns:, batch_size:)
+    def build_active_record_enumerator(scope, cursor:, **args)
       unless scope.is_a?(ActiveRecord::Relation)
         raise ArgumentError, "scope must be an ActiveRecord::Relation"
       end
 
       JobIteration::ActiveRecordEnumerator.new(
         scope,
-        **{
-          columns: columns,
-          batch_size: batch_size,
-          cursor: cursor,
-        }.compact
+        cursor: cursor,
+        **args
       )
     end
   end

data/lib/job-iteration/iteration.rb

@@ -75,7 +75,7 @@ module JobIteration
     private
 
     def enumerator_builder
-      JobIteration::EnumeratorBuilder.new(self)
+      JobIteration.enumerator_builder.new(self)
     end
 
     def interruptible_perform(*arguments)

data/lib/job-iteration/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-14 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob