ruby-lsp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cacbd0ac625037e2671811471792d7f4557bfd71e8ee1259c306ecd81b71974b
-  data.tar.gz: 58442bd37eaf5954d486556bc0a2a94a093471627791e55c66701fcad3a7ebd4
+  metadata.gz: 25bad06533efa8072f0d501520e7429220be622d06a9061eb02171e1d515a498
+  data.tar.gz: dc8cc9436d3b57b362661ba36b8f02b90495287386f94ac5b20916ce5e6025bf
 SHA512:
-  metadata.gz: bb55d15c4be207b39516891c9e0fc3f82e1412e57e9712932e3c73b354a7b95cf35f3df15990a097d146b849ab3309490236f8ad72b2a678fb142a99a3246372
-  data.tar.gz: 86269ca803e98331eec3e432f75049ffdf9250439b675a1e3bf335e4ce429f7fdb20ca67a6b0daff2afda8f6a69dbfded2178c9e2e5ed687b000d0ca82b7e08c
+  metadata.gz: b8ae688533a36c018cfbca467f7db2b54d121787cff48b7fd56723c03790df34c99a2ace3a0770ee6e3971b5ac1aa5e559b9264d1466ba93556f3d9ec051abaa
+  data.tar.gz: 1db946d571c62209b40fc4aef7048ea55f39c446bf87ff638d44aefcbdf2e8abdfad79c60ec5e9f0c3dc1fdda78f867582e4f58b56c861941197651bd286e6b3

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,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: self-hosted
+    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: Lint Ruby files
+        run: bin/rubocop
+      - name: Run tests
+        run: bin/test

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

@@ -2,11 +2,13 @@ inherit_gem:
   rubocop-shopify: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.1
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
   Exclude:
   - "vendor/**/*"
   - "features/**/*"
 
 Naming/FileName:
   Exclude:
-  - "lib/ruby-lsp.rb"
+  - "lib/ruby-lsp.rb"

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,16 @@
+# 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.2]
+
+- Alpha release including
+    - RuboCop formatting, diagnostics and quick fixes
+    - Folding ranges
+    - Initial semantic highlighting
+    - Document symbols

data/Gemfile

@@ -4,10 +4,10 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "debug", "~> 1.5"
 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-shopify", "~> 2.5"
+gem "rubocop-minitest", "~> 0.19.1"
 gem "rubocop-rake", "~> 0.6.0"

data/Gemfile.lock

@@ -1,8 +1,10 @@
 PATH
   remote: .
   specs:
-    ruby-lsp (0.0.1)
+    ruby-lsp (0.0.2)
       language_server-protocol
+      rubocop (>= 1.0)
+      syntax_tree (>= 2.3)
 
 GEM
   remote: https://rubygems.org/
@@ -10,6 +12,12 @@ GEM
     ansi (1.5.0)
     ast (2.4.2)
     builder (3.2.4)
+    debug (1.5.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
     language_server-protocol (3.16.0.3)
     minitest (5.15.0)
     minitest-reporters (1.5.0)
@@ -17,31 +25,34 @@ GEM
       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)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.3.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
     rexml (3.2.5)
-    rubocop (1.25.1)
+    rubocop (1.28.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.15.1, < 2.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.17.2)
+    rubocop-minitest (0.19.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-shopify (2.4.0)
-      rubocop (~> 1.24)
+    rubocop-shopify (2.5.0)
+      rubocop (~> 1.25)
     ruby-progressbar (1.11.0)
+    syntax_tree (2.3.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -49,13 +60,13 @@ PLATFORMS
   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.19.1)
   rubocop-rake (~> 0.6.0)
-  rubocop-shopify (~> 2.4)
+  rubocop-shopify (~> 2.5)
   ruby-lsp!
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,5 @@
 # ruby-lsp
 
-Future home of monorepo for `ruby-lsp` Gem and VSCode extension
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/ruby-lsp.
@@ -10,6 +8,18 @@ are expected to adhere to the
 [Contributor Covenant](https://github.com/Shopify/ruby-lsp/blob/main/CODE_OF_CONDUCT.md)
 code of conduct.
 
+## 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/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

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,12 @@ 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
   test:
     syntax:
       argument: file

data/exe/ruby-lsp

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../lib/ruby/lsp"
+require "syntax_tree"
+require "ruby_lsp/cli"
 
-Ruby::Lsp::Cli.start(ARGV)
+RubyLsp::Cli.start(ARGV)

data/lib/ruby-lsp.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "./ruby/lsp"
+module RubyLsp
+end

data/lib/ruby_lsp/cli.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "language_server-protocol"
+
+require_relative "handler"
+
+module RubyLsp
+  module Cli
+    def self.start(_argv)
+      handler = RubyLsp::Handler.new
+
+      handler.config do
+        on("initialize") do |request|
+          store.clear
+          respond_with_capabilities(request.dig(:params, :initializationOptions).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)
+
+          send_diagnostics(uri)
+          nil
+        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)
+          nil
+        end
+
+        on("textDocument/didClose") do |request|
+          uri = request.dig(:params, :textDocument, :uri)
+          store.delete(uri)
+
+          nil
+        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/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/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

data/lib/ruby_lsp/document.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  class Document
+    attr_reader :tree, :parser, :source
+
+    def initialize(source)
+      @source = source
+      @parser = SyntaxTree::Parser.new(source)
+      @tree = @parser.parse
+      @cache = {}
+    end
+
+    def ==(other)
+      @source == other.source
+    end
+
+    def cache_fetch(request_name)
+      cached = @cache[request_name]
+      return cached if cached
+
+      result = yield(self)
+      @cache[request_name] = result
+      result
+    end
+  end
+end

data/lib/ruby_lsp/handler.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "ruby_lsp/requests"
+require "ruby_lsp/store"
+
+module RubyLsp
+  class Handler
+    attr_reader :store
+
+    Interface = LanguageServer::Protocol::Interface
+    Constant = LanguageServer::Protocol::Constant
+    Transport = LanguageServer::Protocol::Transport
+
+    def initialize
+      @writer = Transport::Stdio::Writer.new
+      @reader = Transport::Stdio::Reader.new
+      @handlers = {}
+      @store = Store.new
+    end
+
+    def start
+      $stderr.puts "Starting Ruby LSP..."
+      @reader.read do |request|
+        handle(request)
+      end
+    end
+
+    def config(&blk)
+      instance_exec(&blk)
+    end
+
+    private
+
+    def on(msg, &blk)
+      @handlers[msg.to_s] = blk
+    end
+
+    def handle(request)
+      result = @handlers[request[:method]]&.call(request)
+      @writer.write(id: request[:id], result: result) if result
+    end
+
+    def shutdown
+      $stderr.puts "Shutting down Ruby LSP..."
+      store.clear
+    end
+
+    def respond_with_capabilities(enabled_features)
+      document_symbol_provider = if enabled_features.include?("documentSymbols")
+        Interface::DocumentSymbolClientCapabilities.new(
+          hierarchical_document_symbol_support: true,
+          symbol_kind: {
+            value_set: Requests::DocumentSymbol::SYMBOL_KIND.values,
+          }
+        )
+      end
+
+      folding_ranges_provider = if enabled_features.include?("foldingRanges")
+        Interface::FoldingRangeClientCapabilities.new(line_folding_only: true)
+      end
+
+      semantic_tokens_provider = if enabled_features.include?("semanticHighlighting")
+        Interface::SemanticTokensRegistrationOptions.new(
+          document_selector: { scheme: "file", language: "ruby" },
+          legend: Interface::SemanticTokensLegend.new(
+            token_types: Requests::SemanticHighlighting::TOKEN_TYPES,
+            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS
+          ),
+          range: false,
+          full: {
+            delta: true,
+          }
+        )
+      end
+
+      Interface::InitializeResult.new(
+        capabilities: Interface::ServerCapabilities.new(
+          text_document_sync: Interface::TextDocumentSyncOptions.new(
+            change: Constant::TextDocumentSyncKind::FULL,
+            open_close: true,
+          ),
+          document_symbol_provider: document_symbol_provider,
+          folding_range_provider: folding_ranges_provider,
+          semantic_tokens_provider: semantic_tokens_provider,
+          document_formatting_provider: enabled_features.include?("formatting"),
+          code_action_provider: enabled_features.include?("codeActions")
+        )
+      )
+    end
+
+    def respond_with_document_symbol(uri)
+      store.cache_fetch(uri, :document_symbol) do |document|
+        RubyLsp::Requests::DocumentSymbol.run(document)
+      end
+    end
+
+    def respond_with_folding_ranges(uri)
+      store.cache_fetch(uri, :folding_ranges) do |document|
+        Requests::FoldingRanges.run(document)
+      end
+    end
+
+    def respond_with_semantic_highlighting(uri)
+      store.cache_fetch(uri, :semantic_highlighting) do |document|
+        Requests::SemanticHighlighting.run(document)
+      end
+    end
+
+    def respond_with_formatting(uri)
+      Requests::Formatting.run(uri, store.get(uri))
+    end
+
+    def send_diagnostics(uri)
+      response = store.cache_fetch(uri, :diagnostics) do |document|
+        Requests::Diagnostics.run(uri, document)
+      end
+
+      @writer.write(
+        method: "textDocument/publishDiagnostics",
+        params: Interface::PublishDiagnosticsParams.new(
+          uri: uri,
+          diagnostics: response.map(&:to_lsp_diagnostic)
+        )
+      )
+    end
+
+    def respond_with_code_actions(uri, range)
+      store.cache_fetch(uri, :code_actions) do |document|
+        Requests::CodeActions.run(uri, document, range)
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/base_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    class BaseRequest < SyntaxTree::Visitor
+      def self.run(document)
+        new(document).run
+      end
+
+      def initialize(document)
+        @document = document
+
+        super()
+      end
+
+      def run
+        raise NotImplementedError, "#{self.class}#run must be implemented"
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/code_actions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    class CodeActions
+      def self.run(uri, document, range)
+        new(uri, document, range).run
+      end
+
+      def initialize(uri, document, range)
+        @document = document
+        @uri = uri
+        @range = range
+      end
+
+      def run
+        diagnostics = Diagnostics.run(@uri, @document)
+        corrections = diagnostics.select { |diagnostic| diagnostic.correctable? && diagnostic.in_range?(@range) }
+        return if corrections.empty?
+
+        corrections.map!(&:to_lsp_code_action)
+      end
+    end
+  end
+end