tapioca 0.16.11 → 0.17.0

data/lib/tapioca/gem/listeners/sorbet_props.rb

@@ -10,7 +10,8 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           constant = event.constant
           node = event.node
@@ -29,7 +30,8 @@ module Tapioca
           end
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/listeners/sorbet_required_ancestors.rb

@@ -9,7 +9,8 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           ancestors = Runtime::Trackers::RequiredAncestor.required_ancestors_by(event.constant)
           ancestors.each do |ancestor|
@@ -19,7 +20,8 @@ module Tapioca
           end
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/listeners/sorbet_signatures.rb

@@ -14,7 +14,8 @@ module Tapioca
 
         private
 
-        sig { override.params(event: MethodNodeAdded).void }
+        # @override
+        #: (MethodNodeAdded event) -> void
         def on_method(event)
           signature = event.signature
           return unless signature
@@ -22,9 +23,9 @@ module Tapioca
           event.node.sigs << compile_signature(signature, event.parameters)
         end
 
-        sig { params(signature: T.untyped, parameters: T::Array[[Symbol, String]]).returns(RBI::Sig) }
+        #: (untyped signature, Array[[Symbol, String]] parameters) -> RBI::Sig
         def compile_signature(signature, parameters)
-          parameter_types = T.let(signature.arg_types.to_h, T::Hash[Symbol, T::Types::Base])
+          parameter_types = signature.arg_types.to_h #: Hash[Symbol, T::Types::Base]
           parameter_types.merge!(signature.kwarg_types)
           parameter_types[signature.rest_name] = signature.rest_type if signature.has_rest
           parameter_types[signature.keyrest_name] = signature.keyrest_type if signature.has_keyrest
@@ -64,7 +65,7 @@ module Tapioca
           sig
         end
 
-        sig { params(signature: T.untyped).returns(T::Boolean) }
+        #: (untyped signature) -> bool
         def signature_final?(signature)
           modules_with_final = T::Private::Methods.instance_variable_get(:@modules_with_final)
           # In https://github.com/sorbet/sorbet/pull/7531, Sorbet changed internal hashes to be compared by identity,
@@ -75,7 +76,8 @@ module Tapioca
           final_methods.include?(signature.method_name)
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/listeners/sorbet_type_variables.rb

@@ -11,7 +11,8 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           constant = event.constant
           node = event.node
@@ -23,7 +24,7 @@ module Tapioca
           node << sclass if sclass.nodes.length > 1
         end
 
-        sig { params(tree: RBI::Tree, constant: Module).void }
+        #: (RBI::Tree tree, Module constant) -> void
         def compile_type_variable_declarations(tree, constant)
           # Try to find the type variables defined on this constant, bail if we can't
           type_variables = Runtime::GenericTypeRegistry.lookup_type_variables(constant)
@@ -46,7 +47,7 @@ module Tapioca
           tree << RBI::Extend.new("T::Generic")
         end
 
-        sig { params(type_variable: Tapioca::TypeVariableModule).returns(T.nilable(RBI::Node)) }
+        #: (Tapioca::TypeVariableModule type_variable) -> RBI::Node?
         def node_from_type_variable(type_variable)
           case type_variable.type
           when Tapioca::TypeVariableModule::Type::HasAttachedClass
@@ -59,7 +60,8 @@ module Tapioca
           end
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/listeners/source_location.rb

@@ -9,13 +9,15 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ConstNodeAdded).void }
+        # @override
+        #: (ConstNodeAdded event) -> void
         def on_const(event)
           file, line = Object.const_source_location(event.symbol)
           add_source_location_comment(event.node, file, line)
         end
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           # Instead of using `const_source_location`, which always reports the first place where a constant is defined,
           # we filter the locations tracked by ConstantDefinition. This allows us to provide the correct location for
@@ -31,13 +33,14 @@ module Tapioca
           add_source_location_comment(event.node, location.path, location.lineno) unless location.nil?
         end
 
-        sig { override.params(event: MethodNodeAdded).void }
+        # @override
+        #: (MethodNodeAdded event) -> void
         def on_method(event)
           file, line = event.method.source_location
           add_source_location_comment(event.node, file, line)
         end
 
-        sig { params(node: RBI::NodeWithComments, file: T.nilable(String), line: T.nilable(Integer)).void }
+        #: (RBI::NodeWithComments node, String? file, Integer? line) -> void
         def add_source_location_comment(node, file, line)
           return unless file && line
 

data/lib/tapioca/gem/listeners/subconstants.rb

@@ -11,7 +11,8 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           symbol = event.symbol
           constant = event.constant
@@ -31,7 +32,8 @@ module Tapioca
           end
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/listeners/yard_doc.rb

@@ -7,23 +7,20 @@ module Tapioca
       class YardDoc < Base
         extend T::Sig
 
-        IGNORED_COMMENTS = T.let(
-          [
-            ":doc:",
-            ":nodoc:",
-            "typed:",
-            "frozen_string_literal:",
-            "encoding:",
-            "warn_indent:",
-            "shareable_constant_value:",
-            "rubocop:",
-          ],
-          T::Array[String],
-        )
-
-        IGNORED_SIG_TAGS = T.let(["param", "return"], T::Array[String])
-
-        sig { params(pipeline: Pipeline).void }
+        IGNORED_COMMENTS = [
+          ":doc:",
+          ":nodoc:",
+          "typed:",
+          "frozen_string_literal:",
+          "encoding:",
+          "warn_indent:",
+          "shareable_constant_value:",
+          "rubocop:",
+        ] #: Array[String]
+
+        IGNORED_SIG_TAGS = ["param", "return"] #: Array[String]
+
+        #: (Pipeline pipeline) -> void
         def initialize(pipeline)
           YARD::Registry.clear
           super(pipeline)
@@ -32,17 +29,20 @@ module Tapioca
 
         private
 
-        sig { override.params(event: ConstNodeAdded).void }
+        # @override
+        #: (ConstNodeAdded event) -> void
         def on_const(event)
           event.node.comments = documentation_comments(event.symbol)
         end
 
-        sig { override.params(event: ScopeNodeAdded).void }
+        # @override
+        #: (ScopeNodeAdded event) -> void
         def on_scope(event)
           event.node.comments = documentation_comments(event.symbol)
         end
 
-        sig { override.params(event: MethodNodeAdded).void }
+        # @override
+        #: (MethodNodeAdded event) -> void
         def on_method(event)
           separator = event.constant.singleton_class? ? "." : "#"
           event.node.comments = documentation_comments(
@@ -51,7 +51,7 @@ module Tapioca
           )
         end
 
-        sig { params(name: String, sigs: T::Array[RBI::Sig]).returns(T::Array[RBI::Comment]) }
+        #: (String name, ?sigs: Array[RBI::Sig]) -> Array[RBI::Comment]
         def documentation_comments(name, sigs: [])
           yard_docs = YARD::Registry.at(name)
           return [] unless yard_docs
@@ -95,7 +95,8 @@ module Tapioca
           comments
         end
 
-        sig { override.params(event: NodeAdded).returns(T::Boolean) }
+        # @override
+        #: (NodeAdded event) -> bool
         def ignore?(event)
           event.is_a?(Tapioca::Gem::ForeignScopeNodeAdded)
         end

data/lib/tapioca/gem/pipeline.rb

@@ -8,42 +8,35 @@ module Tapioca
       include Runtime::Reflection
       include RBIHelper
 
-      IGNORED_SYMBOLS = T.let(["YAML", "MiniTest", "Mutex"], T::Array[String])
+      IGNORED_SYMBOLS = ["YAML", "MiniTest", "Mutex"] #: Array[String]
 
-      sig { returns(Gemfile::GemSpec) }
+      #: Gemfile::GemSpec
       attr_reader :gem
 
-      sig { returns(T.proc.params(error: String).void) }
+      #: ^(String error) -> void
       attr_reader :error_handler
 
-      sig do
-        params(
-          gem: Gemfile::GemSpec,
-          error_handler: T.proc.params(error: String).void,
-          include_doc: T::Boolean,
-          include_loc: T::Boolean,
-        ).void
-      end
+      #: (Gemfile::GemSpec gem, error_handler: ^(String error) -> void, ?include_doc: bool, ?include_loc: bool) -> void
       def initialize(
         gem,
         error_handler:,
         include_doc: false,
         include_loc: false
       )
-        @root = T.let(RBI::Tree.new, RBI::Tree)
+        @root = RBI::Tree.new #: RBI::Tree
         @gem = gem
-        @seen = T.let(Set.new, T::Set[String])
-        @alias_namespace = T.let(Set.new, T::Set[String])
+        @seen = Set.new #: Set[String]
+        @alias_namespace = Set.new #: Set[String]
         @error_handler = error_handler
 
-        @events = T.let([], T::Array[Gem::Event])
+        @events = [] #: Array[Gem::Event]
 
-        @payload_symbols = T.let(Static::SymbolLoader.payload_symbols, T::Set[String])
-        @bootstrap_symbols = T.let(load_bootstrap_symbols(@gem), T::Set[String])
+        @payload_symbols = Static::SymbolLoader.payload_symbols #: Set[String]
+        @bootstrap_symbols = load_bootstrap_symbols(@gem) #: Set[String]
 
         @bootstrap_symbols.each { |symbol| push_symbol(symbol) }
 
-        @node_listeners = T.let([], T::Array[Gem::Listeners::Base])
+        @node_listeners = [] #: Array[Gem::Listeners::Base]
         @node_listeners << Gem::Listeners::SorbetTypeVariables.new(self)
         @node_listeners << Gem::Listeners::Mixins.new(self)
         @node_listeners << Gem::Listeners::DynamicMixins.new(self)
@@ -60,7 +53,7 @@ module Tapioca
         @node_listeners << Gem::Listeners::RemoveEmptyPayloadScopes.new(self)
       end
 
-      sig { returns(RBI::Tree) }
+      #: -> RBI::Tree
       def compile
         dispatch(next_event) until @events.empty?
         @root
@@ -68,57 +61,45 @@ module Tapioca
 
       # Events handling
 
-      sig { params(symbol: String).void }
+      #: (String symbol) -> void
       def push_symbol(symbol)
         @events << Gem::SymbolFound.new(symbol)
       end
 
-      sig { params(symbol: String, constant: BasicObject).void.checked(:never) }
+      # @without_runtime
+      #: (String symbol, BasicObject constant) -> void
       def push_constant(symbol, constant)
         @events << Gem::ConstantFound.new(symbol, constant)
       end
 
-      sig { params(symbol: String, constant: Module).void.checked(:never) }
+      #: (String symbol, Module constant) -> void
       def push_foreign_constant(symbol, constant)
         @events << Gem::ForeignConstantFound.new(symbol, constant)
       end
 
-      sig { params(symbol: String, constant: Module, node: RBI::Const).void.checked(:never) }
+      #: (String symbol, Module constant, RBI::Const node) -> void
       def push_const(symbol, constant, node)
         @events << Gem::ConstNodeAdded.new(symbol, constant, node)
       end
 
-      sig do
-        params(symbol: String, constant: Module, node: RBI::Scope).void.checked(:never)
-      end
+      #: (String symbol, Module constant, RBI::Scope node) -> void
       def push_scope(symbol, constant, node)
         @events << Gem::ScopeNodeAdded.new(symbol, constant, node)
       end
 
-      sig do
-        params(symbol: String, constant: Module, node: RBI::Scope).void.checked(:never)
-      end
+      #: (String symbol, Module constant, RBI::Scope node) -> void
       def push_foreign_scope(symbol, constant, node)
         @events << Gem::ForeignScopeNodeAdded.new(symbol, constant, node)
       end
 
-      sig do
-        params(
-          symbol: String,
-          constant: Module,
-          method: UnboundMethod,
-          node: RBI::Method,
-          signature: T.untyped,
-          parameters: T::Array[[Symbol, String]],
-        ).void.checked(:never)
-      end
+      #: (String symbol, Module constant, UnboundMethod method, RBI::Method node, untyped signature, Array[[Symbol, String]] parameters) -> void
       def push_method(symbol, constant, method, node, signature, parameters) # rubocop:disable Metrics/ParameterLists
         @events << Gem::MethodNodeAdded.new(symbol, constant, method, node, signature, parameters)
       end
 
       # Constants and properties filtering
 
-      sig { params(symbol_name: String).returns(T::Boolean) }
+      #: (String symbol_name) -> bool
       def symbol_in_payload?(symbol_name)
         symbol_name = symbol_name[2..-1] if symbol_name.start_with?("::")
         return false unless symbol_name
@@ -129,9 +110,9 @@ module Tapioca
       # this looks something like:
       # "(eval at /path/to/file.rb:123)"
       # and we are just interested in the "/path/to/file.rb" part
-      EVAL_SOURCE_FILE_PATTERN = T.let(/\(eval at (.+):\d+\)/, Regexp)
+      EVAL_SOURCE_FILE_PATTERN = /\(eval at (.+):\d+\)/ #: Regexp
 
-      sig { params(name: T.any(String, Symbol)).returns(T::Boolean) }
+      #: ((String | Symbol) name) -> bool
       def constant_in_gem?(name)
         return true unless Object.respond_to?(:const_source_location)
 
@@ -149,7 +130,7 @@ module Tapioca
         gem.contains_path?(source_file)
       end
 
-      sig { params(method: UnboundMethod).returns(T::Boolean) }
+      #: (UnboundMethod method) -> bool
       def method_in_gem?(method)
         source_location = method.source_location&.first
         return false if source_location.nil?
@@ -159,7 +140,7 @@ module Tapioca
 
       # Helpers
 
-      sig { params(constant: Module).returns(T.nilable(String)) }
+      #: (Module constant) -> String?
       def name_of(constant)
         name = name_of_proxy_target(constant, super(class_of(constant)))
         return name if name
@@ -174,7 +155,7 @@ module Tapioca
 
       private
 
-      sig { params(gem: Gemfile::GemSpec).returns(T::Set[String]) }
+      #: (Gemfile::GemSpec gem) -> Set[String]
       def load_bootstrap_symbols(gem)
         engine_symbols = Static::SymbolLoader.engine_symbols(gem)
         gem_symbols = Static::SymbolLoader.gem_symbols(gem)
@@ -184,12 +165,12 @@ module Tapioca
 
       # Events handling
 
-      sig { returns(Gem::Event) }
+      #: -> Gem::Event
       def next_event
         T.must(@events.shift)
       end
 
-      sig { params(event: Gem::Event).void }
+      #: (Gem::Event event) -> void
       def dispatch(event)
         case event
         when Gem::SymbolFound
@@ -203,7 +184,7 @@ module Tapioca
         end
       end
 
-      sig { params(event: Gem::SymbolFound).void }
+      #: (Gem::SymbolFound event) -> void
       def on_symbol(event)
         symbol = event.symbol.delete_prefix("::")
         return if skip_symbol?(symbol)
@@ -212,7 +193,7 @@ module Tapioca
         push_constant(symbol, constant) if Runtime::Reflection.constant_defined?(constant)
       end
 
-      sig { params(event: Gem::ConstantFound).void.checked(:never) }
+      #: (Gem::ConstantFound event) -> void
       def on_constant(event)
         name = event.symbol
         return if skip_constant?(name, event.constant)
@@ -224,14 +205,14 @@ module Tapioca
         end
       end
 
-      sig { params(event: Gem::NodeAdded).void }
+      #: (Gem::NodeAdded event) -> void
       def on_node(event)
         @node_listeners.each { |listener| listener.dispatch(event) }
       end
 
       # Compiling
 
-      sig { params(symbol: String, constant: Module).void }
+      #: (String symbol, Module constant) -> void
       def compile_foreign_constant(symbol, constant)
         return if skip_foreign_constant?(symbol, constant)
         return if seen?(symbol)
@@ -242,7 +223,8 @@ module Tapioca
         push_foreign_scope(symbol, constant, scope)
       end
 
-      sig { params(symbol: String, constant: BasicObject).void.checked(:never) }
+      # @without_runtime
+      #: (String symbol, BasicObject constant) -> void
       def compile_constant(symbol, constant)
         case constant
         when Module
@@ -256,7 +238,7 @@ module Tapioca
         end
       end
 
-      sig { params(name: String, constant: Module).void }
+      #: (String name, Module constant) -> void
       def compile_alias(name, constant)
         return if seen?(name)
 
@@ -277,7 +259,8 @@ module Tapioca
         @root << node
       end
 
-      sig { params(name: String, value: BasicObject).void.checked(:never) }
+      # @without_runtime
+      #: (String name, BasicObject value) -> void
       def compile_object(name, value)
         return if seen?(name)
 
@@ -310,7 +293,7 @@ module Tapioca
         @root << node
       end
 
-      sig { params(name: String, constant: Module).void }
+      #: (String name, Module constant) -> void
       def compile_module(name, constant)
         return if skip_module?(name, constant)
         return if seen?(name)
@@ -321,7 +304,7 @@ module Tapioca
         push_scope(name, constant, scope)
       end
 
-      sig { params(name: String, constant: Module).returns(RBI::Scope) }
+      #: (String name, Module constant) -> RBI::Scope
       def compile_scope(name, constant)
         scope = if constant.is_a?(Class)
           superclass = compile_superclass(constant)
@@ -335,9 +318,9 @@ module Tapioca
         scope
       end
 
-      sig { params(constant: T::Class[T.anything]).returns(T.nilable(String)) }
+      #: (Class[top] constant) -> String?
       def compile_superclass(constant)
-        superclass = T.let(nil, T.nilable(T::Class[T.anything])) # rubocop:disable Lint/UselessAssignment
+        superclass = nil #: Class[top]? # rubocop:disable Lint/UselessAssignment
 
         while (superclass = superclass_of(constant))
           constant_name = name_of(constant)
@@ -386,12 +369,13 @@ module Tapioca
 
       # Constants and properties filtering
 
-      sig { params(name: String).returns(T::Boolean) }
+      #: (String name) -> bool
       def skip_symbol?(name)
         symbol_in_payload?(name) && !@bootstrap_symbols.include?(name)
       end
 
-      sig { params(name: String, constant: T.anything).returns(T::Boolean).checked(:never) }
+      # @without_runtime
+      #: (String name, top constant) -> bool
       def skip_constant?(name, constant)
         return true if name.strip.empty?
         return true if name.start_with?("#<")
@@ -403,7 +387,7 @@ module Tapioca
         false
       end
 
-      sig { params(name: String, constant: Module).returns(T::Boolean) }
+      #: (String name, Module constant) -> bool
       def skip_alias?(name, constant)
         return true if symbol_in_payload?(name)
         return true unless constant_in_gem?(name)
@@ -412,7 +396,8 @@ module Tapioca
         false
       end
 
-      sig { params(name: String, constant: BasicObject).returns(T::Boolean).checked(:never) }
+      # @without_runtime
+      #: (String name, BasicObject constant) -> bool
       def skip_object?(name, constant)
         return true if symbol_in_payload?(name)
         return true unless constant_in_gem?(name)
@@ -420,12 +405,12 @@ module Tapioca
         false
       end
 
-      sig { params(name: String, constant: Module).returns(T::Boolean) }
+      #: (String name, Module constant) -> bool
       def skip_foreign_constant?(name, constant)
         Tapioca::TypeVariableModule === constant
       end
 
-      sig { params(name: String, constant: Module).returns(T::Boolean) }
+      #: (String name, Module constant) -> bool
       def skip_module?(name, constant)
         return true unless defined_in_gem?(constant, strict: false)
         return true if Tapioca::TypeVariableModule === constant
@@ -433,7 +418,7 @@ module Tapioca
         false
       end
 
-      sig { params(constant: Module, strict: T::Boolean).returns(T::Boolean) }
+      #: (Module constant, ?strict: bool) -> bool
       def defined_in_gem?(constant, strict: true)
         files = get_file_candidates(constant)
           .merge(Runtime::Trackers::ConstantDefinition.files_for(constant))
@@ -445,38 +430,38 @@ module Tapioca
         end
       end
 
-      sig { params(constant: Module).returns(T::Set[String]) }
+      #: (Module constant) -> Set[String]
       def get_file_candidates(constant)
         file_candidates_for(constant)
       rescue ArgumentError, NameError
         Set.new
       end
 
-      sig { params(name: String).void }
+      #: (String name) -> void
       def add_to_alias_namespace(name)
         @alias_namespace.add("#{name}::")
       end
 
-      sig { params(name: String).returns(T::Boolean) }
+      #: (String name) -> bool
       def alias_namespaced?(name)
         @alias_namespace.any? do |namespace|
           name.start_with?(namespace)
         end
       end
 
-      sig { params(name: String).void }
+      #: (String name) -> void
       def seen!(name)
         @seen.add(name)
       end
 
-      sig { params(name: String).returns(T::Boolean) }
+      #: (String name) -> bool
       def seen?(name)
         @seen.include?(name)
       end
 
       # Helpers
 
-      sig { params(constant: T.all(Module, T::Generic)).returns(String) }
+      #: ((Module & T::Generic) constant) -> String
       def generic_name_of(constant)
         type_name = T.must(constant.name)
         return type_name if type_name =~ /\[.*\]$/
@@ -492,7 +477,7 @@ module Tapioca
         "#{type_name}[#{type_variable_names}]"
       end
 
-      sig { params(constant: Module, class_name: T.nilable(String)).returns(T.nilable(String)) }
+      #: (Module constant, String? class_name) -> String?
       def name_of_proxy_target(constant, class_name)
         return unless class_name == "ActiveSupport::Deprecation::DeprecatedConstantProxy"
 

data/lib/tapioca/gem_info.rb

@@ -9,7 +9,7 @@ module Tapioca
     class << self
       extend(T::Sig)
 
-      sig { params(spec: Bundler::LazySpecification).returns(GemInfo) }
+      #: (Bundler::LazySpecification spec) -> GemInfo
       def from_spec(spec)
         new(name: spec.name, version: spec.version)
       end