rucoa 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ffd244eb4ed0935120e2d33a03798897a4880e06ff999c1779a920e4926215c
-  data.tar.gz: fe7296dba2ff6d185a729e6649cd9630a5644961837d28306f3a5a193643d38e
+  metadata.gz: f31a0a81d1013267e3bfc0358911e1306e22f0b34f40249604050914da18d8f4
+  data.tar.gz: b999e9fe78ee1dbb0b11662756c84399b474fb8522476429c90becb454fb0fd1
 SHA512:
-  metadata.gz: 9f9965f568980d2f069a5670dcf5e008986399b8826a331410bdd0f31cacf10a01068bc8e37109241ccd2c1e79bf9f0bc639600b7608260fffd02b07251e310b
-  data.tar.gz: 1143b279fbbf845f07f0654b37eadf20226d96b1dc930ceea5fd9fc3daf90b6bd786d3a55c08b9601019d85b0e79284de1268de5ed628136cb0097be3e6af846
+  metadata.gz: 1af0f2fed0d7d7930f69768234263e77707f1f22d80e93392ae126c0cfa72d11b3356de6ba5c6f3476ff7b3f27239c1667ac1c2442e9e12301bdadb0a25fec47
+  data.tar.gz: bdd44ba9cb0284a16589798ec20ee7d9e9bf01989e054108859f3f8286a3f6382a45d84be056dd7a755de8b14d4cf9e28610652489e8e57f9c009b1f81c7f432

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rucoa (0.5.1)
+    rucoa (0.6.0)
       parser
       rbs
       rubocop

data/README.md

@@ -15,15 +15,6 @@ To install rucoa gem, if your project is managed by bundler, add to your Gemfile
 gem 'rucoa'
 ```
 
-or in Rails application, we'll recommend you to do like this:
-
-```ruby
-# Gemfile
-group :development do
-  gem 'rucoa', require: false
-end
-```
-
 If bundler is not being used to manage dependencies, simply install the gem:
 
 ```bash
@@ -65,14 +56,22 @@ This extension supports the folowiing types of symbols:
 
 ![demo](images/document-symbol.gif)
 
-### Signature help (experimental)
+## Experimental features
+
+### Completion
+
+Provides completion items for constant names and method names.
+
+### Hover
+
+Shows documentation for the symbol under the cursor.
+
+### Signature help
 
 Shows method signature help when you start to type method arguments like `"100".to_i(`.
 
-### Coming soon
+## Coming soon
 
-- Completion
-- Documentation
 - Go to Definition
 - Highlight
 - Semantic Tokens

data/lib/rucoa/cli.rb

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

data/lib/rucoa/configuration.rb

@@ -8,62 +8,108 @@ module Rucoa
 
     # @return [void]
     def disable_code_action
-      disable('codeAction')
+      disable_feature('codeAction')
+    end
+
+    # @return [void]
+    def disable_completion
+      disable_feature('completion')
     end
 
     # @return [void]
     def disable_diagnostics
-      disable('diagnostics')
+      disable_feature('diagnostics')
     end
 
     # @return [void]
     def disable_document_symbol
-      disable('documentSymbol')
+      disable_feature('documentSymbol')
     end
 
     # @return [void]
     def disable_formatting
-      disable('formatting')
+      disable_feature('formatting')
+    end
+
+    # @return [void]
+    def disable_hover
+      disable_feature('hover')
     end
 
     # @return [void]
     def disable_selection_range
-      disable('selectionRange')
+      disable_feature('selectionRange')
     end
 
     # @return [void]
     def disable_signature_help
-      disable('signatureHelp')
+      disable_feature('signatureHelp')
+    end
+
+    # @return [void]
+    def enable_debug
+      @settings ||= {}
+      @settings['base'] ||= {}
+      @settings['base']['debug'] = true
     end
 
     # @return [Boolean]
+    # @example returns false if the configuration is empty
+    #   configuration = Rucoa::Configuration.new
+    #   expect(configuration).not_to be_enables_debug
+    # @example returns true if the configuration enables debug
+    #   configuration = Rucoa::Configuration.new
+    #   configuration.update('base' => { 'debug' => true })
+    #   expect(configuration).to be_enables_debug
+    def enables_debug?
+      fetch('base', 'debug', default: false)
+    end
+
+    # @return [Boolean]
+    # @example returns true if the configuration is empty
+    #   configuration = Rucoa::Configuration.new
+    #   expect(configuration).to be_enables_code_action
+    # @example returns false if the configuration disables code action
+    #   configuration = Rucoa::Configuration.new
+    #   configuration.disable_code_action
+    #   expect(configuration).not_to be_enables_code_action
     def enables_code_action?
-      enables?('codeAction')
+      enables_feature?('codeAction')
+    end
+
+    # @return [Boolean]
+    def enables_completion?
+      enables_feature?('completion')
     end
 
     # @return [Boolean]
     def enables_diagnostics?
-      enables?('diagnostics')
+      enables_feature?('diagnostics')
     end
 
     # @return [Boolean]
     def enables_document_symbol?
-      enables?('documentSymbol')
+      enables_feature?('documentSymbol')
     end
 
     # @return [Boolean]
     def enables_formatting?
-      enables?('formatting')
+      enables_feature?('formatting')
+    end
+
+    # @return [Boolean]
+    def enables_hover?
+      enables_feature?('hover')
     end
 
     # @return [Boolean]
     def enables_selection_range?
-      enables?('selectionRange')
+      enables_feature?('selectionRange')
     end
 
     # @return [Boolean]
     def enables_signature_help?
-      enables?('signatureHelp')
+      enables_feature?('signatureHelp')
     end
 
     # @param settings [Hash]
@@ -76,7 +122,7 @@ module Rucoa
 
     # @param feature [String]
     # @return [void]
-    def disable(feature)
+    def disable_feature(feature)
       @settings ||= {}
       @settings['feature'] ||= {}
       @settings['feature'][feature] ||= {}
@@ -85,10 +131,17 @@ module Rucoa
 
     # @param feature [String]
     # @return [Boolean]
-    def enables?(feature)
-      value = @settings.dig('feature', feature, 'enable')
+    def enables_feature?(feature)
+      fetch('feature', feature, 'enable', default: true)
+    end
+
+    # @param keys [Array<String>]
+    # @param default [Object]
+    # @return [Object]
+    def fetch(*keys, default:)
+      value = @settings.dig(*keys)
       if value.nil?
-        true
+        default
       else
         value
       end

data/lib/rucoa/handlers/initialize_handler.rb

@@ -7,9 +7,16 @@ module Rucoa
         respond(
           capabilities: {
             codeActionProvider: true,
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: %w[
+                .
+              ]
+            },
             documentFormattingProvider: true,
             documentRangeFormattingProvider: true,
             documentSymbolProvider: true,
+            hoverProvider: true,
             selectionRangeProvider: true,
             signatureHelpProvider: {
               triggerCharacters: %w[

data/lib/rucoa/handlers/text_document_completion_handler.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentCompletionHandler < Base
+      COMPLETION_ITEM_KIND_FOR_TEXT = 1
+      COMPLETION_ITEM_KIND_FOR_METHOD = 2
+      COMPLETION_ITEM_KIND_FOR_FUNCTION = 3
+      COMPLETION_ITEM_KIND_FOR_CONSTRUCTOR = 4
+      COMPLETION_ITEM_KIND_FOR_FIELD = 5
+      COMPLETION_ITEM_KIND_FOR_VARIABLE = 6
+      COMPLETION_ITEM_KIND_FOR_CLASS = 7
+      COMPLETION_ITEM_KIND_FOR_INTERFACE = 8
+      COMPLETION_ITEM_KIND_FOR_MODULE = 9
+      COMPLETION_ITEM_KIND_FOR_PROPERTY = 10
+      COMPLETION_ITEM_KIND_FOR_UNIT = 11
+      COMPLETION_ITEM_KIND_FOR_VALUE = 12
+      COMPLETION_ITEM_KIND_FOR_ENUM = 13
+      COMPLETION_ITEM_KIND_FOR_KEYWORD = 14
+      COMPLETION_ITEM_KIND_FOR_SNIPPET = 15
+      COMPLETION_ITEM_KIND_FOR_COLOR = 16
+      COMPLETION_ITEM_KIND_FOR_FILE = 17
+      COMPLETION_ITEM_KIND_FOR_REFERENCE = 18
+      COMPLETION_ITEM_KIND_FOR_FOLDER = 19
+      COMPLETION_ITEM_KIND_FOR_ENUM_MEMBER = 20
+      COMPLETION_ITEM_KIND_FOR_CONSTANT = 21
+      COMPLETION_ITEM_KIND_FOR_STRUCT = 22
+      COMPLETION_ITEM_KIND_FOR_EVENT = 23
+      COMPLETION_ITEM_KIND_FOR_OPERATOR = 24
+      COMPLETION_ITEM_KIND_FOR_TYPE_PARAMETER = 25
+
+      EXAMPLE_IDENTIFIER = 'a'
+      private_constant :EXAMPLE_IDENTIFIER
+
+      def call
+        respond(completion_items)
+      end
+
+      private
+
+      # @return [Array<Hash>, nil]
+      def completion_items
+        return unless responsible?
+
+        case node
+        when Nodes::ConstNode
+          completion_items_for_constant
+        when Nodes::SendNode
+          if node.location.dot&.is?('::')
+            completion_items_for_constant
+          else
+            completion_items_for_method
+          end
+        else
+          []
+        end
+      end
+
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_completion? &&
+          !source.nil?
+      end
+
+      # @return [Rucoa::Source, nil]
+      def source
+        @source ||= source_store.get(uri)
+      end
+
+      # @return [Rucoa::Position]
+      def position
+        @position ||= Position.from_vscode_position(
+          request.dig('params', 'position')
+        )
+      end
+
+      # @return [String]
+      def uri
+        request.dig('params', 'textDocument', 'uri')
+      end
+
+      # @return [Array<Hash>]
+      def completion_items_for_method
+        completable_method_names.map do |method_name|
+          {
+            kind: COMPLETION_ITEM_KIND_FOR_METHOD,
+            label: method_name,
+            textEdit: {
+              newText: method_name,
+              range: range.to_vscode_range
+            }
+          }
+        end
+      end
+
+      # @return [Array<Hash>]
+      def completion_items_for_constant
+        completable_constant_names.map do |constant_name|
+          {
+            kind: COMPLETION_ITEM_KIND_FOR_CONSTANT,
+            label: constant_name,
+            textEdit: {
+              newText: constant_name,
+              range: range.to_vscode_range
+            }
+          }
+        end
+      end
+
+      # @return [Array<String>]
+      def completable_constant_names
+        referrable_constant_names.select do |constant_name|
+          constant_name.start_with?(completion_head)
+        end.sort
+      end
+
+      # @return [String] e.g. "SE" to `File::SE|`, "ba" to `foo.ba|`
+      def completion_head
+        @completion_head ||=
+          if @repaired
+            ''
+          else
+            node.name
+          end
+      end
+
+      def referrable_constant_names
+        definition_store.constant_definitions_under(constant_namespace).map(&:name).uniq
+      end
+
+      # @return [String] e.g. "Foo::Bar" to `Foo::Bar.baz|`.
+      def constant_namespace
+        node.each_child_node(:const).map(&:name).reverse.join('::')
+      end
+
+      # @return [Array<String>]
+      def completable_method_names
+        callable_method_names.select do |method_name|
+          method_name.start_with?(completion_head)
+        end.sort
+      end
+
+      # @return [Array<String>]
+      def callable_method_names
+        callable_method_definitions.map(&:method_name).uniq
+      end
+
+      # @return [Array<String>]
+      def callable_method_definitions
+        receiver_types.flat_map do |type|
+          definition_store.method_definitions_of(type)
+        end
+      end
+
+      # @return [Array<String>]
+      def receiver_types
+        NodeInspector.new(
+          definition_store: definition_store,
+          node: node
+        ).method_receiver_types
+      end
+
+      # @return [Rucoa::Node, nil]
+      def node
+        @node ||=
+          if source.syntax_error?
+            repair
+            repaired_node
+          else
+            normal_node
+          end
+      end
+
+      # @return [Rucoa::Node, nil]
+      def normal_node
+        source.node_at(position)
+      end
+
+      # @return [Rucoa::Node, nil]
+      def repaired_node
+        repaired_source.node_at(position)
+      end
+
+      # @return [void]
+      def repair
+        @repaired = true
+      end
+
+      # @return [String]
+      def repaired_content
+        source.content.dup.insert(
+          position.to_index_of(source.content),
+          EXAMPLE_IDENTIFIER
+        )
+      end
+
+      # @return [Rucoa::Source]
+      def repaired_source
+        Source.new(
+          content: repaired_content,
+          uri: source.uri
+        )
+      end
+
+      # @return [Rucoa::Range]
+      def range
+        @range ||=
+          if @repaired
+            position.to_range
+          else
+            Range.from_parser_range(node.location.expression)
+          end
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/text_document_hover_handler.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentHoverHandler < Base
+      def call
+        respond(hover)
+      end
+
+      private
+
+      # @return [Hash, nil]
+      def hover
+        return unless responsible?
+
+        {
+          contents: contents,
+          range: range.to_vscode_range
+        }
+      end
+
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_hover? &&
+          !source.nil? &&
+          !node.nil?
+      end
+
+      # @return [String, nil]
+      def contents
+        method_definition = method_definitions.first
+        return unless method_definition
+
+        [
+          method_definition.signatures.join("\n"),
+          method_definition.description
+        ].join("\n\n")
+      end
+
+      # @return [Rucoa::Range]
+      def range
+        Range.from_parser_range(node.location.expression)
+      end
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def node
+        @node ||= source.node_at(position)
+      end
+
+      # @return [Rucoa::Source, nil]
+      def source
+        @source ||= source_store.get(uri)
+      end
+
+      # @return [String]
+      def uri
+        request.dig('params', 'textDocument', 'uri')
+      end
+
+      # @return [Rucoa::Position]
+      def position
+        Position.from_vscode_position(
+          request.dig('params', 'position')
+        )
+      end
+
+      # @return [Array<Rucoa::Definitions::MethodDefinition>]
+      def method_definitions
+        NodeInspector.new(
+          definition_store: definition_store,
+          node: node
+        ).method_definitions
+      end
+    end
+  end
+end

data/lib/rucoa/handlers.rb

@@ -8,10 +8,12 @@ module Rucoa
     autoload :InitializedHandler, 'rucoa/handlers/initialized_handler'
     autoload :ShutdownHandler, 'rucoa/handlers/shutdown_handler'
     autoload :TextDocumentCodeActionHandler, 'rucoa/handlers/text_document_code_action_handler'
+    autoload :TextDocumentCompletionHandler, 'rucoa/handlers/text_document_completion_handler'
     autoload :TextDocumentDidChangeHandler, 'rucoa/handlers/text_document_did_change_handler'
     autoload :TextDocumentDidOpenHandler, 'rucoa/handlers/text_document_did_open_handler'
     autoload :TextDocumentDocumentSymbolHandler, 'rucoa/handlers/text_document_document_symbol_handler'
     autoload :TextDocumentFormattingHandler, 'rucoa/handlers/text_document_formatting_handler'
+    autoload :TextDocumentHoverHandler, 'rucoa/handlers/text_document_hover_handler'
     autoload :TextDocumentRangeFormattingHandler, 'rucoa/handlers/text_document_range_formatting_handler'
     autoload :TextDocumentSelectionRangeHandler, 'rucoa/handlers/text_document_selection_range_handler'
     autoload :TextDocumentSignatureHelpHandler, 'rucoa/handlers/text_document_signature_help_handler'

data/lib/rucoa/position.rb

@@ -21,7 +21,7 @@ module Rucoa
         )
       end
 
-      # @param hash [Hash{Symbol => Integer}]
+      # @param hash [Hash{String => Integer}]
       # @return [Rucoa::Position]
       def from_vscode_position(hash)
         new(
@@ -44,6 +44,17 @@ module Rucoa
       @line = line
     end
 
+    # @param text [String]
+    # @return [Integer]
+    def to_index_of(text)
+      text.each_line.take(@line - 1).sum(&:length) + @column
+    end
+
+    # @return [Rucoa::Range]
+    def to_range
+      Range.new(self, self)
+    end
+
     # @return [Hash]
     def to_vscode_position
       {

data/lib/rucoa/server.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'logger'
+require 'stringio'
+
 module Rucoa
   class Server
     # @return [Hash{String => Class}]
@@ -9,10 +12,12 @@ module Rucoa
       'initialized' => Handlers::InitializedHandler,
       'shutdown' => Handlers::ShutdownHandler,
       'textDocument/codeAction' => Handlers::TextDocumentCodeActionHandler,
+      'textDocument/completion' => Handlers::TextDocumentCompletionHandler,
       'textDocument/didChange' => Handlers::TextDocumentDidChangeHandler,
       'textDocument/didOpen' => Handlers::TextDocumentDidOpenHandler,
       'textDocument/documentSymbol' => Handlers::TextDocumentDocumentSymbolHandler,
       'textDocument/formatting' => Handlers::TextDocumentFormattingHandler,
+      'textDocument/hover' => Handlers::TextDocumentHoverHandler,
       'textDocument/rangeFormatting' => Handlers::TextDocumentRangeFormattingHandler,
       'textDocument/selectionRange' => Handlers::TextDocumentSelectionRangeHandler,
       'textDocument/signatureHelp' => Handlers::TextDocumentSignatureHelpHandler,
@@ -32,11 +37,18 @@ module Rucoa
     # @return [Rucoa::SourceStore]
     attr_reader :source_store
 
-    # @param input [IO]
-    # @param output [IO]
-    def initialize(input:, output:)
-      @reader = MessageReader.new(input)
-      @writer = MessageWriter.new(output)
+    # @param io_log [IO]
+    # @param io_in [IO]
+    # @param io_out [IO]
+    def initialize(
+      io_log: ::StringIO.new,
+      io_in: ::StringIO.new,
+      io_out: ::StringIO.new
+    )
+      @logger = ::Logger.new(io_log)
+      @logger.level = ::Logger::DEBUG
+      @reader = MessageReader.new(io_in)
+      @writer = MessageWriter.new(io_out)
 
       @client_response_handlers = {}
       @configuration = Configuration.new
@@ -50,8 +62,14 @@ module Rucoa
 
     # @return [void]
     def start
-      @reader.read do |request|
-        handle(request)
+      @reader.read do |message|
+        debug do
+          {
+            kind: :read,
+            message: message
+          }
+        end
+        handle(message)
       end
     end
 
@@ -91,6 +109,11 @@ module Rucoa
       end
     end
 
+    # @yieldparam log [String]
+    def debug(&block)
+      @logger.debug(&block) if configuration.enables_debug?
+    end
+
     # @param request [Hash]
     # @return [void]
     def handle_client_request(request)
@@ -115,11 +138,14 @@ module Rucoa
     # @param message [Hash]
     # @return [void]
     def write_server_request(message, &block)
-      @writer.write(
-        message.merge(
-          id: @server_request_id
-        )
-      )
+      message = message.merge('id' => @server_request_id)
+      debug do
+        {
+          kind: :write,
+          message: message
+        }
+      end
+      @writer.write(message)
       @client_response_handlers[@server_request_id] = block
       @server_request_id += 1
     end
@@ -127,6 +153,12 @@ module Rucoa
     # @param message [Hash]
     # @return [void]
     def write_server_response(message)
+      debug do
+        {
+          kind: :write,
+          message: message
+        }
+      end
       @writer.write(message)
     end
   end

data/lib/rucoa/source.rb

@@ -78,6 +78,11 @@ module Rucoa
       nil
     end
 
+    # @return [Boolean]
+    def syntax_error?
+      root_node.nil?
+    end
+
     private
 
     # @return [Array<Rucoa::Nodes::Base>]

data/lib/rucoa/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-11 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -113,10 +113,12 @@ files:
 - lib/rucoa/handlers/initialized_handler.rb
 - lib/rucoa/handlers/shutdown_handler.rb
 - lib/rucoa/handlers/text_document_code_action_handler.rb
+- lib/rucoa/handlers/text_document_completion_handler.rb
 - lib/rucoa/handlers/text_document_did_change_handler.rb
 - lib/rucoa/handlers/text_document_did_open_handler.rb
 - lib/rucoa/handlers/text_document_document_symbol_handler.rb
 - lib/rucoa/handlers/text_document_formatting_handler.rb
+- lib/rucoa/handlers/text_document_hover_handler.rb
 - lib/rucoa/handlers/text_document_range_formatting_handler.rb
 - lib/rucoa/handlers/text_document_selection_range_handler.rb
 - lib/rucoa/handlers/text_document_signature_help_handler.rb