rucoa 0.4.0 → 0.6.0

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_did_change_handler.rb

@@ -2,30 +2,11 @@
 
 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
-
+    class TextDocumentDidChangeHandler < TextDocumentDidOpenHandler
       # @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

@@ -6,15 +6,22 @@ module Rucoa
       include HandlerConcerns::DiagnosticsPublishable
 
       def call
-        update_source
+        source_store.update(source)
+        definition_store.update_definitions_defined_in(
+          source.path,
+          definitions: source.definitions
+        )
         publish_diagnostics_on(uri)
       end
 
       private
 
-      # @return [void]
-      def update_source
-        source_store.set(uri, text)
+      # @return [Rucoa::Source]
+      def source
+        @source ||= Source.new(
+          content: text,
+          uri: uri
+        )
       end
 
       # @return [String]

data/lib/rucoa/handlers/text_document_document_symbol_handler.rb

@@ -40,7 +40,7 @@ module Rucoa
       ]
 
       def call
-        return unless respondable?
+        return unless responsible?
 
         respond(document_symbols)
       end
@@ -206,13 +206,14 @@ module Rucoa
       end
 
       # @return [Boolean]
-      def respondable?
-        configuration.enables_document_symbol? && source
+      def responsible?
+        configuration.enables_document_symbol? &&
+          !source.nil?
       end
 
       # @return [Rucoa::Source]
       def source
-        @source ||= @server.source_store.get(uri)
+        @source ||= source_store.get(uri)
       end
 
       # @return [String]

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/text_document_range_formatting_handler.rb

@@ -53,7 +53,7 @@ module Rucoa
       # @return [Array(Rucoa::Range, String)]
       def correctable_replacements
         replacements.select do |replacement_range, _|
-          range.contains?(replacement_range)
+          range.contain?(replacement_range)
         end
       end
 

data/lib/rucoa/handlers/text_document_selection_range_handler.rb

@@ -4,7 +4,7 @@ module Rucoa
   module Handlers
     class TextDocumentSelectionRangeHandler < Base
       def call
-        return unless respondable?
+        return unless responsible?
 
         respond(
           positions.filter_map do |position|
@@ -19,9 +19,9 @@ module Rucoa
       private
 
       # @return [Boolean]
-      def respondable?
+      def responsible?
         configuration.enables_selection_range? &&
-          source
+          !source.nil?
       end
 
       # @return [Rucoa::Source]

data/lib/rucoa/handlers/text_document_signature_help_handler.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class TextDocumentSignatureHelpHandler < Base
+      def call
+        respond(signature_help)
+      end
+
+      private
+
+      # @return [Hash]
+      def signature_help
+        return unless responsible?
+
+        {
+          signatures: signature_informations
+        }
+      end
+
+      # @return [Boolean]
+      def responsible?
+        configuration.enables_signature_help? &&
+          node.is_a?(Nodes::SendNode)
+      end
+
+      # @return [Array<Hash>]
+      def signature_informations
+        method_definitions.map do |method_definition|
+          {
+            documentation: method_definition.description,
+            label: method_definition.signatures.join("\n")
+          }
+        end
+      end
+
+      # @return [Array<Rucoa::Definitions::MethodDefinition>]
+      def method_definitions
+        NodeInspector.new(
+          definition_store: definition_store,
+          node: node
+        ).method_definitions
+      end
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def node
+        @node ||= source.node_at(position)
+      end
+
+      # @return [Rucoa::Position]
+      def position
+        Position.from_vscode_position(
+          request.dig('params', 'position')
+        )
+      end
+
+      # @return [Rucoa::Source]
+      def source
+        source_store.get(uri)
+      end
+
+      # @return [String]
+      def uri
+        request.dig('params', 'textDocument', 'uri')
+      end
+    end
+  end
+end

data/lib/rucoa/handlers.rb

@@ -3,15 +3,20 @@
 module Rucoa
   module Handlers
     autoload :Base, 'rucoa/handlers/base'
+    autoload :ExitHandler, 'rucoa/handlers/exit_handler'
     autoload :InitializeHandler, 'rucoa/handlers/initialize_handler'
     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'
     autoload :WorkspaceDidChangeConfigurationHandler, 'rucoa/handlers/workspace_did_change_configuration_handler'
   end
 end

data/lib/rucoa/node_inspector.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Rucoa
+  class NodeInspector
+    # @param definition_store [Rucoa::DefinitionStore]
+    # @param node [Rucoa::Node]
+    def initialize(definition_store:, node:)
+      @definition_store = definition_store
+      @node = node
+    end
+
+    # @return [Array<String>]
+    def method_definitions
+      method_full_qualified_names.flat_map do |full_qualified_name|
+        @definition_store.select_by_full_qualified_name(full_qualified_name)
+      end
+    end
+
+    # @return [Array<String>]
+    def method_receiver_types
+      return [] unless @node.is_a?(Nodes::SendNode)
+
+      if @node.receiver
+        self.class.new(
+          definition_store: @definition_store,
+          node: @node.receiver
+        ).return_types
+      else
+        [@node.namespace]
+      end
+    end
+
+    # @return [Array<String>]
+    def return_types
+      case @node.type
+      when :const
+        [@node.name]
+      when :lvar
+        return_types_for_lvar
+      when :send
+        return_types_for_send
+      when :array
+        %w[Array]
+      when :class, :module, :nil
+        %w[NilClass]
+      when :complex
+        %w[Complex]
+      when :def, :sym
+        %w[Symbol]
+      when :dstr, :str, :xstr
+        %w[String]
+      when :erange, :irange
+        %w[Range]
+      when false
+        %w[FalseClass]
+      when :float
+        %w[Float]
+      when :hash, :pair
+        %w[Hash]
+      when :int
+        %w[Integer]
+      when :rational
+        %w[Rational]
+      when :regexp, :regopt
+        %w[Regexp]
+      when true
+        %w[TrueClass]
+      else
+        []
+      end
+    end
+
+    private
+
+    # @return [Array<String>]
+    def method_full_qualified_names
+      method_receiver_types.map do |type|
+        [
+          type,
+          @node.name
+        ].join('#')
+      end
+    end
+
+    # @return [String, nil]
+    def nearest_def_full_qualified_name
+      @node.each_ancestor(:def).first&.full_qualified_name
+    end
+
+    # @return [Array<String>]
+    def return_types_for_lvar
+      full_qualified_name = nearest_def_full_qualified_name
+      return [] unless full_qualified_name
+
+      @definition_store.select_by_full_qualified_name(full_qualified_name).flat_map do |definition|
+        definition.parameters.select do |parameter|
+          parameter.name == @node.name
+        end.flat_map(&:types)
+      end
+    end
+
+    # @return [Array<String>]
+    def return_types_for_send
+      method_full_qualified_names.flat_map do |full_qualified_name|
+        @definition_store.select_by_full_qualified_name(full_qualified_name).flat_map(&:return_types)
+      end.uniq
+    end
+  end
+end

data/lib/rucoa/nodes/base.rb

@@ -85,6 +85,36 @@ module Rucoa
         Range.from_parser_range(location.expression).include?(position)
       end
 
+      # @note namespace is a String representation of `Module.nesting`.
+      # @return [String]
+      # @example returns namespace
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY
+      #       module Foo
+      #         class Bar
+      #           def baz
+      #           end
+      #         end
+      #       end
+      #     RUBY
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 4,
+      #       line: 3
+      #     )
+      #   )
+      #   expect(node.namespace).to eq('Foo::Bar')
+      # @example returns "Object" when the node is not in a namespace
+      #   node = Rucoa::Parser.call(
+      #     <<~RUBY
+      #       foo
+      #     RUBY
+      #   )
+      #   expect(node.namespace).to eq('Object')
+      def namespace
+        each_ancestor(:module, :class).first&.full_qualified_name || 'Object'
+      end
+
       protected
 
       # Visit all descendants.