solargraph 0.58.2 → 0.59.0.dev.2

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

@@ -43,7 +43,7 @@ module Solargraph
 
           # @param corrections [String]
           # @return [void]
-          def log_corrections(corrections)
+          def log_corrections corrections
             corrections = corrections&.strip
             return if corrections&.empty?
 
@@ -56,7 +56,7 @@ module Solargraph
 
           # @param file_uri [String]
           # @return [Hash{String => undefined}]
-          def config_for(file_uri)
+          def config_for file_uri
             conf = host.formatter_config(file_uri)
             return {} unless conf.is_a?(Hash)
 
@@ -71,10 +71,10 @@ module Solargraph
             args = [
               config['cops'] == 'all' ? '-A' : '-a',
               '--cache', 'false',
-              '--format', formatter_class(config).name,
+              '--format', formatter_class(config).name
             ]
 
-            ['except', 'only'].each do |arg|
+            %w[except only].each do |arg|
               cops = cop_list(config[arg])
               args += ["--#{arg}", cops] if cops
             end
@@ -86,7 +86,7 @@ module Solargraph
           # @param config [Hash{String => String}]
           # @sg-ignore
           # @return [Class<RuboCop::Formatter::BaseFormatter>]
-          def formatter_class(config)
+          def formatter_class config
             if self.class.const_defined?('BlankRubocopFormatter')
               # @sg-ignore
               BlankRubocopFormatter
@@ -98,9 +98,11 @@ module Solargraph
           end
 
           # @param value [Array, String]
+          #
           # @return [String, nil]
-          def cop_list(value)
+          def cop_list value
             # @type [String]
+            # @sg-ignore Translate to something flow sensitive typing understands
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)
             value

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

@@ -11,12 +11,11 @@ module Solargraph
             contents = []
             suggestions = host.definitions_at(params['textDocument']['uri'], line, col)
             last_link = nil
+            # @sg-ignore Need to add nil check here
             suggestions.each do |pin|
               parts = []
               this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_documentation
-              if !this_link.nil? && this_link != last_link
-                parts.push this_link
-              end
+              parts.push this_link if !this_link.nil? && this_link != last_link
               parts.push "`#{pin.detail}`" unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
               parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
               unless parts.empty?
@@ -31,6 +30,7 @@ module Solargraph
             )
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             Logging.logger.warn e.backtrace.join("\n")
             set_result nil
           end
@@ -41,8 +41,8 @@ module Solargraph
           # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
           def contents_or_nil contents
             stripped = contents
-              .map(&:strip)
-              .reject { |c| c.empty? }
+                       .map(&:strip)
+                       .reject(&:empty?)
             return nil if stripped.empty?
             {
               contents: {

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

@@ -1,11 +1,18 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::TextDocument
-  class PrepareRename < Base
-    def process
-      line = params['position']['line']
-      col = params['position']['character']
-      set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line, col)).range.to_hash
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class PrepareRename < Base
+          def process
+            line = params['position']['line']
+            col = params['position']['character']
+            set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line,
+                                                                                                           col)).range.to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,16 +1,23 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::TextDocument
-  class References < Base
-    def process
-      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'])
-      result = locs.map do |loc|
-        {
-          uri: file_to_uri(loc.filename),
-          range: loc.range.to_hash
-        }
-      end
-      set_result result
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class References < Base
+          def process
+            locs = host.references_from(params['textDocument']['uri'], params['position']['line'],
+                                        params['position']['character'])
+            result = locs.map do |loc|
+              {
+                uri: file_to_uri(loc.filename),
+                range: loc.range.to_hash
+              }
+            end
+            set_result result
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,19 +1,26 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::TextDocument
-  class Rename < Base
-    def process
-      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'], strip: true)
-      changes = {}
-      locs.each do |loc|
-        uri = file_to_uri(loc.filename)
-        changes[uri] ||= []
-        changes[uri].push({
-          range: loc.range.to_hash,
-          newText: params['newName']
-        })
-      end
-      set_result changes: changes
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Rename < Base
+          def process
+            locs = host.references_from(params['textDocument']['uri'], params['position']['line'],
+                                        params['position']['character'], strip: true)
+            changes = {}
+            locs.each do |loc|
+              uri = file_to_uri(loc.filename)
+              changes[uri] ||= []
+              changes[uri].push({
+                                  range: loc.range.to_hash,
+                                  newText: params['newName']
+                                })
+            end
+            set_result changes: changes
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,10 +10,11 @@ module Solargraph
             col = params['position']['character']
             suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
             set_result({
-              signatures: suggestions.flat_map { |pin| pin.signature_help }
-            })
+                         signatures: suggestions.flat_map(&:signature_help)
+                       })
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             Logging.logger.warn e.backtrace.join("\n")
             set_result nil
           end

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

@@ -1,24 +1,32 @@
 # frozen_string_literal: true
 
-module Solargraph::LanguageServer::Message::TextDocument
-  class TypeDefinition < Base
-    def process
-      @line = params['position']['line']
-      @column = params['position']['character']
-      set_result(code_location || [])
-    end
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class TypeDefinition < Base
+          def process
+            @line = params['position']['line']
+            @column = params['position']['character']
+            set_result(code_location || [])
+          end
 
-    private
+          private
 
-    # @return [Array<Hash>, nil]
-    def code_location
-      suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
-      return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
-        {
-          uri: file_to_uri(pin.best_location.filename),
-          range: pin.best_location.range.to_hash
-        }
+          # @return [Array<Hash>, nil]
+          def code_location
+            suggestions = host.type_definitions_at(params['textDocument']['uri'], @line, @column)
+            # @sg-ignore Need to add nil check here
+            return nil if suggestions.empty?
+            # @sg-ignore Need to add nil check here
+            suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
+              {
+                uri: file_to_uri(pin.best_location.filename),
+                range: pin.best_location.range.to_hash
+              }
+            end
+          end
+        end
       end
     end
   end

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

@@ -1,35 +1,41 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::Workspace
-  class DidChangeConfiguration < Solargraph::LanguageServer::Message::Base
-    def process
-      return unless params['settings']
-      update = params['settings']['solargraph']
-      host.configure update
-      register_from_options
-    end
-
-    private
-
-    # @return [void]
-    def register_from_options
-      Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
-      # @type [Array<String>]
-      y = []
-      # @type [Array<String>]
-      n = []
-      (host.options['completion'] ? y : n).push('textDocument/completion')
-      (host.options['hover'] ? y : n).push('textDocument/hover', 'textDocument/signatureHelp')
-      (host.options['autoformat'] ? y : n).push('textDocument/onTypeFormatting')
-      (host.options['formatting'] ? y : n).push('textDocument/formatting')
-      (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
-      (host.options['definitions'] ? y : n).push('textDocument/definition')
-      (host.options['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
-      (host.options['references'] ? y : n).push('textDocument/references')
-      (host.options['folding'] ? y : n).push('textDocument/folding')
-      (host.options['highlights'] ? y : n).push('textDocument/documentHighlight')
-      host.register_capabilities y
-      host.unregister_capabilities n
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class DidChangeConfiguration < Solargraph::LanguageServer::Message::Base
+          def process
+            return unless params['settings']
+            update = params['settings']['solargraph']
+            host.configure update
+            register_from_options
+          end
+
+          private
+
+          # @return [void]
+          def register_from_options
+            Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
+            # @type [Array<String>]
+            y = []
+            # @type [Array<String>]
+            n = []
+            (host.options['completion'] ? y : n).push('textDocument/completion')
+            (host.options['hover'] ? y : n).push('textDocument/hover', 'textDocument/signatureHelp')
+            (host.options['autoformat'] ? y : n).push('textDocument/onTypeFormatting')
+            (host.options['formatting'] ? y : n).push('textDocument/formatting')
+            (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
+            (host.options['definitions'] ? y : n).push('textDocument/definition')
+            (host.options['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
+            (host.options['references'] ? y : n).push('textDocument/references')
+            (host.options['folding'] ? y : n).push('textDocument/folding')
+            (host.options['highlights'] ? y : n).push('textDocument/documentHighlight')
+            host.register_capabilities y
+            host.unregister_capabilities n
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,40 +1,48 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::Workspace
-  class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
-    CREATED = 1
-    CHANGED = 2
-    DELETED = 3
-
-    include Solargraph::LanguageServer::UriHelpers
-
-    def process
-      need_catalog = false
-      to_create = []
-      to_delete = []
-
-      # @param change [Hash]
-      params['changes'].each do |change|
-        if change['type'] == CREATED
-          to_create << change['uri']
-          need_catalog = true
-        elsif change['type'] == CHANGED
-          next if host.open?(change['uri'])
-          to_create << change['uri']
-          need_catalog = true
-        elsif change['type'] == DELETED
-          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
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
+          CREATED = 1
+          CHANGED = 2
+          DELETED = 3
+
+          include Solargraph::LanguageServer::UriHelpers
+
+          def process
+            need_catalog = false
+            to_create = []
+            to_delete = []
+
+            # @param change [Hash]
+            params['changes'].each do |change|
+              case change['type']
+              when CREATED
+                to_create << change['uri']
+                need_catalog = true
+              when CHANGED
+                next if host.open?(change['uri'])
+                to_create << change['uri']
+                need_catalog = true
+              when DELETED
+                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
+        end
+      end
+    end
+  end
+end

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

@@ -1,26 +1,32 @@
-# frozen_string_literal: true
-
-module Solargraph::LanguageServer::Message::Workspace
-  class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
-    def process
-      add_folders
-      remove_folders
-    end
-
-    private
-
-    # @return [void]
-    def add_folders
-      return unless params['event'] && params['event']['added']
-      host.prepare_folders params['event']['added']
-    end
-
-    # @return [void]
-    def remove_folders
-      return unless params['event'] && params['event']['removed']
-      params['event']['removed'].each do |folder|
-        host.remove_folders params['event']['removed']
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
+          def process
+            add_folders
+            remove_folders
+          end
+
+          private
+
+          # @return [void]
+          def add_folders
+            return unless params['event'] && params['event']['added']
+            host.prepare_folders params['event']['added']
+          end
+
+          # @return [void]
+          def remove_folders
+            return unless params['event'] && params['event']['removed']
+            params['event']['removed'].each do |_folder|
+              host.remove_folders params['event']['removed']
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,23 +1,33 @@
 # frozen_string_literal: true
 
-class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
-  include Solargraph::LanguageServer::UriHelpers
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
+          include Solargraph::LanguageServer::UriHelpers
 
-  def process
-    pins = host.query_symbols(params['query'])
-    info = pins.map do |pin|
-      uri = file_to_uri(pin.best_location.filename)
-      {
-        name: pin.path,
-        containerName: pin.namespace,
-        kind: pin.symbol_kind,
-        location: {
-          uri: uri,
-          range: pin.best_location.range.to_hash
-        },
-        deprecated: pin.deprecated?
-      }
+          def process
+            pins = host.query_symbols(params['query'])
+            info = pins.map do |pin|
+              # @sg-ignore Need to add nil check here
+              uri = file_to_uri(pin.best_location.filename)
+              {
+                name: pin.path,
+                containerName: pin.namespace,
+                kind: pin.symbol_kind,
+                location: {
+                  uri: uri,
+                  # @sg-ignore Need to add nil check here
+                  range: pin.best_location.range.to_hash
+                },
+                deprecated: pin.deprecated?
+              }
+            end
+            set_result info
+          end
+        end
+      end
     end
-    set_result info
   end
 end