solargraph 0.51.2 → 0.53.0

data/lib/solargraph/documentor.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler'
-require 'json'
-require 'open3'
-require 'shellwords'
-require 'yard'
-require 'fileutils'
-
-module Solargraph
-  class Documentor
-    RDOC_GEMS = %w[
-      actioncable actionmailbox actionmailer actionpack actiontext actionview
-      activejob activemodel activerecord activestorage activesupport railties
-    ]
-
-    def initialize directory, rebuild: false, out: File.new(File::NULL, 'w')
-      @directory = directory
-      @rebuild = rebuild
-      @out = out
-    end
-
-    # @return [Boolean] True if all specs were found and documented.
-    def document
-      failures = 0
-      Documentor.specs_from_bundle(@directory).each_pair do |name, version|
-        yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
-        if !yd || @rebuild
-          FileUtils.safe_unlink File.join(YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}.ser")
-          @out.puts "Documenting #{name} #{version}"
-          `yard gems #{name} #{version} #{@rebuild ? '--rebuild' : ''}`
-          yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
-          # HACK: Ignore errors documenting bundler
-          if !yd && name != 'bundler'
-            @out.puts "#{name} #{version} YARD documentation failed"
-            failures += 1
-          end
-        end
-        if yd && RDOC_GEMS.include?(name)
-          cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}", 'yardoc')
-          if !File.exist?(cache) || @rebuild
-            @out.puts "Caching custom documentation for #{name} #{version}"
-            spec = Gem::Specification.find_by_name(name, "= #{version}")
-            Solargraph::YardMap::RdocToYard.run(spec)
-          end
-        end
-      end
-      if failures > 0
-        @out.puts "#{failures} gem#{failures == 1 ? '' : 's'} could not be documented. You might need to run `bundle install`."
-      end
-      failures == 0
-    rescue Solargraph::BundleNotFoundError => e
-      @out.puts "[#{e.class}] #{e.message}"
-      @out.puts "No bundled gems are available in #{@directory}"
-      false
-    end
-
-    # @param directory [String]
-    # @return [Hash]
-    def self.specs_from_bundle directory
-      Solargraph.with_clean_env do
-        cmd = [
-          'ruby', '-e',
-          "require 'bundler'; require 'json'; Dir.chdir('#{directory}') { puts Bundler.definition.specs_for([:default]).map { |spec| [spec.name, spec.version] }.to_h.to_json }"
-        ]
-        o, e, s = Open3.capture3(*cmd)
-        if s.success?
-          o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
-        else
-          Solargraph.logger.warn e
-          raise BundleNotFoundError, "Failed to load gems from bundle at #{directory}"
-        end
-      end
-    end
-  end
-end

data/lib/solargraph/parser/legacy/node_methods.rb

@@ -1,325 +0,0 @@
-# frozen_string_literal: true
-
-require 'parser'
-
-module Solargraph
-  module Parser
-    module Legacy
-      module NodeMethods
-        module_function
-
-        # @param node [Parser::AST::Node]
-        # @return [String]
-        def unpack_name(node)
-          pack_name(node).join("::")
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [Array<String>]
-        def pack_name(node)
-          parts = []
-          if node.is_a?(AST::Node)
-            node.children.each { |n|
-              if n.is_a?(AST::Node)
-                if n.type == :cbase
-                  parts = [''] + pack_name(n)
-                else
-                  parts += pack_name(n)
-                end
-              else
-                parts.push n unless n.nil?
-              end
-            }
-          end
-          parts
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [String, nil]
-        def infer_literal_node_type node
-          return nil unless node.is_a?(AST::Node)
-          if node.type == :str || node.type == :dstr
-            return '::String'
-          elsif node.type == :array
-            return '::Array'
-          elsif node.type == :hash
-            return '::Hash'
-          elsif node.type == :int
-            return '::Integer'
-          elsif node.type == :float
-            return '::Float'
-          elsif node.type == :sym
-            return '::Symbol'
-          elsif node.type == :regexp
-            return '::Regexp'
-          elsif node.type == :irange
-            return '::Range'
-          elsif node.type == :true || node.type == :false
-            return '::Boolean'
-            # @todo Support `nil` keyword in types
-          # elsif node.type == :nil
-          #   return 'NilClass'
-          end
-          nil
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [Position]
-        def get_node_start_position(node)
-          Position.new(node.loc.line, node.loc.column)
-        end
-
-        # @param node [Parser::AST::Node]
-        # @return [Position]
-        def get_node_end_position(node)
-          Position.new(node.loc.last_line, node.loc.last_column)
-        end
-
-        def drill_signature node, signature
-          return signature unless node.is_a?(AST::Node)
-          if node.type == :const or node.type == :cbase
-            unless node.children[0].nil?
-              signature += drill_signature(node.children[0], signature)
-            end
-            signature += '::' unless signature.empty?
-            signature += node.children[1].to_s
-          elsif node.type == :lvar or node.type == :ivar or node.type == :cvar
-            signature += '.' unless signature.empty?
-            signature += node.children[0].to_s
-          elsif node.type == :send
-            unless node.children[0].nil?
-              signature += drill_signature(node.children[0], signature)
-            end
-            signature += '.' unless signature.empty?
-            signature += node.children[1].to_s
-          end
-          signature
-        end
-
-        def convert_hash node
-          return {} unless Parser.is_ast_node?(node)
-          return convert_hash(node.children[0]) if node.type == :kwsplat
-          return convert_hash(node.children[0]) if Parser.is_ast_node?(node.children[0]) && node.children[0].type == :kwsplat
-          return {} unless node.type == :hash
-          result = {}
-          node.children.each do |pair|
-            result[pair.children[0].children[0]] = Solargraph::Parser.chain(pair.children[1])
-          end
-          result
-        end
-
-        NIL_NODE = ::Parser::AST::Node.new(:nil)
-
-        def const_nodes_from node
-          return [] unless Parser.is_ast_node?(node)
-          result = []
-          if node.type == :const
-            result.push node
-          else
-            node.children.each { |child| result.concat const_nodes_from(child) }
-          end
-          result
-        end
-
-        def splatted_hash? node
-          Parser.is_ast_node?(node.children[0]) && node.children[0].type == :kwsplat
-        end
-
-        def splatted_call? node
-          return false unless Parser.is_ast_node?(node)
-          Parser.is_ast_node?(node.children[0]) && node.children[0].type == :kwsplat && node.children[0].children[0].type != :hash
-        end
-
-        def any_splatted_call?(nodes)
-          nodes.any? { |n| splatted_call?(n) }
-        end
-
-        # @todo Temporarily here for testing. Move to Solargraph::Parser.
-        def call_nodes_from node
-          return [] unless node.is_a?(::Parser::AST::Node)
-          result = []
-          if node.type == :block
-            result.push node
-            if Parser.is_ast_node?(node.children[0]) && node.children[0].children.length > 2
-              node.children[0].children[2..-1].each { |child| result.concat call_nodes_from(child) }
-            end
-            node.children[1..-1].each { |child| result.concat call_nodes_from(child) }
-          elsif node.type == :send
-            result.push node
-            node.children[2..-1].each { |child| result.concat call_nodes_from(child) }
-          elsif [:super, :zsuper].include?(node.type)
-            result.push node
-            node.children.each { |child| result.concat call_nodes_from(child) }
-          elsif node.type == :masgn
-            # @todo We're treating a mass assignment as a call node, but the
-            #   type checker still needs the logic to handle it.
-            result.push node
-          else
-            node.children.each { |child| result.concat call_nodes_from(child) }
-          end
-          result
-        end
-
-        # Find all the nodes within the provided node that potentially return a
-        # value.
-        #
-        # The node parameter typically represents a method's logic, e.g., the
-        # second child (after the :args node) of a :def node. A simple one-line
-        # method would typically return itself, while a node with conditions
-        # would return the resulting node from each conditional branch. Nodes
-        # that follow a :return node are assumed to be unreachable. Nil values
-        # are converted to nil node types.
-        #
-        # @param node [Parser::AST::Node]
-        # @return [Array<Parser::AST::Node>]
-        def returns_from node
-          DeepInference.get_return_nodes(node).map { |n| n || NIL_NODE }
-        end
-
-        # @param cursor [Solargraph::Source::Cursor]
-        def find_recipient_node cursor
-          return repaired_find_recipient_node(cursor) if cursor.source.repaired? && cursor.source.code[cursor.offset - 1] == '('
-          source = cursor.source
-          position = cursor.position
-          offset = cursor.offset
-          tree = if source.synchronized?
-            match = source.code[0..offset-1].match(/,\s*\z/)
-            if match
-              source.tree_at(position.line, position.column - match[0].length)
-            else
-              source.tree_at(position.line, position.column)
-            end
-          else
-            source.tree_at(position.line, position.column - 1)
-          end
-          prev = nil
-          tree.each do |node|
-            if node.type == :send
-              args = node.children[2..-1]
-              if !args.empty?
-                return node if prev && args.include?(prev)
-              else
-                if source.synchronized?
-                  return node if source.code[0..offset-1] =~ /\(\s*\z/ && source.code[offset..-1] =~ /^\s*\)/
-                else
-                  return node if source.code[0..offset-1] =~ /\([^\(]*\z/
-                end
-              end
-            end
-            prev = node
-          end
-          nil
-        end
-
-        def repaired_find_recipient_node cursor
-          cursor = cursor.source.cursor_at([cursor.position.line, cursor.position.column - 1])
-          node = cursor.source.tree_at(cursor.position.line, cursor.position.column).first
-          return node if node && node.type == :send
-        end
-
-        module DeepInference
-          class << self
-            CONDITIONAL = [:if, :unless]
-            REDUCEABLE = [:begin, :kwbegin]
-            SKIPPABLE = [:def, :defs, :class, :sclass, :module]
-
-            # @param node [Parser::AST::Node]
-            # @return [Array<Parser::AST::Node>]
-            def get_return_nodes node
-              return [] unless node.is_a?(::Parser::AST::Node)
-              result = []
-              if REDUCEABLE.include?(node.type)
-                result.concat get_return_nodes_from_children(node)
-              elsif CONDITIONAL.include?(node.type)
-                result.concat reduce_to_value_nodes(node.children[1..-1])
-                # result.push NIL_NODE unless node.children[2]
-              elsif node.type == :or
-                result.concat reduce_to_value_nodes(node.children)
-              elsif node.type == :return
-                result.concat reduce_to_value_nodes([node.children[0]])
-              elsif node.type == :block
-                result.push node
-                result.concat get_return_nodes_only(node.children[2])
-              elsif node.type == :case
-                node.children[1..-1].each do |cc|
-                  if cc.nil?
-                    result.push NIL_NODE
-                  else
-                    result.concat reduce_to_value_nodes(cc.children[1..-2]) unless cc.children.length < 1
-                    result.concat reduce_to_value_nodes([cc.children.last])
-                  end
-                end
-              else
-                result.push node
-              end
-              result
-            end
-
-            private
-
-            def get_return_nodes_from_children parent
-              result = []
-              nodes = parent.children.select{|n| n.is_a?(AST::Node)}
-              nodes.each_with_index do |node, idx|
-                if node.type == :block
-                  result.concat get_return_nodes_only(node.children[2])
-                elsif SKIPPABLE.include?(node.type)
-                  next
-                elsif node.type == :return
-                  result.concat reduce_to_value_nodes([node.children[0]])
-                  # Return the result here because the rest of the code is
-                  # unreachable
-                  return result
-                else
-                  result.concat get_return_nodes_only(node)
-                end
-                result.concat reduce_to_value_nodes([nodes.last]) if idx == nodes.length - 1
-              end
-              result
-            end
-
-            def get_return_nodes_only parent
-              return [] unless parent.is_a?(::Parser::AST::Node)
-              result = []
-              nodes = parent.children.select{|n| n.is_a?(::Parser::AST::Node)}
-              nodes.each do |node|
-                next if SKIPPABLE.include?(node.type)
-                if node.type == :return
-                  result.concat reduce_to_value_nodes([node.children[0]])
-                  # Return the result here because the rest of the code is
-                  # unreachable
-                  return result
-                else
-                  result.concat get_return_nodes_only(node)
-                end
-              end
-              result
-            end
-
-            def reduce_to_value_nodes nodes
-              result = []
-              nodes.each do |node|
-                if !node.is_a?(::Parser::AST::Node)
-                  result.push nil
-                elsif REDUCEABLE.include?(node.type)
-                  result.concat get_return_nodes_from_children(node)
-                elsif CONDITIONAL.include?(node.type)
-                  result.concat reduce_to_value_nodes(node.children[1..-1])
-                elsif node.type == :return
-                  result.concat reduce_to_value_nodes([node.children[0]])
-                elsif node.type == :or
-                  result.concat reduce_to_value_nodes(node.children)
-                elsif node.type == :block
-                  result.concat get_return_nodes_only(node.children[2])
-                else
-                  result.push node
-                end
-              end
-              result
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module Legacy
-      module NodeProcessors
-        class AliasNode < Parser::NodeProcessor::Base
-          def process
-            loc = get_node_location(node)
-            pins.push Solargraph::Pin::MethodAlias.new(
-              location: loc,
-              closure: region.closure,
-              name: node.children[0].children[0].to_s,
-              original: node.children[1].children[0].to_s,
-              scope: region.scope || :instance
-            )
-            process_children
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module Legacy
-      module NodeProcessors
-        class BeginNode < Parser::NodeProcessor::Base
-          def process
-            process_children
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# 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/legacy/node_processors.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require 'solargraph/parser/node_processor'
-
-module Solargraph
-  module Parser
-    module Legacy
-      module NodeProcessors
-        autoload :BeginNode,     'solargraph/parser/legacy/node_processors/begin_node'
-        autoload :DefNode,       'solargraph/parser/legacy/node_processors/def_node'
-        autoload :DefsNode,      'solargraph/parser/legacy/node_processors/defs_node'
-        autoload :SendNode,      'solargraph/parser/legacy/node_processors/send_node'
-        autoload :NamespaceNode, 'solargraph/parser/legacy/node_processors/namespace_node'
-        autoload :SclassNode,    'solargraph/parser/legacy/node_processors/sclass_node'
-        autoload :ModuleNode,    'solargraph/parser/legacy/node_processors/module_node'
-        autoload :IvasgnNode,    'solargraph/parser/legacy/node_processors/ivasgn_node'
-        autoload :CvasgnNode,    'solargraph/parser/legacy/node_processors/cvasgn_node'
-        autoload :LvasgnNode,    'solargraph/parser/legacy/node_processors/lvasgn_node'
-        autoload :GvasgnNode,    'solargraph/parser/legacy/node_processors/gvasgn_node'
-        autoload :CasgnNode,     'solargraph/parser/legacy/node_processors/casgn_node'
-        autoload :AliasNode,     'solargraph/parser/legacy/node_processors/alias_node'
-        autoload :ArgsNode,      'solargraph/parser/legacy/node_processors/args_node'
-        autoload :BlockNode,     'solargraph/parser/legacy/node_processors/block_node'
-        autoload :OrasgnNode,    'solargraph/parser/legacy/node_processors/orasgn_node'
-        autoload :SymNode,       'solargraph/parser/legacy/node_processors/sym_node'
-        autoload :ResbodyNode,   'solargraph/parser/legacy/node_processors/resbody_node'
-      end
-    end
-
-    module NodeProcessor
-      register :source,       Legacy::NodeProcessors::BeginNode
-      register :begin,        Legacy::NodeProcessors::BeginNode
-      register :kwbegin,      Legacy::NodeProcessors::BeginNode
-      register :rescue,       Legacy::NodeProcessors::BeginNode
-      register :resbody,      Legacy::NodeProcessors::ResbodyNode
-      register :def,          Legacy::NodeProcessors::DefNode
-      register :defs,         Legacy::NodeProcessors::DefsNode
-      register :send,         Legacy::NodeProcessors::SendNode
-      register :class,        Legacy::NodeProcessors::NamespaceNode
-      register :module,       Legacy::NodeProcessors::NamespaceNode
-      register :sclass,       Legacy::NodeProcessors::SclassNode
-      register :ivasgn,       Legacy::NodeProcessors::IvasgnNode
-      register :cvasgn,       Legacy::NodeProcessors::CvasgnNode
-      register :lvasgn,       Legacy::NodeProcessors::LvasgnNode
-      register :gvasgn,       Legacy::NodeProcessors::GvasgnNode
-      register :casgn,        Legacy::NodeProcessors::CasgnNode
-      register :alias,        Legacy::NodeProcessors::AliasNode
-      register :args,         Legacy::NodeProcessors::ArgsNode
-      register :forward_args, Legacy::NodeProcessors::ArgsNode
-      register :block,        Legacy::NodeProcessors::BlockNode
-      register :or_asgn,      Legacy::NodeProcessors::OrasgnNode
-      register :sym,          Legacy::NodeProcessors::SymNode
-    end
-  end
-end

data/lib/solargraph/parser/legacy.rb

@@ -1,12 +0,0 @@
-module Solargraph
-  module Parser
-    module Legacy
-      autoload :FlawedBuilder, 'solargraph/parser/legacy/flawed_builder'
-      autoload :ClassMethods, 'solargraph/parser/legacy/class_methods'
-      autoload :NodeMethods, 'solargraph/parser/legacy/node_methods'
-      autoload :NodeChainer, 'solargraph/parser/legacy/node_chainer'
-    end
-  end
-end
-
-require 'solargraph/parser/legacy/node_processors'

data/lib/solargraph/parser/rubyvm/class_methods.rb

@@ -1,153 +0,0 @@
-require 'solargraph/parser/rubyvm/node_processors'
-require 'solargraph/parser/rubyvm/node_wrapper'
-
-module Solargraph
-  module Parser
-    module Rubyvm
-      module ClassMethods
-        # @param code [String]
-        # @param filename [String]
-        # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
-        # @sg-ignore
-        def parse_with_comments code, filename = nil
-          node = RubyVM::AbstractSyntaxTree.parse(code).children[2]
-          node &&= RubyVM::AbstractSyntaxTree::NodeWrapper.from(node, code.lines)
-          comments = CommentRipper.new(code).parse
-          [node, comments]
-        rescue ::SyntaxError => e
-          raise Parser::SyntaxError, e.message
-        end
-
-        # @param code [String]
-        # @param filename [String, nil]
-        # @param line [Integer]
-        # @return [Parser::AST::Node]
-        # @sg-ignore
-        def parse code, filename = nil, line = 0
-          node = RubyVM::AbstractSyntaxTree.parse(code).children[2]
-          node and RubyVM::AbstractSyntaxTree::NodeWrapper.from(node, code.lines)
-        rescue ::SyntaxError => e
-          raise Parser::SyntaxError, e.message
-        end
-
-        def map source
-          NodeProcessor.process(source.node, Region.new(source: source))
-        end
-
-        def references source, name
-          if name.end_with?("=")
-            reg = /#{Regexp.escape name[0..-2]}\s*=/
-            extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
-          else
-            extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
-          end
-          inner_node_references(name, source.node).map do |n|
-            rng = Range.from_node(n)
-            offset = Position.to_offset(source.code, rng.start)
-            soff, eoff = extract_offset[source.code, offset]
-            Location.new(
-              source.filename,
-              Range.new(
-                Position.from_offset(source.code, soff),
-                Position.from_offset(source.code, eoff)
-              )
-            )
-          end
-        end
-
-        # @param name [String]
-        # @param top [AST::Node]
-        # @return [Array<AST::Node>]
-        def inner_node_references name, top
-          result = []
-          if Parser.rubyvm?
-            if Parser.is_ast_node?(top)
-              result.push top if match_rubyvm_node_to_ref(top, name)
-              top.children.each { |c| result.concat inner_node_references(name, c) }
-            end
-          else
-            if Parser.is_ast_node?(top) && top.to_s.include?(":#{name}")
-              result.push top if top.children.any? { |c| c.to_s == name }
-              top.children.each { |c| result.concat inner_node_references(name, c) }
-            end
-          end
-          result
-        end
-
-        def match_rubyvm_node_to_ref(top, name)
-          top.children.select { |c| c.is_a?(Symbol) }.any? { |c| c.to_s == name } ||
-            top.children.select { |c| c.is_a?(Array) }.any? { |c| c.include?(name.to_sym) }
-        end
-
-        def chain *args
-          NodeChainer.chain *args
-        end
-
-        def chain_string *args
-          NodeChainer.load_string *args
-        end
-
-        def process_node *args
-          Solargraph::Parser::NodeProcessor.process *args
-        end
-
-        def infer_literal_node_type node
-          NodeMethods.infer_literal_node_type node
-        end
-
-        def version
-          Ruby::VERSION
-        end
-
-        def is_ast_node? node
-          if Parser.rubyvm?
-            node.is_a?(RubyVM::AbstractSyntaxTree::Node)
-          else
-            node.is_a?(::Parser::AST::Node)
-          end
-        end
-
-        def node_range node
-          if node.nil?
-            nil
-          else
-          st = Position.new(node.first_lineno - 1, node.first_column)
-          en = Position.new(node.last_lineno - 1, node.last_column)
-          Range.new(st, en)
-          end
-        end
-
-        def recipient_node tree
-          tree.each_with_index do |node, idx|
-            return tree[idx + 1] if [:ARRAY, :ZARRAY, :LIST].include?(node.type) && tree[idx + 1] && [:FCALL, :VCALL, :CALL].include?(tree[idx + 1].type)
-          end
-          nil
-        end
-
-        def string_ranges node
-          return [] unless is_ast_node?(node)
-          result = []
-          if node.type == :STR
-            result.push Range.from_node(node)
-          elsif node.type == :DSTR
-            here = Range.from_node(node)
-            there = Range.from_node(node.children[1])
-            result.push Range.new(here.start, there&.start || here.ending)
-          end
-          node.children.each do |child|
-            result.concat string_ranges(child)
-          end
-          if node.type == :DSTR && node.children.last.nil?
-            last = node.children[-2]
-            unless last.nil?
-              rng = Range.from_node(last)
-              pos = Position.new(rng.ending.line, rng.ending.column - 1)
-              result.push Range.new(pos, pos)
-            end
-          end
-          result
-        end
-      end
-    end
-  end
-end