solargraph 0.58.2 → 0.59.0.dev.1

data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb

@@ -5,6 +5,7 @@ module Solargraph
     module ParserGem
       module NodeProcessors
         class SclassNode < Parser::NodeProcessor::Base
+          # @sg-ignore @override is adding, not overriding
           def process
             sclass = node.children[0]
             # @todo Changing Parser::AST::Node to AST::Node below will

data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb

@@ -7,6 +7,7 @@ module Solargraph
         class SendNode < Parser::NodeProcessor::Base
           include ParserGem::NodeMethods
 
+          # @sg-ignore @override is adding, not overriding
           def process
             # @sg-ignore Variable type could not be inferred for method_name
             # @type [Symbol]
@@ -53,6 +54,7 @@ module Solargraph
           # @return [void]
           def process_visibility
             if (node.children.length > 2)
+              # @sg-ignore Need to add nil check here
               node.children[2..-1].each do |child|
                 # @sg-ignore Variable type could not be inferred for method_name
                 # @type [Symbol]
@@ -82,6 +84,7 @@ module Solargraph
 
           # @return [void]
           def process_attribute
+            # @sg-ignore Need to add nil check here
             node.children[2..-1].each do |a|
               loc = get_node_location(node)
               clos = region.closure
@@ -122,6 +125,7 @@ module Solargraph
           def process_include
             if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
               cp = region.closure
+              # @sg-ignore Need to add nil check here
               node.children[2..-1].each do |i|
                 type = region.scope == :class ? Pin::Reference::Extend : Pin::Reference::Include
                 pins.push type.new(
@@ -138,6 +142,7 @@ module Solargraph
           def process_prepend
             if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
               cp = region.closure
+              # @sg-ignore Need to add nil check here
               node.children[2..-1].each do |i|
                 pins.push Pin::Reference::Prepend.new(
                   location: get_node_location(i),
@@ -151,6 +156,7 @@ module Solargraph
 
           # @return [void]
           def process_extend
+            # @sg-ignore Need to add nil check here
             node.children[2..-1].each do |i|
               loc = get_node_location(node)
               if i.type == :self
@@ -193,6 +199,7 @@ module Solargraph
               # @todo Smelly instance variable access
               region.instance_variable_set(:@visibility, :module_function)
             elsif node.children[2].type == :sym || node.children[2].type == :str
+              # @sg-ignore Need to add nil check here
               node.children[2..-1].each do |x|
                 cn = x.children[0].to_s
                 # @type [Pin::Method, nil]
@@ -221,23 +228,21 @@ module Solargraph
                     node: ref.node,
                     source: :parser)
                   pins.push mm, cm
-                  pins.select{|pin| pin.is_a?(Pin::InstanceVariable) && pin.closure.path == ref.path}.each do |ivar|
-                    pins.delete ivar
-                    pins.push Solargraph::Pin::InstanceVariable.new(
+                  ivars.select{|pin| pin.is_a?(Pin::InstanceVariable) && pin.closure.path == ref.path}.each do |ivar|
+                    ivars.delete ivar
+                    ivars.push Solargraph::Pin::InstanceVariable.new(
                       location: ivar.location,
                       closure: cm,
                       name: ivar.name,
                       comments: ivar.comments,
-                      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
                       assignment: ivar.assignment,
                       source: :parser
                     )
-                    pins.push Solargraph::Pin::InstanceVariable.new(
+                    ivars.push Solargraph::Pin::InstanceVariable.new(
                       location: ivar.location,
                       closure: mm,
                       name: ivar.name,
                       comments: ivar.comments,
-                      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
                       assignment: ivar.assignment,
                       source: :parser
                     )
@@ -245,7 +250,7 @@ module Solargraph
                 end
               end
             elsif node.children[2].type == :def
-              NodeProcessor.process node.children[2], region.update(visibility: :module_function), pins, locals
+              NodeProcessor.process node.children[2], region.update(visibility: :module_function), pins, locals, ivars
             end
           end
 

data/lib/solargraph/parser/parser_gem/node_processors/when_node.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class WhenNode < Parser::NodeProcessor::Base
+          include ParserGem::NodeMethods
+
+          def process
+            pins.push Solargraph::Pin::CompoundStatement.new(
+              location: get_node_location(node),
+              closure: region.closure,
+              node: node,
+              source: :parser,
+            )
+            process_children
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb

@@ -8,7 +8,11 @@ module Solargraph
           include ParserGem::NodeMethods
 
           def process
-            location = get_node_location(node)
+            FlowSensitiveTyping.new(locals,
+                                    ivars,
+                                    enclosing_breakable_pin,
+                                    enclosing_compound_statement_pin).process_while(node)
+
             # Note - this should not be considered a block, as the
             # while statement doesn't create a closure - e.g.,
             # variables created inside can be seen from outside as

data/lib/solargraph/parser/parser_gem/node_processors.rb

@@ -27,8 +27,10 @@ module Solargraph
         autoload :SymNode,       'solargraph/parser/parser_gem/node_processors/sym_node'
         autoload :ResbodyNode,   'solargraph/parser/parser_gem/node_processors/resbody_node'
         autoload :UntilNode,     'solargraph/parser/parser_gem/node_processors/until_node'
+        autoload :WhenNode,      'solargraph/parser/parser_gem/node_processors/when_node'
         autoload :WhileNode,     'solargraph/parser/parser_gem/node_processors/while_node'
         autoload :AndNode,       'solargraph/parser/parser_gem/node_processors/and_node'
+        autoload :OrNode,        'solargraph/parser/parser_gem/node_processors/or_node'
       end
     end
 
@@ -63,8 +65,10 @@ module Solargraph
       register :op_asgn,      ParserGem::NodeProcessors::OpasgnNode
       register :sym,          ParserGem::NodeProcessors::SymNode
       register :until,        ParserGem::NodeProcessors::UntilNode
+      register :when,         ParserGem::NodeProcessors::WhenNode
       register :while,        ParserGem::NodeProcessors::WhileNode
       register :and,          ParserGem::NodeProcessors::AndNode
+      register :or,           ParserGem::NodeProcessors::OrNode
     end
   end
 end

data/lib/solargraph/parser/region.rb

@@ -22,7 +22,6 @@ module Solargraph
       attr_reader :lvars
 
       # @param source [Source]
-      # @param namespace [String]
       # @param closure [Pin::Closure, nil]
       # @param scope [Symbol, nil]
       # @param visibility [Symbol]
@@ -30,18 +29,25 @@ module Solargraph
       def initialize source: Solargraph::Source.load_string(''), closure: nil,
                      scope: nil, visibility: :public, lvars: []
         @source = source
-        # @closure = closure
         @closure = closure || Pin::Namespace.new(name: '', location: source.location, source: :parser)
         @scope = scope
         @visibility = visibility
         @lvars = lvars
       end
 
-      # @return [String]
+      # @return [String, nil]
       def filename
         source.filename
       end
 
+      # @return [Pin::Namespace, nil]
+      def namespace_pin
+        ns = closure
+        # @sg-ignore flow sensitive typing needs to handle while
+        ns = ns.closure while ns && !ns.is_a?(Pin::Namespace)
+        ns
+      end
+
       # Generate a new Region with the provided attribute changes.
       #
       # @param closure [Pin::Closure, nil]

data/lib/solargraph/parser/snippet.rb

@@ -1,7 +1,7 @@
 module Solargraph
   module Parser
     class Snippet
-      # @return [Range]
+      # @return [Solargraph::Range]
       attr_reader :range
       # @return [String]
       attr_reader :text

data/lib/solargraph/pin/base.rb

@@ -41,7 +41,7 @@ module Solargraph
       # @param type_location [Solargraph::Location, nil]
       # @param closure [Solargraph::Pin::Closure, nil]
       # @param name [String]
-      # @param comments [String]
+      # @param comments [String, nil]
       # @param source [Symbol, nil]
       # @param docstring [YARD::Docstring, nil]
       # @param directives [::Array<YARD::Tags::Directive>, nil]
@@ -57,6 +57,9 @@ module Solargraph
         @docstring = docstring
         @directives = directives
         @combine_priority = combine_priority
+        # @type [ComplexType, ComplexType::UniqueType, nil]
+        @binder = nil
+
 
         assert_source_provided
         assert_location_provided
@@ -72,7 +75,6 @@ module Solargraph
       # @return [Pin::Closure, nil]
       def closure
         Solargraph.assert_or_log(:closure, "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}") unless @closure
-        # @type [Pin::Closure, nil]
         @closure
       end
 
@@ -81,7 +83,6 @@ module Solargraph
       #
       # @return [self]
       def combine_with(other, attrs={})
-        raise "tried to combine #{other.class} with #{self.class}" unless other.class == self.class
         priority_choice = choose_priority(other)
         return priority_choice unless priority_choice.nil?
 
@@ -92,7 +93,7 @@ module Solargraph
           location: location,
           type_location: type_location,
           name: combined_name,
-          closure: choose_pin_attr_with_same_name(other, :closure),
+          closure: combine_closure(other),
           comments: choose_longer(other, :comments),
           source: :combined,
           docstring: choose(other, :docstring),
@@ -140,14 +141,22 @@ module Solargraph
       end
 
       # @param other [self]
+      #
       # @return [::Array<YARD::Tags::Directive>, nil]
       def combine_directives(other)
         return self.directives if other.directives.empty?
         return other.directives if directives.empty?
-        [directives + other.directives].uniq
+        (directives + other.directives).uniq
+      end
+
+      # @param other [self]
+      # @return [Pin::Closure, nil]
+      def combine_closure(other)
+        choose_pin_attr_with_same_name(other, :closure)
       end
 
       # @param other [self]
+      # @sg-ignore @type should override probed type
       # @return [String]
       def combine_name(other)
         if needs_consistent_name? || other.needs_consistent_name?
@@ -170,6 +179,9 @@ module Solargraph
         # Same with @directives, @macros, @maybe_directives, which
         # regenerate docstring
         @deprecated = nil
+        @context = nil
+        @binder = nil
+        @path = nil
         reset_conversions
       end
 
@@ -189,6 +201,10 @@ module Solargraph
           other.return_type
         elsif other.return_type.undefined?
           return_type
+        elsif return_type.erased_version_of?(other.return_type)
+          other.return_type
+        elsif other.return_type.erased_version_of?(return_type)
+          return_type
         elsif dodgy_return_type_source? && !other.dodgy_return_type_source?
           other.return_type
         elsif other.dodgy_return_type_source? && !dodgy_return_type_source?
@@ -203,9 +219,12 @@ module Solargraph
         end
       end
 
+      # @sg-ignore need boolish support for ? methods
       def dodgy_return_type_source?
         # uses a lot of 'Object' instead of 'self'
-        location&.filename&.include?('core_ext/object/')
+        location&.filename&.include?('core_ext/object/') ||
+          # ditto
+          location&.filename&.include?('stdlib/date/0/date.rbs')
       end
 
       # when choices are arbitrary, make sure the choice is consistent
@@ -213,11 +232,13 @@ module Solargraph
       # @param other [Pin::Base]
       # @param attr [::Symbol]
       #
-      # @return [Object, nil]
+      # @sg-ignore
+      # @return [undefined, nil]
       def choose(other, attr)
         results = [self, other].map(&attr).compact
         # true and false are different classes and can't be sorted
         return true if results.any? { |r| r == true || r == false }
+        return results.first if results.any? { |r| r.is_a? AST::Node }
         results.min
       rescue
         STDERR.puts("Problem handling #{attr} for \n#{self.inspect}\n and \n#{other.inspect}\n\n#{self.send(attr).inspect} vs #{other.send(attr).inspect}")
@@ -250,6 +271,7 @@ module Solargraph
         end
       end
 
+      # @sg-ignore need boolish support for ? methods
       def rbs_location?
         type_location&.rbs?
       end
@@ -309,7 +331,11 @@ module Solargraph
       # @sg-ignore
       # @return [undefined]
       def assert_same(other, attr)
-        return false if other.nil?
+        if other.nil?
+          Solargraph.assert_or_log("combine_with_#{attr}_nil".to_sym,
+                                   "Other was passed in nil in assert_same on #{self}")
+          return send(attr)
+        end
         val1 = send(attr)
         val2 = other.send(attr)
         return val1 if val1 == val2
@@ -358,8 +384,11 @@ module Solargraph
           [
             # maximize number of gates, as types in other combined pins may
             # depend on those gates
+
+            # @sg-ignore Need better handling of #compact
             closure.gates.length,
             # use basename so that results don't vary system to system
+            # @sg-ignore Need better handling of #compact
             File.basename(closure.best_location.to_s)
           ]
         end
@@ -376,7 +405,7 @@ module Solargraph
       end
 
       # @param generics_to_resolve [Enumerable<String>]
-      # @param return_type_context [ComplexType, nil]
+      # @param return_type_context [ComplexType, ComplexType::UniqueType, nil]
       # @param context [ComplexType]
       # @param resolved_generic_values [Hash{String => ComplexType}]
       # @return [self]
@@ -418,6 +447,7 @@ module Solargraph
       # @return [String, nil]
       def filename
         return nil if location.nil?
+        # @sg-ignore flow sensitive typing needs to handle attrs
         location.filename
       end
 
@@ -453,11 +483,16 @@ module Solargraph
       # @return [Boolean]
       def nearly? other
         self.class == other.class &&
+          # @sg-ignore Translate to something flow sensitive typing understands
           name == other.name &&
+          # @sg-ignore flow sensitive typing needs to handle attrs
           (closure == other.closure || (closure && closure.nearly?(other.closure))) &&
+          # @sg-ignore Translate to something flow sensitive typing understands
           (comments == other.comments ||
+            # @sg-ignore Translate to something flow sensitive typing understands
             (((maybe_directives? == false && other.maybe_directives? == false) || compare_directives(directives, other.directives)) &&
-            compare_docstring_tags(docstring, other.docstring))
+             # @sg-ignore Translate to something flow sensitive typing understands
+             compare_docstring_tags(docstring, other.docstring))
           )
       end
 
@@ -484,6 +519,7 @@ module Solargraph
         @docstring ||= Solargraph::Source.parse_docstring('').to_docstring
       end
 
+      # @sg-ignore parse_comments will always set @directives
       # @return [::Array<YARD::Tags::Directive>]
       def directives
         parse_comments unless @directives
@@ -520,7 +556,7 @@ module Solargraph
       # provided ApiMap.
       #
       # @param api_map [ApiMap]
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def typify api_map
         return_type.qualify(api_map, *(closure&.gates || ['']))
       end
@@ -528,16 +564,16 @@ module Solargraph
       # Infer the pin's return type via static code analysis.
       #
       # @param api_map [ApiMap]
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def probe api_map
         typify api_map
       end
 
       # @deprecated Use #typify and/or #probe instead
       # @param api_map [ApiMap]
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType]
       def infer api_map
-        Solargraph::Logging.logger.warn "WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead."
+        Solargraph.assert_or_log(:pin_infer, 'WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead.')
         type = typify(api_map)
         return type unless type.undefined?
         probe api_map
@@ -568,7 +604,7 @@ module Solargraph
       # the return type and the #proxied? setting, the proxy should be a clone
       # of the original.
       #
-      # @param return_type [ComplexType]
+      # @param return_type [ComplexType, ComplexType::UniqueType, nil]
       # @return [self]
       def proxy return_type
         result = dup
@@ -618,7 +654,7 @@ module Solargraph
 
       # @return [String]
       def inner_desc
-        closure_info = closure&.desc
+        closure_info = closure&.name.inspect
         binder_info = binder&.desc
         "name=#{name.inspect} return_type=#{type_desc}, context=#{context.rooted_tags}, closure=#{closure_info}, binder=#{binder_info}"
       end
@@ -646,10 +682,6 @@ module Solargraph
         end
       end
 
-      # @return [void]
-      def reset_generated!
-      end
-
       protected
 
       # @return [Boolean]
@@ -658,7 +690,7 @@ module Solargraph
       # @return [Boolean]
       attr_writer :proxied
 
-      # @return [ComplexType]
+      # @return [ComplexType, ComplexType::UniqueType, nil]
       attr_writer :return_type
 
       attr_writer :docstring