ruby-lsp 0.23.15 → 0.23.17

data/lib/ruby_lsp/document.rb

@@ -3,14 +3,6 @@
 
 module RubyLsp
   class Document
-    class LanguageId < T::Enum
-      enums do
-        Ruby = new("ruby")
-        ERB = new("erb")
-        RBS = new("rbs")
-      end
-    end
-
     extend T::Sig
     extend T::Helpers
     extend T::Generic
@@ -56,8 +48,13 @@ module RubyLsp
       @encoding = global_state.encoding #: Encoding
       @uri = uri #: URI::Generic
       @needs_parsing = true #: bool
-      @parse_result = T.unsafe(nil) #: ParseResultType
       @last_edit = nil #: Edit?
+
+      # Workaround to be able to type parse_result properly. It is immediately set when invoking parse!
+      @parse_result = ( # rubocop:disable Style/RedundantParentheses
+        nil #: as untyped
+      ) #: ParseResultType
+
       parse!
     end
 
@@ -66,7 +63,7 @@ module RubyLsp
       self.class == other.class && uri == other.uri && @source == other.source
     end
 
-    sig { abstract.returns(LanguageId) }
+    sig { abstract.returns(Symbol) }
     def language_id; end
 
     #: [T] (String request_name) { (Document[ParseResultType] document) -> T } -> T

data/lib/ruby_lsp/erb_document.rb

@@ -46,9 +46,9 @@ module RubyLsp
     end
 
     # @override
-    #: -> LanguageId
+    #: -> Symbol
     def language_id
-      LanguageId::ERB
+      :erb
     end
 
     #: (Hash[Symbol, untyped] position, ?node_types: Array[singleton(Prism::Node)]) -> NodeContext

data/lib/ruby_lsp/listeners/completion.rb

@@ -50,7 +50,7 @@ module RubyLsp
         "__LINE__",
       ].freeze
 
-      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem] response_builder, GlobalState global_state, NodeContext node_context, RubyDocument::SorbetLevel sorbet_level, Prism::Dispatcher dispatcher, URI::Generic uri, String? trigger_character) -> void
+      #: (ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem] response_builder, GlobalState global_state, NodeContext node_context, SorbetLevel sorbet_level, Prism::Dispatcher dispatcher, URI::Generic uri, String? trigger_character) -> void
       def initialize( # rubocop:disable Metrics/ParameterLists
         response_builder,
         global_state,
@@ -100,7 +100,7 @@ module RubyLsp
       def on_constant_read_node_enter(node)
         # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
         # no sigil, Sorbet will still provide completion for constants
-        return if @sorbet_level != RubyDocument::SorbetLevel::Ignore
+        return unless @sorbet_level.ignore?
 
         name = RubyIndexer::Index.constant_name(node)
         return if name.nil?
@@ -125,7 +125,7 @@ module RubyLsp
       def on_constant_path_node_enter(node)
         # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
         # no sigil, Sorbet will still provide completion for constants
-        return if @sorbet_level != RubyDocument::SorbetLevel::Ignore
+        return unless @sorbet_level.ignore?
 
         name = begin
           node.full_name
@@ -143,7 +143,7 @@ module RubyLsp
       def on_call_node_enter(node)
         # The only scenario where Sorbet doesn't provide constant completion is on ignored files. Even if the file has
         # no sigil, Sorbet will still provide completion for constants
-        if @sorbet_level == RubyDocument::SorbetLevel::Ignore
+        if @sorbet_level.ignore?
           receiver = node.receiver
 
           # When writing `Foo::`, the AST assigns a method call node (because you can use that syntax to invoke
@@ -390,7 +390,7 @@ module RubyLsp
       def handle_instance_variable_completion(name, location)
         # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
         # to provide all features for them
-        return if @sorbet_level == RubyDocument::SorbetLevel::Strict
+        return if @sorbet_level.strict?
 
         type = @type_inferrer.infer_receiver_type(@node_context)
         return unless type
@@ -475,13 +475,13 @@ module RubyLsp
       def complete_methods(node, name)
         # If the node has a receiver, then we don't need to provide local nor keyword completions. Sorbet can provide
         # local and keyword completion for any file with a Sorbet level of true or higher
-        if !sorbet_level_true_or_higher?(@sorbet_level) && !node.receiver
+        if !@sorbet_level.true_or_higher? && !node.receiver
           add_local_completions(node, name)
           add_keyword_completions(node, name)
         end
 
         # Sorbet can provide completion for methods invoked on self on typed true or higher files
-        return if sorbet_level_true_or_higher?(@sorbet_level) && self_receiver?(node)
+        return if @sorbet_level.true_or_higher? && self_receiver?(node)
 
         type = @type_inferrer.infer_receiver_type(@node_context)
         return unless type
@@ -512,7 +512,7 @@ module RubyLsp
         external_references = @node_context.fully_qualified_name != type.name
 
         @index.method_completion_candidates(method_name, type.name).each do |entry|
-          next if entry.visibility != RubyIndexer::Entry::Visibility::PUBLIC && external_references
+          next if entry.visibility != :public && external_references
 
           entry_name = entry.name
           owner_name = entry.owner&.name

data/lib/ruby_lsp/listeners/definition.rb

@@ -8,7 +8,7 @@ module RubyLsp
 
       MAX_NUMBER_OF_DEFINITION_CANDIDATES_WITHOUT_RECEIVER = 10
 
-      #: (ResponseBuilders::CollectionResponseBuilder[(Interface::Location | Interface::LocationLink)] response_builder, GlobalState global_state, Document::LanguageId language_id, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
+      #: (ResponseBuilders::CollectionResponseBuilder[(Interface::Location | Interface::LocationLink)] response_builder, GlobalState global_state, Symbol language_id, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void
       def initialize(response_builder, global_state, language_id, uri, node_context, dispatcher, sorbet_level) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
         @global_state = global_state
@@ -53,7 +53,7 @@ module RubyLsp
       #: (Prism::CallNode node) -> void
       def on_call_node_enter(node)
         # Sorbet can handle go to definition for methods invoked on self on typed true or higher
-        return if sorbet_level_true_or_higher?(@sorbet_level) && self_receiver?(node)
+        return if @sorbet_level.true_or_higher? && self_receiver?(node)
 
         message = node.message
         return unless message
@@ -62,7 +62,7 @@ module RubyLsp
 
         # Until we can properly infer the receiver type in erb files (maybe with ruby-lsp-rails),
         # treating method calls' type as `nil` will allow users to get some completion support first
-        if @language_id == Document::LanguageId::ERB && inferrer_receiver_type&.name == "Object"
+        if @language_id == :erb && inferrer_receiver_type&.name == "Object"
           inferrer_receiver_type = nil
         end
 
@@ -223,7 +223,7 @@ module RubyLsp
       #: -> void
       def handle_super_node_definition
         # Sorbet can handle super hover on typed true or higher
-        return if sorbet_level_true_or_higher?(@sorbet_level)
+        return if @sorbet_level.true_or_higher?
 
         surrounding_method = @node_context.surrounding_method
         return unless surrounding_method
@@ -276,7 +276,7 @@ module RubyLsp
       def handle_instance_variable_definition(name)
         # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
         # to provide all features for them
-        return if @sorbet_level == RubyDocument::SorbetLevel::Strict
+        return if @sorbet_level.strict?
 
         type = @type_inferrer.infer_receiver_type(@node_context)
         return unless type
@@ -317,7 +317,7 @@ module RubyLsp
         methods.each do |target_method|
           uri = target_method.uri
           full_path = uri.full_path
-          next if sorbet_level_true_or_higher?(@sorbet_level) && (!full_path || not_in_dependencies?(full_path))
+          next if @sorbet_level.true_or_higher? && (!full_path || not_in_dependencies?(full_path))
 
           @response_builder << Interface::LocationLink.new(
             target_uri: uri.to_s,
@@ -392,7 +392,7 @@ module RubyLsp
           uri = entry.uri
           full_path = uri.full_path
 
-          if @sorbet_level != RubyDocument::SorbetLevel::Ignore && (!full_path || not_in_dependencies?(full_path))
+          if !@sorbet_level.ignore? && (!full_path || not_in_dependencies?(full_path))
             next
           end
 

data/lib/ruby_lsp/listeners/document_link.rb

@@ -105,16 +105,13 @@ module RubyLsp
         match = comment.location.slice.match(%r{source://.*#\d+$})
         return unless match
 
-        uri = T.cast(
-          begin
-            URI(
-              match[0], #: as !nil
-            )
-          rescue URI::Error
-            nil
-          end,
-          T.nilable(URI::Source),
-        )
+        uri =  begin
+          URI(
+            match[0], #: as !nil
+          )
+        rescue URI::Error
+          nil
+        end #: as URI::Source?
         return unless uri
 
         gem_version = resolve_version(uri)

data/lib/ruby_lsp/listeners/hover.rb

@@ -42,7 +42,7 @@ module RubyLsp
         "https://gitlab.com",
       ].freeze #: Array[String]
 
-      #: (ResponseBuilders::Hover response_builder, GlobalState global_state, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
+      #: (ResponseBuilders::Hover response_builder, GlobalState global_state, URI::Generic uri, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void
       def initialize(response_builder, global_state, uri, node_context, dispatcher, sorbet_level) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
         @global_state = global_state
@@ -96,7 +96,7 @@ module RubyLsp
 
       #: (Prism::ConstantReadNode node) -> void
       def on_constant_read_node_enter(node)
-        return if @sorbet_level != RubyDocument::SorbetLevel::Ignore
+        return unless @sorbet_level.ignore?
 
         name = RubyIndexer::Index.constant_name(node)
         return if name.nil?
@@ -106,14 +106,14 @@ module RubyLsp
 
       #: (Prism::ConstantWriteNode node) -> void
       def on_constant_write_node_enter(node)
-        return if @sorbet_level != RubyDocument::SorbetLevel::Ignore
+        return unless @sorbet_level.ignore?
 
         generate_hover(node.name.to_s, node.name_loc)
       end
 
       #: (Prism::ConstantPathNode node) -> void
       def on_constant_path_node_enter(node)
-        return if @sorbet_level != RubyDocument::SorbetLevel::Ignore
+        return unless @sorbet_level.ignore?
 
         name = RubyIndexer::Index.constant_name(node)
         return if name.nil?
@@ -128,7 +128,7 @@ module RubyLsp
           return
         end
 
-        return if sorbet_level_true_or_higher?(@sorbet_level) && self_receiver?(node)
+        return if @sorbet_level.true_or_higher? && self_receiver?(node)
 
         message = node.message
         return unless message
@@ -283,7 +283,7 @@ module RubyLsp
       #: -> void
       def handle_super_node_hover
         # Sorbet can handle super hover on typed true or higher
-        return if sorbet_level_true_or_higher?(@sorbet_level)
+        return if @sorbet_level.true_or_higher?
 
         surrounding_method = @node_context.surrounding_method
         return unless surrounding_method
@@ -318,7 +318,7 @@ module RubyLsp
       def handle_instance_variable_hover(name)
         # Sorbet enforces that all instance variables be declared on typed strict or higher, which means it will be able
         # to provide all features for them
-        return if @sorbet_level == RubyDocument::SorbetLevel::Strict
+        return if @sorbet_level.strict?
 
         type = @type_inferrer.infer_receiver_type(@node_context)
         return unless type
@@ -366,9 +366,10 @@ module RubyLsp
         # We should only show hover for private constants if the constant is defined in the same namespace as the
         # reference
         first_entry = entries.first #: as !nil
-        return if first_entry.private? && first_entry.name != "#{@node_context.fully_qualified_name}::#{name}"
+        full_name = first_entry.name
+        return if first_entry.private? && full_name != "#{@node_context.fully_qualified_name}::#{name}"
 
-        categorized_markdown_from_index_entries(name, entries).each do |category, content|
+        categorized_markdown_from_index_entries(full_name, entries).each do |category, content|
           @response_builder.push(content, category: category)
         end
       end

data/lib/ruby_lsp/listeners/signature_help.rb

@@ -6,7 +6,7 @@ module RubyLsp
     class SignatureHelp
       include Requests::Support::Common
 
-      #: (ResponseBuilders::SignatureHelp response_builder, GlobalState global_state, NodeContext node_context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
+      #: (ResponseBuilders::SignatureHelp response_builder, GlobalState global_state, NodeContext node_context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void
       def initialize(response_builder, global_state, node_context, dispatcher, sorbet_level)
         @sorbet_level = sorbet_level
         @response_builder = response_builder
@@ -19,7 +19,7 @@ module RubyLsp
 
       #: (Prism::CallNode node) -> void
       def on_call_node_enter(node)
-        return if sorbet_level_true_or_higher?(@sorbet_level)
+        return if @sorbet_level.true_or_higher?
 
         message = node.message
         return unless message

data/lib/ruby_lsp/listeners/spec_style.rb

@@ -4,9 +4,7 @@
 module RubyLsp
   module Listeners
     class SpecStyle < TestDiscovery
-      extend T::Sig
-
-      #: (response_builder: ResponseBuilders::TestCollection, global_state: GlobalState, dispatcher: Prism::Dispatcher, uri: URI::Generic) -> void
+      #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
         super
 
@@ -22,7 +20,7 @@ module RubyLsp
         )
       end
 
-      #: (node: Prism::ClassNode) -> void
+      #: (Prism::ClassNode) -> void
       def on_class_node_enter(node)
         with_test_ancestor_tracking(node) do |_, ancestors|
           is_spec = ancestors.include?("Minitest::Spec")
@@ -30,14 +28,14 @@ module RubyLsp
         end
       end
 
-      #: (node: Prism::ClassNode) -> void
+      #: (Prism::ClassNode) -> void
       def on_class_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         super
 
         @spec_class_stack.pop
       end
 
-      #: (node: Prism::CallNode) -> void
+      #: (Prism::CallNode) -> void
       def on_call_node_enter(node)
         case node.name
         when :describe
@@ -47,7 +45,7 @@ module RubyLsp
         end
       end
 
-      #: (node: Prism::CallNode) -> void
+      #: (Prism::CallNode) -> void
       def on_call_node_leave(node)
         return unless node.name == :describe && !node.receiver
 
@@ -56,7 +54,7 @@ module RubyLsp
 
       private
 
-      #: (node: Prism::CallNode) -> void
+      #: (Prism::CallNode) -> void
       def handle_describe(node)
         return if node.block.nil?
 
@@ -74,6 +72,7 @@ module RubyLsp
             framework: :minitest,
           )
           @response_builder.add(test_item)
+          @response_builder.add_code_lens(test_item)
         else
           add_to_parent_test_group(description, node)
         end
@@ -81,7 +80,7 @@ module RubyLsp
         @describe_block_nesting << description
       end
 
-      #: (node: Prism::CallNode) -> void
+      #: (Prism::CallNode) -> void
       def handle_example(node)
         return unless in_spec_context?
 
@@ -93,7 +92,7 @@ module RubyLsp
         add_to_parent_test_group(description, node)
       end
 
-      #: (description: String, node: Prism::CallNode) -> void
+      #: (String, Prism::CallNode) -> void
       def add_to_parent_test_group(description, node)
         parent_test_group = find_parent_test_group
         return unless parent_test_group
@@ -106,6 +105,7 @@ module RubyLsp
           framework: :minitest,
         )
         parent_test_group.add(test_item)
+        @response_builder.add_code_lens(test_item)
       end
 
       #: -> Requests::Support::TestItem?
@@ -129,7 +129,7 @@ module RubyLsp
         test_group
       end
 
-      #: (node: Prism::CallNode) -> String?
+      #: (Prism::CallNode) -> String?
       def extract_description(node)
         first_argument = node.arguments&.arguments&.first
         return unless first_argument

data/lib/ruby_lsp/listeners/test_style.rb

@@ -93,9 +93,9 @@ module RubyLsp
             if examples.empty?
               "^#{group_regex}(#|::)"
             elsif examples.length == 1
-              "^#{group_regex}##{examples[0]}$"
+              "^#{group_regex}##{examples[0]}\\$"
             else
-              "^#{group_regex}#(#{examples.join("|")})$"
+              "^#{group_regex}#(#{examples.join("|")})\\$"
             end
           end
 
@@ -116,13 +116,13 @@ module RubyLsp
               Shellwords.escape(TestDiscovery::DYNAMIC_REFERENCE_MARKER),
               ".*",
             )
-            command = +"#{BASE_COMMAND} -Itest #{file_path} --testcase \"/^#{group_regex}$/\""
+            command = +"#{BASE_COMMAND} -Itest #{file_path} --testcase \"/^#{group_regex}\\$/\""
 
             unless examples.empty?
               command << if examples.length == 1
-                " --name \"/#{examples[0]}$/\""
+                " --name \"/#{examples[0]}\\$/\""
               else
-                " --name \"/(#{examples.join("|")})$/\""
+                " --name \"/(#{examples.join("|")})\\$/\""
               end
             end
 
@@ -143,7 +143,7 @@ module RubyLsp
         "ruby"
       end #: String
 
-      #: (ResponseBuilders::TestCollection response_builder, GlobalState global_state, Prism::Dispatcher dispatcher, URI::Generic uri) -> void
+      #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
         super
 
@@ -165,13 +165,16 @@ module RubyLsp
           @framework = :test_unit if ancestors.include?("Test::Unit::TestCase")
 
           if @framework == :test_unit || non_declarative_minitest?(ancestors, name)
-            @response_builder.add(Requests::Support::TestItem.new(
+            test_item = Requests::Support::TestItem.new(
               name,
               name,
               @uri,
               range_from_node(node),
               framework: @framework,
-            ))
+            )
+
+            @response_builder.add(test_item)
+            @response_builder.add_code_lens(test_item)
           end
         end
       end
@@ -191,13 +194,15 @@ module RubyLsp
         test_item = @response_builder[current_group_name]
         return unless test_item
 
-        test_item.add(Requests::Support::TestItem.new(
+        example_item = Requests::Support::TestItem.new(
           "#{current_group_name}##{name}",
           name,
           @uri,
           range_from_node(node),
           framework: @framework,
-        ))
+        )
+        test_item.add(example_item)
+        @response_builder.add_code_lens(test_item)
       end
 
       #: (Prism::CallNode node) -> void

data/lib/ruby_lsp/rbs_document.rb

@@ -36,9 +36,9 @@ module RubyLsp
     end
 
     # @override
-    #: -> LanguageId
+    #: -> Symbol
     def language_id
-      LanguageId::RBS
+      :rbs
     end
   end
 end