solargraph 0.24.1 → 0.25.0

data/lib/solargraph/pin/attribute.rb

@@ -7,10 +7,9 @@ module Solargraph
       # @return [Symbol] :class or :instance
       attr_reader :scope
 
-      def initialize location, namespace, name, docstring, access, scope
-        super(location, namespace, name, docstring)
+      def initialize location, namespace, name, comments, access, scope
+        super(location, namespace, name, comments)
         @access = access
-        @docstring = docstring
         @scope = scope
       end
 
@@ -33,10 +32,8 @@ module Solargraph
       def return_complex_types
         if @return_complex_types.nil?
           @return_complex_types = []
-          unless docstring.nil?
-            tag = docstring.tag(:return)
-            @return_complex_types.concat ComplexType.parse(*tag.types) unless tag.nil?
-          end
+          tag = docstring.tag(:return)
+          @return_complex_types.concat ComplexType.parse(*tag.types) unless tag.nil?
         end
         @return_complex_types
       end

data/lib/solargraph/pin/base.rb

@@ -15,8 +15,8 @@ module Solargraph
       # @return [String]
       attr_reader :name
 
-      # @return [YARD::Docstring]
-      attr_reader :docstring
+      # @return [String]
+      attr_reader :comments
 
       # @return [Integer]
       attr_reader :kind
@@ -27,16 +27,17 @@ module Solargraph
       # @param location [Solargraph::Source::Location]
       # @param namespace [String]
       # @param name [String]
-      # @param docstring [YARD::Docstring]
-      def initialize location, namespace, name, docstring
+      # @param comments [String]
+      def initialize location, namespace, name, comments
         @location = location
         @namespace = namespace
         @name = name
-        @docstring = docstring
+        @comments = comments || ''
       end
 
       # @return [String]
       def filename
+        return nil if location.nil?
         location.filename
       end
 
@@ -64,17 +65,39 @@ module Solargraph
         false
       end
 
+      def yard_pin?
+        false
+      end
+
       # @return [String]
       def named_context
         namespace
       end
 
+      # Pin equality is determined using the #nearly? method and also
+      # requiring both pins to have the same location.
+      #
       def == other
-        return false unless self.class == other.class
-        location == other.location and
+        return false unless nearly? other
+        location == other.location
+      end
+
+      # True if the specified pin is a near match to this one. A near match
+      # indicates that the pins contain mostly the same data. Any differences
+      # between them should not have an impact on the API surface.
+      #
+      # @param other [Solargraph::Pin::Base, Object]
+      # @return [Boolean]
+      def nearly? other
+        # @todo The directives test needs to be a deep check similar to
+        #   compare_docstring_tags.
+        self.class == other.class and
           namespace == other.namespace and
           name == other.name and
-          ( (docstring.nil? and other.docstring.nil?) or (docstring == other.docstring and docstring.all == other.docstring.all) )
+          (comments == other.comments or
+            ( ((maybe_directives? == false and other.maybe_directives? == false) or compare_directives(directives, other.directives)) and
+            compare_docstring_tags(docstring, other.docstring) )
+          )
       end
 
       # The first return type associated with the pin.
@@ -110,6 +133,88 @@ module Solargraph
       def return_complex_types
         @return_complex_types ||= []
       end
+
+      # @return [YARD::Docstring]
+      def docstring
+        parse_comments unless defined?(@docstring)
+        @docstring ||= YARD::Docstring.parser.parse('').to_docstring
+      end
+
+      # @param [Array<YARD::Tags::Directive>]
+      def directives
+        parse_comments unless defined?(@directives)
+        @directives
+      end
+
+      # Perform a quick check to see if this pin possibly includes YARD
+      # directives. This method does not require parsing the comments.
+      #
+      # After the comments have been parsed, this method will return false if
+      # no directives were found, regardless of whether it previously appeared
+      # possible.
+      #
+      # @return [Boolean]
+      def maybe_directives?
+        return !@directives.empty? if defined?(@directives)
+        @maybe_directives ||= comments.include?('@!')
+      end
+
+      # Try to merge data from another pin. Merges are only possible if the
+      # pins are near matches (see the #nearly? method). The changes should
+      # not have any side effects on the API surface.
+      #
+      # @param pin [Pin::Base] The pin to merge into this one
+      # @return [Boolean] True if the pins were merged
+      def try_merge! pin
+        return false unless nearly?(pin)
+        @location = pin.location
+        if comments != pin.comments
+          @comments = pin.comments
+          @docstring = pin.docstring
+          @return_complex_types = pin.return_complex_types
+          @documentation = nil
+          reset_conversions
+        end
+        true
+      end
+
+      private
+
+      # @return [void]
+      def parse_comments
+        if comments.empty?
+          @docstring = nil
+          @directives = []
+        else
+          parse = YARD::Docstring.parser.parse(comments)
+          @docstring = parse.to_docstring
+          @directives = parse.directives
+        end
+      end
+
+      def compare_docstring_tags d1, d2
+        return false if d1.tags.length != d2.tags.length
+        d1.tags.each_index do |i|
+          return false unless compare_tags(d1.tags[i], d2.tags[i])
+        end
+        true
+      end
+
+      def compare_directives d1, d2
+        return false if d1.length != d2.length
+        d1.each_index do |i|
+          return false unless compare_tags(d1[i].tag, d2[i].tag)
+        end
+        true
+      end
+
+      def compare_tags t1, t2
+        return true if t1.class == t2.class and
+          t1.tag_name == t2.tag_name and
+          t1.text == t2.text and
+          t1.name == t2.name and
+          t1.types == t2.types
+      end
     end
   end
 end

data/lib/solargraph/pin/base_variable.rb

@@ -5,8 +5,8 @@ module Solargraph
 
       attr_reader :context
 
-      def initialize location, namespace, name, docstring, signature, literal, context
-        super(location, namespace, name, docstring)
+      def initialize location, namespace, name, comments, signature, literal, context
+        super(location, namespace, name, comments)
         @signature = signature
         @literal = literal
         @context = context
@@ -25,26 +25,6 @@ module Solargraph
         Solargraph::LanguageServer::SymbolKinds::VARIABLE
       end
 
-      def return_type
-        # if @return_type.nil?
-        #   if !docstring.nil?
-        #     tag = docstring.tag(:type)
-        #     @return_type = tag.types[0] unless tag.nil?
-        #   else
-        #     @return_type = @literal
-        #   end
-        # end
-        # @return_type
-        if @return_type.nil?
-          if return_complex_types.empty?
-            @return_type = @literal
-          else
-            @return_type = return_complex_types.first.tag
-          end
-        end
-        @return_type
-      end
-
       def return_complex_types
         @return_complex_types ||= generate_complex_types
       end
@@ -57,13 +37,25 @@ module Solargraph
         true
       end
 
+      def == other
+        return false unless super
+        signature == other.signature
+      end
+
+      def try_merge! pin
+        return false unless super
+        @signature = pin.signature
+        @return_complex_types = pin.return_complex_types
+        true
+      end
+
       private
 
       def generate_complex_types
-        return [] if docstring.nil?
         tag = docstring.tag(:type)
-        return [] if tag.nil?
-        ComplexType.parse *tag.types
+        return ComplexType.parse(*tag.types) unless tag.nil?
+        return ComplexType.parse(@literal) unless @literal.nil?
+        []
       end
     end
   end

data/lib/solargraph/pin/block.rb

@@ -4,8 +4,8 @@ module Solargraph
       attr_reader :receiver
       attr_reader :parameters
 
-      def initialize location, namespace, name, docstring, receiver
-        super(location, namespace, name, docstring)
+      def initialize location, namespace, name, comments, receiver
+        super(location, namespace, name, comments)
         @receiver = receiver
       end
 

data/lib/solargraph/pin/block_parameter.rb

@@ -6,8 +6,8 @@ module Solargraph
       # @return [Pin::Block]
       attr_reader :block
 
-      def initialize location, namespace, name, docstring, block
-        super(location, namespace, name, docstring)
+      def initialize location, namespace, name, comments, block
+        super(location, namespace, name, comments)
         @block = block
         @presence = block.location.range
       end
@@ -38,15 +38,13 @@ module Solargraph
       def return_complex_types
         if @return_complex_types.nil?
           @return_complex_types = []
-          unless block.docstring.nil?
-            found = nil
-            params = block.docstring.tags(:param)
-            params.each do |p|
-              next unless p.name == name
-              found = p
-            end
-            @return_complex_types.concat ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
+          found = nil
+          params = block.docstring.tags(:param)
+          params.each do |p|
+            next unless p.name == name
+            found = p
           end
+          @return_complex_types.concat ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
         end
         @return_complex_types
       end

data/lib/solargraph/pin/constant.rb

@@ -3,8 +3,8 @@ module Solargraph
     class Constant < BaseVariable
       attr_reader :visibility
 
-      def initialize location, namespace, name, docstring, signature, literal, context, visibility
-        super(location, namespace, name, docstring, signature, literal, context)
+      def initialize location, namespace, name, comments, signature, literal, context, visibility
+        super(location, namespace, name, comments, signature, literal, context)
         @visibility = visibility
       end
 

data/lib/solargraph/pin/conversions.rb

@@ -57,6 +57,14 @@ module Solargraph
         @link_documentation ||= generate_link
       end
 
+      def reset_conversions
+        @completion_item = nil
+        @resolve_completion_item = nil
+        @signature_help = nil
+        @detail = nil
+        @link_documentation = nil
+      end
+
       private
 
       def generate_link

data/lib/solargraph/pin/documenting.rb

@@ -3,7 +3,7 @@ module Solargraph
     module Documenting
       # @return [String]
       def documentation
-        if @documentation.nil? and !docstring.nil?
+        if @documentation.nil?
           @documentation = ReverseMarkdown.convert(helper.html_markup_rdoc(docstring), github_flavored: true)
           @documentation.strip!
         end
@@ -16,7 +16,7 @@ module Solargraph
       #
       # @return [Boolean]
       def has_doc?
-        !docstring.nil? and !docstring.all.empty?
+        !docstring.all.empty?
       end
 
       def helper

data/lib/solargraph/pin/duck_method.rb

@@ -6,7 +6,6 @@ module Solargraph
     class DuckMethod < Pin::Method
       # @param location [Solargraph::Source::Location]
       # @param name [String]
-      #
       def initialize location, name
         super(location, 'Object', name, nil, :instance, :public, [])
       end

data/lib/solargraph/pin/local_variable.rb

@@ -3,8 +3,8 @@ module Solargraph
     class LocalVariable < BaseVariable
       include Localized
 
-      def initialize location, namespace, name, docstring, assignment, literal, context, block, presence
-        super(location, namespace, name, docstring, assignment, literal, context)
+      def initialize location, namespace, name, comments, assignment, literal, context, block, presence
+        super(location, namespace, name, comments, assignment, literal, context)
         @block = block
         @presence = presence
       end
@@ -12,6 +12,12 @@ module Solargraph
       def kind
         Pin::LOCAL_VARIABLE
       end
+
+      def try_merge! pin
+        return false unless super
+        @presence = pin.presence
+        true
+      end
     end
   end
 end

data/lib/solargraph/pin/method.rb

@@ -1,17 +1,23 @@
 module Solargraph
   module Pin
     class Method < Base
+      # @return [Symbol] :instance or :class
       attr_reader :scope
+
+      # @return [Symbol] :public, :private, or :protected
       attr_reader :visibility
+
+      # @return [Array<String>]
       attr_reader :parameters
 
-      def initialize location, namespace, name, docstring, scope, visibility, args
-        super(location, namespace, name, docstring)
+      def initialize location, namespace, name, comments, scope, visibility, args
+        super(location, namespace, name, comments)
         @scope = scope
         @visibility = visibility
         @parameters = args
       end
 
+      # @return [Array<String>]
       def parameter_names
         @parameter_names ||= parameters.map{|p| p.split(/[ =:]/).first}
       end
@@ -40,29 +46,33 @@ module Solargraph
       def documentation
         if @documentation.nil?
           @documentation ||= super || ''
-          unless docstring.nil?
-            param_tags = docstring.tags(:param)
-            unless param_tags.nil? or param_tags.empty?
-              @documentation += "\n\n"
-              @documentation += "Params:\n"
-              lines = []
-              param_tags.each do |p|
-                l = "* #{p.name}"
-                l += " [#{p.types.join(', ')}]" unless p.types.empty?
-                l += " #{p.text}"
-                lines.push l
-              end
-              @documentation += lines.join("\n")
+          param_tags = docstring.tags(:param)
+          unless param_tags.nil? or param_tags.empty?
+            @documentation += "\n\n" unless @documentation.empty?
+            @documentation += "Params:\n"
+            lines = []
+            param_tags.each do |p|
+              l = "* #{p.name}"
+              l += " [#{p.types.join(', ')}]" unless p.types.nil? or p.types.empty?
+              l += " #{p.text}"
+              lines.push l
             end
+            @documentation += lines.join("\n")
           end
         end
         @documentation
       end
 
+      def nearly? other
+        return false unless super
+        parameters == other.parameters and
+          scope == other.scope and
+          visibility == other.visibility
+      end
+
       private
 
       def generate_complex_types
-        return [] if docstring.nil?
         tag = docstring.tag(:return)
         if tag.nil?
           ol = docstring.tag(:overload)