ruby-lsp 0.14.6 → 0.16.4

data/lib/ruby_lsp/global_state.rb

@@ -0,0 +1,169 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  class GlobalState
+    extend T::Sig
+
+    sig { returns(String) }
+    attr_reader :test_library
+
+    sig { returns(String) }
+    attr_accessor :formatter
+
+    sig { returns(T::Boolean) }
+    attr_reader :typechecker
+
+    sig { returns(RubyIndexer::Index) }
+    attr_reader :index
+
+    sig { returns(Encoding) }
+    attr_reader :encoding
+
+    sig { returns(T::Boolean) }
+    attr_reader :supports_watching_files
+
+    sig { void }
+    def initialize
+      @workspace_uri = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
+      @encoding = T.let(Encoding::UTF_8, Encoding)
+
+      @formatter = T.let("auto", String)
+      @test_library = T.let(detect_test_library, String)
+      @typechecker = T.let(detect_typechecker, T::Boolean)
+      @index = T.let(RubyIndexer::Index.new, RubyIndexer::Index)
+      @supported_formatters = T.let({}, T::Hash[String, Requests::Support::Formatter])
+      @supports_watching_files = T.let(false, T::Boolean)
+    end
+
+    sig { params(identifier: String, instance: Requests::Support::Formatter).void }
+    def register_formatter(identifier, instance)
+      @supported_formatters[identifier] = instance
+    end
+
+    sig { returns(T.nilable(Requests::Support::Formatter)) }
+    def active_formatter
+      @supported_formatters[@formatter]
+    end
+
+    sig { params(options: T::Hash[Symbol, T.untyped]).void }
+    def apply_options(options)
+      workspace_uri = options.dig(:workspaceFolders, 0, :uri)
+      @workspace_uri = URI(workspace_uri) if workspace_uri
+
+      specified_formatter = options.dig(:initializationOptions, :formatter)
+      @formatter = specified_formatter if specified_formatter
+      @formatter = detect_formatter if @formatter == "auto"
+
+      encodings = options.dig(:capabilities, :general, :positionEncodings)
+      @encoding = if !encodings || encodings.empty?
+        Encoding::UTF_16LE
+      elsif encodings.include?(Constant::PositionEncodingKind::UTF8)
+        Encoding::UTF_8
+      elsif encodings.include?(Constant::PositionEncodingKind::UTF16)
+        Encoding::UTF_16LE
+      else
+        Encoding::UTF_32
+      end
+
+      file_watching_caps = options.dig(:capabilities, :workspace, :didChangeWatchedFiles)
+      if file_watching_caps&.dig(:dynamicRegistration) && file_watching_caps&.dig(:relativePatternSupport)
+        @supports_watching_files = true
+      end
+    end
+
+    sig { returns(String) }
+    def workspace_path
+      T.must(@workspace_uri.to_standardized_path)
+    end
+
+    sig { returns(String) }
+    def encoding_name
+      case @encoding
+      when Encoding::UTF_8
+        Constant::PositionEncodingKind::UTF8
+      when Encoding::UTF_16LE
+        Constant::PositionEncodingKind::UTF16
+      else
+        Constant::PositionEncodingKind::UTF32
+      end
+    end
+
+    sig { params(gem_pattern: Regexp).returns(T::Boolean) }
+    def direct_dependency?(gem_pattern)
+      dependencies.any?(gem_pattern)
+    end
+
+    private
+
+    sig { returns(String) }
+    def detect_formatter
+      # NOTE: Intentionally no $ at end, since we want to match rubocop-shopify, etc.
+      if direct_dependency?(/^rubocop/)
+        "rubocop"
+      elsif direct_dependency?(/^syntax_tree$/)
+        "syntax_tree"
+      else
+        "none"
+      end
+    end
+
+    sig { returns(String) }
+    def detect_test_library
+      if direct_dependency?(/^rspec/)
+        "rspec"
+      # A Rails app may have a dependency on minitest, but we would instead want to use the Rails test runner provided
+      # by ruby-lsp-rails. A Rails app doesn't need to depend on the rails gem itself, individual components like
+      # activestorage may be added to the gemfile so that other components aren't downloaded. Check for the presence
+      #  of bin/rails to support these cases.
+      elsif File.exist?(File.join(workspace_path, "bin/rails"))
+        "rails"
+      # NOTE: Intentionally ends with $ to avoid mis-matching minitest-reporters, etc. in a Rails app.
+      elsif direct_dependency?(/^minitest$/)
+        "minitest"
+      elsif direct_dependency?(/^test-unit/)
+        "test-unit"
+      else
+        "unknown"
+      end
+    end
+
+    sig { returns(T::Boolean) }
+    def detect_typechecker
+      return false if ENV["RUBY_LSP_BYPASS_TYPECHECKER"]
+
+      # We can't read the env from within `Bundle.with_original_env` so we need to set it here.
+      ruby_lsp_env_is_test = (ENV["RUBY_LSP_ENV"] == "test")
+      Bundler.with_original_env do
+        sorbet_static_detected = Bundler.locked_gems.specs.any? { |spec| spec.name == "sorbet-static" }
+        # Don't show message while running tests, since it's noisy
+        if sorbet_static_detected && !ruby_lsp_env_is_test
+          $stderr.puts("Ruby LSP detected this is a Sorbet project so will defer to Sorbet LSP for some functionality")
+        end
+        sorbet_static_detected
+      end
+    rescue Bundler::GemfileNotFound
+      false
+    end
+
+    sig { returns(T::Array[String]) }
+    def dependencies
+      @dependencies ||= T.let(
+        begin
+          Bundler.with_original_env { Bundler.default_gemfile }
+          Bundler.locked_gems.dependencies.keys + gemspec_dependencies
+        rescue Bundler::GemfileNotFound
+          []
+        end,
+        T.nilable(T::Array[String]),
+      )
+    end
+
+    sig { returns(T::Array[String]) }
+    def gemspec_dependencies
+      Bundler.locked_gems.sources
+        .grep(Bundler::Source::Gemspec)
+        .flat_map { _1.gemspec&.dependencies&.map(&:name) }
+    end
+  end
+end

data/lib/ruby_lsp/internal.rb

@@ -20,12 +20,13 @@ require "prism/visitor"
 require "language_server-protocol"
 
 require "ruby-lsp"
+require "ruby_lsp/base_server"
 require "ruby_indexer/ruby_indexer"
 require "core_ext/uri"
 require "ruby_lsp/utils"
 require "ruby_lsp/parameter_scope"
+require "ruby_lsp/global_state"
 require "ruby_lsp/server"
-require "ruby_lsp/executor"
 require "ruby_lsp/requests"
 require "ruby_lsp/response_builders"
 require "ruby_lsp/document"
@@ -33,3 +34,5 @@ require "ruby_lsp/ruby_document"
 require "ruby_lsp/store"
 require "ruby_lsp/addon"
 require "ruby_lsp/requests/support/rubocop_runner"
+require "ruby_lsp/requests/support/rubocop_formatter"
+require "ruby_lsp/requests/support/syntax_tree_formatter"

data/lib/ruby_lsp/listeners/code_lens.rb

@@ -27,12 +27,14 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
+          global_state: GlobalState,
           uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(response_builder, uri, dispatcher)
+      def initialize(response_builder, global_state, uri, dispatcher)
         @response_builder = response_builder
+        @global_state = global_state
         @uri = T.let(uri, URI::Generic)
         @path = T.let(uri.to_standardized_path, T.nilable(String))
         # visibility_stack is a stack of [current_visibility, previous_visibility]
@@ -66,17 +68,22 @@ module RubyLsp
             command: generate_test_command(group_stack: @group_stack),
             kind: :group,
           )
-        end
 
-        @group_id_stack.push(@group_id)
-        @group_id += 1
+          @group_id_stack.push(@group_id)
+          @group_id += 1
+        end
       end
 
       sig { params(node: Prism::ClassNode).void }
       def on_class_node_leave(node)
         @visibility_stack.pop
         @group_stack.pop
-        @group_id_stack.pop
+
+        class_name = node.constant_path.slice
+
+        if @path && class_name.end_with?("Test")
+          @group_id_stack.pop
+        end
       end
 
       sig { params(node: Prism::DefNode).void }
@@ -156,7 +163,7 @@ module RubyLsp
       sig { params(node: Prism::Node, name: String, command: String, kind: Symbol).void }
       def add_test_code_lens(node, name:, command:, kind:)
         # don't add code lenses if the test library is not supported or unknown
-        return unless SUPPORTED_TEST_LIBRARIES.include?(DependencyDetector.instance.detected_test_library) && @path
+        return unless SUPPORTED_TEST_LIBRARIES.include?(@global_state.test_library) && @path
 
         arguments = [
           @path,
@@ -208,7 +215,7 @@ module RubyLsp
       def generate_test_command(group_stack: [], spec_name: nil, method_name: nil)
         command = BASE_COMMAND + T.must(@path)
 
-        case DependencyDetector.instance.detected_test_library
+        case @global_state.test_library
         when "minitest"
           last_dynamic_reference_index = group_stack.rindex(DYNAMIC_REFERENCE_MARKER)
           command += if last_dynamic_reference_index
@@ -264,12 +271,14 @@ module RubyLsp
 
         return unless name
 
-        add_test_code_lens(
-          node,
-          name: name,
-          command: generate_test_command(spec_name: name),
-          kind: kind,
-        )
+        if @path
+          add_test_code_lens(
+            node,
+            name: name,
+            command: generate_test_command(spec_name: name),
+            kind: kind,
+          )
+        end
       end
     end
   end

data/lib/ruby_lsp/listeners/completion.rb

@@ -10,16 +10,17 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           nesting: T::Array[String],
           typechecker_enabled: T::Boolean,
           dispatcher: Prism::Dispatcher,
           uri: URI::Generic,
         ).void
       end
-      def initialize(response_builder, index, nesting, typechecker_enabled, dispatcher, uri) # rubocop:disable Metrics/ParameterLists
+      def initialize(response_builder, global_state, nesting, typechecker_enabled, dispatcher, uri) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
-        @index = index
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @nesting = nesting
         @typechecker_enabled = typechecker_enabled
         @uri = uri
@@ -35,7 +36,7 @@ module RubyLsp
       # Handle completion on regular constant references (e.g. `Bar`)
       sig { params(node: Prism::ConstantReadNode).void }
       def on_constant_read_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         name = constant_name(node)
         return if name.nil?
@@ -56,7 +57,7 @@ module RubyLsp
       # Handle completion on namespaced constant references (e.g. `Foo::Bar`)
       sig { params(node: Prism::ConstantPathNode).void }
       def on_constant_path_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         name = constant_name(node)
         return if name.nil?
@@ -77,7 +78,10 @@ module RubyLsp
 
         real_namespace = @index.follow_aliased_namespace(T.must(namespace_entries.first).name)
 
-        candidates = @index.prefix_search("#{real_namespace}::#{incomplete_name}", top_level_reference ? [] : @nesting)
+        candidates = @index.prefix_search(
+          "#{real_namespace}::#{incomplete_name}",
+          top_level_reference ? [] : @nesting,
+        )
         candidates.each do |entries|
           # The only time we may have a private constant reference from outside of the namespace is if we're dealing
           # with ConstantPath and the entry name doesn't start with the current nesting
@@ -124,7 +128,9 @@ module RubyLsp
 
         return unless path_node_to_complete.is_a?(Prism::StringNode)
 
-        @index.search_require_paths(path_node_to_complete.content).map!(&:require_path).sort!.each do |path|
+        matched_indexable_paths = @index.search_require_paths(path_node_to_complete.content)
+
+        matched_indexable_paths.map!(&:require_path).sort!.each do |path|
           @response_builder << build_completion(T.must(path), path_node_to_complete)
         end
       end
@@ -284,13 +290,6 @@ module RubyLsp
             new_text: insertion_text,
           ),
           kind: kind,
-          label_details: Interface::CompletionItemLabelDetails.new(
-            description: entries.map(&:file_name).join(","),
-          ),
-          documentation: Interface::MarkupContent.new(
-            kind: "markdown",
-            value: markdown_from_index_entries(real_name, entries),
-          ),
         )
       end
 

data/lib/ruby_lsp/listeners/definition.rb

@@ -10,18 +10,19 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::CollectionResponseBuilder[Interface::Location],
+          global_state: GlobalState,
           uri: URI::Generic,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
           typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(response_builder, uri, nesting, index, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
+      def initialize(response_builder, global_state, uri, nesting, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @uri = uri
         @nesting = nesting
-        @index = index
         @typechecker_enabled = typechecker_enabled
 
         dispatcher.register(

data/lib/ruby_lsp/listeners/document_symbol.rb

@@ -12,17 +12,20 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::DocumentSymbol,
+          uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(response_builder, dispatcher)
+      def initialize(response_builder, uri, dispatcher)
         @response_builder = response_builder
+        @uri = uri
 
         dispatcher.register(
           self,
           :on_class_node_enter,
           :on_class_node_leave,
           :on_call_node_enter,
+          :on_call_node_leave,
           :on_constant_path_write_node_enter,
           :on_constant_write_node_enter,
           :on_constant_path_or_write_node_enter,
@@ -79,10 +82,24 @@ module RubyLsp
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
-        if ATTR_ACCESSORS.include?(node.name)
+        node_name = node.name
+        if ATTR_ACCESSORS.include?(node_name)
           handle_attr_accessor(node)
-        elsif node.name == :alias_method
+        elsif node_name == :alias_method
           handle_alias_method(node)
+        elsif node_name == :namespace
+          handle_rake_namespace(node)
+        elsif node_name == :task
+          handle_rake_task(node)
+        end
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_leave(node)
+        return unless rake?
+
+        if node.name == :namespace && !node.receiver
+          @response_builder.pop
         end
       end
 
@@ -279,6 +296,7 @@ module RubyLsp
         ).returns(Interface::DocumentSymbol)
       end
       def create_document_symbol(name:, kind:, range_location:, selection_range_location:)
+        name = "<blank>" if name.empty?
         symbol = Interface::DocumentSymbol.new(
           name: name,
           kind: kind,
@@ -357,6 +375,76 @@ module RubyLsp
           )
         end
       end
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_rake_namespace(node)
+        return unless rake?
+        return if node.receiver
+
+        arguments = node.arguments
+        return unless arguments
+
+        name_argument = arguments.arguments.first
+        return unless name_argument
+
+        name = case name_argument
+        when Prism::StringNode then name_argument.content
+        when Prism::SymbolNode then name_argument.value
+        end
+
+        return if name.nil? || name.empty?
+
+        @response_builder << create_document_symbol(
+          name: name,
+          kind: Constant::SymbolKind::MODULE,
+          range_location: name_argument.location,
+          selection_range_location: name_argument.location,
+        )
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_rake_task(node)
+        return unless rake?
+        return if node.receiver
+
+        arguments = node.arguments
+        return unless arguments
+
+        name_argument = arguments.arguments.first
+        return unless name_argument
+
+        name = case name_argument
+        when Prism::StringNode then name_argument.content
+        when Prism::SymbolNode then name_argument.value
+        when Prism::KeywordHashNode
+          first_element = name_argument.elements.first
+          if first_element.is_a?(Prism::AssocNode)
+            key = first_element.key
+            case key
+            when Prism::StringNode then key.content
+            when Prism::SymbolNode then key.value
+            end
+          end
+        end
+
+        return if name.nil? || name.empty?
+
+        create_document_symbol(
+          name: name,
+          kind: Constant::SymbolKind::METHOD,
+          range_location: name_argument.location,
+          selection_range_location: name_argument.location,
+        )
+      end
+
+      sig { returns(T::Boolean) }
+      def rake?
+        if (path = @uri.to_standardized_path)
+          path.match?(/(Rakefile|\.rake)$/)
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/ruby_lsp/listeners/hover.rb

@@ -28,18 +28,19 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::Hover,
+          global_state: GlobalState,
           uri: URI::Generic,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
           typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(response_builder, uri, nesting, index, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
+      def initialize(response_builder, global_state, uri, nesting, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @path = T.let(uri.to_standardized_path, T.nilable(String))
         @nesting = nesting
-        @index = index
         @typechecker_enabled = typechecker_enabled
 
         dispatcher.register(
@@ -63,14 +64,14 @@ module RubyLsp
 
       sig { params(node: Prism::ConstantWriteNode).void }
       def on_constant_write_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         generate_hover(node.name.to_s, node.name_loc)
       end
 
       sig { params(node: Prism::ConstantPathNode).void }
       def on_constant_path_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         name = constant_name(node)
         return if name.nil?

data/lib/ruby_lsp/listeners/signature_help.rb

@@ -10,21 +10,24 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::SignatureHelp,
+          global_state: GlobalState,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
+          typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(response_builder, nesting, index, dispatcher)
+      def initialize(response_builder, global_state, nesting, dispatcher, typechecker_enabled)
+        @typechecker_enabled = typechecker_enabled
         @response_builder = response_builder
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @nesting = nesting
-        @index = index
         dispatcher.register(self, :on_call_node_enter)
       end
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @typechecker_enabled
         return unless self_receiver?(node)
 
         message = node.message

data/lib/ruby_lsp/load_sorbet.rb

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+begin
+  T::Configuration.default_checked_level = :never
+  # Suppresses call validation errors
+  T::Configuration.call_validation_error_handler = ->(*) {}
+  # Suppresses errors caused by T.cast, T.let, T.must, etc.
+  T::Configuration.inline_type_error_handler = ->(*) {}
+  # Suppresses errors caused by incorrect parameter ordering
+  T::Configuration.sig_validation_error_handler = ->(*) {}
+rescue
+  # Need this rescue so that if another gem has
+  # already set the checked level by the time we
+  # get to it, we don't fail outright.
+  nil
+end
+
+module RubyLsp
+  # No-op all inline type assertions defined in T
+  module InlineTypeAssertions
+    def absurd(value)
+      value
+    end
+
+    def any(type_a, type_b, *types)
+      T::Types::Union.new([type_a, type_b, *types])
+    end
+
+    def assert_type!(value, type, checked: true)
+      value
+    end
+
+    def bind(value, type, checked: true)
+      value
+    end
+
+    def cast(value, type, checked: true)
+      value
+    end
+
+    def let(value, type, checked: true)
+      value
+    end
+
+    def must(arg)
+      arg
+    end
+
+    def nilable(type)
+      T::Types::Union.new([type, T::Utils::Nilable::NIL_TYPE])
+    end
+
+    def unsafe(value)
+      value
+    end
+
+    T.singleton_class.prepend(self)
+  end
+end

data/lib/ruby_lsp/requests/code_lens.rb

@@ -34,17 +34,18 @@ module RubyLsp
 
       sig do
         params(
+          global_state: GlobalState,
           uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(uri, dispatcher)
+      def initialize(global_state, uri, dispatcher)
         @response_builder = T.let(
           ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens].new,
           ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
         )
         super()
-        Listeners::CodeLens.new(@response_builder, uri, dispatcher)
+        Listeners::CodeLens.new(@response_builder, global_state, uri, dispatcher)
 
         Addon.addons.each do |addon|
           addon.create_code_lens_listener(@response_builder, uri, dispatcher)