rucoa 0.2.0 → 0.5.0

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,21 +4,31 @@ require_relative 'rucoa/version'
 
 module Rucoa
   autoload :Cli, 'rucoa/cli'
-  autoload :CodeActionProvider, 'rucoa/code_action_provider'
-  autoload :DiagnosticProvider, 'rucoa/diagnostic_provider'
+  autoload :Configuration, 'rucoa/configuration'
+  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 :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,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'parser'
+  spec.add_dependency 'rbs'
   spec.add_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-04 00:00:00.000000000 Z
+date: 2022-09-10 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
@@ -54,29 +68,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/diagnostic_provider.rb
+- lib/rucoa/configuration.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/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

data/lib/rucoa/diagnostic_provider.rb

@@ -1,159 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-
-module Rucoa
-  class DiagnosticProvider
-    # @param source [Rucoa::Source]
-    # @param uri [String]
-    # @return [Array<Hash>]
-    def self.call(source:, uri:)
-      new(
-        source: source,
-        uri: uri
-      ).call
-    end
-
-    # @param source [Rucoa::Source]
-    # @param uri [String]
-    def initialize(source:, uri:)
-      @source = source
-      @uri = uri
-    end
-
-    # @return [Array<Hash>]
-    def call
-      return [] unless rubocop_configured?
-
-      offenses.map do |offense|
-        OffenseToDiagnosticMapper.call(
-          offense,
-          uri: @uri
-        )
-      end
-    end
-
-    private
-
-    # @return [Array<RuboCop::Cop::Offense>]
-    def offenses
-      RubocopInvestigator.call(source: @source)
-    end
-
-    # @return [Boolean]
-    def rubocop_configured?
-      each_ancestor_pathname.any? do |pathname|
-        pathname.join('.rubocop.yml').exist?
-      end
-    end
-
-    # @return [Enumerable<Pathname>]
-    def each_ancestor_pathname
-      return to_enum(__method__) unless block_given?
-
-      pathname = ::Pathname.new(@source.path)
-      loop do
-        pathname = pathname.parent
-        yield pathname
-        break if pathname.root?
-      end
-      self
-    end
-
-    class OffenseToDiagnosticMapper
-      LSP_SEVERITY_NAME_TO_VALUE_MAP = {
-        error: 1,
-        hint: 4,
-        information: 3,
-        warning: 2
-      }.freeze
-      private_constant :LSP_SEVERITY_NAME_TO_VALUE_MAP
-
-      RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP = {
-        convention: LSP_SEVERITY_NAME_TO_VALUE_MAP[:information],
-        error: LSP_SEVERITY_NAME_TO_VALUE_MAP[:error],
-        fatal: LSP_SEVERITY_NAME_TO_VALUE_MAP[:error],
-        info: LSP_SEVERITY_NAME_TO_VALUE_MAP[:information],
-        refactor: LSP_SEVERITY_NAME_TO_VALUE_MAP[:hint],
-        warning: LSP_SEVERITY_NAME_TO_VALUE_MAP[:warning]
-      }.freeze
-      private_constant :RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP
-
-      class << self
-        # @param offense [RuboCop::Cop::Offense]
-        # @param uri [String]
-        # @return [Hash]
-        def call(offense, uri:)
-          new(offense, uri: uri).call
-        end
-      end
-
-      # @param offense [RuboCop::Cop::Offense]
-      # @param uri [String]
-      def initialize(offense, uri:)
-        @offense = offense
-        @uri = uri
-      end
-
-      # @return [Hash]
-      def call
-        {
-          code: code,
-          data: data,
-          message: message,
-          range: range,
-          severity: severity,
-          source: source
-        }
-      end
-
-      private
-
-      # @return [String]
-      def code
-        @offense.cop_name
-      end
-
-      # @return [Hash]
-      def data
-        {
-          cop_name: @offense.cop_name,
-          edits: edits,
-          path: @offense.location.source_buffer.name,
-          range: range,
-          uri: @uri
-        }
-      end
-
-      # @return [Array<Hash>, nil]
-      def edits
-        @offense.corrector&.as_replacements&.map do |range, replacement|
-          {
-            newText: replacement,
-            range: Range.from_parser_range(range).to_vscode_range
-          }
-        end
-      end
-
-      # @return [String]
-      def message
-        @offense.message.delete_prefix("#{@offense.cop_name}: ")
-      end
-
-      # @return [Hash]
-      def range
-        Range.from_parser_range(@offense.location).to_vscode_range
-      end
-
-      # @return [Integer]
-      def severity
-        RUBOCOP_SEVERITY_NAME_TO_LSP_SEVERITY_MAP.fetch(@offense.severity.name, 1)
-      end
-
-      # @return [String]
-      def source
-        'RuboCop'
-      end
-    end
-  end
-end

data/lib/rucoa/formatting_provider.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Rucoa
-  class FormattingProvider
-    class << self
-      # @param source [Rucoa::Source]
-      # @return [Array<Hash>]
-      def call(source:)
-        new(source: source).call
-      end
-    end
-
-    # @param source [Rucoa::Source]
-    def initialize(source:)
-      @source = source
-    end
-
-    # @return [Array<Hash>]
-    def call
-      [text_edit]
-    end
-
-    private
-
-    # @return [Hash]
-    def text_edit
-      {
-        newText: new_text,
-        range: range
-      }
-    end
-
-    # @return [String]
-    def new_text
-      RubocopAutocorrector.call(source: @source)
-    end
-
-    # @return [Hash]
-    def range
-      Range.new(
-        Position.new(
-          column: 0,
-          line: 1
-        ),
-        Position.new(
-          column: @source.content.lines.last.length,
-          line: @source.content.lines.count + 1
-        )
-      ).to_vscode_range
-    end
-  end
-end

data/lib/rucoa/selection_range_provider.rb

@@ -1,97 +0,0 @@
-# frozen_string_literal: true
-
-module Rucoa
-  class SelectionRangeProvider
-    class << self
-      # @param source [Rucoa::Source]
-      # @param position [Rucoa::Position]
-      # @return [Hash, nil]
-      def call(position:, source:)
-        new(
-          position: position,
-          source: source
-        ).call
-      end
-    end
-
-    # @param position [Rucoa::Position]
-    # @param source [Rucoa::Source]
-    def initialize(position:, source:)
-      @position = position
-      @source = source
-    end
-
-    # @return [Hash, nil]
-    def call
-      ranges.reverse.reduce(nil) do |result, range|
-        {
-          parent: result,
-          range: range.to_vscode_range
-        }
-      end
-    end
-
-    private
-
-    # @return [Rucoa::Nodes::Base, nil]
-    def node_at_position
-      if instance_variable_defined?(:@node_at_position)
-        @node_at_position
-      else
-        @node_at_position = @source.node_at(@position)
-      end
-    end
-
-    # @return [Array<Rucoa::Range>]
-    def ranges
-      return [] unless node_at_position
-
-      [node_at_position, *node_at_position.ancestors].flat_map do |node|
-        NodeToRangesMapper.call(node)
-      end
-    end
-
-    class NodeToRangesMapper
-      class << self
-        # @param node [Rucoa::Nodes::Base]
-        # @return [Array<Rucoa::Range>]
-        def call(node)
-          new(node).call
-        end
-      end
-
-      # @param node [Rucoa::Nodes::Base]
-      def initialize(node)
-        @node = node
-      end
-
-      # @return [Array<Rucoa::Range>]
-      def call
-        case @node
-        when Nodes::StrNode
-          [
-            inner_range,
-            expression_range
-          ]
-        else
-          []
-        end
-      end
-
-      private
-
-      # @return [Rucoa::Range]
-      def inner_range
-        Range.new(
-          Position.from_parser_range_ending(@node.location.begin),
-          Position.from_parser_range_beginning(@node.location.end)
-        )
-      end
-
-      # @return [Rucoa::Range]
-      def expression_range
-        Range.from_parser_range(@node.location.expression)
-      end
-    end
-  end
-end