Include convention (eg. solargraph-rspec) pins in document_symbols

lib/solargraph/language_server/message/text_document/document_symbol.rb

@@ -6,6 +6,8 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
  def process
  pins = host.document_symbols params['textDocument']['uri']
  info = pins.map do |pin|
+ next nil unless pin.location&.filename
+
  result = {
  name: pin.name,
  containerName: pin.namespace,
@@ -17,7 +19,8 @@ def process
  deprecated: pin.deprecated?
  }
  result
- end
+ end.compact
+
  set_result info
  end
 end

lib/solargraph/source_map.rb

@@ -30,6 +30,7 @@ def initialize source, pins, locals
  @pins = pins
  @locals = locals
  environ.merge Convention.for_local(self) unless filename.nil?
+ self.convention_pins = environ.pins
  @pin_class_hash = pins.to_set.classify(&:class).transform_values(&:to_a)
  @pin_select_cache = {}
  end
@@ -65,11 +66,12 @@ def environ
  @environ ||= Environ.new
  end
 
+ # all pins except Solargraph::Pin::Reference::Reference
  # @return [Array<Pin::Base>]
  def document_symbols
- @document_symbols ||= pins.select { |pin|
+ @document_symbols ||= (pins + convention_pins).select do |pin|
  pin.path && !pin.path.empty?
- }
+ end
  end
 
  # @param query [String]
@@ -159,6 +161,17 @@ def map source
 
  private
 
+ # @return [Array<Pin::Base>]
+ def convention_pins
+ @convention_pins || []
+ end
+
+ def convention_pins=(pins)
+ # unmemoizing the document_symbols in case it was called from any of convnetions
+ @document_symbols = nil
+ @convention_pins = pins
+ end
+
  # @param line [Integer]
  # @param character [Integer]
  # @param klasses [Array<Class>]

spec/source_map_spec.rb

@@ -20,6 +20,49 @@ def baz_qux; end
  expect(map.query_symbols("bazqux")).to eq(map.document_symbols.select{ |pin_namespace| pin_namespace.name == "baz_qux" })
  end
 
+ it 'returns all pins, except for references as document symbols' do
+ map = Solargraph::SourceMap.load_string(%(
+ class FooBar
+ require 'foo'
+ include SomeModule
+ extend SomeOtherModule
+
+ def baz_qux; end
+ end
+ ), 'test.rb')
+
+ expect(map.document_symbols.map(&:path)).to eq(['FooBar', 'FooBar#baz_qux'])
+ expect(map.document_symbols.map(&:class)).not_to include(an_instance_of(Solargraph::Pin::Reference))
+ end
+
+ it 'includes convention pins in document symbols' do
+ dummy_convention = Class.new(Solargraph::Convention::Base) do
+ def local(source_map)
+ source_map.document_symbols # call memoized method
+
+ Solargraph::Environ.new(
+ pins: [
+ Solargraph::Pin::Method.new(
+ closure: Solargraph::Pin::Namespace.new(name: 'FooBar', type: :class),
+ name: 'baz_convention',
+ scope: :instance
+ )
+ ]
+ )
+ end
+ end
+
+ Solargraph::Convention.register dummy_convention
+
+ map = Solargraph::SourceMap.load_string(%(
+ class FooBar
+ def baz_qux; end
+ end
+ ), 'test.rb')
+
+ expect(map.document_symbols.map(&:path)).to include('FooBar#baz_convention')
+ end
+
  it "locates block pins" do
  map = Solargraph::SourceMap.load_string(%(
  class Foo