Allow multiple node processors

Author: lekemula

lib/solargraph/parser/node_processor.rb

@@ -9,7 +9,7 @@ module NodeProcessor
       autoload :Base, 'solargraph/parser/node_processor/base'
 
       class << self
-        # @type [Hash<Symbol, Class<NodeProcessor::Base>>]
+        # @type [Hash<Symbol, Array<Class<NodeProcessor::Base>>>]
         @@processors ||= {}
 
         # Register a processor for a node type.
@@ -18,7 +18,12 @@ class << self
         # @param cls [Class<NodeProcessor::Base>]
         # @return [Class<NodeProcessor::Base>]
         def register type, cls
-          @@processors[type] = cls
+          @@processors[type] ||= []
+          @@processors[type] << cls
+        end
+
+        def deregister type, cls
+          @@processors[type].delete(cls)
         end
       end
 
@@ -28,17 +33,24 @@ def register type, cls
       # @param locals [Array<Pin::BaseVariable>]
       # @return [Array(Array<Pin::Base>, Array<Pin::Base>)]
       def self.process node, region = Region.new, pins = [], locals = []
+        result = [[], []]
         if pins.empty?
           pins.push Pin::Namespace.new(
             location: region.source.location,
             name: ''
           )
         end
         return [pins, locals] unless Parser.is_ast_node?(node)
-        klass = @@processors[node.type] || NodeProcessor::Base
-        processor = klass.new(node, region, pins, locals)
-        processor.process
-        [processor.pins, processor.locals]
+        node_processor_classes = @@processors[node.type] || [NodeProcessor::Base]
+        node_processor_classes.each do |klass|
+          processor = klass.new(node, region, pins, locals)
+          processor.process
+
+          result[0] += processor.pins
+          result[1] += processor.locals
+        end
+
+        result
       end
     end
   end

spec/parser/node_processor_spec.rb

@@ -19,4 +19,30 @@ def foo(bar = nil, baz = nil); end
     pin = pins[1]
     expect(pin.parameters.map(&:name)).to eq(%w[bar baz])
   end
+
+  it 'allows multiple processors for the same node type' do
+    dummy_processor1 = Class.new(Solargraph::Parser::NodeProcessor::Base) do
+      def process
+        pins.push Solargraph::Pin::Method.new(name: 'foo')
+      end
+    end
+
+    dummy_processor2 = Class.new(Solargraph::Parser::NodeProcessor::Base) do
+      def process
+        pins.push Solargraph::Pin::Method.new(name: 'bar')
+      end
+    end
+
+    Solargraph::Parser::NodeProcessor.register(:def, dummy_processor1)
+    Solargraph::Parser::NodeProcessor.register(:def, dummy_processor2)
+    node = Solargraph::Parser.parse(%(
+      def some_method; end
+    ))
+    pins, = Solargraph::Parser::NodeProcessor.process(node)
+    expect(pins.map(&:name)).to include('foo', 'bar')
+
+    # Clean up the registered processors
+    Solargraph::Parser::NodeProcessor.deregister(:def, dummy_processor1)
+    Solargraph::Parser::NodeProcessor.deregister(:def, dummy_processor2)
+  end
 end