solargraph 0.40.4 → 0.42.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eff7d664014ae6d25990957afb4328baafe88ff76ef892db8b3d50791860845e
-  data.tar.gz: 8038c884a63ce269f1a0faaf635e4c295fadd61c456ba2665c84a17b4f03a031
+  metadata.gz: 1099281670bd5cacd480624f66b36d7ce8fb6b69b4486f080d0c0d6436c0f36c
+  data.tar.gz: 4b1e028bc357204b953c31916845a7f12caefc07d733dc90cfb5bc142401f2d4
 SHA512:
-  metadata.gz: a7b95e2ba342b191642a1d5ea228243a60b9211f6c05cab2acf09ddcaab3efb25cef488ca910964e0ac1c32edacc2f0ced4eef09fa819b03d2919af4ac734ca7
-  data.tar.gz: 6990c07591d43fdb583484c00fc5221d228850fa75e12b5cd2632413a21c1984f634ce2655371d9be7016a035e23fe622469418779bf3285f03a087a38c394ae
+  metadata.gz: 771c40ddff0a11757d1e9c4487802afc9f5b992840383f525643957d92516e735dc7328a8d23ed1ff4f0e55ceb09e3792eb24818758e4b217927bf4ba9708b5a
+  data.tar.gz: 948101863fc7f3f167dee00139f07ccdf5711afd12125aa2a18b708ed4ba6edaffbc7ba0c1a7a7dd09ad51460a0827546841cf2dbcd223198247fd86d8b0841b

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,35 @@
+## 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
+
+## 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

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,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.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

@@ -17,7 +17,6 @@ module Solargraph
     autoload :BundlerMethods, 'solargraph/api_map/bundler_methods'
 
     include SourceToYard
-    include BundlerMethods
 
     # @return [Array<String>]
     attr_reader :unresolved_requires
@@ -33,7 +32,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 +46,39 @@ 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
-      pins = []
-      reqs = Set.new
-      # @param map [SourceMap]
-      new_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
-      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
-        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
+      @source_map_hash = bench.source_maps.map { |s| [s.filename, s] }.to_h
+      pins = bench.source_maps.map(&:pins).flatten
+      external_requires = bench.external_requires
+      source_map_hash.each_value do |map|
+        implicit.merge map.environ
+      end
+      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
-      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
@@ -142,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]
@@ -173,7 +114,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
 
@@ -490,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
@@ -531,20 +454,26 @@ module Solargraph
       @yard_map ||= YardMap.new
     end
 
-    private
-
-    # @return [Array<String>]
-    def workspace_filenames
-      @workspace_filenames ||= []
+    # 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
+
     # A hash of source maps with filename keys.
     #
     # @return [Hash{String => SourceMap}]
     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/bench.rb

@@ -1,30 +1,27 @@
 # 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 [Set<SourceMap>]
+    attr_reader :source_maps
+
     # @return [Workspace]
     attr_reader :workspace
 
-    # @return [Array<Source>]
-    attr_reader :opened
-
-    # @return [Array<Pin::Base>]
-    attr_reader :pins
+    # @return [Set<String>]
+    attr_reader :external_requires
 
+    # @param source_maps [Array<SourceMap>, Set<SourceMap>]
     # @param workspace [Workspace]
-    # @param opened [Array<Source>]
-    def initialize workspace: Workspace.new, opened: [], pins: []
+    # @param external_requires [Array<String>, Set<String>]
+    def initialize source_maps: [], workspace: Workspace.new, external_requires: []
+      @source_maps = source_maps.to_set
       @workspace = workspace
-      @opened = opened
-      @pins = pins
-    end
-
-    # @return [Array<Source>]
-    def sources
-      @sources ||= (opened + workspace.sources).uniq(&:filename)
+      @external_requires = external_requires.to_set
     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