solargraph 0.45.0 → 0.46.0

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

@@ -1,126 +1,126 @@
-# 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)
-            options[:stdin] = original
-            corrections = redirect_stdout do
-              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
-            end
-            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
-
-          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
-
-          def config_for(file_uri)
-            conf = host.formatter_config(file_uri)
-            return {} unless conf.is_a?(Hash)
-
-            conf['rubocop'] || {}
-          end
-
-          def cli_args file_uri, config
-            file = UriHelpers.uri_to_file(file_uri)
-            args = [
-              config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
-              '--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
-
-          def formatter_class(config)
-            if self.class.const_defined?('BlankRubocopFormatter')
-              BlankRubocopFormatter
-            else
-              require_rubocop(config['version'])
-              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
-              self.class.const_set 'BlankRubocopFormatter', klass
-            end
-          end
-
-          def cop_list(value)
-            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)
+            options[:stdin] = original
+            corrections = redirect_stdout do
+              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
+            end
+            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
+
+          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
+
+          def config_for(file_uri)
+            conf = host.formatter_config(file_uri)
+            return {} unless conf.is_a?(Hash)
+
+            conf['rubocop'] || {}
+          end
+
+          def cli_args file_uri, config
+            file = UriHelpers.uri_to_file(file_uri)
+            args = [
+              config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
+              '--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
+
+          def formatter_class(config)
+            if self.class.const_defined?('BlankRubocopFormatter')
+              BlankRubocopFormatter
+            else
+              require_rubocop(config['version'])
+              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
+              self.class.const_set 'BlankRubocopFormatter', klass
+            end
+          end
+
+          def cop_list(value)
+            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,44 +1,54 @@
-# 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 && contents.last.end_with?(data)
-                contents.push data
-              end
-              last_link = this_link unless this_link.nil?
-            end
-            set_result(
-              contents: {
-                kind: 'markdown',
-                value: contents.join("\n\n")
-              }
-            )
-          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 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 && contents.last.end_with?(data)
+                contents.push data
+              end
+              last_link = this_link unless this_link.nil?
+            end
+            set_result(
+              contents: {
+                kind: 'markdown',
+                value: value_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 value_or_nil contents
+            stripped = contents
+              .map(&:strip)
+              .reject { |c| c.empty? }
+            return nil if stripped.empty?
+            stripped.join("\n\n")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,34 +1,34 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        class OnTypeFormatting < Base
-          def process
-            # @todo Temporarily disabled due to conflicts with VSCode formatting on type
-            # src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
-            # fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
-            # offset = fragment.send(:offset)
-            # if fragment.string? and params['ch'] == '{' and src.code[offset - 1, 2] == '#{'
-            #   set_result(
-            #     [
-            #       {
-            #         range: {
-            #           start: params['position'],
-            #           end: params['position']
-            #         },
-            #         newText: '}'
-            #       }
-            #     ]
-            #   )
-            # else
-            #   # @todo Is `nil` or `[]` more appropriate here?
-            #   set_result nil
-            # end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class OnTypeFormatting < Base
+          def process
+            # @todo Temporarily disabled due to conflicts with VSCode formatting on type
+            # src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
+            # fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
+            # offset = fragment.send(:offset)
+            # if fragment.string? and params['ch'] == '{' and src.code[offset - 1, 2] == '#{'
+            #   set_result(
+            #     [
+            #       {
+            #         range: {
+            #           start: params['position'],
+            #           end: params['position']
+            #         },
+            #         newText: '}'
+            #       }
+            #     ]
+            #   )
+            # else
+            #   # @todo Is `nil` or `[]` more appropriate here?
+            #   set_result nil
+            # end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,11 @@
-# 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::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

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

@@ -1,16 +1,16 @@
-# 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::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

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

@@ -1,19 +1,19 @@
-# 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::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

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

@@ -1,29 +1,29 @@
-# 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)
-            info = []
-            suggestions.each do |pin|
-              info.concat pin.overloads.map(&:signature_help)
-              info.push pin.signature_help
-            end
-            set_result({
-              signatures: info
-            })
-          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)
+            info = []
+            suggestions.each do |pin|
+              info.concat pin.overloads.map(&:signature_help)
+              info.push pin.signature_help
+            end
+            set_result({
+              signatures: info
+            })
+          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

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

@@ -1,28 +1,28 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        autoload :Base,              'solargraph/language_server/message/text_document/base'
-        autoload :Completion,        'solargraph/language_server/message/text_document/completion'
-        autoload :DidOpen,           'solargraph/language_server/message/text_document/did_open'
-        autoload :DidChange,         'solargraph/language_server/message/text_document/did_change'
-        autoload :DidClose,          'solargraph/language_server/message/text_document/did_close'
-        autoload :DidSave,           'solargraph/language_server/message/text_document/did_save'
-        autoload :Hover,             'solargraph/language_server/message/text_document/hover'
-        autoload :SignatureHelp,     'solargraph/language_server/message/text_document/signature_help'
-        autoload :DiagnosticsQueue,  'solargraph/language_server/message/text_document/diagnostics_queue'
-        autoload :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
-        autoload :Definition,        'solargraph/language_server/message/text_document/definition'
-        autoload :DocumentSymbol,    'solargraph/language_server/message/text_document/document_symbol'
-        autoload :Formatting,        'solargraph/language_server/message/text_document/formatting'
-        autoload :References,        'solargraph/language_server/message/text_document/references'
-        autoload :Rename,            'solargraph/language_server/message/text_document/rename'
-        autoload :PrepareRename,     'solargraph/language_server/message/text_document/prepare_rename'
-        autoload :FoldingRange,      'solargraph/language_server/message/text_document/folding_range'
-        autoload :DocumentHighlight, 'solargraph/language_server/message/text_document/document_highlight'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        autoload :Base,              'solargraph/language_server/message/text_document/base'
+        autoload :Completion,        'solargraph/language_server/message/text_document/completion'
+        autoload :DidOpen,           'solargraph/language_server/message/text_document/did_open'
+        autoload :DidChange,         'solargraph/language_server/message/text_document/did_change'
+        autoload :DidClose,          'solargraph/language_server/message/text_document/did_close'
+        autoload :DidSave,           'solargraph/language_server/message/text_document/did_save'
+        autoload :Hover,             'solargraph/language_server/message/text_document/hover'
+        autoload :SignatureHelp,     'solargraph/language_server/message/text_document/signature_help'
+        autoload :DiagnosticsQueue,  'solargraph/language_server/message/text_document/diagnostics_queue'
+        autoload :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
+        autoload :Definition,        'solargraph/language_server/message/text_document/definition'
+        autoload :DocumentSymbol,    'solargraph/language_server/message/text_document/document_symbol'
+        autoload :Formatting,        'solargraph/language_server/message/text_document/formatting'
+        autoload :References,        'solargraph/language_server/message/text_document/references'
+        autoload :Rename,            'solargraph/language_server/message/text_document/rename'
+        autoload :PrepareRename,     'solargraph/language_server/message/text_document/prepare_rename'
+        autoload :FoldingRange,      'solargraph/language_server/message/text_document/folding_range'
+        autoload :DocumentHighlight, 'solargraph/language_server/message/text_document/document_highlight'
+      end
+    end
+  end
+end