ruby-lsp 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25bad06533efa8072f0d501520e7429220be622d06a9061eb02171e1d515a498
-  data.tar.gz: dc8cc9436d3b57b362661ba36b8f02b90495287386f94ac5b20916ce5e6025bf
+  metadata.gz: 2b072ffa3ea73a83aba6d6c32b931c4de30b0de06fd70655d620c3ed95bd8aa4
+  data.tar.gz: 24568688b20ffed38defcbc0b00708eb22a7dad20a9b5f397348242a64359bfd
 SHA512:
-  metadata.gz: b8ae688533a36c018cfbca467f7db2b54d121787cff48b7fd56723c03790df34c99a2ace3a0770ee6e3971b5ac1aa5e559b9264d1466ba93556f3d9ec051abaa
-  data.tar.gz: 1db946d571c62209b40fc4aef7048ea55f39c446bf87ff638d44aefcbdf2e8abdfad79c60ec5e9f0c3dc1fdda78f867582e4f58b56c861941197651bd286e6b3
+  metadata.gz: ea1830f0be08cb291e67d80bbe21dbe17f3e4b4d285b1d9112e004ca2feff32eaca85af755bc2635e3341ab4e64491710c3ba13c5bed617e34495534e1d7a5f8
+  data.tar.gz: f84b1b27c5c17455d1e8423f1e52f98a754ed123e1722bd536ee7bfdc754952e5d6619c0f4402664a33dc278bdc2422a3e7a37c8de5f172e4456e7a6c08b7a67

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on: [push, pull_request]
 
 jobs:
   build:
-    runs-on: self-hosted
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
@@ -17,7 +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/.github/workflows/publish_docs.yml

@@ -0,0 +1,32 @@
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Publish documentation website
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.1
+          bundler-cache: true
+
+      - name: Configure git
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+
+      - name: Generate documentation
+        run: bundle exec rake yard
+
+      - name: Commit to gh-pages
+        run: |
+          git add docs
+          git commit -m "Publish website $(git log --format=format:%h -1)"
+          git push --force origin main:gh-pages

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,29 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [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,10 +4,14 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "debug", "~> 1.5"
+gem "debug", "~> 1.5", require: false
 gem "minitest", "~> 5.15"
 gem "minitest-reporters", "~> 1.5"
 gem "rake", "~> 13.0"
-gem "rubocop-shopify", "~> 2.5"
-gem "rubocop-minitest", "~> 0.19.1"
-gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-shopify", "~> 2.7", 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,11 @@
 PATH
   remote: .
   specs:
-    ruby-lsp (0.0.2)
+    ruby-lsp (0.1.0)
       language_server-protocol
       rubocop (>= 1.0)
-      syntax_tree (>= 2.3)
+      sorbet-runtime
+      syntax_tree (>= 2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -12,13 +13,16 @@ 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)
     language_server-protocol (3.16.0.3)
+    method_source (1.0.0)
     minitest (5.15.0)
     minitest-reporters (1.5.0)
       ansi
@@ -28,32 +32,75 @@ GEM
     parallel (1.22.1)
     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.3.1)
+    rbi (0.0.14)
+      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.28.1)
+    rubocop (1.30.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.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.5.0)
-      rubocop (~> 1.25)
+    rubocop-shopify (2.7.0)
+      rubocop (~> 1.30)
+    rubocop-sorbet (0.6.8)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
-    syntax_tree (2.3.1)
+    sorbet (0.5.10092)
+      sorbet-static (= 0.5.10092)
+    sorbet-runtime (0.5.10092)
+    sorbet-static (0.5.10092-universal-darwin-21)
+    sorbet-static (0.5.10092-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10092)
+      sorbet (= 0.5.10092)
+      sorbet-runtime (= 0.5.10092)
+    spoom (1.1.11)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    syntax_tree (2.7.1)
+      prettier_print
+    tapioca (0.8.1)
+      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.1.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
   arm64-darwin-21
@@ -64,10 +111,14 @@ DEPENDENCIES
   minitest (~> 5.15)
   minitest-reporters (~> 1.5)
   rake (~> 13.0)
-  rubocop-minitest (~> 0.19.1)
+  rubocop-minitest (~> 0.20.1)
   rubocop-rake (~> 0.6.0)
-  rubocop-shopify (~> 2.5)
+  rubocop-shopify (~> 2.7)
+  rubocop-sorbet (~> 0.6)
   ruby-lsp!
+  sorbet-static-and-runtime
+  tapioca (~> 0.8)
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -1,4 +1,23 @@
-# ruby-lsp
+![Build Status](https://github.com/Shopify/ruby-lsp/workflows/CI/badge.svg)
+
+# Ruby LSP
+
+This gem is an implementation of the language server protocol specification for Ruby, used to improve editor features.
+
+## Usage
+
+Install the gem. There's no need to require it, since the server is used as a standalone executable.
+
+```ruby
+group :development do
+  gem "ruby-lsp", require: false
+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.
 
 ## Contributing
 
@@ -8,6 +27,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

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "yard"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,6 +10,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--markup", "markdown", "--output-dir", "docs"]
+end
+
 require "rubocop/rake_task"
 
 RuboCop::RakeTask.new

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

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,7 +1,23 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "syntax_tree"
-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,4 +1,6 @@
+# typed: strict
 # frozen_string_literal: true
 
 module RubyLsp
+  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,22 +7,26 @@ 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
         on("initialize") do |request|
           store.clear
-          respond_with_capabilities(request.dig(:params, :initializationOptions).fetch(:enabledFeatures, []))
+          initialization_options = request.dig(:params, :initializationOptions)
+
+          respond_with_capabilities(initialization_options.fetch(:enabledFeatures, []))
         end
 
         on("textDocument/didChange") do |request|
           uri = request.dig(:params, :textDocument, :uri)
-          text = request.dig(:params, :contentChanges, 0, :text)
-          store.set(uri, text)
+          store.push_edits(uri, request.dig(:params, :contentChanges))
 
           send_diagnostics(uri)
-          nil
+          RubyLsp::Handler::VOID
         end
 
         on("textDocument/didOpen") do |request|
@@ -30,14 +35,14 @@ 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)
 
-          nil
+          RubyLsp::Handler::VOID
         end
 
         on("textDocument/documentSymbol") do |request|
@@ -48,6 +53,13 @@ module RubyLsp
           respond_with_folding_ranges(request.dig(:params, :textDocument, :uri))
         end
 
+        on("textDocument/selectionRange") do |request|
+          respond_with_selection_ranges(
+            request.dig(:params, :textDocument, :uri),
+            request.dig(:params, :positions),
+          )
+        end
+
         on("textDocument/semanticTokens/full") do |request|
           respond_with_semantic_highlighting(request.dig(:params, :textDocument, :uri))
         end
@@ -56,6 +68,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,27 +1,119 @@
+# typed: strict
 # frozen_string_literal: true
 
 module RubyLsp
   class Document
-    attr_reader :tree, :parser, :source
+    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 = 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
-      @parser = SyntaxTree::Parser.new(source)
-      @tree = @parser.parse
-      @cache = {}
+      @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]) }
+
+      @cache.clear
+      @tree = SyntaxTree.parse(@source)
+      @syntax_error_edits.clear
+      @parsable_source = @source.dup
+      nil
+    rescue SyntaxTree::Parser::ParseError
+      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
+      edits.each do |edit|
+        @syntax_error_edits << edit
+        next if edit[:text].empty? # skip deletions, since they may have caused the syntax error
+
+        apply_edit(@parsable_source, edit[:range], edit[:text].gsub(/[^\r\n]/, " "))
+      end
+
+      @tree = SyntaxTree.parse(@parsable_source)
+    rescue SyntaxTree::Parser::ParseError
+      # 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])
+      end_position = scanner.find_position(range[:end])
+
+      source[start_position...end_position] = text
+    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
+      end
+
+      sig { params(position: PositionShape).returns(Integer) }
+      def find_position(position)
+        until @current_line == position[:line]
+          @pos += 1 until /\R/.match?(@source[@pos])
+          @pos += 1
+          @current_line += 1
+        end
+
+        @pos + position[:character]
+      end
+    end
   end
 end