ruby-lsp 0.0.4 → 0.2.1

data/lib/ruby_lsp/requests.rb

@@ -1,24 +1,35 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module RubyLsp
+  # Supported features
+  #
+  # - {RubyLsp::Requests::DocumentSymbol}
+  # - {RubyLsp::Requests::FoldingRanges}
+  # - {RubyLsp::Requests::SelectionRanges}
+  # - {RubyLsp::Requests::SemanticHighlighting}
+  # - {RubyLsp::Requests::Formatting}
+  # - {RubyLsp::Requests::Diagnostics}
+  # - {RubyLsp::Requests::CodeActions}
+  # - {RubyLsp::Requests::DocumentHighlight}
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
     autoload :DocumentSymbol, "ruby_lsp/requests/document_symbol"
     autoload :FoldingRanges, "ruby_lsp/requests/folding_ranges"
     autoload :SelectionRanges, "ruby_lsp/requests/selection_ranges"
     autoload :SemanticHighlighting, "ruby_lsp/requests/semantic_highlighting"
-    autoload :RuboCopRequest, "ruby_lsp/requests/rubocop_request"
     autoload :Formatting, "ruby_lsp/requests/formatting"
     autoload :Diagnostics, "ruby_lsp/requests/diagnostics"
     autoload :CodeActions, "ruby_lsp/requests/code_actions"
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
 
+    # :nodoc:
     module Support
       autoload :RuboCopDiagnostic, "ruby_lsp/requests/support/rubocop_diagnostic"
       autoload :SelectionRange, "ruby_lsp/requests/support/selection_range"
       autoload :SemanticTokenEncoder, "ruby_lsp/requests/support/semantic_token_encoder"
       autoload :SyntaxErrorDiagnostic, "ruby_lsp/requests/support/syntax_error_diagnostic"
+      autoload :HighlightTarget, "ruby_lsp/requests/support/highlight_target"
     end
   end
 end

data/lib/ruby_lsp/server.rb

@@ -0,0 +1,160 @@
+# 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
+
+      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
+
+      Interface::InitializeResult.new(
+        capabilities: Interface::ServerCapabilities.new(
+          text_document_sync: 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")
+        )
+      )
+    end
+
+    on("textDocument/didChange") do |request|
+      uri = request.dig(:params, :textDocument, :uri)
+      store.push_edits(uri, request.dig(:params, :contentChanges))
+
+      send_diagnostics(uri)
+      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)
+      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/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
+
+      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)
+        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))
+      return unless document.parsed?
+
+      Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
+    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("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,20 +39,29 @@ 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)
     end
 
     sig do
-      params(
-        uri: String,
-        request_name: Symbol,
-        block: T.proc.params(document: Document).returns(T.untyped)
-      ).returns(T.untyped)
+      type_parameters(:T)
+        .params(
+          uri: String,
+          request_name: Symbol,
+          block: T.proc.params(document: Document).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

data/rakelib/check_docs.rake

@@ -3,13 +3,18 @@
 
 desc "Check if all LSP requests are documented"
 task :check_docs do
+  require "sorbet-runtime"
   require "language_server-protocol"
   require "syntax_tree"
   require "logger"
   require "ruby_lsp/requests/base_request"
-  require "ruby_lsp/requests/rubocop_request"
+  require "ruby_lsp/requests/support/rubocop_diagnostics_runner"
+  require "ruby_lsp/requests/support/rubocop_formatting_runner"
 
-  Dir["#{Dir.pwd}/lib/ruby_lsp/requests/*.rb"].each do |file|
+  request_doc_files = Dir["#{Dir.pwd}/lib/ruby_lsp/requests/*.rb"]
+  request_doc_files << "#{Dir.pwd}/lib/ruby_lsp/requests.rb"
+
+  request_doc_files.each do |file|
     require(file)
     YARD.parse(file, [], Logger::Severity::FATAL)
   end
@@ -18,6 +23,8 @@ task :check_docs do
   error_messages = RubyLsp::Requests
     .constants # rubocop:disable Sorbet/ConstantsFromStrings
     .each_with_object(Hash.new { |h, k| h[k] = [] }) do |request, errors|
+    next if request == :Support
+
     full_name = "RubyLsp::Requests::#{request}"
     docs = YARD::Registry.at(full_name).docstring
     next if /:nodoc:/.match?(docs)
@@ -31,15 +38,33 @@ task :check_docs do
         For example, if your request handles text document hover, you should add a link to
         https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover.
       MESSAGE
+    elsif !%r{!\[.* demo\]\(\.\./\.\./misc/.*\.gif\)}.match?(docs)
+      errors[full_name] << <<~MESSAGE
+        Documentation for request handler class must contain a demonstration GIF, in the following format:
+
+        ![Request name demo](../../misc/request_name.gif)
+
+        See the misc/ folder for examples.
+      MESSAGE
     elsif !/# Example/.match?(docs)
       errors[full_name] << <<~MESSAGE
         Documentation for request handler class must contain an example.
 
-        = Example
-            def my_method # <-- something happens here
-            end
+        # # Example
+        #
+        # ```ruby
+        # def my_method # <-- something happens here
+        # end
+        # ```
       MESSAGE
     end
+
+    supported_features = YARD::Registry.at("RubyLsp::Requests").docstring
+    next if /- {#{full_name}}/.match?(supported_features)
+
+    errors[full_name] << <<~MESSAGE
+      Documentation for request handler class must be listed in the RubyLsp::Requests module documentation.
+    MESSAGE
   end
 
   formatted_errors = error_messages.map { |name, errors| "#{name}: #{errors.join(", ")}" }

data/ruby-lsp.gemspec

@@ -7,20 +7,21 @@ Gem::Specification.new do |s|
   s.email = ["ruby@shopify.com"]
   s.metadata["allowed_push_host"] = "https://rubygems.org"
 
-  s.summary = "A simple language server for ruby"
-  s.description = "A simple language server for ruby"
+  s.summary = "An opinionated language server for Ruby"
+  s.description = "An opinionated language server for Ruby"
   s.homepage = "https://github.com/Shopify/ruby-lsp"
   s.license = "MIT"
 
   s.files = Dir.chdir(File.expand_path(__dir__)) do
-    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|misc)/}) }
   end
   s.bindir = "exe"
   s.executables = s.files.grep(/\Aexe/) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_dependency("language_server-protocol")
-  s.add_dependency("rubocop", ">= 1.0")
   s.add_dependency("sorbet-runtime")
-  s.add_dependency("syntax_tree", ">= 2.3")
+  s.add_dependency("syntax_tree", ">= 2.4")
+
+  s.required_ruby_version = ">= 2.7.3"
 end

data/sorbet/tapioca/require.rb

@@ -1,4 +1,4 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 # Add your extra requires here (`bin/tapioca require` can be used to boostrap this list)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-07-27 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
@@ -58,15 +44,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
-description: A simple language server for ruby
+        version: '2.4'
+description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
 executables:
@@ -92,16 +78,16 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/console
 - bin/rubocop
 - bin/tapioca
 - bin/test
 - dev.yml
 - exe/ruby-lsp
-- lib/internal.rb
 - lib/ruby-lsp.rb
-- lib/ruby_lsp/cli.rb
 - lib/ruby_lsp/document.rb
 - lib/ruby_lsp/handler.rb
+- lib/ruby_lsp/internal.rb
 - lib/ruby_lsp/requests.rb
 - lib/ruby_lsp/requests/base_request.rb
 - lib/ruby_lsp/requests/code_actions.rb
@@ -110,18 +96,20 @@ files:
 - 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
-- shipit.production.yml
 - sorbet/config
 - sorbet/rbi/.rubocop.yml
 - sorbet/rbi/gems/ansi@1.5.0.rbi
@@ -180,15 +168,15 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+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/lib/ruby_lsp/cli.rb

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

data/lib/ruby_lsp/requests/rubocop_request.rb

@@ -1,50 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "rubocop"
-require "cgi"
-
-module RubyLsp
-  module Requests
-    # :nodoc:
-    class RuboCopRequest < RuboCop::Runner
-      COMMON_RUBOCOP_FLAGS = [
-        "--stderr", # Print any output to stderr so that our stdout does not get polluted
-        "--format",
-        "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
-      ].freeze
-
-      attr_reader :file, :text
-
-      def self.run(uri, document)
-        new(uri, document).run
-      end
-
-      def initialize(uri, document)
-        @file = CGI.unescape(URI.parse(uri).path)
-        @document = document
-        @text = document.source
-        @uri = uri
-
-        super(
-          ::RuboCop::Options.new.parse(rubocop_flags).first,
-          ::RuboCop::ConfigStore.new
-        )
-      end
-
-      def run
-        # We communicate with Rubocop via stdin
-        @options[:stdin] = text
-
-        # Invoke the actual run method with just this file in `paths`
-        super([file])
-      end
-
-      private
-
-      def rubocop_flags
-        COMMON_RUBOCOP_FLAGS
-      end
-    end
-  end
-end

data/shipit.production.yml

@@ -1 +0,0 @@
-# default config