solargraph 0.58.2 → 0.59.0.dev.1

data/lib/solargraph/pin/parameter.rb

@@ -30,12 +30,29 @@ module Solargraph
       end
 
       def combine_with(other, attrs={})
-        new_attrs = {
-          decl: assert_same(other, :decl),
-          presence: choose(other, :presence),
-          asgn_code: choose(other, :asgn_code),
-        }.merge(attrs)
-        super(other, new_attrs)
+        # Parameters can be combined with local variables
+        new_attrs = if other.is_a?(Parameter)
+                      {
+                        decl: assert_same(other, :decl),
+                        asgn_code: choose(other, :asgn_code)
+                      }
+                    else
+                      {
+                        decl: decl,
+                        asgn_code: asgn_code
+                      }
+                    end
+        super(other, new_attrs.merge(attrs))
+      end
+
+      def combine_return_type(other)
+        out = super
+        if out&.undefined?
+          # allow our return_type method to provide a better type
+          # using :param tag
+          out = nil
+        end
+        out
       end
 
       def keyword?
@@ -43,6 +60,7 @@ module Solargraph
       end
 
       def kwrestarg?
+        # @sg-ignore flow sensitive typing needs to handle attrs
         decl == :kwrestarg || (assignment && [:HASH, :hash].include?(assignment.type))
       end
 
@@ -72,6 +90,11 @@ module Solargraph
         end
       end
 
+      # @return [String]
+      def type_arity_decl
+        arity_decl + return_type.items.count.to_s
+      end
+
       def arg?
         decl == :arg
       end
@@ -80,6 +103,14 @@ module Solargraph
         decl == :restarg
       end
 
+      def mandatory_positional?
+        decl == :arg
+      end
+
+      def positional?
+        !keyword?
+      end
+
       def rest?
         decl == :restarg || decl == :kwrestarg
       end
@@ -123,6 +154,11 @@ module Solargraph
         end
       end
 
+      def reset_generated!
+        @return_type = nil if param_tag
+        super
+      end
+
       # @return [String]
       def full
         full_name + case decl
@@ -135,12 +171,14 @@ module Solargraph
                     end
       end
 
+      # @sg-ignore super always sets @return_type to something
       # @return [ComplexType]
       def return_type
         if @return_type.nil?
           @return_type = ComplexType::UNDEFINED
           found = param_tag
           @return_type = ComplexType.try_parse(*found.types) unless found.nil? or found.types.nil?
+          # @sg-ignore flow sensitive typing should be able to handle redefinition
           if @return_type.undefined?
             if decl == :restarg
               @return_type = ComplexType.try_parse('::Array')
@@ -152,22 +190,29 @@ module Solargraph
           end
         end
         super
-        @return_type
       end
 
       # The parameter's zero-based location in the block's signature.
       #
+      # @sg-ignore Need to add nil check here
       # @return [Integer]
       def index
-        # @type [Method, Block]
         method_pin = closure
+        # @sg-ignore Need to add nil check here
         method_pin.parameter_names.index(name)
       end
 
       # @param api_map [ApiMap]
       def typify api_map
-        return return_type.qualify(api_map, *closure.gates) unless return_type.undefined?
-        closure.is_a?(Pin::Block) ? typify_block_param(api_map) : typify_method_param(api_map)
+        new_type = super
+        return new_type if new_type.defined?
+
+        # sniff based on param tags
+        new_type = closure.is_a?(Pin::Block) ? typify_block_param(api_map) : typify_method_param(api_map)
+
+        return adjust_type api_map, new_type.self_to_type(full_context) if new_type.defined?
+
+        adjust_type api_map, super.self_to_type(full_context)
       end
 
       # @param atype [ComplexType]
@@ -176,9 +221,16 @@ module Solargraph
         # make sure we get types from up the method
         # inheritance chain if we don't have them on this pin
         ptype = typify api_map
-        ptype.undefined? || ptype.can_assign?(api_map, atype) || ptype.generic?
+        return true if ptype.undefined?
+
+        return true if atype.conforms_to?(api_map,
+                                          ptype,
+                                          :method_call,
+                                          [:allow_empty_params, :allow_undefined])
+        ptype.generic?
       end
 
+      # @sg-ignore flow sensitive typing needs to handle attrs
       def documentation
         tag = param_tag
         return '' if tag.nil? || tag.text.nil?
@@ -187,12 +239,19 @@ module Solargraph
 
       private
 
+      def generate_complex_type
+        nil
+      end
+
       # @return [YARD::Tags::Tag, nil]
       def param_tag
+        # @sg-ignore Need to add nil check here
         params = closure.docstring.tags(:param)
+        # @sg-ignore Need to add nil check here
         params.each do |p|
           return p if p.name == name
         end
+        # @sg-ignore Need to add nil check here
         params[index] if index && params[index] && (params[index].name.nil? || params[index].name.empty?)
       end
 
@@ -200,7 +259,7 @@ module Solargraph
       # @return [ComplexType]
       def typify_block_param api_map
         block_pin = closure
-        if block_pin.is_a?(Pin::Block) && block_pin.receiver
+        if block_pin.is_a?(Pin::Block) && block_pin.receiver && index
           return block_pin.typify_parameters(api_map)[index]
         end
         ComplexType::UNDEFINED
@@ -209,6 +268,7 @@ module Solargraph
       # @param api_map [ApiMap]
       # @return [ComplexType]
       def typify_method_param api_map
+        # @sg-ignore Need to add nil check here
         meths = api_map.get_method_stack(closure.full_context.tag, closure.name, scope: closure.scope)
         # meths.shift # Ignore the first one
         meths.each do |meth|
@@ -222,6 +282,7 @@ module Solargraph
           if found.nil? and !index.nil?
             found = params[index] if params[index] && (params[index].name.nil? || params[index].name.empty?)
           end
+          # @sg-ignore Need to add nil check here
           return ComplexType.try_parse(*found.types).qualify(api_map, *meth.closure.gates) unless found.nil? || found.types.nil?
         end
         ComplexType::UNDEFINED
@@ -230,6 +291,7 @@ module Solargraph
       # @param heredoc [YARD::Docstring]
       # @param api_map [ApiMap]
       # @param skip [::Array]
+      #
       # @return [::Array<YARD::Tags::Tag>]
       def see_reference heredoc, api_map, skip = []
         # This should actually be an intersection type
@@ -237,7 +299,7 @@ module Solargraph
         heredoc.ref_tags.each do |ref|
           # @sg-ignore ref should actually be an intersection type
           next unless ref.tag_name == 'param' && ref.owner
-          # @sg-ignore ref should actually be an intersection type
+          # @todo ref should actually be an intersection type
           result = resolve_reference(ref.owner.to_s, api_map, skip)
           return result unless result.nil?
         end
@@ -257,6 +319,7 @@ module Solargraph
         else
           fqns = api_map.qualify(parts.first, namespace)
           return nil if fqns.nil?
+          # @sg-ignore Need to add nil check here
           path = fqns + ref[parts.first.length] + parts.last
         end
         pins = api_map.get_path_pins(path)

data/lib/solargraph/pin/proxy_type.rb

@@ -3,7 +3,7 @@
 module Solargraph
   module Pin
     class ProxyType < Base
-      # @param return_type [ComplexType]
+      # @param return_type [ComplexType, ComplexType::UniqueType]
       # @param gates [Array<String>, nil] Namespaces to try while resolving non-rooted types
       # @param binder [ComplexType, ComplexType::UniqueType, nil]
       # @param gates [Array<String>, nil]
@@ -25,6 +25,7 @@ module Solargraph
       def self.anonymous context, closure: nil, binder: nil, **kwargs
         unless closure
           parts = context.namespace.split('::')
+          # @sg-ignore Need to add nil check here
           namespace = parts[0..-2].join('::').to_s
           closure = Solargraph::Pin::Namespace.new(name: namespace, source: :proxy_type)
         end

data/lib/solargraph/pin/reference/override.rb

@@ -7,7 +7,7 @@ module Solargraph
         # @return [::Array<YARD::Tags::Tag>]
         attr_reader :tags
 
-        # @return [::Array<Symbol>]
+        # @return [::Array<::Symbol>]
         attr_reader :delete
 
         def closure

data/lib/solargraph/pin/reference/superclass.rb

@@ -6,7 +6,9 @@ module Solargraph
       # A Superclass reference pin.
       #
       class Superclass < Reference
+        # @sg-ignore Need to add nil check here
         def reference_gates
+          # @sg-ignore Need to add nil check here
           @reference_gates ||= closure.gates - [closure.path]
         end
       end

data/lib/solargraph/pin/reference.rb

@@ -30,8 +30,10 @@ module Solargraph
         )
       end
 
+      # @sg-ignore Need to add nil check here
       # @return [Array<String>]
       def reference_gates
+        # @sg-ignore Need to add nil check here
         closure.gates
       end
     end

data/lib/solargraph/pin/search.rb

@@ -51,6 +51,7 @@ module Solargraph
 
       # @param str1 [String]
       # @param str2 [String]
+      #
       # @return [Float]
       def fuzzy_string_match str1, str2
         return 1.0 + (str2.length.to_f / str1.length.to_f) if str1.downcase.include?(str2.downcase)

data/lib/solargraph/pin/signature.rb

@@ -10,6 +10,7 @@ module Solargraph
       end
 
       def generics
+        # @type [Array<::String, nil>]
         @generics ||= [].freeze
       end
 
@@ -19,6 +20,7 @@ module Solargraph
 
       attr_writer :closure
 
+      # @ sg-ignore need boolish support for ? methods
       def dodgy_return_type_source?
         super || closure&.dodgy_return_type_source?
       end
@@ -32,8 +34,11 @@ module Solargraph
       end
 
       def typify api_map
+        # @sg-ignore Need to add nil check here
         if return_type.defined?
+          # @sg-ignore Need to add nil check here
           qualified = return_type.qualify(api_map, closure.namespace)
+          # @sg-ignore Need to add nil check here
           logger.debug { "Signature#typify(self=#{self}) => #{qualified.rooted_tags.inspect}" }
           return qualified
         end
@@ -46,8 +51,11 @@ module Solargraph
         method_stack.each do |pin|
           sig = pin.signatures.find { |s| s.arity == self.arity }
           next unless sig
+          # @sg-ignore Need to add nil check here
           unless sig.return_type.undefined?
+            # @sg-ignore Need to add nil check here
             qualified = sig.return_type.qualify(api_map, closure.namespace)
+            # @sg-ignore Need to add nil check here
             logger.debug { "Signature#typify(self=#{self}) => #{qualified.rooted_tags.inspect}" }
             return qualified
           end

data/lib/solargraph/pin/symbol.rb

@@ -3,7 +3,7 @@
 module Solargraph
   module Pin
     class Symbol < Base
-      # @param location [Solargraph::Location]
+      # @param location [Solargraph::Location, nil]
       # @param name [String]
       def initialize(location, name, **kwargs)
         # @sg-ignore "Unrecognized keyword argument kwargs to Solargraph::Pin::Base#initialize"

data/lib/solargraph/pin/until.rb

@@ -2,7 +2,7 @@
 
 module Solargraph
   module Pin
-    class Until < Base
+    class Until < CompoundStatement
       include Breakable
 
       # @param receiver [Parser::AST::Node, nil]

data/lib/solargraph/pin/while.rb

@@ -2,7 +2,7 @@
 
 module Solargraph
   module Pin
-    class While < Base
+    class While < CompoundStatement
       include Breakable
 
       # @param receiver [Parser::AST::Node, nil]

data/lib/solargraph/pin.rb

@@ -38,6 +38,8 @@ module Solargraph
     autoload :Until,            'solargraph/pin/until'
     autoload :While,            'solargraph/pin/while'
     autoload :Callable,         'solargraph/pin/callable'
+    autoload :CompoundStatement,
+             'solargraph/pin/compound_statement'
 
     ROOT_PIN = Pin::Namespace.new(type: :class, name: '', closure: nil, source: :pin_rb)
   end