solargraph 0.58.3 → 0.59.0.dev.1

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

@@ -1,109 +1,109 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    class Chain
-      class Link
-        include Equality
-
-        # @return [String]
-        attr_reader :word
-
-        # @return [Pin::Base]
-        attr_accessor :last_context
-
-        # @param word [String]
-        def initialize word = '<undefined>'
-          @word = word
-        end
-
-        # @sg-ignore two problems - Declared return type
-        #   ::Solargraph::Source::Chain::Array does not match inferred
-        #   type ::Array(::Class<::Solargraph::Source::Chain::Link>,
-        #   ::String) for
-        #   Solargraph::Source::Chain::Link#equality_fields
-        #   and
-        #   Not enough arguments to Module#protected
-        protected def equality_fields
-          [self.class, word]
-        end
-
-        def undefined?
-          word == '<undefined>'
-        end
-
-        def constant?
-          is_a?(Chain::Constant)
-        end
-
-        # @param api_map [ApiMap]
-        # @param name_pin [Pin::Base]
-        # @param locals [::Array<Pin::Base>]
-        # @return [::Array<Pin::Base>]
-        def resolve api_map, name_pin, locals
-          []
-        end
-
-        # debugging description of contents; not for machine use
-        # @return [String]
-        def desc
-          word
-        end
-
-        def to_s
-          desc
-        end
-
-        def inspect
-          "#<#{self.class} - `#{self.desc}`>"
-        end
-
-        def head?
-          @head ||= false
-        end
-
-        # Make a copy of this link marked as the head of a chain
-        #
-        # @return [self]
-        def clone_head
-          clone.mark_head(true)
-        end
-
-        # Make a copy of this link unmarked as the head of a chain
-        #
-        # @return [self]
-        def clone_body
-          clone.mark_head(false)
-        end
-
-        def nullable?
-          false
-        end
-
-        # debugging description of contents; not for machine use
-        #
-        # @return [String]
-        def desc
-          word
-        end
-
-        def inspect
-          "#<#{self.class} - `#{self.desc}`>"
-        end
-
-        include Logging
-
-        protected
-
-        # Mark whether this link is the head of a chain
-        #
-        # @param bool [Boolean]
-        # @return [self]
-        def mark_head bool
-          @head = bool
-          self
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    class Chain
+      class Link
+        include Equality
+
+        # @return [String]
+        attr_reader :word
+
+        # @return [Pin::Base]
+        attr_accessor :last_context
+
+        # @param word [String]
+        def initialize word = '<undefined>'
+          @word = word
+        end
+
+        # @sg-ignore two problems - Declared return type
+        #   ::Solargraph::Source::Chain::Array does not match inferred
+        #   type ::Array(::Class<::Solargraph::Source::Chain::Link>,
+        #   ::String) for
+        #   Solargraph::Source::Chain::Link#equality_fields
+        #   and
+        #   Not enough arguments to Module#protected
+        protected def equality_fields
+          [self.class, word]
+        end
+
+        def undefined?
+          word == '<undefined>'
+        end
+
+        def constant?
+          is_a?(Chain::Constant)
+        end
+
+        # @param api_map [ApiMap]
+        # @param name_pin [Pin::Base]
+        # @param locals [::Array<Pin::Base>]
+        # @return [::Array<Pin::Base>]
+        def resolve api_map, name_pin, locals
+          []
+        end
+
+        # debugging description of contents; not for machine use
+        # @return [String]
+        def desc
+          word
+        end
+
+        def to_s
+          desc
+        end
+
+        def inspect
+          "#<#{self.class} - `#{self.desc}`>"
+        end
+
+        def head?
+          @head ||= false
+        end
+
+        # Make a copy of this link marked as the head of a chain
+        #
+        # @return [self]
+        def clone_head
+          clone.mark_head(true)
+        end
+
+        # Make a copy of this link unmarked as the head of a chain
+        #
+        # @return [self]
+        def clone_body
+          clone.mark_head(false)
+        end
+
+        def nullable?
+          false
+        end
+
+        # debugging description of contents; not for machine use
+        #
+        # @return [String]
+        def desc
+          word
+        end
+
+        def inspect
+          "#<#{self.class} - `#{self.desc}`>"
+        end
+
+        include Logging
+
+        protected
+
+        # Mark whether this link is the head of a chain
+        #
+        # @param bool [Boolean]
+        # @return [self]
+        def mark_head bool
+          @head = bool
+          self
+        end
+      end
+    end
+  end
+end

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

@@ -16,11 +16,15 @@ module Solargraph
         # @param node [Parser::AST::Node, Object]
         def initialize type, node
           if node.is_a?(::Parser::AST::Node)
+            # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
             if node.type == :true
               @value = true
+            # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
             elsif node.type == :false
               @value = false
+            # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
             elsif [:int, :sym].include?(node.type)
+              # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
               @value = node.children.first
             end
           end
@@ -31,6 +35,7 @@ module Solargraph
 
         # @sg-ignore Fix "Not enough arguments to Module#protected"
         protected def equality_fields
+          # @sg-ignore literal arrays in this module turn into ::Solargraph::Source::Chain::Array
           super + [@value, @type, @literal_type, @complex_type]
         end
 

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

@@ -8,6 +8,8 @@ module Solargraph
           '<or>'
         end
 
+        attr_reader :links
+
         # @param links [::Array<Chain>]
         def initialize links
           @links = links
@@ -15,7 +17,13 @@ module Solargraph
 
         def resolve api_map, name_pin, locals
           types = @links.map { |link| link.infer(api_map, name_pin, locals) }
-          [Solargraph::Pin::ProxyType.anonymous(Solargraph::ComplexType.new(types.uniq), source: :chain)]
+          combined_type = Solargraph::ComplexType.new(types)
+          unless types.all?(&:nullable?)
+            # @sg-ignore flow sensitive typing should be able to handle redefinition
+            combined_type = combined_type.without_nil
+          end
+
+          [Solargraph::Pin::ProxyType.anonymous(combined_type, source: :chain)]
         end
       end
     end

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

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

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

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    class Chain
-      class Variable < Link
-        def resolve api_map, name_pin, locals
-          api_map.get_instance_variable_pins(name_pin.context.namespace, name_pin.context.scope).select{|p| p.name == word}
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    class Chain
+      class Variable < Link
+        def resolve api_map, name_pin, locals
+          api_map.get_instance_variable_pins(name_pin.context.namespace, name_pin.context.scope).select{|p| p.name == word}
+        end
+      end
+    end
+  end
+end

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

@@ -1,30 +1,30 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class Source
-    class Chain
-      class ZSuper < Call
-        # @return [String]
-        attr_reader :word
-
-        # @return [::Array<Chain>]
-        attr_reader :arguments
-
-        # @param word [String]
-        # @param arguments [::Array<Chain>]
-        # @param with_block [Boolean] True if the chain is inside a block
-        # @param head [Boolean] True if the call is the start of its chain
-        def initialize word, with_block = false
-          super(word, nil, [], with_block)
-        end
-
-        # @param api_map [ApiMap]
-        # @param name_pin [Pin::Base]
-        # @param locals [::Array<Pin::Base>]
-        def resolve api_map, name_pin, locals
-          return super_pins(api_map, name_pin)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    class Chain
+      class ZSuper < Call
+        # @return [String]
+        attr_reader :word
+
+        # @return [::Array<Chain>]
+        attr_reader :arguments
+
+        # @param word [String]
+        # @param arguments [::Array<Chain>]
+        # @param with_block [Boolean] True if the chain is inside a block
+        # @param head [Boolean] True if the call is the start of its chain
+        def initialize word, with_block = false
+          super(word, nil, [], with_block)
+        end
+
+        # @param api_map [ApiMap]
+        # @param name_pin [Pin::Base]
+        # @param locals [::Array<Pin::Base>]
+        def resolve api_map, name_pin, locals
+          return super_pins(api_map, name_pin)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/source/chain.rb

@@ -71,6 +71,7 @@ module Solargraph
 
       # @return [Chain]
       def base
+        # @sg-ignore Need to add nil check here
         @base ||= Chain.new(links[0..-2])
       end
 
@@ -78,25 +79,25 @@ module Solargraph
       #
       # @param api_map [ApiMap]
       #
-      # @param name_pin [Pin::Base] A pin
-      # representing the place in which expression is evaluated (e.g.,
-      # a Method pin, or a Module or Class pin if not run within a
-      # method - both in terms of the closure around the chain, as well
-      # as the self type used for any method calls in head position.
+      # @param name_pin [Pin::Base] A pin representing the closure in
+      #   which expression is evaluated (e.g., a Method pin, or a
+      #   Module or Class pin if not run within a method - both in
+      #   terms of the closure around the chain, as well as the self
+      #   type used for any method calls in head position.
       #
       #   Requirements for name_pin:
       #
       #     * name_pin.context: This should be a type representing the
-      #       namespace where we can look up non-local variables and
-      #       method names.  If it is a Class<X>, we will look up
-      #       :class scoped methods/variables.
+      #       namespace where we can look up non-local variables.  If
+      #       it is a Class<X>, we will look up :class scoped
+      #       instance variables.
       #
       #     * name_pin.binder: Used for method call lookups only
       #       (Chain::Call links).  For method calls as the first
       #       element in the chain, 'name_pin.binder' should be the
       #       same as name_pin.context above.  For method calls later
-      #       in the chain (e.g., 'b' in a.b.c), it should represent
-      #       'a'.
+      #       in the chain, it changes.  (e.g., for 'b' in a.b.c, it
+      #       should represent the type of 'a').
       #
       # @param locals [::Array<Pin::LocalVariable>] Any local
       #   variables / method parameters etc visible by the statement
@@ -113,6 +114,7 @@ module Solargraph
         #
         # @todo ProxyType uses 'type' for the binder, but '
         working_pin = name_pin
+        # @sg-ignore Need to add nil check here
         links[0..-2].each do |link|
           pins = link.resolve(api_map, working_pin, locals)
           type = infer_from_definitions(pins, working_pin, api_map, locals)
@@ -138,7 +140,8 @@ module Solargraph
       # @return [ComplexType]
       # @sg-ignore
       def infer api_map, name_pin, locals
-        cache_key = [node, node&.location, links, name_pin&.return_type, locals]
+        # includes binder as it is mutable in Pin::Block
+        cache_key = [node, node&.location, links, name_pin&.return_type, name_pin&.binder, locals]
         if @@inference_invalidation_key == api_map.hash
           cached = @@inference_cache[cache_key]
           return cached if cached
@@ -154,7 +157,7 @@ module Solargraph
       # @param api_map [ApiMap]
       # @param name_pin [Pin::Base]
       # @param locals [::Array<Pin::LocalVariable>]
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def infer_uncached api_map, name_pin, locals
         pins = define(api_map, name_pin, locals)
         if pins.empty?
@@ -209,12 +212,12 @@ module Solargraph
       private
 
       # @param pins [::Array<Pin::Base>]
-      # @param context [Pin::Base]
+      # @param name_pin [Pin::Base]
       # @param api_map [ApiMap]
       # @param locals [::Enumerable<Pin::LocalVariable>]
-      # @return [ComplexType]
-      def infer_from_definitions pins, context, api_map, locals
-        # @type [::Array<ComplexType>]
+      # @return [ComplexType, ComplexType::UniqueType]
+      def infer_from_definitions pins, name_pin, api_map, locals
+        # @type [::Array<ComplexType, ComplexType::UniqueType>]
         types = []
         unresolved_pins = []
         # @todo this param tag shouldn't be needed to probe the type
@@ -232,7 +235,8 @@ module Solargraph
               # @todo even at strong, no typechecking complaint
               #   happens when a [Pin::Base,nil] is passed into a method
               #   that accepts only [Pin::Namespace] as an argument
-              type = type.resolve_generics(pin.closure, context.binder)
+              # @sg-ignore Need to add nil check here
+              type = type.resolve_generics(pin.closure, name_pin.binder)
             end
             types << type
           else
@@ -271,16 +275,15 @@ module Solargraph
                else
                  ComplexType.new(types)
                end
-        if context.nil? || context.return_type.undefined?
+        if name_pin.nil? || name_pin.context.undefined?
           # up to downstream to resolve self type
           return type
         end
-
-        type.self_to_type(context.return_type)
+        type.self_to_type(name_pin.context)
       end
 
-      # @param type [ComplexType]
-      # @return [ComplexType]
+      # @param type [ComplexType, ComplexType::UniqueType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def maybe_nil type
         return type if type.undefined? || type.void? || type.nullable?
         return type unless nullable?

data/lib/solargraph/source/change.rb

@@ -7,13 +7,13 @@ module Solargraph
     class Change
       include EncodingFixes
 
-      # @return [Range]
+      # @return [Range, nil]
       attr_reader :range
 
       # @return [String]
       attr_reader :new_text
 
-      # @param range [Range] The starting and ending positions of the change.
+      # @param range [Range, nil] The starting and ending positions of the change.
       #   If nil, the original text will be overwritten.
       # @param new_text [String] The text to be changed.
       def initialize range, new_text
@@ -31,9 +31,11 @@ module Solargraph
         if nullable and !range.nil? and new_text.match(/[.\[{(@$:]$/)
           [':', '@'].each do |dupable|
             next unless new_text == dupable
+            # @sg-ignore flow sensitive typing needs to handle attrs
             offset = Position.to_offset(text, range.start)
             if text[offset - 1] == dupable
               p = Position.from_offset(text, offset - 1)
+              # @sg-ignore flow sensitive typing needs to handle attrs
               r = Change.new(Range.new(p, range.start), ' ')
               text = r.write(text)
             end
@@ -58,9 +60,12 @@ module Solargraph
           fixed
         else
           result = commit text, fixed
+          # @sg-ignore flow sensitive typing needs to handle attrs
           off = Position.to_offset(text, range.start)
+          # @sg-ignore Need to add nil check here
           match = result[0, off].match(/[.:]+\z/)
           if match
+            # @sg-ignore flow sensitive typing should be able to handle redefinition
             result = result[0, off].sub(/#{match[0]}\z/, ' ' * match[0].length) + result[off..-1]
           end
           result
@@ -73,7 +78,9 @@ module Solargraph
       # @param insert [String]
       # @return [String]
       def commit text, insert
+        # @sg-ignore Need to add nil check here
         start_offset = Position.to_offset(text, range.start)
+        # @sg-ignore Need to add nil check here
         end_offset = Position.to_offset(text, range.ending)
         (start_offset == 0 ? '' : text[0..start_offset-1].to_s) + normalize(insert) + text[end_offset..-1].to_s
       end

data/lib/solargraph/source/cursor.rb

@@ -19,7 +19,7 @@ module Solargraph
         @position = Position.normalize(position)
       end
 
-      # @return [String]
+      # @return [String, nil]
       def filename
         source.filename
       end
@@ -35,12 +35,14 @@ module Solargraph
       # The part of the word before the current position. Given the text
       # `foo.bar`, the start_of_word at position(0, 6) is `ba`.
       #
+      # @sg-ignore Need to add nil check here
       # @return [String]
       def start_of_word
         @start_of_word ||= begin
           match = source.code[0..offset-1].to_s.match(start_word_pattern)
           result = (match ? match[0] : '')
           # Including the preceding colon if the word appears to be a symbol
+          # @sg-ignore Need to add nil check here
           result = ":#{result}" if source.code[0..offset-result.length-1].end_with?(':') and !source.code[0..offset-result.length-1].end_with?('::')
           result
         end
@@ -50,6 +52,7 @@ module Solargraph
       # `foo.bar`, the end_of_word at position (0,6) is `r`.
       #
       # @return [String]
+      # @sg-ignore Need to add nil check here
       def end_of_word
         @end_of_word ||= begin
           match = source.code[offset..-1].to_s.match(end_word_pattern)
@@ -110,6 +113,7 @@ module Solargraph
       def recipient
         @recipient ||= begin
           node = recipient_node
+          # @sg-ignore Need to add nil check here
           node ? Cursor.new(source, Range.from_node(node).ending) : nil
         end
       end
@@ -124,8 +128,10 @@ module Solargraph
       def node_position
         @node_position ||= begin
           if start_of_word.empty?
+            # @sg-ignore Need to add nil check here
             match = source.code[0, offset].match(/\s*(\.|:+)\s*$/)
             if match
+              # @sg-ignore Need to add nil check here
               Position.from_offset(source.code, offset - match[0].length)
             else
               position

data/lib/solargraph/source/source_chainer.rb

@@ -33,25 +33,29 @@ module Solargraph
       def chain
         # Special handling for files that end with an integer and a period
         return Chain.new([Chain::Literal.new('Integer', Integer(phrase[0..-2])), Chain::UNDEFINED_CALL]) if phrase =~ /^[0-9]+\.$/
+        # @sg-ignore Need to add nil check here
         return Chain.new([Chain::Literal.new('Symbol', phrase[1..].to_sym)]) if phrase.start_with?(':') && !phrase.start_with?('::')
         return SourceChainer.chain(source, Position.new(position.line, position.character + 1)) if end_of_phrase.strip == '::' && source.code[Position.to_offset(source.code, position)].to_s.match?(/[a-z]/i)
         begin
           return Chain.new([]) if phrase.end_with?('..')
+          # @type [::Parser::AST::Node, nil]
           node = nil
+          # @type [::Parser::AST::Node, nil]
           parent = nil
           if !source.repaired? && source.parsed? && source.synchronized?
             tree = source.tree_at(position.line, position.column)
             node, parent = tree[0..2]
           elsif source.parsed? && source.repaired? && end_of_phrase == '.'
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2]
-            node = Parser.parse(fixed_phrase) if node.nil?
+            # provide filename and line so that we can look up local variables there later
+            node = Parser.parse(fixed_phrase, source.filename, fixed_position.line) if node.nil?
           elsif source.repaired?
-            node = Parser.parse(fixed_phrase)
+            node = Parser.parse(fixed_phrase, source.filename, fixed_position.line)
           else
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2] unless source.error_ranges.any?{|r| r.nil? || r.include?(fixed_position)}
             # Exception for positions that chain literal nodes in unsynchronized sources
             node = nil unless source.synchronized? || !Parser.infer_literal_node_type(node).nil?
-            node = Parser.parse(fixed_phrase) if node.nil?
+            node = Parser.parse(fixed_phrase, source.filename, fixed_position.line) if node.nil?
           end
         rescue Parser::SyntaxError
           return Chain.new([Chain::UNDEFINED_CALL])
@@ -79,11 +83,13 @@ module Solargraph
       # @return [Solargraph::Source]
       attr_reader :source
 
+      # @sg-ignore Need to add nil check here
       # @return [String]
       def phrase
         @phrase ||= source.code[signature_data..offset-1]
       end
 
+      # @sg-ignore Need to add nil check here
       # @return [String]
       def fixed_phrase
         @fixed_phrase ||= phrase[0..-(end_of_phrase.length+1)]
@@ -95,6 +101,7 @@ module Solargraph
       end
 
       # @return [String]
+      # @sg-ignore Need to add nil check here
       def end_of_phrase
         @end_of_phrase ||= begin
           match = phrase.match(/\s*(\.{1}|::)\s*$/)
@@ -149,9 +156,12 @@ module Solargraph
             in_whitespace = true
           else
             if brackets.zero? and parens.zero? and squares.zero? and in_whitespace
+              # @sg-ignore Need to add nil check here
               unless char == '.' or @source.code[index+1..-1].strip.start_with?('.')
                 old = @source.code[index+1..-1]
+                # @sg-ignore Need to add nil check here
                 nxt = @source.code[index+1..-1].lstrip
+                # @sg-ignore Need to add nil check here
                 index += (@source.code[index+1..-1].length - @source.code[index+1..-1].lstrip.length)
                 break
               end