rbs下載 - rbs原始碼下載

蘇格蘭皇家銀行

RBS是一種描述Ruby程式結構的語言。您可以寫下類別或模組的定義：類別中定義的方法、實例變數及其類型以及繼承/混合關係。它還允許聲明常數和全域變數。

以下是聊天應用程式的 RBS 的一個小範例。

 module ChatApp
  VERSION: String

  class User
    attr_reader login: String
    attr_reader email: String

    def initialize : (login: String, email: String) -> void
  end

  class Bot
    attr_reader name: String
    attr_reader email: String
    attr_reader owner: User

    def initialize : (name: String, owner: User) -> void
  end

  class Message
    attr_reader id: String
    attr_reader string: String
    attr_reader from: User | Bot                     # `|` means union types: `#from` can be `User` or `Bot`
    attr_reader reply_to: Message?                   # `?` means optional type: `#reply_to` can be `nil`

    def initialize : (from: User | Bot, string: String) -> void

    def reply : (from: User | Bot, string: String) -> Message
  end

  class Channel
    attr_reader name: String
    attr_reader messages: Array[Message]
    attr_reader users: Array[User]
    attr_reader bots: Array[Bot]

    def initialize : (name: String) -> void

    def each_member : () { (User | Bot) -> void } -> void  # `{` and `}` means block.
                   | () -> Enumerator[User | Bot, void ]   # Method can be overloaded.
  end
end

目標版本

標準庫簽名針對最新版本的 Ruby。（自 2023 年起為3.2 。）
該函式庫程式碼面向非 EOL 版本的 Ruby。（截至 2023 年， >= 3.0 。）

安裝

安裝rbs gem。 $ gem install rbs從命令列，或在Gemfile中新增一行。

 gem "rbs"

命令列介面

gem 附帶了rbs命令列工具來示範它的功能並協助開發 RBS。

$ rbs version
$ rbs list
$ rbs ancestors ::Object
$ rbs methods ::Object
$ rbs method Object then

rbs的最終用戶可能會發現rbs prototype最有用。此命令產生 ruby 檔案的樣板簽署聲明。例如，假設您編寫了以下 ruby 腳本。

 # person.rb
class Person
  attr_reader :name
  attr_reader :contacts

  def initialize ( name : )
    @name = name
    @contacts = [ ]
  end

  def speak
    "I'm #{ @name } and I love Ruby!"
  end
end

在上面運行prototype會自動生成

$ rbs prototype rb person.rb
class Person
  @name: untyped

  @contacts: untyped

  attr_reader name: untyped

  attr_reader contacts: untyped

  def initialize: (name: untyped) -> void

  def speak: () -> ::String
end

它列印所有方法、類別、實例變數和常數的簽章。這只是一個起點，您應該編輯輸出以更準確地匹配您的簽名。

rbs prototype提供了三種選擇。

rb僅從可用的 Ruby 程式碼生成
rbi從冰糕 RBI 生成
runtime從運行時 API 生成

圖書館

有兩個重要的概念，環境和定義。

環境是一個追蹤所有聲明的字典。與String類別相關的聲明是什麼？環境會給你答案。

定義為您提供了類別的詳細資訊。 String類別的gsub方法的回傳值是什麼型別？ String類別的定義知道它提供的方法清單及其類型。

以下是檢索String#gsub方法的定義的小程式碼。

# (::Regexp | ::string pattern, ::string replacement) -> ::String # (::Regexp | ::string pattern, ::Hash[::String, ::String] hash) -> ::String # (::Regexp | ::string pattern) { (::String match) -> ::_ToS } -> ::String # (::Regexp | ::string pattern) -> ::Enumerator[::String, self] # Definition of singleton of String singleton = builder.build_singleton(string) # No `gsub` method for String singleton puts singleton.methods[:gsub]">

 require "rbs"

loader = RBS :: EnvironmentLoader . new ( )

# loader.add(path: Pathname("sig"))   # Load .rbs files from `sig` directory
# loader.add(library: "pathname")     # Load pathname library

environment = RBS :: Environment . from_loader ( loader ) . resolve_type_names

# ::String
string = RBS :: TypeName . new ( name : :String , namespace : RBS :: Namespace . root )

# Class declaration for ::String
decl = environment . class_decls [ string ]

# Builder provides the translation from `declaration` to `definition`
builder = RBS :: DefinitionBuilder . new ( env : environment )

# Definition of instance of String
instance = builder . build_instance ( string )

# Print the types of `gsub` method:
puts instance . methods [ :gsub ] . method_types . join ( " n " )
# Outputs =>
#  (::Regexp | ::string pattern, ::string replacement) -> ::String
#  (::Regexp | ::string pattern, ::Hash[::String, ::String] hash) -> ::String
#  (::Regexp | ::string pattern) { (::String match) -> ::_ToS } -> ::String
#  (::Regexp | ::string pattern) -> ::Enumerator[::String, self]

# Definition of singleton of String
singleton = builder . build_singleton ( string )
# No `gsub` method for String singleton
puts singleton . methods [ :gsub ]

指南

建築學
核心和標準庫簽名貢獻指南
書寫簽名指南
Stdlib 簽名指南
句法
蘇格蘭皇家銀行為例
蘇格蘭皇家銀行收藏
使用Data和Struct
與 RBS 一起發布 gem

社群

以下是您可以與活躍維護者交談的一些地方的清單。

Ruby Discord 伺服器（邀請連結）－我們在 Ruby Discord 伺服器中擁有rbs頻道。
ruby-jp Slack Workspace（日文）－我們在 ruby-jp Slack 工作空間中有types通道。
gem_rbs_collection－我們有一個第三方 RBS 類型定義的儲存庫，以防您的依賴項不隨 RBS 檔案附帶。

發展

查看儲存庫後，執行bin/setup以安裝相依性。然後，執行bundle exec rake test來執行測試。您也可以執行bin/console以獲得互動式提示，以便您進行實驗。

若要將此 gem 安裝到本機上，請執行bundle exec rake install 。若要發布新版本，請更新version.rb中的版本號，然後執行bundle exec rake release ，這將為該版本建立 git 標籤，推送 git 提交和標籤，並將.gem檔案推送到rubygems .org。