ruby-lsp 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e66f508823e7d8e663c90e9990ae13bf26c3480d4ce9d7d43db14185518064d
-  data.tar.gz: 70cfc0be15d1ad988d66a641191fa64679109ae1f6be56afdc01ded665b0a439
+  metadata.gz: 9762389a7b7979afb57d6e6d2cf0d65b0b0a0b31f5a1fdd7045311c33a0c21d6
+  data.tar.gz: 35cc2318946e650ee311129955d3674c7e693a87d25c5cc2f29c5a55e479d880
 SHA512:
-  metadata.gz: a2f71a448863bf25e229032cb06d3ae7e7ebf1ef50b414e6486bd902ec7f100dad1ae4cb7160ef9c5fa8069f3ff0bcbb3da29d9c16a49f2e347f8d3d8797049a
-  data.tar.gz: 4cd747fb8505531a1ab0f1c28c8b3a09a134d544c1834b2f821c220bce2e3b6efce325b73326e23d92891a27ae5ae3cd9a79e9bbfdfa1b45c8f6e490b74d5c9a
+  metadata.gz: 4735e18c297c992727d0a151ed7948cf6d4ea32b01fe411ed0774efdda7cdc0cf6533f5d71ad288aad9e6e717149932744376fdceda9fa4cd039b560934a9b47
+  data.tar.gz: bd6e0c9a81a373c509f2f96b480543657a8d241a6e58ea25ec21c62ac60094f299af1c5f85d1555ad6ca1908c325e46569119271d4c6b7117f33f9919cf40bca

data/CHANGELOG.md

@@ -6,6 +6,19 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.3.1]
+
+- Resolve TODO for LSP v3.17 (https://github.com/Shopify/ruby-lsp/pull/268)
+- Add dependency constraint for LSP v3.17 (https://github.com/Shopify/ruby-lsp/pull/269)
+- Handle class/module declarations as a class token with declaration modifier (https://github.com/Shopify/ruby-lsp/pull/260)
+- Handle required parameters in semantic highlighting (https://github.com/Shopify/ruby-lsp/pull/271)
+- Add comment continuation via on type on_type_formatting (https://github.com/Shopify/ruby-lsp/pull/274)
+- Make RuboCop runner use composition instead of inheritance (https://github.com/Shopify/ruby-lsp/pull/278)
+- Protect worker against cancellation during popping (https://github.com/Shopify/ruby-lsp/pull/280)
+- Handle formatting errors in on_error block (https://github.com/Shopify/ruby-lsp/pull/279)
+- Fix on type formatting pipe completion for regular or expressions (https://github.com/Shopify/ruby-lsp/pull/282)
+- Do not fail on LoadError (https://github.com/Shopify/ruby-lsp/pull/292)
+
 ## [0.3.0]
 - Add on type formatting completions (https://github.com/Shopify/ruby-lsp/pull/253)
 - Upgrade syntax_tree requirement to >= 3.4 (https://github.com/Shopify/ruby-lsp/pull/254)

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/ruby_lsp/handler.rb

@@ -20,13 +20,13 @@ module RubyLsp
       const :action, T.proc.params(request: T::Hash[Symbol, T.untyped]).returns(T.untyped)
       const :parallel, T::Boolean
       prop :error_handler,
-        T.nilable(T.proc.params(error: StandardError, request: T::Hash[Symbol, T.untyped]).void)
+        T.nilable(T.proc.params(error: Exception, request: T::Hash[Symbol, T.untyped]).void)
 
       # A proc that runs in case a request has errored. Receives the error and the original request as arguments. Useful
       # for displaying window messages on errors
       sig do
         params(
-          block: T.proc.bind(Handler).params(error: StandardError, request: T::Hash[Symbol, T.untyped]).void
+          block: T.proc.bind(Handler).params(error: Exception, request: T::Hash[Symbol, T.untyped]).void
         ).void
       end
       def on_error(&block)

data/lib/ruby_lsp/queue.rb

@@ -7,11 +7,11 @@ module RubyLsp
   class Queue
     extend T::Sig
 
-    class Cancelled < Interrupt; end
+    class Cancelled < StandardError; end
 
     class Result < T::Struct
       const :response, T.untyped # rubocop:disable Sorbet/ForbidUntypedStructProps
-      const :error, T.nilable(StandardError)
+      const :error, T.nilable(Exception)
       const :request_time, T.nilable(Float)
     end
 
@@ -88,11 +88,13 @@ module RubyLsp
     sig { params(request: T::Hash[Symbol, T.untyped]).returns(Queue::Result) }
     def execute(request)
       response = T.let(nil, T.untyped)
-      error = T.let(nil, T.nilable(StandardError))
+      error = T.let(nil, T.nilable(Exception))
 
       request_time = Benchmark.realtime do
         response = T.must(@handlers[request[:method]]).action.call(request)
-      rescue StandardError => e
+      rescue Cancelled
+        raise
+      rescue StandardError, LoadError => e
         error = e
       end
 
@@ -135,7 +137,10 @@ module RubyLsp
     def new_worker
       Thread.new do
         # Thread::Queue#pop is thread safe and will wait until an item is available
-        while (job = T.let(@job_queue.pop, T.nilable(Job)))
+        loop do
+          job = T.let(@job_queue.pop, T.nilable(Job))
+          break if job.nil?
+
           # The only time when the job is nil is when the queue is closed and we can then terminate the thread
 
           request = job.request
@@ -144,17 +149,18 @@ module RubyLsp
             @current_job = job
           end
 
-          begin
-            next if job.cancelled
+          next if job.cancelled
 
-            result = execute(request)
-          rescue Cancelled
-            # We need to return nil to the client even if the request was cancelled
-            result = Queue::Result.new(response: nil, error: nil, request_time: nil)
-          ensure
-            @mutex.synchronize { @current_job = nil }
-            finalize_request(result, request) unless result.nil?
-          end
+          result = execute(request)
+        rescue Cancelled
+          # We need to return nil to the client even if the request was cancelled
+          result = Queue::Result.new(response: nil, error: nil, request_time: nil)
+        ensure
+          @mutex.synchronize { @current_job = nil }
+
+          # If there's request, it means the worker was cancelled while waiting to pop from the queue or immediately
+          # after
+          finalize_request(result, request) unless result.nil? || request.nil?
         end
       end
     end
@@ -163,7 +169,7 @@ module RubyLsp
       params(
         request: T::Hash[Symbol, T.untyped],
         request_time: Float,
-        error: T.nilable(StandardError)
+        error: T.nilable(Exception)
       ).returns(T::Hash[Symbol, T.any(String, Float)])
     end
     def telemetry_params(request, request_time, error)

data/lib/ruby_lsp/requests/formatting.rb

@@ -19,6 +19,8 @@ module RubyLsp
     # end
     # ```
     class Formatting < BaseRequest
+      class Error < StandardError; end
+
       extend T::Sig
 
       sig { params(uri: String, document: Document).void }

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -41,7 +41,9 @@ module RubyLsp
 
       sig { override.returns(T.nilable(T.all(T::Array[Interface::TextEdit], Object))) }
       def run
-        return unless @document.syntax_errors?
+        handle_comment_line
+
+        return @edits unless @document.syntax_errors?
 
         case @trigger_character
         when "{"
@@ -59,7 +61,7 @@ module RubyLsp
 
       sig { void }
       def handle_pipe
-        return unless /".*|/.match?(@previous_line)
+        return unless /((?<=do)|(?<={))\s+\|/.match?(@previous_line)
 
         add_edit_with_text("|")
         move_cursor_to(@position[:line], @position[:character])
@@ -83,6 +85,18 @@ module RubyLsp
         move_cursor_to(@position[:line], @indentation + 2)
       end
 
+      sig { void }
+      def handle_comment_line
+        return unless @trigger_character == "\n"
+
+        is_comment_match = @previous_line.match(/^#(\s*)/)
+        return unless is_comment_match
+
+        spaces = T.must(is_comment_match[1])
+        add_edit_with_text("##{spaces}")
+        move_cursor_to(@position[:line], @indentation + spaces.size + 1)
+      end
+
       sig { params(text: String).void }
       def add_edit_with_text(text)
         position = Interface::Position.new(

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -185,6 +185,10 @@ module RubyLsp
           add_token(location_without_colon(location), :variable)
         end
 
+        node.requireds.each do |required|
+          add_token(required.location, :variable)
+        end
+
         rest = node.keyword_rest
         return if rest.nil? || rest.is_a?(SyntaxTree::ArgsForward)
 
@@ -217,6 +221,19 @@ module RubyLsp
         add_token(node.value.location, :method) unless special_method?(node.value.value)
       end
 
+      sig { params(node: SyntaxTree::ClassDeclaration).void }
+      def visit_class(node)
+        add_token(node.constant.location, :class, [:declaration])
+        add_token(node.superclass.location, :class) if node.superclass
+        visit(node.bodystmt)
+      end
+
+      sig { params(node: SyntaxTree::ModuleDeclaration).void }
+      def visit_module(node)
+        add_token(node.constant.location, :class, [:declaration])
+        visit(node.bodystmt)
+      end
+
       sig { params(location: SyntaxTree::Location, type: Symbol, modifiers: T::Array[Symbol]).void }
       def add_token(location, type, modifiers = [])
         length = location.end_char - location.start_char

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

@@ -1,11 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-begin
-  require "rubocop"
-rescue LoadError
-  return
-end
+require "ruby_lsp/requests/support/rubocop_runner"
+return unless defined?(::RubyLsp::Requests::Support::RuboCopRunner)
 
 require "cgi"
 require "singleton"
@@ -14,46 +11,24 @@ module RubyLsp
   module Requests
     module Support
       # :nodoc:
-      class RuboCopDiagnosticsRunner < RuboCop::Runner
+      class RuboCopDiagnosticsRunner
         extend T::Sig
         include Singleton
 
         sig { void }
         def initialize
-          @options = T.let({}, T::Hash[Symbol, T.untyped])
-          @uri = T.let(nil, T.nilable(String))
-          @diagnostics = T.let([], T::Array[Support::RuboCopDiagnostic])
-
-          super(
-            ::RuboCop::Options.new.parse([
-              "--stderr", # Print any output to stderr so that our stdout does not get polluted
-              "--force-exclusion",
-              "--format",
-              "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
-            ]).first,
-            ::RuboCop::ConfigStore.new
-          )
+          @runner = T.let(RuboCopRunner.new, RuboCopRunner)
         end
 
         sig { params(uri: String, document: Document).returns(T::Array[Support::RuboCopDiagnostic]) }
         def run(uri, document)
-          @diagnostics.clear
-          @uri = uri
-
-          file = CGI.unescape(URI.parse(uri).path)
-          # We communicate with Rubocop via stdin
-          @options[:stdin] = document.source
-
+          filename = CGI.unescape(URI.parse(uri).path)
           # Invoke RuboCop with just this file in `paths`
-          super([file])
-          @diagnostics
-        end
-
-        private
+          @runner.run(filename, document.source)
 
-        sig { params(_file: String, offenses: T::Array[RuboCop::Cop::Offense]).void }
-        def file_finished(_file, offenses)
-          @diagnostics = offenses.map { |offense| Support::RuboCopDiagnostic.new(offense, T.must(@uri)) }
+          @runner.offenses.map do |offense|
+            Support::RuboCopDiagnostic.new(offense, uri)
+          end
         end
       end
     end

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

@@ -1,11 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-begin
-  require "rubocop"
-rescue LoadError
-  return
-end
+require "ruby_lsp/requests/support/rubocop_runner"
+return unless defined?(::RubyLsp::Requests::Support::RuboCopRunner)
 
 require "cgi"
 require "singleton"
@@ -14,35 +11,24 @@ module RubyLsp
   module Requests
     module Support
       # :nodoc:
-      class RuboCopFormattingRunner < RuboCop::Runner
+      class RuboCopFormattingRunner
         extend T::Sig
         include Singleton
 
         sig { void }
         def initialize
-          @options = T.let({}, T::Hash[Symbol, T.untyped])
-
-          super(
-            ::RuboCop::Options.new.parse([
-              "--stderr", # Print any output to stderr so that our stdout does not get polluted
-              "--force-exclusion",
-              "--format",
-              "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
-              "-a", # --auto-correct
-            ]).first,
-            ::RuboCop::ConfigStore.new
-          )
+          # -a is for "--auto-correct" (or "--autocorrect" on newer versions of RuboCop)
+          @runner = T.let(RuboCopRunner.new("-a"), RuboCopRunner)
         end
 
         sig { params(uri: String, document: Document).returns(T.nilable(String)) }
         def run(uri, document)
-          file = CGI.unescape(URI.parse(uri).path)
-          # We communicate with Rubocop via stdin
-          @options[:stdin] = document.source
+          filename = CGI.unescape(URI.parse(uri).path)
 
           # Invoke RuboCop with just this file in `paths`
-          super([file])
-          @options[:stdin]
+          @runner.run(filename, document.source)
+
+          @runner.formatted_source
         end
       end
     end

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

@@ -0,0 +1,69 @@
+# typed: strict
+# frozen_string_literal: true
+
+begin
+  require "rubocop"
+rescue LoadError
+  return
+end
+
+module RubyLsp
+  module Requests
+    module Support
+      # :nodoc:
+      class RuboCopRunner < RuboCop::Runner
+        extend T::Sig
+
+        sig { returns(T::Array[RuboCop::Cop::Offense]) }
+        attr_reader :offenses
+
+        DEFAULT_ARGS = T.let([
+          "--stderr", # Print any output to stderr so that our stdout does not get polluted
+          "--force-exclusion",
+          "--format",
+          "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
+        ].freeze, T::Array[String])
+
+        sig { params(args: String).void }
+        def initialize(*args)
+          @options = T.let({}, T::Hash[Symbol, T.untyped])
+          @offenses = T.let([], T::Array[RuboCop::Cop::Offense])
+          @errors = T.let([], T::Array[String])
+          @warnings = T.let([], T::Array[String])
+
+          args += DEFAULT_ARGS
+          rubocop_options = ::RuboCop::Options.new.parse(args).first
+          config_store = ::RuboCop::ConfigStore.new
+
+          super(rubocop_options, config_store)
+        end
+
+        sig { params(path: String, contents: String).void }
+        def run(path, contents)
+          # Clear Runner state between runs since we get a single instance of this class
+          # on every use site.
+          @errors = []
+          @warnings = []
+          @offenses = []
+          @options[:stdin] = contents
+
+          super([path])
+        rescue RuboCop::Runner::InfiniteCorrectionLoop => error
+          raise Formatting::Error, error.message
+        end
+
+        sig { returns(String) }
+        def formatted_source
+          @options[:stdin]
+        end
+
+        private
+
+        sig { params(_file: String, offenses: T::Array[RuboCop::Cop::Offense]).void }
+        def file_finished(_file, offenses)
+          @offenses = offenses
+        end
+      end
+    end
+  end
+end

data/lib/ruby_lsp/server.rb

@@ -55,24 +55,23 @@ module RubyLsp
         )
       end
 
-      # TODO: switch back to using Interface::ServerCapabilities once the gem is updated for spec 3.17
       Interface::InitializeResult.new(
-        capabilities: {
-          textDocumentSync: Interface::TextDocumentSyncOptions.new(
+        capabilities: Interface::ServerCapabilities.new(
+          text_document_sync: Interface::TextDocumentSyncOptions.new(
             change: Constant::TextDocumentSyncKind::INCREMENTAL,
             open_close: true,
           ),
-          selectionRangeProvider: enabled_features.include?("selectionRanges"),
-          documentSymbolProvider: document_symbol_provider,
-          documentLinkProvider: document_link_provider,
-          foldingRangeProvider: folding_ranges_provider,
-          semanticTokensProvider: semantic_tokens_provider,
-          documentFormattingProvider: enabled_features.include?("formatting"),
-          documentHighlightProvider: enabled_features.include?("documentHighlights"),
-          codeActionProvider: enabled_features.include?("codeActions"),
-          documentOnTypeFormattingProvider: on_type_formatting_provider,
-          diagnosticProvider: diagnostics_provider,
-        }.reject { |_, v| !v }
+          selection_range_provider: enabled_features.include?("selectionRanges"),
+          document_symbol_provider: document_symbol_provider,
+          document_link_provider: document_link_provider,
+          folding_range_provider: folding_ranges_provider,
+          semantic_tokens_provider: semantic_tokens_provider,
+          document_formatting_provider: enabled_features.include?("formatting"),
+          document_highlight_provider: enabled_features.include?("documentHighlights"),
+          code_action_provider: enabled_features.include?("codeActions"),
+          document_on_type_formatting_provider: on_type_formatting_provider,
+          diagnostic_provider: diagnostics_provider,
+        )
       )
     end
 
@@ -156,9 +155,8 @@ module RubyLsp
       uri = request.dig(:params, :textDocument, :uri)
 
       Requests::Formatting.new(uri, store.get(uri)).run
-    rescue RuboCop::Runner::InfiniteCorrectionLoop => e
-      show_message(Constant::MessageType::ERROR, "Error from RuboCop: #{e.message}")
-      nil
+    end.on_error do |error|
+      show_message(Constant::MessageType::ERROR, "Formatting error: #{error.message}")
     end
 
     on("textDocument/onTypeFormatting", parallel: true) do |request|

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.17.0
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb
 - lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb
+- lib/ruby_lsp/requests/support/rubocop_runner.rb
 - lib/ruby_lsp/requests/support/selection_range.rb
 - lib/ruby_lsp/requests/support/semantic_token_encoder.rb
 - lib/ruby_lsp/requests/support/source_uri.rb