solargraph 0.44.3 → 0.49.0

data/lib/solargraph/convention/rspec.rb

@@ -8,14 +8,23 @@ module Solargraph
         @environ ||= Environ.new(
           requires: ['rspec'],
           domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
-          # This override is necessary due to an erroneous @return tag in
-          # rspec's YARD documentation.
-          # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
           pins: [
+            # This override is necessary due to an erroneous @return tag in
+            # rspec's YARD documentation.
+            # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
             Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
-          ]
+          ].concat(extras)
         )
       end
+
+      private
+
+      def extras
+        @@extras ||= SourceMap.load_string(%(
+          def describe(*args); end
+          def it(*args); end
+        )).pins
+      end
     end
   end
 end

data/lib/solargraph/convention.rb

@@ -11,6 +11,7 @@ module Solargraph
     autoload :Gemfile, 'solargraph/convention/gemfile'
     autoload :Rspec,   'solargraph/convention/rspec'
     autoload :Gemspec, 'solargraph/convention/gemspec'
+    autoload :Rakefile, 'solargraph/convention/rakefile'
 
     @@conventions = Set.new
 
@@ -43,5 +44,6 @@ module Solargraph
     register Gemfile
     register Gemspec
     register Rspec
+    register Rakefile
   end
 end

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -12,6 +12,10 @@ module Solargraph
         refs = {}
         map = api_map.source_map(source.filename)
         map.requires.each { |ref| refs[ref.name] = ref }
+        api_map.missing_docs.each do |r|
+          next unless refs.key?(r)
+          result.push docs_error(r, refs[r].location)
+        end
         api_map.unresolved_requires.each do |r|
           next unless refs.key?(r)
           result.push require_error(r, refs[r].location)
@@ -21,6 +25,18 @@ module Solargraph
 
       private
 
+      # @param path [String]
+      # @param location [Location]
+      # @return [Hash]
+      def docs_error path, location
+        {
+          range: location.range.to_hash,
+          severity: Diagnostics::Severities::WARNING,
+          source: 'RequireNotFound',
+          message: "YARD docs not found for #{path}"
+        }
+      end
+
       # @param path [String]
       # @param location [Location]
       # @return [Hash]

data/lib/solargraph/diagnostics/rubocop.rb

@@ -11,6 +11,7 @@ module Solargraph
 
       # Conversion of RuboCop severity names to LSP constants
       SEVERITIES = {
+        'info' => Severities::HINT,
         'refactor' => Severities::HINT,
         'convention' => Severities::INFORMATION,
         'warning' => Severities::WARNING,
@@ -22,16 +23,20 @@ module Solargraph
       # @param _api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, _api_map
+        @source = source
         require_rubocop(rubocop_version)
         options, paths = generate_options(source.filename, source.code)
         store = RuboCop::ConfigStore.new
         runner = RuboCop::Runner.new(options, store)
         result = redirect_stdout{ runner.run(paths) }
+        
+        return [] if result.empty?
+        
         make_array JSON.parse(result)
       rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
         raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
-      rescue JSON::ParserError
-        raise DiagnosticsError, 'RuboCop returned invalid data'
+      rescue JSON::ParserError => e
+        raise DiagnosticsError, "RuboCop returned invalid data: #{e.message}"
       end
 
       private
@@ -88,8 +93,17 @@ module Solargraph
         if off['location']['start_line'] != off['location']['last_line']
           Position.new(off['location']['start_line'], 0)
         else
+          start_line = off['location']['start_line'] - 1
+          last_column = off['location']['last_column']
+          line = @source.code.lines[start_line]
+          col_off = if line.nil? || line.empty?
+            1
+          else
+            0
+          end
+
           Position.new(
-            off['location']['start_line'] - 1, off['location']['last_column']
+            start_line, last_column - col_off
           )
         end
       end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -10,13 +10,15 @@ module Solargraph
       # Requires a specific version of rubocop, or the latest installed version
       # if _version_ is `nil`.
       #
-      # @param version [String]
+      # @param version [String, nil]
       # @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)
+        # @todo Gem::MissingSpecVersionError is undocumented for some reason
+        # @sg-ignore
         rescue Gem::MissingSpecVersionError => e
           raise InvalidRubocopVersionError,
                 "could not find '#{e.name}' (#{e.requirement}) - "\

data/lib/solargraph/language_server/host.rb

@@ -130,35 +130,39 @@ module Solargraph
         end
       end
 
-      # Respond to a notification that a file was created in the workspace.
-      # The libraries will determine whether the file should be merged; see
+      # Respond to a notification that files were created in the workspace.
+      # The libraries will determine whether the files should be merged; see
       # Solargraph::Library#create_from_disk.
       #
-      # @param uri [String] The file uri.
-      # @return [Boolean] True if a library accepted the file.
-      def create uri
-        filename = uri_to_file(uri)
+      # @param uris [Array<String>] The URIs of the files.
+      # @return [Boolean] True if at least one library accepted at least one file.
+      def create *uris
+        filenames = uris.map { |uri| uri_to_file(uri) }
         result = false
         libraries.each do |lib|
-          result = true if lib.create_from_disk(filename)
+          result = true if lib.create_from_disk(*filenames)
+        end
+        uris.each do |uri|
+          diagnoser.schedule uri if open?(uri)
         end
-        diagnoser.schedule uri if open?(uri)
         result
       end
 
-      # Delete the specified file from the library.
+      # Delete the specified files from the library.
       #
-      # @param uri [String] The file uri.
+      # @param uris [Array<String>] The file uris.
       # @return [void]
-      def delete uri
-        filename = uri_to_file(uri)
+      def delete *uris
+        filenames = uris.map { |uri| uri_to_file(uri) }
         libraries.each do |lib|
-          lib.delete(filename)
+          lib.delete(*filenames)
+        end
+        uris.each do |uri|
+          send_notification "textDocument/publishDiagnostics", {
+            uri: uri,
+            diagnostics: []
+          }
         end
-        send_notification "textDocument/publishDiagnostics", {
-          uri: uri,
-          diagnostics: []
-        }
       end
 
       # Open the specified file in the library.
@@ -692,7 +696,7 @@ module Solargraph
         params['contentChanges'].each do |recvd|
           chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
-            (chng['range'].nil? ? 
+            (chng['range'].nil? ?
               nil :
               Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
             ),

data/lib/solargraph/language_server/message/extended/download_core.rb

@@ -10,11 +10,7 @@ module Solargraph
         #
         class DownloadCore < Base
           def process
-            ver = Solargraph::YardMap::CoreDocs.best_download
-            Solargraph::YardMap::CoreDocs.download ver
-            host.show_message "Downloaded documentation for Ruby #{ver}.", LanguageServer::MessageTypes::INFO
-          rescue StandardError => e
-            host.show_message "An error occurred while downloading documentation: [#{e.class}] #{e.message}", LanguageServer::MessageTypes::ERROR
+            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
           end
         end
       end

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

@@ -25,6 +25,8 @@ module Solargraph
               }
             }
           }
+          # FIXME: lsp default is utf-16, may have different position
+          result[:capabilities][:positionEncoding] = "utf-32" if params.dig("capabilities", "general", "positionEncodings")&.include?("utf-32")
           result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
           result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
           # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -54,7 +54,7 @@ module Solargraph
           def cli_args file_uri, config
             file = UriHelpers.uri_to_file(file_uri)
             args = [
-              config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
+              config['cops'] == 'all' ? '--autocorrect-all' : '--autocorrect',
               '--cache', 'false',
               '--format', formatter_class(config).name,
             ]

data/lib/solargraph/language_server/message/text_document/hover.rb

@@ -27,16 +27,28 @@ module Solargraph
               last_link = this_link unless this_link.nil?
             end
             set_result(
-              contents: {
-                kind: 'markdown',
-                value: contents.join("\n\n")
-              }
+              contents_or_nil(contents)
             )
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
             Logging.logger.warn e.backtrace.join("\n")
             set_result nil
           end
+
+          private
+
+          def contents_or_nil contents
+            stripped = contents
+              .map(&:strip)
+              .reject { |c| c.empty? }
+            return nil if stripped.empty?
+            {
+              contents: {
+                kind: 'markdown',
+                value: stripped.join("\n\n")
+              }
+            }
+          end
         end
       end
     end

data/lib/solargraph/language_server/message/text_document/signature_help.rb

@@ -9,13 +9,8 @@ module Solargraph
             line = params['position']['line']
             col = params['position']['character']
             suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
-            info = []
-            suggestions.each do |pin|
-              info.concat pin.overloads.map(&:signature_help)
-              info.push pin.signature_help
-            end
             set_result({
-              signatures: info
+              signatures: suggestions.flat_map { |pin| pin.signature_help }
             })
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"

data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb

@@ -10,22 +10,29 @@ module Solargraph::LanguageServer::Message::Workspace
 
     def process
       need_catalog = false
+      to_create = []
+      to_delete = []
+
       # @param change [Hash]
       params['changes'].each do |change|
         if change['type'] == CREATED
-          host.create change['uri']
+          to_create << change['uri']
           need_catalog = true
         elsif change['type'] == CHANGED
           next if host.open?(change['uri'])
-          host.create change['uri']
+          to_create << change['uri']
           need_catalog = true
         elsif change['type'] == DELETED
-          host.delete change['uri']
+          to_delete << change['uri']
           need_catalog = true
         else
           set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS, "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
         end
       end
+
+      host.create *to_create
+      host.delete *to_delete
+
       # Force host to catalog libraries after file changes (see castwide/solargraph#139)
       host.catalog if need_catalog
     end

data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb

@@ -8,7 +8,7 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
     info = pins.map do |pin|
       uri = file_to_uri(pin.location.filename)
       {
-        name: pin.name,
+        name: pin.path,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {

data/lib/solargraph/language_server/uri_helpers.rb

@@ -14,7 +14,7 @@ module Solargraph
       # @param uri [String]
       # @return [String]
       def uri_to_file uri
-        decode(uri).sub(/^file\:\/\//, '').sub(/^\/([a-z]\:)/i, '\1')
+        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
       end
 
       # Convert a file path to a URI.

data/lib/solargraph/library.rb

@@ -106,36 +106,37 @@ module Solargraph
       result
     end
 
-    # Create a file source from a file on disk. The file is ignored if it is
+    # Create file sources from files on disk. A file is ignored if it is
     # neither open in the library nor included in the workspace.
     #
-    # @param filename [String]
-    # @return [Boolean] True if the file was added to the workspace.
-    def create_from_disk filename
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if at least one file was added to the workspace.
+    def create_from_disk *filenames
       result = false
       mutex.synchronize do
-        next if File.directory?(filename) || !File.exist?(filename)
-        next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
-        source = Solargraph::Source.load_string(File.read(filename), filename)
-        workspace.merge(source)
-        maybe_map source
-        result = true
+        sources = filenames
+          .reject { |filename| File.directory?(filename) || !File.exist?(filename) }
+          .map { |filename| Solargraph::Source.load_string(File.read(filename), filename) }
+        result = workspace.merge(*sources)
+        sources.each { |source| maybe_map source }
       end
       result
     end
 
-    # Delete a file from the library. Deleting a file will make it unavailable
+    # Delete files from the library. Deleting a file will make it unavailable
     # for checkout and optionally remove it from the workspace unless the
     # workspace configuration determines that it should still exist.
     #
-    # @param filename [String]
-    # @return [Boolean] True if the file was deleted
-    def delete filename
-      detach filename
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if any file was deleted
+    def delete *filenames
       result = false
-      mutex.synchronize do
-        result = workspace.remove(filename)
-        @synchronized = !result if synchronized?
+      filenames.each do |filename|
+        detach filename
+        mutex.synchronize do
+          result ||= workspace.remove(filename)
+          @synchronized = !result if synchronized?
+        end
       end
       result
     end
@@ -267,7 +268,7 @@ module Solargraph
         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)
+      # api_map.yard_map.require_reference(pin.name)
     rescue FileNotFoundError
       nil
     end
@@ -522,7 +523,7 @@ module Solargraph
       return unless source
       return unless @current == source || workspace.has_file?(source.filename)
       if source_map_hash.key?(source.filename)
-        return if source_map_hash[source.filename].code == source.code && 
+        return if source_map_hash[source.filename].code == source.code &&
           source_map_hash[source.filename].source.synchronized? &&
           source.synchronized?
         if source.synchronized?

data/lib/solargraph/parser/legacy/class_methods.rb

@@ -115,16 +115,11 @@ module Solargraph
           result = []
           if node.type == :str
             result.push Range.from_node(node)
-          elsif node.type == :dstr
-            here = Range.from_node(node)
-            there = Range.from_node(node.children[1])
-            result.push Range.new(here.start, there.start)
           end
           node.children.each do |child|
             result.concat string_ranges(child)
           end
           if node.type == :dstr && node.children.last.nil?
-            # result.push Range.new(result.last.ending, result.last.ending)
             last = node.children[-2]
             unless last.nil?
               rng = Range.from_node(last)

data/lib/solargraph/parser/legacy/node_processors/casgn_node.rb

@@ -8,16 +8,26 @@ module Solargraph
           include Legacy::NodeMethods
 
           def process
-            here = get_node_start_position(node)
             pins.push Solargraph::Pin::Constant.new(
               location: get_node_location(node),
               closure: region.closure,
-              name: node.children[1].to_s,
+              name: const_name,
               comments: comments_for(node),
               assignment: node.children[2]
             )
             process_children
           end
+
+          private
+
+          # @return [String]
+          def const_name
+            if node.children[0]
+              Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
+            else
+              node.children[1].to_s
+            end
+          end
         end
       end
     end

data/lib/solargraph/parser/legacy/node_processors/sclass_node.rb

@@ -6,11 +6,32 @@ module Solargraph
       module NodeProcessors
         class SclassNode < Parser::NodeProcessor::Base
           def process
-            # @todo Temporarily skipping remote metaclasses
-            return unless node.children[0].is_a?(AST::Node) && node.children[0].type == :self
+            sclass = node.children[0]
+            if sclass.is_a?(AST::Node) && sclass.type == :self
+              closure = region.closure
+            elsif sclass.is_a?(AST::Node) && sclass.type == :casgn
+              names = [region.closure.namespace, region.closure.name]
+              if sclass.children[0].nil? && names.last != sclass.children[1].to_s
+                names << sclass.children[1].to_s
+              else
+                names.concat [NodeMethods.unpack_name(sclass.children[0]), sclass.children[1].to_s]
+              end
+              name = names.reject(&:empty?).join('::')
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+            elsif sclass.is_a?(AST::Node) && sclass.type == :const
+              names = [region.closure.namespace, region.closure.name]
+              also = NodeMethods.unpack_name(sclass)
+              if also != region.closure.name
+                names << also
+              end
+              name = names.reject(&:empty?).join('::')
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+            else
+              return
+            end
             pins.push Solargraph::Pin::Singleton.new(
               location: get_node_location(node),
-              closure: region.closure
+              closure: closure
             )
             process_children region.update(visibility: :public, scope: :class, closure: pins.last)
           end

data/lib/solargraph/parser/rubyvm/class_methods.rb

@@ -1,4 +1,5 @@
 require 'solargraph/parser/rubyvm/node_processors'
+require 'solargraph/parser/rubyvm/node_wrapper'
 
 module Solargraph
   module Parser
@@ -7,8 +8,10 @@ module Solargraph
         # @param code [String]
         # @param filename [String]
         # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
+        # @sg-ignore
         def parse_with_comments code, filename = nil
           node = RubyVM::AbstractSyntaxTree.parse(code).children[2]
+          node &&= RubyVM::AbstractSyntaxTree::NodeWrapper.from(node, code.lines)
           comments = CommentRipper.new(code).parse
           [node, comments]
         rescue ::SyntaxError => e
@@ -19,8 +22,10 @@ module Solargraph
         # @param filename [String, nil]
         # @param line [Integer]
         # @return [Parser::AST::Node]
+        # @sg-ignore
         def parse code, filename = nil, line = 0
-          RubyVM::AbstractSyntaxTree.parse(code).children[2]
+          node = RubyVM::AbstractSyntaxTree.parse(code).children[2]
+          node and RubyVM::AbstractSyntaxTree::NodeWrapper.from(node, code.lines)
         rescue ::SyntaxError => e
           raise Parser::SyntaxError, e.message
         end
@@ -87,7 +92,7 @@ module Solargraph
         end
 
         def infer_literal_node_type node
-          # NodeMethods.infer_literal_node_type node
+          NodeMethods.infer_literal_node_type node
         end
 
         def version
@@ -123,13 +128,12 @@ module Solargraph
           elsif node.type == :DSTR
             here = Range.from_node(node)
             there = Range.from_node(node.children[1])
-            result.push Range.new(here.start, there.start)
+            result.push Range.new(here.start, there&.start || here.ending)
           end
           node.children.each do |child|
             result.concat string_ranges(child)
           end
           if node.type == :DSTR && node.children.last.nil?
-            # result.push Range.new(result.last.ending, result.last.ending)
             last = node.children[-2]
             unless last.nil?
               rng = Range.from_node(last)

data/lib/solargraph/parser/rubyvm/node_processors/casgn_node.rb

@@ -9,12 +9,23 @@ module Solargraph
             pins.push Solargraph::Pin::Constant.new(
               location: get_node_location(node),
               closure: region.closure,
-              name: node.children[0].to_s,
+              name: const_name,
               comments: comments_for(node),
-              assignment: node.children[1]
+              assignment: node.children[2] || node.children[1]
             )
             process_children
           end
+
+          private
+
+          # @return [String]
+          def const_name
+            if Parser.is_ast_node?(node.children[0])
+              Parser::NodeMethods.unpack_name(node.children[0])
+            else
+              node.children[0].to_s
+            end
+          end
         end
       end
     end

data/lib/solargraph/parser/rubyvm/node_processors/def_node.rb

@@ -6,7 +6,8 @@ module Solargraph
       module NodeProcessors
         class DefNode < Parser::NodeProcessor::Base
           def process
-            loc = get_node_location(node)
+            anon_splat = node_has_anon_splat?
+
             methpin = Solargraph::Pin::Method.new(
               location: get_node_location(node),
               closure: region.closure,
@@ -14,17 +15,19 @@ module Solargraph
               comments: comments_for(node),
               scope: region.scope || (region.closure.is_a?(Pin::Singleton) ? :class : :instance),
               visibility: region.visibility,
-              node: node
+              node: node,
+              anon_splat: anon_splat
             )
-            if methpin.name == 'initialize' and methpin.scope == :instance
+            if methpin.name == 'initialize' && methpin.scope == :instance
               pins.push Solargraph::Pin::Method.new(
                 location: methpin.location,
                 closure: methpin.closure,
                 name: 'new',
                 comments: methpin.comments,
                 scope: :class,
-                parameters: methpin.parameters
-              )
+                parameters: methpin.parameters,
+                anon_splat: anon_splat
+                )
               # @todo Smelly instance variable access.
               pins.last.instance_variable_set(:@return_type, ComplexType::SELF)
               pins.push methpin
@@ -40,8 +43,9 @@ module Solargraph
                 scope: :class,
                 visibility: :public,
                 parameters: methpin.parameters,
-                node: methpin.node
-              )
+                node: methpin.node,
+                anon_splat: anon_splat
+                )
               pins.push Solargraph::Pin::Method.new(
                 location: methpin.location,
                 closure: methpin.closure,
@@ -50,13 +54,20 @@ module Solargraph
                 scope: :instance,
                 visibility: :private,
                 parameters: methpin.parameters,
-                node: methpin.node
-              )
+                node: methpin.node,
+                anon_splat: anon_splat
+                )
             else
               pins.push methpin
             end
             process_children region.update(closure: methpin, scope: methpin.scope)
           end
+
+          private
+
+          def node_has_anon_splat?
+            node.children[1]&.children&.first == [nil]
+          end
         end
       end
     end