rucoa 0.6.0 → 0.8.0

data/lib/rucoa/yard/definitions_loader.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'yard'
+
+module Rucoa
+  module Yard
+    class DefinitionsLoader
+      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::Yard::DefinitionsLoader.load_string(
+        #     content: content,
+        #     path: '/path/to/foo.rb'
+        #   )
+        #   expect(definitions.size).to eq(2)
+        #   expect(definitions[1].full_qualified_name).to eq('Foo#foo')
+        #   expect(definitions[1].source_path).to eq('/path/to/foo.rb')
+        #   expect(definitions[1].description).to eq('Return given argument as an Integer.')
+        #   expect(definitions[1].return_types).to eq(%w[Integer])
+        def load_string(content:, path:)
+          load(path: path) do
+            ::YARD.parse_string(content)
+          end
+        end
+
+        # @param globs [String]
+        # @return [Array<Rucoa::Definitions::Base>]
+        def load_globs(globs:)
+          load do
+            ::YARD.parse(globs)
+          end
+        end
+
+        private
+
+        # @param code_object [YARD::CodeObjects::Base]
+        # @param path [String, nil]
+        # @return [Rucoa::Definitions::Base, nil]
+        def map(code_object, path:)
+          case code_object
+          when ::YARD::CodeObjects::ClassObject
+            Definitions::ClassDefinition.new(
+              full_qualified_name: code_object.path,
+              source_path: path || code_object.file,
+              super_class_name: code_object.superclass.to_s # TODO: superclass may not include full namespace on `YARD.parse_string`.
+            )
+          when ::YARD::CodeObjects::ModuleObject
+            Definitions::ModuleDefinition.new(
+              full_qualified_name: code_object.path,
+              source_path: path || code_object.file
+            )
+          when ::YARD::CodeObjects::MethodObject
+            MethodDefinitionMapper.call(code_object, path: path)
+          end
+        end
+
+        # @param path [String, nil]
+        # @return [Array<Rucoa::Definitions::Base>]
+        def load(path: nil, &block)
+          ::YARD::Registry.clear
+          quietly(&block)
+          ::YARD::Registry.all.filter_map do |code_object|
+            map(code_object, path: path)
+          end
+        end
+
+        def quietly(&block)
+          ::YARD::Logger.instance.enter_level(::Logger::FATAL, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/{definition_builders/yard_method_definition_builder.rb → yard/method_definition_mapper.rb}

@@ -3,30 +3,27 @@
 require 'yard'
 
 module Rucoa
-  module DefinitionBuilders
-    class YardMethodDefinitionBuilder
+  module Yard
+    class MethodDefinitionMapper
       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
+        # @param path [String] This must be passed if the path is not available from code object.
+        # @return [Rucoa::Definitions::Base, nil]
+        def call(code_object, path: code_object.file)
+          new(code_object, path: path).call
         end
       end
 
-      # @param code_object [YARD::CodeObjects::Base]
+      # @param code_object [YARD::CodeObjects::MethodObject]
       # @param path [String]
-      def initialize(code_object:, path:)
+      def initialize(code_object, path:)
         @code_object = code_object
         @path = path
       end
 
-      # @return [Rucoa::Definitions::Base]
+      # @return [Rucoa::Definitions::MethodDefinition]
       def call
-        ::Rucoa::Definitions::MethodDefinition.new(
+        Definitions::MethodDefinition.new(
           description: description,
           kind: kind,
           method_name: method_name,
@@ -52,9 +49,9 @@ module Rucoa
         end
       end
 
-      # @return [String
+      # @return [String]
       def method_name
-        @code_object.name
+        @code_object.name.to_s
       end
 
       # @return [String]
@@ -74,7 +71,7 @@ module Rucoa
 
       # @return [String]
       # @example
-      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #   definitions = Rucoa::Yard::DefinitionsLoader.load_string(
       #     content: <<~RUBY,
       #       class Foo
       #         def bar(
@@ -91,7 +88,7 @@ module Rucoa
       #     RUBY
       #     path: '/path/to/foo.rb'
       #   )
-      #   expect(definitions.first.signatures).to eq(
+      #   expect(definitions[1].signatures).to eq(
       #     [
       #       'Foo#bar(argument1, argument2 = nil, *arguments, keyword1:, keyword2: nil, **keywords, &block) -> Object'
       #     ]
@@ -116,7 +113,7 @@ module Rucoa
       # @return [Array<Rucoa::Definitions::MethodParameterDefinition>]
       def parameters
         parameter_tags.map do |parameter_tag|
-          ::Rucoa::Definitions::MethodParameterDefinition.new(
+          Definitions::MethodParameterDefinition.new(
             name: parameter_tag.name,
             types: parameter_tag.types
           )
@@ -133,7 +130,7 @@ module Rucoa
       # @return [Array<String>]
       # @return [String]
       # @example returns return type annotated by YARD @return tags
-      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #   definitions = Rucoa::Yard::DefinitionsLoader.load_string(
       #     content: <<~RUBY,
       #       # @return [String]
       #       def foo
@@ -148,7 +145,7 @@ module Rucoa
       #     ]
       #   )
       # @example ignores empty @return tags
-      #   definitions = Rucoa::YardStringDocumentLoader.call(
+      #   definitions = Rucoa::Yard::DefinitionsLoader.load_string(
       #     content: <<~RUBY,
       #       # @return []
       #       def foo
@@ -181,27 +178,27 @@ module Rucoa
 
         # @return [String]
         # @example scrubs "Array<String>" to "Array"
-        #   yard_type = Rucoa::DefinitionBuilders::YardMethodDefinitionBuilder::YardType.new(
+        #   yard_type = Rucoa::Yard::MethodDefinitionMapper::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(
+        #   yard_type = Rucoa::Yard::MethodDefinitionMapper::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(
+        #   yard_type = Rucoa::Yard::MethodDefinitionMapper::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(
+        #   yard_type = Rucoa::Yard::MethodDefinitionMapper::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(
+        #   yard_type = Rucoa::Yard::MethodDefinitionMapper::YardType.new(
         #     'Array<Array<Integer>>'
         #   )
         #   expect(yard_type.to_rucoa_type).to eq('Array')

data/lib/rucoa/yard.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    autoload :DefinitionsLoader, 'rucoa/yard/definitions_loader'
+    autoload :MethodDefinitionMapper, 'rucoa/yard/method_definition_mapper'
+  end
+end

data/lib/rucoa.rb

@@ -6,7 +6,6 @@ module Rucoa
   autoload :Cli, 'rucoa/cli'
   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'
@@ -21,14 +20,11 @@ module Rucoa
   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 :Rbs, 'rucoa/rbs'
+  autoload :Rubocop, 'rucoa/rubocop'
   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'
+  autoload :Yard, 'rucoa/yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rucoa
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -92,16 +92,14 @@ files:
 - lib/rucoa/cli.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/class_definition.rb
 - lib/rucoa/definitions/constant_definition.rb
 - lib/rucoa/definitions/method_definition.rb
 - lib/rucoa/definitions/method_parameter_definition.rb
+- lib/rucoa/definitions/module_definition.rb
 - lib/rucoa/errors.rb
 - lib/rucoa/handler_concerns.rb
 - lib/rucoa/handler_concerns/configuration_requestable.rb
@@ -114,7 +112,9 @@ files:
 - lib/rucoa/handlers/shutdown_handler.rb
 - lib/rucoa/handlers/text_document_code_action_handler.rb
 - lib/rucoa/handlers/text_document_completion_handler.rb
+- lib/rucoa/handlers/text_document_definition_handler.rb
 - lib/rucoa/handlers/text_document_did_change_handler.rb
+- lib/rucoa/handlers/text_document_did_close_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
@@ -145,18 +145,25 @@ files:
 - 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/rbs.rb
+- lib/rucoa/rbs/class_definition_mapper.rb
+- lib/rucoa/rbs/constant_definition_mapper.rb
+- lib/rucoa/rbs/method_definition_mapper.rb
+- lib/rucoa/rbs/module_definition_mapper.rb
+- lib/rucoa/rbs/ruby_definitions_loader.rb
+- lib/rucoa/rubocop.rb
+- lib/rucoa/rubocop/autocorrector.rb
+- lib/rucoa/rubocop/configuration_checker.rb
+- lib/rucoa/rubocop/investigator.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
+- lib/rucoa/yard.rb
+- lib/rucoa/yard/definitions_loader.rb
+- lib/rucoa/yard/method_definition_mapper.rb
 - rucoa.gemspec
 homepage: https://github.com/r7kamura/rucoa
 licenses:

data/lib/rucoa/definition_builders.rb

@@ -1,9 +0,0 @@
-# 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/rbs_document_loader.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'rbs'
-
-module Rucoa
-  class RbsDocumentLoader
-    class << self
-      def call
-        new.call
-      end
-    end
-
-    # @return [Array<Rucoa::Definitions::Base>]
-    def call
-      declarations.flat_map do |declaration|
-        case declaration
-        when ::RBS::AST::Declarations::Constant
-          [
-            DefinitionBuilders::RbsConstantDefinitionBuilder.call(declaration: declaration)
-          ]
-        when ::RBS::AST::Declarations::Class, ::RBS::AST::Declarations::Module
-          declaration.members.grep(::RBS::AST::Members::MethodDefinition).map do |method_definition|
-            DefinitionBuilders::RbsMethodDefinitionBuilder.call(
-              declaration: declaration,
-              method_definition: method_definition
-            )
-          end
-        else
-          []
-        end
-      end
-    end
-
-    private
-
-    # @return [Array<RBS::AST::Declarations::Base>]
-    def declarations
-      ::RBS::Environment.from_loader(
-        ::RBS::EnvironmentLoader.new
-      ).resolve_type_names.declarations
-    end
-  end
-end

data/lib/rucoa/rubocop_autocorrector.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Rucoa
-  class RubocopAutocorrector < ::RuboCop::Runner
-    class << self
-      # @param source [Rucoa::Source]
-      # @return [String]
-      def call(source:)
-        new(source: source).call
-      end
-    end
-
-    # @param source [Rucoa::Source]
-    def initialize(source:)
-      @source = source
-      super(
-        ::RuboCop::Options.new.parse(
-          %w[
-            --stderr
-            --force-exclusion
-            --format RuboCop::Formatter::BaseFormatter
-            -A
-          ]
-        ).first,
-        ::RuboCop::ConfigStore.new
-      )
-    end
-
-    # @return [String]
-    def call
-      @options[:stdin] = @source.content
-      run([@source.path || 'untitled'])
-      @options[:stdin]
-    end
-  end
-end

data/lib/rucoa/rubocop_configuration_checker.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-
-module Rucoa
-  class RubocopConfigurationChecker
-    class << self
-      # @return [Boolean]
-      def call
-        new.call
-      end
-    end
-
-    # @return [Boolean]
-    def call
-      rubocop_configured_for_current_directory?
-    end
-
-    private
-
-    # @return [Boolean]
-    def rubocop_configured_for_current_directory?
-      each_current_and_ancestor_pathname.any? do |pathname|
-        pathname.join('.rubocop.yml').exist?
-      end
-    end
-
-    # @return [Enumerable<Pathname>]
-    def each_current_and_ancestor_pathname
-      return to_enum(__method__) unless block_given?
-
-      pathname = ::Pathname.pwd
-      loop do
-        yield pathname
-        break if pathname.root?
-
-        pathname = pathname.parent
-      end
-      self
-    end
-  end
-end

data/lib/rucoa/rubocop_investigator.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'rubocop'
-
-module Rucoa
-  class RubocopInvestigator < ::RuboCop::Runner
-    class << self
-      # @param source [Rucoa::Source]
-      # @return [Array<RuboCop::Cop::Offense>]
-      def call(source:)
-        new(source: source).call
-      end
-    end
-
-    # @param source [Rucoa::Source]
-    def initialize(source:)
-      @source = source
-      @offenses = []
-      super(
-        ::RuboCop::Options.new.parse(
-          %w[
-            --stderr
-            --force-exclusion
-            --format RuboCop::Formatter::BaseFormatter
-          ]
-        ).first,
-        ::RuboCop::ConfigStore.new
-      )
-    end
-
-    # @return [Array<RuboCop::Cop::Offense>]
-    def call
-      @options[:stdin] = @source.content
-      run([@source.path || 'untitled'])
-      @offenses
-    end
-
-    private
-
-    # @param file [String]
-    # @param offenses [Array<RuboCop::Cop::Offense>]
-    # @return [void]
-    def file_finished(file, offenses)
-      @offenses = offenses
-      super
-    end
-  end
-end

data/lib/rucoa/yard_glob_document_loader.rb

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

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