solargraph 0.43.3 → 0.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5d2e054ff8eca78f0b4f2294eecd1018cb32f53bd43c241e803edefeb4fce1
-  data.tar.gz: c8161d2b732b03024d592a6db89a07c4cf27588d5a8b8d41c6cfcd63871c6796
+  metadata.gz: '0827e2be47eea923c2f61688ce4e97efa11d3d801f094ffb8a6cdb73a7fb52b3'
+  data.tar.gz: dcbad1eaa64acab63ccc511a93c0e1370fc469815e2e67735fc79c2f4dc08038
 SHA512:
-  metadata.gz: 6b310e476d1f7434a5da52adeda1212994b5cfa9907a60475a1dbd230e2bdbf9619a5a16420524fb0542e13dd527010f437e032f39ccac3596543bc96c4b1c24
-  data.tar.gz: 65bd2f40560050fc92f79bb4450a122f61e9b5a80bf58703f8317bd86d50058d6834b07b02d699b9804ab803c228f77441a32e37049d95ea4364704b916cf908
+  metadata.gz: fa050d901186e2385685d2aab7934f611517d68b549f4cb064ab7c3524f99e890488675a06483c2b1f2e2cafc0417a3367972a1ea8b6c6614a3465e867313b03
+  data.tar.gz: 4b12d6b0f65f53afd0ccbbdfc84a9fe8159f2f3a4bb3c625a84f1a9ee80be53f8c8b1d1ecfbae9bcf01ceff691388af5d0cef7271bb5470730fc4aa7a2471df9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.44.0 - September 27, 2021
+- Allow opening parenthesis, space, and comma when using Diff::LCS (#465)
+- Support textDocument/documentHighlight
+- Library#references_from performs shallow matches
+
 ## 0.43.3 - September 25, 2021
 - Avoid Dir.chdir in Bundler processes (#481)
 - Check stdlib for gems with empty yardocs

data/lib/solargraph/language_server/host.rb

@@ -18,7 +18,6 @@ module Solargraph
       autoload :Dispatch,      'solargraph/language_server/host/dispatch'
       autoload :MessageWorker, 'solargraph/language_server/host/message_worker'
 
-
       include UriHelpers
       include Logging
       include Dispatch
@@ -543,10 +542,11 @@ module Solargraph
       # @param line [Integer]
       # @param column [Integer]
       # @param strip [Boolean] Strip special characters from variable names
+      # @param only [Boolean] If true, search current file only
       # @return [Array<Solargraph::Range>]
-      def references_from uri, line, column, strip: true
+      def references_from uri, line, column, strip: true, only: false
         library = library_for(uri)
-        library.references_from(uri_to_file(uri), line, column, strip: strip)
+        library.references_from(uri_to_file(uri), line, column, strip: strip, only: only)
       end
 
       # @param query [String]
@@ -632,6 +632,7 @@ module Solargraph
           'diagnostics' => false,
           'formatting' => false,
           'folding' => true,
+          'highlights' => true,
           'logLevel' => 'warn'
         }
       end
@@ -716,7 +717,7 @@ module Solargraph
         return change if diffs.length.zero? || diffs.length > 1 || diffs.first.length > 1
         # @type [Diff::LCS::Change]
         diff = diffs.first.first
-        return change unless diff.adding? && ['.', ':'].include?(diff.element)
+        return change unless diff.adding? && ['.', ':', '(', ',', ' '].include?(diff.element)
         position = Solargraph::Position.from_offset(source.code, diff.position)
         {
           'range' => {
@@ -784,6 +785,9 @@ module Solargraph
           },
           'textDocument/codeAction' => {
             codeActionProvider: true
+          },
+          'textDocument/documentHighlight' => {
+            documentHighlightProvider: true
           }
         }
       end

data/lib/solargraph/language_server/message/initialize.rb

@@ -36,6 +36,7 @@ module Solargraph
           result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
           result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
           result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
+          result[:capabilities].merge! static_highlights unless dynamic_registration_for?('textDocument', 'documentHighlight')
           # @todo Temporarily disabled
           # result[:capabilities].merge! static_code_action unless dynamic_registration_for?('textDocument', 'codeAction')
           set_result result
@@ -138,6 +139,12 @@ module Solargraph
           }
         end
 
+        def static_highlights
+          {
+            documentHighlightProvider: true
+          }
+        end
+
         # @param section [String]
         # @param capability [String]
         # @return [Boolean]

data/lib/solargraph/language_server/message/initialized.rb

@@ -17,6 +17,7 @@ module Solargraph
             textDocument/rename
             textDocument/prepareRename
             textDocument/foldingRange
+            textDocument/documentHighlight
             workspace/symbol
           ]
         end

data/lib/solargraph/language_server/message/text_document/document_highlight.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class DocumentHighlight < Base
+    def process
+      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'], strip: true, only: true)
+      result = locs.map do |loc|
+        {
+          range: loc.range.to_hash,
+          kind: 1
+        }
+      end
+      set_result result
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document.rb

@@ -4,24 +4,24 @@ module Solargraph
   module LanguageServer
     module Message
       module TextDocument
-        autoload :Base,             'solargraph/language_server/message/text_document/base'
-        autoload :Completion,       'solargraph/language_server/message/text_document/completion'
-        autoload :DidOpen,          'solargraph/language_server/message/text_document/did_open'
-        autoload :DidChange,        'solargraph/language_server/message/text_document/did_change'
-        autoload :DidClose,         'solargraph/language_server/message/text_document/did_close'
-        autoload :DidSave,          'solargraph/language_server/message/text_document/did_save'
-        autoload :Hover,            'solargraph/language_server/message/text_document/hover'
-        autoload :SignatureHelp,    'solargraph/language_server/message/text_document/signature_help'
-        autoload :DiagnosticsQueue, 'solargraph/language_server/message/text_document/diagnostics_queue'
-        autoload :OnTypeFormatting, 'solargraph/language_server/message/text_document/on_type_formatting'
-        autoload :Definition,       'solargraph/language_server/message/text_document/definition'
-        autoload :DocumentSymbol,   'solargraph/language_server/message/text_document/document_symbol'
-        autoload :Formatting,       'solargraph/language_server/message/text_document/formatting'
-        autoload :References,       'solargraph/language_server/message/text_document/references'
-        autoload :Rename,           'solargraph/language_server/message/text_document/rename'
-        autoload :PrepareRename,    'solargraph/language_server/message/text_document/prepare_rename'
-        autoload :FoldingRange,     'solargraph/language_server/message/text_document/folding_range'
-        autoload :CodeAction,       'solargraph/language_server/message/text_document/code_action'
+        autoload :Base,              'solargraph/language_server/message/text_document/base'
+        autoload :Completion,        'solargraph/language_server/message/text_document/completion'
+        autoload :DidOpen,           'solargraph/language_server/message/text_document/did_open'
+        autoload :DidChange,         'solargraph/language_server/message/text_document/did_change'
+        autoload :DidClose,          'solargraph/language_server/message/text_document/did_close'
+        autoload :DidSave,           'solargraph/language_server/message/text_document/did_save'
+        autoload :Hover,             'solargraph/language_server/message/text_document/hover'
+        autoload :SignatureHelp,     'solargraph/language_server/message/text_document/signature_help'
+        autoload :DiagnosticsQueue,  'solargraph/language_server/message/text_document/diagnostics_queue'
+        autoload :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
+        autoload :Definition,        'solargraph/language_server/message/text_document/definition'
+        autoload :DocumentSymbol,    'solargraph/language_server/message/text_document/document_symbol'
+        autoload :Formatting,        'solargraph/language_server/message/text_document/formatting'
+        autoload :References,        'solargraph/language_server/message/text_document/references'
+        autoload :Rename,            'solargraph/language_server/message/text_document/rename'
+        autoload :PrepareRename,     'solargraph/language_server/message/text_document/prepare_rename'
+        autoload :FoldingRange,      'solargraph/language_server/message/text_document/folding_range'
+        autoload :DocumentHighlight, 'solargraph/language_server/message/text_document/document_highlight'
       end
     end
   end

data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb

@@ -22,6 +22,7 @@ module Solargraph::LanguageServer::Message::Workspace
       (host.options['definitions'] ? y : n).push('textDocument/definition')
       (host.options['references'] ? y : n).push('textDocument/references')
       (host.options['folding'] ? y : n).push('textDocument/folding')
+      (host.options['highlights'] ? y : n).push('textDocument/documentHighlight')
       host.register_capabilities y
       host.unregister_capabilities n
     end

data/lib/solargraph/language_server/message.rb

@@ -73,7 +73,8 @@ module Solargraph
       register 'textDocument/rename',                 TextDocument::Rename
       register 'textDocument/prepareRename',          TextDocument::PrepareRename
       register 'textDocument/foldingRange',           TextDocument::FoldingRange
-      register 'textDocument/codeAction',             TextDocument::CodeAction
+      # register 'textDocument/codeAction',             TextDocument::CodeAction
+      register 'textDocument/documentHighlight',      TextDocument::DocumentHighlight
       register 'workspace/didChangeWatchedFiles',     Workspace::DidChangeWatchedFiles
       register 'workspace/didChangeConfiguration',    Workspace::DidChangeConfiguration
       register 'workspace/didChangeWorkspaceFolders', Workspace::DidChangeWorkspaceFolders

data/lib/solargraph/library.rb

@@ -216,33 +216,35 @@ module Solargraph
     # @param line [Integer]
     # @param column [Integer]
     # @param strip [Boolean] Strip special characters from variable names
+    # @param only [Boolean] Search for references in the current file only
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
-    def references_from filename, line, column, strip: false
+    def references_from filename, line, column, strip: false, only: false
       cursor = api_map.cursor_at(filename, Position.new(line, column))
       clip = api_map.clip(cursor)
-      pins = clip.define
-      return [] if pins.empty?
+      pin = clip.define.first
+      return [] unless pin
       result = []
-      pins.uniq.each do |pin|
-        (workspace.sources + (@current ? [@current] : [])).uniq(&:filename).each do |source|
-          found = source.references(pin.name)
-          found.select! do |loc|
-            referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
-            # HACK: The additional location comparison is necessary because
-            # Clip#define can return proxies for parameter pins
-            referenced.any? { |r| r == pin || r.location == pin.location }
-          end
-          # HACK: for language clients that exclude special characters from the start of variable names
-          if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
-            found.map! do |loc|
-              Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
-            end
+      files = if only
+        [api_map.source_map(filename)]
+      else
+        (workspace.sources + (@current ? [@current] : []))
+      end
+      files.uniq(&:filename).each do |source|
+        found = source.references(pin.name)
+        found.select! do |loc|
+          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
+          referenced && referenced.path == pin.path
+        end
+        # HACK: for language clients that exclude special characters from the start of variable names
+        if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
+          found.map! do |loc|
+            Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
           end
-          result.concat(found.sort do |a, b|
-            a.range.start.line <=> b.range.start.line
-          end)
         end
+        result.concat(found.sort do |a, b|
+          a.range.start.line <=> b.range.start.line
+        end)
       end
       result.uniq
     end

data/lib/solargraph/parser/legacy/node_methods.rb

@@ -178,6 +178,7 @@ module Solargraph
 
         # @param cursor [Solargraph::Source::Cursor]
         def find_recipient_node cursor
+          return repaired_find_recipient_node(cursor) if cursor.source.repaired? && cursor.source.code[cursor.offset - 1] == '('
           source = cursor.source
           position = cursor.position
           offset = cursor.offset
@@ -210,6 +211,12 @@ module Solargraph
           nil
         end
 
+        def repaired_find_recipient_node cursor
+          cursor = cursor.source.cursor_at([cursor.position.line, cursor.position.column - 1])
+          node = cursor.source.tree_at(cursor.position.line, cursor.position.column).first
+          return node if node && node.type == :send
+        end
+
         module DeepInference
           class << self
             CONDITIONAL = [:if, :unless]

data/lib/solargraph/parser/rubyvm/node_methods.rb

@@ -141,36 +141,45 @@ module Solargraph
         class << self
           protected
 
+          # @param cursor [Source::Cursor]
+          # @return [RubyVM::AbstractSyntaxTree::Node, nil]
           def synchronized_find_recipient_node cursor
+            cursor = maybe_adjust_cursor(cursor)
             source = cursor.source
             position = cursor.position
             offset = cursor.offset
             tree = source.tree_at(position.line, position.column)
-            tree.shift while tree.first && [:FCALL, :VCALL, :CALL].include?(tree.first.type) && !source.code_for(tree.first).strip.end_with?(')')
+              .select { |n| [:FCALL, :VCALL, :CALL].include?(n.type) }
+            unless source.repaired?
+              tree.shift while tree.first && !source.code_for(tree.first).strip.end_with?(')')
+            end
+            return tree.first if source.repaired? || source.code[0..offset-1] =~ /\(\s*$/
             tree.each do |node|
-              if [:FCALL, :VCALL, :CALL].include?(node.type)
-                args = node.children.find { |c| Parser.is_ast_node?(c) && [:ARRAY, :ZARRAY, :LIST].include?(c.type) }
-                if args
-                  match = source.code[0..offset-1].match(/,[^\)]*\z/)
-                  rng = Solargraph::Range.from_node(args)
-                  if match
-                    rng = Solargraph::Range.new(rng.start, position)
-                  end
-                  return node if rng.contain?(position)
-                elsif source.code[0..offset-1] =~ /\(\s*$/
-                  break  unless source.code_for(node).strip.end_with?(')')
-                  return node
+              args = node.children.find { |c| Parser.is_ast_node?(c) && [:ARRAY, :ZARRAY, :LIST].include?(c.type) }
+              if args
+                match = source.code[0..offset-1].match(/,[^\)]*\z/)
+                rng = Solargraph::Range.from_node(args)
+                if match
+                  rng = Solargraph::Range.new(rng.start, position)
                 end
+                return node if rng.contain?(position)
               end
             end
             nil
           end
 
+          # @param cursor [Source::Cursor]
+          # @return [Source::Cursor]
+          def maybe_adjust_cursor cursor
+            return cursor unless (cursor.source.repaired? && cursor.source.code[cursor.offset - 1] == '(') || [',', ' '].include?(cursor.source.code[cursor.offset - 1])
+            cursor.source.cursor_at([cursor.position.line, cursor.position.column - 1])
+          end
+
           def unsynchronized_find_recipient_node cursor
             source = cursor.source
             position = cursor.position
             offset = cursor.offset
-            if source.code[0..offset-1] =~ /\([A-Zaz0-9_\s]*\z$/ #&& source.code[offset] == ')'
+            if source.code[0..offset-1] =~ /\([A-Zaz0-9_\s]*\z$/
               tree = source.tree_at(position.line, position.column - 1)
               if tree.first && [:FCALL, :VCALL, :CALL].include?(tree.first.type)
                 return tree.first

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.43.3'
+  VERSION = '0.44.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.43.3
+  version: 0.44.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -381,6 +381,7 @@ files:
 - lib/solargraph/language_server/message/text_document/did_close.rb
 - lib/solargraph/language_server/message/text_document/did_open.rb
 - lib/solargraph/language_server/message/text_document/did_save.rb
+- lib/solargraph/language_server/message/text_document/document_highlight.rb
 - lib/solargraph/language_server/message/text_document/document_symbol.rb
 - lib/solargraph/language_server/message/text_document/folding_range.rb
 - lib/solargraph/language_server/message/text_document/formatting.rb