rucoa 0.4.0 → 0.6.0

data/lib/rucoa/definition_builders/yard_method_definition_builder.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require 'yard'
+
+module Rucoa
+  module DefinitionBuilders
+    class YardMethodDefinitionBuilder
+      class << self
+        # @param code_object [YARD::CodeObjects::MethodObject]
+        # @param path [String]
+        # @return [Rucoa::Definitions::Base]
+        def call(code_object:, path:)
+          new(
+            code_object: code_object,
+            path: path
+          ).call
+        end
+      end
+
+      # @param code_object [YARD::CodeObjects::Base]
+      # @param path [String]
+      def initialize(code_object:, path:)
+        @code_object = code_object
+        @path = path
+      end
+
+      # @return [Rucoa::Definitions::Base]
+      def call
+        ::Rucoa::Definitions::MethodDefinition.new(
+          description: description,
+          kind: kind,
+          method_name: method_name,
+          namespace: namespace,
+          source_path: @path,
+          types: types
+        )
+      end
+
+      private
+
+      # @return [String]
+      def description
+        @code_object.docstring.to_s
+      end
+
+      # @return [Symbol]
+      def kind
+        if @code_object.scope == :instance
+          :instance
+        else
+          :singleton
+        end
+      end
+
+      # @return [String
+      def method_name
+        @code_object.name
+      end
+
+      # @return [String]
+      def namespace
+        @code_object.namespace.to_s
+      end
+
+      # @return [Array<Rucoa::Types::MethodType>]
+      def types
+        return_types.map do |return_type|
+          ::Rucoa::Types::MethodType.new(
+            parameters_string: parameters_string,
+            return_type: return_type
+          )
+        end
+      end
+
+      # @return [String]
+      # @example
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: <<~RUBY,
+      #       class Foo
+      #         def bar(
+      #           argument1,
+      #           argument2 = nil,
+      #           *arguments,
+      #           keyword1:,
+      #           keyword2: nil,
+      #           **keywords,
+      #           &block
+      #         )
+      #         end
+      #       end
+      #     RUBY
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.first.signatures).to eq(
+      #     [
+      #       'Foo#bar(argument1, argument2 = nil, *arguments, keyword1:, keyword2: nil, **keywords, &block) -> Object'
+      #     ]
+      #   )
+      def parameters_string
+        @code_object.parameters.map do |parameter_name, default_value|
+          default_value_part =
+            if default_value.nil?
+              nil
+            elsif parameter_name.end_with?(':')
+              " #{default_value}"
+            else
+              " = #{default_value}"
+            end
+          [
+            parameter_name,
+            default_value_part
+          ].join
+        end.join(', ')
+      end
+
+      # @return [Array<Rucoa::Definitions::MethodParameterDefinition>]
+      def parameters
+        parameter_tags.map do |parameter_tag|
+          ::Rucoa::Definitions::MethodParameterDefinition.new(
+            name: parameter_tag.name,
+            types: parameter_tag.types
+          )
+        end
+      end
+
+      # @return [Array<YARD::Tags::Tag>]
+      def parameter_tags
+        @code_object.tags(:param) + @code_object.tags(:overload).flat_map do |overload_tag|
+          overload_tag.tags(:param)
+        end
+      end
+
+      # @return [Array<String>]
+      # @return [String]
+      # @example returns return type annotated by YARD @return tags
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: <<~RUBY,
+      #       # @return [String]
+      #       def foo
+      #         'foo'
+      #       end
+      #     RUBY
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.first.return_types).to eq(
+      #     %w[
+      #       String
+      #     ]
+      #   )
+      # @example ignores empty @return tags
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: <<~RUBY,
+      #       # @return []
+      #       def foo
+      #         'foo'
+      #       end
+      #     RUBY
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.first.return_types).to eq([])
+      def return_types
+        return %w[Object] if return_tags.empty?
+
+        return_tags.flat_map(&:types).compact.map do |type|
+          YardType.new(type).to_rucoa_type
+        end
+      end
+
+      # @return [YARD::Tags::Tag]
+      def return_tags
+        @code_object.tags(:return) + @code_object.tags(:overload).flat_map do |overload_tag|
+          overload_tag.tags(:return)
+        end
+      end
+
+      class YardType
+        # @param type [String]
+        def initialize(type)
+          @type = type
+        end
+
+        # @return [String]
+        # @example scrubs "Array<String>" to "Array"
+        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #     'Array<String>'
+        #   )
+        #   expect(yard_type.to_rucoa_type).to eq('Array')
+        # @example scrubs "Array(String, Integer)" to "Array"
+        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #     'Array(String, Integer)'
+        #   )
+        #   expect(yard_type.to_rucoa_type).to eq('Array')
+        # @example scrubs "::Array" to "Array"
+        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #     '::Array'
+        #   )
+        #   expect(yard_type.to_rucoa_type).to eq('Array')
+        # @example scrubs "Hash{Symbol => Object}" to "Hash"
+        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #     'Hash{Symbol => Object}'
+        #   )
+        #   expect(yard_type.to_rucoa_type).to eq('Hash')
+        # @example scrubs "Array<Array<Integer>>" to "Array"
+        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #     'Array<Array<Integer>>'
+        #   )
+        #   expect(yard_type.to_rucoa_type).to eq('Array')
+        def to_rucoa_type
+          @type
+            .delete_prefix('::')
+            .gsub(/<.+>/, '')
+            .gsub(/\{.+\}/, '')
+            .gsub(/\(.+\)/, '')
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/definition_builders.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module DefinitionBuilders
+    autoload :RbsConstantDefinitionBuilder, 'rucoa/definition_builders/rbs_constant_definition_builder'
+    autoload :RbsMethodDefinitionBuilder, 'rucoa/definition_builders/rbs_method_definition_builder'
+    autoload :YardMethodDefinitionBuilder, 'rucoa/definition_builders/yard_method_definition_builder'
+  end
+end

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

@@ -7,10 +7,23 @@ module Rucoa
         respond(
           capabilities: {
             codeActionProvider: true,
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: %w[
+                .
+              ]
+            },
             documentFormattingProvider: true,
             documentRangeFormattingProvider: true,
             documentSymbolProvider: true,
+            hoverProvider: 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