solargraph 0.41.2 → 0.42.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4533d6cac061c01e292b70313f68a9de816c8af4ca6d34ddf7bde467d0428b0
-  data.tar.gz: 1fd4959f4e1652c8725fcc79f5da92df9f91a90eb5462879f87c30c0c8f2ada2
+  metadata.gz: 28ad96860cdfaaa7ce608149d111164649664a86e13567c63efb0218cac98bff
+  data.tar.gz: 12f96ea8a87a97a98e0f91774bff44ff3c736fe5268cbdb959cfbf0ce70c53b6
 SHA512:
-  metadata.gz: 48b7f57a7b84140cb4ff9b1f2428fb1dfe2c814ef9fca26585bec17ea61a122a8755ab60e8da52969942c5ab674501332f6fc0655fcceb77606f1ab353899a4b
-  data.tar.gz: cd817d200a9579e66f612a100b17096fb56eb468c356de4c75d7c5d0f5621f6e734596f9babe809398f26bd2bcc2226bf424215393fe03626adf03f856eb24b9
+  metadata.gz: '00259fb37ec37b1090797678288f75fc9e1fd26db368d11f6e98f6c89b78745141d416a6a40cc507ce1f032056318c9f67946d9a6d9e17646aee0c9b54a1fd5d'
+  data.tar.gz: 264c5b2e39c4f946f9e375b7d5ef17f97d42c7b6343aa632f1c0319e1a2c6b2b2d73dc50f31b7b863b55b814e0b089cfae63137e8548927e2e0935c4e3243402

data/.travis.yml

@@ -8,15 +8,10 @@ rvm:
   - jruby-head
 matrix:
   include:
-    - rvm: 2.4
-      os: osx
-    - rvm: 2.6
-      os: osx
     - rvm: 2.7
       os: osx
   allow_failures:
     - rvm: jruby-head
-    - rvm: 3.0
 before_install:
 - gem update --system
 - gem install bundler

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.42.4
+- Yardoc cache handling
+- Fix required_paths when gemspec is used (#451)
+- fix: yard stdout may break language client (#454)
+
+## 0.42.3 - June 14, 2021
+- Require 'pathname' for Library
+
+## 0.42.2 - June 14, 2021
+- Improve download-core command output
+- Ignore missing requests to client responses
+- Add automatically required gems to YardMap
+- Use closures to identify local variables
+
+## 0.42.1 - June 11, 2021
+- YardMap#change sets new directory (#445)
+
+## 0.42.0 - June 11, 2021
+- Improve YardMap efficiency
+- Bench includes Workspace for cataloging
+- Initialize confirms static features from options (#436)
+- Enable simple repairs without incremental sync (#416)
+- Discard unrecognized client responses
+- Notify on use of closest match for core (#390)
+
 ## 0.41.2 - June 9, 2021
 - Rescue InvalidOffset in async diagnosis
 - Remove erroneous escaping from Hover

data/SPONSORS.md

@@ -13,4 +13,3 @@ The following people and organizations provide funding or other resources. [Beco
 - Emily Strickland
 - Tom de Grunt
 - Akira Yamada
-- Jared White

data/lib/.rubocop.yml

@@ -1,5 +1,5 @@
-Layout/EndOfLine:
-  EnforcedStyle: lf
+AllCops:
+  NewCops: enable
 Style/MethodDefParentheses:
   Enabled: false
 Layout/EmptyLineAfterGuardClause:
@@ -10,6 +10,8 @@ Lint/RaiseException:
   Enabled: true
 Lint/StructNewOverride:
   Enabled: true
+Metrics/MethodLength:
+  Max: 25
 Style/ExponentialNotation:
   Enabled: true
 Style/HashEachMethods:
@@ -18,4 +20,3 @@ Style/HashTransformKeys:
   Enabled: true
 Style/HashTransformValues:
   Enabled: true
-

data/lib/solargraph/api_map.rb

@@ -17,7 +17,6 @@ module Solargraph
     autoload :BundlerMethods, 'solargraph/api_map/bundler_methods'
 
     include SourceToYard
-    include BundlerMethods
 
     # @return [Array<String>]
     attr_reader :unresolved_requires
@@ -59,30 +58,14 @@ module Solargraph
       implicit.clear
       @cache.clear
       @source_map_hash = bench.source_maps.map { |s| [s.filename, s] }.to_h
-      pins = []
-      @required = Set.new
-      local_path_hash.clear
+      pins = bench.source_maps.map(&:pins).flatten
+      external_requires = bench.external_requires
       source_map_hash.each_value do |map|
-        pins.concat map.pins
-        @required.merge map.requires.map(&:name)
         implicit.merge map.environ
       end
-      @required.merge implicit.requires
-      external_requires = []
-      @required.each do |req|
-        result = bench.load_paths.find do |path|
-          full = Pathname.new(path).join("#{req}.rb").to_s
-          @source_map_hash.key?(full)
-        end
-        if result
-          local_path_hash[req] = Pathname.new(result).join("#{req}.rb").to_s
-        else
-          external_requires.push req unless result
-        end
-      end
-      br = @required.include?('bundler/require') ? require_from_bundle(bench.directory) : {}
-      @required.merge br.keys
-      yard_map.change(external_requires, br, bench.gemnames)
+      external_requires.merge implicit.requires
+      external_requires.merge bench.workspace.config.required
+      yard_map.change(external_requires, bench.workspace.directory, bench.workspace.source_gems)
       @store = Store.new(yard_map.pins + implicit.pins + pins)
       @unresolved_requires = yard_map.unresolved_requires
       @rebindable_method_names = nil
@@ -105,11 +88,6 @@ module Solargraph
       @implicit ||= Environ.new
     end
 
-    # @return [Hash{String => String}]
-    def local_path_hash
-      @local_paths ||= {}
-    end
-
     # @param filename [String]
     # @param position [Position, Array(Integer, Integer)]
     # @return [Source::Cursor]
@@ -456,27 +434,6 @@ module Solargraph
       source_map_hash.keys.include?(filename)
     end
 
-    # True if the specified file is included in the workspace.
-    #
-    # @param filename [String]
-    def workspaced? filename
-      workspace_filenames.include?(filename)
-    end
-
-    # @param location [Location]
-    # @return [Location]
-    def require_reference_at location
-      map = source_map(location.filename)
-      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
-      return nil if pin.nil?
-      if local_path_hash.key?(pin.name)
-        return Location.new(local_path_hash[pin.name], Solargraph::Range.from_to(0, 0, 0, 0))
-      end
-      yard_map.require_reference(pin.name)
-    rescue FileNotFoundError
-      nil
-    end
-
     # Check if a class is a superclass of another class.
     #
     # @param sup [String] The superclass
@@ -508,11 +465,6 @@ module Solargraph
 
     private
 
-    # @return [Array<String>]
-    def workspace_filenames
-      @workspace_filenames ||= []
-    end
-
     # A hash of source maps with filename keys.
     #
     # @return [Hash{String => SourceMap}]

data/lib/solargraph/api_map/bundler_methods.rb

@@ -9,7 +9,7 @@ module Solargraph
       # @param directory [String]
       # @return [Hash]
       def require_from_bundle directory
-        @require_from_bundle ||= begin
+        begin
           Solargraph.logger.info "Loading gems for bundler/require"
           Documentor.specs_from_bundle(directory)
         rescue BundleNotFoundError => e
@@ -17,11 +17,6 @@ module Solargraph
           {}
         end
       end
-
-      # @return [void]
-      def reset_require_from_bundle
-        @require_from_bundle = nil
-      end
     end
   end
 end

data/lib/solargraph/bench.rb

@@ -3,29 +3,25 @@
 require 'set'
 
 module Solargraph
-  # A container of source maps and gem specs to be cataloged in an ApiMap.
+  # A container of source maps and workspace data to be cataloged in an ApiMap.
   #
   class Bench
     # @return [Set<SourceMap>]
     attr_reader :source_maps
 
-    # @return [Set<String>]
-    attr_reader :load_paths
+    # @return [Workspace]
+    attr_reader :workspace
 
     # @return [Set<String>]
-    attr_reader :gemnames
-
-    # @return [String]
-    attr_reader :directory
+    attr_reader :external_requires
 
     # @param source_maps [Array<SourceMap>, Set<SourceMap>]
-    # @param load_paths [Array<String>, Set<String>]
-    # @param gemnames [Array<String>, Set<String>]
-    def initialize source_maps: [], load_paths: [], gemnames: [], directory: ''
+    # @param workspace [Workspace]
+    # @param external_requires [Array<String>, Set<String>]
+    def initialize source_maps: [], workspace: Workspace.new, external_requires: []
       @source_maps = source_maps.to_set
-      @load_paths = load_paths.to_set
-      @gemnames = gemnames.to_set
-      @directory = directory
+      @workspace = workspace
+      @external_requires = external_requires.to_set
     end
   end
 end

data/lib/solargraph/diagnostics/type_check.rb

@@ -7,7 +7,7 @@ module Solargraph
     #
     class TypeCheck < Base
       def diagnose source, api_map
-        return [] unless args.include?('always') || api_map.workspaced?(source.filename)
+        # 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
         checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)

data/lib/solargraph/language_server/host.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require 'diff/lcs'
 require 'observer'
-require 'set'
 require 'securerandom'
+require 'set'
 
 module Solargraph
   module LanguageServer
@@ -30,7 +31,7 @@ module Solargraph
         @cancel = []
         @buffer = String.new
         @stopped = true
-        @next_request_id = 0
+        @next_request_id = 1
         @dynamic_capabilities = Set.new
         @registered_capabilities = Set.new
       end
@@ -107,9 +108,13 @@ module Solargraph
           end
           message
         elsif request['id']
-          # @todo What if the id is invalid?
-          requests[request['id']].process(request['result'])
-          requests.delete request['id']
+          if requests[request['id']]
+            requests[request['id']].process(request['result'])
+            requests.delete request['id']
+          else
+            logger.warn "Discarding client response to unrecognized message #{request['id']}"
+            nil
+          end
         else
           logger.warn "Invalid message received."
           logger.debug request
@@ -165,8 +170,6 @@ module Solargraph
       # @return [void]
       def open_from_disk uri
         sources.open_from_disk(uri)
-        library = library_for(uri)
-        # library.open_from_disk uri_to_file(uri)
         diagnoser.schedule uri
       end
 
@@ -672,7 +675,8 @@ module Solargraph
       # @return [Source::Updater]
       def generate_updater params
         changes = []
-        params['contentChanges'].each do |chng|
+        params['contentChanges'].each do |recvd|
+          chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
             (chng['range'].nil? ? 
               nil :
@@ -688,6 +692,36 @@ module Solargraph
         )
       end
 
+      # @param uri [String]
+      # @param change [Hash]
+      # @return [Hash]
+      def check_diff uri, change
+        return change if change['range']
+        source = sources.find(uri)
+        return change if source.code.length + 1 != change['text'].length
+        diffs = Diff::LCS.diff(source.code, change['text'])
+        return change if diffs.length.zero? || diffs.length > 1 || diffs.first.length > 1
+        # @type [Diff::LCS::Change]
+        diff = diffs.first.first
+        return change unless diff.adding? && ['.', ':'].include?(diff.element)
+        position = Solargraph::Position.from_offset(source.code, diff.position)
+        {
+          'range' => {
+            'start' => {
+              'line' => position.line,
+              'character' => position.character
+            },
+            'end' => {
+              'line' => position.line,
+              'character' => position.character
+            }
+          },
+          'text' => diff.element
+        }
+      rescue Solargraph::FileNotFoundError
+        change
+      end
+
       # @return [Hash]
       def dynamic_capability_options
         @dynamic_capability_options ||= {
@@ -787,7 +821,7 @@ module Solargraph
           next unless uuid
           cur = ((library.source_map_hash.keys.length.to_f / total.to_f) * 100).to_i
           if cur > pct && cur % mod == 0
-          pct = cur
+            pct = cur
             send_notification '$/progress', {
               token: uuid,
               value: {

data/lib/solargraph/language_server/host/sources.rb

@@ -76,7 +76,7 @@ module Solargraph
           source = Solargraph::Source.load(UriHelpers.uri_to_file(uri))
           open_source_hash[uri] = source
         end
-    
+
         # Update an existing source.
         #
         # @raise [FileNotFoundError] if the URI does not match an open source.

data/lib/solargraph/language_server/message/initialize.rb

@@ -51,6 +51,7 @@ module Solargraph
         end
 
         def static_completion
+          return {} unless host.options['completion']
           {
             completionProvider: {
               resolveProvider: true,
@@ -84,18 +85,21 @@ module Solargraph
         end
 
         def static_hover
+          return {} unless host.options['hover']
           {
             hoverProvider: true
           }
         end
 
         def static_document_formatting
+          return {} unless host.options['formatting']
           {
             documentFormattingProvider: true
           }
         end
 
         def static_document_symbols
+          return {} unless host.options['symbols']
           {
             documentSymbolProvider: true
           }
@@ -108,6 +112,7 @@ module Solargraph
         end
 
         def static_definitions
+          return {} unless host.options['definitions']
           {
             definitionProvider: true
           }
@@ -120,12 +125,14 @@ module Solargraph
         end
 
         def static_references
+          return {} unless host.options['references']
           {
             referencesProvider: true
           }
         end
 
         def static_folding_range
+          return {} unless host.options['folding']
           {
             foldingRangeProvider: true
           }

data/lib/solargraph/language_server/transport/adapter.rb

@@ -42,9 +42,7 @@ module Solargraph
         # @return [void]
         def process request
           message = @host.receive(request)
-          message.send_response
-          # tmp = @host.flush
-          # write tmp unless tmp.empty?
+          message && message.send_response
         end
 
         def shutdown

data/lib/solargraph/library.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module Solargraph
   # A Library handles coordination between a Workspace and an ApiMap.
   #
@@ -46,8 +48,10 @@ module Solargraph
     # @return [void]
     def attach source
       mutex.synchronize do
-        if @current && @current.filename != source.filename && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
+        if @current && (!source || @current.filename != source.filename) && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
           source_map_hash.delete @current.filename
+          source_map_external_require_hash.delete @current.filename
+          @external_requires = nil
           @synchronized = false
         end
         @current = source
@@ -252,7 +256,18 @@ module Solargraph
     end
 
     def locate_ref location
-      api_map.require_reference_at location
+      map = source_map_hash[location.filename]
+      return if map.nil?
+      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
+      return nil if pin.nil?
+      workspace.require_paths.each do |path|
+        full = Pathname.new(path).join("#{pin.name}.rb").to_s
+        next unless source_map_hash.key?(full)
+        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
+      end
+      api_map.yard_map.require_reference(pin.name)
+    rescue FileNotFoundError
+      nil
     end
 
     # Get an array of pins that match a path.
@@ -326,6 +341,7 @@ module Solargraph
       return [] unless open?(filename)
       result = []
       source = read(filename)
+      catalog
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'
@@ -335,7 +351,7 @@ module Solargraph
         else
           args = line.split(':').map(&:strip)
           name = args.shift
-            reporter = Diagnostics.reporter(name)
+          reporter = Diagnostics.reporter(name)
           raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
           repargs[reporter] ||= []
           repargs[reporter].concat args
@@ -361,13 +377,10 @@ module Solargraph
     end
 
     def bench
-      source_maps = @current ? [@current] : []
-      source_maps.concat source_map_hash.values
       Bench.new(
-        source_maps: source_maps,
-        load_paths: workspace.require_paths,
-        gemnames: workspace.gemnames,
-        directory: workspace.directory
+        source_maps: source_map_hash.values,
+        workspace: workspace,
+        external_requires: external_requires
       )
     end
 
@@ -423,6 +436,8 @@ module Solargraph
         if src
           Logging.logger.debug "Mapping #{src.filename}"
           source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+          find_external_requires(source_map_hash[src.filename])
+          source_map_hash[src.filename]
         else
           false
         end
@@ -432,6 +447,7 @@ module Solargraph
     def map!
       workspace.sources.each do |src|
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        find_external_requires(source_map_hash[src.filename])
       end
       self
     end
@@ -440,8 +456,29 @@ module Solargraph
       @pins ||= []
     end
 
+    def external_requires
+      @external_requires ||= source_map_external_require_hash.values.flatten.to_set
+    end
+
     private
 
+    def source_map_external_require_hash
+      @source_map_external_require_hash ||= {}
+    end
+
+    # @param source_map [SourceMap]
+    def find_external_requires source_map
+      new_set = source_map.requires.map(&:name).to_set
+      # return if new_set == source_map_external_require_hash[source_map.filename]
+      source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
+        workspace.require_paths.any? do |base|
+          full = Pathname.new(base).join("#{path}.rb").to_s
+          workspace.filenames.include?(full)
+        end
+      end
+      @external_requires = nil
+    end
+
     # @return [Mutex]
     def mutex
       @mutex ||= Mutex.new
@@ -476,6 +513,7 @@ module Solargraph
     end
 
     def maybe_map source
+      return unless source
       if source_map_hash.key?(source.filename)
         return if source_map_hash[source.filename].code == source.code && 
           source_map_hash[source.filename].source.synchronized? &&
@@ -484,6 +522,7 @@ module Solargraph
           new_map = Solargraph::SourceMap.map(source)
           unless source_map_hash[source.filename].try_merge!(new_map)
             source_map_hash[source.filename] = new_map
+            find_external_requires(source_map_hash[source.filename])
             @synchronized = false
           end
         else
@@ -492,6 +531,7 @@ module Solargraph
         end
       else
         source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
+        find_external_requires(source_map_hash[source.filename])
         @synchronized = false
       end
     end

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

@@ -4,9 +4,6 @@ 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
 

data/lib/solargraph/pin/local_variable.rb

@@ -3,7 +3,8 @@
 module Solargraph
   module Pin
     class LocalVariable < BaseVariable
-      include Localized
+      # @return [Range]
+      attr_reader :presence
 
       def initialize assignment: nil, presence: nil, **splat
         super(**splat)
@@ -16,6 +17,51 @@ module Solargraph
         @presence = pin.presence
         true
       end
+
+      # @param other [Pin::Base] The caller's block
+      # @param position [Position, Array(Integer, Integer)] The caller's position
+      # @return [Boolean]
+      def visible_from?(other, position)
+        position = Position.normalize(position)
+        other.filename == filename &&
+          match_tags(other.full_context.tag, full_context.tag) &&
+          (other == closure ||
+            (closure.location.range.contain?(other.location.range.start) && closure.location.range.contain?(other.location.range.ending))
+          ) &&
+          presence.contain?(position)
+      end
+
+      # @param other_loc [Location]
+      def visible_at?(other_closure, other_loc)
+        return true if location.filename == other_loc.filename &&
+          presence.include?(other_loc.range.start) &&
+          match_named_closure(other_closure, closure)
+      end
+
+      private
+
+      # @param tag1 [String]
+      # @param tag2 [String]
+      # @return [Boolean]
+      def match_tags tag1, tag2
+        # @todo This is an unfortunate hack made necessary by a discrepancy in
+        #   how tags indicate the root namespace. The long-term solution is to
+        #   standardize it, whether it's `Class<>`, an empty string, or
+        #   something else.
+        tag1 == tag2 ||
+          (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
+      end
+
+      def match_named_closure needle, haystack
+        return true if needle == haystack
+        cursor = haystack
+        until cursor.nil?
+          return true if needle.path == cursor.path
+          return false if cursor.path && !cursor.path.empty?
+          cursor = cursor.closure
+        end
+        false
+      end
     end
   end
 end

data/lib/solargraph/shell.rb

@@ -74,10 +74,14 @@ module Solargraph
     desc 'download-core [VERSION]', 'Download core documentation'
     def download_core version = nil
       ver = version || Solargraph::YardMap::CoreDocs.best_download
+      if RUBY_VERSION != ver
+        puts "Documentation for #{RUBY_VERSION} is not available. Reverting to closest match..."
+      end
       puts "Downloading docs for #{ver}..."
       Solargraph::YardMap::CoreDocs.download ver
       # Clear cached documentation if it exists
       FileUtils.rm_rf Dir.glob(File.join(Solargraph::YardMap::CoreDocs.cache_dir, ver, '*.ser'))
+      puts "Download complete."
     rescue ArgumentError => e
       STDERR.puts "ERROR: #{e.message}"
       STDERR.puts "Run `solargraph available-cores` for a list."

data/lib/solargraph/source.rb

@@ -6,19 +6,15 @@ module Solargraph
   # A Ruby file that has been parsed into an AST.
   #
   class Source
-    # autoload :FlawedBuilder, 'solargraph/source/flawed_builder'
     autoload :Updater,       'solargraph/source/updater'
     autoload :Change,        'solargraph/source/change'
     autoload :Mapper,        'solargraph/source/mapper'
-    # autoload :NodeMethods,   'solargraph/source/node_methods'
     autoload :EncodingFixes, 'solargraph/source/encoding_fixes'
     autoload :Cursor,        'solargraph/source/cursor'
     autoload :Chain,         'solargraph/source/chain'
     autoload :SourceChainer, 'solargraph/source/source_chainer'
-    # autoload :NodeChainer,   'solargraph/source/node_chainer'
 
     include EncodingFixes
-    # include NodeMethods
 
     # @return [String]
     attr_reader :filename
@@ -50,17 +46,9 @@ module Solargraph
         @node, @comments = Solargraph::Parser.parse_with_comments(@code, filename)
         @parsed = true
       rescue Parser::SyntaxError, EncodingError => e
-        # @todo 100% whitespace results in a nil node, so there's no reason to parse it.
-        #   We still need to determine whether the resulting node should be nil or a dummy
-        #   node with a location that encompasses the range.
-        # @node, @comments = Source.parse_with_comments(@code.gsub(/[^\s]/, ' '), filename)
         @node = nil
         @comments = {}
         @parsed = false
-      # rescue Exception => e
-      #   Solargraph.logger.warn "[#{e.class}] #{e.message}"
-      #   Solargraph.logger.warn e.backtrace.join("\n")
-      #   raise "Error parsing #{filename || '(source)'}: [#{e.class}] #{e.message}"
       ensure
         @code.freeze
       end

data/lib/solargraph/source/chain.rb

@@ -61,10 +61,6 @@ module Solargraph
         working_pin = name_pin
         links[0..-2].each do |link|
           pins = link.resolve(api_map, working_pin, locals)
-          # Locals are only used when resolving the first link
-          # @todo There's a problem here. Call links need to resolve arguments
-          #   that might refer to local variables.
-          # locals = []
           type = infer_first_defined(pins, working_pin, api_map)
           return [] if type.undefined?
           working_pin = Pin::ProxyType.anonymous(type)

data/lib/solargraph/source/chain/call.rb

@@ -77,6 +77,7 @@ module Solargraph
               end
               if match
                 type = extra_return_type(ol, context)
+                break if type
                 type = ComplexType.try_parse(*ol.tag(:return).types).self_to(context.to_s).qualify(api_map, context.namespace) if ol.has_tag?(:return) && ol.tag(:return).types && !ol.tag(:return).types.empty? && (type.nil? || type.undefined?)
                 type ||= ComplexType::UNDEFINED
               end
@@ -170,8 +171,8 @@ module Solargraph
         # @param context [ComplexType]
         # @return [ComplexType]
         def extra_return_type docstring, context
-          if docstring.has_tag?(:return_single_parameter) && context.subtypes.one?
-            return context.subtypes.first
+          if docstring.has_tag?(:return_single_parameter) #&& context.subtypes.one?
+            return context.subtypes.first || ComplexType::UNDEFINED
           elsif docstring.has_tag?(:return_value_parameter) && context.value_types.one?
             return context.value_types.first
           end

data/lib/solargraph/source_map.rb

@@ -131,7 +131,8 @@ module Solargraph
     # @return [Array<Pin::LocalVariable>]
     def locals_at(location)
       return [] if location.filename != filename
-      locals.select { |pin| pin.visible_at?(location) }
+      closure = locate_named_path_pin(location.range.start.line, location.range.start.character)
+      locals.select { |pin| pin.visible_at?(closure, location) }
     end
 
     class << self

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.41.2'
+  VERSION = '0.42.4'
 end

data/lib/solargraph/workspace.rb

@@ -18,6 +18,7 @@ module Solargraph
 
     # @return [Array<String>]
     attr_reader :gemnames
+    alias source_gems gemnames
 
     # @param directory [String]
     # @param config [Config, nil]
@@ -182,7 +183,7 @@ module Solargraph
           end
         end
       end
-      result.concat config.require_paths
+      result.concat(config.require_paths.map { |p| File.join(directory, p) })
       result.push File.join(directory, 'lib') if result.empty?
       result
     end

data/lib/solargraph/yard_map.rb

@@ -20,6 +20,8 @@ module Solargraph
     autoload :Helpers,     'solargraph/yard_map/helpers'
     autoload :ToMethod,    'solargraph/yard_map/to_method'
 
+    include ApiMap::BundlerMethods
+
     CoreDocs.require_minimum
 
     def stdlib_paths
@@ -37,33 +39,16 @@ module Solargraph
       end
     end
 
-    # @return [Array<String>]
-    attr_reader :required
-
     # @return [Boolean]
     attr_writer :with_dependencies
 
-    # A hash of gem names and the version numbers to include in the map.
-    #
-    # @return [Hash{String => String}]
-    attr_reader :gemset
-
-    # @param required [Array<String>]
-    # @param gemset [Hash{String => String}]
+    # @param required [Array<String>, Set<String>]
+    # @param directory [String]
+    # @param source_gems [Array<String>, Set<String>]
     # @param with_dependencies [Boolean]
-    def initialize(required: [], gemset: {}, with_dependencies: true)
-      # HACK: YardMap needs its own copy of this array
-      @required = required.clone
-      # HACK: Hardcoded YAML handling
-      @required.push 'psych' if @required.include?('yaml')
+    def initialize(required: [], directory: '', source_gems: [], with_dependencies: true)
       @with_dependencies = with_dependencies
-      @gem_paths = {}
-      @stdlib_namespaces = []
-      @gemset = gemset
-      @source_gems = []
-      process_requires
-      yardocs.uniq!
-      @pin_select_cache = {}
+      change required.to_set, directory, source_gems.to_set
     end
 
     # @return [Array<Solargraph::Pin::Base>]
@@ -76,25 +61,24 @@ module Solargraph
       @with_dependencies
     end
 
-    # @param new_requires [Array<String>]
-    # @param new_gemset [Hash{String => String}]
+    # @param new_requires [Set<String>] Required paths to use for loading gems
+    # @param new_directory [String] The workspace directory
+    # @param new_source_gems [Set<String>] Gems under local development (i.e., part of the workspace)
     # @return [Boolean]
-    def change new_requires, new_gemset, source_gems = []
+    def change new_requires, new_directory, new_source_gems
+      return false if new_requires == base_required && new_directory == @directory && new_source_gems == @source_gems
+      @gem_paths = {}
+      base_required.replace new_requires
+      required.replace new_requires
       # HACK: Hardcoded YAML handling
-      new_requires.push 'psych' if new_requires.include?('yaml')
-      if new_requires.uniq.sort == required.uniq.sort && new_gemset == gemset && @source_gems.uniq.sort == source_gems.uniq.sort
-        false
-      else
-        required.clear
-        required.concat new_requires
-        @gemset = new_gemset
-        @source_gems = source_gems
-        process_requires
-        @rebindable_method_names = nil
-        @pin_class_hash = nil
-        @pin_select_cache = {}
-        true
-      end
+      required.add 'psych' if new_requires.include?('yaml')
+      @source_gems = new_source_gems
+      @directory = new_directory
+      process_requires
+      @rebindable_method_names = nil
+      @pin_class_hash = nil
+      @pin_select_cache = {}
+      true
     end
 
     # @return [Set<String>]
@@ -111,6 +95,11 @@ module Solargraph
       @yardocs ||= []
     end
 
+    # @return [Set<String>]
+    def required
+      @required ||= Set.new
+    end
+
     # @return [Array<String>]
     def unresolved_requires
       @unresolved_requires ||= []
@@ -163,6 +152,14 @@ module Solargraph
       @stdlib_pins ||= []
     end
 
+    def base_required
+      @base_required ||= Set.new
+    end
+
+    def directory
+      @directory ||= ''
+    end
+
     private
 
     # @return [YardMap::Cache]
@@ -193,6 +190,8 @@ module Solargraph
 
     # @return [void]
     def process_requires
+      @gemset = process_gemsets
+      required.merge @gemset.keys if required.include?('bundler/require')
       pins.replace core_pins
       unresolved_requires.clear
       stdlib_pins.clear
@@ -252,6 +251,11 @@ module Solargraph
       pins.concat environ.pins
     end
 
+    def process_gemsets
+      return {} if directory.empty? || !File.file?(File.join(directory, 'Gemfile'))
+      require_from_bundle(directory)
+    end
+
     # @param spec [Gem::Specification]
     # @return [void]
     def add_gem_dependencies spec
@@ -284,9 +288,6 @@ module Solargraph
     # @return [Array<Pin::Base>]
     def process_yardoc y, spec = nil
       return [] if y.nil?
-      size = Dir.glob(File.join(y, '**', '*'))
-        .map{ |f| File.size(f) }
-        .inject(:+)
       if spec
         ser = File.join(CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}.ser")
         if File.file?(ser)
@@ -295,19 +296,24 @@ module Solargraph
           dump = file.read
           file.close
           begin
-            return Marshal.load(dump)
+            result = Marshal.load(dump)
+            return result unless result.nil? || result.empty?
+            Solargraph.logger.warn "Empty cache for #{spec.name} #{spec.version}. Reloading"
           rescue StandardError => e
             Solargraph.logger.warn "Error loading pin cache: [#{e.class}] #{e.message}"
             File.unlink ser
           end
         end
       end
+      size = Dir.glob(File.join(y, '**', '*'))
+        .map{ |f| File.size(f) }
+        .inject(:+)
       if !size.nil? && size > 20_000_000
         Solargraph::Logging.logger.warn "Yardoc at #{y} is too large to process (#{size} bytes)"
         return []
       end
+      Solargraph.logger.info "Loading #{spec.name} #{spec.version} from #{y}"
       load_yardoc y
-      Solargraph.logger.info "Loading #{spec.name} #{spec.version} from yardoc"
       result = Mapper.new(YARD::Registry.all, spec).map
       if spec
         ser = File.join(CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}.ser")
@@ -431,5 +437,3 @@ module Solargraph
 end
 
 Solargraph::YardMap::CoreDocs.require_minimum
-# Change YARD log IO to avoid sending unexpected messages to STDOUT
-YARD::Logger.instance.io = File.new(File::NULL, 'w')

data/lib/solargraph/yard_map/core_fills.rb

@@ -82,6 +82,18 @@ module Solargraph
         Override.method_return('Class#allocate', 'self'),
         Override.method_return('Class.allocate', 'Class<Object>'),
 
+        Override.from_comment('Enumerable#detect', %(
+@overload detect(&block)
+  @return_single_parameter
+@overload detect()
+  @return [Enumerator]
+        )),
+        Override.from_comment('Enumerable#find', %(
+@overload find(&block)
+  @return_single_parameter
+@overload find()
+  @return [Enumerator]
+        )),
         Override.method_return('Enumerable#select', 'self'),
 
         Override.method_return('File.absolute_path', 'String'),
@@ -111,7 +123,12 @@ module Solargraph
 @param y [Numeric]
 @return [Numeric]
         )),
-        Override.method_return('Integer#times', 'Enumerator', delete: [:overload]),
+        Override.from_comment('Integer#times', %(
+@overload times(&block)
+  @return [Integer]
+@overload times()
+  @return [Enumerator]
+        )),
 
         Override.method_return('Kernel#puts', 'nil'),
 

data/lib/yard-solargraph.rb

@@ -2,6 +2,9 @@
 
 require 'yard'
 
+# Change YARD log IO to avoid sending unexpected messages to STDOUT
+YARD::Logger.instance.io = File.new(File::NULL, 'w')
+
 module Solargraph
   # A placeholder for the @!domain directive. It doesn't need to do anything
   # for yardocs. It's only used for Solargraph API maps.

data/solargraph.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.4'
 
-  s.add_runtime_dependency 'backport', '~> 1.1'
+  s.add_runtime_dependency 'backport', '~> 1.2'
   s.add_runtime_dependency 'benchmark'
   s.add_runtime_dependency 'bundler', '>= 1.17.2'
+  s.add_runtime_dependency 'diff-lcs', '~> 1.4'
   s.add_runtime_dependency 'e2mmap'
   s.add_runtime_dependency 'jaro_winkler', '~> 1.5'
   s.add_runtime_dependency 'kramdown', '~> 2.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.41.2
+  version: 0.42.4
 platform: ruby
 authors:
 - Fred Snyder
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: benchmark
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.2
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: e2mmap
   requirement: !ruby/object:Gem::Requirement
@@ -463,7 +477,6 @@ files:
 - lib/solargraph/pin/keyword.rb
 - lib/solargraph/pin/keyword_param.rb
 - lib/solargraph/pin/local_variable.rb
-- lib/solargraph/pin/localized.rb
 - lib/solargraph/pin/method.rb
 - lib/solargraph/pin/method_alias.rb
 - lib/solargraph/pin/namespace.rb
@@ -540,7 +553,7 @@ homepage: http://solargraph.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -555,8 +568,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Ruby language server
 test_files: []

data/lib/solargraph/pin/localized.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    module Localized
-      # @return [Range]
-      attr_reader :presence
-
-      # @param other [Pin::Base] The caller's block
-      # @param position [Position, Array(Integer, Integer)] The caller's position
-      # @return [Boolean]
-      def visible_from?(other, position)
-        position = Position.normalize(position)
-        other.filename == filename &&
-          match_tags(other.full_context.tag, full_context.tag) &&
-          (other == closure ||
-            (closure.location.range.contain?(other.location.range.start) && closure.location.range.contain?(other.location.range.ending))
-          ) &&
-          presence.contain?(position)
-      end
-
-      # @param other_loc [Location]
-      def visible_at?(other_loc)
-        return false if location.filename != other_loc.filename
-        presence.include?(other_loc.range.start)
-      end
-
-      private
-
-      # @param tag1 [String]
-      # @param tag2 [String]
-      # @return [Boolean]
-      def match_tags tag1, tag2
-        # @todo This is an unfortunate hack made necessary by a discrepancy in
-        #   how tags indicate the root namespace. The long-term solution is to
-        #   standardize it, whether it's `Class<>`, an empty string, or
-        #   something else.
-        tag1 == tag2 ||
-          (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
-      end
-    end
-  end
-end