Fix documentation reference when methods are too close (#2806)

* delete line key from @comments_by_line when comment has been visited

* fix 'test_completion_resolve_with_owner_present' test

* add source_lines and refactor collect_comments

* minimize the changes

Author: IgnacioFan

lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb

@@ -37,6 +37,7 @@ def initialize(index, dispatcher, parse_result, file_path, collect_comments: fal
         parse_result.code_units_cache(@index.configuration.encoding),
         T.any(T.proc.params(arg0: Integer).returns(Integer), Prism::CodeUnitsCache),
       )
+      @source_lines = T.let(parse_result.source.lines, T::Array[String])
 
       # The nesting stack we're currently inside. Used to determine the fully qualified name of constants, but only
       # stored by unresolved aliases which need the original nesting to be lazily resolved
@@ -661,8 +662,7 @@ def collect_comments(node)
       comments = +""
 
       start_line = node.location.start_line - 1
-      start_line -= 1 unless @comments_by_line.key?(start_line)
-
+      start_line -= 1 unless comment_exists_at?(start_line)
       start_line.downto(1) do |line|
         comment = @comments_by_line[line]
         break unless comment
@@ -683,6 +683,11 @@ def collect_comments(node)
       comments
     end
 
+    sig { params(line: Integer).returns(T::Boolean) }
+    def comment_exists_at?(line)
+      @comments_by_line.key?(line) || !@source_lines[line - 1].to_s.strip.empty?
+    end
+
     sig { params(name: String).returns(String) }
     def fully_qualify_name(name)
       if @stack.empty? || name.start_with?("::")

lib/ruby_indexer/test/method_test.rb

@@ -149,6 +149,39 @@ def bar; end
       end
     end
 
+    def test_comments_documentation
+      index(<<~RUBY)
+        # Documentation for Foo
+
+        class Foo
+          # ####################
+          # Documentation for bar
+          # ####################
+          #
+          def bar
+          end
+
+          # test
+
+          # Documentation for baz
+          def baz; end
+          def ban; end
+        end
+      RUBY
+
+      foo_comment = @index["Foo"].first.comments
+      assert_equal("Documentation for Foo", foo_comment)
+
+      bar_comment = @index["bar"].first.comments
+      assert_equal("####################\nDocumentation for bar\n####################\n", bar_comment)
+
+      baz_comment = @index["baz"].first.comments
+      assert_equal("Documentation for baz", baz_comment)
+
+      ban_comment = @index["ban"].first.comments
+      assert_empty(ban_comment)
+    end
+
     def test_method_with_parameters
       index(<<~RUBY)
         class Foo

test/requests/completion_resolve_test.rb

@@ -50,8 +50,8 @@ def initialize
       end
 
       class Foo
-        # Foo!
         def initialize
+          # Foo!
           @a = 1
         end
       end