Skip to content

Support conditional arguments in Sorbet compiler #593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 23, 2025
Merged

Support conditional arguments in Sorbet compiler #593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/tapioca/dsl/compilers/job_iteration.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class JobIteration < Compiler

ConstantType = type_member { { fixed: T.class_of(::JobIteration::Iteration) } }
PARAM_TYPES_IN_ORDER = [
RBI::Param,
RBI::ReqParam,
RBI::OptParam,
RBI::RestParam,
RBI::KwParam,
Expand Down
144 changes: 144 additions & 0 deletions test/tapioca/dsl/compilers/job_iteration_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,41 @@ def perform_now(user_id); end
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_optional_parameter
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
include JobIteration::Iteration

def build_enumerator(user_id, foo_id = nil, cursor:)
# ...
end
end
RUBY

expected = template(<<~RBI)
# typed: strong

class NotifyJob
sig { params(user_id: T.untyped, foo_id: T.untyped).void }
def perform(user_id, foo_id = T.unsafe(nil)); end

class << self
<% if rails_version(">= 7.0") %>
sig { params(user_id: T.untyped, foo_id: T.untyped, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id, foo_id = T.unsafe(nil), &block); end
<% else %>
sig { params(user_id: T.untyped, foo_id: T.untyped).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id, foo_id = T.unsafe(nil)); end
<% end %>

sig { params(user_id: T.untyped, foo_id: T.untyped).returns(T.any(NilClass, Exception)) }
def perform_now(user_id, foo_id = T.unsafe(nil)); end
end
end
RBI
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_with_keyword_parameter
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
Expand Down Expand Up @@ -121,6 +156,41 @@ def perform_now(user_id:, profile_id:); end
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_with_optional_keyword_parameter
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
include JobIteration::Iteration

def build_enumerator(user_id:, profile_id: nil, cursor:)
# ...
end
end
RUBY

expected = template(<<~RBI)
# typed: strong

class NotifyJob
sig { params(user_id: T.untyped, profile_id: T.untyped).void }
def perform(user_id:, profile_id: T.unsafe(nil)); end

class << self
<% if rails_version(">= 7.0") %>
sig { params(user_id: T.untyped, profile_id: T.untyped, block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id:, profile_id: T.unsafe(nil), &block); end
<% else %>
sig { params(user_id: T.untyped, profile_id: T.untyped).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id:, profile_id: T.unsafe(nil)); end
<% end %>

sig { params(user_id: T.untyped, profile_id: T.untyped).returns(T.any(NilClass, Exception)) }
def perform_now(user_id:, profile_id: T.unsafe(nil)); end
end
end
RBI
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_signature
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
Expand Down Expand Up @@ -158,6 +228,43 @@ def perform_now(user_id); end
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_optional_parameter_and_signature
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
include JobIteration::Iteration

extend T::Sig
sig { params(user_id: Integer, foo_id: T.nilable(String), cursor: T.untyped).returns(T::Array[T.untyped]) }
def build_enumerator(user_id, foo_id = nil, cursor:)
# ...
end
end
RUBY

expected = template(<<~RBI)
# typed: strong

class NotifyJob
sig { params(user_id: ::Integer, foo_id: T.nilable(::String)).void }
def perform(user_id, foo_id = T.unsafe(nil)); end

class << self
<% if rails_version(">= 7.0") %>
sig { params(user_id: ::Integer, foo_id: T.nilable(::String), block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id, foo_id = T.unsafe(nil), &block); end
<% else %>
sig { params(user_id: ::Integer, foo_id: T.nilable(::String)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id, foo_id = T.unsafe(nil)); end
<% end %>

sig { params(user_id: ::Integer, foo_id: T.nilable(::String)).returns(T.any(NilClass, Exception)) }
def perform_now(user_id, foo_id = T.unsafe(nil)); end
end
end
RBI
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_signature_with_keyword_parameter
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
Expand Down Expand Up @@ -195,6 +302,43 @@ def perform_now(user_id:, profile_id:); end
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_with_optional_keyword_parameter_and_signature
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
include JobIteration::Iteration

extend T::Sig
sig { params(user_id: Integer, cursor: T.untyped, profile_id: T.nilable(Integer)).returns(T::Array[T.untyped]) }
def build_enumerator(user_id:, cursor:, profile_id: nil)
# ...
end
end
RUBY

expected = template(<<~RBI)
# typed: strong

class NotifyJob
sig { params(user_id: ::Integer, profile_id: T.nilable(::Integer)).void }
def perform(user_id:, profile_id: T.unsafe(nil)); end

class << self
<% if rails_version(">= 7.0") %>
sig { params(user_id: ::Integer, profile_id: T.nilable(::Integer), block: T.nilable(T.proc.params(job: NotifyJob).void)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id:, profile_id: T.unsafe(nil), &block); end
<% else %>
sig { params(user_id: ::Integer, profile_id: T.nilable(::Integer)).returns(T.any(NotifyJob, FalseClass)) }
def perform_later(user_id:, profile_id: T.unsafe(nil)); end
<% end %>

sig { params(user_id: ::Integer, profile_id: T.nilable(::Integer)).returns(T.any(NilClass, Exception)) }
def perform_now(user_id:, profile_id: T.unsafe(nil)); end
end
end
RBI
assert_equal(expected, rbi_for(:NotifyJob))
end

def test_generates_correct_rbi_file_for_job_with_build_enumerator_method_with_multiple_parameters
add_ruby_file("job.rb", <<~RUBY)
class NotifyJob < ActiveJob::Base
Expand Down