ruby-lsp 0.1.0 → 0.2.2

data/lib/ruby_lsp/server.rb

@@ -0,0 +1,192 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "ruby_lsp/internal"
+
+module RubyLsp
+  Handler.start do
+    on("initialize") do |request|
+      store.clear
+      initialization_options = request.dig(:params, :initializationOptions)
+      enabled_features = initialization_options.fetch(:enabledFeatures, [])
+
+      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
+
+      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
+
+      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.keys,
+            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys
+          ),
+          range: false,
+          full: {
+            delta: true,
+          }
+        )
+      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: {
+          textDocumentSync: Interface::TextDocumentSyncOptions.new(
+            change: Constant::TextDocumentSyncKind::INCREMENTAL,
+            open_close: true,
+          ),
+          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
+
+    on("textDocument/didChange") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      store.push_edits(uri, request.dig(:params, :contentChanges))
+
+      Handler::VOID
+    end
+
+    on("textDocument/didOpen") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      text = request.dig(:params, :textDocument, :text)
+      store.set(uri, text)
+
+      Handler::VOID
+    end
+
+    on("textDocument/didClose") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      store.delete(uri)
+      clear_diagnostics(uri)
+
+      Handler::VOID
+    end
+
+    on("textDocument/documentSymbol") do |request|
+      store.cache_fetch(request.dig(:params, :textDocument, :uri), :document_symbol) do |document|
+        Requests::DocumentSymbol.new(document).run
+      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
+      end
+    end
+
+    on("textDocument/selectionRange") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      positions = request.dig(:params, :positions)
+
+      ranges = store.cache_fetch(uri, :selection_ranges) do |document|
+        Requests::SelectionRanges.new(document).run
+      end
+
+      # 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.
+
+      unless ranges.nil?
+        positions.map do |position|
+          ranges.find do |range|
+            range.cover?(position)
+          end
+        end
+      end
+    end
+
+    on("textDocument/semanticTokens/full") do |request|
+      store.cache_fetch(request.dig(:params, :textDocument, :uri), :semantic_highlighting) do |document|
+        T.cast(
+          Requests::SemanticHighlighting.new(
+            document,
+            encoder: Requests::Support::SemanticTokenEncoder.new
+          ).run,
+          LanguageServer::Protocol::Interface::SemanticTokens
+        )
+      end
+    end
+
+    on("textDocument/formatting") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+
+      Requests::Formatting.new(uri, store.get(uri)).run
+    end
+
+    on("textDocument/documentHighlight") do |request|
+      document = store.get(request.dig(:params, :textDocument, :uri))
+
+      if document.parsed?
+        Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
+      end
+    end
+
+    on("textDocument/codeAction") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      range = request.dig(:params, :range)
+      start_line = range.dig(:start, :line)
+      end_line = range.dig(:end, :line)
+
+      store.cache_fetch(uri, :code_actions) do |document|
+        Requests::CodeActions.new(uri, document, start_line..end_line).run
+      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
+      # We return zero if shutdown has already been received or one otherwise as per the recommendation in the spec
+      # https://microsoft.github.io/language-server-protocol/specification/#exit
+      status = store.empty? ? 0 : 1
+      exit(status)
+    end
+  end
+end

data/lib/ruby_lsp/store.rb

@@ -25,9 +25,8 @@ module RubyLsp
 
     sig { params(uri: String, content: String).void }
     def set(uri, content)
-      @state[uri] = Document.new(content)
-    rescue SyntaxTree::Parser::ParseError
-      # Do not update the store if there are syntax errors
+      document = Document.new(content)
+      @state[uri] = document
     end
 
     sig { params(uri: String, edits: T::Array[Document::EditShape]).void }
@@ -40,6 +39,11 @@ module RubyLsp
       @state.clear
     end
 
+    sig { returns(T::Boolean) }
+    def empty?
+      @state.empty?
+    end
+
     sig { params(uri: String).void }
     def delete(uri)
       @state.delete(uri)
@@ -51,10 +55,13 @@ module RubyLsp
           uri: String,
           request_name: Symbol,
           block: T.proc.params(document: Document).returns(T.type_parameter(:T))
-        ).returns(T.type_parameter(:T))
+        ).returns(T.nilable(T.type_parameter(:T)))
     end
     def cache_fetch(uri, request_name, &block)
-      get(uri).cache_fetch(request_name, &block)
+      document = get(uri)
+      return unless document.parsed?
+
+      document.cache_fetch(request_name, &block)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.4'
-description: A simple language server for ruby
+description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
 executables:
@@ -74,31 +60,12 @@ 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/rubocop
-- bin/tapioca
-- bin/test
-- dev.yml
 - exe/ruby-lsp
 - lib/ruby-lsp.rb
-- lib/ruby_lsp/cli.rb
 - lib/ruby_lsp/document.rb
 - lib/ruby_lsp/handler.rb
 - lib/ruby_lsp/internal.rb
@@ -107,65 +74,21 @@ 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
-- lib/ruby_lsp/requests/rubocop_request.rb
 - lib/ruby_lsp/requests/selection_ranges.rb
 - lib/ruby_lsp/requests/semantic_highlighting.rb
+- lib/ruby_lsp/requests/support/highlight_target.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
+- lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb
+- lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb
 - lib/ruby_lsp/requests/support/selection_range.rb
 - lib/ruby_lsp/requests/support/semantic_token_encoder.rb
 - 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
@@ -179,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -189,5 +112,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
-summary: A simple language server for ruby
+summary: An opinionated language server for Ruby
 test_files: []

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,39 +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"

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
-      }
-    }
-  ]
-}

data/CODE_OF_CONDUCT.md

@@ -1,78 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies within all project spaces, and it also applies when
-an individual is representing the project or its community in public spaces.
-Examples of representing a project or community include using an official
-project e-mail address, posting via an official social media account, or acting
-as an appointed representative at an online or offline event. Representation of
-a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at opensource@shopify.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
-
-

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-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-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