Sorbet
RubyMine 可以直接从 Ruby 代码推断出许多类型。 例如,它会将字符串文字识别为 字符串 ,并确定 String#length 返回 整数。
当无法可靠地推断类型时,RubyMine 可以使用 Sorbet 类型签名。 可以使用 sig 在 Ruby 代码中内联声明签名,或将其单独存储在 .rbi 文件中。 RubyMine 使用来自这两个来源的类型信息来确定参数、返回值、变量和表达式的类型。
添加类型签名
要直接在 Ruby 代码中声明签名,请扩展
T::Sig并在方法前添加sig声明:# typed: true module MyFoo class Bar end class Service extend T::Sig sig { params(foo: MyFoo::Bar).returns(MyFoo::Bar) } def process(foo) foo end end end service = MyFoo::Service.new result = service.process(MyFoo::Bar.new)该签名声明
process接受并返回MyFoo::Bar类型的对象。 因此,RubyMine 可以确定foo、方法调用和result的类型。要使 Ruby 实现不包含 Sorbet 注解,请在单独的 .rbi 文件中声明相应的类型:
# typed: true module MyFoo class Bar end class Service sig { params(foo: MyFoo::Bar).returns(MyFoo::Bar) } def process(foo); end end end需要显式的
# typed:sigil。 无需向声明添加extend T::Sig。
查看类型信息
将文本光标放在要检查其类型的表达式内。 然后选择 或按 Ctrl+Shift+P。
如果文本光标位置有多个可用表达式,RubyMine 会显示表达式选择器。 选择要查看其类型信息的表达式。

以下示例显示了从直接写入 Ruby 代码的 sig 声明获取的类型信息:

以下示例显示了从单独存储在 RBI 文件中的签名获取的类型信息:

检查类型是否匹配
当方法实参或返回值与其 Sorbet 签名不匹配时,RubyMine 会发出警告。 在以下示例中,
Greeting#greet方法预期使用User的实例:module InspectionExample class User end class Greeting extend T::Sig sig { params(user: User).void } def greet(user) puts "Hello!" end end end greeting = InspectionExample::Greeting.new greeting.greet("Ruby")该调用传递的是
字符串,而不是所需的User。 RubyMine 会高亮显示"Ruby"并报告:Expected type 'User', got 'String' instead。您可以使用 参数类型不匹配 和 返回类型不匹配 检查来管理这些警告。

在 Ruby 和 RBI 文件之间导航
RubyMine 启用从 Ruby 声明到其类型签名的导航,以及从 RBI 签名到其关联 Ruby 声明的导航。
转到类型签名
选择 Ruby 声明,然后在主菜单中转到 。

转到关联的 Ruby 声明
选择类型签名,然后在主菜单中转到 。
