solargraph 0.58.1 → 0.59.0.dev.1

data/lib/solargraph/parser/node_processor/base.rb

@@ -1,92 +1,122 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module NodeProcessor
-      class Base
-        # @return [Parser::AST::Node]
-        attr_reader :node
-
-        # @return [Region]
-        attr_reader :region
-
-        # @return [Array<Pin::Base>]
-        attr_reader :pins
-
-        # @return [Array<Pin::LocalVariable>]
-        attr_reader :locals
-
-        # @param node [Parser::AST::Node]
-        # @param region [Region]
-        # @param pins [Array<Pin::Base>]
-        # @param locals [Array<Pin::LocalVariable>]
-        def initialize node, region, pins, locals
-          @node = node
-          @region = region
-          @pins = pins
-          @locals = locals
-          @processed_children = false
-        end
-
-        # Subclasses should override this method to generate new pins.
-        #
-        # @return [Boolean] continue processing the next processor of the same node type.
-        # @return [void] In case there is only one processor registered for the node type, it can be void.
-        def process
-          process_children
-
-          true
-        end
-
-        private
-
-        # @param subregion [Region]
-        # @return [void]
-        def process_children subregion = region
-          return if @processed_children
-          @processed_children = true
-          node.children.each do |child|
-            next unless Parser.is_ast_node?(child)
-            NodeProcessor.process(child, subregion, pins, locals)
-          end
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [Solargraph::Location]
-        def get_node_location(node)
-          range = Parser.node_range(node)
-          Location.new(region.filename, range)
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [String, nil]
-        def comments_for(node)
-          region.source.comments_for(node)
-        end
-
-        # @param position [Solargraph::Position]
-        # @return [Pin::Closure, nil]
-        def named_path_pin position
-          pins.select do |pin|
-            pin.is_a?(Pin::Closure) && pin.path && !pin.path.empty? && pin.location.range.contain?(position)
-          end.last
-        end
-
-        # @todo Candidate for deprecation
-        # @param position [Solargraph::Position]
-        # @return [Pin::Closure, nil]
-        def block_pin position
-          # @todo determine if this can return a Pin::Block
-          pins.select { |pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position) }.last
-        end
-
-        # @todo Candidate for deprecation
-        # @param position [Solargraph::Position]
-        # @return [Pin::Closure, nil]
-        def closure_pin position
-          pins.select { |pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position) }.last
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module NodeProcessor
+      class Base
+        # @return [Parser::AST::Node]
+        attr_reader :node
+
+        # @return [Region]
+        attr_reader :region
+
+        # @return [Array<Pin::Base>]
+        attr_reader :pins
+
+        # @return [Array<Pin::LocalVariable>]
+        attr_reader :locals
+
+        # @return [Array<Pin::InstanceVariable>]
+        attr_reader :ivars
+
+        # @param node [Parser::AST::Node]
+        # @param region [Region]
+        # @param pins [Array<Pin::Base>]
+        # @param locals [Array<Pin::LocalVariable>]
+        # @param ivars [Array<Pin::InstanceVariable>]
+        def initialize node, region, pins, locals, ivars
+          @node = node
+          @region = region
+          @pins = pins
+          @locals = locals
+          @ivars = ivars
+          @processed_children = false
+        end
+
+        # Subclasses should override this method to generate new pins.
+        #
+        # @return [Boolean] continue processing the next processor of the same node type.
+        # @return [void] In case there is only one processor registered for the node type, it can be void.
+        def process
+          process_children
+
+          true
+        end
+
+        private
+
+        # @return [Solargraph::Location]
+        def location
+          get_node_location(node)
+        end
+
+        # @return [Solargraph::Position]
+        def position
+          Position.new(node.loc.line, node.loc.column)
+        end
+
+        # @sg-ignore downcast output of Enumerable#select
+        # @return [Solargraph::Pin::Breakable, nil]
+        def enclosing_breakable_pin
+          pins.select{|pin| pin.is_a?(Pin::Breakable) && pin.location&.range&.contain?(position)}.last
+        end
+
+        # @todo downcast output of Enumerable#select
+        # @return [Solargraph::Pin::CompoundStatement, nil]
+        def enclosing_compound_statement_pin
+          pins.select{|pin| pin.is_a?(Pin::CompoundStatement) && pin.location&.range&.contain?(position)}.last
+        end
+
+        # @param subregion [Region]
+        # @return [void]
+        def process_children subregion = region
+          return if @processed_children
+          @processed_children = true
+          node.children.each do |child|
+            next unless Parser.is_ast_node?(child)
+            NodeProcessor.process(child, subregion, pins, locals, ivars)
+          end
+        end
+
+        # @param node [Parser::AST::Node]
+        # @return [Solargraph::Location]
+        def get_node_location(node)
+          range = Parser.node_range(node)
+          Location.new(region.filename, range)
+        end
+
+        # @param node [Parser::AST::Node]
+        # @return [String, nil]
+        def comments_for(node)
+          region.source.comments_for(node)
+        end
+
+        # @param position [Solargraph::Position]
+        # @return [Pin::Closure, nil]
+        def named_path_pin position
+          pins.select do |pin|
+            # @sg-ignore Need to add nil check here
+            pin.is_a?(Pin::Closure) && pin.path && !pin.path.empty? && pin.location.range.contain?(position)
+          end.last
+        end
+
+        # @todo Candidate for deprecation
+        # @param position [Solargraph::Position]
+        # @return [Pin::Closure, nil]
+        def block_pin position
+          # @todo determine if this can return a Pin::Block
+          # @sg-ignore Need to add nil check here
+          pins.select { |pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position) }.last
+        end
+
+        # @todo Candidate for deprecation
+        # @param position [Solargraph::Position]
+        # @return [Pin::Closure, nil]
+        def closure_pin position
+          # @sg-ignore Need to add nil check here
+          pins.select { |pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position) }.last
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/node_processor.rb

@@ -1,62 +1,63 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    # The processor classes used by SourceMap::Mapper to generate pins from
-    # parser nodes.
-    #
-    module NodeProcessor
-      autoload :Base, 'solargraph/parser/node_processor/base'
-
-      class << self
-        # @type [Hash{Symbol => Array<Class<NodeProcessor::Base>>}]
-        @@processors ||= {}
-
-        # Register a processor for a node type. You can register multiple processors for the same type.
-        # If a node processor returns true, it will skip the next processor of the same node type.
-        #
-        # @param type [Symbol]
-        # @param cls [Class<NodeProcessor::Base>]
-        # @return [Array<Class<NodeProcessor::Base>>]
-        def register type, cls
-          @@processors[type] ||= []
-          @@processors[type] << cls
-        end
-
-        # @param type [Symbol]
-        # @param cls [Class<NodeProcessor::Base>]
-        #
-        # @return [void]
-        def deregister type, cls
-          @@processors[type].delete(cls)
-        end
-      end
-
-      # @param node [Parser::AST::Node]
-      # @param region [Region]
-      # @param pins [Array<Pin::Base>]
-      # @param locals [Array<Pin::BaseVariable>]
-      # @return [Array(Array<Pin::Base>, Array<Pin::Base>)]
-      def self.process node, region = Region.new, pins = [], locals = []
-        if pins.empty?
-          pins.push Pin::Namespace.new(
-            location: region.source.location,
-            name: '',
-            source: :parser,
-          )
-        end
-        return [pins, locals] unless Parser.is_ast_node?(node)
-        node_processor_classes = @@processors[node.type] || [NodeProcessor::Base]
-
-        node_processor_classes.each do |klass|
-          processor = klass.new(node, region, pins, locals)
-          process_next = processor.process
-
-          break unless process_next
-        end
-
-        [pins, locals]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    # The processor classes used by SourceMap::Mapper to generate pins from
+    # parser nodes.
+    #
+    module NodeProcessor
+      autoload :Base, 'solargraph/parser/node_processor/base'
+
+      class << self
+        # @type [Hash{Symbol => Array<Class<NodeProcessor::Base>>}]
+        @@processors ||= {}
+
+        # Register a processor for a node type. You can register multiple processors for the same type.
+        # If a node processor returns true, it will skip the next processor of the same node type.
+        #
+        # @param type [Symbol]
+        # @param cls [Class<NodeProcessor::Base>]
+        # @return [Array<Class<NodeProcessor::Base>>]
+        def register type, cls
+          @@processors[type] ||= []
+          @@processors[type] << cls
+        end
+
+        # @param type [Symbol]
+        # @param cls [Class<NodeProcessor::Base>]
+        #
+        # @return [void]
+        def deregister type, cls
+          @@processors[type].delete(cls)
+        end
+      end
+
+      # @param node [Parser::AST::Node]
+      # @param region [Region]
+      # @param pins [Array<Pin::Base>]
+      # @param locals [Array<Pin::LocalVariable>]
+      # @param ivars [Array<Pin::InstanceVariable>]
+      # @return [Array(Array<Pin::Base>, Array<Pin::LocalVariable>, Array<Pin::InstanceVariable>)]
+      def self.process node, region = Region.new, pins = [], locals = [], ivars = []
+        if pins.empty?
+          pins.push Pin::Namespace.new(
+            location: region.source.location,
+            name: '',
+            source: :parser,
+          )
+        end
+        return [pins, locals, ivars] unless Parser.is_ast_node?(node)
+        node_processor_classes = @@processors[node.type] || [NodeProcessor::Base]
+
+        node_processor_classes.each do |klass|
+          processor = klass.new(node, region, pins, locals, ivars)
+          process_next = processor.process
+
+          break unless process_next
+        end
+
+        [pins, locals, ivars]
+      end
+    end
+  end
+end