solargraph 0.58.2 → 0.59.0.dev.2

data/lib/solargraph/pin/callable.rb

@@ -14,6 +14,7 @@ module Solargraph
       # @param block [Signature, nil]
       # @param return_type [ComplexType, nil]
       # @param parameters [::Array<Pin::Parameter>]
+      # @param [Hash{Symbol => Object}] splat
       def initialize block: nil, return_type: nil, parameters: [], **splat
         super(**splat)
         @block = block
@@ -21,15 +22,22 @@ module Solargraph
         @parameters = parameters
       end
 
+      def reset_generated!
+        parameters.each(&:reset_generated!)
+        super
+      end
+
+      # @sg-ignore Need to add nil check here
       # @return [String]
       def method_namespace
+        # @sg-ignore Need to add nil check here
         closure.namespace
       end
 
       # @param other [self]
       #
       # @return [Pin::Signature, nil]
-      def combine_blocks(other)
+      def combine_blocks other
         if block.nil?
           other.block
         elsif other.block.nil?
@@ -44,10 +52,10 @@ module Solargraph
       # @param attrs [Hash{Symbol => Object}]
       #
       # @return [self]
-      def combine_with(other, attrs={})
+      def combine_with other, attrs = {}
         new_attrs = {
           block: combine_blocks(other),
-          return_type: combine_return_type(other),
+          return_type: combine_return_type(other)
         }.merge(attrs)
         new_attrs[:parameters] = choose_parameters(other).clone.freeze unless new_attrs.key?(:parameters)
         super(other, new_attrs)
@@ -65,8 +73,10 @@ module Solargraph
       # @param other [self]
       #
       # @return [Array<Pin::Parameter>]
-      def choose_parameters(other)
-        raise "Trying to combine two pins with different arities - \nself =#{inspect}, \nother=#{other.inspect}, \n\n self.arity=#{self.arity}, \nother.arity=#{other.arity}" if other.arity != arity
+      def choose_parameters other
+        if other.arity != arity
+          raise "Trying to combine two pins with different arities - \nself =#{inspect}, \nother=#{other.inspect}, \n\n self.arity=#{arity}, \nother.arity=#{other.arity}"
+        end
         # @param param [Pin::Parameter]
         # @param other_param [Pin::Parameter]
         parameters.zip(other.parameters).map do |param, other_param|
@@ -80,6 +90,7 @@ module Solargraph
         end
       end
 
+      # @sg-ignore Need to add nil check here
       # @return [Array<Pin::Parameter>]
       def blockless_parameters
         if parameters.last&.block?
@@ -89,25 +100,47 @@ module Solargraph
         end
       end
 
-      # @return [Array]
+      # e.g., [["T"], "", "?", "foo:"] - parameter arity declarations,
+      #   ignoring positional names.  Used to match signatures.
+      #
+      # @return [Array<Array<String>, String, nil>]
       def arity
         [generics, blockless_parameters.map(&:arity_decl), block&.arity]
       end
 
+      # e.g., [["T"], "1", "?3", "foo:5"] - parameter arity
+      #   declarations, including the number of unique types in each
+      #   parameter.  Used to determine whether combining two
+      #   signatures has lost useful information mapping specific
+      #   parameter types to specific return types.
+      #
+      # @return [Array<Array, String, nil>]
+      def type_arity
+        [generics, blockless_parameters.map(&:type_arity_decl), block&.type_arity]
+      end
+
+      # Same as type_arity, but includes return type arity at the front.
+      #
+      # @return [Array<Array, String, nil>]
+      def full_type_arity
+        # @sg-ignore flow sensitive typing needs to handle attrs
+        [return_type ? return_type.items.count.to_s : nil] + type_arity
+      end
+
       # @param generics_to_resolve [Enumerable<String>]
       # @param arg_types [Array<ComplexType>, nil]
       # @param return_type_context [ComplexType, nil]
       # @param yield_arg_types [Array<ComplexType>, nil]
       # @param yield_return_type_context [ComplexType, nil]
-      # @param context [ComplexType, nil]
       # @param resolved_generic_values [Hash{String => ComplexType}]
+      #
       # @return [self]
-      def resolve_generics_from_context(generics_to_resolve,
+      def resolve_generics_from_context generics_to_resolve,
                                         arg_types = nil,
                                         return_type_context = nil,
                                         yield_arg_types = nil,
                                         yield_return_type_context = nil,
-                                        resolved_generic_values: {})
+                                        resolved_generic_values: {}
         callable = super(generics_to_resolve, return_type_context, resolved_generic_values: resolved_generic_values)
         callable.parameters = callable.parameters.each_with_index.map do |param, i|
           if arg_types.nil?
@@ -118,10 +151,12 @@ module Solargraph
                                                 resolved_generic_values: resolved_generic_values)
           end
         end
-        callable.block = block.resolve_generics_from_context(generics_to_resolve,
-                                                              yield_arg_types,
-                                                              yield_return_type_context,
-                                                              resolved_generic_values: resolved_generic_values) if callable.block?
+        if callable.block?
+          callable.block = block.resolve_generics_from_context(generics_to_resolve,
+                                                               yield_arg_types,
+                                                               yield_return_type_context,
+                                                               resolved_generic_values: resolved_generic_values)
+        end
         callable
       end
 
@@ -137,9 +172,11 @@ module Solargraph
         end
       end
 
+      # @sg-ignore Need to add nil check here
       # @return [String]
       def method_name
-        raise "closure was nil in #{self.inspect}" if closure.nil?
+        raise "closure was nil in #{inspect}" if closure.nil?
+        # @sg-ignore Need to add nil check here
         @method_name ||= closure.name
       end
 
@@ -148,15 +185,15 @@ module Solargraph
       # @param return_type_context [ComplexType, nil]
       # @param yield_arg_types [Array<ComplexType>, nil]
       # @param yield_return_type_context [ComplexType, nil]
-      # @param context [ComplexType, nil]
       # @param resolved_generic_values [Hash{String => ComplexType}]
+      #
       # @return [self]
-      def resolve_generics_from_context_until_complete(generics_to_resolve,
+      def resolve_generics_from_context_until_complete generics_to_resolve,
                                                        arg_types = nil,
                                                        return_type_context = nil,
                                                        yield_arg_types = nil,
                                                        yield_return_type_context = nil,
-                                                       resolved_generic_values: {})
+                                                       resolved_generic_values: {}
         # See
         # https://github.com/soutaro/steep/tree/master/lib/steep/type_inference
         # and
@@ -174,7 +211,7 @@ module Solargraph
                                                 resolved_generic_values: resolved_generic_values)
         if last_resolved_generic_values == resolved_generic_values
           # erase anything unresolved
-          return new_pin.erase_generics(self.generics)
+          return new_pin.erase_generics(generics)
         end
         new_pin.resolve_generics_from_context_until_complete(generics_to_resolve,
                                                              arg_types,
@@ -184,11 +221,10 @@ module Solargraph
                                                              resolved_generic_values: resolved_generic_values)
       end
 
-      # @return [Array<String>]
       # @yieldparam [ComplexType]
       # @yieldreturn [ComplexType]
       # @return [self]
-      def transform_types(&transform)
+      def transform_types &transform
         # @todo 'super' alone should work here I think, but doesn't typecheck at level typed
         callable = super(&transform)
         callable.block = block.transform_types(&transform) if block?
@@ -206,6 +242,9 @@ module Solargraph
         parcount = mandatory_positional_param_count
         parcount -= 1 if !parameters.empty? && parameters.last.block?
         return false if block? && !with_block
+        # @todo this and its caller should be changed so that this can
+        #   look at the kwargs provided and check names against what
+        #   we acccept
         return false if argcount < parcount && !(argcount == parcount - 1 && parameters.last.restarg?)
         true
       end
@@ -215,8 +254,13 @@ module Solargraph
         parameters.count(&:arg?)
       end
 
+      # @return [String]
+      def parameters_to_rbs
+        "#{rbs_generics}(#{parameters.map(&:to_rbs).join(', ')}) #{"{ #{block.to_rbs} } " unless block.nil?}"
+      end
+
       def to_rbs
-        rbs_generics + '(' + parameters.map { |param| param.to_rbs }.join(', ') + ') ' + (block.nil? ? '' : '{ ' + block.to_rbs + ' } ') + '-> ' + return_type.to_rbs
+        "#{parameters_to_rbs}-> #{return_type&.to_rbs || 'untyped'}"
       end
 
       def block?

data/lib/solargraph/pin/closure.rb

@@ -2,14 +2,15 @@
 
 module Solargraph
   module Pin
-    class Closure < Base
+    class Closure < CompoundStatement
       # @return [::Symbol] :class or :instance
       attr_reader :scope
 
       # @param scope [::Symbol] :class or :instance
-      # @param generics [::Array<Pin::Parameter>, nil]
+      # @param generics [::Array<Pin::String>, nil]
       # @param generic_defaults [Hash{String => ComplexType}]
-      def initialize scope: :class, generics: nil, generic_defaults: {},  **splat
+      # @param [Hash{Symbol => Object}] splat
+      def initialize scope: :class, generics: nil, generic_defaults: {}, **splat
         super(**splat)
         @scope = scope
         @generics = generics
@@ -25,10 +26,10 @@ module Solargraph
       # @param attrs [Hash{Symbol => Object}]
       #
       # @return [self]
-      def combine_with(other, attrs={})
+      def combine_with other, attrs = {}
         new_attrs = {
           scope: assert_same(other, :scope),
-          generics: generics.empty? ? other.generics : generics,
+          generics: generics.empty? ? other.generics : generics
         }.merge(attrs)
         super(other, new_attrs)
       end
@@ -44,10 +45,6 @@ module Solargraph
         end
       end
 
-      def binder
-        @binder || context
-      end
-
       # @param api_map [Solargraph::ApiMap]
       # @return [void]
       def rebind api_map; end
@@ -65,7 +62,7 @@ module Solargraph
       def rbs_generics
         return '' if generics.empty?
 
-        '[' + generics.map { |gen| gen.to_s }.join(', ') + '] '
+        "[#{generics.map(&:to_s).join(', ')}] "
       end
     end
   end

data/lib/solargraph/pin/common.rb

@@ -6,15 +6,30 @@ module Solargraph
       # @!method source
       #   @abstract
       #   @return [Source, nil]
+      # @!method reset_generated!
+      #   @abstract
+      #   @return [void]
       # @type @closure [Pin::Closure, nil]
+      # @type @binder [ComplexType, ComplexType::UniqueType, nil]
+
+      # @todo Missed nil violation
+      # @return [Location, nil]
+      attr_accessor :location
 
-      # @return [Location]
-      attr_reader :location
+      # @param value [Pin::Closure]
+      # @return [void]
+      def closure= value
+        @closure = value
+        # remove cached values generated from closure
+        reset_generated!
+      end
 
-      # @sg-ignore Solargraph::Pin::Common#closure return type could not be inferred
       # @return [Pin::Closure, nil]
       def closure
-        Solargraph.assert_or_log(:closure, "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}") unless @closure
+        unless @closure
+          Solargraph.assert_or_log(:closure,
+                                   "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}")
+        end
         @closure
       end
 
@@ -23,12 +38,13 @@ module Solargraph
         @name ||= ''
       end
 
+      # @todo redundant with Base#return_type?
       # @return [ComplexType]
       def return_type
         @return_type ||= ComplexType::UNDEFINED
       end
 
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def context
         # Get the static context from the nearest namespace
         @context ||= find_context
@@ -40,7 +56,8 @@ module Solargraph
         context.namespace.to_s
       end
 
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
+      # @sg-ignore https://github.com/castwide/solargraph/pull/1100
       def binder
         @binder || context
       end
@@ -70,6 +87,7 @@ module Solargraph
           elsif here.is_a?(Pin::Method)
             return here.context
           end
+          # @sg-ignore Need to add nil check here
           here = here.closure
         end
         ComplexType::ROOT

data/lib/solargraph/pin/compound_statement.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # A series of statements where if a given statement executes, /all
+    # of the previous statements in the sequence must have executed as
+    # well/.  In other words, the statements are run from the top in
+    # sequence, until interrupted by something like a
+    # return/break/next/raise/etc.
+    #
+    # This mix-in is used in flow sensitive typing to determine how
+    # far we can assume a given assertion about a type can be trusted
+    # to be true.
+    #
+    # Some examples in Ruby:
+    #
+    # * Bodies of methods and Ruby blocks
+    # * Branches of conditionals and loops - if/elsif/else,
+    #   unless/else, when, until, ||=, ?:, switch/case/else
+    # * The body of begin-end/try/rescue/ensure statements
+    #
+    # Compare/contrast with:
+    #
+    # * Scope - a sequence where variables declared are not available
+    #   after the end of the scope.  Note that this is not necessarily
+    #   true for a compound statement.
+    # * Compound statement - synonym
+    # * Block - in Ruby this has a special meaning (a closure passed to a method), but
+    #   in general parlance this is also a synonym.
+    # * Closure - a sequence which is also a scope
+    # * Namespace - a named sequence which is also a scope and a
+    #   closure
+    #
+    # See:
+    #   https://cse.buffalo.edu/~regan/cse305/RubyBNF.pdf
+    #   https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html
+    #   https://en.wikipedia.org/wiki/Block_(programming)
+    #
+    # Note:
+    #
+    # Just because statement #1 in a sequence is executed, it doesn't
+    # mean that future ones will.  Consider the effect of
+    # break/next/return/raise/etc. on control flow.
+    class CompoundStatement < Pin::Base
+      attr_reader :node
+
+      # @param node [Parser::AST::Node, nil]
+      # @param [Hash{Symbol => Object}] splat
+      def initialize node: nil, **splat
+        super(**splat)
+        @node = node
+      end
+    end
+  end
+end

data/lib/solargraph/pin/constant.rb

@@ -1,45 +1,43 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Constant < BaseVariable
-      attr_reader :visibility
-
-      # @param visibility [::Symbol] The visibility of the constant (:public, :protected, or :private)
-      # @param splat [Hash] Additional options supported by superclasses
-      def initialize visibility: :public, **splat
-        super(**splat)
-        @visibility = visibility
-      end
-
-      def return_type
-        @return_type ||= generate_complex_type
-      end
-
-      def completion_item_kind
-        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
-      end
-
-      # @return [Integer]
-      def symbol_kind
-        LanguageServer::SymbolKinds::CONSTANT
-      end
-
-      def path
-        @path ||= context.namespace.to_s.empty? ? name : "#{context.namespace}::#{name}"
-      end
-
-      private
-
-      # @return [ComplexType]
-      def generate_complex_type
-        tags = docstring.tags(:return).map(&:types).flatten.reject(&:nil?)
-        if tags.empty?
-          tags = docstring.tags(:type).map(&:types).flatten.reject(&:nil?)
-        end
-        return ComplexType::UNDEFINED if tags.empty?
-        ComplexType.try_parse *tags
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Constant < BaseVariable
+      attr_reader :visibility
+
+      # @param visibility [::Symbol] The visibility of the constant (:public, :protected, or :private)
+      # @param splat [Hash] Additional options supported by superclasses
+      def initialize visibility: :public, **splat
+        super(**splat)
+        @visibility = visibility
+      end
+
+      def return_type
+        @return_type ||= generate_complex_type
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
+      end
+
+      # @return [Integer]
+      def symbol_kind
+        LanguageServer::SymbolKinds::CONSTANT
+      end
+
+      def path
+        @path ||= context.namespace.to_s.empty? ? name : "#{context.namespace}::#{name}"
+      end
+
+      private
+
+      # @return [ComplexType]
+      def generate_complex_type
+        tags = docstring.tags(:return).map(&:types).flatten.compact
+        tags = docstring.tags(:type).map(&:types).flatten.compact if tags.empty?
+        return ComplexType::UNDEFINED if tags.empty?
+        ComplexType.try_parse(*tags)
+      end
+    end
+  end
+end

data/lib/solargraph/pin/conversions.rb

@@ -43,7 +43,7 @@ module Solargraph
           data: {
             path: path,
             return_type: return_type.tag,
-            location: (location ? location.to_hash : nil),
+            location: location&.to_hash,
             deprecated: deprecated?
           }
         }
@@ -72,7 +72,13 @@ module Solargraph
         # This property is not cached in an instance variable because it can
         # change when pins get proxied.
         detail = String.new
-        detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
+        unless return_type.undefined?
+          detail += "=#{if probed?
+                          '~'
+                        else
+                          (proxied? ? '^' : '>')
+                        end} #{return_type}"
+        end
         detail.strip!
         return nil if detail.empty?
         detail
@@ -80,7 +86,7 @@ module Solargraph
 
       # Get a markdown-flavored link to a documentation page.
       #
-      # @return [String]
+      # @return [String, nil]
       def link_documentation
         @link_documentation ||= generate_link
       end
@@ -116,7 +122,7 @@ module Solargraph
       # @return [String]
       def escape_brackets text
         # text.gsub(/(\<|\>)/, "\\#{$1}")
-        text.gsub("<", '\<').gsub(">", '\>')
+        text.gsub('<', '\<').gsub('>', '\>')
       end
     end
   end

data/lib/solargraph/pin/delegated_method.rb

@@ -13,10 +13,12 @@ module Solargraph
       #
       # @param method [Method, nil] an already resolved method pin.
       # @param receiver [Source::Chain, nil] the source code used to resolve the receiver for this delegated method.
-      # @param name [String]
-      # @param receiver_method_name [String] the method name that will be called on the receiver (defaults to :name).
+      # @param name [String, nil]
+      # @param receiver_method_name [String, nil] the method name that will be called on the receiver (defaults to :name).
+      # @param [Hash{Symbol => Object}] splat
       def initialize(method: nil, receiver: nil, name: method&.name, receiver_method_name: name, **splat)
         raise ArgumentError, 'either :method or :receiver is required' if (method && receiver) || (!method && !receiver)
+        # @sg-ignore Need to add nil check here
         super(name: name, **splat)
 
         @receiver_chain = receiver
@@ -34,7 +36,6 @@ module Solargraph
         @resolved_method&.send(:location)
       end
 
-
       def type_location
         return super if super
 
@@ -58,7 +59,7 @@ module Solargraph
       end
 
       # @param api_map [ApiMap]
-      def resolvable?(api_map)
+      def resolvable? api_map
         resolve_method(api_map)
         !!@resolved_method
       end
@@ -69,30 +70,40 @@ module Solargraph
       #
       # @param api_map [ApiMap]
       # @return [Pin::Method, nil]
+      # @sg-ignore Declared return type ::Solargraph::Pin::Method, nil
+      #   does not match inferred type nil, false for
+      #   Solargraph::Pin::DelegatedMethod#resolve_method
       def resolve_method api_map
         return if @resolved_method
 
+        # @sg-ignore Need to add nil check here
         resolver = @receiver_chain.define(api_map, self, []).first
 
         unless resolver
-          Solargraph.logger.warn \
-            "Delegated receiver for #{path} was resolved to nil from `#{print_chain(@receiver_chain)}'"
+          # @sg-ignore Need to add nil check here
+          Solargraph.logger.warn "Delegated receiver for #{path} was resolved to nil from `#{print_chain(@receiver_chain)}'"
           return
         end
 
+        # @sg-ignore Need to add nil check here
         receiver_type = resolver.return_type
 
+        # @sg-ignore Need to add nil check here
         return if receiver_type.undefined?
 
         receiver_path, method_scope =
+          # @sg-ignore Need to add nil check here
           if @receiver_chain.constant?
             # HACK: the `return_type` of a constant is Class<Whatever>, but looking up a method expects
             # the arguments `"Whatever"` and `scope: :class`.
+            # @sg-ignore Need to add nil check here
             [receiver_type.to_s.sub(/^Class<(.+)>$/, '\1'), :class]
           else
+            # @sg-ignore Need to add nil check here
             [receiver_type.to_s, :instance]
           end
 
+        # @sg-ignore Need to add nil check here
         method_stack = api_map.get_method_stack(receiver_path, @receiver_method_name, scope: method_scope)
         @resolved_method = method_stack.first
       end
@@ -101,10 +112,10 @@ module Solargraph
       #
       # @param chain [Source::Chain]
       # @return [String]
-      def print_chain(chain)
+      def print_chain chain
         out = +''
         chain.links.each_with_index do |link, index|
-          if index > 0
+          if index.positive?
             if Source::Chain::Constant
               out << '::' unless link.word.start_with?('::')
             else

data/lib/solargraph/pin/documenting.rb

@@ -62,7 +62,7 @@ module Solargraph
 
         # @return [String]
         def to_code
-          "\n```ruby\n#{Documenting.normalize_indentation(@plaintext)}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n"
+          "\n```ruby\n#{Documenting.normalize_indentation(@plaintext)}#{"\n" unless @plaintext.end_with?("\n")}```\n\n"
         end
 
         # @return [String]
@@ -78,7 +78,8 @@ module Solargraph
           # line and at least two spaces of indentation. This is a common
           # convention in Ruby core documentation, e.g., String#split.
           sections = [DocSection.new(false)]
-          Documenting.normalize_indentation(Documenting.strip_html_comments(docstring.to_s.gsub("\t", '  '))).lines.each do |l|
+          Documenting.normalize_indentation(Documenting.strip_html_comments(docstring.to_s.gsub("\t",
+                                                                                                '  '))).lines.each do |l|
             if l.start_with?('  ')
               # Code block
               sections.push DocSection.new(true) unless sections.last.code?
@@ -104,6 +105,7 @@ module Solargraph
         left = text.lines.map do |line|
           match = line.match(/^ +/)
           next 0 unless match
+          # @sg-ignore Need to add nil check here
           match[0].length
         end.min
         return text if left.nil? || left.zero?

data/lib/solargraph/pin/instance_variable.rb

@@ -3,13 +3,17 @@
 module Solargraph
   module Pin
     class InstanceVariable < BaseVariable
-      # @return [ComplexType]
+      # @sg-ignore Need to add nil check here
+      # @return [ComplexType, ComplexType::UniqueType]
       def binder
+        # @sg-ignore Need to add nil check here
         closure.binder
       end
 
+      # @sg-ignore Need to add nil check here
       # @return [::Symbol]
       def scope
+        # @sg-ignore Need to add nil check here
         closure.binder.scope
       end
 

data/lib/solargraph/pin/keyword.rb

@@ -11,10 +11,6 @@ module Solargraph
       def closure
         @closure ||= Pin::ROOT_PIN
       end
-
-      def name
-        @name
-      end
     end
   end
 end