ruby-lsp 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacbd0ac625037e2671811471792d7f4557bfd71e8ee1259c306ecd81b71974b
-  data.tar.gz: 58442bd37eaf5954d486556bc0a2a94a093471627791e55c66701fcad3a7ebd4
+  metadata.gz: ab0e94532c080cf6e443c95d9ca7ccb16f548ec45768dc58e95fd691c907a965
+  data.tar.gz: 856df7b413ef111e100ee42da541856843d966184f9dbe1dfe2ee5a50da1e802
 SHA512:
-  metadata.gz: bb55d15c4be207b39516891c9e0fc3f82e1412e57e9712932e3c73b354a7b95cf35f3df15990a097d146b849ab3309490236f8ad72b2a678fb142a99a3246372
-  data.tar.gz: 86269ca803e98331eec3e432f75049ffdf9250439b675a1e3bf335e4ce429f7fdb20ca67a6b0daff2afda8f6a69dbfded2178c9e2e5ed687b000d0ca82b7e08c
+  metadata.gz: fde4cd9c5e556ff926b22d316d1bfcc5d31c089850d4558ac7d954fe33df4c8d2b8f8c14e55d1dcc2898087d0d29e8b12fc2f768e2b14935fa727f9620ff5c9e
+  data.tar.gz: 24fb12213f36edcee13fe65d53a94977737b251566d2503dc857dc276192d6f570f93147f57fc5e3b23c8d90b2c1f96f4cc7e308d5b969a02705d39444676f95

data/.github/dependabot.yml

@@ -1,20 +1,11 @@
 version: 2
-registries:
-  rubygems-server-pkgs-shopify-io:
-    type: rubygems-server
-    url: https://pkgs.shopify.io
-    username: ${{secrets.RUBYGEMS_SERVER_PKGS_SHOPIFY_IO_USERNAME}}
-    password: ${{secrets.RUBYGEMS_SERVER_PKGS_SHOPIFY_IO_PASSWORD}}
-  github-com:
-    type: git
-    url: https://github.com
-    username: ${{secrets.DEPENDENCIES_GITHUB_USER}}
-    password: ${{secrets.DEPENDENCIES_GITHUB_TOKEN}}
 updates:
-  - package-ecosystem: bundler
+  - package-ecosystem: "bundler"
     directory: "/"
     schedule:
-      interval: daily
-    open-pull-requests-limit: 100
-    insecure-external-code-execution: allow
-    registries: '*'
+      interval: "weekly"
+    reviewers:
+      - "Shopify/sorbet"
+    labels:
+      - "dependencies"
+      - "ruby"

data/.github/pull_request_template.md

@@ -0,0 +1,15 @@
+### Motivation
+
+<!-- Explain why you are making this change. Include links to issues or describe the problem being solved, not the solution. -->
+
+### Implementation
+
+<!-- How did you implement your changes? Explain your solution, design decisions, things reviewers should watch out for. -->
+
+### Automated Tests
+
+<!-- We hope you added unit tests as part of your changes, just state that you have. If you haven't, state why. -->
+
+### Manual Tests
+
+<!-- Explain how we can test these changes in our own instance of VS Code. Provide the step by step instructions. -->

data/.github/workflows/ci.yml

@@ -0,0 +1,31 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ "2.7", "3.0", "3.1" ]
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        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/.gitignore

@@ -1,12 +1,9 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/.dev/
-/**/node_modules/
-/**/out/
-/**/*.vsix
+/**/.bundle/
+/**/.yardoc
+/**/_yardoc/
+/**/coverage/
+/**/doc/
+/**/pkg/
+/**/spec/reports/
+/**/tmp/
+/**/.dev/

data/.rubocop.yml

@@ -1,12 +1,30 @@
 inherit_gem:
   rubocop-shopify: rubocop.yml
 
+require:
+ - rubocop-sorbet
+ - rubocop-minitest
+ - rubocop-rake
+
 AllCops:
-  TargetRubyVersion: 3.1
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
   Exclude:
   - "vendor/**/*"
   - "features/**/*"
+  - "test/fixtures/**/*"
 
 Naming/FileName:
   Exclude:
-  - "lib/ruby-lsp.rb"
+  - "lib/ruby-lsp.rb"
+
+Sorbet/FalseSigil:
+  Enabled: false
+
+Sorbet/TrueSigil:
+  Enabled: true
+  Include:
+    - "**/*.rb"
+  Exclude:
+    - "**/*.rake"

data/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  // Set this value to `verbose` to see the full JSON content of LSP requests and responses
+  "ruby lsp.trace.server": "messages",
+  "editor.defaultFormatter": "Shopify.ruby-lsp",
+}

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Change Log
+
+All notable changes to the "ruby-lsp" extension will be documented in this file.
+
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+
+## [Unreleased]
+
+## [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]
+
+- Alpha release including
+    - RuboCop formatting, diagnostics and quick fixes
+    - Folding ranges
+    - Initial semantic highlighting
+    - Document symbols

data/Gemfile

@@ -4,10 +4,14 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "debug", "~> 1.5", require: false
 gem "minitest", "~> 5.15"
 gem "minitest-reporters", "~> 1.5"
 gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.25"
-gem "rubocop-shopify", "~> 2.4"
-gem "rubocop-minitest", "~> 0.17.2"
-gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-shopify", "~> 2.7", require: false
+gem "rubocop-minitest", "~> 0.20.0", 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,8 +1,11 @@
 PATH
   remote: .
   specs:
-    ruby-lsp (0.0.1)
+    ruby-lsp (0.0.4)
       language_server-protocol
+      rubocop (>= 1.0)
+      sorbet-runtime
+      syntax_tree (>= 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -10,53 +13,112 @@ 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
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    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.2.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.25.1)
+    rubocop (1.30.0)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 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.16.0)
+    rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.17.2)
+    rubocop-minitest (0.20.0)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-shopify (2.4.0)
-      rubocop (~> 1.24)
+    rubocop-shopify (2.7.0)
+      rubocop (~> 1.30)
+    rubocop-sorbet (0.6.8)
+      rubocop (>= 0.90.0)
     ruby-progressbar (1.11.0)
+    sorbet (0.5.10073)
+      sorbet-static (= 0.5.10073)
+    sorbet-runtime (0.5.10073)
+    sorbet-static (0.5.10073-universal-darwin-21)
+    sorbet-static (0.5.10073-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10073)
+      sorbet (= 0.5.10073)
+      sorbet-runtime (= 0.5.10073)
+    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
   x86_64-linux
 
 DEPENDENCIES
+  debug (~> 1.5)
   minitest (~> 5.15)
   minitest-reporters (~> 1.5)
   rake (~> 13.0)
-  rubocop (~> 1.25)
-  rubocop-minitest (~> 0.17.2)
+  rubocop-minitest (~> 0.20.0)
   rubocop-rake (~> 0.6.0)
-  rubocop-shopify (~> 2.4)
+  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,6 +1,23 @@
-# ruby-lsp
+![Build Status](https://github.com/Shopify/ruby-lsp/workflows/CI/badge.svg)
 
-Future home of monorepo for `ruby-lsp` Gem and VSCode extension
+# 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
 
@@ -10,6 +27,56 @@ 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
+
+LSP server tracing can be controlled through the `ruby lsp.trace.server` config key in the `.vscode/settings.json` config file.
+
+Possible values are:
+
+* `off`: no tracing
+* `messages`: display requests and responses notifications
+* `verbose`: display each request and response as JSON
+
 ## License
 
 The gem is available as open source under the terms of the

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.1
+0.0.4

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/bin/test

@@ -1,3 +1,9 @@
 #!/usr/bin/env bash
 
-bundle exec rake "$@"
+if [[ 2 -eq $# ]]; then
+  bundle exec rake TEST="$1" TESTOPTS="-n='/$2/'"
+elif [[ 1 -eq $# ]]; then
+  bundle exec rake TEST="$1"
+else
+  bundle exec rake "$@"
+fi

data/dev.yml

@@ -4,15 +4,15 @@ type: ruby
 
 up:
   - ruby: 3.1.1
-  - bundler
-  - node:
-      yarn: 1.22.17
-      version: v16.14.0
-      packages: ["./features/vscode_extension"]
+  - bundler:
+      gemfile: Gemfile
 
 commands:
-  style: bin/style
-  extension: bin/package_extension
+  server: exe/ruby-lsp
+  style: bin/rubocop
+  typecheck:
+    aliases: ["tc"]
+    run: "bundle exec srb tc"
   test:
     syntax:
       argument: file

data/exe/ruby-lsp

@@ -1,6 +1,23 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../lib/ruby/lsp"
+require "sorbet-runtime"
 
-Ruby::Lsp::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/internal"
+
+RubyLsp::Cli.start

data/lib/internal.rb

@@ -0,0 +1,7 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+require "syntax_tree"
+require "ruby-lsp"
+require "ruby_lsp/cli"

data/lib/ruby-lsp.rb

@@ -1,3 +1,6 @@
+# typed: true
 # frozen_string_literal: true
 
-require_relative "./ruby/lsp"
+module RubyLsp
+  VERSION = File.read(File.expand_path("../VERSION", __dir__)).strip
+end

data/lib/ruby_lsp/cli.rb

@@ -0,0 +1,88 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "language_server-protocol"
+
+require_relative "handler"
+
+module RubyLsp
+  module Cli
+    extend T::Sig
+
+    sig { void }
+    def self.start
+      handler = RubyLsp::Handler.new
+
+      handler.config do
+        on("initialize") do |request|
+          store.clear
+          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)
+          store.push_edits(uri, request.dig(:params, :contentChanges))
+
+          send_diagnostics(uri)
+          RubyLsp::Handler::VOID
+        end
+
+        on("textDocument/didOpen") do |request|
+          uri = request.dig(:params, :textDocument, :uri)
+          text = request.dig(:params, :textDocument, :text)
+          store.set(uri, text)
+
+          send_diagnostics(uri)
+          RubyLsp::Handler::VOID
+        end
+
+        on("textDocument/didClose") do |request|
+          uri = request.dig(:params, :textDocument, :uri)
+          store.delete(uri)
+
+          RubyLsp::Handler::VOID
+        end
+
+        on("textDocument/documentSymbol") do |request|
+          respond_with_document_symbol(request.dig(:params, :textDocument, :uri))
+        end
+
+        on("textDocument/foldingRange") do |request|
+          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
+
+        on("textDocument/formatting") do |request|
+          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)
+          end_line = range.dig(:end, :line)
+          respond_with_code_actions(request.dig(:params, :textDocument, :uri), (start_line..end_line))
+        end
+
+        on("shutdown") { shutdown }
+      end
+
+      handler.start
+    end
+  end
+end