solargraph 0.50.0 → 0.58.2

data/lib/.rubocop.yml

@@ -1,22 +0,0 @@
-AllCops:
-  NewCops: enable
-Style/MethodDefParentheses:
-  Enabled: false
-Layout/EmptyLineAfterGuardClause:
-  Enabled: false
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Metrics/MethodLength:
-  Max: 25
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true

data/lib/solargraph/api_map/bundler_methods.rb

@@ -1,22 +0,0 @@
-require 'bundler'
-require 'shellwords'
-
-module Solargraph
-  class ApiMap
-    module BundlerMethods
-      module_function
-
-      # @param directory [String]
-      # @return [Hash]
-      def require_from_bundle directory
-        begin
-          Solargraph.logger.info "Loading gems for bundler/require"
-          Documentor.specs_from_bundle(directory)
-        rescue BundleNotFoundError => e
-          Solargraph.logger.warn e.message
-          {}
-        end
-      end
-    end
-  end
-end

data/lib/solargraph/cache.rb

@@ -1,53 +0,0 @@
-require 'fileutils'
-
-module Solargraph
-  module Cache
-    class << self
-      # The base directory where cached documentation is installed.
-      #
-      # @return [String]
-      def base_dir
-        # The directory is not stored in a variable so it can be overridden
-        # in specs.
-        ENV['SOLARGRAPH_CACHE'] ||
-          ENV['XDG_CACHE_HOME'] ? File.join(ENV['XDG_CACHE_HOME'], 'solargraph') :
-          File.join(Dir.home, '.cache', 'solargraph')
-      end
-
-      # The working directory for the current Ruby and Solargraph versions.
-      #
-      # @return [String]
-      def work_dir
-        # The directory is not stored in a variable so it can be overridden
-        # in specs.
-        File.join(base_dir, "ruby-#{RUBY_VERSION}", "rbs-#{RBS::VERSION}", "solargraph-#{Solargraph::VERSION}")
-      end
-
-      # @return [Array<Solargraph::Pin::Base>, nil]
-      def load *path
-        file = File.join(work_dir, *path)
-        return nil unless File.file?(file)
-        Marshal.load(File.read(file, mode: 'rb'))
-      rescue StandardError => e
-        Solargraph.logger.warn "Failed to load cached file #{file}: [#{e.class}] #{e.message}"
-        FileUtils.rm_f file
-        nil
-      end
-
-      # @return [Boolean]
-      def save *path, pins
-        return false if pins.empty?
-        file = File.join(work_dir, *path)
-        base = File.dirname(file)
-        FileUtils.mkdir_p base unless File.directory?(base)
-        ser = Marshal.dump(pins)
-        File.write file, ser, mode: 'wb'
-        true
-      end
-
-      def clear
-        FileUtils.rm_rf base_dir, secure: true
-      end
-    end
-  end
-end

data/lib/solargraph/convention/rspec.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    class Rspec < Base
-      def local source_map
-        return EMPTY_ENVIRON unless File.basename(source_map.filename) =~ /_spec\.rb$/
-        @environ ||= Environ.new(
-          requires: ['rspec'],
-          domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
-          pins: [
-            # This override is necessary due to an erroneous @return tag in
-            # rspec's YARD documentation.
-            # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
-            Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
-          ].concat(extras)
-        )
-      end
-
-      private
-
-      def extras
-        @@extras ||= SourceMap.load_string(%(
-          def describe(*args); end
-          def it(*args); end
-        )).pins
-      end
-    end
-  end
-end

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/language_server/host/cataloger.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # An asynchronous library cataloging handler.
-      #
-      class Cataloger
-        def initialize host
-          @host = host
-          @stopped = true
-        end
-
-        # Stop the catalog thread.
-        #
-        # @return [void]
-        def stop
-          @stopped = true
-        end
-
-        # True if the cataloger is stopped.
-        #
-        # @return [Boolean]
-        def stopped?
-          @stopped
-        end
-
-        # Start the catalog thread.
-        #
-        # @return [void]
-        def start
-          return unless stopped?
-          @stopped = false
-          Thread.new do
-            until stopped?
-              tick
-              sleep 0.1
-            end
-          end
-        end
-
-        # Perform cataloging.
-        #
-        # @return [void]
-        def tick
-          host.catalog
-        end
-
-        private
-
-        # @return [Host]
-        attr_reader :host
-      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/args_node.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module Legacy
-      module NodeProcessors
-        class ArgsNode < Parser::NodeProcessor::Base
-          def process
-            node.children.each do |u|
-              loc = get_node_location(u)
-              locals.push Solargraph::Pin::Parameter.new(
-                location: loc,
-                closure: region.closure,
-                comments: comments_for(node),
-                name: u.children[0].to_s,
-                assignment: u.children[1],
-                asgn_code: u.children[1] ? region.code_for(u.children[1]) : nil,
-                presence: region.closure.location.range,
-                decl: get_decl(u)
-              )
-              region.closure.parameters.push locals.last
-            end
-            process_children
-          end
-
-          private
-
-          def get_decl node
-            node.type
-          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,54 +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 :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/node_methods.rb

@@ -1,43 +0,0 @@
-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/rubyvm/class_methods.rb

@@ -1,149 +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
-          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
-
-        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