ruby-lsp 0.3.2 → 0.3.4

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -101,15 +101,15 @@ module RubyLsp
       def add_edit_with_text(text)
         position = Interface::Position.new(
           line: @position[:line],
-          character: @position[:character]
+          character: @position[:character],
         )
 
         @edits << Interface::TextEdit.new(
           range: Interface::Range.new(
             start: position,
-            end: position
+            end: position,
           ),
-          new_text: text
+          new_text: text,
         )
       end
 
@@ -117,7 +117,7 @@ module RubyLsp
       def move_cursor_to(line, character)
         position = Interface::Position.new(
           line: line,
-          character: character
+          character: character,
         )
 
         # The $0 is a special snippet anchor that moves the cursor to that given position. See the snippets
@@ -126,9 +126,9 @@ module RubyLsp
         @edits << Interface::TextEdit.new(
           range: Interface::Range.new(
             start: position,
-            end: position
+            end: position,
           ),
-          new_text: "$0"
+          new_text: "$0",
         )
       end
 

data/lib/ruby_lsp/requests/selection_ranges.rb

@@ -70,13 +70,13 @@ module RubyLsp
 
       sig { override.returns(T.all(T::Array[Support::SelectionRange], Object)) }
       def run
-        visit(@document.tree)
+        visit(@document.tree) if @document.parsed?
         @ranges.reverse!
       end
 
       private
 
-      sig { params(node: T.nilable(SyntaxTree::Node)).void }
+      sig { override.params(node: T.nilable(SyntaxTree::Node)).void }
       def visit(node)
         return if node.nil?
 
@@ -93,7 +93,7 @@ module RubyLsp
       sig do
         params(
           location: SyntaxTree::Location,
-          parent: T.nilable(Support::SelectionRange)
+          parent: T.nilable(Support::SelectionRange),
         ).returns(Support::SelectionRange)
       end
       def create_selection_range(location, parent = nil)
@@ -108,7 +108,7 @@ module RubyLsp
               character: location.end_column,
             ),
           ),
-          parent: parent
+          parent: parent,
         )
       end
     end

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -90,22 +90,19 @@ module RubyLsp
           T.any(
             LanguageServer::Protocol::Interface::SemanticTokens,
             T.all(T::Array[SemanticToken], Object),
-          )
+          ),
         )
       end
       def run
+        return @tokens unless @document.parsed?
+
         visit(@tree)
         return @tokens unless @encoder
 
         @encoder.encode(@tokens)
       end
 
-      sig { params(node: SyntaxTree::ARefField).void }
-      def visit_a_ref_field(node)
-        add_token(node.collection.value.location, :variable)
-      end
-
-      sig { params(node: SyntaxTree::Call).void }
+      sig { override.params(node: SyntaxTree::Call).void }
       def visit_call(node)
         visit(node.receiver)
 
@@ -115,32 +112,32 @@ module RubyLsp
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Command).void }
+      sig { override.params(node: SyntaxTree::Command).void }
       def visit_command(node)
         add_token(node.message.location, :method) unless special_method?(node.message.value)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::CommandCall).void }
+      sig { override.params(node: SyntaxTree::CommandCall).void }
       def visit_command_call(node)
         visit(node.receiver)
         add_token(node.message.location, :method)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Const).void }
+      sig { override.params(node: SyntaxTree::Const).void }
       def visit_const(node)
         add_token(node.location, :namespace)
       end
 
-      sig { params(node: SyntaxTree::Def).void }
+      sig { override.params(node: SyntaxTree::Def).void }
       def visit_def(node)
         add_token(node.name.location, :method, [:declaration])
         visit(node.params)
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::DefEndless).void }
+      sig { override.params(node: SyntaxTree::DefEndless).void }
       def visit_def_endless(node)
         add_token(node.name.location, :method, [:declaration])
         visit(node.paren)
@@ -148,7 +145,7 @@ module RubyLsp
         visit(node.statement)
       end
 
-      sig { params(node: SyntaxTree::Defs).void }
+      sig { override.params(node: SyntaxTree::Defs).void }
       def visit_defs(node)
         visit(node.target)
         visit(node.operator)
@@ -157,13 +154,13 @@ module RubyLsp
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::FCall).void }
+      sig { override.params(node: SyntaxTree::FCall).void }
       def visit_fcall(node)
         add_token(node.value.location, :method) unless special_method?(node.value.value)
         visit(node.arguments)
       end
 
-      sig { params(node: SyntaxTree::Kw).void }
+      sig { override.params(node: SyntaxTree::Kw).void }
       def visit_kw(node)
         case node.value
         when "self"
@@ -171,14 +168,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::MAssign).void }
-      def visit_m_assign(node)
-        node.target.parts.each do |var_ref|
-          add_token(var_ref.value.location, :variable)
-        end
-      end
-
-      sig { params(node: SyntaxTree::Params).void }
+      sig { override.params(node: SyntaxTree::Params).void }
       def visit_params(node)
         node.keywords.each do |keyword,|
           location = keyword.location
@@ -196,7 +186,7 @@ module RubyLsp
         add_token(name.location, :variable) if name
       end
 
-      sig { params(node: SyntaxTree::VarField).void }
+      sig { override.params(node: SyntaxTree::VarField).void }
       def visit_var_field(node)
         case node.value
         when SyntaxTree::Ident
@@ -206,7 +196,7 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::VarRef).void }
+      sig { override.params(node: SyntaxTree::VarRef).void }
       def visit_var_ref(node)
         case node.value
         when SyntaxTree::Ident
@@ -216,19 +206,19 @@ module RubyLsp
         end
       end
 
-      sig { params(node: SyntaxTree::VCall).void }
+      sig { override.params(node: SyntaxTree::VCall).void }
       def visit_vcall(node)
         add_token(node.value.location, :method) unless special_method?(node.value.value)
       end
 
-      sig { params(node: SyntaxTree::ClassDeclaration).void }
+      sig { override.params(node: SyntaxTree::ClassDeclaration).void }
       def visit_class(node)
         add_token(node.constant.location, :class, [:declaration])
         add_token(node.superclass.location, :class) if node.superclass
         visit(node.bodystmt)
       end
 
-      sig { params(node: SyntaxTree::ModuleDeclaration).void }
+      sig { override.params(node: SyntaxTree::ModuleDeclaration).void }
       def visit_module(node)
         add_token(node.constant.location, :class, [:declaration])
         visit(node.bodystmt)
@@ -243,8 +233,8 @@ module RubyLsp
             location: location,
             length: length,
             type: T.must(TOKEN_TYPES[type]),
-            modifier: modifiers_indices
-          )
+            modifier: modifiers_indices,
+          ),
         )
       end
 

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

@@ -0,0 +1,114 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "net/http"
+
+module RubyLsp
+  module Requests
+    module Support
+      class RailsDocumentClient
+        RAILS_DOC_HOST = "https://api.rubyonrails.org"
+        SUPPORTED_RAILS_DOC_NAMESPACES = T.let(
+          Regexp.union(
+            /ActionDispatch/, /ActionController/, /AbstractController/, /ActiveRecord/, /ActiveModel/, /ActiveStorage/,
+            /ActionText/, /ActiveJob/
+          ).freeze,
+          Regexp,
+        )
+
+        RAILTIES_VERSION = T.let(
+          [*::Gem::Specification.default_stubs, *::Gem::Specification.stubs].find do |s|
+            s.name == "railties"
+          end&.version&.to_s, T.nilable(String)
+        )
+
+        class << self
+          extend T::Sig
+          sig do
+            params(name: String).returns(T::Array[String])
+          end
+          def generate_rails_document_urls(name)
+            docs = T.must(search_index)[name]
+
+            return [] unless docs
+
+            docs.map do |doc|
+              owner = doc[:owner]
+
+              link_name =
+                # class/module name
+                if owner == name
+                  name
+                else
+                  "#{owner}##{name}"
+                end
+
+              "[Rails Document: `#{link_name}`](#{doc[:url]})"
+            end
+          end
+
+          sig { returns(T.nilable(T::Hash[String, T::Array[T::Hash[Symbol, String]]])) }
+          private def search_index
+            @rails_documents ||= T.let(
+              build_search_index,
+              T.nilable(T::Hash[String, T::Array[T::Hash[Symbol, String]]]),
+            )
+          end
+
+          sig { returns(T.nilable(T::Hash[String, T::Array[T::Hash[Symbol, String]]])) }
+          private def build_search_index
+            return unless RAILTIES_VERSION
+
+            $stderr.puts "Fetching Rails Documents..."
+            # If the version's doc is not found, e.g. Rails main, it'll be redirected
+            # In this case, we just fetch the latest doc
+            response = if Gem::Version.new(RAILTIES_VERSION).prerelease?
+              Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/js/search_index.js"))
+            else
+              Net::HTTP.get_response(URI("#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/js/search_index.js"))
+            end
+
+            if response.code == "200"
+              process_search_index(response.body)
+            else
+              $stderr.puts("Response failed: #{response.inspect}")
+              nil
+            end
+          rescue StandardError => e
+            $stderr.puts("Exception occurred when fetching Rails document index: #{e.inspect}")
+          end
+
+          sig { params(js: String).returns(T::Hash[String, T::Array[T::Hash[Symbol, String]]]) }
+          private def process_search_index(js)
+            raw_data = js.sub("var search_data = ", "")
+            info = JSON.parse(raw_data).dig("index", "info")
+
+            # An entry looks like this:
+            #
+            # ["belongs_to",                                                              # method or module/class
+            #  "ActiveRecord::Associations::ClassMethods",                                # method owner
+            #  "classes/ActiveRecord/Associations/ClassMethods.html#method-i-belongs_to", # path to the document
+            #  "(name, scope = nil, **options)",                                          # method's parameters
+            #  "<p>Specifies a one-to-one association with another class..."]             # document preview
+            #
+            info.each_with_object({}) do |(method_or_class, method_owner, doc_path, _, doc_preview), table|
+              # If a method doesn't have documentation, there's no need to generate the link to it.
+              next if doc_preview.nil? || doc_preview.empty?
+
+              # If the method or class/module is not from the supported namespace, reject it
+              next unless [method_or_class, method_owner].any? do |elem|
+                            elem.match?(SUPPORTED_RAILS_DOC_NAMESPACES)
+                          end
+
+              owner = method_owner.empty? ? method_or_class : method_owner
+              table[method_or_class] ||= []
+              # It's possible to have multiple modules defining the same method name. For example,
+              # both `ActiveRecord::FinderMethods` and `ActiveRecord::Associations::CollectionProxy` defines `#find`
+              table[method_or_class] << { owner: owner, url: "#{RAILS_DOC_HOST}/v#{RAILTIES_VERSION}/#{doc_path}" }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -25,7 +25,7 @@ module RubyLsp
           @uri = uri
           @replacements = T.let(
             offense.correctable? ? offense_replacements : [],
-            T::Array[LanguageServer::Protocol::Interface::TextEdit]
+            T::Array[LanguageServer::Protocol::Interface::TextEdit],
           )
         end
 
@@ -49,11 +49,11 @@ module RubyLsp
                 LanguageServer::Protocol::Interface::TextDocumentEdit.new(
                   text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
                     uri: @uri,
-                    version: nil
+                    version: nil,
                   ),
-                  edits: @replacements
+                  edits: @replacements,
                 ),
-              ]
+              ],
             ),
             is_preferred: true,
           )
@@ -76,13 +76,13 @@ module RubyLsp
             range: LanguageServer::Protocol::Interface::Range.new(
               start: LanguageServer::Protocol::Interface::Position.new(
                 line: @offense.line - 1,
-                character: @offense.column
+                character: @offense.column,
               ),
               end: LanguageServer::Protocol::Interface::Position.new(
                 line: @offense.last_line - 1,
-                character: @offense.last_column
-              )
-            )
+                character: @offense.last_column,
+              ),
+            ),
           )
         end
 
@@ -95,9 +95,9 @@ module RubyLsp
               range: LanguageServer::Protocol::Interface::Range.new(
                 start: LanguageServer::Protocol::Interface::Position.new(line: range.line - 1, character: range.column),
                 end: LanguageServer::Protocol::Interface::Position.new(line: range.last_line - 1,
-                  character: range.last_column)
+                  character: range.last_column),
               ),
-              new_text: replacement
+              new_text: replacement,
             )
           end
         end

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

@@ -7,6 +7,12 @@ rescue LoadError
   return
 end
 
+begin
+  gem("rubocop", ">= 1.4.0")
+rescue LoadError
+  raise StandardError, "Incompatible RuboCop version. Ruby LSP requires >= 1.4.0"
+end
+
 module RubyLsp
   module Requests
     module Support

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

@@ -15,7 +15,7 @@ module RubyLsp
 
         sig do
           params(
-            tokens: T::Array[SemanticHighlighting::SemanticToken]
+            tokens: T::Array[SemanticHighlighting::SemanticToken],
           ).returns(LanguageServer::Protocol::Interface::SemanticTokens)
         end
         def encode(tokens)

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

@@ -30,7 +30,7 @@ module URI
           gem_name: String,
           gem_version: T.nilable(String),
           path: String,
-          line_number: T.nilable(String)
+          line_number: T.nilable(String),
         ).returns(URI::Source)
       end
       def build(gem_name:, gem_version:, path:, line_number:)

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

@@ -23,7 +23,7 @@ module RubyLsp
             message: "Syntax error",
             source: "SyntaxTree",
             severity: LanguageServer::Protocol::Constant::DiagnosticSeverity::ERROR,
-            range: @edit[:range]
+            range: @edit[:range],
           )
         end
       end

data/lib/ruby_lsp/requests.rb

@@ -6,6 +6,7 @@ module RubyLsp
   #
   # - {RubyLsp::Requests::DocumentSymbol}
   # - {RubyLsp::Requests::DocumentLink}
+  # - {RubyLsp::Requests::Hover}
   # - {RubyLsp::Requests::FoldingRanges}
   # - {RubyLsp::Requests::SelectionRanges}
   # - {RubyLsp::Requests::SemanticHighlighting}
@@ -14,10 +15,13 @@ module RubyLsp
   # - {RubyLsp::Requests::Diagnostics}
   # - {RubyLsp::Requests::CodeActions}
   # - {RubyLsp::Requests::DocumentHighlight}
+  # - {RubyLsp::Requests::InlayHints}
+
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
     autoload :DocumentSymbol, "ruby_lsp/requests/document_symbol"
     autoload :DocumentLink, "ruby_lsp/requests/document_link"
+    autoload :Hover, "ruby_lsp/requests/hover"
     autoload :FoldingRanges, "ruby_lsp/requests/folding_ranges"
     autoload :SelectionRanges, "ruby_lsp/requests/selection_ranges"
     autoload :SemanticHighlighting, "ruby_lsp/requests/semantic_highlighting"
@@ -26,6 +30,7 @@ module RubyLsp
     autoload :Diagnostics, "ruby_lsp/requests/diagnostics"
     autoload :CodeActions, "ruby_lsp/requests/code_actions"
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
+    autoload :InlayHints, "ruby_lsp/requests/inlay_hints"
 
     # :nodoc:
     module Support

data/lib/ruby_lsp/server.rb

@@ -15,7 +15,7 @@ module RubyLsp
           hierarchical_document_symbol_support: true,
           symbol_kind: {
             value_set: Requests::DocumentSymbol::SYMBOL_KIND.values,
-          }
+          },
         )
       end
 
@@ -23,6 +23,10 @@ module RubyLsp
         Interface::DocumentLinkOptions.new(resolve_provider: false)
       end
 
+      hover_provider = if enabled_features.include?("hover")
+        Interface::HoverClientCapabilities.new(dynamic_registration: false)
+      end
+
       folding_ranges_provider = if enabled_features.include?("foldingRanges")
         Interface::FoldingRangeClientCapabilities.new(line_folding_only: true)
       end
@@ -32,12 +36,12 @@ module RubyLsp
           document_selector: { scheme: "file", language: "ruby" },
           legend: Interface::SemanticTokensLegend.new(
             token_types: Requests::SemanticHighlighting::TOKEN_TYPES.keys,
-            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys
+            token_modifiers: Requests::SemanticHighlighting::TOKEN_MODIFIERS.keys,
           ),
           range: false,
           full: {
             delta: true,
-          }
+          },
         )
       end
 
@@ -51,10 +55,14 @@ module RubyLsp
       on_type_formatting_provider = if enabled_features.include?("onTypeFormatting")
         Interface::DocumentOnTypeFormattingOptions.new(
           first_trigger_character: "{",
-          more_trigger_character: ["\n", "|"]
+          more_trigger_character: ["\n", "|"],
         )
       end
 
+      inlay_hint_provider = if enabled_features.include?("inlayHint")
+        Interface::InlayHintOptions.new(resolve_provider: false)
+      end
+
       Interface::InitializeResult.new(
         capabilities: Interface::ServerCapabilities.new(
           text_document_sync: Interface::TextDocumentSyncOptions.new(
@@ -62,6 +70,7 @@ module RubyLsp
             open_close: true,
           ),
           selection_range_provider: enabled_features.include?("selectionRanges"),
+          hover_provider: hover_provider,
           document_symbol_provider: document_symbol_provider,
           document_link_provider: document_link_provider,
           folding_range_provider: folding_ranges_provider,
@@ -71,7 +80,8 @@ module RubyLsp
           code_action_provider: enabled_features.include?("codeActions"),
           document_on_type_formatting_provider: on_type_formatting_provider,
           diagnostic_provider: diagnostics_provider,
-        )
+          inlay_hint_provider: inlay_hint_provider,
+        ),
       )
     end
 
@@ -111,6 +121,13 @@ module RubyLsp
       end
     end
 
+    on("textDocument/hover") do |request|
+      position = request.dig(:params, :position)
+      document = store.get(request.dig(:params, :textDocument, :uri))
+
+      RubyLsp::Requests::Hover.new(document, position).run
+    end
+
     on("textDocument/foldingRange", parallel: true) do |request|
       store.cache_fetch(request.dig(:params, :textDocument, :uri), :folding_ranges) do |document|
         Requests::FoldingRanges.new(document).run
@@ -144,9 +161,9 @@ module RubyLsp
         T.cast(
           Requests::SemanticHighlighting.new(
             document,
-            encoder: Requests::Support::SemanticTokenEncoder.new
+            encoder: Requests::Support::SemanticTokenEncoder.new,
           ).run,
-          LanguageServer::Protocol::Interface::SemanticTokens
+          LanguageServer::Protocol::Interface::SemanticTokens,
         )
       end
     end
@@ -170,9 +187,7 @@ module RubyLsp
     on("textDocument/documentHighlight", parallel: true) do |request|
       document = store.get(request.dig(:params, :textDocument, :uri))
 
-      if document.parsed?
-        Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
-      end
+      Requests::DocumentHighlight.new(document, request.dig(:params, :position)).run
     end
 
     on("textDocument/codeAction", parallel: true) do |request|
@@ -186,6 +201,15 @@ module RubyLsp
       end
     end
 
+    on("textDocument/inlayHint", parallel: true) do |request|
+      document = store.get(request.dig(:params, :textDocument, :uri))
+      range = request.dig(:params, :range)
+      start_line = range.dig(:start, :line)
+      end_line = range.dig(:end, :line)
+
+      Requests::InlayHints.new(document, start_line..end_line).run
+    end
+
     on("$/cancelRequest") do |request|
       cancel_request(request[:params][:id])
       Handler::VOID

data/lib/ruby_lsp/store.rb

@@ -54,14 +54,11 @@ module RubyLsp
         .params(
           uri: String,
           request_name: Symbol,
-          block: T.proc.params(document: Document).returns(T.type_parameter(:T))
-        ).returns(T.nilable(T.type_parameter(:T)))
+          block: T.proc.params(document: Document).returns(T.type_parameter(:T)),
+        ).returns(T.type_parameter(:T))
     end
     def cache_fetch(uri, request_name, &block)
-      document = get(uri)
-      return unless document.parsed?
-
-      document.cache_fetch(request_name, &block)
+      get(uri).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.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.6.3
 description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
@@ -60,7 +60,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - VERSION
@@ -79,10 +78,13 @@ 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/hover.rb
+- lib/ruby_lsp/requests/inlay_hints.rb
 - lib/ruby_lsp/requests/on_type_formatting.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/rails_document_client.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