job-iteration 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2d963a3239101fbb564b9864936a7f06413aead04540979b8d3737c7fc1429
-  data.tar.gz: e8b7e4d4d75f263633883d6b24b1af0adfe549b0d8778d2fb57aeb937a482c03
+  metadata.gz: 1c3ab22befabdf3cf98cc50124b312de7dd50326f1dea99b49031eba00b37862
+  data.tar.gz: 179254cc9a30f277ee5a0d562db27812345e64ef2b212a68594a0bf308d1986a
 SHA512:
-  metadata.gz: d3140b3feff8927f989a1ac2ad9c118254793e23119aabe56c405e6a35d0bd944ea176f3398e07fd5e1f0f3f43a7eac053bcf4565dfcc23341c1c26a67e58044
-  data.tar.gz: 4b71e936e4801192f62e1990761dcd544425d5fdffb7020bcabe9f0d91778c50b599d14f341ce04b8491797dff774b02ee26db8ff6dbc8ed1f1a2f0b42d2aa56
+  metadata.gz: 30e2524355311167b9f0ae415558bb7e6b0242f542f92eee81f994e7eb635738ae06ac50189c64963939f1c23e9d0e0741d933a24b413089387020bc0ae6587c
+  data.tar.gz: 72234ba20316ee9e010c82efd04cb5e5594da33cc2ae89623f198f324664888aa145b89b8f873dacf57f035bd8c66ccec6d53beabafa98165c046cddd0f47684

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 #### Bug fix
 
+### v1.1.0 (July 17, 2019)
+
+#### New feature
+
+- [35](https://github.com/Shopify/job-iteration/pull/35) - Raise exception if malformed arguments are use in #build_enumerator
+
 ### v1.0.0 (April 29, 2019)
 
 It’s been in production at Shopify since 2017. It has support for Rails 5 and 6 :tada:

data/job-iteration.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.metadata["changelog_uri"] = "https://github.com/Shopify/job-iteration/blob/master/CHANGELOG.md"
 
+  spec.add_development_dependency("activerecord")
   spec.add_dependency("activejob", ">= 5.2")
 end

data/lib/job-iteration/iteration.rb

@@ -176,7 +176,13 @@ module JobIteration
         )
       end
 
-      unless respond_to?(:build_enumerator, true)
+      if respond_to?(:build_enumerator, true)
+        parameters = method(:build_enumerator).parameters
+        unless valid_cursor_parameter?(parameters)
+          raise ArgumentError, "Iteration job (#{self.class}) #build_enumerator " \
+          "expects the keyword argument `cursor`"
+        end
+      else
         raise ArgumentError, "Iteration job (#{self.class}) must implement #build_enumerator " \
           "to provide a collection to iterate"
       end
@@ -214,5 +220,17 @@ module JobIteration
       when false, :skip_complete_callbacks then false
       end
     end
+
+    def valid_cursor_parameter?(parameters)
+      # this condition is when people use the splat operator.
+      # def build_enumerator(*)
+      return true if parameters == [[:rest]]
+
+      parameters.each do |parameter_type, parameter_name|
+        next unless parameter_name == :cursor
+        return true if parameter_type == :keyreq
+      end
+      false
+    end
   end
 end

data/lib/job-iteration/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement