solargraph 0.58.2 → 0.59.0.dev.2

data/lib/solargraph/pin/base_variable.rb

@@ -6,31 +6,127 @@ module Solargraph
       # include Solargraph::Source::NodeMethods
       include Solargraph::Parser::NodeMethods
 
-      # @return [Parser::AST::Node, nil]
-      attr_reader :assignment
+      # @return [Array<Parser::AST::Node>]
+      attr_reader :assignments
 
       attr_accessor :mass_assignment
 
+      # @return [Range, nil]
+      attr_reader :presence
+
       # @param return_type [ComplexType, nil]
+      # @param assignment [Parser::AST::Node, nil] First assignment
+      #   that was made to this variable
+      # @param assignments [Array<Parser::AST::Node>] Possible
+      #   assignments that may have been made to this variable
       # @param mass_assignment [::Array(Parser::AST::Node, Integer), nil]
-      # @param assignment [Parser::AST::Node, nil]
-      def initialize assignment: nil, return_type: nil, mass_assignment: nil, **splat
+      # @param assignment [Parser::AST::Node, nil] First assignment
+      #   that was made to this variable
+      # @param assignments [Array<Parser::AST::Node>] Possible
+      #   assignments that may have been made to this variable
+      # @param exclude_return_type [ComplexType, nil] Ensure any
+      #   return type returned will never include any of these unique
+      #   types in the unique types of its complex type.
+      #
+      #   Example: If a return type is 'Float | Integer | nil' and the
+      #   exclude_return_type is 'Integer', the resulting return
+      #   type will be 'Float | nil' because Integer is excluded.
+      # @param intersection_return_type [ComplexType, nil] Ensure each unique
+      #   return type is compatible with at least one element of this
+      #   complex type.  If a ComplexType used as a return type is an
+      #   union type - we can return any of these - these are
+      #   intersection types - everything we return needs to meet at least
+      #   one of these unique types.
+      #
+      #   Example: If a return type is 'Numeric | nil' and the
+      #   intersection_return_type is 'Float | nil', the resulting return
+      #   type will be 'Float | nil' because Float is compatible
+      #   with Numeric and nil is compatible with nil.
+      # @see https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types
+      # @see https://en.wikipedia.org/wiki/Intersection_type#TypeScript_example
+      # @param presence [Range, nil]
+      # @param [Hash{Symbol => Object}] splat
+      def initialize assignment: nil, assignments: [], mass_assignment: nil,
+                     presence: nil, return_type: nil,
+                     intersection_return_type: nil, exclude_return_type: nil,
+                     **splat
         super(**splat)
-        @assignment = assignment
+        @assignments = (assignment.nil? ? [] : [assignment]) + assignments
         # @type [nil, ::Array(Parser::AST::Node, Integer)]
-        @mass_assignment = nil
+        @mass_assignment = mass_assignment
         @return_type = return_type
+        @intersection_return_type = intersection_return_type
+        @exclude_return_type = exclude_return_type
+        @presence = presence
       end
 
-      def combine_with(other, attrs={})
+      # @param presence [Range]
+      # @param exclude_return_type [ComplexType, nil]
+      # @param intersection_return_type [ComplexType, nil]
+      # @param source [::Symbol]
+      #
+      # @return [self]
+      def downcast presence:, exclude_return_type: nil, intersection_return_type: nil,
+                   source: self.source
+        result = dup
+        result.exclude_return_type = exclude_return_type
+        result.intersection_return_type = intersection_return_type
+        result.source = source
+        result.presence = presence
+        result.reset_generated!
+        result
+      end
+
+      def reset_generated!
+        @assignment = nil
+        super
+      end
+
+      def combine_with other, attrs = {}
+        new_assignments = combine_assignments(other)
         new_attrs = attrs.merge({
-          assignment: assert_same(other, :assignment),
-          mass_assignment: assert_same(other, :mass_assignment),
-          return_type: combine_return_type(other),
-        })
+                                  # default values don't exist in RBS parameters; it just
+                                  # tells you if the arg is optional or not.  Prefer a
+                                  # provided value if we have one here since we can't rely on
+                                  # it from RBS so we can infer from it and typecheck on it.
+                                  assignment: choose(other, :assignment),
+                                  assignments: new_assignments,
+                                  mass_assignment: combine_mass_assignment(other),
+                                  return_type: combine_return_type(other),
+                                  intersection_return_type: combine_types(other, :intersection_return_type),
+                                  exclude_return_type: combine_types(other, :exclude_return_type),
+                                  presence: combine_presence(other)
+                                })
         super(other, new_attrs)
       end
 
+      # @param other [self]
+      #
+      # @return [Array(AST::Node, Integer), nil]
+      def combine_mass_assignment other
+        # @todo pick first non-nil arbitrarily - we don't yet support
+        #   mass assignment merging
+        mass_assignment || other.mass_assignment
+      end
+
+      # @return [Parser::AST::Node, nil]
+      def assignment
+        @assignment ||= assignments.last
+      end
+
+      # @param other [self]
+      #
+      # @return [::Array<Parser::AST::Node>]
+      def combine_assignments other
+        (other.assignments + assignments).uniq
+      end
+
+      def inner_desc
+        super + ", presence=#{presence.inspect}, assignments=#{assignments}, " \
+                "intersection_return_type=#{intersection_return_type&.rooted_tags.inspect}, " \
+                "exclude_return_type=#{exclude_return_type&.rooted_tags.inspect}"
+      end
+
       def completion_item_kind
         Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
       end
@@ -40,10 +136,6 @@ module Solargraph
         Solargraph::LanguageServer::SymbolKinds::VARIABLE
       end
 
-      def return_type
-        @return_type ||= generate_complex_type
-      end
-
       def nil_assignment?
         # this will always be false - should it be return_type ==
         #   ComplexType::NIL or somesuch?
@@ -57,7 +149,7 @@ module Solargraph
       # @param parent_node [Parser::AST::Node]
       # @param api_map [ApiMap]
       # @return [::Array<ComplexType>]
-      def return_types_from_node(parent_node, api_map)
+      def return_types_from_node parent_node, api_map
         types = []
         value_position_nodes_only(parent_node).each do |node|
           # Nil nodes may not have a location
@@ -67,10 +159,12 @@ module Solargraph
             rng = Range.from_node(node)
             next if rng.nil?
             pos = rng.ending
+            # @sg-ignore Need to add nil check here
             clip = api_map.clip_at(location.filename, pos)
             # Use the return node for inference. The clip might infer from the
             # first node in a method call instead of the entire call.
             chain = Parser.chain(node, nil, nil)
+            # @sg-ignore Need to add nil check here
             result = chain.infer(api_map, closure, clip.locals).self_to_type(closure.context)
             types.push result unless result.undefined?
           end
@@ -79,13 +173,15 @@ module Solargraph
       end
 
       # @param api_map [ApiMap]
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def probe api_map
-        unless @assignment.nil?
-          types = return_types_from_node(@assignment, api_map)
-          return ComplexType.new(types.uniq) unless types.empty?
-        end
+        assignment_types = assignments.flat_map { |node| return_types_from_node(node, api_map) }
+        type_from_assignment = ComplexType.new(assignment_types.flat_map(&:items).uniq) unless assignment_types.empty?
+        return adjust_type api_map, type_from_assignment unless type_from_assignment.nil?
 
+        # @todo should handle merging types from mass assignments as
+        #   well so that we can do better flow sensitive typing with
+        #   multiple assignments
         unless @mass_assignment.nil?
           mass_node, index = @mass_assignment
           types = return_types_from_node(mass_node, api_map)
@@ -96,7 +192,10 @@ module Solargraph
               type.all_params.first
             end
           end.compact!
-          return ComplexType.new(types.uniq) unless types.empty?
+
+          return ComplexType::UNDEFINED if types.empty?
+
+          return adjust_type api_map, ComplexType.new(types.uniq).qualify(api_map, *gates)
         end
 
         ComplexType::UNDEFINED
@@ -113,13 +212,163 @@ module Solargraph
         "#{super} = #{assignment&.type.inspect}"
       end
 
+      # @return [ComplexType, nil]
+      def return_type
+        generate_complex_type || @return_type || intersection_return_type || ComplexType::UNDEFINED
+      end
+
+      def typify api_map
+        raw_return_type = super
+
+        adjust_type(api_map, raw_return_type)
+      end
+
+      # @sg-ignore need boolish support for ? methods
+      def presence_certain?
+        exclude_return_type || intersection_return_type
+      end
+
+      # @param other_loc [Location]
+      # @sg-ignore flow sensitive typing needs to handle attrs
+      def starts_at? other_loc
+        location&.filename == other_loc.filename &&
+          presence &&
+          # @sg-ignore flow sensitive typing needs to handle attrs
+          presence.start == other_loc.range.start
+      end
+
+      # Narrow the presence range to the intersection of both.
+      #
+      # @param other [self]
+      #
+      # @return [Range, nil]
+      def combine_presence other
+        return presence || other.presence if presence.nil? || other.presence.nil?
+
+        # @sg-ignore flow sensitive typing needs to handle attrs
+        Range.new([presence.start, other.presence.start].max, [presence.ending, other.presence.ending].min)
+      end
+
+      # @param other [self]
+      # @return [Pin::Closure, nil]
+      def combine_closure other
+        return closure if closure == other.closure
+
+        # choose first defined, as that establishes the scope of the variable
+        if closure.nil? || other.closure.nil?
+          Solargraph.assert_or_log(:varible_closure_missing) do
+            'One of the local variables being combined is missing a closure: ' \
+              "#{inspect} vs #{other.inspect}"
+          end
+          return closure || other.closure
+        end
+
+        # @sg-ignore flow sensitive typing needs to handle attrs
+        if closure.location.nil? || other.closure.location.nil?
+          # @sg-ignore flow sensitive typing needs to handle attrs
+          return closure.location.nil? ? other.closure : closure
+        end
+
+        # if filenames are different, this will just pick one
+        # @sg-ignore flow sensitive typing needs to handle attrs
+        return closure if closure.location <= other.closure.location
+
+        other.closure
+      end
+
+      # @param other_closure [Pin::Closure]
+      # @param other_loc [Location]
+      def visible_at? other_closure, other_loc
+        # @sg-ignore flow sensitive typing needs to handle attrs
+        location.filename == other_loc.filename &&
+          # @sg-ignore flow sensitive typing needs to handle attrs
+          (!presence || presence.include?(other_loc.range.start)) &&
+          visible_in_closure?(other_closure)
+      end
+
+      protected
+
+      attr_accessor :exclude_return_type, :intersection_return_type
+
+      # @return [Range]
+      attr_writer :presence
+
       private
 
-      # @return [ComplexType]
+      # @param api_map [ApiMap]
+      # @param raw_return_type [ComplexType, ComplexType::UniqueType]
+      #
+      # @return [ComplexType, ComplexType::UniqueType]
+      def adjust_type api_map, raw_return_type
+        qualified_exclude = exclude_return_type&.qualify(api_map, *(closure&.gates || ['']))
+        minus_exclusions = raw_return_type.exclude qualified_exclude, api_map
+        qualified_intersection = intersection_return_type&.qualify(api_map, *(closure&.gates || ['']))
+        minus_exclusions.intersect_with qualified_intersection, api_map
+      end
+
+      # See if this variable is visible within 'viewing_closure'
+      #
+      # @param viewing_closure [Pin::Closure]
+      # @return [Boolean]
+      def visible_in_closure? viewing_closure
+        return false if closure.nil?
+
+        # if we're declared at top level, we can't be seen from within
+        # methods declared tere
+
+        # @sg-ignore Need to add nil check here
+        return false if viewing_closure.is_a?(Pin::Method) && closure.context.tags == 'Class<>'
+
+        # @sg-ignore Need to add nil check here
+        return true if viewing_closure.binder.namespace == closure.binder.namespace
+
+        # @sg-ignore Need to add nil check here
+        return true if viewing_closure.return_type == closure.context
+
+        # classes and modules can't see local variables declared
+        # in their parent closure, so stop here
+        return false if scope == :instance && viewing_closure.is_a?(Pin::Namespace)
+
+        parent_of_viewing_closure = viewing_closure.closure
+
+        return false if parent_of_viewing_closure.nil?
+
+        visible_in_closure?(parent_of_viewing_closure)
+      end
+
+      # @param other [self]
+      # @return [ComplexType, nil]
+      def combine_return_type other
+        combine_types(other, :return_type)
+      end
+
+      # @param other [self]
+      # @param attr [::Symbol]
+      #
+      # @return [ComplexType, nil]
+      def combine_types other, attr
+        # @type [ComplexType, nil]
+        type1 = send(attr)
+        # @type [ComplexType, nil]
+        type2 = other.send(attr)
+        if type1 && type2
+          types = (type1.items + type2.items).uniq
+          ComplexType.new(types)
+        else
+          type1 || type2
+        end
+      end
+
+      # @return [::Symbol]
+      def scope
+        :instance
+      end
+
+      # @return [ComplexType, nil]
       def generate_complex_type
         tag = docstring.tag(:type)
         return ComplexType.try_parse(*tag.types) unless tag.nil? || tag.types.nil? || tag.types.empty?
-        ComplexType.new
+        nil
       end
     end
   end

data/lib/solargraph/pin/block.rb

@@ -15,12 +15,14 @@ module Solargraph
       # @param node [Parser::AST::Node, nil]
       # @param context [ComplexType, nil]
       # @param args [::Array<Parameter>]
+      # @param [Hash{Symbol => Object}] splat
       def initialize receiver: nil, args: [], context: nil, node: nil, **splat
         super(**splat, parameters: args)
         @receiver = receiver
         @context = context
         @return_type = ComplexType.parse('::Proc')
         @node = node
+        @name = '<block>'
       end
 
       # @param api_map [ApiMap]
@@ -30,14 +32,20 @@ module Solargraph
       end
 
       def binder
-        @rebind&.defined? ? @rebind : closure.binder
+        out = @rebind if @rebind&.defined?
+        out ||= super
+      end
+
+      def context
+        @context = @rebind if @rebind&.defined?
+        super
       end
 
       # @param yield_types [::Array<ComplexType>]
       # @param parameters [::Array<Parameter>]
       #
       # @return [::Array<ComplexType>]
-      def destructure_yield_types(yield_types, parameters)
+      def destructure_yield_types yield_types, parameters
         # yielding a tuple into a block will destructure the tuple
         if yield_types.length == 1
           yield_type = yield_types.first
@@ -48,16 +56,19 @@ module Solargraph
 
       # @param api_map [ApiMap]
       # @return [::Array<ComplexType>]
-      def typify_parameters(api_map)
+      def typify_parameters api_map
         chain = Parser.chain(receiver, filename, node)
+        # @sg-ignore Need to add nil check here
         clip = api_map.clip_at(location.filename, location.range.start)
         locals = clip.locals - [self]
+        # @sg-ignore Need to add nil check here
         meths = chain.define(api_map, closure, locals)
         # @todo Convert logic to use signatures
         # @param meth [Pin::Method]
         meths.each do |meth|
           next if meth.block.nil?
 
+          # @sg-ignore flow sensitive typing needs to handle attrs
           yield_types = meth.block.parameters.map(&:return_type)
           # 'arguments' is what the method says it will yield to the
           # block; 'parameters' is what the block accepts
@@ -67,6 +78,7 @@ module Solargraph
             param_type = chain.base.infer(api_map, param, locals)
             unless arg_type.nil?
               if arg_type.generic? && param_type.defined?
+                # @sg-ignore Need to add nil check here
                 namespace_pin = api_map.get_namespace_pins(meth.namespace, closure.namespace).first
                 arg_type.resolve_generics(namespace_pin, param_type)
               else
@@ -86,16 +98,27 @@ module Solargraph
       def maybe_rebind api_map
         return ComplexType::UNDEFINED unless receiver
 
-        chain = Parser.chain(receiver, location.filename)
+        # @sg-ignore Need to add nil check here
+        chain = Parser.chain(receiver, location.filename, node)
+        # @sg-ignore Need to add nil check here
         locals = api_map.source_map(location.filename).locals_at(location)
+        # @sg-ignore Need to add nil check here
         receiver_pin = chain.define(api_map, closure, locals).first
         return ComplexType::UNDEFINED unless receiver_pin
 
         types = receiver_pin.docstring.tag(:yieldreceiver)&.types
         return ComplexType::UNDEFINED unless types&.any?
 
-        target = chain.base.infer(api_map, receiver_pin, locals)
-        target = full_context unless target.defined?
+        name_pin = self
+        # if we have Foo.bar { |x| ... }, and the bar method references self...
+        target = if chain.base.defined?
+                   # figure out Foo
+                   chain.base.infer(api_map, name_pin, locals)
+                 else
+                   # if not, any self there must be the context of our closure
+                   # @sg-ignore Need to add nil check here
+                   closure.full_context
+                 end
 
         ComplexType.try_parse(*types).qualify(api_map, *receiver_pin.gates).self_to_type(target)
       end

data/lib/solargraph/pin/breakable.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 module Solargraph
   module Pin
-    # Mix-in for pins which enclose code which the 'break' statement works with-in - e.g., blocks, when, until, ...
+    # Mix-in for pins which enclose code which the 'break' statement
+    # works with-in - e.g., blocks, when, until, ...
     module Breakable
       # @return [Parser::AST::Node]
       attr_reader :node
+
+      # @return [Location, nil]
+      attr_reader :location
     end
   end
 end