rucoa 0.4.0 → 0.5.0

data/lib/rucoa/definition_store.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Rucoa
+  class DefinitionStore
+    # @return [Array<Rucoa::Definition::Base>]
+    attr_accessor :definitions
+
+    def initialize
+      @definitions = []
+    end
+
+    # @param source_path [String]
+    # @return [Array<Rucoa::Definition::Base>]
+    def update_definitions_defined_in(source_path, definitions:)
+      delete_definitions_defined_in(source_path)
+      @definitions += definitions
+    end
+
+    # @param full_qualified_name [String]
+    # @return [Array<Rucoa::Definitions::Base>]
+    def select_by_full_qualified_name(full_qualified_name)
+      @definitions.select do |definition|
+        definition.full_qualified_name == full_qualified_name
+      end
+    end
+
+    # @param namespace [String]
+    # @return [Array<Rucoa::Definitions::MethodDefinition>]
+    def method_definitions_of(namespace)
+      method_definitions.select do |method_definition|
+        method_definition.namespace == namespace
+      end
+    end
+
+    # @param namespace [String]
+    # @return [Array<Rucoa::Definitions::ConstantDefinition>] e.g. File::Separator, File::SEPARATOR, etc.
+    def constant_definitions_under(namespace)
+      constant_definitions.select do |constant_definition|
+        constant_definition.namespace == namespace
+      end
+    end
+
+    private
+
+    # @return [Array<Rucoa::Definition::ConstantDefinition>]
+    def constant_definitions
+      @definitions.grep(Definitions::ConstantDefinition)
+    end
+
+    # @return [Array<Rucoa::Definition::MethodDefinition>]
+    def method_definitions
+      @definitions.grep(Definitions::MethodDefinition)
+    end
+
+    # @param source_path [String]
+    # @return [Array<Rucoa::Definition::Base>]
+    def delete_definitions_defined_in(source_path)
+      @definitions.delete_if do |definition|
+        definition.source_path == source_path
+      end
+    end
+  end
+end

data/lib/rucoa/definitions/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Definitions
+    class Base
+      # @return [String]
+      def source_path
+        raise ::NotImplementedError
+      end
+    end
+  end
+end

data/lib/rucoa/definitions/constant_definition.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Definitions
+    # Represents class definition, module definition, or constant assignment.
+    class ConstantDefinition < Base
+      # @return [String]
+      attr_reader :full_qualified_name
+
+      # @return [String]
+      attr_reader :source_path
+
+      # @param full_qualified_name [String]
+      # @param source_path [String]
+      def initialize(full_qualified_name:, source_path:)
+        super()
+        @full_qualified_name = full_qualified_name
+        @source_path = source_path
+      end
+
+      # @return [String]
+      # @example returns non-full-qualified name
+      #   definition = Rucoa::Definitions::ConstantDefinition.new(
+      #     full_qualified_name: 'Foo::Bar::Baz',
+      #     source_path: '/path/to/foo/bar/baz.rb'
+      #   )
+      #   expect(definition.name).to eq('Baz')
+      def name
+        names.last
+      end
+
+      # @return [String]
+      # @example returns namespace
+      #   definition = Rucoa::Definitions::ConstantDefinition.new(
+      #     full_qualified_name: 'Foo::Bar::Baz',
+      #     source_path: '/path/to/foo/bar/baz.rb'
+      #   )
+      #   expect(definition.namespace).to eq('Foo::Bar')
+      def namespace
+        names[..-2].join('::')
+      end
+
+      private
+
+      # @return [Array<String>]
+      def names
+        @names ||= full_qualified_name.split('::')
+      end
+    end
+  end
+end

data/lib/rucoa/definitions/method_definition.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Definitions
+    class MethodDefinition < Base
+      # @return [String, nil]
+      attr_reader :description
+
+      # @return [String]
+      attr_reader :method_name
+
+      # @return [String]
+      attr_reader :namespace
+
+      # @return [String]
+      attr_reader :source_path
+
+      # @param description [String, nil]
+      # @param kind [Symbol]
+      # @param method_name [String]
+      # @param namespace [String]
+      # @param source_path [String]
+      # @param types [Array<Rucoa::Types::MethodType>]
+      def initialize(
+        description:,
+        kind:,
+        method_name:,
+        namespace:,
+        source_path:,
+        types:
+      )
+        super()
+        @description = description
+        @kind = kind
+        @method_name = method_name
+        @namespace = namespace
+        @source_path = source_path
+        @types = types
+      end
+
+      # @return [String]
+      # @example returns qualified name of method
+      #   method_definition = Rucoa::Definitions::MethodDefinition.new(
+      #     description: nil,
+      #     kind: :instance,
+      #     method_name: 'foo',
+      #     namespace: 'Foo::Bar',
+      #     source_path: '/path/to/foo/bar.rb',
+      #     types: []
+      #   )
+      #   expect(method_definition.full_qualified_name).to eq('Foo::Bar#foo')
+      def full_qualified_name
+        [
+          @namespace,
+          method_kind_symbol,
+          @method_name
+        ].join
+      end
+
+      # @todo
+      # @return [Array<Rucoa::Definitions::MethodParameter>]
+      def parameters
+        []
+      end
+
+      # @return [Array<String>]
+      # @example returns return types
+      #   method_definition = Rucoa::Definitions::MethodDefinition.new(
+      #     description: nil,
+      #     kind: :instance,
+      #     method_name: 'foo',
+      #     namespace: 'Foo::Bar',
+      #     source_path: '/path/to/foo/bar.rb',
+      #     types: [
+      #       Rucoa::Types::MethodType.new(
+      #         parameters_string: '',
+      #         return_type: 'String'
+      #       )
+      #     ]
+      #   )
+      #   expect(method_definition.return_types).to eq(%w[String])
+      def return_types
+        @types.map(&:return_type)
+      end
+
+      # @return [Array<String>]
+      # @example returns signature
+      #   method_definition = Rucoa::Definitions::MethodDefinition.new(
+      #     description: nil,
+      #     kind: :instance,
+      #     method_name: 'foo',
+      #     namespace: 'Foo::Bar',
+      #     source_path: '/path/to/foo/bar.rb',
+      #     types: [
+      #       Rucoa::Types::MethodType.new(
+      #         parameters_string: '?::int base',
+      #         return_type: 'String'
+      #       )
+      #     ]
+      #   )
+      #   expect(method_definition.signatures).to eq(['Foo::Bar#foo(?::int base) -> String'])
+      def signatures
+        @types.map do |type|
+          format(
+            '%<full_qualified_name>s(%<parameters>s) -> %<return_types>s',
+            full_qualified_name: full_qualified_name,
+            parameters: type.parameters_string,
+            return_types: type.return_type
+          )
+        end
+      end
+
+      private
+
+      # @return [String]
+      def method_kind_symbol
+        case @kind
+        when :instance
+          '#'
+        else
+          '.'
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/definitions/method_parameter_definition.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Definitions
+    # Represents method parameter definition.
+    class MethodParameterDefinition < Base
+      # @return [String]
+      attr_reader :name
+
+      # @return [Array<String>]
+      attr_reader :types
+
+      # @param name [String]
+      # @param types [Array<String>]
+      def initialize(name:, types:)
+        super()
+        @name = name
+        @types = types
+      end
+
+      # @return [Hash{Symbol => Object}]
+      def to_hash
+        {
+          name: name,
+          types: types
+        }
+      end
+    end
+  end
+end

data/lib/rucoa/definitions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Definitions
+    autoload :Base, 'rucoa/definitions/base'
+    autoload :ConstantDefinition, 'rucoa/definitions/constant_definition'
+    autoload :MethodDefinition, 'rucoa/definitions/method_definition'
+  end
+end

data/lib/rucoa/handlers/base.rb

@@ -32,6 +32,9 @@ module Rucoa
       # @return [Hash]
       attr_reader :request
 
+      # @return [Rucoa::Server]
+      attr_reader :server
+
       # @param message [Hash]
       # @return [void]
       def respond(message)
@@ -46,6 +49,11 @@ module Rucoa
         @server.configuration
       end
 
+      # @return [Rucoa::DefinitionStore]
+      def definition_store
+        @server.definition_store
+      end
+
       # @return [Rucoa::SourceStore]
       def source_store
         @server.source_store

data/lib/rucoa/handlers/exit_handler.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class ExitHandler < Base
+      def call
+        server.finish
+      end
+    end
+  end
+end

data/lib/rucoa/handlers/initialize_handler.rb

@@ -11,6 +11,12 @@ module Rucoa
             documentRangeFormattingProvider: true,
             documentSymbolProvider: true,
             selectionRangeProvider: true,
+            signatureHelpProvider: {
+              triggerCharacters: %w[
+                (
+                ,
+              ]
+            },
             textDocumentSync: {
               change: 1, # Full
               openClose: true

data/lib/rucoa/handlers/initialized_handler.rb

@@ -7,6 +7,16 @@ module Rucoa
 
       def call
         request_workspace_configuration
+        load_definitions
+      end
+
+      private
+
+      # @return [void]
+      def load_definitions
+        YardGlobDocumentLoader.call(
+          globs: ::YARD::Parser::SourceParser::DEFAULT_PATH_GLOB
+        )
       end
     end
   end

data/lib/rucoa/handlers/shutdown_handler.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Handlers
+    class ShutdownHandler < Base
+      def call
+        server.shutting_down = true
+        respond(nil)
+      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

@@ -212,7 +212,7 @@ module Rucoa
 
       # @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_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_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 respondable?
+
+        {
+          signatures: signature_informations
+        }
+      end
+
+      # @return [Boolean]
+      def respondable?
+        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,8 +3,10 @@
 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 :TextDocumentDidChangeHandler, 'rucoa/handlers/text_document_did_change_handler'
     autoload :TextDocumentDidOpenHandler, 'rucoa/handlers/text_document_did_open_handler'
@@ -12,6 +14,7 @@ module Rucoa
     autoload :TextDocumentFormattingHandler, 'rucoa/handlers/text_document_formatting_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,109 @@
+# 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>, nil]
+    def method_definitions
+      method_full_qualified_name&.flat_map do |full_qualified_name|
+        @definition_store.select_by_full_qualified_name(full_qualified_name)
+      end
+    end
+
+    # @return [Array<String>, nil]
+    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>, nil]
+    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]
+      end
+    end
+
+    private
+
+    # @return [Array<String>, nil]
+    def method_full_qualified_name
+      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_name.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.