ruby-lsp 0.14.3 → 0.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e762c728055d0a7ee471dd6455cb0b8ed5f1a2ed1137a71c70f4238e18d7b8bd
-  data.tar.gz: 61636e671131322ffd9792c1e23f70e54ebea9f9dd15401abac8ec0c91bf4131
+  metadata.gz: '046081e0caf521f948f3952bd7a356ef6f0beb80c5a9ff72930a6d0c9fd8d9f4'
+  data.tar.gz: e65b5224342c412a0b28198af0e56b17a421eaacc7748a17d2ed30890c0a2d86
 SHA512:
-  metadata.gz: dd8712a89c31f1a43bed4744537a08997acf927e7dad6cd3e64aa31f8c2beb08bfdf2867b66a7c302cf11f7c803a52e2a4dfe46930bcb17f7f57c6cf196140ee
-  data.tar.gz: 7bd900943556a4e5e54d46894ca855740de8effb0f2675ec4b01efd9a08f3b2517a516e38ab99abf3266a3984dcbcc4ec5b2de5c976a0eabd08dfdd0ce38516f
+  metadata.gz: 682219fbef2c6e1483c0e6b0c36bf2ce8c3bd15aed88e53ee1a05623f5569c7e52227300b1a6fb4968a6ba2b0844a7e985a0b134af9e9498036199673d660117
+  data.tar.gz: a13eb33a1a41514819f4d0612a5d50eb170a0adb36158b799cebffae34781a5d41c1b07922f0bec8310cf6439ea8356305224bcf1de7423b96ff6e28c9e744c8

data/LICENSE.txt

@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-

data/README.md

@@ -1,3 +1,7 @@
+<p align="center">
+  <img alt="Ruby LSP logo" width="200" src="vscode/icon.png" />
+</p>
+
 [![Build Status](https://github.com/Shopify/ruby-lsp/workflows/CI/badge.svg)](https://github.com/Shopify/ruby-lsp/actions/workflows/ci.yml)
 [![Ruby LSP extension](https://img.shields.io/badge/VS%20Code-Ruby%20LSP-success?logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp)
 [![Ruby DX Slack](https://img.shields.io/badge/Slack-Ruby%20DX-success?logo=slack)](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q)
@@ -11,12 +15,38 @@ experience to Ruby developers using modern standards for cross-editor features,
 Want to discuss Ruby developer experience? Consider joining the public
 [Ruby DX Slack workspace](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q).
 
+## Features
+
+![Ruby LSP demo](vscode/extras/ruby_lsp_demo.gif)
+
+The Ruby LSP features include
+
+- Semantic highlighting
+- Symbol search and code outline
+- RuboCop errors and warnings (diagnostics)
+- Format on save (with RuboCop or Syntax Tree)
+- Format on type
+- Debugging support
+- Running and debugging tests through VS Code's UI
+- Go to definition for classes, modules, constants and required files
+- Showing documentaton on hover for classes, modules and constants
+- Completion for classes, modules, constants and require paths
+- Fuzzy search classes, modules and constants anywhere in the project and its dependencies (workspace symbol)
+
+Adding method support for definition, completion, hover and workspace symbol is planned, but not yet completed.
+
+See complete information about features [here](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).
+
+If you experience issues, please see the [troubleshooting
+guide](https://github.com/Shopify/ruby-lsp/blob/main/TROUBLESHOOTING.md).
+
 ## Usage
 
 ### With VS Code
 
-If using VS Code, all you have to do is install the [Ruby LSP extension](https://github.com/Shopify/vscode-ruby-lsp) to
-get the extra features in the editor. Do not install this gem manually.
+If using VS Code, all you have to do is install the [Ruby LSP
+extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp) to get the extra features in the
+editor. Do not install the `ruby-lsp` gem manually.
 
 ### With other editors
 
@@ -27,16 +57,8 @@ The gem can be installed by doing
 gem install ruby-lsp
 ```
 
-**NOTE**: starting with v0.7.0, it is no longer recommended to add the `ruby-lsp` to the bundle. The gem will generate a
-custom bundle in `.ruby-lsp/Gemfile` which is used to identify the versions of dependencies that should be used for the
-application (e.g.: the correct RuboCop version).
-
-For older versions, if you decide to add the gem to the bundle, it is not necessary to require it.
-```ruby
-group :development do
-  gem "ruby-lsp", require: false
-end
-```
+and the language server can be launched running `ruby-lsp` (without bundle exec in order to properly hook into your
+project's dependencies).
 
 ### Documentation
 
@@ -98,16 +120,13 @@ For instructions on how to create addons, see the [addons documentation](ADDONS.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp.
-This project is intended to be a safe, welcoming space for collaboration, and contributors
-are expected to adhere to the
-[Contributor Covenant](CODE_OF_CONDUCT.md)
-code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp.  This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor
+Covenant](CODE_OF_CONDUCT.md) code of conduct.
 
 If you wish to contribute, see [CONTRIBUTING](CONTRIBUTING.md) for development instructions and check out our pinned
 [roadmap issue](https://github.com/Shopify/ruby-lsp/issues) for a list of tasks to get started.
 
 ## License
 
-The gem is available as open source under the terms of the
-[MIT License](LICENSE.txt).
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/VERSION

@@ -1 +1 @@
-0.14.3
+0.14.5

data/lib/ruby_lsp/addon.rb

@@ -27,6 +27,8 @@ module RubyLsp
 
     @addons = T.let([], T::Array[Addon])
     @addon_classes = T.let([], T::Array[T.class_of(Addon)])
+    # Addon instances that have declared a handler to accept file watcher events
+    @file_watcher_addons = T.let([], T::Array[Addon])
 
     class << self
       extend T::Sig
@@ -34,6 +36,9 @@ module RubyLsp
       sig { returns(T::Array[Addon]) }
       attr_accessor :addons
 
+      sig { returns(T::Array[Addon]) }
+      attr_accessor :file_watcher_addons
+
       sig { returns(T::Array[T.class_of(Addon)]) }
       attr_reader :addon_classes
 
@@ -57,6 +62,7 @@ module RubyLsp
 
         # Instantiate all discovered addon classes
         self.addons = addon_classes.map(&:new)
+        self.file_watcher_addons = addons.select { |addon| addon.respond_to?(:workspace_did_change_watched_files) }
 
         # Activate each one of the discovered addons. If any problems occur in the addons, we don't want to
         # fail to boot the server

data/lib/ruby_lsp/executor.rb

@@ -121,24 +121,10 @@ module RubyLsp
         begin
           formatting(uri)
         rescue Requests::Formatting::InvalidFormatter => error
-          @message_queue << Notification.new(
-            message: "window/showMessage",
-            params: Interface::ShowMessageParams.new(
-              type: Constant::MessageType::ERROR,
-              message: "Configuration error: #{error.message}",
-            ),
-          )
-
+          @message_queue << Notification.window_show_error("Configuration error: #{error.message}")
           nil
         rescue StandardError, LoadError => error
-          @message_queue << Notification.new(
-            message: "window/showMessage",
-            params: Interface::ShowMessageParams.new(
-              type: Constant::MessageType::ERROR,
-              message: "Formatting error: #{error.message}",
-            ),
-          )
-
+          @message_queue << Notification.window_show_error("Formatting error: #{error.message}")
           nil
         end
       when "textDocument/documentHighlight"
@@ -174,14 +160,7 @@ module RubyLsp
         begin
           diagnostic(uri)
         rescue StandardError, LoadError => error
-          @message_queue << Notification.new(
-            message: "window/showMessage",
-            params: Interface::ShowMessageParams.new(
-              type: Constant::MessageType::ERROR,
-              message: "Error running diagnostics: #{error.message}",
-            ),
-          )
-
+          @message_queue << Notification.window_show_error("Error running diagnostics: #{error.message}")
           nil
         end
       when "textDocument/completion"
@@ -250,6 +229,7 @@ module RubyLsp
         end
       end
 
+      Addon.file_watcher_addons.each { |addon| T.unsafe(addon).workspace_did_change_watched_files(changes) }
       VOID
     end
 
@@ -287,13 +267,7 @@ module RubyLsp
             false
           end
         rescue StandardError => error
-          @message_queue << Notification.new(
-            message: "window/showMessage",
-            params: Interface::ShowMessageParams.new(
-              type: Constant::MessageType::ERROR,
-              message: "Error while indexing: #{error.message}",
-            ),
-          )
+          @message_queue << Notification.window_show_error("Error while indexing: #{error.message}")
         end
 
         # Always end the progress notification even if indexing failed or else it never goes away and the user has no
@@ -402,21 +376,11 @@ module RubyLsp
 
       case result
       when Requests::CodeActionResolve::Error::EmptySelection
-        @message_queue << Notification.new(
-          message: "window/showMessage",
-          params: Interface::ShowMessageParams.new(
-            type: Constant::MessageType::ERROR,
-            message: "Invalid selection for Extract Variable refactor",
-          ),
-        )
+        @message_queue << Notification.window_show_error("Invalid selection for Extract Variable refactor")
         raise Requests::CodeActionResolve::CodeActionError
       when Requests::CodeActionResolve::Error::InvalidTargetRange
-        @message_queue << Notification.new(
-          message: "window/showMessage",
-          params: Interface::ShowMessageParams.new(
-            type: Constant::MessageType::ERROR,
-            message: "Couldn't find an appropriate location to place extracted refactor",
-          ),
+        @message_queue << Notification.window_show_error(
+          "Couldn't find an appropriate location to place extracted refactor",
         )
         raise Requests::CodeActionResolve::CodeActionError
       else
@@ -639,12 +603,8 @@ module RubyLsp
       unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
         @store.formatter = "none"
 
-        @message_queue << Notification.new(
-          message: "window/showMessage",
-          params: Interface::ShowMessageParams.new(
-            type: Constant::MessageType::ERROR,
-            message: "Ruby LSP formatter is set to `rubocop` but RuboCop was not found in the Gemfile or gemspec.",
-          ),
+        @message_queue << Notification.window_show_error(
+          "Ruby LSP formatter is set to `rubocop` but RuboCop was not found in the Gemfile or gemspec.",
         )
       end
     end

data/lib/ruby_lsp/listeners/completion.rb

@@ -14,30 +14,24 @@ module RubyLsp
           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)
+      def initialize(response_builder, index, nesting, typechecker_enabled, dispatcher, uri) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
         @index = index
         @nesting = nesting
         @typechecker_enabled = typechecker_enabled
+        @uri = uri
 
         dispatcher.register(
           self,
-          :on_string_node_enter,
           :on_constant_path_node_enter,
           :on_constant_read_node_enter,
           :on_call_node_enter,
         )
       end
 
-      sig { params(node: Prism::StringNode).void }
-      def on_string_node_enter(node)
-        @index.search_require_paths(node.content).map!(&:require_path).sort!.each do |path|
-          @response_builder << build_completion(T.must(path), node)
-        end
-      end
-
       # Handle completion on regular constant references (e.g. `Bar`)
       sig { params(node: Prism::ConstantReadNode).void }
       def on_constant_read_node_enter(node)
@@ -106,12 +100,66 @@ module RubyLsp
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
-        return if @typechecker_enabled
-        return unless self_receiver?(node)
-
         name = node.message
         return unless name
 
+        case name
+        when "require"
+          complete_require(node)
+        when "require_relative"
+          complete_require_relative(node)
+        else
+          complete_self_receiver_method(node, name) if !@typechecker_enabled && self_receiver?(node)
+        end
+      end
+
+      private
+
+      sig { params(node: Prism::CallNode).void }
+      def complete_require(node)
+        arguments_node = node.arguments
+        return unless arguments_node
+
+        path_node_to_complete = arguments_node.arguments.first
+
+        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|
+          @response_builder << build_completion(T.must(path), path_node_to_complete)
+        end
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def complete_require_relative(node)
+        arguments_node = node.arguments
+        return unless arguments_node
+
+        path_node_to_complete = arguments_node.arguments.first
+
+        return unless path_node_to_complete.is_a?(Prism::StringNode)
+
+        origin_dir = Pathname.new(@uri.to_standardized_path).dirname
+
+        content = path_node_to_complete.content
+        # if the path is not a directory, glob all possible next characters
+        # for example ../somethi| (where | is the cursor position)
+        # should find files for ../somethi*/
+        path_query = if content.end_with?("/") || content.empty?
+          "#{content}**/*.rb"
+        else
+          "{#{content}*/**/*.rb,**/#{content}*.rb}"
+        end
+
+        Dir.glob(path_query, File::FNM_PATHNAME | File::FNM_EXTGLOB, base: origin_dir).sort!.each do |path|
+          @response_builder << build_completion(
+            path.delete_suffix(".rb"),
+            path_node_to_complete,
+          )
+        end
+      end
+
+      sig { params(node: Prism::CallNode, name: String).void }
+      def complete_self_receiver_method(node, name)
         receiver_entries = @index[@nesting.join("::")]
         return unless receiver_entries
 
@@ -125,8 +173,6 @@ module RubyLsp
         end
       end
 
-      private
-
       sig do
         params(
           entry: RubyIndexer::Entry::Member,

data/lib/ruby_lsp/requests/completion.rb

@@ -34,7 +34,7 @@ module RubyLsp
         def provider
           Interface::CompletionOptions.new(
             resolve_provider: false,
-            trigger_characters: ["/"],
+            trigger_characters: ["/", "\"", "'"],
             completion_item: {
               labelDetailsSupport: true,
             },
@@ -68,26 +68,13 @@ module RubyLsp
           ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
         )
 
-        Listeners::Completion.new(@response_builder, index, nesting, typechecker_enabled, dispatcher)
+        Listeners::Completion.new(@response_builder, index, nesting, typechecker_enabled, dispatcher, document.uri)
 
         return unless matched && parent
 
         @target = case matched
         when Prism::CallNode
-          message = matched.message
-
-          if message == "require"
-            args = matched.arguments&.arguments
-            return if args.nil? || args.is_a?(Prism::ForwardingArgumentsNode)
-
-            argument = args.first
-            return unless argument.is_a?(Prism::StringNode)
-            return unless (argument.location.start_offset..argument.location.end_offset).cover?(char_position)
-
-            argument
-          else
-            matched
-          end
+          matched
         when Prism::ConstantReadNode, Prism::ConstantPathNode
           if parent.is_a?(Prism::ConstantPathNode) && matched.is_a?(Prism::ConstantReadNode)
             parent

data/lib/ruby_lsp/requests/diagnostics.rb

@@ -42,27 +42,61 @@ module RubyLsp
 
       sig { override.returns(T.nilable(T.all(T::Array[Interface::Diagnostic], Object))) }
       def perform
+        diagnostics = []
+        diagnostics.concat(syntax_error_diagnostics, syntax_warning_diagnostics)
+
         # Running RuboCop is slow, so to avoid excessive runs we only do so if the file is syntactically valid
-        return syntax_error_diagnostics if @document.syntax_error?
-        return [] unless defined?(Support::RuboCopDiagnosticsRunner)
+        return diagnostics if @document.syntax_error?
+
+        diagnostics.concat(
+          Support::RuboCopDiagnosticsRunner.instance.run(
+            @uri,
+            @document,
+          ).map!(&:to_lsp_diagnostic),
+        ) if defined?(Support::RuboCopDiagnosticsRunner)
 
-        Support::RuboCopDiagnosticsRunner.instance.run(@uri, @document).map!(&:to_lsp_diagnostic)
+        diagnostics
       end
 
       private
 
-      sig { returns(T.nilable(T::Array[Interface::Diagnostic])) }
+      sig { returns(T::Array[Interface::Diagnostic]) }
+      def syntax_warning_diagnostics
+        @document.parse_result.warnings.map do |warning|
+          location = warning.location
+
+          Interface::Diagnostic.new(
+            source: "Prism",
+            message: warning.message,
+            severity: Constant::DiagnosticSeverity::WARNING,
+            range: Interface::Range.new(
+              start: Interface::Position.new(
+                line: location.start_line - 1,
+                character: location.start_column,
+              ),
+              end: Interface::Position.new(
+                line: location.end_line - 1,
+                character: location.end_column,
+              ),
+            ),
+          )
+        end
+      end
+
+      sig { returns(T::Array[Interface::Diagnostic]) }
       def syntax_error_diagnostics
         @document.parse_result.errors.map do |error|
+          location = error.location
+
           Interface::Diagnostic.new(
             range: Interface::Range.new(
               start: Interface::Position.new(
-                line: error.location.start_line - 1,
-                character: error.location.start_column,
+                line: location.start_line - 1,
+                character: location.start_column,
               ),
               end: Interface::Position.new(
-                line: error.location.end_line - 1,
-                character: error.location.end_column,
+                line: location.end_line - 1,
+                character: location.end_column,
               ),
             ),
             message: error.message,

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -178,7 +178,7 @@ module RubyLsp
 
       sig { params(line: Integer, character: Integer).void }
       def move_cursor_to(line, character)
-        return if @client_name != "Visual Studio Code"
+        return unless @client_name.start_with?("Visual Studio Code")
 
         position = Interface::Position.new(
           line: line,

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

@@ -40,6 +40,9 @@ module RubyLsp
 
         sig { returns(Interface::Diagnostic) }
         def to_lsp_diagnostic
+          # highlighted_area contains the begin and end position of the first line
+          # This ensures that multiline offenses don't clutter the editor
+          highlighted = @offense.highlighted_area
           Interface::Diagnostic.new(
             message: message,
             source: "RuboCop",
@@ -49,11 +52,11 @@ module RubyLsp
             range: Interface::Range.new(
               start: Interface::Position.new(
                 line: @offense.line - 1,
-                character: @offense.column,
+                character: highlighted.begin_pos,
               ),
               end: Interface::Position.new(
-                line: @offense.last_line - 1,
-                character: @offense.last_column,
+                line: @offense.line - 1,
+                character: highlighted.end_pos,
               ),
             ),
             data: {

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

@@ -13,6 +13,10 @@ rescue LoadError
   raise StandardError, "Incompatible RuboCop version. Ruby LSP requires >= 1.4.0"
 end
 
+if RuboCop.const_defined?(:LSP) # This condition will be removed when requiring RuboCop >= 1.61.
+  RuboCop::LSP.enable
+end
+
 module RubyLsp
   module Requests
     module Support

data/lib/ruby_lsp/utils.rb

@@ -41,7 +41,22 @@ module RubyLsp
     end
   end
 
-  class Notification < Message; end
+  class Notification < Message
+    class << self
+      extend T::Sig
+      sig { params(message: String).returns(Notification) }
+      def window_show_error(message)
+        new(
+          message: "window/showMessage",
+          params: Interface::ShowMessageParams.new(
+            type: Constant::MessageType::ERROR,
+            message: message,
+          ),
+        )
+      end
+    end
+  end
+
   class Request < Message; end
 
   # The final result of running a request before its IO is finalized

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.14.3
+  version: 0.14.5
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol