rucoa 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceb1c198d4cc4deef7d9b122f4d50ca77c4c9e57713b96069278d7b827f9ba05
-  data.tar.gz: 7d826934f96b44bfbde2f0b75670b4d6678c665c6651f5ece3b463150dbd985f
+  metadata.gz: 76603729adc41973a6692fa067867eefa24f1724afa9d972f224dc34338cf925
+  data.tar.gz: d5c4a1c8001121bafbb9a768f8c5d91d6ae66a737e8b415572756772450d9ba1
 SHA512:
-  metadata.gz: 76179fc8d424e84b810ed46135a9a39f403e4799dece8743bf44c48adf478b0467c0774c6827312868c5e4f41baa98b161448e3442e24f9c04b5836d0b390982
-  data.tar.gz: 9ffa4f84e54f7592cdb669934778b1a2d0e23cc6b3ea356a189e62daf935bb54dc69f10095bddd8a93f797ec7b5e308cecf9923d78154c2c1634798b344cd512
+  metadata.gz: de17db3774a60396fa40a307cf1d34c73db06b55afa9a3e2e2cae2085f1aeef07e459ace8149cf668e0cee47ca940a29066c963e599633e6c647dee31c36b1a0
+  data.tar.gz: c309425209a6146a1ea4031f57b752bcef0ce7fe25f965704d6a334194000e8aa96a94aaad992bed04ddc200397ee9790349e0d5e94998703eaeafa4fd8f3558

data/.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - sevencop
 
 AllCops:
   NewCops: enable
@@ -25,6 +26,9 @@ RSpec/MultipleMemoizedHelpers:
 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.2.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

@@ -33,12 +33,13 @@ gem install rucoa
 ## Features
 
 - Diagnostics
+- Formatting
+- Quick Fix
 - Selection Ranges (experimental)
 
 ### Coming soon
 
 - Completion
 - Documentation
-- Formatting
 - Highlight
 - Go to Definition

data/lib/rucoa/code_action_provider.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Rucoa
+  class CodeActionProvider
+    class << self
+      # @param diagnostics [Array<Hash>]
+      # @return [Array<Hash>]
+      def call(diagnostics:)
+        new(diagnostics: diagnostics).call
+      end
+    end
+
+    # @param diagnostics [Array<Hash>]
+    def initialize(diagnostics:)
+      @diagnostics = diagnostics
+    end
+
+    # @return [Array<Hash>]
+    def call
+      correctable_diagnostics.map do |diagnostic|
+        DiagnosticToCodeActionMapper.call(diagnostic)
+      end
+    end
+
+    private
+
+    # @return [Array<Hash>]
+    def correctable_diagnostics
+      @diagnostics.select do |diagnostic|
+        diagnostic.dig('data', 'edits')
+      end
+    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

data/lib/rucoa/diagnostic_provider.rb

@@ -1,22 +1,35 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module Rucoa
   class DiagnosticProvider
     # @param source [Rucoa::Source]
+    # @param uri [String]
     # @return [Array<Hash>]
-    def self.call(source:)
-      new(source: source).call
+    def self.call(source:, uri:)
+      new(
+        source: source,
+        uri: uri
+      ).call
     end
 
     # @param source [Rucoa::Source]
-    def initialize(source:)
+    # @param uri [String]
+    def initialize(source:, uri:)
       @source = source
+      @uri = uri
     end
 
     # @return [Array<Hash>]
     def call
+      return [] unless rubocop_configured?
+
       offenses.map do |offense|
-        OffenseToDiagnosticMapper.call(offense: offense)
+        OffenseToDiagnosticMapper.call(
+          offense,
+          uri: @uri
+        )
       end
     end
 
@@ -24,7 +37,27 @@ module Rucoa
 
     # @return [Array<RuboCop::Cop::Offense>]
     def offenses
-      RubocopRunner.call(path: @source.path)
+      RubocopInvestigator.call(source: @source)
+    end
+
+    # @return [Boolean]
+    def rubocop_configured?
+      each_ancestor_pathname.any? do |pathname|
+        pathname.join('.rubocop.yml').exist?
+      end
+    end
+
+    # @return [Enumerable<Pathname>]
+    def each_ancestor_pathname
+      return to_enum(__method__) unless block_given?
+
+      pathname = ::Pathname.new(@source.path)
+      loop do
+        pathname = pathname.parent
+        yield pathname
+        break if pathname.root?
+      end
+      self
     end
 
     class OffenseToDiagnosticMapper
@@ -48,15 +81,18 @@ module Rucoa
 
       class << self
         # @param offense [RuboCop::Cop::Offense]
+        # @param uri [String]
         # @return [Hash]
-        def call(offense:)
-          new(offense: offense).call
+        def call(offense, uri:)
+          new(offense, uri: uri).call
         end
       end
 
       # @param offense [RuboCop::Cop::Offense]
-      def initialize(offense:)
+      # @param uri [String]
+      def initialize(offense, uri:)
         @offense = offense
+        @uri = uri
       end
 
       # @return [Hash]
@@ -82,12 +118,23 @@ module Rucoa
       def data
         {
           cop_name: @offense.cop_name,
-          correctable: @offense.correctable?,
+          edits: edits,
           path: @offense.location.source_buffer.name,
-          range: range
+          range: range,
+          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}: ")
@@ -95,7 +142,7 @@ module Rucoa
 
       # @return [Hash]
       def range
-        Range.from_rubocop_offense(@offense).to_vscode_range
+        Range.from_parser_range(@offense.location).to_vscode_range
       end
 
       # @return [Integer]

data/lib/rucoa/formatting_provider.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rucoa
+  class FormattingProvider
+    class << self
+      # @param source [Rucoa::Source]
+      # @return [Array<Hash>]
+      def call(source:)
+        new(source: source).call
+      end
+    end
+
+    # @param source [Rucoa::Source]
+    def initialize(source:)
+      @source = source
+    end
+
+    # @return [Array<Hash>]
+    def call
+      [text_edit]
+    end
+
+    private
+
+    # @return [Hash]
+    def text_edit
+      {
+        newText: new_text,
+        range: range
+      }
+    end
+
+    # @return [String]
+    def new_text
+      RubocopAutocorrector.call(source: @source)
+    end
+
+    # @return [Hash]
+    def range
+      Range.new(
+        Position.new(
+          column: 0,
+          line: 1
+        ),
+        Position.new(
+          column: @source.content.lines.last.length,
+          line: @source.content.lines.count + 1
+        )
+      ).to_vscode_range
+    end
+  end
+end

data/lib/rucoa/range.rb

@@ -7,17 +7,8 @@ module Rucoa
       # @return [Rucoa::Range]
       def from_parser_range(range)
         new(
-          Position.from_parser_range_beginning(range.begin),
-          Position.from_parser_range_beginning(range.end)
-        )
-      end
-
-      # @param offense [RuboCop::Cop::Offense]
-      # @return [Rucoa::Range]
-      def from_rubocop_offense(offense)
-        new(
-          Position.from_parser_range_beginning(offense.location),
-          Position.from_parser_range_ending(offense.location)
+          Position.from_parser_range_beginning(range),
+          Position.from_parser_range_ending(range)
         )
       end
     end

data/lib/rucoa/rubocop_autocorrector.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Rucoa
+  class RubocopAutocorrector < ::RuboCop::Runner
+    class << self
+      # @param source [Rucoa::Source]
+      # @return [String]
+      def call(source:)
+        new(source: source).call
+      end
+    end
+
+    # @param source [Rucoa::Source]
+    def initialize(source:)
+      @source = source
+      super(
+        ::RuboCop::Options.new.parse(
+          %w[
+            --stderr
+            --force-exclusion
+            --format RuboCop::Formatter::BaseFormatter
+            -A
+          ]
+        ).first,
+        ::RuboCop::ConfigStore.new
+      )
+    end
+
+    # @return [String]
+    def call
+      @options[:stdin] = @source.content
+      run([@source.path])
+      @options[:stdin]
+    end
+  end
+end

data/lib/rucoa/{rubocop_runner.rb → rubocop_investigator.rb}

@@ -3,18 +3,18 @@
 require 'rubocop'
 
 module Rucoa
-  class RubocopRunner < ::RuboCop::Runner
+  class RubocopInvestigator < ::RuboCop::Runner
     class << self
-      # @param path [String]
+      # @param source [Rucoa::Source]
       # @return [Array<RuboCop::Cop::Offense>]
-      def call(path:)
-        new(path: path).call
+      def call(source:)
+        new(source: source).call
       end
     end
 
-    # @param path [String]
-    def initialize(path:)
-      @path = path
+    # @param source [Rucoa::Source]
+    def initialize(source:)
+      @source = source
       @offenses = []
       super(
         ::RuboCop::Options.new.parse(
@@ -30,7 +30,8 @@ module Rucoa
 
     # @return [Array<RuboCop::Cop::Offense>]
     def call
-      run([@path])
+      @options[:stdin] = @source.content
+      run([@source.path])
       @offenses
     end
 

data/lib/rucoa/server.rb

@@ -31,10 +31,14 @@ module Rucoa
       case request['method']
       when 'initialize'
         on_initialize(request)
+      when 'textDocument/codeAction'
+        on_text_document_code_action(request)
       when 'textDocument/didChange'
         on_text_document_did_change(request)
       when 'textDocument/didOpen'
         on_text_document_did_open(request)
+      when 'textDocument/formatting'
+        on_text_document_formatting(request)
       when 'textDocument/selectionRange'
         on_text_document_selection_range(request)
       end
@@ -61,15 +65,13 @@ module Rucoa
     # @param uri [String]
     # @return [void]
     def investigate_diagnostics(uri:)
-      diagnostics = DiagnosticProvider.call(
-        source: @source_store.get(uri)
-      )
-      return if diagnostics.empty?
-
       @writer.write(
         method: 'textDocument/publishDiagnostics',
         params: {
-          diagnostics: diagnostics,
+          diagnostics: DiagnosticProvider.call(
+            source: @source_store.get(uri),
+            uri: uri
+          ),
           uri: uri
         }
       )
@@ -80,17 +82,30 @@ module Rucoa
     def on_initialize(_request)
       {
         capabilities: {
+          codeActionProvider: true,
+          documentFormattingProvider: true,
+          selectionRangeProvider: true,
           textDocumentSync: {
             change: 1, # Full
             openClose: true
-          },
-          selectionRangeProvider: true
+          }
         }
       }
     end
 
     # @param request [Hash]
-    # @return [Array<Hash>]
+    # @return [Array<Hash>, nil]
+    def on_text_document_code_action(request)
+      diagnostics = request.dig('params', 'context', 'diagnostics')
+      return unless diagnostics
+
+      CodeActionProvider.call(
+        diagnostics: diagnostics
+      )
+    end
+
+    # @param request [Hash]
+    # @return [nil]
     def on_text_document_did_change(request)
       uri = request.dig('params', 'textDocument', 'uri')
       @source_store.set(
@@ -102,7 +117,7 @@ module Rucoa
     end
 
     # @param request [Hash]
-    # @return [Array<Hash>]
+    # @return [nil]
     def on_text_document_did_open(request)
       uri = request.dig('params', 'textDocument', 'uri')
       @source_store.set(
@@ -113,6 +128,18 @@ module Rucoa
       nil
     end
 
+    # @param request [Hash]
+    # @return [Array<Hash>, nil]
+    def on_text_document_formatting(request)
+      uri = request.dig('params', 'textDocument', 'uri')
+      source = @source_store.get(uri)
+      return unless source
+
+      FormattingProvider.call(
+        source: source
+      )
+    end
+
     # @param request [Hash]
     # @return [Array<Hash>, nil]
     def on_text_document_selection_range(request)

data/lib/rucoa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rucoa
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/rucoa.rb

@@ -4,16 +4,19 @@ require_relative 'rucoa/version'
 
 module Rucoa
   autoload :Cli, 'rucoa/cli'
-  autoload :Errors, 'rucoa/errors'
+  autoload :CodeActionProvider, 'rucoa/code_action_provider'
   autoload :DiagnosticProvider, 'rucoa/diagnostic_provider'
+  autoload :Errors, 'rucoa/errors'
+  autoload :FormattingProvider, 'rucoa/formatting_provider'
   autoload :MessageReader, 'rucoa/message_reader'
   autoload :MessageWriter, 'rucoa/message_writer'
   autoload :Nodes, 'rucoa/nodes'
-  autoload :ParserBuilder, 'rucoa/parser_builder'
   autoload :Parser, 'rucoa/parser'
+  autoload :ParserBuilder, 'rucoa/parser_builder'
   autoload :Position, 'rucoa/position'
   autoload :Range, 'rucoa/range'
-  autoload :RubocopRunner, 'rucoa/rubocop_runner'
+  autoload :RubocopAutocorrector, 'rucoa/rubocop_autocorrector'
+  autoload :RubocopInvestigator, 'rucoa/rubocop_investigator'
   autoload :SelectionRangeProvider, 'rucoa/selection_range_provider'
   autoload :Server, 'rucoa/server'
   autoload :Source, 'rucoa/source'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-03 00:00:00.000000000 Z
+date: 2022-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -57,8 +57,10 @@ files:
 - exe/rucoa
 - lib/rucoa.rb
 - lib/rucoa/cli.rb
+- lib/rucoa/code_action_provider.rb
 - lib/rucoa/diagnostic_provider.rb
 - lib/rucoa/errors.rb
+- lib/rucoa/formatting_provider.rb
 - lib/rucoa/message_reader.rb
 - lib/rucoa/message_writer.rb
 - lib/rucoa/nodes.rb
@@ -68,7 +70,8 @@ files:
 - lib/rucoa/parser_builder.rb
 - lib/rucoa/position.rb
 - lib/rucoa/range.rb
-- lib/rucoa/rubocop_runner.rb
+- lib/rucoa/rubocop_autocorrector.rb
+- lib/rucoa/rubocop_investigator.rb
 - lib/rucoa/selection_range_provider.rb
 - lib/rucoa/server.rb
 - lib/rucoa/source.rb