rubocop-lsp 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03b55f861c0619105ceaf9da7ba457972dd562cd41b31409dc0455e8765b6089
-  data.tar.gz: 46df16a989903fad8f80d01e54a428811a2ce85dada49e8cd0cbf8cbbfc01bf3
+  metadata.gz: de59c33976acd6f570c9f4812248e905b8fc8b3ca2c61f5bc1a6acb82d903ee7
+  data.tar.gz: 4af340c2c6c89bdd5c19e152a26e94614ac83e7770387564f936276fc063a5c4
 SHA512:
-  metadata.gz: ea5e70919e3e09b28d4f93cb6074054e826686e1458490338843260a84582deca878f55378485a480a9ee0c285144cce16c8bd3630e45aa27c6dbd6b31a596cc
-  data.tar.gz: 2acdcb7cf4f8e83c24aa62ae6b44214eb64d294baa8f7b91a10a8de2a8634cf596b40eb8dba6aed91daeb96e01c60f5d2d7b00ab8f725e042663b5b51acffd22
+  metadata.gz: 7cb778276e436791c288856e37f36e00ff22293f507368bb0170a3ccf8f0b289ca2f652a15f9eb5b24d28c8a70f3e18fe8732da3590045b252cc9c193a293a8f
+  data.tar.gz: d68688323dd99d361f11fbb7ce070e66b31e5492ef90f7829d536215fb0439e2efa0ffb9bc67df81f410e451c89b3bd149ea629d836b55181cf2debae6aed353

data/.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-  "rubocop-lsp.trace.server": "verbose"
+  // "rubocop-lsp.trace.server": "verbose",
+  "editor.formatOnSave": true
 }

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-lsp (0.1.3)
+    rubocop-lsp (0.1.4)
       language_server-protocol (>= 3.16)
       rubocop (>= 1.0)
 

data/lib/rubocop/lsp/cli.rb

@@ -9,29 +9,19 @@ require "rubocop/lsp/handler"
 module Rubocop
   module Lsp
     module Cli
-      Interface = LanguageServer::Protocol::Interface
-      Constant = LanguageServer::Protocol::Constant
-
       def self.start(_argv)
         handler = Handler.new
 
         handler.config do
           on("initialize") do
-            DiagnosticStore.clear_diagnostics
-            Interface::InitializeResult.new(
-              capabilities: Interface::ServerCapabilities.new(
-                text_document_sync: Interface::TextDocumentSyncOptions.new(
-                  change: Constant::TextDocumentSyncKind::FULL,
-                  open_close: true,
-                ),
-                document_formatting_provider: true,
-                code_action_provider: true
-              ),
-            )
+            store.clear
+
+            respond_with_capabilities
           end
 
           on("shutdown") do
-            DiagnosticStore.clear_diagnostics
+            store.clear
+
             nil
           end
 
@@ -39,7 +29,8 @@ module Rubocop
             uri = request[:params][:textDocument][:uri]
             text = request[:params][:contentChanges][0][:text]
 
-            send_diagnostics(uri: uri, text: text)
+            collector = collect_diagnostics(uri: uri, text: text)
+            send_diagnostics(collector)
 
             nil
           end
@@ -48,7 +39,8 @@ module Rubocop
             uri = request[:params][:textDocument][:uri]
             text = request[:params][:textDocument][:text]
 
-            send_diagnostics(uri: uri, text: text)
+            collector = collect_diagnostics(uri: uri, text: text)
+            send_diagnostics(collector)
 
             nil
           end
@@ -56,28 +48,24 @@ module Rubocop
           on("textDocument/didClose") do |request|
             uri = request[:params][:textDocument][:uri]
 
-            DiagnosticStore.remove_diagnostics_for(uri)
-
-            send_diagnostics(uri: uri, diagnostics: [])
+            clear_diagnostics(uri: uri)
 
             nil
           end
 
           on("textDocument/formatting") do |request|
             uri = request[:params][:textDocument][:uri]
-            file = CGI.unescape(URI.parse(uri).path)
-
-            collector = DiagnosticCollector.new(file: file, text: File.binread(file))
-            collector.run
 
-            collector.text_edits_from_formatting
+            collector = collect_diagnostics(uri: uri, text: store.text_for(uri))
+            send_text_edits(collector)
           end
 
           on("textDocument/codeAction") do |request|
             uri = request[:params][:textDocument][:uri]
             range = request[:params][:range]
+            line_range = Range.new(range[:start][:line], range[:end][:line])
 
-            DiagnosticStore.code_actions_for(uri, range)
+            send_code_actions(uri, line_range)
           end
         end
 

data/lib/rubocop/lsp/diagnostic_collector.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-class DiagnosticCollector < RuboCop::Formatter::BaseFormatter
-  Interface = LanguageServer::Protocol::Interface
-  Constant = LanguageServer::Protocol::Constant
+require "rubocop/lsp/model/diagnostic_collection"
 
-  attr_reader :file, :text, :formatted_text, :diagnostics
+class DiagnosticCollector < RuboCop::Formatter::BaseFormatter
+  attr_reader :uri, :file, :text, :formatted_text, :diagnostics
 
-  def initialize(file:, text:)
+  def initialize(uri:, text:)
     super({}, nil)
-    @file = file
+    @uri = uri
+    @file = CGI.unescape(URI.parse(uri).path)
     @text = text
     @formatted_text = nil
   end
@@ -26,57 +26,6 @@ class DiagnosticCollector < RuboCop::Formatter::BaseFormatter
   end
 
   def file_finished(_file, offenses)
-    @diagnostics = offenses.map do |offense|
-      diagnostic_from_offense(offense)
-    end
-  end
-
-  def text_edits_from_formatting
-    return unless formatted_text
-
-    [
-      Interface::TextEdit.new(
-        range: Interface::Range.new(
-          start: Interface::Position.new(line: 0, character: 0),
-          end: Interface::Position.new(line: text.size, character: text.size)
-        ),
-        new_text: formatted_text
-      ),
-    ]
-  end
-
-  private
-
-  def diagnostic_from_offense(offense)
-    Interface::Diagnostic.new(
-      message: offense.message,
-      severity: Constant::DiagnosticSeverity::INFORMATION,
-      range: Interface::Range.new(
-        start: Interface::Position.new(line: offense.line - 1, character: offense.column),
-        end: Interface::Position.new(line: offense.last_line - 1, character: offense.last_column)
-      ),
-      data: {
-        cop_name: offense.cop_name,
-        edits: replacements_from_offense(offense),
-      }
-    )
-  end
-
-  def replacements_from_offense(offense)
-    return unless offense.correctable?
-
-    offense.corrector.as_replacements.map do |range, replacement|
-      edit_from_replacement(range, replacement)
-    end
-  end
-
-  def edit_from_replacement(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
-    )
+    @diagnostics = Model::DiagnosticCollection.new(uri, offenses)
   end
 end

data/lib/rubocop/lsp/handler.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-require "rubocop/lsp/diagnostic_store"
+require "rubocop/lsp/state_store"
 require "rubocop/lsp/diagnostic_collector"
 
 class Handler
   Interface = LanguageServer::Protocol::Interface
   Constant = LanguageServer::Protocol::Constant
 
-  attr_reader :writer, :reader
-
   def initialize
     @writer = LanguageServer::Protocol::Transport::Stdio::Writer.new
     @reader = LanguageServer::Protocol::Transport::Stdio::Reader.new
     @handlers = {}
+    @store = StateStore.new
   end
 
   def config(&blk)
@@ -27,6 +26,8 @@ class Handler
 
   private
 
+  attr_reader :writer, :reader, :store
+
   def on(message, &blk)
     @handlers[message.to_s] = blk
   end
@@ -51,22 +52,69 @@ class Handler
     writer.write(method: method, params: params)
   end
 
-  def send_diagnostics(uri:, text: nil, diagnostics: [])
-    diagnostics = collect_diagnostics(uri: uri, text: text) if text
+  def respond_with_capabilities
+    Interface::InitializeResult.new(
+      capabilities: Interface::ServerCapabilities.new(
+        text_document_sync: Interface::TextDocumentSyncOptions.new(
+          change: Constant::TextDocumentSyncKind::FULL,
+          open_close: true,
+        ),
+        document_formatting_provider: true,
+        code_action_provider: true
+      ),
+    )
+  end
 
+  def notify_diagnostics(uri:, diagnostics_response:)
     notify(
       method: "textDocument/publishDiagnostics",
       params: Interface::PublishDiagnosticsParams.new(
         uri: uri,
-        diagnostics: diagnostics
+        diagnostics: diagnostics_response
       )
     )
   end
 
+  def clear_diagnostics(uri:)
+    store.delete(uri)
+
+    notify_diagnostics(uri: uri, diagnostics_response: [])
+  end
+
+  def send_diagnostics(collector)
+    notify_diagnostics(
+      uri: collector.uri,
+      diagnostics_response: collector.diagnostics.response
+    )
+  end
+
+  def send_code_actions(uri, line_range)
+    store.code_actions_for(uri, line_range)
+  end
+
+  def send_text_edits(collector)
+    return unless collector.formatted_text
+
+    [
+      Interface::TextEdit.new(
+        range: Interface::Range.new(
+          start: Interface::Position.new(line: 0, character: 0),
+          end: Interface::Position.new(
+            line: collector.text.size,
+            character: collector.text.size
+          )
+        ),
+        new_text: collector.formatted_text
+      ),
+    ]
+  end
+
   def collect_diagnostics(uri:, text:)
-    file = CGI.unescape(URI.parse(uri).path)
-    collector = DiagnosticCollector.new(file: file, text: text)
+    collector = DiagnosticCollector.new(uri: uri, text: text)
     collector.run
-    DiagnosticStore.set_diagnostics_for(uri, collector.diagnostics)
+
+    store.set(uri: collector.uri, text: collector.text, diagnostics: collector.diagnostics)
+
+    collector
   end
 end

data/lib/rubocop/lsp/model/diagnostic.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Model
+  class Diagnostic
+    attr_reader :cop_name, :message, :start, :end, :replacements, :diagnostic_response
+
+    def initialize(offense)
+      @cop_name = offense.cop_name
+      @message = offense.message
+      @start = Interface::Position.new(line: offense.line - 1, character: offense.column)
+      @end = Interface::Position.new(line: offense.last_line - 1, character: offense.last_column)
+      @replacements = replacements_from_offense(offense)
+      @diagnostic_response = diagnostic_from_offense(offense)
+    end
+
+    def correctable?
+      !!@replacements
+    end
+
+    private
+
+    def diagnostic_from_offense(offense)
+      Interface::Diagnostic.new(
+        message: offense.message,
+        severity: Constant::DiagnosticSeverity::INFORMATION,
+        range: Interface::Range.new(
+          start: @start,
+          end: @end
+        )
+      )
+    end
+
+    def replacements_from_offense(offense)
+      return unless offense.correctable?
+
+      offense.corrector.as_replacements.map do |range, replacement|
+        edit_from_replacement(range, replacement)
+      end
+    end
+
+    def edit_from_replacement(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
+end

data/lib/rubocop/lsp/model/diagnostic_collection.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "rubocop/lsp/model/diagnostic"
+
+module Model
+  Interface = LanguageServer::Protocol::Interface
+  Constant = LanguageServer::Protocol::Constant
+
+  class DiagnosticCollection
+    attr_reader :uri, :diagnostics
+
+    def initialize(uri, offenses)
+      @uri = uri
+      @diagnostics = offenses.map do |offense|
+        Diagnostic.new(offense)
+      end
+    end
+
+    def response
+      diagnostics.map(&:diagnostic_response)
+    end
+
+    def correctable_diagnostics
+      @correctable_diagnostics ||= diagnostics.select(&:correctable?)
+    end
+
+    def code_actions(line_range)
+      line_diagnostics = correctable_diagnostics.select do |diagnostic|
+        line_range.include?(diagnostic.start.line)
+      end
+
+      actions = line_diagnostics.map do |diagnostic|
+        code_action_from(
+          diagnostic,
+          title: "Autocorrect `#{diagnostic.cop_name}`",
+          kind: Constant::CodeActionKind::QUICK_FIX
+        )
+      end
+
+      if actions.any?
+        actions << code_action_from(
+          line_diagnostics,
+          title: "Autocorrect all offenses on line",
+          kind: "rubocop.fix"
+        )
+      end
+
+      actions
+    end
+
+    private
+
+    def code_action_from(diagnostics, title:, kind:)
+      diagnostics = Array(diagnostics)
+
+      Interface::CodeAction.new(
+        title: title,
+        kind: "rubocop.fix",
+        edit: Interface::WorkspaceEdit.new(
+          document_changes: [
+            Interface::TextDocumentEdit.new(
+              text_document: Interface::OptionalVersionedTextDocumentIdentifier.new(
+                uri: uri,
+                version: nil
+              ),
+              edits: diagnostics.flat_map(&:replacements)
+            ),
+          ]
+        ),
+        is_preferred: true,
+      )
+    end
+  end
+end

data/lib/rubocop/lsp/state.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class State
+  attr_reader :uri, :text, :diagnostics
+
+  def initialize(uri:, text:, diagnostics: [])
+    @uri = uri
+    @text = text
+    @diagnostics = diagnostics
+  end
+
+  def code_actions(line_range)
+    diagnostics.code_actions(line_range)
+  end
+end

data/lib/rubocop/lsp/state_store.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rubocop/lsp/state"
+
+class StateStore
+  def initialize
+    @state_map = {}
+  end
+
+  def clear
+    @state_map = {}
+  end
+
+  def delete(uri)
+    @state_map.delete(uri)
+    []
+  end
+
+  def set(uri:, text:, diagnostics: [])
+    @state_map[uri] = State.new(uri: uri, text: text, diagnostics: diagnostics || [])
+  end
+
+  def get(uri)
+    @state_map[uri]
+  end
+
+  def text_for(uri)
+    state = get(uri)
+
+    return state.text if state
+
+    file = CGI.unescape(URI.parse(uri).path)
+    File.binread(file)
+  end
+
+  def code_actions_for(uri, line_range)
+    state = get(uri)
+
+    return [] unless state
+
+    state.code_actions(line_range)
+  end
+
+  private
+
+  attr_reader :state_map
+end

data/lib/rubocop/lsp/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Lsp
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-lsp
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -60,8 +60,11 @@ files:
 - lib/rubocop/lsp.rb
 - lib/rubocop/lsp/cli.rb
 - lib/rubocop/lsp/diagnostic_collector.rb
-- lib/rubocop/lsp/diagnostic_store.rb
 - lib/rubocop/lsp/handler.rb
+- lib/rubocop/lsp/model/diagnostic.rb
+- lib/rubocop/lsp/model/diagnostic_collection.rb
+- lib/rubocop/lsp/state.rb
+- lib/rubocop/lsp/state_store.rb
 - lib/rubocop/lsp/version.rb
 - rubocop-lsp.gemspec
 homepage: https://github.com/Shopify/rubocop-lsp

data/lib/rubocop/lsp/diagnostic_store.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module DiagnosticStore
-  @diagnostic_map = {}
-
-  def self.clear_diagnostics
-    @diagnostic_map = {}
-  end
-
-  def self.remove_diagnostics_for(uri)
-    @diagnostic_map.delete(uri)
-    []
-  end
-
-  def self.set_diagnostics_for(uri, diagnostics)
-    @diagnostic_map[uri] = diagnostics
-  end
-
-  def self.diagnostics_for(uri)
-    @diagnostic_map[uri] || []
-  end
-
-  def self.correctable_diagnostics_for(uri)
-    diagnostics_for(uri).reject do |diagnostic|
-      diagnostic.data[:edits].nil?
-    end
-  end
-
-  def self.code_actions_for(uri, range)
-    line_range = Range.new(range[:start][:line], range[:end][:line])
-
-    file_diagnostics = correctable_diagnostics_for(uri)
-    line_diagnostics = file_diagnostics.select { |diagnostic| line_range.include?(diagnostic.range.start.line) }
-    actions = line_diagnostics.map { |diagnostic| code_action_from(uri, diagnostic) }
-
-    unless actions.empty?
-      actions << code_action_from_diagnostics(uri, line_diagnostics, title: "Autocorrect all offenses on line")
-    end
-
-    actions
-  end
-
-  def self.code_action_from_diagnostics(uri, diagnostics, title:)
-    diagnostics = diagnostics.sort_by do |diagnostic|
-      [diagnostic.range.start.line, diagnostic.range.start.character]
-    end
-
-    LanguageServer::Protocol::Interface::CodeAction.new(
-      title: title,
-      kind: "rubocop.fix",
-      edit: LanguageServer::Protocol::Interface::WorkspaceEdit.new(
-        document_changes: [
-          LanguageServer::Protocol::Interface::TextDocumentEdit.new(
-            text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
-              uri: uri,
-              version: nil
-            ),
-            edits: diagnostics.flat_map { |d| d.data[:edits] }
-          ),
-        ]
-      ),
-      is_preferred: true,
-    )
-  end
-
-  def self.code_action_from(uri, diagnostic)
-    LanguageServer::Protocol::Interface::CodeAction.new(
-      title: "Autocorrect `#{diagnostic.data[:cop_name]}`",
-      kind: LanguageServer::Protocol::Constant::CodeActionKind::QUICK_FIX,
-      edit: LanguageServer::Protocol::Interface::WorkspaceEdit.new(
-        document_changes: [
-          LanguageServer::Protocol::Interface::TextDocumentEdit.new(
-            text_document: LanguageServer::Protocol::Interface::OptionalVersionedTextDocumentIdentifier.new(
-              uri: uri,
-              version: nil
-            ),
-            edits: diagnostic.data[:edits]
-          ),
-        ]
-      ),
-      is_preferred: true,
-    )
-  end
-end