solargraph 0.54.0 → 0.55.0

data/lib/solargraph/pin/namespace.rb

@@ -14,21 +14,23 @@ module Solargraph
       # @param type [::Symbol] :class or :module
       # @param visibility [::Symbol] :public or :private
       # @param gates [::Array<String>]
-      def initialize type: :class, visibility: :public, gates: [''], **splat
+      # @param name [String]
+      def initialize type: :class, visibility: :public, gates: [''], name: '', **splat
         # super(location, namespace, name, comments)
-        super(**splat)
+        super(**splat, name: name)
         @type = type
         @visibility = visibility
         if name.start_with?('::')
-          @name = name[2..-1]
+          # @type [String]
+          name = name[2..-1] || ''
           @closure = Solargraph::Pin::ROOT_PIN
         end
         @open_gates = gates
-        if @name.include?('::')
+        if name.include?('::')
           # In this case, a chained namespace was opened (e.g., Foo::Bar)
           # but Foo does not exist.
-          parts = @name.split('::')
-          @name = parts.pop
+          parts = name.split('::')
+          name = parts.pop
           closure_name = if [Solargraph::Pin::ROOT_PIN, nil].include?(closure)
             ''
           else
@@ -38,17 +40,18 @@ module Solargraph
           @closure = Pin::Namespace.new(name: closure_name, gates: [parts.join('::')])
           @context = nil
         end
+        @name = name
       end
 
       def to_rbs
-        "#{@type.to_s} #{generics_as_rbs}#{return_type.to_rbs}"
+        "#{@type.to_s} #{return_type.all_params.first.to_rbs}#{rbs_generics}".strip
       end
 
       def desc
-        if name.nil?
+        if name.nil? || name.empty?
           '(top-level)'
         else
-          to_rbs
+          super
         end
       end
 
@@ -57,7 +60,7 @@ module Solargraph
       end
 
       def full_context
-        @full_context ||= ComplexType.try_parse("#{type.to_s.capitalize}<#{path}>")
+        @full_context ||= ComplexType.try_parse("::#{type.to_s.capitalize}<#{path}>")
       end
 
       def binder
@@ -83,7 +86,7 @@ module Solargraph
       end
 
       def return_type
-        @return_type ||= ComplexType.try_parse( (type == :class ? 'Class' : 'Module') + "<#{path}>" )
+        @return_type ||= ComplexType.try_parse( (type == :class ? '::Class' : '::Module') + "<::#{path}>")
       end
 
       # @return [Array<String>]

data/lib/solargraph/pin/parameter.rb

@@ -3,7 +3,7 @@
 module Solargraph
   module Pin
     class Parameter < LocalVariable
-      # @return [Symbol]
+      # @return [::Symbol]
       attr_reader :decl
 
       # @return [String]
@@ -11,12 +11,10 @@ module Solargraph
 
       # @param decl [::Symbol] :arg, :optarg, :kwarg, :kwoptarg, :restarg, :kwrestarg, :block, :blockarg
       # @param asgn_code [String, nil]
-      # @param return_type [ComplexType, nil]
-      def initialize decl: :arg, asgn_code: nil, return_type: nil, **splat
+      def initialize decl: :arg, asgn_code: nil, **splat
         super(**splat)
         @asgn_code = asgn_code
         @decl = decl
-        @return_type = return_type
       end
 
       def keyword?
@@ -27,6 +25,10 @@ module Solargraph
         decl == :kwrestarg || (assignment && [:HASH, :hash].include?(assignment.type))
       end
 
+      def arg?
+        decl == :arg
+      end
+
       def restarg?
         decl == :restarg
       end
@@ -84,11 +86,11 @@ module Solargraph
           @return_type = ComplexType.try_parse(*found.types) unless found.nil? or found.types.nil?
           if @return_type.undefined?
             if decl == :restarg
-              @return_type = ComplexType.try_parse('Array')
+              @return_type = ComplexType.try_parse('::Array')
             elsif decl == :kwrestarg
-              @return_type = ComplexType.try_parse('Hash')
+              @return_type = ComplexType.try_parse('::Hash')
             elsif decl == :blockarg
-              @return_type = ComplexType.try_parse('Proc')
+              @return_type = ComplexType.try_parse('::Proc')
             end
           end
         end
@@ -111,12 +113,22 @@ module Solargraph
         closure.is_a?(Pin::Block) ? typify_block_param(api_map) : typify_method_param(api_map)
       end
 
+      # @param atype [ComplexType]
+      # @param api_map [ApiMap]
+      def compatible_arg?(atype, api_map)
+        # make sure we get types from up the method
+        # inheritance chain if we don't have them on this pin
+        ptype = typify api_map
+        ptype.undefined? || ptype.can_assign?(api_map, atype) || ptype.generic?
+      end
+
       def documentation
         tag = param_tag
         return '' if tag.nil? || tag.text.nil?
         tag.text
       end
 
+      # @param pin [Pin::Parameter]
       def try_merge! pin
         return false unless super && closure == pin.closure
         true
@@ -126,24 +138,19 @@ module Solargraph
 
       # @return [YARD::Tags::Tag, nil]
       def param_tag
-        found = nil
         params = closure.docstring.tags(:param)
         params.each do |p|
-          next unless p.name == name
-          found = p
-          break
-        end
-        if found.nil? and !index.nil?
-          found = params[index] if params[index] && (params[index].name.nil? || params[index].name.empty?)
+          return p if p.name == name
         end
-        found
+        params[index] if index && params[index] && (params[index].name.nil? || params[index].name.empty?)
       end
 
       # @param api_map [ApiMap]
       # @return [ComplexType]
       def typify_block_param api_map
-        if closure.is_a?(Pin::Block) && closure.receiver
-          return closure.typify_parameters(api_map)[index]
+        block_pin = closure
+        if block_pin.is_a?(Pin::Block) && block_pin.receiver
+          return block_pin.typify_parameters(api_map)[index]
         end
         ComplexType::UNDEFINED
       end

data/lib/solargraph/pin/proxy_type.rb

@@ -4,24 +4,30 @@ module Solargraph
   module Pin
     class ProxyType < Base
       # @param return_type [ComplexType]
-      def initialize return_type: ComplexType::UNDEFINED, **splat
+      def initialize return_type: ComplexType::UNDEFINED, binder: nil, **splat
         super(**splat)
         @return_type = return_type
+        @binder = binder if binder
       end
 
       def context
         @return_type
       end
 
-      # @param return_type [ComplexType]
+      # @param context [ComplexType, ComplexType::UniqueType] Used as context for this pin
+      # @param closure [Pin::Namespace, nil] Used as the closure for this pin
+      # @param binder [ComplexType, ComplexType::UniqueType, nil]
       # @return [ProxyType]
-      def self.anonymous return_type
-        parts = return_type.namespace.split('::')
-        namespace = parts[0..-2].join('::').to_s
-        name = parts.last.to_s
+      def self.anonymous context, closure: nil, binder: nil
+        unless closure
+          parts = context.namespace.split('::')
+          namespace = parts[0..-2].join('::').to_s
+          closure = Solargraph::Pin::Namespace.new(name: namespace)
+        end
+        # name = parts.last.to_s
         # ProxyType.new(nil, namespace, name, return_type)
         ProxyType.new(
-          closure: Solargraph::Pin::Namespace.new(name: namespace), return_type: return_type
+          closure: closure, return_type: context, binder: binder || context
         )
       end
     end

data/lib/solargraph/pin/signature.rb

@@ -1,143 +1,17 @@
 module Solargraph
   module Pin
-    class Signature < Base
-      # @return [::Array<Parameter>]
-      attr_reader :parameters
-
-      # @return [ComplexType]
-      attr_reader :return_type
-
-      # @return [self]
-      attr_reader :block
-
-      # @param generics [Array<String>]
-      # @param parameters [Array<Parameter>]
-      # @param return_type [ComplexType]
-      # @param block [Signature, nil]
-      def initialize generics, parameters, return_type, block = nil
-        @generics = generics
-        @parameters = parameters
-        @return_type = return_type
-        @block = block
+    class Signature < Callable
+      def initialize **splat
+        super(**splat)
       end
 
       def generics
         @generics ||= [].freeze
       end
 
-      # @return [String]
-      def to_rbs
-        rbs_generics + '(' + parameters.map { |param| param.to_rbs }.join(', ') + ') ' + (block.nil? ? '' : '{ ' + block.to_rbs + ' } ') + '-> ' + return_type.to_rbs
-      end
-
-      # @return [String]
-      def rbs_generics
-        if generics.empty?
-          return ''
-        else
-          return '[' + generics.map { |gen| gen.to_s }.join(', ') + '] '
-        end
-      end
-
-      # @return [Array<String>]
-      # @yieldparam [ComplexType]
-      # @yieldreturn [ComplexType]
-      # @return [self]
-      def transform_types(&transform)
-        # @todo 'super' alone should work here I think, but doesn't typecheck at level typed
-        signature = super(&transform)
-        signature.parameters = signature.parameters.map do |param|
-          param.transform_types(&transform)
-        end
-        signature.block = block.transform_types(&transform) if signature.block?
-        signature
-      end
-
-      # @param generics_to_resolve [Enumerable<String>]
-      # @param arg_types [Array<ComplexType>, nil]
-      # @param return_type_context [ComplexType, nil]
-      # @param yield_arg_types [Array<ComplexType>, nil]
-      # @param yield_return_type_context [ComplexType, nil]
-      # @param context [ComplexType, nil]
-      # @param resolved_generic_values [Hash{String => ComplexType}]
-      # @return [self]
-      def resolve_generics_from_context(generics_to_resolve,
-                                        arg_types = nil,
-                                        return_type_context = nil,
-                                        yield_arg_types = nil,
-                                        yield_return_type_context = nil,
-                                        resolved_generic_values: {})
-        signature = super(generics_to_resolve, return_type_context, resolved_generic_values: resolved_generic_values)
-        signature.parameters = signature.parameters.each_with_index.map do |param, i|
-          if arg_types.nil?
-            param.dup
-          else
-            param.resolve_generics_from_context(generics_to_resolve,
-                                                arg_types[i],
-                                                resolved_generic_values: resolved_generic_values)
-          end
-        end
-        signature.block = block.resolve_generics_from_context(generics_to_resolve,
-                                                              yield_arg_types,
-                                                              yield_return_type_context,
-                                                              resolved_generic_values: resolved_generic_values) if signature.block?
-        signature
-      end
-
-      # @param generics_to_resolve [Enumerable<String>]
-      # @param arg_types [Array<ComplexType>, nil]
-      # @param return_type_context [ComplexType, nil]
-      # @param yield_arg_types [Array<ComplexType>, nil]
-      # @param yield_return_type_context [ComplexType, nil]
-      # @param context [ComplexType, nil]
-      # @param resolved_generic_values [Hash{String => ComplexType}]
-      # @return [self]
-      def resolve_generics_from_context_until_complete(generics_to_resolve,
-                                                       arg_types = nil,
-                                                       return_type_context = nil,
-                                                       yield_arg_types = nil,
-                                                       yield_return_type_context = nil,
-                                                       resolved_generic_values: {})
-        # See
-        # https://github.com/soutaro/steep/tree/master/lib/steep/type_inference
-        # and
-        # https://github.com/sorbet/sorbet/blob/master/infer/inference.cc
-        # for other implementations
-
-        return self if generics_to_resolve.empty?
-
-        last_resolved_generic_values = resolved_generic_values.dup
-        new_pin = resolve_generics_from_context(generics_to_resolve,
-                                                arg_types,
-                                                return_type_context,
-                                                yield_arg_types,
-                                                yield_return_type_context,
-                                                resolved_generic_values: resolved_generic_values)
-        if last_resolved_generic_values == resolved_generic_values
-          # erase anything unresolved
-          return new_pin.erase_generics(self.generics)
-        end
-        new_pin.resolve_generics_from_context_until_complete(generics_to_resolve,
-                                                             arg_types,
-                                                             return_type_context,
-                                                             yield_arg_types,
-                                                             yield_return_type_context,
-                                                             resolved_generic_values: resolved_generic_values)
-      end
-
       def identity
         @identity ||= "signature#{object_id}"
       end
-
-      def block?
-        !!@block
-      end
-
-      protected
-
-      attr_writer :block
-
-      attr_writer :parameters
     end
   end
 end

data/lib/solargraph/pin/until.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Until < Base
+      include Breakable
+
+      # @param receiver [Parser::AST::Node, nil]
+      # @param node [Parser::AST::Node, nil]
+      # @param context [ComplexType, nil]
+      # @param args [::Array<Parameter>]
+      def initialize node: nil, **splat
+        super(**splat)
+        @node = node
+      end
+    end
+  end
+end

data/lib/solargraph/pin/while.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class While < Base
+      include Breakable
+
+      # @param receiver [Parser::AST::Node, nil]
+      # @param node [Parser::AST::Node, nil]
+      # @param context [ComplexType, nil]
+      # @param args [::Array<Parameter>]
+      def initialize node: nil, **splat
+        super(**splat)
+        @node = node
+      end
+    end
+  end
+end

data/lib/solargraph/pin.rb

@@ -3,7 +3,9 @@
 require 'yard'
 
 module Solargraph
-  # The namespace for pins used in maps.
+  # The namespace for Pins used in SourceMaps.
+  #
+  # Pins represent declarations, from gems, Sources, and the Ruby core.
   #
   module Pin
     autoload :Common,           'solargraph/pin/common'
@@ -32,6 +34,10 @@ module Solargraph
     autoload :Singleton,        'solargraph/pin/singleton'
     autoload :KeywordParam,     'solargraph/pin/keyword_param'
     autoload :Search,           'solargraph/pin/search'
+    autoload :Breakable,        'solargraph/pin/breakable'
+    autoload :Until,            'solargraph/pin/until'
+    autoload :While,            'solargraph/pin/while'
+    autoload :Callable,         'solargraph/pin/callable'
 
     ROOT_PIN = Pin::Namespace.new(type: :class, name: '', closure: nil)
   end

data/lib/solargraph/position.rb

@@ -4,6 +4,8 @@ module Solargraph
   # The zero-based line and column numbers of a position in a string.
   #
   class Position
+    include Equality
+
     # @return [Integer]
     attr_reader :line
 
@@ -19,6 +21,11 @@ module Solargraph
       @character = character
     end
 
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [line, character]
+    end
+
     # Get a hash of the position. This representation is suitable for use in
     # the language server protocol.
     #

data/lib/solargraph/range.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 module Solargraph
-  # A pair of positions that compose a section of text.
+  # A pair of Positions that compose a section of text in code.
   #
   class Range
+    include Equality
+
     # @return [Position]
     attr_reader :start
 
@@ -17,6 +19,11 @@ module Solargraph
       @ending = ending
     end
 
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [start, ending]
+    end
+
     # Get a hash of the range. This representation is suitable for use in
     # the language server protocol.
     #
@@ -65,9 +72,7 @@ module Solargraph
     # @param node [Parser::AST::Node]
     # @return [Range, nil]
     def self.from_node node
-      if Parser.rubyvm? && node.is_a?(RubyVM::AbstractSyntaxTree::Node)
-        Solargraph::Range.from_to(node.first_lineno - 1, node.first_column, node.last_lineno - 1, node.last_column)
-      elsif node&.loc && node.loc.expression
+      if node&.loc && node.loc.expression
         from_expr(node.loc.expression)
       end
     end