Skip to content

Commit

Permalink
Use Prism to determine valid names
Browse files Browse the repository at this point in the history
  • Loading branch information
vinistock committed Oct 30, 2024
1 parent 448e639 commit e62913d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 26 deletions.
34 changes: 8 additions & 26 deletions lib/tapioca/helpers/rbi_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -107,36 +107,18 @@ def as_non_nilable_type(type)

sig { params(name: String).returns(T::Boolean) }
def valid_method_name?(name)
# try to parse a method definition with this name
iseq = RubyVM::InstructionSequence.compile("def #{name}; end", nil, nil, 0, false)
# pull out the first operation in the instruction sequence and its first argument
op, arg, _data = iseq.to_a.dig(-1, 0)
# make sure that the operation is a method definition and the method that was
# defined has the expected name, for example, for `def !foo; end` we don't get
# a syntax error but instead get a method defined as `"foo"`
op == :definemethod && arg == name.to_sym
rescue SyntaxError
false
result = Prism.parse("def #{name}(a); end")
return false unless result.success?

# We don't consider `def foo.bar` as valid for generating RBIs since only `def self.bar` is supported
method_def = result.value.statements.body.first
receiver = method_def.receiver
!receiver || receiver.is_a?(Prism::SelfNode)
end

sig { params(name: String).returns(T::Boolean) }
def valid_parameter_name?(name)
sentinel_method_name = :sentinel_method_name
# try to parse a method definition with this name as the name of a
# keyword parameter. If we use a positional parameter, then parameter names
# like `&` (and maybe others) will be treated like `def foo(&); end` and will
# thus be considered valid. Using a required keyword parameter prevents that
# confusion between Ruby syntax and parameter name.
iseq = RubyVM::InstructionSequence.compile("def #{sentinel_method_name}(#{name}:); end", nil, nil, 0, false)
# pull out the first operation in the instruction sequence and its first argument and data
op, arg, data = iseq.to_a.dig(-1, 0)
# make sure that:
# 1. a method was defined, and
# 2. the method has the expected method name, and
# 3. the method has a keyword parameter with the expected name
op == :definemethod && arg == sentinel_method_name && data.dig(11, :keyword, 0) == name.to_sym
rescue SyntaxError
false
Prism.parse("def sentinel_method_name(#{name}:); end").success?
end
end
end
1 change: 1 addition & 0 deletions lib/tapioca/internal.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
require "thor"
require "yaml"
require "yard-sorbet"
require "prism"

require "tapioca/runtime/dynamic_mixin_compiler"
require "tapioca/sorbet_ext/backcompat_patches"
Expand Down

0 comments on commit e62913d

Please sign in to comment.