solargraph 0.54.5 → 0.55.4

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'parser'
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class OpasgnNode < Parser::NodeProcessor::Base
+          def process
+            # Parser::CurrentRuby.parse("a += 2")
+            # => s(:op_asgn,
+            #      s(:lvasgn, :a), :+,
+            #      s(:int, 2))
+            asgn = node.children[0]
+            variable_name = asgn.children[0]
+            operator = node.children[1]
+            argument = node.children[2]
+            # for lvasgn, gvasgn, cvasgn, convert to lvar, gvar, cvar
+            # [6] pry(main)> Parser::CurrentRuby.parse("a = a + 1")
+            # => s(:lvasgn, :a,
+            #   s(:send,
+            #     s(:lvar, :a), :+,
+            #     s(:int, 1)))
+            # [7] pry(main)>
+            variable_reference_type = asgn.type.to_s.sub(/vasgn$/, 'var').to_sym
+            variable_reference = node.updated(variable_reference_type, asgn.children)
+            send_children = [
+              variable_reference,
+              operator,
+              argument
+            ]
+            send_node = node.updated(:send, send_children)
+            new_asgn = node.updated(asgn.type, [variable_name,  send_node])
+            NodeProcessor.process(new_asgn, region, pins, locals)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -24,7 +24,8 @@ module Solargraph
                 closure: region.closure,
                 name: node.children[1].children[0].to_s,
                 comments: "@type [#{types.join(',')}]",
-                presence: presence
+                presence: presence,
+                source: :parser
               )
             end
             NodeProcessor.process(node.children[2], region, pins, locals)

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

@@ -17,7 +17,7 @@ module Solargraph
                 names.concat [NodeMethods.unpack_name(sclass.children[0]), sclass.children[1].to_s]
               end
               name = names.reject(&:empty?).join('::')
-              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location, source: :parser)
             elsif sclass.is_a?(AST::Node) && sclass.type == :const
               names = [region.closure.namespace, region.closure.name]
               also = NodeMethods.unpack_name(sclass)
@@ -25,13 +25,14 @@ module Solargraph
                 names << also
               end
               name = names.reject(&:empty?).join('::')
-              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location, source: :parser)
             else
               return
             end
             pins.push Solargraph::Pin::Singleton.new(
               location: get_node_location(node),
-              closure: closure
+              closure: closure,
+              source: :parser,
             )
             process_children region.update(visibility: :public, scope: :class, closure: pins.last)
           end

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

@@ -34,7 +34,7 @@ module Solargraph
                 return if process_private_class_method
               end
             elsif node.children[1] == :require && node.children[0].to_s == '(const nil :Bundler)'
-              pins.push Pin::Reference::Require.new(Solargraph::Location.new(region.filename, Solargraph::Range.from_to(0, 0, 0, 0)), 'bundler/require')
+              pins.push Pin::Reference::Require.new(Solargraph::Location.new(region.filename, Solargraph::Range.from_to(0, 0, 0, 0)), 'bundler/require', source: :parser)
             end
             process_children
           end
@@ -76,7 +76,8 @@ module Solargraph
                   comments: cmnt,
                   scope: region.scope || :instance,
                   visibility: region.visibility,
-                  attribute: true
+                  attribute: true,
+                  source: :parser
                 )
               end
               if node.children[1] == :attr_writer || node.children[1] == :attr_accessor
@@ -87,10 +88,11 @@ module Solargraph
                   comments: cmnt,
                   scope: region.scope || :instance,
                   visibility: region.visibility,
-                  attribute: true
+                  attribute: true,
+                  source: :parser
                 )
                 pins.push method_pin
-                method_pin.parameters.push Pin::Parameter.new(name: 'value', decl: :arg, closure: pins.last)
+                method_pin.parameters.push Pin::Parameter.new(name: 'value', decl: :arg, closure: pins.last, source: :parser)
                 if method_pin.return_type.defined?
                   pins.last.docstring.add_tag YARD::Tags::Tag.new(:param, '', pins.last.return_type.items.map(&:rooted_tags), 'value')
                 end
@@ -107,7 +109,8 @@ module Solargraph
                 pins.push type.new(
                   location: get_node_location(i),
                   closure: cp,
-                  name: unpack_name(i)
+                  name: unpack_name(i),
+                  source: :parser
                 )
               end
             end
@@ -121,7 +124,8 @@ module Solargraph
                 pins.push Pin::Reference::Prepend.new(
                   location: get_node_location(i),
                   closure: cp,
-                  name: unpack_name(i)
+                  name: unpack_name(i),
+                  source: :parser
                 )
               end
             end
@@ -135,13 +139,15 @@ module Solargraph
                 pins.push Pin::Reference::Extend.new(
                   location: loc,
                   closure: region.closure,
-                  name: region.closure.full_context.namespace
+                  name: region.closure.full_context.namespace,
+                  source: :parser
                 )
               else
                 pins.push Pin::Reference::Extend.new(
                   location: loc,
                   closure: region.closure,
-                  name: unpack_name(i)
+                  name: unpack_name(i),
+                  source: :parser
                 )
               end
             end
@@ -151,7 +157,7 @@ module Solargraph
           def process_require
             if node.children[2].is_a?(AST::Node) && node.children[2].type == :str
               path = node.children[2].children[0].to_s
-              pins.push Pin::Reference::Require.new(get_node_location(node), path)
+              pins.push Pin::Reference::Require.new(get_node_location(node), path, source: :parser)
             end
           end
 
@@ -159,7 +165,7 @@ module Solargraph
           def process_autoload
             if node.children[3].is_a?(AST::Node) && node.children[3].type == :str
               path = node.children[3].children[0].to_s
-              pins.push Pin::Reference::Require.new(get_node_location(node), path)
+              pins.push Pin::Reference::Require.new(get_node_location(node), path, source: :parser)
             end
           end
 
@@ -171,7 +177,8 @@ module Solargraph
             elsif node.children[2].type == :sym || node.children[2].type == :str
               node.children[2..-1].each do |x|
                 cn = x.children[0].to_s
-                ref = pins.select{ |p| p.is_a?(Pin::Method) && p.namespace == region.closure.full_context.namespace && p.name == cn }.first
+                # @type [Pin::Method]
+                ref = pins.find { |p| p.is_a?(Pin::Method) && p.namespace == region.closure.full_context.namespace && p.name == cn }
                 unless ref.nil?
                   pins.delete ref
                   mm = Solargraph::Pin::Method.new(
@@ -182,7 +189,8 @@ module Solargraph
                     comments: ref.comments,
                     scope: :class,
                     visibility: :public,
-                    node: ref.node
+                    node: ref.node,
+                    source: :parser
                   )
                   cm = Solargraph::Pin::Method.new(
                     location: ref.location,
@@ -192,7 +200,8 @@ module Solargraph
                     comments: ref.comments,
                     scope: :instance,
                     visibility: :private,
-                    node: ref.node)
+                    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
@@ -201,14 +210,16 @@ module Solargraph
                       closure: cm,
                       name: ivar.name,
                       comments: ivar.comments,
-                      assignment: ivar.assignment
+                      assignment: ivar.assignment,
+                      source: :parser
                     )
                     pins.push Solargraph::Pin::InstanceVariable.new(
                       location: ivar.location,
                       closure: mm,
                       name: ivar.name,
                       comments: ivar.comments,
-                      assignment: ivar.assignment
+                      assignment: ivar.assignment,
+                      source: :parser
                     )
                   end
                 end
@@ -236,7 +247,8 @@ module Solargraph
               closure: region.closure,
               name: node.children[2].children[0].to_s,
               original: node.children[3].children[0].to_s,
-              scope: region.scope || :instance
+              scope: region.scope || :instance,
+              source: :parser
             )
           end
 

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

@@ -8,7 +8,8 @@ module Solargraph
           def process
             pins.push Solargraph::Pin::Symbol.new(
               get_node_location(node),
-              ":#{node.children[0]}"
+              ":#{node.children[0]}",
+              source: :parser
             )
           end
         end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class UntilNode < Parser::NodeProcessor::Base
+          include ParserGem::NodeMethods
+
+          def process
+            location = get_node_location(node)
+            # Note - this should not be considered a block, as the
+            # until statement doesn't create a closure - e.g.,
+            # variables created inside can be seen from outside as
+            # well
+            pins.push Solargraph::Pin::Until.new(
+              location: location,
+              closure: region.closure,
+              node: node,
+              comments: comments_for(node),
+              source: :parser,
+            )
+            process_children region
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class WhileNode < Parser::NodeProcessor::Base
+          include ParserGem::NodeMethods
+
+          def process
+            location = get_node_location(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
+            # well
+            pins.push Solargraph::Pin::While.new(
+              location: location,
+              closure: region.closure,
+              node: node,
+              comments: comments_for(node),
+              source: :parser,
+            )
+            process_children region
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -13,6 +13,7 @@ module Solargraph
         autoload :NamespaceNode, 'solargraph/parser/parser_gem/node_processors/namespace_node'
         autoload :SclassNode,    'solargraph/parser/parser_gem/node_processors/sclass_node'
         autoload :IvasgnNode,    'solargraph/parser/parser_gem/node_processors/ivasgn_node'
+        autoload :IfNode,        'solargraph/parser/parser_gem/node_processors/if_node'
         autoload :CvasgnNode,    'solargraph/parser/parser_gem/node_processors/cvasgn_node'
         autoload :LvasgnNode,    'solargraph/parser/parser_gem/node_processors/lvasgn_node'
         autoload :GvasgnNode,    'solargraph/parser/parser_gem/node_processors/gvasgn_node'
@@ -22,8 +23,12 @@ module Solargraph
         autoload :ArgsNode,      'solargraph/parser/parser_gem/node_processors/args_node'
         autoload :BlockNode,     'solargraph/parser/parser_gem/node_processors/block_node'
         autoload :OrasgnNode,    'solargraph/parser/parser_gem/node_processors/orasgn_node'
+        autoload :OpasgnNode,    'solargraph/parser/parser_gem/node_processors/opasgn_node'
         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 :WhileNode,     'solargraph/parser/parser_gem/node_processors/while_node'
+        autoload :AndNode,       'solargraph/parser/parser_gem/node_processors/and_node'
       end
     end
 
@@ -35,6 +40,7 @@ module Solargraph
       register :resbody,      ParserGem::NodeProcessors::ResbodyNode
       register :def,          ParserGem::NodeProcessors::DefNode
       register :defs,         ParserGem::NodeProcessors::DefsNode
+      register :if,           ParserGem::NodeProcessors::IfNode
       register :send,         ParserGem::NodeProcessors::SendNode
       register :class,        ParserGem::NodeProcessors::NamespaceNode
       register :module,       ParserGem::NodeProcessors::NamespaceNode
@@ -50,7 +56,11 @@ module Solargraph
       register :forward_args, ParserGem::NodeProcessors::ArgsNode
       register :block,        ParserGem::NodeProcessors::BlockNode
       register :or_asgn,      ParserGem::NodeProcessors::OrasgnNode
+      register :op_asgn,      ParserGem::NodeProcessors::OpasgnNode
       register :sym,          ParserGem::NodeProcessors::SymNode
+      register :until,        ParserGem::NodeProcessors::UntilNode
+      register :while,        ParserGem::NodeProcessors::WhileNode
+      register :and,          ParserGem::NodeProcessors::AndNode
     end
   end
 end

data/lib/solargraph/parser/region.rb

@@ -29,7 +29,7 @@ module Solargraph
                      scope: nil, visibility: :public, lvars: []
         @source = source
         # @closure = closure
-        @closure = closure || Pin::Namespace.new(name: '', location: source.location)
+        @closure = closure || Pin::Namespace.new(name: '', location: source.location, source: :parser)
         @scope = scope
         @visibility = visibility
         @lvars = lvars

data/lib/solargraph/parser.rb

@@ -4,6 +4,7 @@ module Solargraph
     autoload :ParserGem, 'solargraph/parser/parser_gem'
     autoload :Region, 'solargraph/parser/region'
     autoload :NodeProcessor, 'solargraph/parser/node_processor'
+    autoload :FlowSensitiveTyping, 'solargraph/parser/flow_sensitive_typing'
     autoload :Snippet, 'solargraph/parser/snippet'
 
     class SyntaxError < StandardError

data/lib/solargraph/pin/base.rb

@@ -27,17 +27,27 @@ module Solargraph
       # @return [::Symbol]
       attr_accessor :source
 
+      def presence_certain?
+        true
+      end
+
       # @param location [Solargraph::Location, nil]
       # @param type_location [Solargraph::Location, nil]
       # @param closure [Solargraph::Pin::Closure, nil]
       # @param name [String]
       # @param comments [String]
-      def initialize location: nil, type_location: nil, closure: nil, name: '', comments: ''
+      def initialize location: nil, type_location: nil, closure: nil, source: nil, name: '', comments: ''
         @location = location
         @type_location = type_location
         @closure = closure
         @name = name
         @comments = comments
+        @source = source
+        assert_source_provided
+      end
+
+      def assert_source_provided
+        Solargraph.assert_or_log(:source, "source not provided - #{@path} #{@source} #{self.class}") if source.nil?
       end
 
       # @return [String]
@@ -268,7 +278,7 @@ module Solargraph
       # @deprecated
       # @return [String]
       def identity
-        @identity ||= "#{closure&.path}|#{name}"
+        @identity ||= "#{closure&.path}|#{name}|#{location}"
       end
 
       # @return [String, nil]
@@ -293,14 +303,33 @@ module Solargraph
       end
 
       # @return [String]
-      def desc
+      def inner_desc
         closure_info = closure&.desc
         binder_info = binder&.desc
-        "[#{type_desc}, closure=#{closure_info}, binder=#{binder}"
+        "name=#{name.inspect} return_type=#{type_desc}, context=#{context.rooted_tags}, closure=#{closure_info}, binder=#{binder_info}"
+      end
+
+      def desc
+        "[#{inner_desc}]"
       end
 
       def inspect
-        "#<#{self.class} `#{self.desc}` at #{self.location.inspect}>"
+        "#<#{self.class} `#{self.inner_desc}`#{all_location_text} via #{source.inspect}>"
+      end
+
+      def all_location_text
+        if location.nil? && type_location.nil?
+          ''
+        elsif !location.nil? && type_location.nil?
+          " at #{location.inspect})"
+        elsif !type_location.nil? && location.nil?
+          " at #{type_location.inspect})"
+        else
+          " at (#{location.inspect} and #{type_location.inspect})"
+        end
+      end
+
+      def reset_generated!
       end
 
       protected

data/lib/solargraph/pin/base_variable.rb

@@ -11,12 +11,14 @@ module Solargraph
 
       attr_accessor :mass_assignment
 
+      # @param return_type [ComplexType, nil]
       # @param assignment [Parser::AST::Node, nil]
-      def initialize assignment: nil, **splat
+      def initialize assignment: nil, return_type: nil, **splat
         super(**splat)
         @assignment = assignment
         # @type [nil, ::Array(Parser::AST::Node, Integer)]
         @mass_assignment = nil
+        @return_type = return_type
       end
 
       def completion_item_kind
@@ -32,7 +34,10 @@ module Solargraph
         @return_type ||= generate_complex_type
       end
 
+      # @sg-ignore
       def nil_assignment?
+        # this will always be false - should it be return_type ==
+        #   ComplexType::NIL or somesuch?
         return_type.nil?
       end
 
@@ -88,6 +93,7 @@ module Solargraph
         ComplexType::UNDEFINED
       end
 
+      # @param other [Object]
       def == other
         return false unless super
         assignment == other.assignment

data/lib/solargraph/pin/block.rb

@@ -3,6 +3,8 @@
 module Solargraph
   module Pin
     class Block < Callable
+      include Breakable
+
       # @return [Parser::AST::Node]
       attr_reader :receiver
 

data/lib/solargraph/pin/breakable.rb

@@ -0,0 +1,9 @@
+module Solargraph
+  module Pin
+    # 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
+    end
+  end
+end

data/lib/solargraph/pin/callable.rb

@@ -6,7 +6,7 @@ module Solargraph
       # @return [Signature]
       attr_reader :block
 
-      attr_reader :parameters
+      attr_accessor :parameters
 
       # @return [ComplexType, nil]
       attr_reader :return_type
@@ -21,6 +21,10 @@ module Solargraph
         @parameters = parameters
       end
 
+      def method_namespace
+        closure.namespace
+      end
+
       # @return [::Array<String>]
       def parameter_names
         @parameter_names ||= parameters.map(&:name)
@@ -140,8 +144,6 @@ module Solargraph
       protected
 
       attr_writer :block
-
-      attr_writer :parameters
     end
   end
 end

data/lib/solargraph/pin/closure.rb

@@ -8,10 +8,15 @@ module Solargraph
 
       # @param scope [::Symbol] :class or :instance
       # @param generics [::Array<Pin::Parameter>, nil]
-      def initialize scope: :class, generics: nil, **splat
+      def initialize scope: :class, generics: nil, generic_defaults: {},  **splat
         super(**splat)
         @scope = scope
         @generics = generics
+        @generic_defaults = generic_defaults
+      end
+
+      def generic_defaults
+        @generic_defaults ||= {}
       end
 
       def context

data/lib/solargraph/pin/common.rb

@@ -9,6 +9,11 @@ module Solargraph
       # @return [Pin::Closure, nil]
       attr_reader :closure
 
+      def closure
+        Solargraph.assert_or_log(:closure, "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}") unless @closure
+        @closure
+      end
+
       # @return [String]
       def name
         @name ||= ''

data/lib/solargraph/pin/delegated_method.rb

@@ -24,8 +24,26 @@ module Solargraph
         @receiver_method_name = receiver_method_name
       end
 
-      %i[comments parameters return_type location].each do |method|
+      def inner_desc
+        "#{name} => #{@receiver_chain}##{@receiver_method_name}"
+      end
+
+      def location
+        return super if super
+
+        @resolved_method&.send(:location)
+      end
+
+
+      def type_location
+        return super if super
+
+        @resolved_method&.send(:type_location)
+      end
+
+      %i[comments parameters return_type signatures].each do |method|
         define_method(method) do
+          # @sg-ignore Need to set context correctly in define_method blocks
           @resolved_method ? @resolved_method.send(method) : super()
         end
       end
@@ -34,6 +52,7 @@ module Solargraph
         # @param api_map [ApiMap]
         define_method(method) do |api_map|
           resolve_method(api_map)
+          # @sg-ignore Need to set context correctly in define_method blocks
           @resolved_method ? @resolved_method.send(method, api_map) : super(api_map)
         end
       end

data/lib/solargraph/pin/documenting.rb

@@ -9,6 +9,22 @@ require 'solargraph/converters/dt'
 require 'solargraph/converters/dd'
 require 'solargraph/converters/misc'
 
+# @todo upstream this definition
+
+# @!parse
+#   module ::Kramdown
+#     class Document
+#       # @return [String]
+#       def to_html; end
+#     end
+#   end
+#   module ReverseMarkdown
+#     # @param input [String]
+#     # @param options [Hash]
+#     # @return [String]
+#     def self.convert(input, options = {}); end
+#   end
+
 module Solargraph
   module Pin
     # A module to add the Pin::Base#documentation method.

data/lib/solargraph/pin/keyword.rb

@@ -3,8 +3,13 @@
 module Solargraph
   module Pin
     class Keyword < Base
-      def initialize name
-        super(name: name)
+      def initialize(name, **kwargs)
+        # @sg-ignore "Unrecognized keyword argument kwargs to Solargraph::Pin::Base#initialize"
+        super(name: name, **kwargs)
+      end
+
+      def closure
+        @closure ||= Pin::ROOT_PIN
       end
 
       def name

data/lib/solargraph/pin/local_variable.rb

@@ -6,13 +6,19 @@ module Solargraph
       # @return [Range]
       attr_reader :presence
 
+      def presence_certain?
+        @presence_certain
+      end
+
       # @param assignment [AST::Node, nil]
       # @param presence [Range, nil]
+      # @param presence_certain [Boolean]
       # @param splat [Hash]
-      def initialize assignment: nil, presence: nil, **splat
+      def initialize assignment: nil, presence: nil, presence_certain: false, **splat
         super(**splat)
         @assignment = assignment
         @presence = presence
+        @presence_certain = presence_certain
       end
 
       # @param pin [self]