ruby-lsp 0.0.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ed87185da0a5d1da74b10f1525f1ca1341f1001f3a4cbdf2b086dd93750ad9
-  data.tar.gz: 1210f736e4cd8450cbe1e1d796dbd22a889c244c6ea5902bc6082f3791064ddc
+  metadata.gz: f81baa8f09011e5130c955c4c5d2a33583379b0b073caee556719b874efc320e
+  data.tar.gz: 55a664f923d93bda9ddb06624303f889123496c672c46b31ea71c629cfa96a81
 SHA512:
-  metadata.gz: a1ed47a3e4d53dbf5250beaa98b3095c89099e67829f2ecac3149b34ecc87ae579c67ed6cd67035ee9930c0fffa0db6c0d4fdc3c3398520196005b180f28ea6f
-  data.tar.gz: 18d07a7c5426fa8cfad11cfab44dbabf05fd3a1352f1bf9272b04fb35c78f0bb0b4860dd4b7bbfda89efb9cfa99fc3ef77fbb679ff2b21bbd4cffb3c53a14bd5
+  metadata.gz: 8a872f34699bfaa4f955c714c4e49eed52e87b009afc0a642d0ad434956f6a14690188ad9c359cc7aadd53e96fbd0d5d320e00aa263265e1ce3d3e369e8bd124
+  data.tar.gz: 06444ea3e08b961445db6cb1a9093fc322b40ddf47daa00deb09a77f3b114014be8f525d7d391430b578b7916042bf345759d113c74e41a8ea51d65791abe69c

data/.github/workflows/ci.yml

@@ -17,9 +17,15 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+
       - name: Check if documentation is up to date
         run: bundle exec rake check_docs
+
+      - name: Typecheck
+        run: bundle exec srb tc
+
       - name: Lint Ruby files
         run: bin/rubocop
+
       - name: Run tests
         run: bin/test

data/.rubocop.yml

@@ -1,6 +1,11 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
+require:
+ - rubocop-sorbet
+ - rubocop-minitest
+ - rubocop-rake
+
 AllCops:
   NewCops: disable
   SuggestExtensions: false
@@ -8,7 +13,27 @@ AllCops:
   Exclude:
   - "vendor/**/*"
   - "features/**/*"
+  - "test/fixtures/**/*"
 
 Naming/FileName:
   Exclude:
   - "lib/ruby-lsp.rb"
+
+Sorbet/FalseSigil:
+  Enabled: false
+
+Sorbet/TrueSigil:
+  Enabled: true
+  Include:
+    - "test/**/*.rb"
+  Exclude:
+    - "**/*.rake"
+    - "lib/**/*.rb"
+
+Sorbet/StrictSigil:
+  Enabled: true
+  Include:
+    - "lib/**/*.rb"
+  Exclude:
+    - "**/*.rake"
+    - "test/**/*.rb"

data/CHANGELOG.md

@@ -6,6 +6,41 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.2.0]
+
+- Add semantic token for keyword and keyword rest params (https://github.com/Shopify/ruby-lsp/pull/142)
+- Return error responses on exceptions (https://github.com/Shopify/ruby-lsp/pull/160)
+- Sanitize home directory for telemetry (https://github.com/Shopify/ruby-lsp/pull/171)
+- Avoid adding semantic tokens for special methods (https://github.com/Shopify/ruby-lsp/pull/162)
+- Properly respect excluded files in RuboCop requests (https://github.com/Shopify/ruby-lsp/pull/173)
+- Clear diagnostics when closing files (https://github.com/Shopify/ruby-lsp/pull/174)
+- Avoid pushing ranges for single line partial ranges (https://github.com/Shopify/ruby-lsp/pull/185)
+- Change folding ranges to include closing tokens (https://github.com/Shopify/ruby-lsp/pull/181)
+- Remove RuboCop dependency and fallback to SyntaxTree formatting (https://github.com/Shopify/ruby-lsp/pull/184)
+
+## [0.1.0]
+
+- Implement token modifiers in SemanticTokenEncoder ([#112](https://github.com/Shopify/ruby-lsp/pull/112))
+- Add semantic token for name in a method definition ([#133](https://github.com/Shopify/ruby-lsp/pull/133))
+- Add semantic highighting for def endless and singleton method names ([#134](https://github.com/Shopify/ruby-lsp/pull/134))
+- Add semantic token for keyword self ([#137](https://github.com/Shopify/ruby-lsp/pull/137))
+- Add semantic token for constants ([#138](https://github.com/Shopify/ruby-lsp/pull/138))
+- Improve error handling + fix formatting hanging issue ([#149](https://github.com/Shopify/ruby-lsp/pull/149))
+- Set the minimum syntax_tree version to 2.4 ([#151](https://github.com/Shopify/ruby-lsp/pull/151))
+
+## [0.0.4]
+
+- Add basic document highlight (https://github.com/Shopify/ruby-lsp/pull/91)
+- Add error telemetry (https://github.com/Shopify/ruby-lsp/pull/100)
+- Always push telemetry events from the server (https://github.com/Shopify/ruby-lsp/pull/109)
+- Fix multibyte character handling (https://github.com/Shopify/ruby-lsp/pull/122)
+- Add Sorbet to the Ruby LSP (https://github.com/Shopify/ruby-lsp/pull/119, https://github.com/Shopify/ruby-lsp/pull/123)
+
+## [0.0.3]
+
+- Fixed code actions return hanging
+- Moved to incremental text synchronization
+- Added syntax error resiliency
 
 ## [0.0.2]
 

data/Gemfile

@@ -4,11 +4,15 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "debug", "~> 1.5"
-gem "minitest", "~> 5.15"
+gem "debug", "~> 1.5", require: false
+gem "minitest", "~> 5.16"
 gem "minitest-reporters", "~> 1.5"
 gem "rake", "~> 13.0"
-gem "rubocop-shopify", "~> 2.6"
-gem "rubocop-minitest", "~> 0.19.1"
-gem "rubocop-rake", "~> 0.6.0"
-gem "yard", "~> 0.9"
+gem "rubocop", ">= 1.0.0"
+gem "rubocop-shopify", "~> 2.8", require: false
+gem "rubocop-minitest", "~> 0.20.1", require: false
+gem "rubocop-rake", "~> 0.6.0", require: false
+gem "rubocop-sorbet", "~> 0.6", require: false
+gem "sorbet-static-and-runtime"
+gem "tapioca", "~> 0.8", require: false
+gem "yard", "~> 0.9", require: false

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    ruby-lsp (0.0.3)
+    ruby-lsp (0.2.0)
       language_server-protocol
-      rubocop (>= 1.0)
-      syntax_tree (>= 2.3)
+      sorbet-runtime
+      syntax_tree (>= 2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -12,14 +12,18 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
+    coderay (1.1.3)
     debug (1.5.0)
       irb (>= 1.3.6)
       reline (>= 0.2.7)
+    diff-lcs (1.5.0)
     io-console (0.5.11)
     irb (1.4.1)
       reline (>= 0.3.0)
+    json (2.6.2)
     language_server-protocol (3.16.0.3)
-    minitest (5.15.0)
+    method_source (1.0.0)
+    minitest (5.16.2)
     minitest-reporters (1.5.0)
       ansi
       builder
@@ -29,36 +33,75 @@ GEM
     parser (3.1.2.0)
       ast (~> 2.4.1)
     prettier_print (0.1.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.4.0)
+    rbi (0.0.15)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.5.0)
     reline (0.3.1)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.29.1)
+    rubocop (1.31.1)
+      json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.1)
+    rubocop-minitest (0.20.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-shopify (2.6.0)
-      rubocop (~> 1.29)
+    rubocop-shopify (2.8.0)
+      rubocop (~> 1.31)
+    rubocop-sorbet (0.6.11)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
-    syntax_tree (2.7.1)
+    sorbet (0.5.10139)
+      sorbet-static (= 0.5.10139)
+    sorbet-runtime (0.5.10139)
+    sorbet-static (0.5.10139-universal-darwin-21)
+    sorbet-static (0.5.10139-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10139)
+      sorbet (= 0.5.10139)
+      sorbet-runtime (= 0.5.10139)
+    spoom (1.1.11)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    syntax_tree (2.8.0)
       prettier_print
-    unicode-display_width (2.1.0)
+    tapioca (0.8.3)
+      bundler (>= 1.17.3)
+      parallel (>= 1.21.0)
+      pry (>= 0.12.2)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-static-and-runtime (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    unicode-display_width (2.2.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
     webrick (1.7.0)
-    yard (0.9.27)
+    yard (0.9.28)
       webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
   arm64-darwin-21
@@ -66,13 +109,17 @@ PLATFORMS
 
 DEPENDENCIES
   debug (~> 1.5)
-  minitest (~> 5.15)
+  minitest (~> 5.16)
   minitest-reporters (~> 1.5)
   rake (~> 13.0)
-  rubocop-minitest (~> 0.19.1)
+  rubocop (>= 1.0.0)
+  rubocop-minitest (~> 0.20.1)
   rubocop-rake (~> 0.6.0)
-  rubocop-shopify (~> 2.6)
+  rubocop-shopify (~> 2.8)
+  rubocop-sorbet (~> 0.6)
   ruby-lsp!
+  sorbet-static-and-runtime
+  tapioca (~> 0.8)
   yard (~> 0.9)
 
 BUNDLED WITH

data/README.md

@@ -17,6 +17,9 @@ end
 If using VS Code, install the [Ruby LSP plugin](https://github.com/Shopify/vscode-ruby-lsp) to get the extra features in
 the editor.
 
+See the [documentation](https://shopify.github.io/ruby-lsp) for
+[supported features](https://shopify.github.io/ruby-lsp/RubyLsp/Requests.html).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp.
@@ -25,6 +28,44 @@ are expected to adhere to the
 [Contributor Covenant](https://github.com/Shopify/ruby-lsp/blob/main/CODE_OF_CONDUCT.md)
 code of conduct.
 
+### Expectation testing
+
+To simplify the way we run tests over different pieces of Ruby code, we use a custom expectations test framework against a set of Ruby fixtures.
+
+To add a new fixture to the expectations test suite:
+
+1. Add a new fixture `my_fixture.rb` file under `test/fixtures`
+2. (optional) Add new expectations under `test/expectations/$HANDLER` for the request handlers you're concerned by
+3. Profit by running `bin/test test/requests/$HANDLER_expectations_test my_fixture`
+    * Handlers for which you added expectations will be checked with `assert_expectations`
+    * Handlers without expectations will be ran against your new test to check that nothing breaks
+
+To add a new expectations test runner for a new request handler:
+
+1. Add a new file under `test/requests/$HANDLER_expectations_test.rb` that subclasses `ExpectationsTestRunner` and calls `expectations_tests $HANDLER, "$EXPECTATIONS_DIR"` where: `$HANDLER` is the fully qualified name or your handler class and `$EXPECTATIONS_DIR` is the directory name where you want to store the expectation files.
+
+   ```rb
+   # frozen_string_literal: true
+
+   require "test_helper"
+   require "expectations/expectations_test_runner"
+
+   class $HANDLERExpectationsTest < ExpectationsTestRunner
+     expectations_tests RubyLsp::Requests::$HANDLER, "$EXPECTATIONS_DIR"
+   end
+   ```
+
+2. (optional) Override the `run_expectations` and `assert_expectations` methods if needed. See the different request handler expectations runners under `test/requests/*_expectations_test.rb` for examples.
+
+4. (optional) Add new fixtures for your handler under `test/fixtures`
+
+5. (optional) Add new expectations under `test/expectations/$HANDLER`
+   * No need to write the expectations by hand, just run the test with an empty expectation file and copy from the output.
+
+7. Profit by running, `bin/test test/expectations_test $HANDLER`
+    * Tests with expectations will be checked with `assert_expectations`
+    * Tests without expectations will be ran against your new $HANDLER to check that nothing breaks
+
 ## Debugging
 
 ### Tracing LSP requests and responses

data/Rakefile

@@ -11,7 +11,14 @@ Rake::TestTask.new(:test) do |t|
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.options = ["--markup", "markdown", "--output-dir", "docs"]
+  t.options = [
+    "--markup",
+    "markdown",
+    "--output-dir",
+    "docs",
+    "--asset",
+    "misc",
+  ]
 end
 
 require "rubocop/rake_task"

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.2.0

data/bin/console

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# typed: strict
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/ruby_lsp/internal"
+require "irb"
+
+extend T::Sig
+
+sig { params(source: String).returns(RubyLsp::Document) }
+def new_doc(source)
+  RubyLsp::Document.new(source)
+end
+
+@source = T.let(File.read(File.expand_path("../lib/ruby_lsp/handler.rb", __dir__)), String)
+@document = T.let(new_doc(@source), RubyLsp::Document)
+
+IRB.start(__FILE__)

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/dev.yml

@@ -10,6 +10,9 @@ up:
 commands:
   server: exe/ruby-lsp
   style: bin/rubocop
+  typecheck:
+    aliases: ["tc"]
+    run: "bundle exec srb tc"
   test:
     syntax:
       argument: file

data/exe/ruby-lsp

@@ -1,8 +1,23 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "syntax_tree"
-require "ruby-lsp"
-require "ruby_lsp/cli"
+require "sorbet-runtime"
 
-RubyLsp::Cli.start(ARGV)
+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
+
+require_relative "../lib/ruby_lsp/internal"
+
+RubyLsp::Cli.start

data/lib/ruby-lsp.rb

@@ -1,5 +1,6 @@
+# typed: strict
 # frozen_string_literal: true
 
 module RubyLsp
-  VERSION = File.read(File.expand_path("../VERSION", __dir__)).strip
+  VERSION = T.let(File.read(File.expand_path("../VERSION", __dir__)).strip, String)
 end

data/lib/ruby_lsp/cli.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 require "language_server-protocol"
@@ -6,7 +7,10 @@ require_relative "handler"
 
 module RubyLsp
   module Cli
-    def self.start(_argv)
+    extend T::Sig
+
+    sig { void }
+    def self.start
       handler = RubyLsp::Handler.new
 
       handler.config do
@@ -14,7 +18,6 @@ module RubyLsp
           store.clear
           initialization_options = request.dig(:params, :initializationOptions)
 
-          configure_options(initialization_options)
           respond_with_capabilities(initialization_options.fetch(:enabledFeatures, []))
         end
 
@@ -23,7 +26,7 @@ module RubyLsp
           store.push_edits(uri, request.dig(:params, :contentChanges))
 
           send_diagnostics(uri)
-          nil
+          RubyLsp::Handler::VOID
         end
 
         on("textDocument/didOpen") do |request|
@@ -32,14 +35,15 @@ module RubyLsp
           store.set(uri, text)
 
           send_diagnostics(uri)
-          nil
+          RubyLsp::Handler::VOID
         end
 
         on("textDocument/didClose") do |request|
           uri = request.dig(:params, :textDocument, :uri)
           store.delete(uri)
+          clear_diagnostics(uri)
 
-          nil
+          RubyLsp::Handler::VOID
         end
 
         on("textDocument/documentSymbol") do |request|
@@ -65,6 +69,10 @@ module RubyLsp
           respond_with_formatting(request.dig(:params, :textDocument, :uri))
         end
 
+        on("textDocument/documentHighlight") do |request|
+          respond_with_document_highlight(request.dig(:params, :textDocument, :uri), request.dig(:params, :position))
+        end
+
         on("textDocument/codeAction") do |request|
           range = request.dig(:params, :range)
           start_line = range.dig(:start, :line)

data/lib/ruby_lsp/document.rb

@@ -1,32 +1,54 @@
+# typed: strict
 # frozen_string_literal: true
 
-require "strscan"
-
 module RubyLsp
   class Document
-    attr_reader :tree, :source, :syntax_error_edits
+    extend T::Sig
+
+    PositionShape = T.type_alias { { line: Integer, character: Integer } }
+    RangeShape = T.type_alias { { start: PositionShape, end: PositionShape } }
+    EditShape = T.type_alias { { range: RangeShape, text: String } }
+
+    sig { returns(SyntaxTree::Node) }
+    attr_reader :tree
+
+    sig { returns(String) }
+    attr_reader :source
 
+    sig { returns(T::Array[EditShape]) }
+    attr_reader :syntax_error_edits
+
+    sig { params(source: String).void }
     def initialize(source)
-      @tree = SyntaxTree.parse(source)
-      @cache = {}
-      @syntax_error_edits = []
+      @tree = T.let(SyntaxTree.parse(source), SyntaxTree::Node)
+      @cache = T.let({}, T::Hash[Symbol, T.untyped])
+      @syntax_error_edits = T.let([], T::Array[EditShape])
       @source = source
-      @parsable_source = source.dup
+      @parsable_source = T.let(source.dup, String)
     end
 
+    sig { params(other: Document).returns(T::Boolean) }
     def ==(other)
       @source == other.source
     end
 
-    def cache_fetch(request_name)
+    sig do
+      type_parameters(:T)
+        .params(
+          request_name: Symbol,
+          block: T.proc.params(document: Document).returns(T.type_parameter(:T))
+        ).returns(T.type_parameter(:T))
+    end
+    def cache_fetch(request_name, &block)
       cached = @cache[request_name]
       return cached if cached
 
-      result = yield(self)
+      result = block.call(self)
       @cache[request_name] = result
       result
     end
 
+    sig { params(edits: T::Array[EditShape]).void }
     def push_edits(edits)
       # Apply the edits on the real source
       edits.each { |edit| apply_edit(@source, edit[:range], edit[:text]) }
@@ -40,12 +62,14 @@ module RubyLsp
       update_parsable_source(edits)
     end
 
+    sig { returns(T::Boolean) }
     def syntax_errors?
       @syntax_error_edits.any?
     end
 
     private
 
+    sig { params(edits: T::Array[EditShape]).void }
     def update_parsable_source(edits)
       # If the new edits caused a syntax error, make all edits blank spaces and line breaks to adjust the line and
       # column numbers. This is attempt to make the document parsable while partial edits are being applied
@@ -61,6 +85,7 @@ module RubyLsp
       # If we can't parse the source even after emptying the edits, then just fallback to the previous source
     end
 
+    sig { params(source: String, range: RangeShape, text: String).void }
     def apply_edit(source, range, text)
       scanner = Scanner.new(source)
       start_position = scanner.find_position(range[:start])
@@ -70,20 +95,24 @@ module RubyLsp
     end
 
     class Scanner
+      extend T::Sig
+
+      sig { params(source: String).void }
       def initialize(source)
+        @current_line = T.let(0, Integer)
+        @pos = T.let(0, Integer)
         @source = source
-        @scanner = StringScanner.new(source)
-        @current_line = 0
       end
 
+      sig { params(position: PositionShape).returns(Integer) }
       def find_position(position)
-        # Move the string scanner counting line breaks until we reach the right line
         until @current_line == position[:line]
-          @scanner.scan_until(/\R/)
+          @pos += 1 until /\R/.match?(@source[@pos])
+          @pos += 1
           @current_line += 1
         end
 
-        @scanner.pos + position[:character]
+        @pos + position[:character]
       end
     end
   end