solargraph 0.52.0 → 0.53.0

data/lib/solargraph/parser/parser_gem.rb

@@ -0,0 +1,12 @@
+module Solargraph
+  module Parser
+    module ParserGem
+      autoload :FlawedBuilder, 'solargraph/parser/parser_gem/flawed_builder'
+      autoload :ClassMethods, 'solargraph/parser/parser_gem/class_methods'
+      autoload :NodeMethods, 'solargraph/parser/parser_gem/node_methods'
+      autoload :NodeChainer, 'solargraph/parser/parser_gem/node_chainer'
+    end
+  end
+end
+
+require 'solargraph/parser/parser_gem/node_processors'

data/lib/solargraph/parser/snippet.rb

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

data/lib/solargraph/parser.rb

@@ -1,8 +1,7 @@
 module Solargraph
   module Parser
     autoload :CommentRipper, 'solargraph/parser/comment_ripper'
-    autoload :Legacy, 'solargraph/parser/legacy'
-    autoload :Rubyvm, 'solargraph/parser/rubyvm'
+    autoload :ParserGem, 'solargraph/parser/parser_gem'
     autoload :Region, 'solargraph/parser/region'
     autoload :NodeProcessor, 'solargraph/parser/node_processor'
     autoload :Snippet, 'solargraph/parser/snippet'
@@ -10,19 +9,17 @@ module Solargraph
     class SyntaxError < StandardError
     end
 
-    # True if the parser can use RubyVM.
-    #
     def self.rubyvm?
-      # !!defined?(RubyVM::AbstractSyntaxTree)
       false
     end
 
-    selected = rubyvm? ? Rubyvm : Legacy
-    # include selected
-    # @!parse
-    #   extend Solargraph::Parser::Legacy::ClassMethods
-    extend selected::ClassMethods
+    # @deprecated
+    Legacy = ParserGem
 
-    NodeMethods = (rubyvm? ? Rubyvm::NodeMethods : Legacy::NodeMethods)
+    ClassMethods = ParserGem::ClassMethods
+
+    extend ParserGem::ClassMethods
+
+    NodeMethods = ParserGem::NodeMethods
   end
 end

data/lib/solargraph/pin/base.rb

@@ -25,7 +25,6 @@ module Solargraph
       attr_accessor :source
 
       # @param location [Solargraph::Location, nil]
-      # @param kind [Integer]
       # @param closure [Solargraph::Pin::Closure, nil]
       # @param name [String]
       # @param comments [String]
@@ -41,6 +40,43 @@ module Solargraph
         @comments ||= ''
       end
 
+      # @param generics_to_resolve [Enumerable<String>]
+      # @param return_type_context [ComplexType, nil]
+      # @param context [ComplexType]
+      # @param resolved_generic_values [Hash{String => ComplexType}]
+      # @return [self]
+      def resolve_generics_from_context(generics_to_resolve, return_type_context = nil, resolved_generic_values: {})
+        proxy return_type.resolve_generics_from_context(generics_to_resolve,
+                                                        return_type_context,
+                                                        resolved_generic_values: resolved_generic_values)
+      end
+
+      # @yieldparam [ComplexType]
+      # @yieldreturn [ComplexType]
+      # @return [self]
+      def transform_types(&transform)
+        proxy return_type.transform(&transform)
+      end
+
+      # Determine the concrete type for each of the generic type
+      # parameters used in this method based on the parameters passed
+      # into the its class and return a new method pin.
+      #
+      # @param definitions [Pin::Namespace] The module/class which uses generic types
+      # @param context_type [ComplexType] The receiver type
+      # @return [self]
+      def resolve_generics definitions, context_type
+        transformed = transform_types { |t| t.resolve_generics(definitions, context_type) if t }
+        transformed.erase_generics(definitions.generics)
+      end
+
+      # @param generics_to_erase [Enumerable<String>]
+      # @return [self]
+      def erase_generics(generics_to_erase)
+        return self if generics_to_erase.empty?
+        transform_types { |t| t.erase_generics(generics_to_erase) }
+      end
+
       # @return [String, nil]
       def filename
         return nil if location.nil?
@@ -58,7 +94,7 @@ module Solargraph
       end
 
       def to_s
-        name.to_s
+        to_rbs
       end
 
       # @return [Boolean]
@@ -103,13 +139,13 @@ module Solargraph
         @docstring ||= Solargraph::Source.parse_docstring('').to_docstring
       end
 
-      # @return [Array<YARD::Tags::Directive>]
+      # @return [::Array<YARD::Tags::Directive>]
       def directives
         parse_comments unless defined?(@directives)
         @directives
       end
 
-      # @return [Array<YARD::Tags::MacroDirective>]
+      # @return [::Array<YARD::Tags::MacroDirective>]
       def macros
         @macros ||= collect_macros
       end
@@ -216,12 +252,31 @@ module Solargraph
         result
       end
 
+      # @return [String]
       def identity
         @identity ||= "#{closure.path}|#{name}"
       end
 
+      # @return [String, nil]
+      def to_rbs
+        return_type.to_rbs
+      end
+
+      # @return [String, nil]
+      def desc
+        if path
+          if to_rbs
+            path + ' ' + to_rbs
+          else
+            path
+          end
+        else
+          to_rbs
+        end
+      end
+
       def inspect
-        "#<#{self.class} `#{self.path}` at #{self.location.inspect}>"
+        "#<#{self.class} `#{self.desc}` at #{self.location.inspect}>"
       end
 
       protected
@@ -266,8 +321,8 @@ module Solargraph
         true
       end
 
-      # @param dir1 [Array<YARD::Tags::Directive>]
-      # @param dir2 [Array<YARD::Tags::Directive>]
+      # @param dir1 [::Array<YARD::Tags::Directive>]
+      # @param dir2 [::Array<YARD::Tags::Directive>]
       # @return [Boolean]
       def compare_directives dir1, dir2
         return false if dir1.length != dir2.length
@@ -288,7 +343,7 @@ module Solargraph
           tag1.types == tag2.types
       end
 
-      # @return [Array<YARD::Tags::Handlers::Directive>]
+      # @return [::Array<YARD::Tags::Handlers::Directive>]
       def collect_macros
         return [] unless maybe_directives?
         parse = Solargraph::Source.parse_docstring(comments)

data/lib/solargraph/pin/base_variable.rb

@@ -39,7 +39,7 @@ module Solargraph
       def probe api_map
         return ComplexType::UNDEFINED if @assignment.nil?
         types = []
-        returns_from(@assignment).each do |node|
+        value_position_nodes_only(@assignment).each do |node|
           # Nil nodes may not have a location
           if node.nil? || node.type == :NIL || node.type == :nil
             types.push ComplexType::NIL
@@ -50,7 +50,7 @@ module Solargraph
             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, clip.in_block?)
+            chain = Parser.chain(node, nil, nil)
             result = chain.infer(api_map, closure, clip.locals)
             types.push result unless result.undefined?
           end
@@ -71,6 +71,10 @@ module Solargraph
         true
       end
 
+      def desc
+        "#{to_rbs} = #{assignment&.type.inspect}"
+      end
+
       private
 
       # @return [ComplexType]

data/lib/solargraph/pin/block.rb

@@ -3,17 +3,22 @@
 module Solargraph
   module Pin
     class Block < Closure
-      # The signature of the method that receives this block.
-      #
       # @return [Parser::AST::Node]
       attr_reader :receiver
 
-      # @param args [Array<Parameter>]
-      def initialize receiver: nil, args: [], context: nil, **splat
+      # @return [Parser::AST::Node]
+      attr_reader :node
+
+      # @param receiver [Parser::AST::Node, nil]
+      # @param node [Parser::AST::Node, nil]
+      # @param context [ComplexType, nil]
+      # @param args [::Array<Parameter>]
+      def initialize receiver: nil, args: [], context: nil, node: nil, **splat
         super(**splat)
         @receiver = receiver
         @context = context
         @parameters = args
+        @node = node
       end
 
       # @param api_map [ApiMap]
@@ -26,12 +31,12 @@ module Solargraph
         @binder || closure.binder
       end
 
-      # @return [Array<Parameter>]
+      # @return [::Array<Parameter>]
       def parameters
         @parameters ||= []
       end
 
-      # @return [Array<String>]
+      # @return [::Array<String>]
       def parameter_names
         @parameter_names ||= parameters.map(&:name)
       end

data/lib/solargraph/pin/closure.rb

@@ -6,9 +6,12 @@ module Solargraph
       # @return [::Symbol] :class or :instance
       attr_reader :scope
 
-      def initialize scope: :class, **splat
+      # @param scope [::Symbol] :class or :instance
+      # @param generics [::Array<Pin::Parameter>, nil]
+      def initialize scope: :class, generics: nil, **splat
         super(**splat)
         @scope = scope
+        @generics = generics
       end
 
       def context
@@ -26,12 +29,24 @@ module Solargraph
         @binder || context
       end
 
-      # @return [Array<String>]
+      # @return [::Array<String>]
       def gates
         # @todo This check might not be necessary. There should always be a
         #   root pin
         closure ? closure.gates : ['']
       end
+
+      # @return [::Array<String>]
+      def generics
+        @generics ||= docstring.tags(:generic).map(&:name)
+      end
+
+      # @return [String]
+      def generics_as_rbs
+        return '' if generics.empty?
+
+        generics.join(', ') + ' '
+      end
     end
   end
 end

data/lib/solargraph/pin/common.rb

@@ -6,7 +6,7 @@ module Solargraph
       # @return [Location]
       attr_reader :location
 
-      # @return [Pin::Base, nil]
+      # @return [Pin::Closure, nil]
       attr_reader :closure
 
       # @return [String]
@@ -19,7 +19,7 @@ module Solargraph
         @return_type ||= ComplexType::UNDEFINED
       end
 
-      # @return [ComplexType]
+      # @return [ComplexType, Array<UniqueType>]
       def context
         # Get the static context from the nearest namespace
         @context ||= find_context
@@ -46,6 +46,10 @@ module Solargraph
         @path ||= name.empty? ? context.namespace : "#{context.namespace}::#{name}"
       end
 
+      protected
+
+      attr_writer :context
+
       private
 
       # @return [ComplexType]
@@ -56,7 +60,7 @@ module Solargraph
             return here.return_type
           elsif here.is_a?(Pin::Method)
             if here.scope == :instance
-              return ComplexType.try_parse(here.context.namespace)
+              return ComplexType.try_parse(here.context.tag)
             else
               return here.context
             end

data/lib/solargraph/pin/conversions.rb

@@ -5,7 +5,35 @@ require 'cgi'
 module Solargraph
   module Pin
     # @todo Move this stuff. It should be the responsibility of the language server.
+    # @todo abstract methods below should be verified to be overridden
+    #   by type checker when mixin included by non-abstract class
     module Conversions
+      # @!parse
+      #   include Documenting
+      #   include Common
+
+      # @return [Integer]
+      # @abstract
+      def completion_item_kind
+        raise NotImplementedError
+      end
+
+      # @abstract
+      # @return [Boolean]
+      def deprecated?
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def probed?
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def proxied?
+        raise NotImplementedError
+      end
+
       # @return [Hash]
       def completion_item
         @completion_item ||= {
@@ -34,12 +62,12 @@ module Solargraph
         end
       end
 
-      # @return [Array<Hash>]
+      # @return [::Array<Hash>]
       def signature_help
         []
       end
 
-      # @return [String]
+      # @return [String, nil]
       def detail
         # This property is not cached in an instance variable because it can
         # change when pins get proxied.
@@ -57,12 +85,14 @@ module Solargraph
         @link_documentation ||= generate_link
       end
 
+      # @return [String, nil]
       def text_documentation
         this_path = path || return_type.tag
         return nil if this_path == 'undefined'
         escape_brackets this_path
       end
 
+      # @return [void]
       def reset_conversions
         @completion_item = nil
         @resolve_completion_item = nil
@@ -73,7 +103,7 @@ module Solargraph
 
       private
 
-      # @return [String]
+      # @return [String, nil]
       def generate_link
         this_path = path || return_type.tag
         return nil if this_path == 'undefined'

data/lib/solargraph/pin/documenting.rb

@@ -38,23 +38,20 @@ module Solargraph
         end
 
         def to_s
-          return "\n```ruby\n#{@plaintext}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n" if code?
-          ReverseMarkdown.convert unescape_brackets(Kramdown::Document.new(escape_brackets(@plaintext), input: 'GFM').to_html)
+          return to_code if code?
+          to_markdown
         end
 
         private
 
-        # @param text [String]
         # @return [String]
-        def escape_brackets text
-          # text.gsub(/(\[[^\]]*\])([^\(]|\z)/, '!!!^\1^!!!\2')
-          text.gsub('[', '!!!!b').gsub(']', 'e!!!!')
+        def to_code
+          "\n```ruby\n#{Documenting.normalize_indentation(@plaintext)}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n"
         end
 
-        # @param text [String]
         # @return [String]
-        def unescape_brackets text
-          text.gsub('!!!!b', '[').gsub('e!!!!', ']')
+        def to_markdown
+          ReverseMarkdown.convert Kramdown::Document.new(@plaintext, input: 'GFM').to_html
         end
       end
 
@@ -65,40 +62,34 @@ module Solargraph
           # line and at least two spaces of indentation. This is a common
           # convention in Ruby core documentation, e.g., String#split.
           sections = [DocSection.new(false)]
-          normalize_indentation(docstring.to_s).gsub(/\t/, '  ').lines.each do |l|
-            if l.strip.empty?
-              sections.last.concat l
-            else
-              if (l =~ /^  [^\s]/ && sections.last.plaintext =~ /(\r?\n[ \t]*?){2,}$/) || (l.start_with?('  ') && sections.last.code?)
-                # Code block
-                sections.push DocSection.new(true) unless sections.last.code?
-                sections.last.concat l[2..-1]
-              else
-                # Regular documentation
-                sections.push DocSection.new(false) if sections.last.code?
-                sections.last.concat l
-              end
+          Documenting.normalize_indentation(Documenting.strip_html_comments(docstring.to_s.gsub("\t", '  '))).lines.each do |l|
+            if l.start_with?('  ')
+              # Code block
+              sections.push DocSection.new(true) unless sections.last.code?
+            elsif sections.last.code?
+              # Regular documentation
+              sections.push DocSection.new(false)
             end
+            sections.last.concat l
           end
           sections.map(&:to_s).join.strip
         end
       end
 
-      private
-
-      # @param text [String]
-      # @return [String]
-      def normalize_indentation text
-        text.lines.map { |l| remove_odd_spaces(l) }.join
+      def self.strip_html_comments text
+        text.gsub(/<!--([\s\S]*?)-->/, '').strip
       end
 
-      # @param line [String]
+      # @param text [String]
       # @return [String]
-      def remove_odd_spaces line
-        return line unless line.start_with?(' ')
-        spaces = line.match(/^ +/)[0].length
-        return line unless spaces.odd?
-        line[1..-1]
+      def self.normalize_indentation text
+        left = text.lines.map do |line|
+          match = line.match(/^ +/)
+          next 0 unless match
+          match[0].length
+        end.min
+        return text if left.nil? || left.zero?
+        text.lines.map { |line| line[left..] }.join
       end
     end
   end

data/lib/solargraph/pin/instance_variable.rb

@@ -3,14 +3,17 @@
 module Solargraph
   module Pin
     class InstanceVariable < BaseVariable
+      # @return [ComplexType]
       def binder
         closure.binder
       end
 
+      # @return [::Symbol]
       def scope
         closure.binder.scope
       end
 
+      # @return [ComplexType]
       def context
         @context ||= begin
           result = super
@@ -22,6 +25,7 @@ module Solargraph
         end
       end
 
+      # @param other [InstanceVariable]
       def nearly? other
         super && binder == other.binder
       end

data/lib/solargraph/pin/local_variable.rb

@@ -6,12 +6,16 @@ module Solargraph
       # @return [Range]
       attr_reader :presence
 
+      # @param assignment [AST::Node, nil]
+      # @param presence [Range, nil]
+      # @param splat [Hash]
       def initialize assignment: nil, presence: nil, **splat
         super(**splat)
         @assignment = assignment
         @presence = presence
       end
 
+      # @param pin [self]
       def try_merge! pin
         return false unless super
         @presence = pin.presence
@@ -21,11 +25,16 @@ module Solargraph
       # @param other_closure [Pin::Closure]
       # @param other_loc [Location]
       def visible_at?(other_closure, other_loc)
-        return true if location.filename == other_loc.filename &&
+        location.filename == other_loc.filename &&
           presence.include?(other_loc.range.start) &&
           match_named_closure(other_closure, closure)
       end
 
+      # @return [String]
+      def to_rbs
+        (name || '(anon)') + ' ' + (return_type&.to_rbs || 'untyped')
+      end
+
       private
 
       # @param tag1 [String]
@@ -40,6 +49,9 @@ module Solargraph
           (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
       end
 
+      # @param needle [Pin::Base]
+      # @param haystack [Pin::Base]
+      # @return [Boolean]
       def match_named_closure needle, haystack
         return true if needle == haystack || haystack.is_a?(Pin::Block)
         cursor = haystack