solargraph 0.58.1 → 0.59.0.dev.1

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

@@ -1,148 +1,150 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-require 'tmpdir'
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        class Formatting < Base
-          include Solargraph::Diagnostics::RubocopHelpers
-
-          def process
-            file_uri = params['textDocument']['uri']
-            config = config_for(file_uri)
-            original = host.read_text(file_uri)
-            args = cli_args(file_uri, config)
-
-            require_rubocop(config['version'])
-            options, paths = ::RuboCop::Options.new.parse(args)
-            # @sg-ignore Unresolved call to []=
-            options[:stdin] = original
-
-            # Ensure only one instance of RuboCop::Runner is running at
-            # a time - it uses 'chdir' to read config files with ERB,
-            # which can conflict with other chdirs.
-            corrections = Solargraph::CHDIR_MUTEX.synchronize do
-              redirect_stdout do
-                ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
-              end
-            end
-            # @sg-ignore Unresolved call to []=
-            result = options[:stdin]
-
-            log_corrections(corrections)
-
-            format original, result
-          rescue ::RuboCop::ValidationError, ::RuboCop::ConfigNotFoundError => e
-            set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
-          end
-
-          private
-
-          # @param corrections [String]
-          # @return [void]
-          def log_corrections(corrections)
-            corrections = corrections&.strip
-            return if corrections&.empty?
-
-            Solargraph.logger.info('Formatting result:')
-            corrections.each_line do |line|
-              next if line.strip.empty?
-              Solargraph.logger.info(line.strip)
-            end
-          end
-
-          # @param file_uri [String]
-          # @return [Hash{String => undefined}]
-          def config_for(file_uri)
-            conf = host.formatter_config(file_uri)
-            return {} unless conf.is_a?(Hash)
-
-            conf['rubocop'] || {}
-          end
-
-          # @param file_uri [String]
-          # @param config [Hash{String => String}]
-          # @return [Array<String>]
-          def cli_args file_uri, config
-            file = UriHelpers.uri_to_file(file_uri)
-            args = [
-              config['cops'] == 'all' ? '-A' : '-a',
-              '--cache', 'false',
-              '--format', formatter_class(config).name,
-            ]
-
-            ['except', 'only'].each do |arg|
-              cops = cop_list(config[arg])
-              args += ["--#{arg}", cops] if cops
-            end
-
-            args += config['extra_args'] if config['extra_args']
-            args + [file]
-          end
-
-          # @param config [Hash{String => String}]
-          # @sg-ignore
-          # @return [Class<RuboCop::Formatter::BaseFormatter>]
-          def formatter_class(config)
-            if self.class.const_defined?('BlankRubocopFormatter')
-              # @sg-ignore
-              BlankRubocopFormatter
-            else
-              require_rubocop(config['version'])
-              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
-              self.class.const_set 'BlankRubocopFormatter', klass
-            end
-          end
-
-          # @param value [Array, String]
-          # @return [String, nil]
-          def cop_list(value)
-            # @type [String]
-            value = value.join(',') if value.respond_to?(:join)
-            return nil if value == '' || !value.is_a?(String)
-            value
-          end
-
-          # @param original [String]
-          # @param result [String]
-          # @return [void]
-          def format original, result
-            ending = if original.end_with?("\n")
-                       {
-                         line: original.lines.length,
-                         character: 0
-                       }
-                     elsif original.lines.empty?
-                       {
-                         line: 0,
-                         character: 0
-                       }
-                     else
-                       {
-                         line: original.lines.length - 1,
-                         character: original.lines.last.length
-                       }
-                     end
-            set_result(
-              [
-                {
-                  range: {
-                    start: {
-                      line: 0,
-                      character: 0
-                    },
-                    end: ending
-                  },
-                  newText: result
-                }
-              ]
-            )
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'tmpdir'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Formatting < Base
+          include Solargraph::Diagnostics::RubocopHelpers
+
+          def process
+            file_uri = params['textDocument']['uri']
+            config = config_for(file_uri)
+            original = host.read_text(file_uri)
+            args = cli_args(file_uri, config)
+
+            require_rubocop(config['version'])
+            options, paths = ::RuboCop::Options.new.parse(args)
+            # @sg-ignore Unresolved call to []=
+            options[:stdin] = original
+
+            # Ensure only one instance of RuboCop::Runner is running at
+            # a time - it uses 'chdir' to read config files with ERB,
+            # which can conflict with other chdirs.
+            corrections = Solargraph::CHDIR_MUTEX.synchronize do
+              redirect_stdout do
+                ::RuboCop::Runner.new(options, ::RuboCop::ConfigStore.new).run(paths)
+              end
+            end
+            # @sg-ignore Unresolved call to []=
+            result = options[:stdin]
+
+            log_corrections(corrections)
+
+            format original, result
+          rescue ::RuboCop::ValidationError, ::RuboCop::ConfigNotFoundError => e
+            set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
+          end
+
+          private
+
+          # @param corrections [String]
+          # @return [void]
+          def log_corrections(corrections)
+            corrections = corrections&.strip
+            return if corrections&.empty?
+
+            Solargraph.logger.info('Formatting result:')
+            corrections.each_line do |line|
+              next if line.strip.empty?
+              Solargraph.logger.info(line.strip)
+            end
+          end
+
+          # @param file_uri [String]
+          # @return [Hash{String => undefined}]
+          def config_for(file_uri)
+            conf = host.formatter_config(file_uri)
+            return {} unless conf.is_a?(Hash)
+
+            conf['rubocop'] || {}
+          end
+
+          # @param file_uri [String]
+          # @param config [Hash{String => String}]
+          # @return [Array<String>]
+          def cli_args file_uri, config
+            file = UriHelpers.uri_to_file(file_uri)
+            args = [
+              config['cops'] == 'all' ? '-A' : '-a',
+              '--cache', 'false',
+              '--format', formatter_class(config).name,
+            ]
+
+            ['except', 'only'].each do |arg|
+              cops = cop_list(config[arg])
+              args += ["--#{arg}", cops] if cops
+            end
+
+            args += config['extra_args'] if config['extra_args']
+            args + [file]
+          end
+
+          # @param config [Hash{String => String}]
+          # @sg-ignore
+          # @return [Class<RuboCop::Formatter::BaseFormatter>]
+          def formatter_class(config)
+            if self.class.const_defined?('BlankRubocopFormatter')
+              # @sg-ignore
+              BlankRubocopFormatter
+            else
+              require_rubocop(config['version'])
+              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
+              self.class.const_set 'BlankRubocopFormatter', klass
+            end
+          end
+
+          # @param value [Array, String]
+          #
+          # @return [String, nil]
+          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
+          end
+
+          # @param original [String]
+          # @param result [String]
+          # @return [void]
+          def format original, result
+            ending = if original.end_with?("\n")
+                       {
+                         line: original.lines.length,
+                         character: 0
+                       }
+                     elsif original.lines.empty?
+                       {
+                         line: 0,
+                         character: 0
+                       }
+                     else
+                       {
+                         line: original.lines.length - 1,
+                         character: original.lines.last.length
+                       }
+                     end
+            set_result(
+              [
+                {
+                  range: {
+                    start: {
+                      line: 0,
+                      character: 0
+                    },
+                    end: ending
+                  },
+                  newText: result
+                }
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,58 +1,60 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        class Hover < Base
-          def process
-            line = params['position']['line']
-            col = params['position']['character']
-            contents = []
-            suggestions = host.definitions_at(params['textDocument']['uri'], line, col)
-            last_link = nil
-            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 "`#{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?
-                data = parts.join("\n\n")
-                next if contents.last&.end_with?(data)
-                contents.push data
-              end
-              last_link = this_link unless this_link.nil?
-            end
-            set_result(
-              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
-
-          # @param contents [Array<String>]
-          # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
-          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
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Hover < Base
+          def process
+            line = params['position']['line']
+            col = params['position']['character']
+            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 "`#{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?
+                data = parts.join("\n\n")
+                next if contents.last&.end_with?(data)
+                contents.push data
+              end
+              last_link = this_link unless this_link.nil?
+            end
+            set_result(
+              contents_or_nil(contents)
+            )
+          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
+
+          private
+
+          # @param contents [Array<String>]
+          # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
+          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
+  end
+end

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

@@ -1,24 +1,25 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        class SignatureHelp < TextDocument::Base
-          def process
-            line = params['position']['line']
-            col = params['position']['character']
-            suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
-            set_result({
-              signatures: suggestions.flat_map { |pin| pin.signature_help }
-            })
-          rescue FileNotFoundError => e
-            Logging.logger.warn "[#{e.class}] #{e.message}"
-            Logging.logger.warn e.backtrace.join("\n")
-            set_result nil
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class SignatureHelp < TextDocument::Base
+          def process
+            line = params['position']['line']
+            col = params['position']['character']
+            suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
+            set_result({
+              signatures: suggestions.flat_map { |pin| pin.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
+        end
+      end
+    end
+  end
+end

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

@@ -1,25 +1,27 @@
-# 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
-
-    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
-        }
-      end
-    end
-  end
-end
+# 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
+
+    private
+
+    # @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

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

@@ -1,23 +1,25 @@
-# frozen_string_literal: true
-
-class Solargraph::LanguageServer::Message::Workspace::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?
-      }
-    end
-    set_result info
-  end
-end
+# frozen_string_literal: true
+
+class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
+  include Solargraph::LanguageServer::UriHelpers
+
+  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