standard 1.38.0 → 1.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f78e04ed9ba26c056a144f8584e28ade38906bf4f0e5078802654cd5d7b99082
-  data.tar.gz: 7d6b129ca13e5cbb8dc9ffed5891edcd81975780873501443f125906846d8a3c
+  metadata.gz: b15a7085baa8421e82fec821f8562214b001cfe17bd6a02f7a061bc892f047fa
+  data.tar.gz: f67e28527faebd95dc452a57f8994523c11f2f3e5be6c28da458d374852c5f9e
 SHA512:
-  metadata.gz: 8de4b19e062290cbc42f4b9d3f73cc2b1412b9dc683b6499a0d443b32f598e1a7d48e0f46f1e4343f18a6032ba6a3fb74a3b90a00257e4f3777ecbc73d5fd758
-  data.tar.gz: 42bf30e5370ca89431b4c8546320fb3c840c1ce7c7256dae9f516ed88f71f8ad1a1b77ea644c417d3ecab3ce98481aecc29211965b6f1c18903d5eccaa9cfc78
+  metadata.gz: d6040219e08da54f2ccfff731e787228e9226b20ba0380530513a41b0f29946eecf1503e41cd93e8f6beca3259258a713ad2f6815099325074a11ec2fcaf8915
+  data.tar.gz: 6749ee4c00f5cad2c52b774e96048f82769046a9527dccc6515e0ee75ed274987d72f11d6422407c747ceed15c8b9c12a884c94573657af07811d7f013889135

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.39.0
+
+* Add support for LSP Code Actions / Quick Fix under Ruby LSP [#636](https://github.com/standardrb/standard/pull/636)
+
 ## 1.38.0
 
 * Update minimum Ruby version to 3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    standard (1.38.0)
+    standard (1.39.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.64.0)

data/lib/ruby_lsp/standard/addon.rb

@@ -4,20 +4,18 @@ require_relative "wraps_built_in_lsp_standardizer"
 module RubyLsp
   module Standard
     class Addon < ::RubyLsp::Addon
-      def initializer
-        @wraps_built_in_lsp_standardizer = nil
-      end
-
       def name
         "Standard Ruby"
       end
 
       def activate(global_state, message_queue)
-        warn "Activating Standard Ruby LSP addon v#{::Standard::VERSION}"
+        @logger = ::Standard::Lsp::Logger.new(prefix: "[Standard Ruby]")
+        @logger.puts "Activating Standard Ruby LSP addon v#{::Standard::VERSION}"
+        RuboCop::LSP.enable
         @wraps_built_in_lsp_standardizer = WrapsBuiltinLspStandardizer.new
         global_state.register_formatter("standard", @wraps_built_in_lsp_standardizer)
         register_additional_file_watchers(global_state, message_queue)
-        warn "Initialized Standard Ruby LSP addon #{::Standard::VERSION}"
+        @logger.puts "Initialized Standard Ruby LSP addon #{::Standard::VERSION}"
       end
 
       def deactivate
@@ -52,7 +50,7 @@ module RubyLsp
       def workspace_did_change_watched_files(changes)
         if changes.any? { |change| change[:uri].end_with?(".standard.yml") }
           @wraps_built_in_lsp_standardizer.init!
-          warn "Re-initialized Standard Ruby LSP addon #{::Standard::VERSION} due to .standard.yml file change"
+          @logger.puts "Re-initialized Standard Ruby LSP addon #{::Standard::VERSION} due to .standard.yml file change"
         end
       end
     end

data/lib/ruby_lsp/standard/wraps_built_in_lsp_standardizer.rb

@@ -7,13 +7,9 @@ module RubyLsp
       end
 
       def init!
-        @config = ::Standard::BuildsConfig.new.call([])
         @standardizer = ::Standard::Lsp::Standardizer.new(
-          @config,
-          ::Standard::Lsp::Logger.new
+          ::Standard::BuildsConfig.new.call([])
         )
-        @rubocop_config = @config.rubocop_config_store.for_pwd
-        @cop_registry = RuboCop::Cop::Registry.global.to_h
       end
 
       def run_formatting(uri, document)
@@ -21,55 +17,7 @@ module RubyLsp
       end
 
       def run_diagnostic(uri, document)
-        offenses = @standardizer.offenses(uri_to_path(uri), document.source)
-
-        offenses.map { |o|
-          cop_name = o[:cop_name]
-
-          msg = o[:message].delete_prefix(cop_name)
-          loc = o[:location]
-
-          severity = case o[:severity]
-          when "error", "fatal"
-            RubyLsp::Constant::DiagnosticSeverity::ERROR
-          when "warning"
-            RubyLsp::Constant::DiagnosticSeverity::WARNING
-          when "convention"
-            RubyLsp::Constant::DiagnosticSeverity::INFORMATION
-          when "refactor", "info"
-            RubyLsp::Constant::DiagnosticSeverity::HINT
-          else # the above cases fully cover what RuboCop sends at this time
-            logger.puts "Unknown severity: #{severity.inspect}"
-            RubyLsp::Constant::DiagnosticSeverity::HINT
-          end
-
-          RubyLsp::Interface::Diagnostic.new(
-            code: cop_name,
-            code_description: code_description(cop_name),
-            message: msg,
-            source: "Standard Ruby",
-            severity: severity,
-            range: RubyLsp::Interface::Range.new(
-              start: RubyLsp::Interface::Position.new(line: loc[:start_line] - 1, character: loc[:start_column] - 1),
-              end: RubyLsp::Interface::Position.new(line: loc[:last_line] - 1, character: loc[:last_column])
-            )
-            # TODO: We need to do something like to support quickfixes thru code actions
-            # See: https://github.com/Shopify/ruby-lsp/blob/4c1906172add4d5c39c35d3396aa29c768bfb898/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L62
-            # data: {
-            #   correctable: correctable?(offense),
-            #   code_actions: to_lsp_code_actions
-            # }
-            #
-            # Right now, our offenses are all just JSON parsed from stdout shelling to RuboCop, so
-            # it seems we don't have the corrector available to us.
-            #
-            # Lifted from:
-            # https://github.com/Shopify/ruby-lsp/blob/8d4c17efce4e8ecc8e7c557ab2981db6b22c0b6d/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L201
-            # def correctable?(offense)
-            #   !offense.corrector.nil?
-            # end
-          )
-        }
+        @standardizer.offenses(uri_to_path(uri), document.source, document.encoding)
       end
 
       private
@@ -83,16 +31,6 @@ module RubyLsp
           uri.to_s.sub(%r{^file://}, "")
         end
       end
-
-      # lifted from:
-      # https://github.com/Shopify/ruby-lsp/blob/4c1906172add4d5c39c35d3396aa29c768bfb898/lib/ruby_lsp/requests/support/rubocop_diagnostic.rb#L84
-      def code_description(cop_name)
-        if (cop_class = @cop_registry[cop_name]&.first)
-          if (doc_url = cop_class.documentation_url(@rubocop_config))
-            Interface::CodeDescription.new(href: doc_url)
-          end
-        end
-      end
     end
   end
 end

data/lib/standard/lsp/diagnostic.rb

@@ -0,0 +1,168 @@
+module Standard
+  module Lsp
+    class Diagnostic
+      Constant = LanguageServer::Protocol::Constant
+      Interface = LanguageServer::Protocol::Interface
+
+      RUBOCOP_TO_LSP_SEVERITY = {
+        info: Constant::DiagnosticSeverity::HINT,
+        refactor: Constant::DiagnosticSeverity::INFORMATION,
+        convention: Constant::DiagnosticSeverity::INFORMATION,
+        warning: Constant::DiagnosticSeverity::WARNING,
+        error: Constant::DiagnosticSeverity::ERROR,
+        fatal: Constant::DiagnosticSeverity::ERROR
+      }.freeze
+
+      def initialize(document_encoding, offense, uri, cop_class)
+        @document_encoding = document_encoding
+        @offense = offense
+        @uri = uri
+        @cop_class = cop_class
+      end
+
+      def to_lsp_code_actions
+        code_actions = []
+
+        code_actions << autocorrect_action if correctable?
+        code_actions << disable_line_action
+
+        code_actions
+      end
+
+      def to_lsp_diagnostic(config)
+        highlighted = @offense.highlighted_area
+        Interface::Diagnostic.new(
+          message: message,
+          source: "Standard Ruby",
+          code: @offense.cop_name,
+          code_description: code_description(config),
+          severity: severity,
+          range: Interface::Range.new(
+            start: Interface::Position.new(
+              line: @offense.line - 1,
+              character: highlighted.begin_pos
+            ),
+            end: Interface::Position.new(
+              line: @offense.line - 1,
+              character: highlighted.end_pos
+            )
+          ),
+          data: {
+            correctable: correctable?,
+            code_actions: to_lsp_code_actions
+          }
+        )
+      end
+
+      private
+
+      def message
+        message = @offense.message
+        message += "\n\nThis offense is not auto-correctable.\n" unless correctable?
+        message
+      end
+
+      def severity
+        RUBOCOP_TO_LSP_SEVERITY[@offense.severity.name]
+      end
+
+      def code_description(config)
+        return unless @cop_class
+
+        if (doc_url = @cop_class.documentation_url(config))
+          Interface::CodeDescription.new(href: doc_url)
+        end
+      end
+
+      def autocorrect_action
+        Interface::CodeAction.new(
+          title: "Autocorrect #{@offense.cop_name}",
+          kind: Constant::CodeActionKind::QUICK_FIX,
+          edit: Interface::WorkspaceEdit.new(
+            document_changes: [
+              Interface::TextDocumentEdit.new(
+                text_document: Interface::OptionalVersionedTextDocumentIdentifier.new(
+                  uri: @uri.to_s,
+                  version: nil
+                ),
+                edits: correctable? ? offense_replacements : []
+              )
+            ]
+          ),
+          is_preferred: true
+        )
+      end
+
+      def offense_replacements
+        @offense.corrector.as_replacements.map do |range, replacement|
+          Interface::TextEdit.new(
+            range: Interface::Range.new(
+              start: Interface::Position.new(line: range.line - 1, character: range.column),
+              end: Interface::Position.new(line: range.last_line - 1, character: range.last_column)
+            ),
+            new_text: replacement
+          )
+        end
+      end
+
+      def disable_line_action
+        Interface::CodeAction.new(
+          title: "Disable #{@offense.cop_name} for this line",
+          kind: Constant::CodeActionKind::QUICK_FIX,
+          edit: Interface::WorkspaceEdit.new(
+            document_changes: [
+              Interface::TextDocumentEdit.new(
+                text_document: Interface::OptionalVersionedTextDocumentIdentifier.new(
+                  uri: @uri.to_s,
+                  version: nil
+                ),
+                edits: line_disable_comment
+              )
+            ]
+          )
+        )
+      end
+
+      def line_disable_comment
+        new_text = if @offense.source_line.include?(" # standard:disable ")
+          ",#{@offense.cop_name}"
+        else
+          " # standard:disable #{@offense.cop_name}"
+        end
+
+        eol = Interface::Position.new(
+          line: @offense.line - 1,
+          character: length_of_line(@offense.source_line)
+        )
+
+        # TODO: fails for multiline strings - may be preferable to use block
+        # comments to disable some offenses
+        inline_comment = Interface::TextEdit.new(
+          range: Interface::Range.new(start: eol, end: eol),
+          new_text: new_text
+        )
+
+        [inline_comment]
+      end
+
+      def length_of_line(line)
+        if @document_encoding == Encoding::UTF_16LE
+          line_length = 0
+          line.codepoints.each do |codepoint|
+            line_length += 1
+            if codepoint > RubyLsp::Document::Scanner::SURROGATE_PAIR_START
+              line_length += 1
+            end
+          end
+          line_length
+        else
+          line.length
+        end
+      end
+
+      def correctable?
+        !@offense.corrector.nil?
+      end
+    end
+  end
+end

data/lib/standard/lsp/logger.rb

@@ -1,12 +1,13 @@
 module Standard
   module Lsp
     class Logger
-      def initialize
+      def initialize(prefix: "[server]")
+        @prefix = prefix
         @puts_onces = []
       end
 
       def puts(message)
-        warn("[server] #{message}")
+        warn [@prefix, message].compact.join(" ")
       end
 
       def puts_once(message)

data/lib/standard/lsp/routes.rb

@@ -154,45 +154,12 @@ module Standard
 
       def diagnostic(file_uri, text)
         @text_cache[file_uri] = text
-        offenses = @standardizer.offenses(uri_to_path(file_uri), text)
-
-        lsp_diagnostics = offenses.map { |o|
-          code = o[:cop_name]
-
-          msg = o[:message].delete_prefix(code)
-          loc = o[:location]
-
-          severity = case o[:severity]
-          when "error", "fatal"
-            SEV::ERROR
-          when "warning"
-            SEV::WARNING
-          when "convention"
-            SEV::INFORMATION
-          when "refactor", "info"
-            SEV::HINT
-          else # the above cases fully cover what RuboCop sends at this time
-            logger.puts "Unknown severity: #{severity.inspect}"
-            SEV::HINT
-          end
-
-          {
-            code: code,
-            message: msg,
-            range: {
-              start: {character: loc[:start_column] - 1, line: loc[:start_line] - 1},
-              end: {character: loc[:last_column], line: loc[:last_line] - 1}
-            },
-            severity: severity,
-            source: "standard"
-          }
-        }
 
         {
           method: "textDocument/publishDiagnostics",
           params: {
             uri: file_uri,
-            diagnostics: lsp_diagnostics
+            diagnostics: @standardizer.offenses(uri_to_path(file_uri), text)
           }
         }
       end

data/lib/standard/lsp/server.rb

@@ -13,11 +13,12 @@ module Standard
         @writer = Proto::Transport::Io::Writer.new($stdout)
         @reader = Proto::Transport::Io::Reader.new($stdin)
         @logger = Logger.new
-        @standardizer = Standard::Lsp::Standardizer.new(config, @logger)
+        @standardizer = Standard::Lsp::Standardizer.new(config)
         @routes = Routes.new(@writer, @logger, @standardizer)
       end
 
       def start
+        RuboCop::LSP.enable
         @reader.read do |request|
           if !request.key?(:method)
             @routes.handle_method_missing(request)

data/lib/standard/lsp/standardizer.rb

@@ -1,68 +1,33 @@
-require_relative "../runners/rubocop"
+require_relative "stdin_rubocop_runner"
+require_relative "diagnostic"
 
 module Standard
   module Lsp
     class Standardizer
-      def initialize(config, logger)
-        @config = config
-        @logger = logger
-        @rubocop_runner = Standard::Runners::Rubocop.new
+      def initialize(config)
+        @diagnostic_runner = ::Standard::Lsp::StdinRubocopRunner.new(config)
+        @format_runner = ::Standard::Lsp::StdinRubocopRunner.new(config.dup.tap { |c|
+          c.rubocop_options[:autocorrect] = true
+        })
+        @cop_registry = RuboCop::Cop::Registry.global.to_h
       end
 
-      # This abuses the --stdin option of rubocop and reads the formatted text
-      # from the options[:stdin] that rubocop mutates. This depends on
-      # parallel: false as well as the fact that rubocop doesn't otherwise dup
-      # or reassign that options object. Risky business!
-      #
-      # Reassigning options[:stdin] is done here:
-      #   https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/team.rb#L131
-      # Printing options[:stdin]
-      #   https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cli/command/execute_runner.rb#L95
-      # Setting `parallel: true` would break this here:
-      #   https://github.com/rubocop/rubocop/blob/master/lib/rubocop/runner.rb#L72
       def format(path, text)
-        ad_hoc_config = fork_config(path, text, format: true)
-        capture_rubocop_stdout(ad_hoc_config)
-        ad_hoc_config.rubocop_options[:stdin]
+        @format_runner.run(path, text)
+        @format_runner.formatted_source
       end
 
-      def offenses(path, text)
-        results = JSON.parse(
-          capture_rubocop_stdout(fork_config(path, text, format: false)),
-          symbolize_names: true
-        )
-        if results[:files].empty?
-          @logger.puts_once "Ignoring file, per configuration: #{path}"
-          []
-        else
-          results.dig(:files, 0, :offenses)
-        end
-      end
-
-      private
+      def offenses(path, text, document_encoding = nil)
+        @diagnostic_runner.run(path, text)
 
-      BASE_OPTIONS = {
-        force_exclusion: true,
-        parallel: false,
-        todo_file: nil,
-        todo_ignore_files: []
-      }
-      def fork_config(path, text, format:)
-        options = if format
-          {stdin: text, autocorrect: true, safe_autocorrect: true, formatters: []}
-        else
-          {stdin: text, autocorrect: false, safe_autocorrect: false, formatters: [["json"]], format: "json"}
+        @diagnostic_runner.offenses.map do |offense|
+          Diagnostic.new(
+            document_encoding,
+            offense,
+            path,
+            @cop_registry[offense.cop_name]&.first
+          ).to_lsp_diagnostic(@diagnostic_runner.config_for_working_directory)
         end
-        Standard::Config.new(@config.runner, [path], BASE_OPTIONS.merge(options), @config.rubocop_config_store)
-      end
-
-      def capture_rubocop_stdout(config)
-        redir = StringIO.new
-        $stdout = redir
-        @rubocop_runner.call(config)
-        redir.string
-      ensure
-        $stdout = STDOUT
       end
     end
   end

data/lib/standard/lsp/stdin_rubocop_runner.rb

@@ -0,0 +1,61 @@
+module Standard
+  module Lsp
+    # Originally lifted from:
+    # https://github.com/Shopify/ruby-lsp/blob/8d4c17efce4e8ecc8e7c557ab2981db6b22c0b6d/lib/ruby_lsp/requests/support/rubocop_runner.rb#L20
+    class StdinRubocopRunner < ::RuboCop::Runner
+      class ConfigurationError < StandardError; end
+
+      attr_reader :offenses
+
+      attr_reader :config_for_working_directory
+
+      DEFAULT_RUBOCOP_OPTIONS = {
+        stderr: true,
+        force_exclusion: true,
+        format: "RuboCop::Formatter::BaseFormatter",
+        raise_cop_error: true
+      }.freeze
+
+      def initialize(config)
+        @options = {}
+        @offenses = []
+        @errors = []
+        @warnings = []
+
+        @config_for_working_directory = config.rubocop_config_store.for_pwd
+
+        super(
+          config.rubocop_options.merge(DEFAULT_RUBOCOP_OPTIONS),
+          config.rubocop_config_store
+          )
+      end
+
+      def run(path, contents)
+        @errors = []
+        @warnings = []
+        @offenses = []
+        @options[:stdin] = contents
+
+        super([path])
+
+        raise Interrupt if aborting?
+      rescue ::RuboCop::Runner::InfiniteCorrectionLoop => error
+        raise RubyLsp::Requests::Formatting::Erro, error.message
+      rescue ::RuboCop::ValidationError => error
+        raise ConfigurationError, error.message
+      rescue => error
+        raise ::RubyLsp::Requests::Support::InternalRuboCopError, error
+      end
+
+      def formatted_source
+        @options[:stdin]
+      end
+
+      private
+
+      def file_finished(_file, offenses)
+        @offenses = offenses
+      end
+    end
+  end
+end

data/lib/standard/version.rb

@@ -1,3 +1,3 @@
 module Standard
-  VERSION = Gem::Version.new("1.38.0")
+  VERSION = Gem::Version.new("1.39.0")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard
 version: !ruby/object:Gem::Version
-  version: 1.38.0
+  version: 1.39.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-23 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -139,11 +139,13 @@ files:
 - lib/standard/formatter.rb
 - lib/standard/loads_runner.rb
 - lib/standard/loads_yaml_config.rb
+- lib/standard/lsp/diagnostic.rb
 - lib/standard/lsp/kills_server.rb
 - lib/standard/lsp/logger.rb
 - lib/standard/lsp/routes.rb
 - lib/standard/lsp/server.rb
 - lib/standard/lsp/standardizer.rb
+- lib/standard/lsp/stdin_rubocop_runner.rb
 - lib/standard/merges_settings.rb
 - lib/standard/plugin.rb
 - lib/standard/plugin/combines_plugin_configs.rb