Skip to content

Support RBS signatures in check-shims command #2482

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

Open
sambostock wants to merge 2 commits into
base: main
Choose a base branch
from
+94 −1
Open

Support RBS signatures in check-shims command #2482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e972340
Support RBS signatures in check-shims command
sambostock Jan 7, 2026
55b64a0
Add comment explaining why intersect? can't be used
sambostock Jan 7, 2026
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
14 changes: 13 additions & 1 deletion lib/tapioca/helpers/rbi_files_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,9 @@ def has_duplicated_methods_and_attrs?(nodes, shims_or_todos)
shims_or_todos_props.each do |shim_or_todo_prop|
other_nodes = extract_methods_and_attrs(nodes) - [shim_or_todo_prop]

if shim_or_todo_prop.sigs.empty?
shim_rbs_comments = extract_rbs_comments(shim_or_todo_prop)

if shim_or_todo_prop.sigs.empty? && shim_rbs_comments.empty?
# If the node doesn't have a signature and is an attribute accessor, we have a duplicate
return true if shim_or_todo_prop.is_a?(RBI::Attr)

Expand All @@ -235,6 +237,11 @@ def has_duplicated_methods_and_attrs?(nodes, shims_or_todos)
other_nodes.each do |node|
# Another prop has the same sig, we have a duplicate
return true if shim_or_todo_prop.sigs.any? { |sig| node.sigs.include?(sig) }

# Another prop has the same RBS comment, we have a duplicate
# Note: can't use `intersect?` here because RBI::RBSComment doesn't implement `eql?`/`hash`
other_rbs_comments = extract_rbs_comments(node)
return true if shim_rbs_comments.any? { |rbs| other_rbs_comments.include?(rbs) }
Copy link
Contributor

@amomchilov amomchilov Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return true if shim_rbs_comments.any? { |rbs| other_rbs_comments.include?(rbs) }
return true if shim_rbs_comments.intersect?(other_rbs_comments)

Copy link
Contributor Author

@sambostock sambostock Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately intersect? won't work here because RBI::RBSComment implements == but not eql?/hash:

c1 = RBI::RBSComment.new('() -> void')
c2 = RBI::RBSComment.new('() -> void')

c1 == c2           # => true
[c1].include?(c2)  # => true  (uses ==)
[c1].intersect?([c2])  # => false (uses eql?/hash)

I've added a comment to explain this.

end
end
end
Expand All @@ -259,6 +266,11 @@ def extract_methods_and_attrs(nodes)
)
end

#: ((RBI::Method | RBI::Attr) node) -> Array[RBI::RBSComment]
def extract_rbs_comments(node)
node.comments.grep(RBI::RBSComment)
end

#: (Array[Spoom::Sorbet::Errors::Error] errors, String gem_dir) -> void
def update_gem_rbis_strictnesses(errors, gem_dir)
files = []
Expand Down
81 changes: 81 additions & 0 deletions spec/tapioca/cli/check_shims_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,87 @@ def foo; end
assert_success_status(result)
end

it "ignores duplicates that have an RBS signature" do
@project.write!("sorbet/rbi/gems/[email protected]", <<~RBI)
class Foo
def foo; end
end
RBI

@project.write!("sorbet/rbi/shims/foo.rbi", <<~RBI)
class Foo
#: () -> void
def foo; end
end
RBI

result = @project.tapioca("check-shims --no-payload")
assert_success_status(result)
end

it "ignores duplicates that have a different RBS signature" do
@project.write!("sorbet/rbi/gems/[email protected]", <<~RBI)
class Foo
#: () -> void
def foo; end
end
RBI

@project.write!("sorbet/rbi/shims/foo.rbi", <<~RBI)
class Foo
#: () -> Integer
def foo; end
end
RBI

result = @project.tapioca("check-shims --no-payload")
assert_success_status(result)
end

it "detects duplicates that have the same RBS signature" do
@project.write!("sorbet/rbi/gems/[email protected]", <<~RBI)
class Foo
#: (Integer x, String y) -> String
def foo(x, y); end

#: (Integer x, Integer y) -> String
def bar(x, y); end

#: (Integer x, Integer y) -> Integer
def baz(x, y); end
end
RBI

@project.write!("sorbet/rbi/shims/foo.rbi", <<~RBI)
class Foo
#: (Integer x, String y) -> String
def foo(x, y); end

#: (String x, Integer y) -> String
def bar(x, y); end

#: (Integer x, Integer y) -> String
def baz(x, y); end
end
RBI

result = @project.tapioca("check-shims --no-payload")

assert_stderr_equals(<<~ERR, result)

Duplicated RBI for ::Foo#foo:
* sorbet/rbi/shims/foo.rbi:3:2-3:20
* sorbet/rbi/gems/[email protected]:3:2-3:20

Please remove the duplicated definitions from sorbet/rbi/shims and sorbet/rbi/todo.rbi
ERR

refute_includes(result.err, "Duplicated RBI for ::Foo#bar")
refute_includes(result.err, "Duplicated RBI for ::Foo#baz")

refute_success_status(result)
end

it "detects duplicates that have the same signature" do
@project.write!("sorbet/rbi/gems/[email protected]", <<~RBI)
class Foo
Expand Down
Loading