solargraph 0.57.0 → 0.58.3

data/lib/solargraph/parser/flow_sensitive_typing.rb

@@ -1,255 +1,255 @@
-module Solargraph
-  module Parser
-    class FlowSensitiveTyping
-      include Solargraph::Parser::NodeMethods
-
-      # @param locals [Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
-      # @param enclosing_breakable_pin [Solargraph::Pin::Breakable, nil]
-      def initialize(locals, enclosing_breakable_pin = nil)
-        @locals = locals
-        @enclosing_breakable_pin = enclosing_breakable_pin
-      end
-
-      # @param and_node [Parser::AST::Node]
-      # @param true_ranges [Array<Range>]
-      #
-      # @return [void]
-      def process_and(and_node, true_ranges = [])
-        # @type [Parser::AST::Node]
-        lhs = and_node.children[0]
-        # @type [Parser::AST::Node]
-        rhs = and_node.children[1]
-
-        before_rhs_loc = rhs.location.expression.adjust(begin_pos: -1)
-        before_rhs_pos = Position.new(before_rhs_loc.line, before_rhs_loc.column)
-
-        rhs_presence = Range.new(before_rhs_pos,
-                                 get_node_end_position(rhs))
-        process_isa(lhs, true_ranges + [rhs_presence])
-      end
-
-      # @param if_node [Parser::AST::Node]
-      #
-      # @return [void]
-      def process_if(if_node)
-        #
-        # See if we can refine a type based on the result of 'if foo.nil?'
-        #
-        # [3] pry(main)> require 'parser/current'; Parser::CurrentRuby.parse("if foo.is_a? Baz; then foo; else bar; end")
-        # => s(:if,
-        #   s(:send,
-        #     s(:send, nil, :foo), :is_a?,
-        #     s(:const, nil, :Baz)),
-        #   s(:send, nil, :foo),
-        #   s(:send, nil, :bar))
-        # [4] pry(main)>
-        conditional_node = if_node.children[0]
-        # @type [Parser::AST::Node]
-        then_clause = if_node.children[1]
-        # @type [Parser::AST::Node]
-        else_clause = if_node.children[2]
-
-        true_ranges = []
-        if always_breaks?(else_clause)
-          unless enclosing_breakable_pin.nil?
-            rest_of_breakable_body = Range.new(get_node_end_position(if_node),
-                                               get_node_end_position(enclosing_breakable_pin.node))
-            true_ranges << rest_of_breakable_body
-          end
-        end
-
-        unless then_clause.nil?
-          #
-          # Add specialized locals for the then clause range
-          #
-          before_then_clause_loc = then_clause.location.expression.adjust(begin_pos: -1)
-          before_then_clause_pos = Position.new(before_then_clause_loc.line, before_then_clause_loc.column)
-          true_ranges << Range.new(before_then_clause_pos,
-                                   get_node_end_position(then_clause))
-        end
-
-        process_conditional(conditional_node, true_ranges)
-      end
-
-      class << self
-        include Logging
-      end
-
-      # Find a variable pin by name and where it is used.
-      #
-      # Resolves our most specific view of this variable's type by
-      # preferring pins created by flow-sensitive typing when we have
-      # them based on the Closure and Location.
-      #
-      # @param pins [Array<Pin::LocalVariable>]
-      # @param name [String]
-      # @param closure [Pin::Closure]
-      # @param location [Location]
-      #
-      # @return [Array<Pin::LocalVariable>]
-      def self.visible_pins(pins, name, closure, location)
-        logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location})" }
-        pins_with_name = pins.select { |p| p.name == name }
-        if pins_with_name.empty?
-          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => [] - no pins with name" }
-          return []
-        end
-        pins_with_specific_visibility = pins.select { |p| p.name == name && p.presence && p.visible_at?(closure, location) }
-        if pins_with_specific_visibility.empty?
-          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{pins_with_name} - no pins with specific visibility" }
-          return pins_with_name
-        end
-        visible_pins_specific_to_this_closure = pins_with_specific_visibility.select { |p| p.closure == closure }
-        if visible_pins_specific_to_this_closure.empty?
-          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{pins_with_specific_visibility} - no visible pins specific to this closure (#{closure})}" }
-          return pins_with_specific_visibility
-        end
-        flow_defined_pins = pins_with_specific_visibility.select { |p| p.presence_certain? }
-        if flow_defined_pins.empty?
-          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{visible_pins_specific_to_this_closure} - no flow-defined pins" }
-          return visible_pins_specific_to_this_closure
-        end
-
-        logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{flow_defined_pins}" }
-
-        flow_defined_pins
-      end
-
-      include Logging
-
-      private
-
-      # @param pin [Pin::LocalVariable]
-      # @param downcast_type_name [String]
-      # @param presence [Range]
-      #
-      # @return [void]
-      def add_downcast_local(pin, downcast_type_name, presence)
-        # @todo Create pin#update method
-        new_pin = Solargraph::Pin::LocalVariable.new(
-          location: pin.location,
-          closure: pin.closure,
-          name: pin.name,
-          assignment: pin.assignment,
-          comments: pin.comments,
-          presence: presence,
-          return_type: ComplexType.try_parse(downcast_type_name),
-          presence_certain: true,
-          source: :flow_sensitive_typing
-        )
-        locals.push(new_pin)
-      end
-
-      # @param facts_by_pin [Hash{Pin::LocalVariable => Array<Hash{Symbol => String}>}]
-      # @param presences [Array<Range>]
-      #
-      # @return [void]
-      def process_facts(facts_by_pin, presences)
-        #
-        # Add specialized locals for the rest of the block
-        #
-        facts_by_pin.each_pair do |pin, facts|
-          facts.each do |fact|
-            downcast_type_name = fact.fetch(:type)
-            presences.each do |presence|
-              add_downcast_local(pin, downcast_type_name, presence)
-            end
-          end
-        end
-      end
-
-      # @param conditional_node [Parser::AST::Node]
-      # @param true_ranges [Array<Range>]
-      #
-      # @return [void]
-      def process_conditional(conditional_node, true_ranges)
-        if conditional_node.type == :send
-          process_isa(conditional_node, true_ranges)
-        elsif conditional_node.type == :and
-          process_and(conditional_node, true_ranges)
-        end
-      end
-
-      # @param isa_node [Parser::AST::Node]
-      # @return [Array(String, String)]
-      def parse_isa(isa_node)
-        return unless isa_node&.type == :send && isa_node.children[1] == :is_a?
-        # Check if conditional node follows this pattern:
-        #   s(:send,
-        #     s(:send, nil, :foo), :is_a?,
-        #     s(:const, nil, :Baz)),
-        isa_receiver = isa_node.children[0]
-        isa_type_name = type_name(isa_node.children[2])
-        return unless isa_type_name
-
-        # check if isa_receiver looks like this:
-        #  s(:send, nil, :foo)
-        # and set variable_name to :foo
-        if isa_receiver&.type == :send && isa_receiver.children[0].nil? && isa_receiver.children[1].is_a?(Symbol)
-          variable_name = isa_receiver.children[1].to_s
-        end
-        # or like this:
-        # (lvar :repr)
-        variable_name = isa_receiver.children[0].to_s if isa_receiver&.type == :lvar
-        return unless variable_name
-
-        [isa_type_name, variable_name]
-      end
-
-      # @param variable_name [String]
-      # @param position [Position]
-      #
-      # @return [Solargraph::Pin::LocalVariable, nil]
-      def find_local(variable_name, position)
-        pins = locals.select { |pin| pin.name == variable_name && pin.presence.include?(position) }
-        return unless pins.length == 1
-        pins.first
-      end
-
-      # @param isa_node [Parser::AST::Node]
-      # @param true_presences [Array<Range>]
-      #
-      # @return [void]
-      def process_isa(isa_node, true_presences)
-        isa_type_name, variable_name = parse_isa(isa_node)
-        return if variable_name.nil? || variable_name.empty?
-        isa_position = Range.from_node(isa_node).start
-
-        pin = find_local(variable_name, isa_position)
-        return unless pin
-
-        if_true = {}
-        if_true[pin] ||= []
-        if_true[pin] << { type: isa_type_name }
-        process_facts(if_true, true_presences)
-      end
-
-      # @param node [Parser::AST::Node]
-      #
-      # @return [String, nil]
-      def type_name(node)
-        # e.g.,
-        #  s(:const, nil, :Baz)
-        return unless node&.type == :const
-        module_node = node.children[0]
-        class_node = node.children[1]
-
-        return class_node.to_s if module_node.nil?
-
-        module_type_name = type_name(module_node)
-        return unless module_type_name
-
-        "#{module_type_name}::#{class_node}"
-      end
-
-      # @param clause_node [Parser::AST::Node]
-      def always_breaks?(clause_node)
-        clause_node&.type == :break
-      end
-
-      attr_reader :locals
-
-      attr_reader :enclosing_breakable_pin
-    end
-  end
-end
+module Solargraph
+  module Parser
+    class FlowSensitiveTyping
+      include Solargraph::Parser::NodeMethods
+
+      # @param locals [Array<Solargraph::Pin::LocalVariable, Solargraph::Pin::Parameter>]
+      # @param enclosing_breakable_pin [Solargraph::Pin::Breakable, nil]
+      def initialize(locals, enclosing_breakable_pin = nil)
+        @locals = locals
+        @enclosing_breakable_pin = enclosing_breakable_pin
+      end
+
+      # @param and_node [Parser::AST::Node]
+      # @param true_ranges [Array<Range>]
+      #
+      # @return [void]
+      def process_and(and_node, true_ranges = [])
+        # @type [Parser::AST::Node]
+        lhs = and_node.children[0]
+        # @type [Parser::AST::Node]
+        rhs = and_node.children[1]
+
+        before_rhs_loc = rhs.location.expression.adjust(begin_pos: -1)
+        before_rhs_pos = Position.new(before_rhs_loc.line, before_rhs_loc.column)
+
+        rhs_presence = Range.new(before_rhs_pos,
+                                 get_node_end_position(rhs))
+        process_isa(lhs, true_ranges + [rhs_presence])
+      end
+
+      # @param if_node [Parser::AST::Node]
+      #
+      # @return [void]
+      def process_if(if_node)
+        #
+        # See if we can refine a type based on the result of 'if foo.nil?'
+        #
+        # [3] pry(main)> require 'parser/current'; Parser::CurrentRuby.parse("if foo.is_a? Baz; then foo; else bar; end")
+        # => s(:if,
+        #   s(:send,
+        #     s(:send, nil, :foo), :is_a?,
+        #     s(:const, nil, :Baz)),
+        #   s(:send, nil, :foo),
+        #   s(:send, nil, :bar))
+        # [4] pry(main)>
+        conditional_node = if_node.children[0]
+        # @type [Parser::AST::Node]
+        then_clause = if_node.children[1]
+        # @type [Parser::AST::Node]
+        else_clause = if_node.children[2]
+
+        true_ranges = []
+        if always_breaks?(else_clause)
+          unless enclosing_breakable_pin.nil?
+            rest_of_breakable_body = Range.new(get_node_end_position(if_node),
+                                               get_node_end_position(enclosing_breakable_pin.node))
+            true_ranges << rest_of_breakable_body
+          end
+        end
+
+        unless then_clause.nil?
+          #
+          # Add specialized locals for the then clause range
+          #
+          before_then_clause_loc = then_clause.location.expression.adjust(begin_pos: -1)
+          before_then_clause_pos = Position.new(before_then_clause_loc.line, before_then_clause_loc.column)
+          true_ranges << Range.new(before_then_clause_pos,
+                                   get_node_end_position(then_clause))
+        end
+
+        process_conditional(conditional_node, true_ranges)
+      end
+
+      class << self
+        include Logging
+      end
+
+      # Find a variable pin by name and where it is used.
+      #
+      # Resolves our most specific view of this variable's type by
+      # preferring pins created by flow-sensitive typing when we have
+      # them based on the Closure and Location.
+      #
+      # @param pins [Array<Pin::LocalVariable>]
+      # @param name [String]
+      # @param closure [Pin::Closure]
+      # @param location [Location]
+      #
+      # @return [Array<Pin::LocalVariable>]
+      def self.visible_pins(pins, name, closure, location)
+        logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location})" }
+        pins_with_name = pins.select { |p| p.name == name }
+        if pins_with_name.empty?
+          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => [] - no pins with name" }
+          return []
+        end
+        pins_with_specific_visibility = pins.select { |p| p.name == name && p.presence && p.visible_at?(closure, location) }
+        if pins_with_specific_visibility.empty?
+          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{pins_with_name} - no pins with specific visibility" }
+          return pins_with_name
+        end
+        visible_pins_specific_to_this_closure = pins_with_specific_visibility.select { |p| p.closure == closure }
+        if visible_pins_specific_to_this_closure.empty?
+          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{pins_with_specific_visibility} - no visible pins specific to this closure (#{closure})}" }
+          return pins_with_specific_visibility
+        end
+        flow_defined_pins = pins_with_specific_visibility.select { |p| p.presence_certain? }
+        if flow_defined_pins.empty?
+          logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{visible_pins_specific_to_this_closure} - no flow-defined pins" }
+          return visible_pins_specific_to_this_closure
+        end
+
+        logger.debug { "FlowSensitiveTyping#visible_pins(name=#{name}, closure=#{closure}, location=#{location}) => #{flow_defined_pins}" }
+
+        flow_defined_pins
+      end
+
+      include Logging
+
+      private
+
+      # @param pin [Pin::LocalVariable]
+      # @param downcast_type_name [String]
+      # @param presence [Range]
+      #
+      # @return [void]
+      def add_downcast_local(pin, downcast_type_name, presence)
+        # @todo Create pin#update method
+        new_pin = Solargraph::Pin::LocalVariable.new(
+          location: pin.location,
+          closure: pin.closure,
+          name: pin.name,
+          assignment: pin.assignment,
+          comments: pin.comments,
+          presence: presence,
+          return_type: ComplexType.try_parse(downcast_type_name),
+          presence_certain: true,
+          source: :flow_sensitive_typing
+        )
+        locals.push(new_pin)
+      end
+
+      # @param facts_by_pin [Hash{Pin::LocalVariable => Array<Hash{Symbol => String}>}]
+      # @param presences [Array<Range>]
+      #
+      # @return [void]
+      def process_facts(facts_by_pin, presences)
+        #
+        # Add specialized locals for the rest of the block
+        #
+        facts_by_pin.each_pair do |pin, facts|
+          facts.each do |fact|
+            downcast_type_name = fact.fetch(:type)
+            presences.each do |presence|
+              add_downcast_local(pin, downcast_type_name, presence)
+            end
+          end
+        end
+      end
+
+      # @param conditional_node [Parser::AST::Node]
+      # @param true_ranges [Array<Range>]
+      #
+      # @return [void]
+      def process_conditional(conditional_node, true_ranges)
+        if conditional_node.type == :send
+          process_isa(conditional_node, true_ranges)
+        elsif conditional_node.type == :and
+          process_and(conditional_node, true_ranges)
+        end
+      end
+
+      # @param isa_node [Parser::AST::Node]
+      # @return [Array(String, String), nil]
+      def parse_isa(isa_node)
+        return unless isa_node&.type == :send && isa_node.children[1] == :is_a?
+        # Check if conditional node follows this pattern:
+        #   s(:send,
+        #     s(:send, nil, :foo), :is_a?,
+        #     s(:const, nil, :Baz)),
+        isa_receiver = isa_node.children[0]
+        isa_type_name = type_name(isa_node.children[2])
+        return unless isa_type_name
+
+        # check if isa_receiver looks like this:
+        #  s(:send, nil, :foo)
+        # and set variable_name to :foo
+        if isa_receiver&.type == :send && isa_receiver.children[0].nil? && isa_receiver.children[1].is_a?(Symbol)
+          variable_name = isa_receiver.children[1].to_s
+        end
+        # or like this:
+        # (lvar :repr)
+        variable_name = isa_receiver.children[0].to_s if isa_receiver&.type == :lvar
+        return unless variable_name
+
+        [isa_type_name, variable_name]
+      end
+
+      # @param variable_name [String]
+      # @param position [Position]
+      #
+      # @return [Solargraph::Pin::LocalVariable, nil]
+      def find_local(variable_name, position)
+        pins = locals.select { |pin| pin.name == variable_name && pin.presence.include?(position) }
+        return unless pins.length == 1
+        pins.first
+      end
+
+      # @param isa_node [Parser::AST::Node]
+      # @param true_presences [Array<Range>]
+      #
+      # @return [void]
+      def process_isa(isa_node, true_presences)
+        isa_type_name, variable_name = parse_isa(isa_node)
+        return if variable_name.nil? || variable_name.empty?
+        isa_position = Range.from_node(isa_node).start
+
+        pin = find_local(variable_name, isa_position)
+        return unless pin
+
+        if_true = {}
+        if_true[pin] ||= []
+        if_true[pin] << { type: isa_type_name }
+        process_facts(if_true, true_presences)
+      end
+
+      # @param node [Parser::AST::Node]
+      #
+      # @return [String, nil]
+      def type_name(node)
+        # e.g.,
+        #  s(:const, nil, :Baz)
+        return unless node&.type == :const
+        module_node = node.children[0]
+        class_node = node.children[1]
+
+        return class_node.to_s if module_node.nil?
+
+        module_type_name = type_name(module_node)
+        return unless module_type_name
+
+        "#{module_type_name}::#{class_node}"
+      end
+
+      # @param clause_node [Parser::AST::Node]
+      def always_breaks?(clause_node)
+        clause_node&.type == :break
+      end
+
+      attr_reader :locals
+
+      attr_reader :enclosing_breakable_pin
+    end
+  end
+end