solargraph 0.40.2 → 0.41.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70d201ad10b41bf9e0322370c2de7fa8c0efa25d8746b5b7cb3d1adc81902721
-  data.tar.gz: 7547665a359af045b4c9d1a0991d4dec4b37c621e7baf15b20656228ce69fa1f
+  metadata.gz: e4533d6cac061c01e292b70313f68a9de816c8af4ca6d34ddf7bde467d0428b0
+  data.tar.gz: 1fd4959f4e1652c8725fcc79f5da92df9f91a90eb5462879f87c30c0c8f2ada2
 SHA512:
-  metadata.gz: 4f79d086cf827d4bfa0a1c24c002a7487e742a0de65e5094126c9cb0dd12ca43aa08ec7e62debf074577adf81b8cd0d7e8916ee90676a3d2a5f0e8bfa6e9296c
-  data.tar.gz: 15afa63bb7bf32dfa51dff97432c8a8070d6521a364097b4f399e5a5962b25f9d86d336e26aad3810c66de01ba5ec273224030628d56b6640db60f10501cc578
+  metadata.gz: 48b7f57a7b84140cb4ff9b1f2428fb1dfe2c814ef9fca26585bec17ea61a122a8755ab60e8da52969942c5ab674501332f6fc0655fcceb77606f1ab353899a4b
+  data.tar.gz: cd817d200a9579e66f612a100b17096fb56eb468c356de4c75d7c5d0f5621f6e734596f9babe809398f26bd2bcc2226bf424215393fe03626adf03f856eb24b9

data/CHANGELOG.md

@@ -1,3 +1,35 @@
+## 0.41.2 - June 9, 2021
+- Rescue InvalidOffset in async diagnosis
+- Remove erroneous escaping from Hover
+
+## 0.41.1 - May 31, 2021
+- ApiMap handles required bundles (#443)
+
+## 0.41.0 - May 30, 2021
+- Chain constant at last double colon with more than two nested namespaces
+- Fill Integer#times return type (#440)
+- Validate included modules in type checks (#424)
+- Faster language server initialization
+  - Server response to initialize is near immediate
+  - Workspace is mapped in a background thread
+  - Supported clients report mapping progress
+- Log RuboCop corrections at info level (#426)
+- Allow configuring the version of RuboCop to require (#430)
+- Fix source of diagnostic (#434)
+- Fix file argument in RuboCop (#435)
+- Config ignores directories with .rb extension (#423)
+
+## 0.40.4 - March 3, 2021
+- Fix optarg and blockarg ordering
+- Override specialization for #initialize
+- Find definitions with cursor after double colon
+
+## 0.40.3 - February 7, 2021
+- Simplify and allow to configure rubocop formatter (#403)
+- Type checker shows tag in param type errors (#398)
+- Handle bare private_constant (#408)
+- Type checker handles splatted variables (#396)
+
 ## 0.40.2 - January 18, 2021
 - Type checker ignores splatted calls in arity (#396)
 - Allow Parser 3.0 (#400)

data/README.md

@@ -79,6 +79,21 @@ Run `bundle install` and use `bundle exec yard gems` to generate the documentati
 
 In order to make sure you're using the correct dependencies, you can start the language server with Bundler. In VS Code, there's a `solargraph.useBundler` option. Other clients will vary, but the command you probably want to run is `bundle exec solargraph socket` or `bundle exec solargraph stdio`.
 
+### Rubocop Version
+
+If you have multiple versions of [`rubocop`](https://rubygems.org/gems/rubocop) installed and you would like to choose a version other than the latest to use, this specific version can be configured.
+
+In `.solargraph.yml`:
+
+```yaml
+---
+reporters:
+- rubocop:version=0.61.0  # diagnostics
+formatter:
+  rubocop:
+    version: 0.61.0       # formatting
+```
+
 ### Integrating Other Editors
 
 The [language server protocol](https://microsoft.github.io/language-server-protocol/specification) is the recommended way for integrating Solargraph into editors and IDEs. Clients can connect using either stdio or TCP. Language client developers should refer to [https://solargraph.org/guides/language-server](https://solargraph.org/guides/language-server).

data/SPONSORS.md

@@ -13,3 +13,4 @@ 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,7 +1,7 @@
 Layout/EndOfLine:
   EnforcedStyle: lf
-# Style/MethodDefParentheses:
-#   Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Layout/SpaceAroundMethodCallOperator:

data/lib/solargraph.rb

@@ -9,13 +9,14 @@ require 'solargraph/version'
 # static analysis, and language server libraries.
 #
 module Solargraph
-  class InvalidOffsetError <      RangeError;    end
-  class DiagnosticsError <        RuntimeError;  end
-  class FileNotFoundError <       RuntimeError;  end
-  class SourceNotAvailableError < StandardError; end
-  class ComplexTypeError        < StandardError; end
-  class WorkspaceTooLargeError <  RuntimeError;  end
-  class BundleNotFoundError <     StandardError; end
+  class InvalidOffsetError         < RangeError;    end
+  class DiagnosticsError           < RuntimeError;  end
+  class FileNotFoundError          < RuntimeError;  end
+  class SourceNotAvailableError    < StandardError; end
+  class ComplexTypeError           < StandardError; end
+  class WorkspaceTooLargeError     < RuntimeError;  end
+  class BundleNotFoundError        < StandardError; end
+  class InvalidRubocopVersionError < RuntimeError;  end
 
   autoload :Position,         'solargraph/position'
   autoload :Range,            'solargraph/range'

data/lib/solargraph/api_map.rb

@@ -33,7 +33,12 @@ module Solargraph
     # @param pins [Array<Pin::Base>]
     # @return [self]
     def index pins
-      catalog Bench.new(pins: pins)
+      # @todo This implementation is incomplete. It should probably create a
+      #   Bench.
+      @source_map_hash = {}
+      implicit.clear
+      cache.clear
+      @store = Store.new(yard_map.pins + pins)
       self
     end
 
@@ -42,97 +47,55 @@ module Solargraph
     # @param source [Source]
     # @return [self]
     def map source
-      catalog Bench.new(opened: [source])
+      map = Solargraph::SourceMap.map(source)
+      catalog Bench.new(source_maps: [map])
       self
     end
 
-    # @param name [String]
-    # @return [YARD::Tags::MacroDirective, nil]
-    def named_macro name
-      store.named_macros[name]
-    end
-
     # Catalog a bench.
     #
     # @param bench [Bench]
-    # @return [self]
     def catalog bench
-      new_map_hash = {}
-      # Bench always needs to be merged if it adds or removes sources
-      merged = (bench.sources.length == source_map_hash.values.length)
-      bench.sources.each do |source|
-        if source_map_hash.key?(source.filename)
-          if source_map_hash[source.filename].code == source.code &&
-             source_map_hash[source.filename].source.synchronized? &&
-             source.synchronized?
-            new_map_hash[source.filename] = source_map_hash[source.filename]
-          elsif !source.synchronized?
-            new_map_hash[source.filename] = source_map_hash[source.filename]
-            # @todo Smelly instance variable access
-            new_map_hash[source.filename].instance_variable_set(:@source, source)
-          else
-            map = Solargraph::SourceMap.map(source)
-            if source_map_hash[source.filename].try_merge!(map)
-              new_map_hash[source.filename] = source_map_hash[source.filename]
-            else
-              new_map_hash[source.filename] = map
-              merged = false
-            end
-          end
-        else
-          map = Solargraph::SourceMap.map(source)
-          new_map_hash[source.filename] = map
-          merged = false
-        end
-      end
-      return self if bench.pins.empty? && @store && merged
       implicit.clear
+      @cache.clear
+      @source_map_hash = bench.source_maps.map { |s| [s.filename, s] }.to_h
       pins = []
-      reqs = Set.new
-      # @param map [SourceMap]
-      new_map_hash.each_value do |map|
+      @required = Set.new
+      local_path_hash.clear
+      source_map_hash.each_value do |map|
         pins.concat map.pins
-        reqs.merge map.requires.map(&:name)
-      end
-      pins.concat bench.pins
-      reqs.merge bench.workspace.config.required
-      @required = reqs
-      bench.sources.each do |src|
-        implicit.merge new_map_hash[src.filename].environ
+        @required.merge map.requires.map(&:name)
+        implicit.merge map.environ
       end
-      # implicit.merge Convention.for_global(self)
-      local_path_hash.clear
-      unless bench.workspace.require_paths.empty?
-        file_keys = new_map_hash.keys
-        workspace_path = Pathname.new(bench.workspace.directory)
-        reqs.delete_if do |r|
-          bench.workspace.require_paths.any? do |base|
-            pn = workspace_path.join(base, "#{r}.rb").to_s
-            if file_keys.include? pn
-              local_path_hash[r] = pn
-              true
-            else
-              false
-            end
-          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
-      reqs.merge implicit.requires
-      br = reqs.include?('bundler/require') ? require_from_bundle(bench.workspace.directory) : {}
-      reqs.merge br.keys
-      yard_map.change(reqs.to_a, br, bench.workspace.gemnames)
-      new_store = Store.new(yard_map.pins + implicit.pins + pins)
-      @cache.clear
-      @source_map_hash = new_map_hash
-      @store = new_store
+      br = @required.include?('bundler/require') ? require_from_bundle(bench.directory) : {}
+      @required.merge br.keys
+      yard_map.change(external_requires, br, bench.gemnames)
+      @store = Store.new(yard_map.pins + implicit.pins + pins)
       @unresolved_requires = yard_map.unresolved_requires
-      workspace_filenames.clear
-      workspace_filenames.concat bench.workspace.filenames
       @rebindable_method_names = nil
       store.block_pins.each { |blk| blk.rebind(self) }
       self
     end
 
+    # @param name [String]
+    # @return [YARD::Tags::MacroDirective, nil]
+    def named_macro name
+      store.named_macros[name]
+    end
+
     def required
       @required ||= Set.new
     end
@@ -173,7 +136,10 @@ module Solargraph
     def self.load directory
       api_map = new
       workspace = Solargraph::Workspace.new(directory)
-      api_map.catalog Bench.new(workspace: workspace)
+      # api_map.catalog Bench.new(workspace: workspace)
+      library = Library.new(workspace)
+      library.map!
+      api_map.catalog library.bench
       api_map
     end
 
@@ -531,6 +497,15 @@ module Solargraph
       @yard_map ||= YardMap.new
     end
 
+    # Check if the host class includes the specified module.
+    #
+    # @param host [String] The class
+    # @param mod [String] The module
+    # @return [Boolean]
+    def type_include?(host, mod)
+      store.get_includes(host).include?(mod)
+    end
+
     private
 
     # @return [Array<String>]
@@ -544,7 +519,9 @@ module Solargraph
     attr_reader :source_map_hash
 
     # @return [ApiMap::Store]
-    attr_reader :store
+    def store
+      @store ||= Store.new
+    end
 
     # @return [Solargraph::ApiMap::Cache]
     attr_reader :cache

data/lib/solargraph/api_map/store.rb

@@ -238,11 +238,16 @@ module Solargraph
         pins_by_class(Pin::Reference::Override).each do |ovr|
           pin = get_path_pins(ovr.name).first
           next if pin.nil?
+          new_pin = if pin.path.end_with?('#initialize')
+            get_path_pins(pin.path.sub(/#initialize/, '.new')).first
+          end
           (ovr.tags.map(&:tag_name) + ovr.delete).uniq.each do |tag|
             pin.docstring.delete_tags tag.to_sym
+            new_pin.docstring.delete_tags tag.to_sym if new_pin
           end
           ovr.tags.each do |tag|
             pin.docstring.add_tag(tag)
+            new_pin.docstring.add_tag(tag) if new_pin
           end
         end
       end

data/lib/solargraph/bench.rb

@@ -1,30 +1,31 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Solargraph
-  # An aggregation of a workspace and additional sources to be cataloged in an
-  # ApiMap.
+  # A container of source maps and gem specs to be cataloged in an ApiMap.
   #
   class Bench
-    # @return [Workspace]
-    attr_reader :workspace
+    # @return [Set<SourceMap>]
+    attr_reader :source_maps
 
-    # @return [Array<Source>]
-    attr_reader :opened
+    # @return [Set<String>]
+    attr_reader :load_paths
 
-    # @return [Array<Pin::Base>]
-    attr_reader :pins
+    # @return [Set<String>]
+    attr_reader :gemnames
 
-    # @param workspace [Workspace]
-    # @param opened [Array<Source>]
-    def initialize workspace: Workspace.new, opened: [], pins: []
-      @workspace = workspace
-      @opened = opened
-      @pins = pins
-    end
+    # @return [String]
+    attr_reader :directory
 
-    # @return [Array<Source>]
-    def sources
-      @sources ||= (opened + workspace.sources).uniq(&:filename)
+    # @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: ''
+      @source_maps = source_maps.to_set
+      @load_paths = load_paths.to_set
+      @gemnames = gemnames.to_set
+      @directory = directory
     end
   end
 end

data/lib/solargraph/compat.rb

@@ -1,9 +1,23 @@
+unless Hash.method_defined?(:transform_keys)
+  class Hash
+    def transform_keys &block
+      result = {}
+      each_pair do |k, v|
+        result[block.call(k)] = v
+      end
+      result
+    end
+  end
+end
+
 unless Hash.method_defined?(:transform_values)
   class Hash
     def transform_values &block
+      result = {}
       each_pair do |k, v|
-        self[k] = block.call(v)
+        result[k] = block.call(v)
       end
+      result
     end
   end
 end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rubocop'
 require 'stringio'
 
 module Solargraph
@@ -23,6 +22,7 @@ module Solargraph
       # @param _api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, _api_map
+        require_rubocop(rubocop_version)
         options, paths = generate_options(source.filename, source.code)
         store = RuboCop::ConfigStore.new
         runner = RuboCop::Runner.new(options, store)
@@ -36,6 +36,13 @@ module Solargraph
 
       private
 
+      # Extracts the rubocop version from _args_
+      #
+      # @return [String]
+      def rubocop_version
+        args.find { |a| a =~ /version=/ }.to_s.split('=').last
+      end
+
       # @param resp [Hash]
       # @return [Array<Hash>]
       def make_array resp
@@ -57,7 +64,8 @@ module Solargraph
           range: offense_range(off).to_hash,
           # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
           severity: SEVERITIES[off['severity']],
-          source: off['cop_name'],
+          source: 'rubocop',
+          code: off['cop_name'],
           message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
         }
       end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -7,38 +7,37 @@ module Solargraph
     module RubocopHelpers
       module_function
 
+      # Requires a specific version of rubocop, or the latest installed version
+      # if _version_ is `nil`.
+      #
+      # @param version [String]
+      # @raise [InvalidRubocopVersionError] if _version_ is not installed
+      def require_rubocop(version = nil)
+        begin
+          gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
+          gem_lib_path = File.join(gem_path, 'lib')
+          $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
+        rescue Gem::MissingSpecVersionError => e
+          raise InvalidRubocopVersionError,
+                "could not find '#{e.name}' (#{e.requirement}) - "\
+                "did find: [#{e.specs.map { |s| s.version.version }.join(', ')}]"
+        end
+        require 'rubocop'
+      end
+
       # Generate command-line options for the specified filename and code.
       #
       # @param filename [String]
       # @param code [String]
       # @return [Array(Array<String>, Array<String>)]
       def generate_options filename, code
-        args = ['-f', 'j']
-        rubocop_file = find_rubocop_file(filename)
-        args.push('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
-        args.push filename
+        args = ['-f', 'j', filename]
         base_options = RuboCop::Options.new
         options, paths = base_options.parse(args)
         options[:stdin] = code
         [options, paths]
       end
 
-      # Find a RuboCop configuration file in a file's directory tree.
-      #
-      # @param filename [String]
-      # @return [String, nil]
-      def find_rubocop_file filename
-        return nil unless File.exist?(filename)
-        filename = File.realpath(filename)
-        dir = File.dirname(filename)
-        until File.dirname(dir) == dir
-          here = File.join(dir, '.rubocop.yml')
-          return here if File.exist?(here)
-          dir = File.dirname(dir)
-        end
-        nil
-      end
-
       # RuboCop internally uses capitalized drive letters for Windows paths,
       # so we need to convert the paths provided to the command.
       #