solargraph 0.54.2 → 0.54.3

data/lib/solargraph/language_server/host/message_worker.rb

@@ -94,6 +94,9 @@ module Solargraph
         # True if the message requires a previous update to have executed in
         # order to work correctly.
         #
+        # @param msg [Hash{String => Object}]
+        # @todo need boolish type from RBS
+        # @return [Object]
         def version_dependent? msg
           msg['textDocument'] && msg['position']
         end

data/lib/solargraph/language_server/host.rb

@@ -471,6 +471,7 @@ module Solargraph
       def locate_pins params
         return [] unless params['data'] && params['data']['uri']
         library = library_for(params['data']['uri'])
+        # @type [Array<Pin::Base>]
         result = []
         if params['data']['location']
           location = Location.new(
@@ -570,7 +571,7 @@ module Solargraph
       # @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>]
+      # @return [Array<Solargraph::Location>]
       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, only: only)

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

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash{String => Array, Hash, String, Integer}]
+        # @return [Hash{String => Array<undefined>, Hash{String => undefined}, String, Integer}]
         attr_reader :params
 
         # @return [Hash, Array, nil]

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

@@ -174,7 +174,9 @@ module Solargraph
 
         # @param section [String]
         # @param capability [String]
-        # @return [Boolean]
+        # @todo Need support for RBS' boolish "type", which doesn't
+        #   enforce strict true/false-ness
+        # @sg-ignore
         def dynamic_registration_for? section, capability
           result = (params['capabilities'] &&
             params['capabilities'][section] &&

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

@@ -33,6 +33,7 @@ module Solargraph
 
           private
 
+          # @param corrections [String]
           def log_corrections(corrections)
             corrections = corrections&.strip
             return if corrections&.empty?
@@ -51,6 +52,7 @@ module Solargraph
             conf['rubocop'] || {}
           end
 
+          # @param config [Hash{String => String}]
           def cli_args file_uri, config
             file = UriHelpers.uri_to_file(file_uri)
             args = [
@@ -68,6 +70,7 @@ module Solargraph
             args + [file]
           end
 
+          # @param config [Hash{String => String}]
           def formatter_class(config)
             if self.class.const_defined?('BlankRubocopFormatter')
               # @sg-ignore
@@ -79,6 +82,7 @@ module Solargraph
             end
           end
 
+          # @param value [Array, String]
           def cop_list(value)
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)

data/lib/solargraph/library.rb

@@ -240,7 +240,7 @@ module Solargraph
     # @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>]
+    # @return [Array<Solargraph::Location>]
     # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column, strip: false, only: false
       sync_catalog
@@ -398,6 +398,8 @@ module Solargraph
       return [] unless open?(filename)
       result = []
       source = read(filename)
+
+      # @type [Hash{Class<Solargraph::Diagnostics::Base> => Array<String>}]
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'

data/lib/solargraph/location.rb

@@ -5,6 +5,8 @@ module Solargraph
   # and Range.
   #
   class Location
+    include Equality
+
     # @return [String]
     attr_reader :filename
 
@@ -18,6 +20,11 @@ module Solargraph
       @range = range
     end
 
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [filename, range]
+    end
+
     # @param location [self]
     def contain? location
       range.contain?(location.range.start) && range.contain?(location.range.ending) && filename == location.filename

data/lib/solargraph/parser/node_methods.rb

@@ -74,7 +74,7 @@ module Solargraph
 
       # @abstract
       # @param node [Parser::AST::Node]
-      # @return [Hash{Parser::AST::Node => Chain}]
+      # @return [Hash{Parser::AST::Node => Source::Chain}]
       def convert_hash node
         raise NotImplementedError
       end

data/lib/solargraph/parser/node_processor.rb

@@ -9,6 +9,7 @@ module Solargraph
       autoload :Base, 'solargraph/parser/node_processor/base'
 
       class << self
+        # @type [Hash<Symbol, Class<NodeProcessor::Base>>]
         @@processors ||= {}
 
         # Register a processor for a node type.

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

@@ -94,11 +94,11 @@ module Solargraph
           elsif n.type == :lvar
             result.push Chain::Call.new(n.children[0].to_s)
           elsif n.type == :ivar
-             result.push Chain::InstanceVariable.new(n.children[0].to_s)
+            result.push Chain::InstanceVariable.new(n.children[0].to_s)
           elsif n.type == :cvar
-             result.push Chain::ClassVariable.new(n.children[0].to_s)
+            result.push Chain::ClassVariable.new(n.children[0].to_s)
           elsif n.type == :gvar
-             result.push Chain::GlobalVariable.new(n.children[0].to_s)
+            result.push Chain::GlobalVariable.new(n.children[0].to_s)
           elsif n.type == :or_asgn
             # @todo: Need a new Link class here that evaluates the
             #   existing variable type with the RHS, and generates a

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

@@ -12,7 +12,7 @@ require 'ast'
 #     class Node
 #       # New children
 #
-#       # @return [Array<AST::Node>]
+#       # @return [Array<self>]
 #       attr_reader :children
 #     end
 #   end
@@ -462,7 +462,7 @@ module Solargraph
               result
             end
 
-            # @param nodes [Enumerable<Parser::AST::Node, BaseObject>]
+            # @param nodes [Enumerable<Parser::AST::Node, BasicObject>]
             # @return [Array<Parser::AST::Node, nil>]
             def reduce_to_value_nodes nodes
               result = []

data/lib/solargraph/pin/base.rb

@@ -78,7 +78,7 @@ module Solargraph
         !return_type || return_type.all_rooted?
       end
 
-      # @param generics_to_erase [Enumerable<String>]
+      # @param generics_to_erase [::Array<String>]
       # @return [self]
       def erase_generics(generics_to_erase)
         return self if generics_to_erase.empty?
@@ -102,7 +102,7 @@ module Solargraph
       end
 
       def to_s
-        to_rbs
+        desc
       end
 
       # @return [Boolean]
@@ -115,14 +115,6 @@ module Solargraph
         location || type_location
       end
 
-      # Pin equality is determined using the #nearly? method and also
-      # requiring both pins to have the same location.
-      #
-      def == other
-        return false unless nearly? other
-        comments == other.comments and location == other.location
-      end
-
       # True if the specified pin is a near match to this one. A near match
       # indicates that the pins contain mostly the same data. Any differences
       # between them should not have an impact on the API surface.
@@ -139,6 +131,14 @@ module Solargraph
           )
       end
 
+      # Pin equality is determined using the #nearly? method and also
+      # requiring both pins to have the same location.
+      #
+      def == other
+        return false unless nearly? other
+        comments == other.comments && location == other.location
+      end
+
       # The pin's return type.
       #
       # @return [ComplexType]
@@ -265,9 +265,10 @@ module Solargraph
         result
       end
 
+      # @deprecated
       # @return [String]
       def identity
-        @identity ||= "#{closure.path}|#{name}"
+        @identity ||= "#{closure&.path}|#{name}"
       end
 
       # @return [String, nil]
@@ -275,19 +276,29 @@ module Solargraph
         return_type.to_rbs
       end
 
-      # @return [String, nil]
-      def desc
+      # @return [String]
+      def type_desc
+        rbs = to_rbs
+        # RBS doesn't have a way to represent a Class<x> type
+        rbs = return_type.rooted_tags if return_type.name == 'Class'
         if path
-          if to_rbs
-            path + ' ' + to_rbs
+          if rbs
+            path + ' ' + rbs
           else
             path
           end
         else
-          to_rbs
+          rbs
         end
       end
 
+      # @return [String]
+      def desc
+        closure_info = closure&.desc
+        binder_info = binder&.desc
+        "[#{type_desc}, closure=#{closure_info}, binder=#{binder}"
+      end
+
       def inspect
         "#<#{self.class} `#{self.desc}` at #{self.location.inspect}>"
       end

data/lib/solargraph/pin/base_variable.rb

@@ -93,6 +93,7 @@ module Solargraph
         assignment == other.assignment
       end
 
+      # @param pin [self]
       def try_merge! pin
         return false unless super
         @assignment = pin.assignment
@@ -100,8 +101,8 @@ module Solargraph
         true
       end
 
-      def desc
-        "#{to_rbs} = #{assignment&.type.inspect}"
+      def type_desc
+        "#{super} = #{assignment&.type.inspect}"
       end
 
       private

data/lib/solargraph/pin/callable.rb

@@ -3,7 +3,7 @@
 module Solargraph
   module Pin
     class Callable < Closure
-      # @return [self]
+      # @return [Signature]
       attr_reader :block
 
       attr_reader :parameters
@@ -57,7 +57,7 @@ module Solargraph
         callable
       end
 
-      # @param generics_to_resolve [Enumerable<String>]
+      # @param generics_to_resolve [::Array<String>]
       # @param arg_types [Array<ComplexType>, nil]
       # @param return_type_context [ComplexType, nil]
       # @param yield_arg_types [Array<ComplexType>, nil]
@@ -113,7 +113,7 @@ module Solargraph
       end
 
       # @param arguments [::Array<Chain>]
-      # @param signature [Pin::Signature]
+      # @param with_block [Boolean]
       # @return [Boolean]
       def arity_matches? arguments, with_block
         argcount = arguments.length

data/lib/solargraph/pin/method.rb

@@ -31,6 +31,10 @@ module Solargraph
         @anon_splat = anon_splat
       end
 
+      def == other
+        super && other.node == node
+      end
+
       def transform_types(&transform)
         # @todo 'super' alone should work here I think, but doesn't typecheck at level typed
         m = super(&transform)
@@ -262,6 +266,7 @@ module Solargraph
         @attribute
       end
 
+      # @parm other [Method]
       def nearly? other
         super &&
           parameters == other.parameters &&
@@ -273,6 +278,7 @@ module Solargraph
         attribute? ? infer_from_iv(api_map) : infer_from_return_nodes(api_map)
       end
 
+      # @param pin [Pin::Method]
       def try_merge! pin
         return false unless super
         @node = pin.node

data/lib/solargraph/pin/namespace.rb

@@ -48,7 +48,7 @@ module Solargraph
         if name.nil? || name.empty?
           '(top-level)'
         else
-          to_rbs
+          return_type.rooted_tags
         end
       end
 

data/lib/solargraph/pin/parameter.rb

@@ -3,7 +3,7 @@
 module Solargraph
   module Pin
     class Parameter < LocalVariable
-      # @return [Symbol]
+      # @return [::Symbol]
       attr_reader :decl
 
       # @return [String]
@@ -121,6 +121,7 @@ module Solargraph
         tag.text
       end
 
+      # @param pin [Pin::Parameter]
       def try_merge! pin
         return false unless super && closure == pin.closure
         true

data/lib/solargraph/position.rb

@@ -4,6 +4,8 @@ module Solargraph
   # The zero-based line and column numbers of a position in a string.
   #
   class Position
+    include Equality
+
     # @return [Integer]
     attr_reader :line
 
@@ -19,6 +21,11 @@ module Solargraph
       @character = character
     end
 
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [line, character]
+    end
+
     # Get a hash of the position. This representation is suitable for use in
     # the language server protocol.
     #

data/lib/solargraph/range.rb

@@ -4,6 +4,8 @@ module Solargraph
   # A pair of Positions that compose a section of text in code.
   #
   class Range
+    include Equality
+
     # @return [Position]
     attr_reader :start
 
@@ -17,6 +19,11 @@ module Solargraph
       @ending = ending
     end
 
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [start, ending]
+    end
+
     # Get a hash of the range. This representation is suitable for use in
     # the language server protocol.
     #

data/lib/solargraph/rbs_map/conversions.rb

@@ -321,7 +321,7 @@ module Solargraph
       # @return [void]
       def method_def_to_sigs decl, pin
         decl.overloads.map do |overload|
-          generics = overload.method_type.type_params.map(&:to_s)
+          generics = overload.method_type.type_params.map(&:name).map(&:to_s)
           signature_parameters, signature_return_type = parts_of_function(overload.method_type, pin)
           block = if overload.method_type.block
                     block_parameters, block_return_type = parts_of_function(overload.method_type.block, pin)

data/lib/solargraph/rbs_map.rb

@@ -64,6 +64,7 @@ module Solargraph
       @@rbs_maps_hash[library] ||= RbsMap.new(library)
     end
 
+    # @param gemspec [Gem::Specification]
     def self.from_gemspec(gemspec)
       RbsMap.new(gemspec.name, gemspec.version)
     end

data/lib/solargraph/shell.rb

@@ -111,6 +111,7 @@ module Solargraph
       also be specified to clear cached system documentation.
       Documentation will be regenerated as needed.
     )
+    # @param gems [Array<String>]
     # @return [void]
     def uncache *gems
       raise ArgumentError, 'No gems specified.' if gems.empty?
@@ -133,6 +134,7 @@ module Solargraph
 
     desc 'gems [GEM[=VERSION]]', 'Cache documentation for installed gems'
     option :rebuild, type: :boolean, desc: 'Rebuild existing documentation', default: false
+    # @param names [Array<String>]
     # @return [void]
     def gems *names
       if names.empty?

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

@@ -14,7 +14,7 @@ module Solargraph
 
         # @param api_map [ApiMap]
         # @param name_pin [Pin::Base]
-        # @param locals [Enumerable<Pin::LocalVariable>]
+        # @param locals [::Array<Pin::Parameter, Pin::LocalVariable>]
         def resolve api_map, name_pin, locals
           child_types = @children.map do |child|
             child.infer(api_map, name_pin, locals)

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

@@ -25,6 +25,11 @@ module Solargraph
           fix_block_pass
         end
 
+        # @sg-ignore Fix "Not enough arguments to Module#protected"
+        protected def equality_fields
+          super + [arguments, block]
+        end
+
         def with_block?
           !!@block
         end
@@ -54,7 +59,7 @@ module Solargraph
         # @param pins [::Enumerable<Pin::Method>]
         # @param api_map [ApiMap]
         # @param name_pin [Pin::Base]
-        # @param locals [::Array<Pin::LocalVariable>]
+        # @param locals [::Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
         # @return [::Array<Pin::Base>]
         def inferred_pins pins, api_map, name_pin, locals
           result = pins.map do |p|
@@ -134,7 +139,7 @@ module Solargraph
         # @param pin [Pin::Base]
         # @param api_map [ApiMap]
         # @param context [ComplexType]
-        # @param locals [Enumerable<Pin::Base>]
+        # @param locals [::Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
         # @return [Pin::Base]
         def process_macro pin, api_map, context, locals
           pin.macros.each do |macro|
@@ -153,7 +158,7 @@ module Solargraph
         # @param pin [Pin::Method]
         # @param api_map [ApiMap]
         # @param context [ComplexType]
-        # @param locals [Enumerable<Pin::Base>]
+        # @param locals [::Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
         # @return [Pin::ProxyType]
         def process_directive pin, api_map, context, locals
           pin.directives.each do |dir|
@@ -169,7 +174,7 @@ module Solargraph
         # @param macro [YARD::Tags::MacroDirective]
         # @param api_map [ApiMap]
         # @param context [ComplexType]
-        # @param locals [Enumerable<Pin::Base>]
+        # @param locals [::Array<Pin::LocalVariable, Pin::Parameter>]
         # @return [Pin::ProxyType]
         def inner_process_macro pin, macro, api_map, context, locals
           vals = arguments.map{ |c| Pin::ProxyType.anonymous(c.infer(api_map, pin, locals)) }

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

@@ -11,6 +11,11 @@ module Solargraph
           @splatted = splatted
         end
 
+        # @sg-ignore Fix "Not enough arguments to Module#protected"
+        protected def equality_fields
+          super + [@splatted]
+        end
+
         def word
           @word ||= "<#{@type}>"
         end

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

@@ -13,6 +13,11 @@ module Solargraph
           @links = links
         end
 
+        # @sg-ignore Fix "Not enough arguments to Module#protected"
+        protected def equality_fields
+          super + [@links]
+        end
+
         def resolve api_map, name_pin, locals
           types = @links.map { |link| link.infer(api_map, name_pin, locals) }
           [Solargraph::Pin::ProxyType.anonymous(Solargraph::ComplexType.try_parse(types.map(&:tag).uniq.join(', ')))]

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

@@ -4,6 +4,8 @@ module Solargraph
   class Source
     class Chain
       class Link
+        include Equality
+
         # @return [String]
         attr_reader :word
 
@@ -15,6 +17,11 @@ module Solargraph
           @word = word
         end
 
+        # @sg-ignore Fix "Not enough arguments to Module#protected"
+        protected def equality_fields
+          [self.class, word]
+        end
+
         def undefined?
           word == '<undefined>'
         end
@@ -31,18 +38,23 @@ module Solargraph
           []
         end
 
+        # debugging description of contents; not for machine use
+        def desc
+          word
+        end
+
+        def to_s
+          desc
+        end
+
         def inspect
-          "#{self.class} #{word}"
+          "#<#{self.class} - `#{self.desc}`>"
         end
 
         def head?
           @head ||= false
         end
 
-        def == other
-          self.class == other.class and word == other.word
-        end
-
         # Make a copy of this link marked as the head of a chain
         #
         # @return [self]

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

@@ -14,6 +14,11 @@ module Solargraph
           @complex_type = ComplexType.try_parse(type)
         end
 
+        # @sg-ignore Fix "Not enough arguments to Module#protected"
+        protected def equality_fields
+          super + [@value, @type, @literal_type, @complex_type]
+        end
+
         def resolve api_map, name_pin, locals
           [Pin::ProxyType.anonymous(@complex_type)]
         end