solargraph 0.38.6 → 0.39.0

data/lib/solargraph/parser/legacy/node_processors/resbody_node.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      module NodeProcessors
+        class ResbodyNode < Parser::NodeProcessor::Base
+          include Legacy::NodeMethods
+
+          def process
+            if node.children[1]
+              here = get_node_start_position(node.children[1])
+              presence = Range.new(here, region.closure.location.range.ending)
+              loc = get_node_location(node.children[1])
+              types = if node.children[0].nil?
+                        ['Exception']
+                      else
+                        node.children[0].children.map do |child|
+                          unpack_name(child)
+                        end
+                      end
+              locals.push Solargraph::Pin::LocalVariable.new(
+                location: loc,
+                closure: region.closure,
+                name: node.children[1].children[0].to_s,
+                comments: "@type [#{types.join(',')}]",
+                presence: presence
+              )
+            end
+            NodeProcessor.process(node.children[2], region, pins, locals)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy/node_processors/sclass_node.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      module NodeProcessors
+        class SclassNode < Parser::NodeProcessor::Base
+          def process
+            # @todo Temporarily skipping remote metaclasses
+            return unless node.children[0].is_a?(AST::Node) && node.children[0].type == :self
+            pins.push Solargraph::Pin::Singleton.new(
+              location: get_node_location(node),
+              closure: region.closure
+            )
+            process_children region.update(visibility: :public, scope: :class, closure: pins.last)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy/node_processors/send_node.rb

@@ -0,0 +1,232 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      module NodeProcessors
+        class SendNode < Parser::NodeProcessor::Base
+          include Legacy::NodeMethods
+
+          def process
+            if node.children[0].nil?
+              if [:private, :public, :protected].include?(node.children[1])
+                if (node.children.length > 2)
+                  node.children[2..-1].each do |child|
+                    next unless child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
+                    name = child.children[0].to_s
+                    matches = pins.select{ |pin| pin.is_a?(Pin::BaseMethod) && pin.name == name && pin.namespace == region.closure.full_context.namespace && pin.context.scope == (region.scope || :instance)}
+                    matches.each do |pin|
+                      # @todo Smelly instance variable access
+                      pin.instance_variable_set(:@visibility, node.children[1])
+                    end
+                  end
+                else
+                  # @todo Smelly instance variable access
+                  region.instance_variable_set(:@visibility, node.children[1])
+                end
+              elsif node.children[1] == :module_function
+                process_module_function
+              elsif [:attr_reader, :attr_writer, :attr_accessor].include?(node.children[1])
+                process_attribute
+              elsif node.children[1] == :include
+                process_include
+              elsif node.children[1] == :extend
+                process_extend
+              elsif node.children[1] == :prepend
+                process_prepend
+              elsif node.children[1] == :require
+                process_require
+              elsif node.children[1] == :private_constant
+                process_private_constant
+              elsif node.children[1] == :alias_method && node.children[2] && node.children[2] && node.children[2].type == :sym && node.children[3] && node.children[3].type == :sym
+                process_alias_method
+              elsif node.children[1] == :private_class_method && node.children[2].is_a?(AST::Node)
+                # Processing a private class can potentially handle children on its own
+                return if process_private_class_method
+              end
+            elsif node.children[1] == :require && node.children[0].to_s == '(const nil :Bundler)'
+              pins.push Pin::Reference::Require.new(Solargraph::Location.new(region.filename, Solargraph::Range.from_to(0, 0, 0, 0)), 'bundler/require')
+            end
+            process_children
+          end
+
+          private
+
+          # @return [void]
+          def process_attribute
+            node.children[2..-1].each do |a|
+              loc = get_node_location(node)
+              clos = region.closure
+              cmnt = comments_for(node)
+              if node.children[1] == :attr_reader || node.children[1] == :attr_accessor
+                pins.push Solargraph::Pin::Attribute.new(
+                  location: loc,
+                  closure: clos,
+                  name: a.children[0].to_s,
+                  comments: cmnt,
+                  access: :reader,
+                  scope: region.scope || :instance,
+                  visibility: region.visibility
+                )
+              end
+              if node.children[1] == :attr_writer || node.children[1] == :attr_accessor
+                pins.push Solargraph::Pin::Attribute.new(
+                  location: loc,
+                  closure: clos,
+                  name: "#{a.children[0]}=",
+                  comments: cmnt,
+                  access: :writer,
+                  scope: region.scope || :instance,
+                  visibility: region.visibility
+                )
+              end
+            end
+          end
+
+          # @return [void]
+          def process_include
+            if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
+              cp = region.closure
+              node.children[2..-1].each do |i|
+                pins.push Pin::Reference::Include.new(
+                  location: get_node_location(i),
+                  closure: cp,
+                  name: unpack_name(i)
+                )
+              end
+            end
+          end
+
+          def process_prepend
+            if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
+              cp = region.closure
+              node.children[2..-1].each do |i|
+                pins.push Pin::Reference::Prepend.new(
+                  location: get_node_location(i),
+                  closure: cp,
+                  name: unpack_name(i)
+                )
+              end
+            end
+          end
+
+          # @return [void]
+          def process_extend
+            node.children[2..-1].each do |i|
+              loc = get_node_location(node)
+              if i.type == :self
+                pins.push Pin::Reference::Extend.new(
+                  location: loc,
+                  closure: region.closure,
+                  name: region.closure.full_context.namespace
+                )
+              else
+                pins.push Pin::Reference::Extend.new(
+                  location: loc,
+                  closure: region.closure,
+                  name: unpack_name(i)
+                )
+              end
+            end
+          end
+
+          # @return [void]
+          def process_require
+            if node.children[2].is_a?(AST::Node) && node.children[2].type == :str
+              path = node.children[2].children[0].to_s
+              pins.push Pin::Reference::Require.new(get_node_location(node), path)
+            end
+          end
+
+          # @return [void]
+          def process_module_function
+            if node.children[2].nil?
+              # @todo Smelly instance variable access
+              region.instance_variable_set(:@visibility, :module_function)
+            elsif node.children[2].type == :sym || node.children[2].type == :str
+              node.children[2..-1].each do |x|
+                cn = x.children[0].to_s
+                ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == cn}.first
+                unless ref.nil?
+                  pins.delete ref
+                  mm = Solargraph::Pin::Method.new(
+                    location: ref.location,
+                    closure: ref.closure,
+                    name: ref.name,
+                    comments: ref.comments,
+                    scope: :class,
+                    visibility: :public,
+                    node: ref.node
+                  )
+                  cm = Solargraph::Pin::Method.new(
+                    location: ref.location,
+                    closure: ref.closure,
+                    name: ref.name,
+                    comments: ref.comments,
+                    scope: :instance,
+                    visibility: :private,
+                    node: ref.node)
+                  pins.push mm, cm
+                  pins.select{|pin| pin.is_a?(Pin::InstanceVariable) && pin.closure.path == ref.path}.each do |ivar|
+                    pins.delete ivar
+                    pins.push Solargraph::Pin::InstanceVariable.new(
+                      location: ivar.location,
+                      closure: cm,
+                      name: ivar.name,
+                      comments: ivar.comments,
+                      assignment: ivar.assignment
+                    )
+                    pins.push Solargraph::Pin::InstanceVariable.new(
+                      location: ivar.location,
+                      closure: mm,
+                      name: ivar.name,
+                      comments: ivar.comments,
+                      assignment: ivar.assignment
+                    )
+                  end
+                end
+              end
+            elsif node.children[2].type == :def
+              NodeProcessor.process node.children[2], region.update(visibility: :module_function), pins, locals
+            end
+          end
+
+          # @return [void]
+          def process_private_constant
+            if node.children[2] && (node.children[2].type == :sym || node.children[2].type == :str)
+              cn = node.children[2].children[0].to_s
+              ref = pins.select{|p| [Solargraph::Pin::Namespace, Solargraph::Pin::Constant].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == cn}.first
+              # HACK: Smelly instance variable access
+              ref.instance_variable_set(:@visibility, :private) unless ref.nil?
+            end
+          end
+
+          # @return [void]
+          def process_alias_method
+            loc = get_node_location(node)
+            pins.push Solargraph::Pin::MethodAlias.new(
+              location: get_node_location(node),
+              closure: region.closure,
+              name: node.children[2].children[0].to_s,
+              original: node.children[3].children[0].to_s,
+              scope: region.scope || :instance
+            )
+          end
+
+          # @return [Boolean]
+          def process_private_class_method
+            if node.children[2].type == :sym || node.children[2].type == :str
+              ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == node.children[2].children[0].to_s}.first
+              # HACK: Smelly instance variable access
+              ref.instance_variable_set(:@visibility, :private) unless ref.nil?
+              false
+            else
+              process_children region.update(scope: :class, visibility: :private)
+              true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/legacy/node_processors/sym_node.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module Legacy
+      module NodeProcessors
+        class SymNode < Parser::NodeProcessor::Base
+          def process
+            pins.push Solargraph::Pin::Symbol.new(
+              get_node_location(node),
+              ":#{node.children[0]}"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/node_methods.rb

@@ -0,0 +1,43 @@
+module Solargraph
+  module Parser
+    class NodeMethods
+      module_function
+
+      def unpack_name node
+        raise NotImplementedError
+      end
+
+      def infer_literal_type node
+        raise NotImplementedError
+      end
+
+      def calls_from node
+        raise NotImplementedError
+      end
+
+      def returns_from node
+        raise NotImplementedError
+      end
+
+      def process node
+        raise NotImplementedError
+      end
+
+      def references node
+        raise NotImplementedError
+      end
+
+      def chain node, filename = nil, in_block = false
+        raise NotImplementedError
+      end
+
+      def node? node
+        raise NotImplementedError
+      end
+
+      def convert_hash node
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/solargraph/parser/node_processor.rb

@@ -0,0 +1,43 @@
+# 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
+        @@processors ||= {}
+
+        # Register a processor for a node type.
+        #
+        # @param type [Symbol]
+        # @param cls [Class<NodeProcessor::Base>]
+        # @return [Class<NodeProcessor::Base>]
+        def register type, cls
+          @@processors[type] = cls
+        end
+      end
+
+      # @param node [Parser::AST::Node]
+      # @param region [Region]
+      # @param pins [Array<Pin::Base>]
+      # @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: ''
+          )
+        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]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module NodeProcessor
+      class Base
+        # @todo The base node processor should not include legacy node methods
+        # include Legacy::NodeMethods
+
+        # @return [Parser::AST::Node]
+        attr_reader :node
+
+        # @return [Region]
+        attr_reader :region
+
+        # @return [Array<Pin::Base>]
+        attr_reader :pins
+
+        # @return [Array<Pin::Base>]
+        attr_reader :locals
+
+        # @param node [Parser::AST::Node]
+        # @param region [Region]
+        # @param pins [Array<Pin::Base>]
+        def initialize node, region, pins, locals
+          @node = node
+          @region = region
+          @pins = pins
+          @locals = locals
+        end
+
+        # Subclasses should override this method to generate new pins.
+        #
+        # @return [void]
+        def process
+          process_children
+        end
+
+        private
+
+        # @param subregion [Region]
+        # @return [void]
+        def process_children subregion = region
+          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
+
+        def comments_for(node)
+          region.source.comments_for(node)
+        end
+
+        def named_path_pin position
+          pins.select{|pin| pin.is_a?(Pin::Closure) && pin.path && !pin.path.empty? && pin.location.range.contain?(position)}.last
+        end
+
+        # @todo Candidate for deprecation
+        def block_pin position
+          pins.select{|pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position)}.last
+        end
+
+        # @todo Candidate for deprecation
+        def closure_pin position
+          pins.select{|pin| pin.is_a?(Pin::Closure) && pin.location.range.contain?(position)}.last
+        end
+      end
+    end
+  end
+end