solargraph 0.58.2 → 0.59.0.dev.2

data/lib/solargraph/gem_pins.rb

@@ -13,8 +13,8 @@ module Solargraph
 
     # @param pins [Array<Pin::Base>]
     # @return [Array<Pin::Base>]
-    def self.combine_method_pins_by_path(pins)
-      method_pins, alias_pins = pins.partition { |pin| pin.class == Pin::Method }
+    def self.combine_method_pins_by_path pins
+      method_pins, alias_pins = pins.partition { |pin| pin.instance_of?(Pin::Method) }
       by_path = method_pins.group_by(&:path)
       by_path.transform_values! do |pins|
         GemPins.combine_method_pins(*pins)
@@ -43,36 +43,37 @@ module Solargraph
       out
     end
 
-    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
-    # @param gemspec [Gem::Specification]
-    # @return [Array<Pin::Base>]
-    def self.build_yard_pins(yard_plugins, gemspec)
-      Yardoc.cache(yard_plugins, gemspec) unless Yardoc.cached?(gemspec)
-      return [] unless Yardoc.cached?(gemspec)
-      yardoc = Yardoc.load!(gemspec)
-      YardMap::Mapper.new(yardoc, gemspec).map
-    end
-
     # @param yard_pins [Array<Pin::Base>]
     # @param rbs_pins [Array<Pin::Base>]
     #
     # @return [Array<Pin::Base>]
-    def self.combine(yard_pins, rbs_pins)
+    def self.combine yard_pins, rbs_pins
       in_yard = Set.new
-      rbs_api_map = Solargraph::ApiMap.new(pins: rbs_pins)
+      rbs_store = Solargraph::ApiMap::Store.new(rbs_pins)
       combined = yard_pins.map do |yard_pin|
         in_yard.add yard_pin.path
-        rbs_pin = rbs_api_map.get_path_pins(yard_pin.path).filter { |pin| pin.is_a? Pin::Method }.first
-        next yard_pin unless rbs_pin && yard_pin.class == Pin::Method
+        rbs_pin = rbs_store.get_path_pins(yard_pin.path).filter { |pin| pin.is_a? Pin::Method }.first
+
+        next yard_pin unless rbs_pin && yard_pin.is_a?(Pin::Method)
 
         unless rbs_pin
-          # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-          logger.debug { "GemPins.combine: No rbs pin for #{yard_pin.path} - using YARD's '#{yard_pin.inspect} (return_type=#{yard_pin.return_type}; signatures=#{yard_pin.signatures})" }
+          logger.debug do
+            "GemPins.combine: No rbs pin for #{yard_pin.path} - using YARD's '#{yard_pin.inspect} (return_type=#{yard_pin.return_type}; signatures=#{yard_pin.signatures})"
+          end
           next yard_pin
         end
 
+        # at this point both yard_pins and rbs_pins are methods or
+        # method aliases.  if not plain methods, prefer the YARD one
+        next yard_pin if rbs_pin.class != Pin::Method
+
+        next rbs_pin if yard_pin.class != Pin::Method
+
+        # both are method pins
         out = combine_method_pins(rbs_pin, yard_pin)
-        logger.debug { "GemPins.combine: Combining yard.path=#{yard_pin.path} - rbs=#{rbs_pin.inspect} with yard=#{yard_pin.inspect} into #{out}" }
+        logger.debug do
+          "GemPins.combine: Combining yard.path=#{yard_pin.path} - rbs=#{rbs_pin.inspect} with yard=#{yard_pin.inspect} into #{out}"
+        end
         out
       end
       in_rbs_only = rbs_pins.select do |pin|
@@ -91,7 +92,7 @@ module Solargraph
       # @param choices [Array<ComplexType>]
       # @return [ComplexType]
       def best_return_type *choices
-        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
+        choices.find(&:defined?) || choices.first || ComplexType::UNDEFINED
       end
     end
   end

data/lib/solargraph/language_server/error_codes.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The ErrorCode constants for the language server protocol.
-    #
-    module ErrorCodes
-      PARSE_ERROR =            -32700
-      INVALID_REQUEST =        -32600
-      METHOD_NOT_FOUND =       -32601
-      INVALID_PARAMS =         -32602
-      INTERNAL_ERROR =         -32603
-      SERVER_ERROR_START =     -32099
-      SERVER_ERROR_END =       -32000
-      SERVER_NOT_INITIALIZED = -32002
-      UNKNOWN_ERROR_CODE =     -32001
-      REQUEST_CANCELLED =      -32800
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The ErrorCode constants for the language server protocol.
+    #
+    module ErrorCodes
+      PARSE_ERROR =            -32_700
+      INVALID_REQUEST =        -32_600
+      METHOD_NOT_FOUND =       -32_601
+      INVALID_PARAMS =         -32_602
+      INTERNAL_ERROR =         -32_603
+      SERVER_ERROR_START =     -32_099
+      SERVER_ERROR_END =       -32_000
+      SERVER_NOT_INITIALIZED = -32_002
+      UNKNOWN_ERROR_CODE =     -32_001
+      REQUEST_CANCELLED =      -32_800
+    end
+  end
+end

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

@@ -56,7 +56,7 @@ module Solargraph
         # @return [void]
         def tick
           return if queue.empty? || host.synchronizing?
-          if !host.options['diagnostics']
+          unless host.options['diagnostics']
             mutex.synchronize { queue.clear }
             return
           end

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

@@ -33,6 +33,7 @@ module Solargraph
         # @return [void]
         def update_libraries uri
           src = sources.find(uri)
+          # @sg-ignore Need to add nil check here
           using = libraries.select { |lib| lib.contain?(src.filename) }
           using.push library_for(uri) if using.empty?
           using.each { |lib| lib.merge src }
@@ -44,12 +45,11 @@ module Solargraph
         # @param uri [String]
         # @return [Library]
         def library_for uri
-          result = explicit_library_for(uri) ||
+          explicit_library_for(uri) ||
             implicit_library_for(uri) ||
             generic_library_for(uri)
           # previous library for already call attach. avoid call twice
           # result.attach sources.find(uri) if sources.include?(uri)
-          result
         end
 
         # Find an explicit library match for the given URI. An explicit match
@@ -118,8 +118,8 @@ module Solargraph
                                                   .tap { |lib| lib.add_observer self }
         end
 
-        # @param library [Solargraph::Library]
         # @param progress [Solargraph::LanguageServer::Progress, nil]
+        #
         # @return [void]
         def update progress
           progress&.send(self)

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

@@ -20,7 +20,7 @@ module Solargraph
         ].freeze
 
         # @param host [Host]
-        def initialize(host)
+        def initialize host
           @host = host
           @mutex = Mutex.new
           @resource = ConditionVariable.new
@@ -28,7 +28,7 @@ module Solargraph
         end
 
         # pending handle messages
-        # @return [Array<Hash>]
+        # @return [Array<Hash{String => undefined}>]
         def messages
           @messages ||= []
         end
@@ -44,7 +44,7 @@ module Solargraph
 
         # @param message [Hash] The message to handle. Will be forwarded to Host#receive
         # @return [void]
-        def queue(message)
+        def queue message
           @mutex.synchronize do
             messages.push(message)
             @resource.signal
@@ -66,6 +66,7 @@ module Solargraph
             @resource.wait(@mutex) if messages.empty?
             next_message
           end
+          # @sg-ignore Need to add nil check here
           handler = @host.receive(message)
           handler&.send_response
         end

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

@@ -13,7 +13,7 @@ module Solargraph
 
         # @param uri [String]
         # @return [void]
-        def add_uri(uri)
+        def add_uri uri
           queue.push(uri)
         end
 
@@ -55,6 +55,7 @@ module Solargraph
         # @raise [FileNotFoundError] if the URI does not match an open source.
         #
         # @param uri [String]
+        # @sg-ignore flow ensitive typing should understand raise
         # @return [Solargraph::Source]
         def find uri
           open_source_hash[uri] || raise(Solargraph::FileNotFoundError, "Host could not find #{uri}")

data/lib/solargraph/language_server/host.rb

@@ -53,7 +53,7 @@ module Solargraph
         logger.level = LOG_LEVELS[options['logLevel']] || DEFAULT_LOG_LEVEL
       end
 
-      # @return [Hash{String => [Boolean, String]}]
+      # @return [Hash{String => Boolean, String}]
       def options
         @options ||= default_configuration
       end
@@ -105,6 +105,7 @@ module Solargraph
             message.process unless cancel?(request['id'])
           rescue StandardError => e
             logger.warn "Error processing request: [#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             logger.warn e.backtrace.join("\n")
             message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
           end
@@ -118,7 +119,7 @@ module Solargraph
             nil
           end
         else
-          logger.warn "Invalid message received."
+          logger.warn 'Invalid message received.'
           logger.debug request
           nil
         end
@@ -153,7 +154,7 @@ module Solargraph
           lib.delete(*filenames)
         end
         uris.each do |uri|
-          send_notification "textDocument/publishDiagnostics", {
+          send_notification 'textDocument/publishDiagnostics', {
             uri: uri,
             diagnostics: []
           }
@@ -208,7 +209,7 @@ module Solargraph
             logger.info "Diagnosing #{uri}"
             begin
               results = library.diagnose uri_to_file(uri)
-              send_notification "textDocument/publishDiagnostics", {
+              send_notification 'textDocument/publishDiagnostics', {
                 uri: uri,
                 diagnostics: results
               }
@@ -300,8 +301,11 @@ module Solargraph
         end
       end
 
+      # @sg-ignore Need to validate config
       # @return [String]
+      # @sg-ignore Need to validate config
       def command_path
+        # @type [String]
         options['commandPath'] || 'solargraph'
       end
 
@@ -350,7 +354,7 @@ module Solargraph
       # @return [void]
       def send_notification method, params
         response = {
-          jsonrpc: "2.0",
+          jsonrpc: '2.0',
           method: method,
           params: params
         }
@@ -373,7 +377,7 @@ module Solargraph
       def send_request method, params, &block
         @request_mutex.synchronize do
           message = {
-            jsonrpc: "2.0",
+            jsonrpc: '2.0',
             method: method,
             params: params,
             id: @next_request_id
@@ -415,13 +419,13 @@ module Solargraph
       # @return [void]
       def unregister_capabilities methods
         logger.debug "Unregistering capabilities: #{methods}"
-        unregisterations = methods.select{|m| registered?(m)}.map{ |m|
+        unregisterations = methods.select { |m| registered?(m) }.map do |m|
           @registered_capabilities.delete m
           {
             id: m,
             method: m
           }
-        }
+        end
         return if unregisterations.empty?
         send_request 'client/unregisterCapability', { unregisterations: unregisterations }
       end
@@ -489,7 +493,7 @@ module Solargraph
               params['data']['location']['range']['end']['character']
             )
           )
-          result.concat library.locate_pins(location).select{ |pin| pin.name == params['label'] }
+          result.concat(library.locate_pins(location).select { |pin| pin.name == params['label'] })
         end
         if params['data']['path']
           result.concat library.path_pins(params['data']['path'])
@@ -543,7 +547,7 @@ module Solargraph
       end
 
       # @return [Bool] if has pending completion request
-      def has_pending_completions?
+      def pending_completions?
         message_worker.messages.reverse_each.any? { |req| req['method'] == 'textDocument/completion' }
       end
 
@@ -644,7 +648,7 @@ module Solargraph
       # @param text [String]
       # @param type [Integer] A MessageType constant
       # @param actions [Array<String>] Response options for the client
-      # @param block The block that processes the response
+      # @param block [Proc] The block that processes the response
       # @yieldparam [String] The action received from the client
       # @return [void]
       def show_message_request text, type, actions, &block
@@ -663,7 +667,7 @@ module Solargraph
         requests.keys
       end
 
-      # @return [Hash{String => [Boolean,String]}]
+      # @return [Hash{String => Boolean,String}]
       def default_configuration
         {
           'completion' => true,
@@ -729,9 +733,11 @@ module Solargraph
       end
 
       # @param path [String]
+      # @sg-ignore Need to be able to choose signature on String#gsub
       # @return [String]
       def normalize_separators path
         return path if File::ALT_SEPARATOR.nil?
+        # @sg-ignore flow sensitive typing needs to handle constants
         path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
       end
 
@@ -742,9 +748,12 @@ module Solargraph
         params['contentChanges'].each do |recvd|
           chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
-            (chng['range'].nil? ?
-              nil :
-              Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
+            (if chng['range'].nil?
+               nil
+             else
+               Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'],
+                                         chng['range']['end']['line'], chng['range']['end']['character'])
+             end
             ),
             chng['text']
           )
@@ -764,8 +773,7 @@ module Solargraph
         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
-        # @sg-ignore push this upstream
+        return change if diffs.empty? || diffs.length > 1 || diffs.first.length > 1
         # @type [Diff::LCS::Change]
         diff = diffs.first.first
         return change unless diff.adding? && ['.', ':', '(', ',', ' '].include?(diff.element)
@@ -808,10 +816,10 @@ module Solargraph
           # documentSymbolProvider: true,
           # workspaceSymbolProvider: true,
           # workspace: {
-            # workspaceFolders: {
-              # supported: true,
-              # changeNotifications: true
-            # }
+          # workspaceFolders: {
+          # supported: true,
+          # changeNotifications: true
+          # }
           # }
           'textDocument/definition' => {
             definitionProvider: true
@@ -858,7 +866,7 @@ module Solargraph
       end
 
       # @param library [Library]
-      # @param uuid [String, nil]
+      #
       # @return [void]
       def sync_library_map library
         total = library.workspace.sources.length

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

@@ -1,97 +1,97 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      class Base
-        # @return [Solargraph::LanguageServer::Host]
-        attr_reader :host
-
-        # @return [Integer]
-        attr_reader :id
-
-        # @return [Hash]
-        attr_reader :request
-
-        # @return [String]
-        attr_reader :method
-
-        # @return [Hash{String => undefined}]
-        attr_reader :params
-
-        # @return [Hash, Array, nil]
-        attr_reader :result
-
-        # @return [Hash, nil]
-        attr_reader :error
-
-        # @param host [Solargraph::LanguageServer::Host]
-        # @param request [Hash]
-        def initialize host, request
-          @host = host
-          @id = request['id'].freeze
-          @request = request.freeze
-          @method = request['method'].freeze
-          @params = (request['params'] || {}).freeze
-          post_initialize
-        end
-
-        # @return [void]
-        def post_initialize; end
-
-        # @return [void]
-        def process; end
-
-        # @param data [Hash, Array, nil]
-        # @return [void]
-        def set_result data
-          @result = data
-        end
-
-        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
-        # @param message [String]
-        # @return [void]
-        def set_error code, message
-          @error = {
-            code: code,
-            message: message
-          }
-        end
-
-        # @return [void]
-        def send_response
-          return if id.nil?
-
-          accept_or_cancel
-          response = {
-            jsonrpc: '2.0',
-            id: id
-          }
-          response[:result] = result unless result.nil?
-          response[:error] = error unless error.nil?
-          response[:result] = nil if result.nil? and error.nil?
-          json = response.to_json
-          envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-          Solargraph.logger.debug envelope
-          host.queue envelope
-          host.clear id
-        end
-
-        private
-
-        # @return [void]
-        def accept_or_cancel
-          if host.cancel?(id)
-            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
-            # cancel should send response RequestCancelled
-            Solargraph::Logging.logger.info "Cancelled response to ##{id} #{method}"
-            set_result nil
-            set_error ErrorCodes::REQUEST_CANCELLED, 'Cancelled by client'
-          else
-            Solargraph::Logging.logger.info "Sending response to ##{id} #{method}"
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Base
+        # @return [Solargraph::LanguageServer::Host]
+        attr_reader :host
+
+        # @return [Integer]
+        attr_reader :id
+
+        # @return [Hash]
+        attr_reader :request
+
+        # @return [String]
+        attr_reader :method
+
+        # @return [Hash{String => undefined}]
+        attr_reader :params
+
+        # @return [Hash, Array, nil]
+        attr_reader :result
+
+        # @return [Hash, nil]
+        attr_reader :error
+
+        # @param host [Solargraph::LanguageServer::Host]
+        # @param request [Hash]
+        def initialize host, request
+          @host = host
+          @id = request['id'].freeze
+          @request = request.freeze
+          @method = request['method'].freeze
+          @params = (request['params'] || {}).freeze
+          post_initialize
+        end
+
+        # @return [void]
+        def post_initialize; end
+
+        # @return [void]
+        def process; end
+
+        # @param data [Hash, Array, nil]
+        # @return [void]
+        def set_result data
+          @result = data
+        end
+
+        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
+        # @param message [String]
+        # @return [void]
+        def set_error code, message
+          @error = {
+            code: code,
+            message: message
+          }
+        end
+
+        # @return [void]
+        def send_response
+          return if id.nil?
+
+          accept_or_cancel
+          response = {
+            jsonrpc: '2.0',
+            id: id
+          }
+          response[:result] = result unless result.nil?
+          response[:error] = error unless error.nil?
+          response[:result] = nil if result.nil? && error.nil?
+          json = response.to_json
+          envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+          Solargraph.logger.debug envelope
+          host.queue envelope
+          host.clear id
+        end
+
+        private
+
+        # @return [void]
+        def accept_or_cancel
+          if host.cancel?(id)
+            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
+            # cancel should send response RequestCancelled
+            Solargraph::Logging.logger.info "Cancelled response to ##{id} #{method}"
+            set_result nil
+            set_error ErrorCodes::REQUEST_CANCELLED, 'Cancelled by client'
+          else
+            Solargraph::Logging.logger.info "Sending response to ##{id} #{method}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/client/register_capability.rb

@@ -1,15 +1,13 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Client
-        class RegisterCapability < Solargraph::LanguageServer::Message::Base
-          def process
-            
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Client
+        class RegisterCapability < Solargraph::LanguageServer::Message::Base
+          def process; end
+        end
+      end
+    end
+  end
+end