solargraph 0.43.3 → 0.44.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5d2e054ff8eca78f0b4f2294eecd1018cb32f53bd43c241e803edefeb4fce1
-  data.tar.gz: c8161d2b732b03024d592a6db89a07c4cf27588d5a8b8d41c6cfcd63871c6796
+  metadata.gz: f8ff2cf72eecc4a36760b60491151cbedb17e11ac665ef20609e0291b2e4b64e
+  data.tar.gz: ea35a1bb406f5c185df0943b483676360b3c0e3df9f4fb476a246174dc37b542
 SHA512:
-  metadata.gz: 6b310e476d1f7434a5da52adeda1212994b5cfa9907a60475a1dbd230e2bdbf9619a5a16420524fb0542e13dd527010f437e032f39ccac3596543bc96c4b1c24
-  data.tar.gz: 65bd2f40560050fc92f79bb4450a122f61e9b5a80bf58703f8317bd86d50058d6834b07b02d699b9804ab803c228f77441a32e37049d95ea4364704b916cf908
+  metadata.gz: 152ad48cda1f002d12f4e27e11bbc090be72a113246521d1a03e4a82f0d920e885f39cf8eef46d12c588d66afe0b4835cb16b2192ceaa16f1ad6d8c9631a9677
+  data.tar.gz: ef1f6ecfa30e9eb58080cdf09c94e1611f35f8f2f64ecc8fcfb0e359aa4b95551cf5cfb7d1ec749e023bcd9045118bb33fc0bc1756c4449aa8959ce6aa73b6d8

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 0.44.3 - January 22, 2022
+- TypeChecker validates aliased namespaces (#497)
+- Always use reference YARD tags when resolving param types (#515) (#516)
+- Skip method aliases in strict type checking
+
+## 0.44.2 - November 23, 2021
+- Scope local variables in class_eval blocks (#503)
+- Fix invalid UTF-8 in node comments (#504)
+
+## 0.44.1 - November 18, 2021
+- Chain nil safety navigation operator (#420)
+- Update closure and context for class_eval receiver (#487)
+- SourceMap::Mapper handles invalid byte sequences (#474)
+- Special handle var= references, which may use as var = (have space) (#498)
+- Rebind define_method to self (#494)
+
+## 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/complex_type.rb

@@ -87,6 +87,10 @@ module Solargraph
       ComplexType.parse(*result.map(&:tag))
     end
 
+    def nullable?
+      @items.any?(&:nil_type?)
+    end
+
     private
 
     # @todo This is a quick and dirty hack that forces `self` keywords

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -31,7 +31,7 @@ module Solargraph
       # @param code [String]
       # @return [Array(Array<String>, Array<String>)]
       def generate_options filename, code
-        args = ['-f', 'j', filename]
+        args = ['-f', 'j', '--force-exclusion', filename]
         base_options = RuboCop::Options.new
         options, paths = base_options.parse(args)
         options[:stdin] = code

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/class_methods.rb

@@ -48,10 +48,16 @@ module Solargraph
         end
 
         def references source, name
+          if name.end_with?("=")
+            reg = /#{Regexp.escape name[0..-2]}\s*=/
+            extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
+          else
+            extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
+          end
           inner_node_references(name, source.node).map do |n|
-            offset = Position.to_offset(source.code, NodeMethods.get_node_start_position(n))
-            soff = source.code.index(name, offset)
-            eoff = soff + name.length
+            rng = Range.from_node(n)
+            offset = Position.to_offset(source.code, rng.start)
+            soff, eoff = extract_offset[source.code, offset]
             Location.new(
               source.filename,
               Range.new(

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

@@ -71,6 +71,23 @@ module Solargraph
             else
               raise "No idea what to do with #{n}"
             end
+          elsif n.type == :csend
+            if n.children[0].is_a?(::Parser::AST::Node)
+              result.concat generate_links(n.children[0])
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            elsif n.children[0].nil?
+              args = []
+              n.children[2..-1].each do |c|
+                args.push NodeChainer.chain(c)
+              end
+              result.push Chain::QCall.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
+            else
+              raise "No idea what to do with #{n}"
+            end
           elsif n.type == :self
             result.push Chain::Head.new('self')
           elsif n.type == :zsuper

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/legacy/node_processors/block_node.rb

@@ -5,16 +5,36 @@ module Solargraph
     module Legacy
       module NodeProcessors
         class BlockNode < Parser::NodeProcessor::Base
+          include Legacy::NodeMethods
+
           def process
+            location = get_node_location(node)
+            parent = if other_class_eval?
+              Solargraph::Pin::Namespace.new(
+                location: location,
+                type: :class,
+                name: unpack_name(node.children[0].children[0])
+              )
+            else
+              region.closure
+            end
             pins.push Solargraph::Pin::Block.new(
-              location: get_node_location(node),
-              closure: region.closure,
+              location: location,
+              closure: parent,
               receiver: node.children[0],
               comments: comments_for(node),
               scope: region.scope || region.closure.context.scope
             )
             process_children region.update(closure: pins.last)
           end
+
+          private
+
+          def other_class_eval?
+            node.children[0].type == :send &&
+              node.children[0].children[1] == :class_eval &&
+              [:cbase, :const].include?(node.children[0].children[0]&.type)
+          end
         end
       end
     end

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

@@ -29,22 +29,17 @@ module Solargraph
           NodeProcessor.process(source.node, Region.new(source: source))
         end
 
-        # def returns_from node
-        #   return [] unless Parser.is_ast_node?(node)
-        #   if node.type == :SCOPE
-        #     # node.children.select { |n| n.is_a?(RubyVM::AbstractSyntaxTree::Node) }.map { |n| DeepInference.get_return_nodes(n) }.flatten
-        #     DeepInference.get_return_nodes(node.children[2])
-        #   else
-        #     DeepInference.get_return_nodes(node)
-        #   end
-        # end
-
         def references source, name
+          if name.end_with?("=")
+            reg = /#{Regexp.escape name[0..-2]}\s*=/
+            extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
+          else
+            extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
+          end
           inner_node_references(name, source.node).map do |n|
             rng = Range.from_node(n)
             offset = Position.to_offset(source.code, rng.start)
-            soff = source.code.index(name, offset)
-            eoff = soff + name.length
+            soff, eoff = extract_offset[source.code, offset]
             Location.new(
               source.filename,
               Range.new(

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

@@ -60,6 +60,11 @@ module Solargraph
               result.concat generate_links(c)
             end
             result.push Chain::Call.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
+          elsif n.type == :QCALL
+            n.children[0..-3].each do |c|
+              result.concat generate_links(c)
+            end
+            result.push Chain::QCall.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
           elsif n.type == :ATTRASGN
             result.concat generate_links(n.children[0])
             result.push Chain::Call.new(n.children[1].to_s, node_to_argchains(n.children[2]), @in_block > 0 || block_passed?(n))

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/parser/rubyvm/node_processors/block_node.rb

@@ -5,16 +5,36 @@ module Solargraph
     module Rubyvm
       module NodeProcessors
         class BlockNode < Parser::NodeProcessor::Base
+          include NodeMethods
+
           def process
+            location = get_node_location(node)
+            parent = if other_class_eval?
+              Solargraph::Pin::Namespace.new(
+                location: location,
+                type: :class,
+                name: unpack_name(node.children[0].children[0])
+              )
+            else
+              region.closure
+            end
             pins.push Solargraph::Pin::Block.new(
-              location: get_node_location(node),
-              closure: region.closure,
+              location: location,
+              closure: parent,
               receiver: node.children[0],
               comments: comments_for(node),
               scope: region.scope || region.closure.context.scope
             )
             process_children region.update(closure: pins.last)
           end
+
+          private
+
+          def other_class_eval?
+            node.children[0].type == :CALL &&
+              node.children[0].children[1] == :class_eval &&
+              [:COLON2, :CONST].include?(node.children[0].children[0].type)
+          end
         end
       end
     end

data/lib/solargraph/pin/block.rb

@@ -8,9 +8,10 @@ module Solargraph
       # @return [Parser::AST::Node]
       attr_reader :receiver
 
-      def initialize receiver: nil, args: [], **splat
+      def initialize receiver: nil, args: [], context: nil, **splat
         super(**splat)
         @receiver = receiver
+        @context = context
         @parameters = args
       end
 
@@ -44,15 +45,24 @@ module Solargraph
         return nil unless api_map.rebindable_method_names.include?(word)
         chain = Parser.chain(receiver, location.filename)
         locals = api_map.source_map(location.filename).locals_at(location)
-        if ['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec'].include?(chain.links.last.word)
+        links_last_word = chain.links.last.word
+        if %w[instance_eval instance_exec class_eval class_exec module_eval module_exec].include?(links_last_word)
           return chain.base.infer(api_map, self, locals)
-        else
-          receiver_pin = chain.define(api_map, self, locals).first
-          if receiver_pin && receiver_pin.docstring
-            ys = receiver_pin.docstring.tag(:yieldself)
-            if ys && ys.types && !ys.types.empty?
-              return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
-            end
+        end
+        if 'define_method' == links_last_word and chain.define(api_map, self, locals).first&.path == 'Module#define_method' # change class type to instance type
+          if chain.links.size > 1 # Class.define_method
+            ty = chain.base.infer(api_map, self, locals)
+            return Solargraph::ComplexType.parse(ty.namespace)
+          else # define_method without self
+            return Solargraph::ComplexType.parse(closure.binder.namespace)
+          end
+        end
+        # other case without early return, read block yieldself tags
+        receiver_pin = chain.define(api_map, self, locals).first
+        if receiver_pin && receiver_pin.docstring
+          ys = receiver_pin.docstring.tag(:yieldself)
+          if ys && ys.types && !ys.types.empty?
+            return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
           end
         end
         nil

data/lib/solargraph/pin/documenting.rb

@@ -80,7 +80,7 @@ module Solargraph
               end
             end
           end
-          sections.map(&:to_s).join
+          sections.map(&:to_s).join.strip
         end
       end
 

data/lib/solargraph/pin/local_variable.rb

@@ -18,19 +18,7 @@ module Solargraph
         true
       end
 
-      # @param other [Pin::Base] The caller's block
-      # @param position [Position, Array(Integer, Integer)] The caller's position
-      # @return [Boolean]
-      def visible_from?(other, position)
-        position = Position.normalize(position)
-        other.filename == filename &&
-          match_tags(other.full_context.tag, full_context.tag) &&
-          (other == closure ||
-            (closure.location.range.contain?(other.location.range.start) && closure.location.range.contain?(other.location.range.ending))
-          ) &&
-          presence.contain?(position)
-      end
-
+      # @param other_closure [Pin::Closure]
       # @param other_loc [Location]
       def visible_at?(other_closure, other_loc)
         return true if location.filename == other_loc.filename &&
@@ -53,7 +41,7 @@ module Solargraph
       end
 
       def match_named_closure needle, haystack
-        return true if needle == haystack
+        return true if needle == haystack || haystack.is_a?(Pin::Block)
         cursor = haystack
         until cursor.nil?
           return true if needle.path == cursor.path

data/lib/solargraph/pin/namespace.rb

@@ -9,8 +9,8 @@ module Solargraph
       # @return [::Symbol] :class or :module
       attr_reader :type
 
-      # @param type [Symbol] :class or :module
-      # @param visibility [Symbol] :public or :private
+      # @param type [::Symbol] :class or :module
+      # @param visibility [::Symbol] :public or :private
       # @param gates [Array<String>]
       def initialize type: :class, visibility: :public, gates: [''], **splat
         # super(location, namespace, name, comments)

data/lib/solargraph/pin/parameter.rb

@@ -145,10 +145,7 @@ module Solargraph
         # meths.shift # Ignore the first one
         meths.each do |meth|
           found = nil
-          params = meth.docstring.tags(:param)
-          if params.empty?
-            params = see_reference(docstring, api_map)
-          end
+          params = meth.docstring.tags(:param) + see_reference(docstring, api_map)
           params.each do |p|
             next unless p.name == name
             found = p

data/lib/solargraph/source/chain/link.rb

@@ -51,6 +51,10 @@ module Solargraph
           clone.mark_head(false)
         end
 
+        def nullable?
+          false
+        end
+
         protected
 
         # Mark whether this link is the head of a chain

data/lib/solargraph/source/chain/q_call.rb

@@ -0,0 +1,11 @@
+module Solargraph
+  class Source
+    class Chain
+      class QCall < Call
+        def nullable?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/source/chain.rb

@@ -11,6 +11,7 @@ module Solargraph
     class Chain
       autoload :Link,             'solargraph/source/chain/link'
       autoload :Call,             'solargraph/source/chain/call'
+      autoload :QCall,            'solargraph/source/chain/q_call'
       autoload :Variable,         'solargraph/source/chain/variable'
       autoload :ClassVariable,    'solargraph/source/chain/class_variable'
       autoload :Constant,         'solargraph/source/chain/constant'
@@ -76,7 +77,8 @@ module Solargraph
       # @return [ComplexType]
       def infer api_map, name_pin, locals
         pins = define(api_map, name_pin, locals)
-        infer_first_defined(pins, links.last.last_context, api_map)
+        type = infer_first_defined(pins, links.last.last_context, api_map)
+        maybe_nil(type)
       end
 
       # @return [Boolean]
@@ -101,6 +103,10 @@ module Solargraph
         @splat
       end
 
+      def nullable?
+        links.any?(&:nullable?)
+      end
+
       private
 
       # @param pins [Array<Pin::Base>]
@@ -146,6 +152,13 @@ module Solargraph
         return type if context.nil? || context.return_type.undefined?
         type.self_to(context.return_type.namespace)
       end
+
+      # @param type [ComplexType]
+      def maybe_nil type
+        return type if type.undefined? || type.void? || type.nullable?
+        return type unless nullable?
+        ComplexType.try_parse("#{type}, nil")
+      end
     end
   end
 end

data/lib/solargraph/source.rb

@@ -42,7 +42,6 @@ module Solargraph
       @version = version
       @domains = []
       begin
-        # @node, @comments = Source.parse_with_comments(@code, filename)
         @node, @comments = Solargraph::Parser.parse_with_comments(@code, filename)
         @parsed = true
       rescue Parser::SyntaxError, EncodingError => e
@@ -336,7 +335,6 @@ module Solargraph
     # @param parent [Symbol]
     # @return [void]
     def inner_folding_ranges top, result = [], parent = nil
-      # return unless top.is_a?(::Parser::AST::Node)
       return unless Parser.is_ast_node?(top)
       if FOLDING_NODE_TYPES.include?(top.type)
         # @todo Smelly exception for hash's first-level array in RubyVM
@@ -362,7 +360,7 @@ module Solargraph
       skip = nil
       comments.lines.each { |l|
         # Trim the comment and minimum leading whitespace
-        p = l.gsub(/^#+/, '')
+        p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
         if p.strip.empty?
           next unless started
           ctxt.concat p
@@ -433,7 +431,6 @@ module Solargraph
     # @return [void]
     def inner_tree_at node, position, stack
       return if node.nil?
-      # here = Range.from_to(node.loc.expression.line, node.loc.expression.column, node.loc.expression.last_line, node.loc.expression.last_column)
       here = Range.from_node(node)
       if here.contain?(position) || colonized(here, position, node)
         stack.unshift node

data/lib/solargraph/source_map/clip.rb

@@ -53,11 +53,7 @@ module Solargraph
       #
       # @return [Array<Solargraph::Pin::Base>]
       def locals
-        loc_pos = context_pin.location.range.contain?(cursor.position) ? cursor.position : context_pin.location.range.ending
-        adj_pos = Position.new(loc_pos.line, (loc_pos.column.zero? ? 0 : loc_pos.column - 1))
-        @locals ||= source_map.locals.select { |pin|
-          pin.visible_from?(block, adj_pos)
-        }.reverse
+        @locals ||= source_map.locals_at(location)
       end
 
       def gates
@@ -92,6 +88,10 @@ module Solargraph
         @source_map ||= api_map.source_map(cursor.filename)
       end
 
+      def location
+        Location.new(source_map.filename, Solargraph::Range.new(cursor.position, cursor.position))
+      end
+
       # @return [Solargraph::Pin::Base]
       def block
         @block ||= source_map.locate_block_pin(cursor.node_position.line, cursor.node_position.character)

data/lib/solargraph/source_map/mapper.rb

@@ -61,7 +61,7 @@ module Solargraph
       end
 
       def process_comment source_position, comment_position, comment
-        return unless comment =~ MACRO_REGEXP
+        return unless comment.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
         cmnt = remove_inline_comment_hashes(comment)
         parse = Solargraph::Source.parse_docstring(cmnt)
         last_line = 0
@@ -169,7 +169,7 @@ module Solargraph
             # @todo Handle parser errors in !parse directives
           end
         when 'domain'
-          namespace = closure_at(source_position)
+          namespace = closure_at(source_position) || Pin::ROOT_PIN
           namespace.domains.concat directive.tag.types unless directive.tag.types.nil?
         when 'override'
           pins.push Pin::Reference::Override.new(location, directive.tag.name, docstring.tags)
@@ -182,7 +182,7 @@ module Solargraph
         started = false
         comment.lines.each { |l|
           # Trim the comment and minimum leading whitespace
-          p = l.gsub(/^#/, '')
+          p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#/, '')
           if num.nil? && !p.strip.empty?
             num = p.index(/[^ ]/)
             started = true
@@ -197,7 +197,7 @@ module Solargraph
 
       # @return [void]
       def process_comment_directives
-        return unless @code =~ MACRO_REGEXP
+        return unless @code.encode('UTF-8', invalid: :replace, replace: '?') =~ MACRO_REGEXP
         code_lines = @code.lines
         @source.associated_comments.each do |line, comments|
           src_pos = line ? Position.new(line, code_lines[line].to_s.chomp.index(/[^\s]/) || 0) : Position.new(code_lines.length, 0)

data/lib/solargraph/type_checker.rb

@@ -84,12 +84,13 @@ module Solargraph
     # @param pin [Pin::Method]
     # @return [Array<Problem>]
     def method_return_type_problems_for pin
+      return [] if pin.is_a?(Pin::MethodAlias)
       result = []
       declared = pin.typify(api_map).self_to(pin.full_context.namespace)
       if declared.undefined?
         if pin.return_type.undefined? && rules.require_type_tags?
           result.push Problem.new(pin.location, "Missing @return tag for #{pin.path}", pin: pin)
-        elsif pin.return_type.defined?
+        elsif pin.return_type.defined? && !resolved_constant?(pin)
           result.push Problem.new(pin.location, "Unresolved return type #{pin.return_type} for #{pin.path}", pin: pin)
         elsif rules.must_tag_or_infer? && pin.probe(api_map).undefined?
           result.push Problem.new(pin.location, "Untyped method #{pin.path} could not be inferred")
@@ -111,6 +112,15 @@ module Solargraph
       result
     end
 
+    # @todo This is not optimal. A better solution would probably be to mix
+    #   namespace alias into types at the ApiMap level.
+    #
+    # @param pin [Pin::Base]
+    # @return [Boolean]
+    def resolved_constant? pin
+      api_map.get_constants('', pin.binder.tag).any? { |pin| pin.name == pin.return_type.namespace && ['Class', 'Module'].include?(pin.return_type.name) }
+    end
+
     def virtual_pin? pin
       pin.location && source_map.source.comment_at?(pin.location.range.ending)
     end

data/lib/solargraph/version.rb

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

data/lib/solargraph/yard_map.rb

@@ -88,7 +88,7 @@ module Solargraph
       @rebindable_method_names ||= pins_by_class(Pin::Method)
         .select { |pin| pin.comments && pin.comments.include?('@yieldself') }
         .map(&:name)
-        .concat(['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec'])
+        .concat(['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec', 'define_method'])
         .to_set
     end
 

data/solargraph.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'tilt', '~> 2.0'
   s.add_runtime_dependency 'yard', '~> 0.9', '>= 0.9.24'
 
-  s.add_development_dependency 'pry', '~> 0.11.3'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'public_suffix', '~> 3.1'
   s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'
   s.add_development_dependency 'simplecov', '~> 0.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.43.3
+  version: 0.44.3
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-25 00:00:00.000000000 Z
+date: 2022-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -222,16 +222,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -509,6 +510,7 @@ files:
 - lib/solargraph/source/chain/link.rb
 - lib/solargraph/source/chain/literal.rb
 - lib/solargraph/source/chain/or.rb
+- lib/solargraph/source/chain/q_call.rb
 - lib/solargraph/source/chain/variable.rb
 - lib/solargraph/source/chain/z_super.rb
 - lib/solargraph/source/change.rb