rucoa 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceb1c198d4cc4deef7d9b122f4d50ca77c4c9e57713b96069278d7b827f9ba05
-  data.tar.gz: 7d826934f96b44bfbde2f0b75670b4d6678c665c6651f5ece3b463150dbd985f
+  metadata.gz: 1656b3603d72a44829a30fd9bd0d0d876ab9daa3af05cad16ad78298fa6fce7d
+  data.tar.gz: ff2fffdb7e90ed0f23cf782bc5c25db77dabb327c3e5b1d0a92aad8d2a5dc201
 SHA512:
-  metadata.gz: 76179fc8d424e84b810ed46135a9a39f403e4799dece8743bf44c48adf478b0467c0774c6827312868c5e4f41baa98b161448e3442e24f9c04b5836d0b390982
-  data.tar.gz: 9ffa4f84e54f7592cdb669934778b1a2d0e23cc6b3ea356a189e62daf935bb54dc69f10095bddd8a93f797ec7b5e308cecf9923d78154c2c1634798b344cd512
+  metadata.gz: 49421faba6f35b3cf0bd33c12ae521cf55125fc8c8b044f5a4d353b4ee9413150b0ca4082884e786329b1cefa3cb5eb5ab513b9723e638cb9786ab768d2f8dd0
+  data.tar.gz: 8ef7dfaf46a49d70eb9404558191aadb3e1778f761a4642c432b53c9e3b1f208ff57f64a5b43ec7aef527dc4b573baaed10f4d859043574e86452b0af60aecb4

data/.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - sevencop
 
 AllCops:
   NewCops: enable
@@ -19,12 +20,18 @@ RSpec/ExampleLength:
 RSpec/ImplicitSubject:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 
 RSpec/NamedSubject:
   Enabled: false
 
+Sevencop/HashLiteralOrder:
+  Enabled: true
+
 Style/Documentation:
   Enabled: false
 

data/Gemfile

@@ -10,3 +10,4 @@ gem 'rubocop'
 gem 'rubocop-performance'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'sevencop'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rucoa (0.1.0)
+    rucoa (0.4.0)
       parser
       rubocop
 
@@ -51,6 +51,8 @@ GEM
     rubocop-rspec (2.12.1)
       rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
+    sevencop (0.9.3)
+      rubocop
     unicode-display_width (2.2.0)
 
 PLATFORMS
@@ -64,6 +66,7 @@ DEPENDENCIES
   rubocop-rake
   rubocop-rspec
   rucoa!
+  sevencop
 
 BUNDLED WITH
    2.3.21

data/README.md

@@ -6,7 +6,7 @@ Language server for Ruby.
 
 ## Usage
 
-Install both rucoa gem and [vscode-rucoa](https://github.com/r7kamura/vscode-rucoa) extension, then open your Ruby project in VSCode.
+Install both rucoa gem and [vscode-rucoa](https://marketplace.visualstudio.com/items?itemName=r7kamura.vscode-rucoa) extension, then open your Ruby project in VSCode.
 
 To install rucoa gem, if your project is managed by bundler, add to your Gemfile:
 
@@ -33,12 +33,15 @@ gem install rucoa
 ## Features
 
 - Diagnostics
-- Selection Ranges (experimental)
+- Formatting
+- Quick Fix
+- Selection Range
+- Symbol
 
 ### Coming soon
 
 - Completion
 - Documentation
-- Formatting
-- Highlight
 - Go to Definition
+- Highlight
+- Semantic Tokens

data/lib/rucoa/cli.rb

@@ -16,8 +16,8 @@ module Rucoa
     # @return [void]
     def call
       Server.new(
-        reader: $stdin,
-        writer: $stdout
+        input: $stdin,
+        output: $stdout
       ).start
     end
   end

data/lib/rucoa/configuration.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Rucoa
+  class Configuration
+    DEFAULT_SETTINGS = {
+      'base' => {
+        'enable' => 'auto',
+        'useBundler' => 'auto'
+      },
+      'feature' => {
+        'codeAction' => {
+          'enable' => true
+        },
+        'diagnostics' => {
+          'enable' => true
+        },
+        'documentSymbol' => {
+          'enable' => true
+        },
+        'formatting' => {
+          'enable' => true
+        },
+        'selectionRange' => {
+          'enable' => true
+        }
+      }
+    }.freeze
+
+    def initialize
+      reset
+    end
+
+    # @return [Boolean]
+    def enables_code_action?
+      @settings.dig('feature', 'codeAction', 'enable')
+    end
+
+    # @return [Boolean]
+    def enables_diagnostics?
+      @settings.dig('feature', 'diagnostics', 'enable')
+    end
+
+    # @return [Boolean]
+    def enables_document_symbol?
+      @settings.dig('feature', 'documentSymbol', 'enable')
+    end
+
+    # @return [Boolean]
+    def enables_formatting?
+      @settings.dig('feature', 'formatting', 'enable')
+    end
+
+    # @return [Boolean]
+    def enables_selection_range?
+      @settings.dig('feature', 'selectionRange', 'enable')
+    end
+
+    # @param settings [Hash]
+    # @return [void]
+    def update(settings)
+      @settings = settings
+    end
+
+    private
+
+    # @return [void]
+    def reset
+      @settings = DEFAULT_SETTINGS.dup
+    end
+  end
+end

data/lib/rucoa/handler_concerns/configuration_requestable.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module HandlerConcerns
+    module ConfigurationRequestable
+      include HandlerConcerns::DiagnosticsPublishable
+
+      private
+
+      # @return [void]
+      def request_workspace_configuration
+        write(
+          method: 'workspace/configuration',
+          params: {
+            items: [
+              {
+                section: 'rucoa'
+              }
+            ]
+          }
+        ) do |response|
+          configuration.update(response['result'][0])
+          publish_diagnostics_on_each_source
+        end
+      end
+
+      # @return [void]
+      def publish_diagnostics_on_each_source
+        source_store.each_uri do |uri|
+          publish_diagnostics_on(uri)
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/handler_concerns/diagnostics_publishable.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module HandlerConcerns
+    module DiagnosticsPublishable
+      private
+
+      # @param uri [String]
+      # @return [Array<Hash>]
+      def diagnostics_on(uri)
+        return [] unless configuration.enables_diagnostics?
+
+        DiagnosticProvider.call(
+          source: source_store.get(uri),
+          uri: uri
+        )
+      end
+
+      # @param uri [String]
+      # @return [void]
+      def publish_diagnostics_on(uri)
+        write(
+          method: 'textDocument/publishDiagnostics',
+          params: {
+            diagnostics: diagnostics_on(uri),
+            uri: uri
+          }
+        )
+      end
+
+      class DiagnosticProvider
+        # @param source [Rucoa::Source]
+        # @param uri [String]
+        # @return [Array<Hash>]
+        def self.call(source:, uri:)
+          new(
+            source: source,
+            uri: uri
+          ).call
+        end
+
+        # @param source [Rucoa::Source]
+        # @param uri [String]
+        def initialize(source:, uri:)
+          @source = source
+          @uri = uri
+        end
+
+        # @return [Array<Hash>]
+        def call
+          return [] unless RubocopConfigurationChecker.call
+
+          offenses.map do |offense|
+            OffenseToDiagnosticMapper.call(
+              offense,
+              source: @source,
+              uri: @uri
+            )
+          end
+        end
+
+        private
+
+        # @return [Array<RuboCop::Cop::Offense>]
+        def offenses
+          RubocopInvestigator.call(source: @source)
+        end
+
+        class OffenseToDiagnosticMapper
+          LSP_SEVERITY_NAME_TO_VALUE_MAP = {
+            error: 1,
+            hint: 4,
+            information: 3,
+            warning: 2
+          }.freeze
+          private_constant :LSP_SEVERITY_NAME_TO_VALUE_MAP
+
+          RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP = {
+            convention: LSP_SEVERITY_NAME_TO_VALUE_MAP[:information],
+            error: LSP_SEVERITY_NAME_TO_VALUE_MAP[:error],
+            fatal: LSP_SEVERITY_NAME_TO_VALUE_MAP[:error],
+            info: LSP_SEVERITY_NAME_TO_VALUE_MAP[:information],
+            refactor: LSP_SEVERITY_NAME_TO_VALUE_MAP[:hint],
+            warning: LSP_SEVERITY_NAME_TO_VALUE_MAP[:warning]
+          }.freeze
+          private_constant :RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP
+
+          class << self
+            # @param offense [RuboCop::Cop::Offense]
+            # @param source [Rucoa::Source]
+            # @param uri [String]
+            # @return [Hash]
+            def call(offense, source:, uri:)
+              new(
+                offense,
+                source: source,
+                uri: uri
+              ).call
+            end
+          end
+
+          # @param offense [RuboCop::Cop::Offense]
+          # @param source [Rucoa::Source]
+          # @param uri [String]
+          def initialize(offense, source:, uri:)
+            @offense = offense
+            @source = source
+            @uri = uri
+          end
+
+          # @return [Hash]
+          def call
+            {
+              code: code,
+              data: data,
+              message: message,
+              range: range,
+              severity: severity,
+              source: source
+            }
+          end
+
+          private
+
+          # @return [String]
+          def code
+            @offense.cop_name
+          end
+
+          # @return [Hash]
+          def data
+            {
+              cop_name: @offense.cop_name,
+              edits: edits,
+              uri: @uri
+            }
+          end
+
+          # @return [Array<Hash>, nil]
+          def edits
+            @offense.corrector&.as_replacements&.map do |range, replacement|
+              {
+                newText: replacement,
+                range: Range.from_parser_range(range).to_vscode_range
+              }
+            end
+          end
+
+          # @return [String]
+          def message
+            @offense.message.delete_prefix("#{@offense.cop_name}: ")
+          end
+
+          # @return [Hash]
+          def range
+            Range.from_parser_range(@offense.location).to_vscode_range
+          end
+
+          # @return [Integer]
+          def severity
+            RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP.fetch(@offense.severity.name, 1)
+          end
+
+          # @return [String]
+          def source
+            'RuboCop'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/handler_concerns.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module HandlerConcerns
+    autoload :ConfigurationRequestable, 'rucoa/handler_concerns/configuration_requestable'
+    autoload :DiagnosticsPublishable, 'rucoa/handler_concerns/diagnostics_publishable'
+  end
+end

data/lib/rucoa/handlers/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class Base
+      class << self
+        # @param server [Rucoa::Server]
+        # @param request [Hash]
+        # @return [void]
+        def call(request:, server:)
+          new(
+            request: request,
+            server: server
+          ).call
+        end
+      end
+
+      # @param request [Hash]
+      # @param server [Rucoa::Server]
+      def initialize(request:, server:)
+        @request = request
+        @server = server
+      end
+
+      # @return [void]
+      def call
+        raise ::NotImplementedError
+      end
+
+      private
+
+      # @return [Hash]
+      attr_reader :request
+
+      # @param message [Hash]
+      # @return [void]
+      def respond(message)
+        write(
+          id: request['id'],
+          result: message
+        )
+      end
+
+      # @return [Rucoa::Configuration]
+      def configuration
+        @server.configuration
+      end
+
+      # @return [Rucoa::SourceStore]
+      def source_store
+        @server.source_store
+      end
+
+      # @param message [Hash]
+      # @return [void]
+      def write(message, &block)
+        @server.write(message, &block)
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/initialize_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class InitializeHandler < Base
+      def call
+        respond(
+          capabilities: {
+            codeActionProvider: true,
+            documentFormattingProvider: true,
+            documentRangeFormattingProvider: true,
+            documentSymbolProvider: true,
+            selectionRangeProvider: true,
+            textDocumentSync: {
+              change: 1, # Full
+              openClose: true
+            }
+          }
+        )
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/initialized_handler.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class InitializedHandler < Base
+      include HandlerConcerns::ConfigurationRequestable
+
+      def call
+        request_workspace_configuration
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/text_document_code_action_handler.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentCodeActionHandler < Base
+      def call
+        return unless diagnostics
+
+        respond(code_actions)
+      end
+
+      private
+
+      # @return [Array<Hash>]
+      def code_actions
+        return [] unless configuration.enables_code_action?
+
+        correctable_diagnostics.map do |diagnostic|
+          DiagnosticToCodeActionMapper.call(diagnostic)
+        end
+      end
+
+      # @return [Array<Hash>]
+      def correctable_diagnostics
+        diagnostics.select do |diagnostic|
+          diagnostic.dig('data', 'edits')
+        end
+      end
+
+      # @return [Array<Hash>, nil]
+      def diagnostics
+        @diagnostics ||= request.dig('params', 'context', 'diagnostics')
+      end
+
+      class DiagnosticToCodeActionMapper
+        class << self
+          # @param diagnostic [Hash]
+          # @return [Hash]
+          def call(diagnostic)
+            new(diagnostic).call
+          end
+        end
+
+        # @param diagnostic [Hash]
+        def initialize(diagnostic)
+          @diagnostic = diagnostic
+        end
+
+        # @return [Hash]
+        def call
+          {
+            diagnostics: diagnostics,
+            edit: edit,
+            isPreferred: preferred?,
+            kind: kind,
+            title: title
+          }
+        end
+
+        private
+
+        # @return [Hash]
+        def edit
+          {
+            documentChanges: [
+              {
+                edits: @diagnostic.dig('data', 'edits'),
+                textDocument: {
+                  uri: @diagnostic.dig('data', 'uri'),
+                  version: nil
+                }
+              }
+            ]
+          }
+        end
+
+        # @return [String]
+        def cop_name
+          @diagnostic.dig('data', 'cop_name')
+        end
+
+        # @return [Array]
+        def diagnostics
+          [@diagnostic]
+        end
+
+        # @return [Boolean]
+        def preferred?
+          true
+        end
+
+        # @return [String]
+        def kind
+          'quickfix'
+        end
+
+        # @return [String]
+        def title
+          "Autocorrect #{cop_name}"
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/text_document_did_change_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentDidChangeHandler < Base
+      include HandlerConcerns::DiagnosticsPublishable
+
+      def call
+        update_source
+        publish_diagnostics_on(uri)
+      end
+
+      private
+
+      # @return [void]
+      def update_source
+        source_store.set(uri, text)
+      end
+
+      # @return [String]
+      def text
+        request.dig('params', 'contentChanges')[0]['text']
+      end
+
+      # @return [String]
+      def uri
+        @uri ||= request.dig('params', 'textDocument', 'uri')
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/text_document_did_open_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentDidOpenHandler < Base
+      include HandlerConcerns::DiagnosticsPublishable
+
+      def call
+        update_source
+        publish_diagnostics_on(uri)
+      end
+
+      private
+
+      # @return [void]
+      def update_source
+        source_store.set(uri, text)
+      end
+
+      # @return [String]
+      def text
+        request.dig('params', 'textDocument', 'text')
+      end
+
+      # @return [String]
+      def uri
+        @uri ||= request.dig('params', 'textDocument', 'uri')
+      end
+    end
+  end
+end