Skip to content

Remove NilClass parameters from AR fixture methods #2660

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
amomchilov merged 1 commit into from
Jul 3, 2026
+23 −26
Merged

Remove NilClass parameters from AR fixture methods #2660

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
17 changes: 7 additions & 10 deletions lib/tapioca/dsl/compilers/active_record_fixtures.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ module Compilers
# # test_case.rbi
# # typed: true
# class ActiveSupport::TestCase
# sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Post]) }
# sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Post) }
# sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol))
# .returns(T::Array[Post]) }
# sig { returns(T::Array[Post]) } # No names: returns an Array of all fixtures
# sig { params(fixture_name: T.any(String, Symbol)).returns(Post) } # One name: returns the requested fixture
# sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)) # Many names: returns an Array of the requested fixtures
# .returns(T::Array[Post]) }
# def posts(fixture_name = nil, *other_fixtures); end
# end
# ~~~
Expand Down Expand Up @@ -110,19 +110,16 @@ def create_fixture_method(mod, name)
node.add_opt_param("fixture_name", "nil")
node.add_rest_param("other_fixtures")

node.add_sig do |sig|
sig.add_param("fixture_name", "NilClass")
sig.add_param("other_fixtures", "NilClass")
node.add_sig do |sig| # No-parameter overload: returns an Array of all fixtures
sig.return_type = "T::Array[#{return_type}]"
end

node.add_sig do |sig|
node.add_sig do |sig| # One parameter overload: returns the requested fixture
sig.add_param("fixture_name", "T.any(String, Symbol)")
sig.add_param("other_fixtures", "NilClass")
sig.return_type = return_type
end

node.add_sig do |sig|
node.add_sig do |sig| # Multi-parameter overload: returns an Array of the requested fixtures
sig.add_param("fixture_name", "T.any(String, Symbol)")
sig.add_param("other_fixtures", "T.any(String, Symbol)")
sig.return_type = "T::Array[#{return_type}]"
Expand Down
8 changes: 4 additions & 4 deletions manual/compiler_activerecordfixtures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ The generated RBI by this compiler will produce the following
# test_case.rbi
# typed: true
class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Post) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol))
.returns(T::Array[Post]) }
sig { returns(T::Array[Post]) } # No names: returns an Array of all fixtures
sig { params(fixture_name: T.any(String, Symbol)).returns(Post) } # One name: returns the requested fixture
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)) # Many names: returns an Array of the requested fixtures
.returns(T::Array[Post]) }
def posts(fixture_name = nil, *other_fixtures); end
end
~~~
24 changes: 12 additions & 12 deletions spec/tapioca/dsl/compilers/active_record_fixtures_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ class Post < ActiveRecord::Base
# typed: strong

class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Post) }
sig { returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(Post) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[Post]) }
def posts(fixture_name = nil, *other_fixtures); end
end
Expand All @@ -107,8 +107,8 @@ class Post < ActiveRecord::Base
# typed: strong

class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Post) }
sig { returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(Post) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[Post]) }
def posts(fixture_name = nil, *other_fixtures); end
end
Expand Down Expand Up @@ -146,13 +146,13 @@ class User < ActiveRecord::Base
# typed: strong

class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Blog::Post]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Blog::Post) }
sig { returns(T::Array[Blog::Post]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(Blog::Post) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[Blog::Post]) }
def blog_posts(fixture_name = nil, *other_fixtures); end

sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[User]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(User) }
sig { returns(T::Array[User]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(User) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[User]) }
def users(fixture_name = nil, *other_fixtures); end
end
Expand Down Expand Up @@ -181,8 +181,8 @@ class Post < ActiveRecord::Base
# typed: strong

class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(Post) }
sig { returns(T::Array[Post]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(Post) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[Post]) }
def posts_with_other_names(fixture_name = nil, *other_fixtures); end
end
Expand All @@ -204,8 +204,8 @@ def posts_with_other_names(fixture_name = nil, *other_fixtures); end
# typed: strong

class ActiveSupport::TestCase
sig { params(fixture_name: NilClass, other_fixtures: NilClass).returns(T::Array[T.untyped]) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: NilClass).returns(T.untyped) }
sig { returns(T::Array[T.untyped]) }
sig { params(fixture_name: T.any(String, Symbol)).returns(T.untyped) }
sig { params(fixture_name: T.any(String, Symbol), other_fixtures: T.any(String, Symbol)).returns(T::Array[T.untyped]) }
def posts(fixture_name = nil, *other_fixtures); end
end
Expand Down
Loading