ruby-lsp 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d067270389ee6b02bb03fb6363e272b6808e7c3d27d77354442801d09a617149
-  data.tar.gz: 74e7cd206a790a8c139969f5167ab3d38686f78646c619488153fd8ab139892e
+  metadata.gz: 0fefb041d92fb2000d3da23248ed622abd596a95264b421349f27d104b85f997
+  data.tar.gz: 312918f128e0a49a2f5b2066354df2fe45f9ed37af5e5eace6c76caa101155e5
 SHA512:
-  metadata.gz: 8d65637f892541a79fde71e3f523dfc37c887ec4892315ffe58b450718c8fa6e2a342036c394c28f5a94da0a1348948a104609881109c5621488b9d23a581bc1
-  data.tar.gz: 1d25dbac214c23c2af2bd991d4c57bdae9dce488ac886cc700d7ab10a7e3b4a0e72ddc2c1d4be459b332e9cdfac69588d42eac11ff78023d365e0d5ef6701f78
+  metadata.gz: 7ab96bd356fe94e3a95572bec24053eed9b467c71acec431a80c600e87ea5a3c31f0f2aee20c7b3b407b5aabc9b5736e0bb385dedf2840747c892fe7ad090b69
+  data.tar.gz: 2ec3f3c88c851e86e7ef6485c7719a271dbda81717990446900fe121844daac905b5f554833b59769a4c6f626bb50579d5e51970e7a306d206c898d0a289d36c

data/CHANGELOG.md

@@ -6,6 +6,16 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Unreleased]
 
+## [0.2.2]
+
+- Support document links (https://github.com/Shopify/ruby-lsp/pull/195)
+- Avoid returning on request blocks (https://github.com/Shopify/ruby-lsp/pull/232)
+- Better specify gemspec files (https://github.com/Shopify/ruby-lsp/pull/233)
+- Include Kernel instance methods as special methods for semantic highlighting (https://github.com/Shopify/ruby-lsp/pull/231)
+- Fix call processing when message is a :call symbol literal (https://github.com/Shopify/ruby-lsp/pull/236)
+- Alert users about non auto-correctable diagnostics (https://github.com/Shopify/ruby-lsp/pull/230)
+- Let clients pull diagnostics instead of pushing on edits (https://github.com/Shopify/ruby-lsp/pull/242)
+
 ## [0.2.1]
 
 - Implement the exit lifecycle request (https://github.com/Shopify/ruby-lsp/pull/198)

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/lib/ruby_lsp/handler.rb

@@ -86,25 +86,6 @@ module RubyLsp
       store.clear
     end
 
-    sig { params(uri: String).void }
-    def send_diagnostics(uri)
-      response = store.cache_fetch(uri, :diagnostics) do |document|
-        Requests::Diagnostics.new(uri, document).run
-      end
-
-      return if response.nil?
-
-      @writer.write(
-        method: "textDocument/publishDiagnostics",
-        params: Interface::PublishDiagnosticsParams.new(
-          uri: uri,
-          diagnostics: response.map(&:to_lsp_diagnostic)
-        )
-      )
-    rescue RuboCop::ValidationError => e
-      show_message(Constant::MessageType::ERROR, "Error in RuboCop configuration file: #{e.message}")
-    end
-
     sig { params(uri: String).void }
     def clear_diagnostics(uri)
       @writer.write(

data/lib/ruby_lsp/requests/document_link.rb

@@ -0,0 +1,59 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Document link demo](../../misc/document_link.gif)
+    #
+    # The [document link](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentLink)
+    # makes `# source://PATH_TO_FILE:line` comments in a Ruby/RBI file clickable if the file exists.
+    # When the user clicks the link, it'll open that location.
+    #
+    # # Example
+    #
+    # ```ruby
+    # # source://syntax_tree-3.2.1/lib/syntax_tree.rb:51 <- it will be clickable and will take the user to that location
+    # def format(source, maxwidth = T.unsafe(nil))
+    # end
+    # ```
+    class DocumentLink < BaseRequest
+      extend T::Sig
+
+      RUBY_ROOT = "RUBY_ROOT"
+
+      sig { params(document: Document).void }
+      def initialize(document)
+        super
+
+        @links = T.let([], T::Array[LanguageServer::Protocol::Interface::DocumentLink])
+      end
+
+      sig { override.returns(T.all(T::Array[LanguageServer::Protocol::Interface::DocumentLink], Object)) }
+      def run
+        visit(@document.tree)
+        @links
+      end
+
+      sig { params(node: SyntaxTree::Comment).void }
+      def visit_comment(node)
+        match = node.value.match(%r{source://(?<path>.*):(?<line>\d+)$})
+        return unless match
+
+        file_path = if match[:path].start_with?(RUBY_ROOT)
+          match[:path].sub(RUBY_ROOT, RbConfig::CONFIG["rubylibdir"])
+        else
+          File.join(Bundler.bundle_path, "gems", match[:path])
+        end
+        return unless File.exist?(file_path)
+
+        target = "file://#{file_path}##{match[:line]}"
+
+        @links << LanguageServer::Protocol::Interface::DocumentLink.new(
+          range: range_from_syntax_tree_node(node),
+          target: target,
+          tooltip: "Jump to #{target.delete_prefix("file://")}"
+        )
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -60,10 +60,13 @@ module RubyLsp
         default_library: 9,
       }.freeze, T::Hash[Symbol, Integer])
 
-      SPECIAL_RUBY_METHODS = T.let((Module.instance_methods(false) +
-        Kernel.methods(false) + Bundler::Dsl.instance_methods(false) +
-        Module.private_instance_methods(false))
-        .map(&:to_s), T::Array[String])
+      SPECIAL_RUBY_METHODS = T.let([
+        Module.instance_methods(false),
+        Kernel.instance_methods(false),
+        Kernel.methods(false),
+        Bundler::Dsl.instance_methods(false),
+        Module.private_instance_methods(false),
+      ].flatten.map(&:to_s), T::Array[String])
 
       class SemanticToken < T::Struct
         const :location, SyntaxTree::Location
@@ -105,7 +108,10 @@ module RubyLsp
       sig { params(node: SyntaxTree::Call).void }
       def visit_call(node)
         visit(node.receiver)
-        add_token(node.message.location, :method)
+
+        message = node.message
+        add_token(message.location, :method) if message != :call
+
         visit(node.arguments)
       end
 

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

@@ -76,7 +76,8 @@ module RubyLsp
           when SyntaxTree::VarField, SyntaxTree::VarRef, SyntaxTree::VCall, SyntaxTree::FCall
             node.value&.value
           when SyntaxTree::Call, SyntaxTree::Command, SyntaxTree::CommandCall
-            node.message.value
+            message = node.message
+            message != :call ? message.value : nil
           when SyntaxTree::ClassDeclaration, SyntaxTree::ModuleDeclaration
             node.constant.constant.value
           end

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

@@ -61,11 +61,18 @@ module RubyLsp
 
         sig { returns(LanguageServer::Protocol::Interface::Diagnostic) }
         def to_lsp_diagnostic
+          if @offense.correctable?
+            severity = RUBOCOP_TO_LSP_SEVERITY[@offense.severity.name]
+            message = @offense.message
+          else
+            severity = LanguageServer::Protocol::Constant::DiagnosticSeverity::WARNING
+            message = "#{@offense.message}\n\nThis offense is not auto-correctable.\n"
+          end
           LanguageServer::Protocol::Interface::Diagnostic.new(
-            message: @offense.message,
+            message: message,
             source: "RuboCop",
             code: @offense.cop_name,
-            severity: RUBOCOP_TO_LSP_SEVERITY[@offense.severity.name],
+            severity: severity,
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(
                 line: @offense.line - 1,

data/lib/ruby_lsp/requests.rb

@@ -5,6 +5,7 @@ module RubyLsp
   # Supported features
   #
   # - {RubyLsp::Requests::DocumentSymbol}
+  # - {RubyLsp::Requests::DocumentLink}
   # - {RubyLsp::Requests::FoldingRanges}
   # - {RubyLsp::Requests::SelectionRanges}
   # - {RubyLsp::Requests::SemanticHighlighting}
@@ -15,6 +16,7 @@ module RubyLsp
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
     autoload :DocumentSymbol, "ruby_lsp/requests/document_symbol"
+    autoload :DocumentLink, "ruby_lsp/requests/document_link"
     autoload :FoldingRanges, "ruby_lsp/requests/folding_ranges"
     autoload :SelectionRanges, "ruby_lsp/requests/selection_ranges"
     autoload :SemanticHighlighting, "ruby_lsp/requests/semantic_highlighting"

data/lib/ruby_lsp/server.rb

@@ -19,6 +19,10 @@ module RubyLsp
         )
       end
 
+      document_link_provider = if enabled_features.include?("documentLink")
+        Interface::DocumentLinkOptions.new(resolve_provider: false)
+      end
+
       folding_ranges_provider = if enabled_features.include?("foldingRanges")
         Interface::FoldingRangeClientCapabilities.new(line_folding_only: true)
       end
@@ -37,20 +41,30 @@ module RubyLsp
         )
       end
 
+      diagnostics_provider = if enabled_features.include?("diagnostics")
+        {
+          interFileDependencies: false,
+          workspaceDiagnostics: false,
+        }
+      end
+
+      # TODO: switch back to using Interface::ServerCapabilities once the gem is updated for spec 3.17
       Interface::InitializeResult.new(
-        capabilities: Interface::ServerCapabilities.new(
-          text_document_sync: Interface::TextDocumentSyncOptions.new(
+        capabilities: {
+          textDocumentSync: Interface::TextDocumentSyncOptions.new(
             change: Constant::TextDocumentSyncKind::INCREMENTAL,
             open_close: true,
           ),
-          selection_range_provider: enabled_features.include?("selectionRanges"),
-          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"),
-          document_highlight_provider: enabled_features.include?("documentHighlights"),
-          code_action_provider: enabled_features.include?("codeActions")
-        )
+          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"),
+          diagnosticProvider: diagnostics_provider,
+        }.reject { |_, v| !v }
       )
     end
 
@@ -58,7 +72,6 @@ module RubyLsp
       uri = request.dig(:params, :textDocument, :uri)
       store.push_edits(uri, request.dig(:params, :contentChanges))
 
-      send_diagnostics(uri)
       Handler::VOID
     end
 
@@ -67,7 +80,6 @@ module RubyLsp
       text = request.dig(:params, :textDocument, :text)
       store.set(uri, text)
 
-      send_diagnostics(uri)
       Handler::VOID
     end
 
@@ -85,6 +97,12 @@ module RubyLsp
       end
     end
 
+    on("textDocument/documentLink") do |request|
+      store.cache_fetch(request.dig(:params, :textDocument, :uri), :document_link) do |document|
+        RubyLsp::Requests::DocumentLink.new(document).run
+      end
+    end
+
     on("textDocument/foldingRange") do |request|
       store.cache_fetch(request.dig(:params, :textDocument, :uri), :folding_ranges) do |document|
         Requests::FoldingRanges.new(document).run
@@ -99,15 +117,16 @@ module RubyLsp
         Requests::SelectionRanges.new(document).run
       end
 
-      return if ranges.nil?
-
       # Per the selection range request spec (https://microsoft.github.io/language-server-protocol/specification#textDocument_selectionRange),
       # every position in the positions array should have an element at the same index in the response
       # array. For positions without a valid selection range, the corresponding element in the response
       # array will be nil.
-      positions.map do |position|
-        ranges.find do |range|
-          range.cover?(position)
+
+      unless ranges.nil?
+        positions.map do |position|
+          ranges.find do |range|
+            range.cover?(position)
+          end
         end
       end
     end
@@ -132,9 +151,10 @@ module RubyLsp
 
     on("textDocument/documentHighlight") do |request|
       document = store.get(request.dig(:params, :textDocument, :uri))
-      return unless document.parsed?
 
-      Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
+      if document.parsed?
+        Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
+      end
     end
 
     on("textDocument/codeAction") do |request|
@@ -148,6 +168,18 @@ module RubyLsp
       end
     end
 
+    on("textDocument/diagnostic") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      response = store.cache_fetch(uri, :diagnostics) do |document|
+        Requests::Diagnostics.new(uri, document).run
+      end
+
+      { kind: "full", items: response.map(&:to_lsp_diagnostic) } if response
+    rescue RuboCop::ValidationError => e
+      show_message(Constant::MessageType::ERROR, "Error in RuboCop configuration file: #{e.message}")
+      nil
+    end
+
     on("shutdown") { shutdown }
 
     on("exit") do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -60,29 +60,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/probots.yml"
-- ".github/pull_request_template.md"
-- ".github/workflows/ci.yml"
-- ".github/workflows/publish_docs.yml"
-- ".gitignore"
-- ".rubocop.yml"
-- ".vscode/extensions.json"
-- ".vscode/settings.json"
-- ".vscode/tasks.json"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
 - VERSION
-- bin/console
-- bin/rubocop
-- bin/tapioca
-- bin/test
-- dev.yml
 - exe/ruby-lsp
 - lib/ruby-lsp.rb
 - lib/ruby_lsp/document.rb
@@ -93,6 +74,7 @@ files:
 - lib/ruby_lsp/requests/code_actions.rb
 - lib/ruby_lsp/requests/diagnostics.rb
 - lib/ruby_lsp/requests/document_highlight.rb
+- lib/ruby_lsp/requests/document_link.rb
 - lib/ruby_lsp/requests/document_symbol.rb
 - lib/ruby_lsp/requests/folding_ranges.rb
 - lib/ruby_lsp/requests/formatting.rb
@@ -107,54 +89,6 @@ files:
 - lib/ruby_lsp/requests/support/syntax_error_diagnostic.rb
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/store.rb
-- rakelib/check_docs.rake
-- ruby-lsp.gemspec
-- service.yml
-- sorbet/config
-- sorbet/rbi/.rubocop.yml
-- sorbet/rbi/gems/ansi@1.5.0.rbi
-- sorbet/rbi/gems/ast@2.4.2.rbi
-- sorbet/rbi/gems/builder@3.2.4.rbi
-- sorbet/rbi/gems/coderay@1.1.3.rbi
-- sorbet/rbi/gems/debug@1.5.0.rbi
-- sorbet/rbi/gems/diff-lcs@1.5.0.rbi
-- sorbet/rbi/gems/io-console@0.5.11.rbi
-- sorbet/rbi/gems/irb@1.4.1.rbi
-- sorbet/rbi/gems/language_server-protocol@3.16.0.3.rbi
-- sorbet/rbi/gems/method_source@1.0.0.rbi
-- sorbet/rbi/gems/minitest-reporters@1.5.0.rbi
-- sorbet/rbi/gems/minitest@5.15.0.rbi
-- sorbet/rbi/gems/parallel@1.22.1.rbi
-- sorbet/rbi/gems/parser@3.1.2.0.rbi
-- sorbet/rbi/gems/prettier_print@0.1.0.rbi
-- sorbet/rbi/gems/pry@0.14.1.rbi
-- sorbet/rbi/gems/rainbow@3.1.1.rbi
-- sorbet/rbi/gems/rake@13.0.6.rbi
-- sorbet/rbi/gems/rbi@0.0.14.rbi
-- sorbet/rbi/gems/regexp_parser@2.5.0.rbi
-- sorbet/rbi/gems/reline@0.3.1.rbi
-- sorbet/rbi/gems/rexml@3.2.5.rbi
-- sorbet/rbi/gems/rubocop-ast@1.18.0.rbi
-- sorbet/rbi/gems/rubocop-minitest@0.20.0.rbi
-- sorbet/rbi/gems/rubocop-rake@0.6.0.rbi
-- sorbet/rbi/gems/rubocop-shopify@2.6.0.rbi
-- sorbet/rbi/gems/rubocop-sorbet@0.6.8.rbi
-- sorbet/rbi/gems/rubocop@1.30.0.rbi
-- sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi
-- sorbet/rbi/gems/spoom@1.1.11.rbi
-- sorbet/rbi/gems/syntax_tree@2.7.1.rbi
-- sorbet/rbi/gems/tapioca@0.8.1.rbi
-- sorbet/rbi/gems/thor@1.2.1.rbi
-- sorbet/rbi/gems/unicode-display_width@2.1.0.rbi
-- sorbet/rbi/gems/unparser@0.6.5.rbi
-- sorbet/rbi/gems/webrick@1.7.0.rbi
-- sorbet/rbi/gems/yard-sorbet@0.6.1.rbi
-- sorbet/rbi/gems/yard@0.9.27.rbi
-- sorbet/rbi/shims/fiddle.rbi
-- sorbet/rbi/shims/hash.rbi
-- sorbet/rbi/shims/rdoc.rbi
-- sorbet/tapioca/config.yml
-- sorbet/tapioca/require.rb
 homepage: https://github.com/Shopify/ruby-lsp
 licenses:
 - MIT

data/.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "bundler"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    reviewers:
-      - "Shopify/sorbet"
-    labels:
-      - "dependencies"
-      - "ruby"

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla

data/.github/pull_request_template.md

@@ -1,15 +0,0 @@
-### 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

@@ -1,31 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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,9 +0,0 @@
-/**/.bundle/
-/**/.yardoc
-/**/_yardoc/
-/**/coverage/
-/**/doc/
-/**/pkg/
-/**/spec/reports/
-/**/tmp/
-/**/.dev/

data/.rubocop.yml

@@ -1,40 +0,0 @@
-inherit_gem:
-  rubocop-shopify: rubocop.yml
-
-require:
- - rubocop-sorbet
- - rubocop-minitest
- - rubocop-rake
-
-AllCops:
-  NewCops: disable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.7
-  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"
-    - "lib/ruby-lsp.rb"

data/.vscode/extensions.json

@@ -1,5 +0,0 @@
-{
-  "recommendations": [
-    "rebornix.ruby"
-  ]
-}

data/.vscode/settings.json

@@ -1,5 +0,0 @@
-{
-  // 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/.vscode/tasks.json

@@ -1,25 +0,0 @@
-// See https://go.microsoft.com/fwlink/?LinkId=733558
-// for the documentation about the tasks.json format
-{
-	"version": "2.0.0",
-	"tasks": [
-    {
-      "type": "rake",
-      "task": "test",
-      "group": {
-        "kind": "test",
-        "isDefault": true
-      },
-      "problemMatcher": [],
-      "label": "rake: test",
-      "presentation": {
-        "echo": true,
-        "reveal": "always",
-        "focus": true,
-        "panel": "shared",
-        "showReuseMessage": true,
-        "clear": false
-      }
-    }
-  ]
-}