ruby-lsp 0.7.6 → 0.8.1

data/lib/ruby_lsp/requests/formatting.rb

@@ -58,7 +58,7 @@ module RubyLsp
       def initialize(document, formatter: "auto")
         super(document)
 
-        @uri = T.let(document.uri, String)
+        @uri = T.let(document.uri, URI::Generic)
         @formatter = formatter
       end
 
@@ -67,7 +67,8 @@ module RubyLsp
         return if @formatter == "none"
 
         # Don't try to format files outside the current working directory
-        return unless @uri.sub("file://", "").start_with?(Dir.pwd)
+        path = @uri.to_standardized_path
+        return unless path.nil? || path.start_with?(T.must(WORKSPACE_URI.to_standardized_path))
 
         return if @document.syntax_error?
 

data/lib/ruby_lsp/requests/hover.rb

@@ -39,29 +39,15 @@ module RubyLsp
       def initialize(emitter, message_queue)
         super
 
-        @external_listeners = T.let([], T::Array[RubyLsp::Listener[ResponseType]])
+        @external_listeners.concat(
+          Extension.extensions.filter_map { |ext| ext.create_hover_listener(emitter, message_queue) },
+        )
         @response = T.let(nil, ResponseType)
         emitter.register(self, :on_command, :on_const_path_ref, :on_call)
-
-        register_external_listeners!
-      end
-
-      sig { void }
-      def register_external_listeners!
-        self.class.listeners.each do |l|
-          @external_listeners << T.unsafe(l).new(@emitter, @message_queue)
-        end
-      end
-
-      sig { void }
-      def merge_external_listeners_responses!
-        @external_listeners.each do |l|
-          merge_response!(l)
-        end
       end
 
       # Merges responses from other hover listeners
-      sig { params(other: Listener[ResponseType]).returns(T.self_type) }
+      sig { override.params(other: Listener[ResponseType]).returns(T.self_type) }
       def merge_response!(other)
         other_response = other.response
         return self unless other_response

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -67,12 +67,10 @@ module RubyLsp
 
         line = T.must(current_line)
 
-        # If the current character is a pipe and both previous ones are pipes too, then we autocompleted a pipe and the
-        # user inserted a third one. In this case, we need to avoid adding a fourth and remove the previous one
-        if line[@position[:character] - 2] == "|" &&
-            line[@position[:character] - 1] == "|" &&
-            line[@position[:character]] == "|"
-
+        # If the user inserts the closing pipe manually to the end of the block argument, we need to avoid adding
+        # an additional one and remove the previous one.  This also helps to remove the user who accidentally
+        # inserts another pipe after the autocompleted one.
+        if line[..@position[:character]] =~ /(do|{)\s+\|[^|]*\|\|$/
           @edits << Interface::TextEdit.new(
             range: Interface::Range.new(
               start: Interface::Position.new(

data/lib/ruby_lsp/requests/support/dependency_detector.rb

@@ -36,6 +36,11 @@ module RubyLsp
         end
       end
 
+      sig { returns(T::Boolean) }
+      def typechecker?
+        direct_dependency?(/^sorbet/) || direct_dependency?(/^sorbet-static-and-runtime/)
+      end
+
       sig { params(gem_pattern: Regexp).returns(T::Boolean) }
       def direct_dependency?(gem_pattern)
         Bundler.with_original_env { Bundler.default_gemfile } &&

data/lib/ruby_lsp/requests/support/formatter_runner.rb

@@ -10,7 +10,7 @@ module RubyLsp
 
         interface!
 
-        sig { abstract.params(uri: String, document: Document).returns(T.nilable(String)) }
+        sig { abstract.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
         def run(uri, document); end
       end
     end

data/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb

@@ -19,7 +19,7 @@ module RubyLsp
           T::Hash[Symbol, Integer],
         )
 
-        sig { params(offense: RuboCop::Cop::Offense, uri: String).void }
+        sig { params(offense: RuboCop::Cop::Offense, uri: URI::Generic).void }
         def initialize(offense, uri)
           @offense = offense
           @uri = uri
@@ -34,7 +34,7 @@ module RubyLsp
               document_changes: [
                 Interface::TextDocumentEdit.new(
                   text_document: Interface::OptionalVersionedTextDocumentIdentifier.new(
-                    uri: @uri,
+                    uri: @uri.to_s,
                     version: nil,
                   ),
                   edits: @offense.correctable? ? offense_replacements : [],

data/lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb

@@ -3,7 +3,6 @@
 
 return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
 
-require "cgi"
 require "singleton"
 
 module RubyLsp
@@ -19,9 +18,9 @@ module RubyLsp
           @runner = T.let(RuboCopRunner.new, RuboCopRunner)
         end
 
-        sig { params(uri: String, document: Document).returns(T::Array[Support::RuboCopDiagnostic]) }
+        sig { params(uri: URI::Generic, document: Document).returns(T::Array[Support::RuboCopDiagnostic]) }
         def run(uri, document)
-          filename = CGI.unescape(URI.parse(uri).path)
+          filename = T.must(uri.to_standardized_path || uri.opaque)
           # Invoke RuboCop with just this file in `paths`
           @runner.run(filename, document.source)
 

data/lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb

@@ -3,7 +3,6 @@
 
 return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
 
-require "cgi"
 require "singleton"
 
 module RubyLsp
@@ -21,9 +20,9 @@ module RubyLsp
           @runner = T.let(RuboCopRunner.new("-a"), RuboCopRunner)
         end
 
-        sig { override.params(uri: String, document: Document).returns(String) }
+        sig { override.params(uri: URI::Generic, document: Document).returns(String) }
         def run(uri, document)
-          filename = CGI.unescape(URI.parse(uri).path)
+          filename = T.must(uri.to_standardized_path || uri.opaque)
 
           # Invoke RuboCop with just this file in `paths`
           @runner.run(filename, document.source)

data/lib/ruby_lsp/requests/support/syntax_tree_formatting_runner.rb

@@ -26,9 +26,10 @@ module RubyLsp
             )
         end
 
-        sig { override.params(uri: String, document: Document).returns(T.nilable(String)) }
+        sig { override.params(uri: URI::Generic, document: Document).returns(T.nilable(String)) }
         def run(uri, document)
-          relative_path = Pathname.new(URI(uri).path).relative_path_from(T.must(WORKSPACE_URI.path))
+          relative_path = Pathname.new(T.must(uri.to_standardized_path || uri.opaque))
+            .relative_path_from(T.must(WORKSPACE_URI.to_standardized_path))
           return if @options.ignore_files.any? { |pattern| File.fnmatch(pattern, relative_path) }
 
           SyntaxTree.format(

data/lib/ruby_lsp/server.rb

@@ -86,6 +86,7 @@ module RubyLsp
           @message_dispatcher.join
           @store.clear
 
+          Extension.extensions.each(&:deactivate)
           finalize_request(Result.new(response: nil), request)
         when "exit"
           # We return zero if shutdown has already been received or one otherwise as per the recommendation in the spec
@@ -105,7 +106,7 @@ module RubyLsp
             # source. Altering the source reference during parsing will put the parser in an invalid internal state,
             # since it started parsing with one source but then it changed in the middle
             uri = request.dig(:params, :textDocument, :uri)
-            @store.get(uri).parse if uri
+            @store.get(URI(uri)).parse if uri
           end
 
           @job_queue << job
@@ -192,7 +193,14 @@ module RubyLsp
         params[:backtrace] = backtrace.map { |bt| bt.sub(/^#{Dir.home}/, "~") }.join("\n") if backtrace
       end
 
-      params[:uri] = uri.sub(%r{.*://#{Dir.home}}, "~") if uri
+      if uri
+        home = URI::Generic.from_path(path: Dir.home)
+
+        parsed_uri = URI(uri)
+        path = parsed_uri.path
+        params[:uri] = path ? path.sub(T.must(home.path), "~") : parsed_uri.opaque
+      end
+
       params
     end
   end

data/lib/ruby_lsp/setup_bundler.rb

@@ -5,6 +5,7 @@ require "sorbet-runtime"
 require "bundler"
 require "fileutils"
 require "pathname"
+require "digest"
 
 # This file is a script that will configure a custom bundle for the Ruby LSP. The custom bundle allows developers to use
 # the Ruby LSP without including the gem in their application's Gemfile while at the same time giving us access to the
@@ -16,14 +17,16 @@ module RubyLsp
 
     class BundleNotLocked < StandardError; end
 
-    sig { params(project_path: String).void }
-    def initialize(project_path)
+    sig { params(project_path: String, branch: T.nilable(String)).void }
+    def initialize(project_path, branch: nil)
       @project_path = project_path
+      @branch = branch
 
       # Custom bundle paths
       @custom_dir = T.let(Pathname.new(".ruby-lsp").expand_path(Dir.pwd), Pathname)
       @custom_gemfile = T.let(@custom_dir + "Gemfile", Pathname)
       @custom_lockfile = T.let(@custom_dir + "Gemfile.lock", Pathname)
+      @lockfile_hash_path = T.let(@custom_dir + "main_lockfile_hash", Pathname)
 
       # Regular bundle paths
       @gemfile = T.let(
@@ -37,7 +40,6 @@ module RubyLsp
       @lockfile = T.let(@gemfile ? Bundler.default_lockfile : nil, T.nilable(Pathname))
 
       @dependencies = T.let(load_dependencies, T::Hash[String, T.untyped])
-      @custom_bundle_dependencies = T.let(custom_bundle_dependencies, T::Hash[String, T.untyped])
     end
 
     # Setups up the custom bundle and returns the `BUNDLE_GEMFILE` and `BUNDLE_PATH` that should be used for running the
@@ -69,14 +71,16 @@ module RubyLsp
         return run_bundle_install(@custom_gemfile)
       end
 
-      # If .ruby-lsp/Gemfile.lock already exists and the top level Gemfile.lock hasn't been modified since it was last
-      # updated, then we're ready to boot the server
-      if @custom_lockfile.exist? && @custom_lockfile.stat.mtime > @lockfile.stat.mtime
+      lockfile_contents = @lockfile.read
+      current_lockfile_hash = Digest::SHA256.hexdigest(lockfile_contents)
+
+      if @custom_lockfile.exist? && @lockfile_hash_path.exist? && @lockfile_hash_path.read == current_lockfile_hash
         warn("Ruby LSP> Skipping custom bundle setup since #{@custom_lockfile} already exists and is up to date")
         return run_bundle_install(@custom_gemfile)
       end
 
       FileUtils.cp(@lockfile.to_s, @custom_lockfile.to_s)
+      @lockfile_hash_path.write(current_lockfile_hash)
       run_bundle_install(@custom_gemfile)
     end
 
@@ -84,10 +88,17 @@ module RubyLsp
 
     sig { returns(T::Hash[String, T.untyped]) }
     def custom_bundle_dependencies
-      return {} unless @custom_lockfile.exist?
-
-      ENV["BUNDLE_GEMFILE"] = @custom_gemfile.to_s
-      Bundler::LockfileParser.new(@custom_lockfile.read).dependencies
+      @custom_bundle_dependencies ||= T.let(
+        begin
+          if @custom_lockfile.exist?
+            ENV["BUNDLE_GEMFILE"] = @custom_gemfile.to_s
+            Bundler::LockfileParser.new(@custom_lockfile.read).dependencies
+          else
+            {}
+          end
+        end,
+        T.nilable(T::Hash[String, T.untyped]),
+      )
     ensure
       ENV.delete("BUNDLE_GEMFILE")
     end
@@ -109,7 +120,9 @@ module RubyLsp
       end
 
       unless @dependencies["ruby-lsp"]
-        parts << 'gem "ruby-lsp", require: false, group: :development'
+        ruby_lsp_entry = +'gem "ruby-lsp", require: false, group: :development'
+        ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\"" if @branch
+        parts << ruby_lsp_entry
       end
 
       unless @dependencies["debug"]
@@ -146,11 +159,12 @@ module RubyLsp
       # `.ruby-lsp` folder, which is not the user's intention. For example, if the path is configured as `vendor`, we
       # want to install it in the top level `vendor` and not `.ruby-lsp/vendor`
       path = Bundler.settings["path"]
+      expanded_path = File.expand_path(path, Dir.pwd) if path
 
       # Use the absolute `BUNDLE_PATH` to prevent accidentally creating unwanted folders under `.ruby-lsp`
       env = {}
       env["BUNDLE_GEMFILE"] = bundle_gemfile.to_s
-      env["BUNDLE_PATH"] = File.expand_path(path, Dir.pwd) if path
+      env["BUNDLE_PATH"] = expanded_path if expanded_path
 
       # If both `ruby-lsp` and `debug` are already in the Gemfile, then we shouldn't try to upgrade them or else we'll
       # produce undesired source control changes. If the custom bundle was just created and either `ruby-lsp` or `debug`
@@ -160,7 +174,7 @@ module RubyLsp
       command = +""
 
       if (@dependencies["ruby-lsp"] && @dependencies["debug"]) ||
-          @custom_bundle_dependencies["ruby-lsp"].nil? || @custom_bundle_dependencies["debug"].nil?
+          custom_bundle_dependencies["ruby-lsp"].nil? || custom_bundle_dependencies["debug"].nil?
         # Install gems using the custom bundle
         command << "bundle install "
       else
@@ -177,7 +191,7 @@ module RubyLsp
       # Add bundle update
       warn("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
       system(env, command)
-      [bundle_gemfile.to_s, path]
+      [bundle_gemfile.to_s, expanded_path]
     end
   end
 end

data/lib/ruby_lsp/store.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "cgi"
-require "uri"
 require "ruby_lsp/document"
 
 module RubyLsp
@@ -15,31 +13,40 @@ module RubyLsp
     sig { returns(String) }
     attr_accessor :formatter
 
+    sig { returns(T::Boolean) }
+    attr_accessor :supports_progress
+
+    sig { returns(T::Boolean) }
+    attr_accessor :experimental_features
+
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document])
       @encoding = T.let(Constant::PositionEncodingKind::UTF8, String)
       @formatter = T.let("auto", String)
+      @supports_progress = T.let(true, T::Boolean)
+      @experimental_features = T.let(false, T::Boolean)
     end
 
-    sig { params(uri: String).returns(Document) }
+    sig { params(uri: URI::Generic).returns(Document) }
     def get(uri)
-      document = @state[uri]
+      document = @state[uri.to_s]
       return document unless document.nil?
 
-      set(uri: uri, source: File.binread(CGI.unescape(URI.parse(uri).path)), version: 0)
-      T.must(@state[uri])
+      path = T.must(uri.to_standardized_path)
+      set(uri: uri, source: File.binread(path), version: 0)
+      T.must(@state[uri.to_s])
     end
 
-    sig { params(uri: String, source: String, version: Integer).void }
+    sig { params(uri: URI::Generic, source: String, version: Integer).void }
     def set(uri:, source:, version:)
       document = Document.new(source: source, version: version, uri: uri, encoding: @encoding)
-      @state[uri] = document
+      @state[uri.to_s] = document
     end
 
-    sig { params(uri: String, edits: T::Array[Document::EditShape], version: Integer).void }
+    sig { params(uri: URI::Generic, edits: T::Array[Document::EditShape], version: Integer).void }
     def push_edits(uri:, edits:, version:)
-      T.must(@state[uri]).push_edits(edits, version: version)
+      T.must(@state[uri.to_s]).push_edits(edits, version: version)
     end
 
     sig { void }
@@ -52,15 +59,15 @@ module RubyLsp
       @state.empty?
     end
 
-    sig { params(uri: String).void }
+    sig { params(uri: URI::Generic).void }
     def delete(uri)
-      @state.delete(uri)
+      @state.delete(uri.to_s)
     end
 
     sig do
       type_parameters(:T)
         .params(
-          uri: String,
+          uri: URI::Generic,
           request_name: String,
           block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
         ).returns(T.type_parameter(:T))

data/lib/ruby_lsp/utils.rb

@@ -6,7 +6,7 @@ module RubyLsp
   VOID = T.let(Object.new.freeze, Object)
 
   # This freeze is not redundant since the interpolated string is mutable
-  WORKSPACE_URI = T.let(URI("file://#{Dir.pwd}".freeze), URI::Generic)
+  WORKSPACE_URI = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
 
   # A notification to be sent to the client
   class Message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: yarp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
@@ -72,8 +86,18 @@ files:
 - VERSION
 - exe/ruby-lsp
 - exe/ruby-lsp-check
+- lib/core_ext/uri.rb
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/ruby-lsp.rb
+- lib/ruby_indexer/lib/ruby_indexer/configuration.rb
+- lib/ruby_indexer/lib/ruby_indexer/index.rb
+- lib/ruby_indexer/lib/ruby_indexer/visitor.rb
+- lib/ruby_indexer/ruby_indexer.rb
+- lib/ruby_indexer/test/classes_and_modules_test.rb
+- lib/ruby_indexer/test/configuration_test.rb
+- lib/ruby_indexer/test/constant_test.rb
+- lib/ruby_indexer/test/index_test.rb
+- lib/ruby_indexer/test/test_case.rb
 - lib/ruby_lsp/check_docs.rb
 - lib/ruby_lsp/document.rb
 - lib/ruby_lsp/event_emitter.rb
@@ -140,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.18
 signing_key: 
 specification_version: 4
 summary: An opinionated language server for Ruby