solargraph 0.58.3 → 0.59.2

data/lib/solargraph/diagnostics/rubocop.rb

@@ -17,7 +17,7 @@ module Solargraph
         'warning' => Severities::WARNING,
         'error' => Severities::ERROR,
         'fatal' => Severities::ERROR
-      }
+      }.freeze
 
       # @param source [Solargraph::Source]
       # @param _api_map [Solargraph::ApiMap]
@@ -25,6 +25,7 @@ module Solargraph
       def diagnose source, _api_map
         @source = source
         require_rubocop(rubocop_version)
+        # @sg-ignore Need to add nil check here
         options, paths = generate_options(source.filename, source.code)
         store = RuboCop::ConfigStore.new
         runner = RuboCop::Runner.new(options, store)
@@ -32,7 +33,7 @@ module Solargraph
         # a time - it uses 'chdir' to read config files with ERB,
         # which can conflict with other chdirs.
         result = Solargraph::CHDIR_MUTEX.synchronize do
-          redirect_stdout{ runner.run(paths) }
+          redirect_stdout { runner.run(paths) }
         end
 
         return [] if result.empty?
@@ -76,7 +77,7 @@ module Solargraph
           severity: SEVERITIES[off['severity']],
           source: 'rubocop',
           code: off['cop_name'],
-          message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
+          message: off['message'].gsub(/^#{off['cop_name']}:/, '')
         }
       end
 
@@ -95,22 +96,22 @@ module Solargraph
       # @param off [Hash{String => Hash{String => Integer}}]
       # @return [Position]
       def offense_ending_position off
-        if off['location']['start_line'] != off['location']['last_line']
-          Position.new(off['location']['start_line'], 0)
-        else
+        if off['location']['start_line'] == off['location']['last_line']
           start_line = off['location']['start_line'] - 1
           # @type [Integer]
           last_column = off['location']['last_column']
           line = @source.code.lines[start_line]
           col_off = if line.nil? || line.empty?
-            1
-          else
-            0
-          end
+                      1
+                    else
+                      0
+                    end
 
           Position.new(
             start_line, last_column - col_off
           )
+        else
+          Position.new(off['location']['start_line'], 0)
         end
       end
     end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -13,17 +13,18 @@ module Solargraph
       # @param version [String, nil]
       # @raise [InvalidRubocopVersionError] if _version_ is not installed
       # @return [void]
-      def require_rubocop(version = nil)
+      def require_rubocop version = nil
         begin
           # @type [String]
           gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
           gem_lib_path = File.join(gem_path, 'lib')
+          # @sg-ignore Should better support meaning of '&' in RBS
           $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
         rescue Gem::MissingSpecVersionError => e
           # @type [Array<Gem::Specification>]
           specs = e.specs
           raise InvalidRubocopVersionError,
-                "could not find '#{e.name}' (#{e.requirement}) - "\
+                "could not find '#{e.name}' (#{e.requirement}) - " \
                 "did find: [#{specs.map { |s| s.version.version }.join(', ')}]"
         end
         require 'rubocop'
@@ -50,7 +51,8 @@ module Solargraph
       # @return [String]
       def fix_drive_letter path
         return path unless path.match(/^[a-z]:/)
-        path[0].upcase + path[1..-1]
+        # @sg-ignore Need to add nil check here
+        path[0].upcase + path[1..]
       end
 
       # @todo This is a smelly way to redirect output, but the RuboCop specs do

data/lib/solargraph/diagnostics/type_check.rb

@@ -10,18 +10,19 @@ module Solargraph
       def diagnose source, api_map
         # return [] unless args.include?('always') || api_map.workspaced?(source.filename)
         severity = Diagnostics::Severities::ERROR
-        level = (args.reverse.find { |a| ['normal', 'typed', 'strict', 'strong'].include?(a) }) || :normal
+        level = args.reverse.find { |a| %w[normal typed strict strong].include?(a) } || :normal
+        # @sg-ignore sensitive typing needs to handle || on nil types
         checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)
         checker.problems
-          .sort { |a, b| a.location.range.start.line <=> b.location.range.start.line }
-          .map do |problem|
-            {
-              range: extract_first_line(problem.location, source),
-              severity: severity,
-              source: 'Typecheck',
-              message: problem.message
-            }
-          end
+               .sort { |a, b| a.location.range.start.line <=> b.location.range.start.line }
+               .map do |problem|
+          {
+            range: extract_first_line(problem.location, source),
+            severity: severity,
+            source: 'Typecheck',
+            message: problem.message
+          }
+        end
       end
 
       private

data/lib/solargraph/diagnostics/update_errors.rb

@@ -4,16 +4,12 @@ module Solargraph
   module Diagnostics
     class UpdateErrors < Base
       def diagnose source, api_map
-        result = []
-        combine_ranges(source.code, source.error_ranges).each do |range|
-          result.push(
-            range: range.to_hash,
+        combine_ranges(source.code, source.error_ranges).map do |range|
+          { range: range.to_hash,
             severity: Diagnostics::Severities::ERROR,
             source: 'Solargraph',
-            message: 'Syntax error'
-          )
+            message: 'Syntax error' }
         end
-        result
       end
 
       private
@@ -26,7 +22,7 @@ module Solargraph
       def combine_ranges code, ranges
         result = []
         lines = []
-        ranges.sort{|a, b| a.start.line <=> b.start.line}.each do |rng|
+        ranges.sort { |a, b| a.start.line <=> b.start.line }.each do |rng|
           next if rng.nil? || lines.include?(rng.start.line)
           lines.push rng.start.line
           next if rng.start.line >= code.lines.length

data/lib/solargraph/diagnostics.rb

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # The Diagnostics library provides reporters for analyzing problems in code
-  # and providing the results to language server clients.
-  #
-  module Diagnostics
-    autoload :Base,            'solargraph/diagnostics/base'
-    autoload :Severities,      'solargraph/diagnostics/severities'
-    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
-    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
-    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
-    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
-    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
-
-    class << self
-      # Add a reporter with a name to identify it in .solargraph.yml files.
-      #
-      # @param name [String] The name
-      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
-      # @return [void]
-      def register name, klass
-        reporter_hash[name] = klass
-      end
-
-      # Get an array of reporter names.
-      #
-      # @return [Array<String>]
-      def reporters
-        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
-      end
-
-      # Find a reporter by name.
-      #
-      # @param name [String] The name with which the reporter was registered
-      # @return [Class<Solargraph::Diagnostics::Base>, nil]
-      def reporter name
-        reporter_hash[name]
-      end
-
-      private
-
-      # @return [Hash{String => Class<Solargraph::Diagnostics::Base>}]
-      def reporter_hash
-        @reporter_hash ||= {}
-      end
-    end
-
-    register 'rubocop', Rubocop
-    register 'require_not_found', RequireNotFound
-    register 'typecheck', TypeCheck
-    register 'update_errors', UpdateErrors
-    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # The Diagnostics library provides reporters for analyzing problems in code
+  # and providing the results to language server clients.
+  #
+  module Diagnostics
+    autoload :Base,            'solargraph/diagnostics/base'
+    autoload :Severities,      'solargraph/diagnostics/severities'
+    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
+    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
+    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
+    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
+    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
+
+    class << self
+      # Add a reporter with a name to identify it in .solargraph.yml files.
+      #
+      # @param name [String] The name
+      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
+      # @return [void]
+      def register name, klass
+        reporter_hash[name] = klass
+      end
+
+      # Get an array of reporter names.
+      #
+      # @return [Array<String>]
+      def reporters
+        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
+      end
+
+      # Find a reporter by name.
+      #
+      # @param name [String] The name with which the reporter was registered
+      # @return [Class<Solargraph::Diagnostics::Base>, nil]
+      def reporter name
+        reporter_hash[name]
+      end
+
+      private
+
+      # @return [Hash{String => Class<Solargraph::Diagnostics::Base>}]
+      def reporter_hash
+        @reporter_hash ||= {}
+      end
+    end
+
+    register 'rubocop', Rubocop
+    register 'require_not_found', RequireNotFound
+    register 'typecheck', TypeCheck
+    register 'update_errors', UpdateErrors
+    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
+  end
+end

data/lib/solargraph/doc_map.rb

@@ -46,11 +46,10 @@ module Solargraph
     attr_reader :environ
 
     # @param requires [Array<String>]
-    # @param preferences [Array<Gem::Specification>]
     # @param workspace [Workspace, nil]
-    def initialize(requires, preferences, workspace = nil)
+    # @param [Object] out
+    def initialize requires, workspace, out: $stderr
       @requires = requires.compact
-      @preferences = preferences.compact
       @workspace = workspace
       @rbs_collection_path = workspace&.rbs_collection_path
       @rbs_collection_config_path = workspace&.rbs_collection_config_path
@@ -58,11 +57,13 @@ module Solargraph
       @requires.concat @environ.requires if @environ
       load_serialized_gem_pins
       pins.concat @environ.pins
+      @out = out
     end
 
-    # @param out [IO]
+    # @param out [IO, StringIO, nil]
     # @return [void]
-    def cache_all!(out)
+    # @param [Boolean] rebuild
+    def cache_all! out, rebuild: false
       # if we log at debug level:
       if logger.info?
         gem_desc = uncached_gemspecs.map { |gemspec| "#{gemspec.name}:#{gemspec.version}" }.join(', ')
@@ -72,7 +73,7 @@ module Solargraph
       logger.debug { "Caching for RBS collection: #{uncached_rbs_collection_gemspecs.map(&:name)}" }
       load_serialized_gem_pins
       uncached_gemspecs.each do |gemspec|
-        cache(gemspec, out: out)
+        cache(gemspec, rebuild: rebuild, out: out)
       end
       load_serialized_gem_pins
       @uncached_rbs_collection_gemspecs = []
@@ -80,18 +81,18 @@ module Solargraph
     end
 
     # @param gemspec [Gem::Specification]
-    # @param out [IO]
+    # @param out [IO, StringIO, nil]
     # @return [void]
-    def cache_yard_pins(gemspec, out)
+    def cache_yard_pins gemspec, out
       pins = GemPins.build_yard_pins(yard_plugins, gemspec)
       PinCache.serialize_yard_gem(gemspec, pins)
       logger.info { "Cached #{pins.length} YARD pins for gem #{gemspec.name}:#{gemspec.version}" } unless pins.empty?
     end
 
     # @param gemspec [Gem::Specification]
-    # @param out [IO]
+    # @param out [IO, StringIO, nil]
     # @return [void]
-    def cache_rbs_collection_pins(gemspec, out)
+    def cache_rbs_collection_pins gemspec, out
       rbs_map = RbsMap.from_gemspec(gemspec, rbs_collection_path, rbs_collection_config_path)
       pins = rbs_map.pins
       rbs_version_cache_key = rbs_map.cache_key
@@ -103,16 +104,16 @@ module Solargraph
 
     # @param gemspec [Gem::Specification]
     # @param rebuild [Boolean] whether to rebuild the pins even if they are cached
-    # @param out [IO, nil] output stream for logging
+    # @param out [IO, StringIO, nil] output stream for logging
     # @return [void]
-    def cache(gemspec, rebuild: false, out: nil)
+    def cache gemspec, rebuild: false, out: nil
       build_yard = uncached_yard_gemspecs.include?(gemspec) || rebuild
       build_rbs_collection = uncached_rbs_collection_gemspecs.include?(gemspec) || rebuild
       if build_yard || build_rbs_collection
         type = []
         type << 'YARD' if build_yard
         type << 'RBS collection' if build_rbs_collection
-        out.puts("Caching #{type.join(' and ')} pins for gem #{gemspec.name}:#{gemspec.version}") if out
+        out&.puts("Caching #{type.join(' and ')} pins for gem #{gemspec.name}:#{gemspec.version}")
       end
       cache_yard_pins(gemspec, out) if build_yard
       cache_rbs_collection_pins(gemspec, out) if build_rbs_collection
@@ -130,12 +131,12 @@ module Solargraph
 
     # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
     def self.all_yard_gems_in_memory
-      @yard_gems_in_memory ||= {}
+      @all_yard_gems_in_memory ||= {}
     end
 
     # @return [Hash{String => Hash{Array(String, String) => Array<Pin::Base>}}] stored by RBS collection path
     def self.all_rbs_collection_gems_in_memory
-      @rbs_collection_gems_in_memory ||= {}
+      @all_rbs_collection_gems_in_memory ||= {}
     end
 
     # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
@@ -145,12 +146,13 @@ module Solargraph
 
     # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
     def rbs_collection_pins_in_memory
+      # @sg-ignore rbs_collection_path is String | nil but used as hash key
       self.class.all_rbs_collection_gems_in_memory[rbs_collection_path] ||= {}
     end
 
     # @return [Hash{Array(String, String) => Array<Pin::Base>}] Indexed by gemspec name and version
     def self.all_combined_pins_in_memory
-      @combined_pins_in_memory ||= {}
+      @all_combined_pins_in_memory ||= {}
     end
 
     # @todo this should also include an index by the hash of the RBS collection
@@ -177,18 +179,16 @@ module Solargraph
       @uncached_yard_gemspecs = []
       @uncached_rbs_collection_gemspecs = []
       with_gemspecs, without_gemspecs = required_gems_map.partition { |_, v| v }
-      # @sg-ignore Need support for RBS duck interfaces like _ToHash
       # @type [Array<String>]
-      paths = Hash[without_gemspecs].keys
-      # @sg-ignore Need support for RBS duck interfaces like _ToHash
+      paths = without_gemspecs.to_h.keys
       # @type [Array<Gem::Specification>]
-      gemspecs = Hash[with_gemspecs].values.flatten.compact + dependencies.to_a
+      gemspecs = with_gemspecs.to_h.values.flatten.compact + dependencies.to_a
 
       paths.each do |path|
-        rbs_pins = deserialize_stdlib_rbs_map path
+        deserialize_stdlib_rbs_map path
       end
 
-      logger.debug { "DocMap#load_serialized_gem_pins: Combining pins..." }
+      logger.debug { 'DocMap#load_serialized_gem_pins: Combining pins...' }
       time = Benchmark.measure do
         gemspecs.each do |gemspec|
           pins = deserialize_combined_pin_cache gemspec
@@ -232,7 +232,7 @@ module Solargraph
 
     # @param gemspec [Gem::Specification]
     # @return [void]
-    def deserialize_combined_pin_cache(gemspec)
+    def deserialize_combined_pin_cache gemspec
       unless combined_pins_in_memory[[gemspec.name, gemspec.version]].nil?
         return combined_pins_in_memory[[gemspec.name, gemspec.version]]
       end
@@ -263,14 +263,14 @@ module Solargraph
       if !yard_pins.nil?
         logger.debug { "Using only YARD pins for #{gemspec.name}:#{gemspec.version}" }
         combined_pins_in_memory[[gemspec.name, gemspec.version]] = yard_pins
-        return combined_pins_in_memory[[gemspec.name, gemspec.version]]
+        combined_pins_in_memory[[gemspec.name, gemspec.version]]
       elsif !rbs_collection_pins.nil?
         logger.debug { "Using only RBS collection pins for #{gemspec.name}:#{gemspec.version}" }
         combined_pins_in_memory[[gemspec.name, gemspec.version]] = rbs_collection_pins
-        return combined_pins_in_memory[[gemspec.name, gemspec.version]]
+        combined_pins_in_memory[[gemspec.name, gemspec.version]]
       else
         logger.debug { "Pins not yet cached for #{gemspec.name}:#{gemspec.version}" }
-        return nil
+        nil
       end
     end
 
@@ -322,9 +322,7 @@ module Solargraph
           # a Gemfile; Gem doesn't try to index the paths in that case.
           #
           # See if we can make a good guess:
-          potential_gemspec = Gem::Specification.find_by_name(gem_name_guess)
-          file = "lib/#{path}.rb"
-          gemspec = potential_gemspec if potential_gemspec.files.any? { |gemspec_file| file == gemspec_file }
+          gemspec = Gem::Specification.find_by_name(gem_name_guess)
         rescue Gem::MissingSpecError
           logger.debug { "Require path #{path} could not be resolved to a gem via find_by_path or guess of #{gem_name_guess}" }
           []
@@ -346,7 +344,7 @@ module Solargraph
     end
 
     # @param gemspec [Gem::Specification]
-    # @param version [Gem::Version]
+    # @param version [Gem::Version, String]
     # @return [Gem::Specification]
     def change_gemspec_version gemspec, version
       Gem::Specification.find_by_name(gemspec.name, "= #{version}")
@@ -364,12 +362,10 @@ module Solargraph
         Solargraph.logger.info "Adding #{spec.name} dependency for #{gemspec.name}"
         dep = Gem.loaded_specs[spec.name]
         # @todo is next line necessary?
-        # @sg-ignore Unresolved call to requirement on Gem::Dependency
         dep ||= Gem::Specification.find_by_name(spec.name, spec.requirement)
         deps.merge fetch_dependencies(dep) if deps.add?(dep)
       rescue Gem::MissingSpecError
-        # @sg-ignore Unresolved call to requirement on Gem::Dependency
-        Solargraph.logger.warn "Gem dependency #{spec.name} #{spec.requirement} for #{gemspec.name} not found in RubyGems."
+        Solargraph.logger.warn "Gem dependency #{spec.name} for #{gemspec.name} not found in RubyGems."
       end.to_a
     end
 
@@ -379,7 +375,6 @@ module Solargraph
       gemspec.dependencies - gemspec.development_dependencies
     end
 
-
     def inspect
       self.class.inspect
     end
@@ -387,9 +382,10 @@ module Solargraph
     # @return [Array<Gem::Specification>, nil]
     def gemspecs_required_from_bundler
       # @todo Handle projects with custom Bundler/Gemfile setups
-      return unless workspace.gemfile?
+      return unless workspace&.gemfile?
 
-      if workspace.gemfile? && Bundler.definition&.lockfile&.to_s&.start_with?(workspace.directory)
+      # @sg-ignore workspace is checked for nil above
+      if workspace.gemfile? && Bundler.definition&.lockfile&.to_s&.start_with?(workspace.directory) # rubocop:disable Style/SafeNavigationChainLength
         # Find only the gems bundler is now using
         Bundler.definition.locked_gems.specs.flat_map do |lazy_spec|
           logger.info "Handling #{lazy_spec.name}:#{lazy_spec.version}"
@@ -407,7 +403,7 @@ module Solargraph
       end
     end
 
-    # @return [Array<Gem::Specification>, nil]
+    # @return [Array<Gem::Specification>]
     def gemspecs_required_from_external_bundle
       logger.info 'Fetching gemspecs required from external bundle'
       return [] unless workspace&.directory
@@ -415,7 +411,8 @@ module Solargraph
       Solargraph.with_clean_env do
         cmd = [
           'ruby', '-e',
-          "require 'bundler'; require 'json'; Dir.chdir('#{workspace&.directory}') { puts Bundler.definition.locked_gems.specs.map { |spec| [spec.name, spec.version] }.to_h.to_json }"
+          # @sg-ignore return above ensures workspace.directory is not nil
+          "require 'bundler'; require 'json'; Dir.chdir('#{workspace.directory}') { puts Bundler.definition.locked_gems.specs.map { |spec| [spec.name, spec.version] }.to_h.to_json }"
         ]
         o, e, s = Open3.capture3(*cmd)
         if s.success?
@@ -431,7 +428,9 @@ module Solargraph
             next specs
           end.compact
         else
-          Solargraph.logger.warn "Failed to load gems from bundle at #{workspace&.directory}: #{e}"
+          # @sg-ignore return above ensures workspace.directory is not nil
+          Solargraph.logger.warn "Failed to load gems from bundle at #{workspace.directory}: #{e}"
+          []
         end
       end
     end

data/lib/solargraph/environ.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # A collection of additional data, such as map pins and required paths, that
-  # can be added to an ApiMap.
-  #
-  # Conventions are used to add Environs.
-  #
-  class Environ
-    # @return [Array<String>]
-    attr_reader :requires
-
-    # @return [Array<String>]
-    attr_reader :domains
-
-    # @return [Array<Pin::Base>]
-    attr_reader :pins
-
-    # @return [Array<String>]
-    attr_reader :yard_plugins
-
-    # @param requires [Array<String>]
-    # @param domains [Array<String>]
-    # @param pins [Array<Pin::Base>]
-    # @param yard_plugins [Array<String>]
-    def initialize requires: [], domains: [], pins: [], yard_plugins: []
-      @requires = requires
-      @domains = domains
-      @pins = pins
-      @yard_plugins = yard_plugins
-    end
-
-    # @return [self]
-    def clear
-      domains.clear
-      requires.clear
-      pins.clear
-      yard_plugins.clear
-      self
-    end
-
-    # @param other [Environ]
-    # @return [self]
-    def merge other
-      domains.concat other.domains
-      requires.concat other.requires
-      pins.concat other.pins
-      yard_plugins.concat other.yard_plugins
-      self
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # A collection of additional data, such as map pins and required paths, that
+  # can be added to an ApiMap.
+  #
+  # Conventions are used to add Environs.
+  #
+  class Environ
+    # @return [Array<String>]
+    attr_reader :requires
+
+    # @return [Array<String>]
+    attr_reader :domains
+
+    # @return [Array<Pin::Base>]
+    attr_reader :pins
+
+    # @return [Array<String>]
+    attr_reader :yard_plugins
+
+    # @param requires [Array<String>]
+    # @param domains [Array<String>]
+    # @param pins [Array<Pin::Base>]
+    # @param yard_plugins [Array<String>]
+    def initialize requires: [], domains: [], pins: [], yard_plugins: []
+      @requires = requires
+      @domains = domains
+      @pins = pins
+      @yard_plugins = yard_plugins
+    end
+
+    # @return [self]
+    def clear
+      domains.clear
+      requires.clear
+      pins.clear
+      yard_plugins.clear
+      self
+    end
+
+    # @param other [Environ]
+    # @return [self]
+    def merge other
+      domains.concat other.domains
+      requires.concat other.requires
+      pins.concat other.pins
+      yard_plugins.concat other.yard_plugins
+      self
+    end
+  end
+end

data/lib/solargraph/equality.rb

@@ -10,16 +10,16 @@ module Solargraph
 
     # @param other [Object]
     # @return [Boolean]
-    def eql?(other)
+    def eql? other
       self.class.eql?(other.class) &&
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
+        # @sg-ignore flow sensitive typing should support .class == .class
         equality_fields.eql?(other.equality_fields)
     end
 
     # @param other [Object]
     # @return [Boolean]
-    def ==(other)
-      self.eql?(other)
+    def == other
+      eql?(other)
     end
 
     def hash