Class: RubyLsp::RuboCop::RuntimeAdapter Private

Do not use. This class is for internal use only.

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain: self, RubyLsp::Requests::Support::Formatter
Inherits:	Object
Defined in:	lib/ruby_lsp/rubocop/runtime_adapter.rb

Overview

Provides an adapter to bridge RuboCop’s built-in LSP runtime with Ruby LSP’s add-on.

Class Method Summary

.new ⇒ RuntimeAdapter constructor Internal use only

Instance Method Summary

#run_diagnostic(uri, document) Internal use only
#run_formatting(uri, document) Internal use only
#run_range_formatting(_uri, _partial_source, _base_indentation) Internal use only
#prism_result(document) private Internal use only
#uri_to_path(uri) private Internal use only

duplicated from: lib/standard/lsp/routes.rb modified to incorporate Ruby LSP’s to_standardized_path method.

Instance Method Details

#prism_result(document) (private)

[ GitHub ]

# File 'lib/ruby_lsp/rubocop/runtime_adapter.rb', line 56


def prism_result(document)
  prism_result = document.parse_result

  # NOTE: `prism_result` must be `Prism::ParseLexResult` compatible object.
  # This is for compatibility parsed result unsupported.
  prism_result.is_a?(Prism::ParseLexResult) ? prism_result : nil
end

#run_diagnostic(uri, document)

[ GitHub ]

# File 'lib/ruby_lsp/rubocop/runtime_adapter.rb', line 18


def run_diagnostic(uri, document)
  @runtime.offenses(
    uri_to_path(uri),
    document.source,
    document.encoding,
    prism_result: prism_result(document)
  )
end

#run_formatting(uri, document)

[ GitHub ]

# File 'lib/ruby_lsp/rubocop/runtime_adapter.rb', line 27


def run_formatting(uri, document)
  @runtime.format(
    uri_to_path(uri),
    document.source,
    command: 'rubocop.formatAutocorrects',
    prism_result: prism_result(document)
  )
end

#run_range_formatting(_uri, _partial_source, _base_indentation)

[ GitHub ]

# File 'lib/ruby_lsp/rubocop/runtime_adapter.rb', line 36


def run_range_formatting(_uri, _partial_source, _base_indentation)
  # Not yet supported. Should return the formatted version of `partial_source` which is
  # a partial selection of the entire document. For example, it should not try to add
  # a frozen_string_literal magic comment and all style corrections should start from
  # the `base_indentation`.
  nil
end

#uri_to_path(uri) (private)

duplicated from: lib/standard/lsp/routes.rb modified to incorporate Ruby LSP’s to_standardized_path method

[ GitHub ]

# File 'lib/ruby_lsp/rubocop/runtime_adapter.rb', line 48


def uri_to_path(uri)
  if uri.respond_to?(:to_standardized_path) && (standardized_path = uri.to_standardized_path)
    standardized_path
  else
    uri.to_s.delete_prefix('file://')
  end
end