solargraph 0.41.2 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4533d6cac061c01e292b70313f68a9de816c8af4ca6d34ddf7bde467d0428b0
-  data.tar.gz: 1fd4959f4e1652c8725fcc79f5da92df9f91a90eb5462879f87c30c0c8f2ada2
+  metadata.gz: ee62ce435bde441d527641ea98d3f448d36ce67f575f35d16927c315a98f1401
+  data.tar.gz: 514c7a0540e0bce8b050e9da507ed6d778b0ba482c5c73bef6ebc54360d93367
 SHA512:
-  metadata.gz: 48b7f57a7b84140cb4ff9b1f2428fb1dfe2c814ef9fca26585bec17ea61a122a8755ab60e8da52969942c5ab674501332f6fc0655fcceb77606f1ab353899a4b
-  data.tar.gz: cd817d200a9579e66f612a100b17096fb56eb468c356de4c75d7c5d0f5621f6e734596f9babe809398f26bd2bcc2226bf424215393fe03626adf03f856eb24b9
+  metadata.gz: fec2a060f92ba925c0911b41025033afb6821e0f5758de849c2722a03b9b102b97f437dad23097d442546e254f21ec407fdf3ca494ee311ce3d2f26396cc9e1d
+  data.tar.gz: 919ae0f90af0de75228cf2c42eb5ab22a9f9ef3af9c9f7003c4fdf746d0b2ee43375f006a08b926f4d5135facfd97f4cacd5df47e2a1862c3d17a96d4c11b004

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,11 @@
+## 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/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/bench.rb

@@ -9,23 +9,19 @@ module Solargraph
     # @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
@@ -107,9 +108,12 @@ 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']}"
+          end
         else
           logger.warn "Invalid message received."
           logger.debug request
@@ -165,8 +169,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 +674,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 +691,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 +820,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/library.rb

@@ -48,6 +48,8 @@ module Solargraph
       mutex.synchronize do
         if @current && @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 +254,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 +339,7 @@ module Solargraph
       return [] unless open?(filename)
       result = []
       source = read(filename)
+      catalog
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'
@@ -361,13 +375,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 +434,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 +445,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 +454,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
@@ -484,6 +519,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 +528,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/shell.rb

@@ -74,7 +74,11 @@ module Solargraph
     desc 'download-core [VERSION]', 'Download core documentation'
     def download_core version = nil
       ver = version || Solargraph::YardMap::CoreDocs.best_download
-      puts "Downloading docs for #{ver}..."
+      if RUBY_VERSION != ver
+        puts "Documentation for #{RUBY_VERSION} is not available. Reverting to closest match..."
+      else
+        puts "Downloading docs for #{ver}..."
+      end
       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'))

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.41.2'
+  VERSION = '0.42.0'
 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]

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 = 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,8 +152,16 @@ module Solargraph
       @stdlib_pins ||= []
     end
 
+    def base_required
+      @base_required ||= Set.new
+    end
+
     private
 
+    def directory
+      @directory ||= ''
+    end
+
     # @return [YardMap::Cache]
     def cache
       @cache ||= YardMap::Cache.new
@@ -193,6 +190,11 @@ module Solargraph
 
     # @return [void]
     def process_requires
+      @gemset = if required.include?('bundler/require')
+        require_from_bundle(directory)
+      else
+        {}
+      end
       pins.replace core_pins
       unresolved_requires.clear
       stdlib_pins.clear

data/solargraph.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'backport', '~> 1.1'
   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.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -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