-
Notifications
You must be signed in to change notification settings - Fork 112
/
rbi_helper.rb
142 lines (123 loc) · 4.94 KB
/
rbi_helper.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# typed: strict
# frozen_string_literal: true
module Tapioca
module RBIHelper
extend T::Sig
include SorbetHelper
extend SorbetHelper
extend self
class << self
extend T::Sig
sig do
params(
type: String,
variance: Symbol,
fixed: T.nilable(String),
upper: T.nilable(String),
lower: T.nilable(String),
).returns(String)
end
def serialize_type_variable(type, variance, fixed, upper, lower)
variance = nil if variance == :invariant
block = []
block << "fixed: #{fixed}" if fixed
block << "lower: #{lower}" if lower
block << "upper: #{upper}" if upper
parameters = []
parameters << ":#{variance}" if variance
serialized = type.dup
serialized << "(#{parameters.join(", ")})" unless parameters.empty?
serialized << " { { #{block.join(", ")} } }" unless block.empty?
serialized
end
end
sig { params(name: String, type: String).returns(RBI::TypedParam) }
def create_param(name, type:)
create_typed_param(RBI::ReqParam.new(name), type)
end
sig { params(name: String, type: String, default: String).returns(RBI::TypedParam) }
def create_opt_param(name, type:, default:)
create_typed_param(RBI::OptParam.new(name, default), type)
end
sig { params(name: String, type: String).returns(RBI::TypedParam) }
def create_rest_param(name, type:)
create_typed_param(RBI::RestParam.new(name), type)
end
sig { params(name: String, type: String).returns(RBI::TypedParam) }
def create_kw_param(name, type:)
create_typed_param(RBI::KwParam.new(name), type)
end
sig { params(name: String, type: String, default: String).returns(RBI::TypedParam) }
def create_kw_opt_param(name, type:, default:)
create_typed_param(RBI::KwOptParam.new(name, default), type)
end
sig { params(name: String, type: String).returns(RBI::TypedParam) }
def create_kw_rest_param(name, type:)
create_typed_param(RBI::KwRestParam.new(name), type)
end
sig { params(name: String, type: String).returns(RBI::TypedParam) }
def create_block_param(name, type:)
create_typed_param(RBI::BlockParam.new(name), type)
end
sig { params(param: RBI::Param, type: String).returns(RBI::TypedParam) }
def create_typed_param(param, type)
RBI::TypedParam.new(param: param, type: sanitize_signature_types(type))
end
sig { params(sig_string: String).returns(String) }
def sanitize_signature_types(sig_string)
sig_string
.gsub(".returns(<VOID>)", ".void")
.gsub("<VOID>", "void")
.gsub("<NOT-TYPED>", "T.untyped")
.gsub(".params()", "")
end
sig { params(type: String).returns(String) }
def as_nilable_type(type)
if type.start_with?("T.nilable(", "::T.nilable(") || type == "T.untyped" || type == "::T.untyped"
type
else
"T.nilable(#{type})"
end
end
sig { params(type: String).returns(String) }
def as_non_nilable_type(type)
if type.match(/\A(?:::)?T.nilable\((.+)\)\z/)
T.must(::Regexp.last_match(1))
else
type
end
end
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
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
end
end
end