Merge pull request #3333 from Shopify/at-rbs-let

Translate all `T.let` to RBS inline comments supported by Sorbet

Author: Morriar

Gemfile.lock

@@ -48,8 +48,9 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbi (0.2.3)
+    rbi (0.3.1)
       prism (~> 1.0)
+      rbs (>= 3.4.4)
       sorbet-runtime (>= 0.5.9204)
     rbs (3.6.1)
       logger
@@ -98,7 +99,7 @@ GEM
     sorbet-static-and-runtime (0.5.11945)
       sorbet (= 0.5.11945)
       sorbet-runtime (= 0.5.11945)
-    spoom (1.5.4)
+    spoom (1.6.1)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
       rbi (>= 0.2.3)

lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb

@@ -29,7 +29,7 @@ module RubyLsp
       class UseLanguageServerAliases < RuboCop::Cop::Base
         extend RuboCop::Cop::AutoCorrector
 
-        ALIASED_CONSTANTS = T.let([:Interface, :Transport, :Constant].freeze, T::Array[Symbol])
+        ALIASED_CONSTANTS = [:Interface, :Transport, :Constant].freeze #: Array[Symbol]
 
         MSG = "Use constant alias `%{constant}`."
 

lib/ruby_indexer/lib/ruby_indexer/configuration.rb

@@ -3,16 +3,13 @@
 
 module RubyIndexer
   class Configuration
-    CONFIGURATION_SCHEMA = T.let(
-      {
-        "excluded_gems" => Array,
-        "included_gems" => Array,
-        "excluded_patterns" => Array,
-        "included_patterns" => Array,
-        "excluded_magic_comments" => Array,
-      }.freeze,
-      T::Hash[String, T.untyped],
-    )
+    CONFIGURATION_SCHEMA = {
+      "excluded_gems" => Array,
+      "included_gems" => Array,
+      "excluded_patterns" => Array,
+      "included_patterns" => Array,
+      "excluded_magic_comments" => Array,
+    }.freeze #: Hash[String, untyped]
 
     #: String
     attr_writer :workspace_path
@@ -22,18 +19,15 @@ class Configuration
 
     #: -> void
     def initialize
-      @workspace_path = T.let(Dir.pwd, String)
-      @encoding = T.let(Encoding::UTF_8, Encoding)
-      @excluded_gems = T.let(initial_excluded_gems, T::Array[String])
-      @included_gems = T.let([], T::Array[String])
-
-      @excluded_patterns = T.let(
-        [
-          "**/{test,spec}/**/{*_test.rb,test_*.rb,*_spec.rb}",
-          "**/fixtures/**/*",
-        ],
-        T::Array[String],
-      )
+      @workspace_path = Dir.pwd #: String
+      @encoding = Encoding::UTF_8 #: Encoding
+      @excluded_gems = initial_excluded_gems #: Array[String]
+      @included_gems = [] #: Array[String]
+
+      @excluded_patterns = [
+        "**/{test,spec}/**/{*_test.rb,test_*.rb,*_spec.rb}",
+        "**/fixtures/**/*",
+      ] #: Array[String]
 
       path = Bundler.settings["path"]
       if path
@@ -45,23 +39,20 @@ def initialize
 
       # We start the included patterns with only the non excluded directories so that we can avoid paying the price of
       # traversing large directories that don't include Ruby files like `node_modules`
-      @included_patterns = T.let(["{#{top_level_directories.join(",")}}/**/*.rb", "*.rb"], T::Array[String])
-      @excluded_magic_comments = T.let(
-        [
-          "frozen_string_literal:",
-          "typed:",
-          "compiled:",
-          "encoding:",
-          "shareable_constant_value:",
-          "warn_indent:",
-          "rubocop:",
-          "nodoc:",
-          "doc:",
-          "coding:",
-          "warn_past_scope:",
-        ],
-        T::Array[String],
-      )
+      @included_patterns = ["{#{top_level_directories.join(",")}}/**/*.rb", "*.rb"] #: Array[String]
+      @excluded_magic_comments = [
+        "frozen_string_literal:",
+        "typed:",
+        "compiled:",
+        "encoding:",
+        "shareable_constant_value:",
+        "warn_indent:",
+        "rubocop:",
+        "nodoc:",
+        "doc:",
+        "coding:",
+        "warn_past_scope:",
+      ] #: Array[String]
     end
 
     #: -> Array[URI::Generic]
@@ -177,7 +168,7 @@ def indexable_uris
 
     #: -> Regexp
     def magic_comment_regex
-      @magic_comment_regex ||= T.let(/^#\s*#{@excluded_magic_comments.join("|")}/, T.nilable(Regexp))
+      @magic_comment_regex ||= /^#\s*#{@excluded_magic_comments.join("|")}/ #: Regexp?
     end
 
     #: (Hash[String, untyped] config) -> void

lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb

@@ -3,8 +3,8 @@
 
 module RubyIndexer
   class DeclarationListener
-    OBJECT_NESTING = T.let(["Object"].freeze, T::Array[String])
-    BASIC_OBJECT_NESTING = T.let(["BasicObject"].freeze, T::Array[String])
+    OBJECT_NESTING = ["Object"].freeze #: Array[String]
+    BASIC_OBJECT_NESTING = ["BasicObject"].freeze #: Array[String]
 
     #: Array[String]
     attr_reader :indexing_errors
@@ -13,28 +13,24 @@ class DeclarationListener
     def initialize(index, dispatcher, parse_result, uri, collect_comments: false)
       @index = index
       @uri = uri
-      @enhancements = T.let(Enhancement.all(self), T::Array[Enhancement])
-      @visibility_stack = T.let([VisibilityScope.public_scope], T::Array[VisibilityScope])
-      @comments_by_line = T.let(
-        parse_result.comments.to_h do |c|
-          [c.location.start_line, c]
-        end,
-        T::Hash[Integer, Prism::Comment],
-      )
-      @inside_def = T.let(false, T::Boolean)
-      @code_units_cache = T.let(
-        parse_result.code_units_cache(@index.configuration.encoding),
-        T.any(T.proc.params(arg0: Integer).returns(Integer), Prism::CodeUnitsCache),
-      )
-      @source_lines = T.let(parse_result.source.lines, T::Array[String])
+      @enhancements = Enhancement.all(self) #: Array[Enhancement]
+      @visibility_stack = [VisibilityScope.public_scope] #: Array[VisibilityScope]
+      @comments_by_line = parse_result.comments.to_h do |c|
+        [c.location.start_line, c]
+      end #: Hash[Integer, Prism::Comment]
+      @inside_def = false #: bool
+      @code_units_cache = parse_result
+        .code_units_cache(@index.configuration.encoding) #: (^(Integer arg0) -> Integer | Prism::CodeUnitsCache)
+
+      @source_lines = parse_result.source.lines #: Array[String]
 
       # The nesting stack we're currently inside. Used to determine the fully qualified name of constants, but only
       # stored by unresolved aliases which need the original nesting to be lazily resolved
-      @stack = T.let([], T::Array[String])
+      @stack = [] #: Array[String]
 
       # A stack of namespace entries that represent where we currently are. Used to properly assign methods to an owner
-      @owner_stack = T.let([], T::Array[Entry::Namespace])
-      @indexing_errors = T.let([], T::Array[String])
+      @owner_stack = [] #: Array[Entry::Namespace]
+      @indexing_errors = [] #: Array[String]
       @collect_comments = collect_comments
 
       dispatcher.register(

lib/ruby_indexer/lib/ruby_indexer/enhancement.rb

@@ -8,7 +8,7 @@ class Enhancement
 
     abstract!
 
-    @enhancements = T.let([], T::Array[T::Class[Enhancement]])
+    @enhancements = [] #: Array[Class[Enhancement]]
 
     class << self
       extend T::Sig

lib/ruby_indexer/lib/ruby_indexer/entry.rb

@@ -30,7 +30,7 @@ def initialize(name, uri, location, comments)
       @name = name
       @uri = uri
       @comments = comments
-      @visibility = T.let(Visibility::PUBLIC, Visibility)
+      @visibility = Visibility::PUBLIC #: Visibility
       @location = location
     end
 
@@ -137,7 +137,7 @@ class Namespace < Entry
 
       #: (Array[String] nesting, URI::Generic uri, Location location, Location name_location, String? comments) -> void
       def initialize(nesting, uri, location, name_location, comments)
-        @name = T.let(nesting.join("::"), String)
+        @name = nesting.join("::") #: String
         # The original nesting where this namespace was discovered
         @nesting = nesting
 
@@ -156,7 +156,7 @@ def mixin_operation_module_names
       # and prepended
       #: -> Array[ModuleOperation]
       def mixin_operations
-        @mixin_operations ||= T.let([], T.nilable(T::Array[ModuleOperation]))
+        @mixin_operations ||= [] #: Array[ModuleOperation]?
       end
 
       #: -> Integer
@@ -251,7 +251,7 @@ def decorated_name
 
     # A rest method parameter, e.g. `def foo(*a)`
     class RestParameter < Parameter
-      DEFAULT_NAME = T.let(:"<anonymous splat>", Symbol)
+      DEFAULT_NAME = :"<anonymous splat>" #: Symbol
 
       # @override
       #: -> Symbol
@@ -262,7 +262,7 @@ def decorated_name
 
     # A keyword rest method parameter, e.g. `def foo(**a)`
     class KeywordRestParameter < Parameter
-      DEFAULT_NAME = T.let(:"<anonymous keyword splat>", Symbol)
+      DEFAULT_NAME = :"<anonymous keyword splat>" #: Symbol
 
       # @override
       #: -> Symbol
@@ -273,7 +273,7 @@ def decorated_name
 
     # A block method parameter, e.g. `def foo(&block)`
     class BlockParameter < Parameter
-      DEFAULT_NAME = T.let(:"<anonymous block>", Symbol)
+      DEFAULT_NAME = :"<anonymous block>" #: Symbol
 
       class << self
         #: -> BlockParameter
@@ -343,14 +343,11 @@ class Accessor < Member
       # @override
       #: -> Array[Signature]
       def signatures
-        @signatures ||= T.let(
-          begin
-            params = []
-            params << RequiredParameter.new(name: name.delete_suffix("=").to_sym) if name.end_with?("=")
-            [Entry::Signature.new(params)]
-          end,
-          T.nilable(T::Array[Signature]),
-        )
+        @signatures ||= begin
+          params = []
+          params << RequiredParameter.new(name: name.delete_suffix("=").to_sym) if name.end_with?("=")
+          [Entry::Signature.new(params)]
+        end #: Array[Signature]?
       end
     end
 
@@ -484,7 +481,7 @@ def initialize(target, unresolved_alias)
         )
 
         @target = target
-        @owner = T.let(unresolved_alias.owner, T.nilable(Entry::Namespace))
+        @owner = unresolved_alias.owner #: Entry::Namespace?
       end
 
       #: -> String
@@ -539,10 +536,10 @@ def format
       #: (Array[Prism::Node] arguments) -> bool
       def matches?(arguments)
         min_pos = 0
-        max_pos = T.let(0, T.any(Integer, Float))
+        max_pos = 0 #: (Integer | Float)
         names = []
-        has_forward = T.let(false, T::Boolean)
-        has_keyword_rest = T.let(false, T::Boolean)
+        has_forward = false #: bool
+        has_keyword_rest = false #: bool
 
         @parameters.each do |param|
           case param

lib/ruby_indexer/lib/ruby_indexer/index.rb

@@ -57,34 +57,31 @@ def initialize
       #  "Foo" => [#<Entry::Class>, #<Entry::Class>],
       #  "Foo::Bar" => [#<Entry::Class>],
       # }
-      @entries = T.let({}, T::Hash[String, T::Array[Entry]])
+      @entries = {} #: Hash[String, Array[Entry]]
 
       # Holds all entries in the index using a prefix tree for searching based on prefixes to provide autocompletion
-      @entries_tree = T.let(PrefixTree[T::Array[Entry]].new, PrefixTree[T::Array[Entry]])
+      @entries_tree = PrefixTree[T::Array[Entry]].new #: PrefixTree[Array[Entry]]
 
       # Holds references to where entries where discovered so that we can easily delete them
       # {
       #  "file:///my/project/foo.rb" => [#<Entry::Class>, #<Entry::Class>],
       #  "file:///my/project/bar.rb" => [#<Entry::Class>],
       #  "untitled:Untitled-1" => [#<Entry::Class>],
       # }
-      @uris_to_entries = T.let({}, T::Hash[String, T::Array[Entry]])
+      @uris_to_entries = {} #: Hash[String, Array[Entry]]
 
       # Holds all require paths for every indexed item so that we can provide autocomplete for requires
-      @require_paths_tree = T.let(PrefixTree[URI::Generic].new, PrefixTree[URI::Generic])
+      @require_paths_tree = PrefixTree[URI::Generic].new #: PrefixTree[URI::Generic]
 
       # Holds the linearized ancestors list for every namespace
-      @ancestors = T.let({}, T::Hash[String, T::Array[String]])
+      @ancestors = {} #: Hash[String, Array[String]]
 
       # Map of module name to included hooks that have to be executed when we include the given module
-      @included_hooks = T.let(
-        {},
-        T::Hash[String, T::Array[T.proc.params(index: Index, base: Entry::Namespace).void]],
-      )
+      @included_hooks = {} #: Hash[String, Array[^(Index index, Entry::Namespace base) -> void]]
 
-      @configuration = T.let(RubyIndexer::Configuration.new, Configuration)
+      @configuration = RubyIndexer::Configuration.new #: Configuration
 
-      @initial_indexing_completed = T.let(false, T::Boolean)
+      @initial_indexing_completed = false #: bool
     end
 
     # Register an included `hook` that will be executed when `module_name` is included into any namespace

lib/ruby_indexer/lib/ruby_indexer/prefix_tree.rb

@@ -39,7 +39,7 @@ class PrefixTree
 
     #: -> void
     def initialize
-      @root = T.let(Node.new("", ""), Node[Value])
+      @root = Node.new("", "") #: Node[Value]
     end
 
     # Search the PrefixTree based on a given `prefix`. If `foo` is an entry in the tree, then searching for `fo` will
@@ -78,7 +78,7 @@ def delete(key)
       return unless node
 
       # Remove the node from the tree and then go up the parents to remove any of them with empty children
-      parent = T.let(T.must(node.parent), T.nilable(Node[Value]))
+      parent = T.must(node.parent) #: Node[Value]?
 
       while parent
         parent.children.delete(node.key)

lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb

@@ -3,7 +3,7 @@
 
 module RubyIndexer
   class RBSIndexer
-    HAS_UNTYPED_FUNCTION = T.let(!!defined?(RBS::Types::UntypedFunction), T::Boolean)
+    HAS_UNTYPED_FUNCTION = !!defined?(RBS::Types::UntypedFunction) #: bool
 
     #: (Index index) -> void
     def initialize(index)

lib/ruby_indexer/lib/ruby_indexer/reference_finder.rb

@@ -66,8 +66,8 @@ def initialize(target, index, dispatcher, uri, include_declarations: true)
       @index = index
       @uri = uri
       @include_declarations = include_declarations
-      @stack = T.let([], T::Array[String])
-      @references = T.let([], T::Array[Reference])
+      @stack = [] #: Array[String]
+      @references = [] #: Array[Reference]
 
       dispatcher.register(
         self,

lib/ruby_lsp/addon.rb

@@ -25,10 +25,10 @@ class Addon
 
     abstract!
 
-    @addons = T.let([], T::Array[Addon])
-    @addon_classes = T.let([], T::Array[T.class_of(Addon)])
+    @addons = [] #: Array[Addon]
+    @addon_classes = [] #: Array[singleton(Addon)]
     # Add-on instances that have declared a handler to accept file watcher events
-    @file_watcher_addons = T.let([], T::Array[Addon])
+    @file_watcher_addons = [] #: Array[Addon]
 
     AddonNotFoundError = Class.new(StandardError)
 
@@ -149,7 +149,7 @@ def depend_on_ruby_lsp!(*version_constraints)
 
     #: -> void
     def initialize
-      @errors = T.let([], T::Array[StandardError])
+      @errors = [] #: Array[StandardError]
     end
 
     #: (StandardError error) -> self