job-iteration 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a38399b1ad6f7c81b2dd731e39abc75b4febcbac50ea9c310c6c96ada5f802ff
-  data.tar.gz: 96182f4dcdd4594c9fde855b2394b96a516e7134671a18905ebd3ae6b13ddcfa
+  metadata.gz: b32eb2fd6eb2dc54f59eff462a3cde3882192134c2964ffc05b737957e3d4abb
+  data.tar.gz: 255864c2fac9d3cc0f75da1929d18c1aeb8e63ff83ea3dc6c19038c0e4894e54
 SHA512:
-  metadata.gz: 515d1e0106c1b7c20ce3058df4df1c0c2a29dfb0ebe297bc3ac81da5365b7c8d68cf1058dc5de9c1c37331570260065e59aa86b1801f3b821a70d504aa3b25ac
-  data.tar.gz: 27303a6ea6910734d7d23f6ef0570cf7b2e6f011b1776731829e8366d93e2ad1032c1fce4bf44dee42e1c253f209f97cda8c761824ab7b81f8bfa51a339b0218
+  metadata.gz: 7c241d626e4c92c4424dd08745feab35f1606fafbf6f0d610f34a704d16702a52623f646e5715925b331509257c737053b25bf90091f61a948b6fba2315cc659
+  data.tar.gz: 19b821e84f93954cea21b0709455ac5ad12b2633f70c2182ae93e75d2e883a0985dda1cf7c56ac89295caab1720ef3508857201d0c33f18b35ffad76996f093b

data/.github/workflows/ci.yml

@@ -13,6 +13,7 @@ jobs:
         ports:
           - 6379:6379
     strategy:
+      fail-fast: false
       matrix:
         ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
         rails: ["5.2", "6.0", "6.1", "7.0", "7.1", "7.2", "edge"]

data/CHANGELOG.md

@@ -12,6 +12,12 @@ nil
 
 nil
 
+## v1.9.0 (Feb 3, 2024)
+
+### Features
+
+- [533](https://github.com/Shopify/job-iteration/pull/533) Added a custom compiler for [Tapioca](https://github.com/Shopify/tapioca) that generates Sorbet types for `MyJob.perform_later` if `MyJob` includes `JobIteration::Iteration` and has defined a type for `build_enumerator`.
+
 ## v1.8.0 (Dec 10, 2024)
 
 ### Changes

data/Gemfile

@@ -37,3 +37,6 @@ gem "csv" # required for Ruby 3.4+
 
 # for unit testing optional sorbet support
 gem "sorbet-runtime"
+gem "tapioca"
+
+gem "logger"

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/brianmario/mysql2
-  revision: 58f8d009a0d107776dd6d24c9906426fe0f7b856
+  revision: 57b8df188c963ae0e4d4e1123d3e9de2bbcab637
   specs:
     mysql2 (0.5.6)
       bigdecimal
@@ -8,121 +8,166 @@ GIT
 PATH
   remote: .
   specs:
-    job-iteration (1.8.0)
+    job-iteration (1.9.0)
       activejob (>= 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activejob (8.0.1)
+      activesupport (= 8.0.1)
       globalid (>= 0.3.6)
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activerecord (7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activerecord (8.0.1)
+      activemodel (= 8.0.1)
+      activesupport (= 8.0.1)
       timeout (>= 0.4.0)
-    activesupport (7.1.3.4)
+    activesupport (8.0.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    csv (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    csv (3.3.2)
     drb (2.2.1)
+    erubi (1.13.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    i18n (1.14.6)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
+    logger (1.6.5)
     method_source (1.1.0)
-    minitest (5.24.0)
-    mocha (2.7.0)
+    minitest (5.25.4)
+    mocha (2.7.1)
       ruby2_keywords (>= 0.0.5)
     mono_logger (1.1.2)
     multi_json (1.15.0)
-    mustermann (3.0.0)
+    mustermann (3.0.3)
       ruby2_keywords (~> 0.0.1)
-    mutex_m (0.2.0)
-    parallel (1.25.1)
-    parser (3.3.3.0)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    parser (3.3.7.0)
       ast (~> 2.4.1)
       racc
-    pry (0.15.0)
+    prism (1.3.0)
+    pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.8.0)
-    rack (3.1.5)
-    rack-protection (4.0.0)
+    racc (1.8.1)
+    rack (3.1.8)
+    rack-protection (4.1.1)
       base64 (>= 0.1.0)
+      logger (>= 1.6.0)
       rack (>= 3.0.0, < 4)
-    rack-session (2.0.0)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
       rack (>= 3.0.0)
     rainbow (3.1.1)
     rake (13.2.1)
+    rbi (0.2.4)
+      prism (~> 1.0)
+      sorbet-runtime (>= 0.5.9204)
     redis (5.3.0)
       redis-client (>= 0.22.0)
-    redis-client (0.22.2)
+    redis-client (0.23.2)
       connection_pool
     redis-namespace (1.11.0)
       redis (>= 4)
-    regexp_parser (2.9.2)
-    resque (2.6.0)
-      mono_logger (~> 1.0)
+    regexp_parser (2.10.0)
+    resque (2.7.0)
+      mono_logger (~> 1)
       multi_json (~> 1.0)
       redis-namespace (~> 1.6)
       sinatra (>= 0.9.2)
-    rexml (3.3.9)
-    rubocop (1.64.1)
+    rubocop (1.71.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
     rubocop-shopify (2.15.1)
       rubocop (~> 1.51)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    sidekiq (7.2.4)
-      concurrent-ruby (< 2)
+    securerandom (0.4.1)
+    sidekiq (7.3.8)
+      base64
       connection_pool (>= 2.3.0)
+      logger
       rack (>= 2.2.4)
-      redis-client (>= 0.19.0)
-    sinatra (4.0.0)
+      redis-client (>= 0.22.2)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
       mustermann (~> 3.0)
       rack (>= 3.0.0, < 4)
-      rack-protection (= 4.0.0)
+      rack-protection (= 4.1.1)
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
-    sorbet-runtime (0.5.11460)
-    tilt (2.4.0)
-    timeout (0.4.1)
+    sorbet (0.5.11787)
+      sorbet-static (= 0.5.11787)
+    sorbet-runtime (0.5.11787)
+    sorbet-static (0.5.11787-universal-darwin)
+    sorbet-static (0.5.11787-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11787)
+      sorbet (= 0.5.11787)
+      sorbet-runtime (= 0.5.11787)
+    spoom (1.5.2)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      rbi (>= 0.2.3)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.16.8)
+      benchmark
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    tilt (2.6.0)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
     yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
-  ruby
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux
 
 DEPENDENCIES
   activerecord
@@ -130,6 +175,7 @@ DEPENDENCIES
   globalid
   i18n
   job-iteration!
+  logger
   mocha
   mysql2!
   pry
@@ -139,7 +185,8 @@ DEPENDENCIES
   rubocop-shopify
   sidekiq
   sorbet-runtime
+  tapioca
   yard
 
 BUNDLED WITH
-   2.5.14
+   2.6.1

data/lib/job-iteration/version.rb

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

data/lib/tapioca/dsl/compilers/job_iteration.rb

@@ -0,0 +1,112 @@
+# typed: strict
+# frozen_string_literal: true
+
+return unless defined?(JobIteration::Iteration)
+
+module Tapioca
+  module Dsl
+    module Compilers
+      class JobIteration < Compiler
+        extend T::Sig
+
+        ConstantType = type_member { { fixed: T.class_of(::JobIteration::Iteration) } }
+        PARAM_TYPES_IN_ORDER = [
+          RBI::Param,
+          RBI::OptParam,
+          RBI::RestParam,
+          RBI::KwParam,
+          RBI::KwOptParam,
+          RBI::KwRestParam,
+          RBI::BlockParam,
+        ].freeze
+
+        sig { override.void }
+        def decorate
+          return unless constant.instance_methods(false).include?(:build_enumerator)
+
+          root.create_path(constant) do |job|
+            method = constant.instance_method(:build_enumerator)
+            constant_name = name_of(constant)
+            signature = signature_of(method)
+
+            parameters = compile_method_parameters_to_rbi(method).reject do |typed_param|
+              typed_param.param.name == "cursor"
+            end
+
+            if signature
+              fixed_hash_args = signature.arg_types.select { |arg_type| T::Types::FixedHash === arg_type[1] }.to_h
+              expanded_parameters = parameters.flat_map do |typed_param|
+                if (hash_type = fixed_hash_args[typed_param.param.name.to_sym])
+                  hash_type.types.map do |key, value|
+                    if value.name.start_with?("T.nilable")
+                      create_kw_opt_param(key.to_s, type: value.to_s, default: "nil")
+                    else
+                      create_kw_param(key.to_s, type: value.to_s)
+                    end
+                  end
+                else
+                  typed_param
+                end
+              end
+            else
+              expanded_parameters = parameters
+            end
+
+            # Sorbet expects optional keyword arguments to be after required keyword arguments.
+            expanded_parameters.sort_by! { |typed_param| PARAM_TYPES_IN_ORDER.index(typed_param.param.class) }
+
+            job.create_method(
+              "perform_later",
+              parameters: perform_later_parameters(expanded_parameters, constant_name),
+              return_type: "T.any(#{constant_name}, FalseClass)",
+              class_method: true,
+            )
+
+            job.create_method(
+              "perform_now",
+              parameters: expanded_parameters,
+              return_type: "T.any(NilClass, Exception)",
+              class_method: true,
+            )
+
+            job.create_method(
+              "perform",
+              parameters: expanded_parameters,
+              return_type: "void",
+              class_method: false,
+            )
+          end
+        end
+
+        private
+
+        sig do
+          params(
+            parameters: T::Array[RBI::TypedParam],
+            constant_name: T.nilable(String),
+          ).returns(T::Array[RBI::TypedParam])
+        end
+        def perform_later_parameters(parameters, constant_name)
+          if ::Gem::Requirement.new(">= 7.0").satisfied_by?(::ActiveJob.gem_version)
+            parameters.reject! { |typed_param| RBI::BlockParam === typed_param.param }
+            parameters + [create_block_param(
+              "block",
+              type: "T.nilable(T.proc.params(job: #{constant_name}).void)",
+            )]
+          else
+            parameters
+          end
+        end
+
+        class << self
+          extend T::Sig
+
+          sig { override.returns(T::Enumerable[Module]) }
+          def gather_constants
+            all_classes.select { |c| ::JobIteration::Iteration > c }
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: job-iteration
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Shopify
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-10 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -75,13 +74,13 @@ files:
 - lib/job-iteration/test_helper.rb
 - lib/job-iteration/throttle_enumerator.rb
 - lib/job-iteration/version.rb
+- lib/tapioca/dsl/compilers/job_iteration.rb
 homepage: https://github.com/shopify/job-iteration
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/Shopify/job-iteration/blob/main/CHANGELOG.md
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Makes your background jobs interruptible and resumable.
 test_files: []