rucoa 0.3.0 → 0.5.1

data/lib/rucoa/server.rb

@@ -4,21 +4,31 @@ module Rucoa
   class Server
     # @return [Hash{String => Class}]
     METHOD_TO_HANDLER_MAP = {
+      'exit' => Handlers::ExitHandler,
       'initialize' => Handlers::InitializeHandler,
       'initialized' => Handlers::InitializedHandler,
+      'shutdown' => Handlers::ShutdownHandler,
       'textDocument/codeAction' => Handlers::TextDocumentCodeActionHandler,
       'textDocument/didChange' => Handlers::TextDocumentDidChangeHandler,
       'textDocument/didOpen' => Handlers::TextDocumentDidOpenHandler,
+      'textDocument/documentSymbol' => Handlers::TextDocumentDocumentSymbolHandler,
       'textDocument/formatting' => Handlers::TextDocumentFormattingHandler,
       'textDocument/rangeFormatting' => Handlers::TextDocumentRangeFormattingHandler,
       'textDocument/selectionRange' => Handlers::TextDocumentSelectionRangeHandler,
+      'textDocument/signatureHelp' => Handlers::TextDocumentSignatureHelpHandler,
       'workspace/didChangeConfiguration' => Handlers::WorkspaceDidChangeConfigurationHandler
     }.freeze
     private_constant :METHOD_TO_HANDLER_MAP
 
+    # @return [Boolean]
+    attr_accessor :shutting_down
+
     # @return [Rucoa::Configuration]
     attr_reader :configuration
 
+    # @return [Rucoa::DefinitionStore]
+    attr_reader :definition_store
+
     # @return [Rucoa::SourceStore]
     attr_reader :source_store
 
@@ -28,10 +38,14 @@ module Rucoa
       @reader = MessageReader.new(input)
       @writer = MessageWriter.new(output)
 
+      @client_response_handlers = {}
       @configuration = Configuration.new
       @server_request_id = 0
-      @client_response_handlers = {}
+      @shutting_down = false
       @source_store = SourceStore.new
+
+      @definition_store = DefinitionStore.new
+      @definition_store.definitions += DefinitionArchiver.load
     end
 
     # @return [void]
@@ -41,6 +55,11 @@ module Rucoa
       end
     end
 
+    # @return [void]
+    def finish
+      exit(0)
+    end
+
     # @yieldparam response [Hash]
     # @param message [Hash]
     # @return [void]

data/lib/rucoa/source.rb

@@ -6,13 +6,59 @@ module Rucoa
     attr_reader :content
 
     # @return [String]
-    attr_reader :path
+    attr_reader :uri
 
     # @param content [String]
-    # @param path [String, nil]
-    def initialize(content:, path: nil)
+    # @param uri [String, nil]
+    def initialize(content:, uri: nil)
       @content = content
-      @path = path
+      @uri = uri
+    end
+
+    # @return [Array<Rucoa::Definition::Base>]
+    # @example returns definitions from given source
+    #   content = <<~RUBY
+    #     class Foo
+    #       def bar
+    #       end
+    #     end
+    #   RUBY
+    #   source = Rucoa::Source.new(
+    #     content: content,
+    #     uri: 'file:///path/to/foo.rb'
+    #   )
+    #   expect(source.definitions).to match(
+    #     [
+    #       a_kind_of(Rucoa::Definitions::MethodDefinition)
+    #     ]
+    #   )
+    def definitions
+      @definitions ||= YardStringDocumentLoader.call(
+        content: @content,
+        path: path
+      )
+    end
+
+    # @return [String, nil]
+    # @example returns path from given VSCode URI
+    #   source = Rucoa::Source.new(
+    #     content: '',
+    #     uri: 'file:///path/to/foo.rb'
+    #   )
+    #   expect(source.path).to eq('/path/to/foo.rb')
+    # @example returns nil for untitled URI
+    #   source = Rucoa::Source.new(
+    #     content: '',
+    #     uri: 'untitled:Untitled-1'
+    #   )
+    #   expect(source.path).to be_nil
+    def path
+      return unless @uri
+
+      path = ::URI.parse(@uri).path
+      return unless path
+
+      ::CGI.unescape(path)
     end
 
     # @param position [Rucoa::Position]
@@ -21,15 +67,19 @@ module Rucoa
       root_and_descendant_nodes.reverse.find do |node|
         node.include_position?(position)
       end
+    rescue ::Parser::SyntaxError
+      nil
     end
 
-    private
-
     # @return [Rucoa::Nodes::Base, nil]
     def root_node
       @root_node ||= Parser.call(@content)
+    rescue ::Parser::SyntaxError
+      nil
     end
 
+    private
+
     # @return [Array<Rucoa::Nodes::Base>]
     def root_and_descendant_nodes
       return [] unless root_node

data/lib/rucoa/source_store.rb

@@ -9,22 +9,18 @@ module Rucoa
       @data = {}
     end
 
+    # @param source [Rucoa::Source]
+    # @return [void]
+    def update(source)
+      @data[source.uri] = source
+    end
+
     # @param uri [String]
     # @return [String, nil]
     def get(uri)
       @data[uri]
     end
 
-    # @param uri [String]
-    # @param content [String]
-    # @return [void]
-    def set(uri, content)
-      @data[uri] = Source.new(
-        content: content,
-        path: path_from_uri(uri)
-      )
-    end
-
     # @yieldparam uri [String]
     # @return [Enumerable<String>]
     def each_uri(&block)

data/lib/rucoa/types/method_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Types
+    class MethodType
+      # @return [String]
+      attr_reader :parameters_string
+
+      # @return [String]
+      attr_reader :return_type
+
+      # @param parameters_string [String]
+      # @param return_type [String]
+      def initialize(
+        parameters_string:,
+        return_type:
+      )
+        @parameters_string = parameters_string
+        @return_type = return_type
+      end
+    end
+  end
+end

data/lib/rucoa/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Types
+    autoload :MethodType, 'rucoa/types/method_type'
+  end
+end

data/lib/rucoa/version.rb

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

data/lib/rucoa/yard_glob_document_loader.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'yard'
+
+module Rucoa
+  class YardGlobDocumentLoader
+    class << self
+      # @param globs [Array<String>]
+      # @return [Array<Rucoa::Definitions::Base>]
+      def call(globs:)
+        new(
+          globs: globs
+        ).call
+      end
+    end
+
+    # @param globs [String]
+    def initialize(globs:)
+      @globs = globs
+    end
+
+    # @return [Array<Rucoa::Definitions::Base>]
+    def call
+      code_objects.filter_map do |code_object|
+        case code_object
+        when ::YARD::CodeObjects::MethodObject
+          DefinitionBuilders::YardMethodDefinitionBuilder.call(
+            code_object: code_object,
+            path: code_object.file
+          )
+        end
+      end
+    end
+
+    private
+
+    # @return [Array<YARD::CodeObjects::Base>]
+    def code_objects
+      ::YARD::Logger.instance.enter_level(::Logger::FATAL) do
+        ::YARD::Registry.clear
+        ::YARD.parse(@globs)
+        ::YARD::Registry.all
+      end
+    end
+  end
+end

data/lib/rucoa/yard_string_document_loader.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'yard'
+
+module Rucoa
+  class YardStringDocumentLoader
+    class << self
+      # @param content [String]
+      # @return [Array<Rucoa::Definitions::Base>]
+      # @example returns method definitions from Ruby source code
+      #   content = <<~RUBY
+      #     class Foo
+      #       # Return given argument as an Integer.
+      #       # @param bar [String]
+      #       # @return [Integer]
+      #       def foo(bar)
+      #         bar.to_i
+      #       end
+      #     end
+      #   RUBY
+      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #     content: content,
+      #     path: '/path/to/foo.rb'
+      #   )
+      #   expect(definitions.size).to eq(1)
+      #   expect(definitions.first.full_qualified_name).to eq('Foo#foo')
+      #   expect(definitions.first.source_path).to eq('/path/to/foo.rb')
+      #   expect(definitions.first.description).to eq('Return given argument as an Integer.')
+      #   expect(definitions.first.return_types).to eq(%w[Integer])
+      def call(content:, path:)
+        new(
+          content: content,
+          path: path
+        ).call
+      end
+    end
+
+    # @param content [String]
+    # @param path [String]
+    def initialize(content:, path:)
+      @content = content
+      @path = path
+    end
+
+    # @return [Array<Rucoa::Definitions::Base>]
+    def call
+      code_objects.filter_map do |code_object|
+        case code_object
+        when ::YARD::CodeObjects::MethodObject
+          DefinitionBuilders::YardMethodDefinitionBuilder.call(
+            code_object: code_object,
+            path: @path
+          )
+        end
+      end
+    end
+
+    private
+
+    # @return [Array<YARD::CodeObjects::Base>]
+    def code_objects
+      ::YARD::Logger.instance.enter_level(::Logger::FATAL) do
+        ::YARD::Registry.clear
+        ::YARD.parse_string(@content)
+        ::YARD::Registry.all
+      end
+    end
+  end
+end

data/lib/rucoa.rb

@@ -4,26 +4,31 @@ require_relative 'rucoa/version'
 
 module Rucoa
   autoload :Cli, 'rucoa/cli'
-  autoload :CodeActionProvider, 'rucoa/code_action_provider'
   autoload :Configuration, 'rucoa/configuration'
-  autoload :DiagnosticProvider, 'rucoa/diagnostic_provider'
+  autoload :DefinitionArchiver, 'rucoa/definition_archiver'
+  autoload :DefinitionBuilders, 'rucoa/definition_builders'
+  autoload :Definitions, 'rucoa/definitions'
+  autoload :DefinitionStore, 'rucoa/definition_store'
   autoload :Errors, 'rucoa/errors'
-  autoload :FormattingProvider, 'rucoa/formatting_provider'
   autoload :HandlerConcerns, 'rucoa/handler_concerns'
   autoload :Handlers, 'rucoa/handlers'
   autoload :MessageReader, 'rucoa/message_reader'
   autoload :MessageWriter, 'rucoa/message_writer'
+  autoload :NodeConcerns, 'rucoa/node_concerns'
+  autoload :NodeInspector, 'rucoa/node_inspector'
   autoload :Nodes, 'rucoa/nodes'
   autoload :Parser, 'rucoa/parser'
   autoload :ParserBuilder, 'rucoa/parser_builder'
   autoload :Position, 'rucoa/position'
   autoload :Range, 'rucoa/range'
-  autoload :RangeFormattingProvider, 'rucoa/range_formatting_provider'
+  autoload :RbsDocumentLoader, 'rucoa/rbs_document_loader'
   autoload :RubocopAutocorrector, 'rucoa/rubocop_autocorrector'
   autoload :RubocopConfigurationChecker, 'rucoa/rubocop_configuration_checker'
   autoload :RubocopInvestigator, 'rucoa/rubocop_investigator'
-  autoload :SelectionRangeProvider, 'rucoa/selection_range_provider'
   autoload :Server, 'rucoa/server'
   autoload :Source, 'rucoa/source'
   autoload :SourceStore, 'rucoa/source_store'
+  autoload :Types, 'rucoa/types'
+  autoload :YardGlobDocumentLoader, 'rucoa/yard_glob_document_loader'
+  autoload :YardStringDocumentLoader, 'rucoa/yard_string_document_loader'
 end

data/rucoa.gemspec

@@ -28,5 +28,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'parser'
+  spec.add_dependency 'rbs'
   spec.add_dependency 'rubocop'
+  spec.add_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - r7kamura@gmail.com
@@ -54,46 +82,79 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- data/definitions_ruby_3_1
 - exe/rucoa
+- images/diagnostics.gif
+- images/document-formatting.gif
+- images/document-symbol.gif
+- images/selection-ranges.gif
 - lib/rucoa.rb
 - lib/rucoa/cli.rb
-- lib/rucoa/code_action_provider.rb
 - lib/rucoa/configuration.rb
-- lib/rucoa/diagnostic_provider.rb
+- lib/rucoa/definition_archiver.rb
+- lib/rucoa/definition_builders.rb
+- lib/rucoa/definition_builders/rbs_constant_definition_builder.rb
+- lib/rucoa/definition_builders/rbs_method_definition_builder.rb
+- lib/rucoa/definition_builders/yard_method_definition_builder.rb
+- lib/rucoa/definition_store.rb
+- lib/rucoa/definitions.rb
+- lib/rucoa/definitions/base.rb
+- lib/rucoa/definitions/constant_definition.rb
+- lib/rucoa/definitions/method_definition.rb
+- lib/rucoa/definitions/method_parameter_definition.rb
 - lib/rucoa/errors.rb
-- lib/rucoa/formatting_provider.rb
 - lib/rucoa/handler_concerns.rb
 - lib/rucoa/handler_concerns/configuration_requestable.rb
 - lib/rucoa/handler_concerns/diagnostics_publishable.rb
 - lib/rucoa/handlers.rb
 - lib/rucoa/handlers/base.rb
+- lib/rucoa/handlers/exit_handler.rb
 - lib/rucoa/handlers/initialize_handler.rb
 - 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_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_range_formatting_handler.rb
 - lib/rucoa/handlers/text_document_selection_range_handler.rb
+- lib/rucoa/handlers/text_document_signature_help_handler.rb
 - lib/rucoa/handlers/workspace_did_change_configuration_handler.rb
 - lib/rucoa/message_reader.rb
 - lib/rucoa/message_writer.rb
+- lib/rucoa/node_concerns.rb
+- lib/rucoa/node_concerns/name_full_qualifiable.rb
+- lib/rucoa/node_inspector.rb
 - lib/rucoa/nodes.rb
 - lib/rucoa/nodes/base.rb
+- lib/rucoa/nodes/casgn_node.rb
+- lib/rucoa/nodes/class_node.rb
+- lib/rucoa/nodes/const_node.rb
+- lib/rucoa/nodes/def_node.rb
+- lib/rucoa/nodes/defs_node.rb
+- lib/rucoa/nodes/lvar_node.rb
+- lib/rucoa/nodes/module_node.rb
+- lib/rucoa/nodes/sclass_node.rb
+- lib/rucoa/nodes/send_node.rb
 - lib/rucoa/nodes/str_node.rb
+- lib/rucoa/nodes/sym_node.rb
 - lib/rucoa/parser.rb
 - lib/rucoa/parser_builder.rb
 - lib/rucoa/position.rb
 - lib/rucoa/range.rb
-- lib/rucoa/range_formatting_provider.rb
+- lib/rucoa/rbs_document_loader.rb
 - lib/rucoa/rubocop_autocorrector.rb
 - lib/rucoa/rubocop_configuration_checker.rb
 - lib/rucoa/rubocop_investigator.rb
-- lib/rucoa/selection_range_provider.rb
 - lib/rucoa/server.rb
 - lib/rucoa/source.rb
 - lib/rucoa/source_store.rb
+- lib/rucoa/types.rb
+- lib/rucoa/types/method_type.rb
 - lib/rucoa/version.rb
+- lib/rucoa/yard_glob_document_loader.rb
+- lib/rucoa/yard_string_document_loader.rb
 - rucoa.gemspec
 homepage: https://github.com/r7kamura/rucoa
 licenses:

data/lib/rucoa/code_action_provider.rb

@@ -1,102 +0,0 @@
-# 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