rucoa 0.8.0 → 0.10.0

data/lib/rucoa/parser_builder.rb

@@ -5,7 +5,9 @@ require 'parser/current'
 module Rucoa
   class ParserBuilder < ::Parser::Builders::Default
     NODE_CLASS_BY_TYPE = {
+      begin: Nodes::BeginNode,
       casgn: Nodes::CasgnNode,
+      cbase: Nodes::CbaseNode,
       class: Nodes::ClassNode,
       const: Nodes::ConstNode,
       def: Nodes::DefNode,
@@ -27,7 +29,11 @@ module Rucoa
     end
 
     # @note Override.
-    def n(type, children, source_map)
+    def n(
+      type,
+      children,
+      source_map
+    )
       self.class.node_class_for(type).new(
         type,
         children,

data/lib/rucoa/position.rb

@@ -39,11 +39,20 @@ module Rucoa
 
     # @param column [Integer] 0-origin column number
     # @param line [Integer] 1-origin line number
-    def initialize(column: 0, line: 1)
+    def initialize(
+      column: 0,
+      line: 1
+    )
       @column = column
       @line = line
     end
 
+    # @param other [Rucoa::Position]
+    # @return [Boolean]
+    def ==(other)
+      column == other.column && line == other.line
+    end
+
     # @param text [String]
     # @return [Integer]
     def to_index_of(text)

data/lib/rucoa/range.rb

@@ -31,12 +31,22 @@ module Rucoa
     # @param beginning [Rucoa::Position]
     # @param ending [Ruoca::Position]
     # @param including_ending [Boolean]
-    def initialize(beginning, ending, including_ending: true)
+    def initialize(
+      beginning,
+      ending,
+      including_ending: true
+    )
       @beginning = beginning
       @ending = ending
       @including_ending = including_ending
     end
 
+    # @param other [Rucoa::Range]
+    # @return [Boolean]
+    def ==(other)
+      beginning == other.beginning && ending == other.ending
+    end
+
     # @param range [Rucoa::Range]
     # @return [Boolean]
     # @example returns true when the range is contained in self

data/lib/rucoa/rbs/class_definition_mapper.rb

@@ -2,43 +2,28 @@
 
 module Rucoa
   module Rbs
-    class ClassDefinitionMapper
-      class << self
-        # @param declaration [RBS::AST::Declarations::Class]
-        # @return [Rucoa::Definitions::ClassDefinition]
-        def call(declaration:)
-          new(declaration: declaration).call
-        end
-      end
-
-      # @param declaration [RBS::AST::Declarations::Class]
-      def initialize(declaration:)
-        @declaration = declaration
-      end
-
+    class ClassDefinitionMapper < ModuleDefinitionMapper
       # @return [Rucoa::Definitions::ClassDefinition]
+      # @example supports `include`
+      #   definition_store = Rucoa::DefinitionStore.new
+      #   definition_store.bulk_add(Rucoa::DefinitionArchiver.load)
+      #   subject = definition_store.find_definition_by_qualified_name('Array')
+      #   expect(subject.included_module_qualified_names).to include('Enumerable')
       def call
         Definitions::ClassDefinition.new(
-          full_qualified_name: full_qualified_name,
-          source_path: source_path,
-          super_class_name: super_class_name
+          description: description,
+          included_module_qualified_names: included_module_qualified_names,
+          location: location,
+          prepended_module_qualified_names: prepended_module_qualified_names,
+          qualified_name: qualified_name,
+          super_class_qualified_name: super_class_qualified_name
         )
       end
 
       private
 
-      # @return [String]
-      def full_qualified_name
-        @declaration.name.to_s.delete_prefix('::')
-      end
-
-      # @return [String]
-      def source_path
-        @declaration.location.name
-      end
-
       # @return [String, nil]
-      def super_class_name
+      def super_class_qualified_name
         @declaration.super_class&.name&.to_s&.delete_prefix('::')
       end
     end

data/lib/rucoa/rbs/constant_definition_mapper.rb

@@ -19,21 +19,27 @@ module Rucoa
       # @return [Rucoa::Definitions::ConstantDefinition]
       def call
         Definitions::ConstantDefinition.new(
-          full_qualified_name: full_qualified_name,
-          source_path: source_path
+          description: description,
+          location: location,
+          qualified_name: qualified_name
         )
       end
 
       private
 
+      # @return [String, nil]
+      def description
+        @declaration.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
+      end
+
       # @return [String]
-      def full_qualified_name
+      def qualified_name
         @declaration.name.to_s.delete_prefix('::')
       end
 
-      # @return [String]
-      def source_path
-        @declaration.location.name
+      # @return [Rucoa::Location]
+      def location
+        Location.from_rbs_location(@declaration.location)
       end
     end
   end

data/lib/rucoa/rbs/method_definition_mapper.rb

@@ -7,7 +7,10 @@ module Rucoa
         # @param declaration [RBS::AST::Declarations::Class, RBS::AST::Declarations::Module]
         # @param method_definition [RBS::AST::Members::MethodDefinition]
         # @return [Rucoa::Definitions::MethodDefinition]
-        def call(declaration:, method_definition:)
+        def call(
+          declaration:,
+          method_definition:
+        )
           new(
             declaration: declaration,
             method_definition: method_definition
@@ -17,7 +20,10 @@ module Rucoa
 
       # @param declaration [RBS::AST::Declarations::Class, RBS::AST::Declarations::Module]
       # @param method_definition [RBS::AST::Members::MethodDefinition]
-      def initialize(declaration:, method_definition:)
+      def initialize(
+        declaration:,
+        method_definition:
+      )
         @declaration = declaration
         @method_definition = method_definition
       end
@@ -27,9 +33,9 @@ module Rucoa
         Definitions::MethodDefinition.new(
           description: description,
           kind: kind,
+          location: location,
           method_name: method_name,
           namespace: namespace,
-          source_path: source_path,
           types: types
         )
       end
@@ -65,9 +71,9 @@ module Rucoa
         @method_definition.kind
       end
 
-      # @return [String]
-      def source_path
-        @declaration.location.name
+      # @return [Rucoa::Location]
+      def location
+        Location.from_rbs_location(@method_definition.location)
       end
 
       class MethodTypeMapper

data/lib/rucoa/rbs/module_definition_mapper.rb

@@ -19,21 +19,49 @@ module Rucoa
       # @return [Rucoa::Definitions::ModuleDefinition]
       def call
         Definitions::ModuleDefinition.new(
-          full_qualified_name: full_qualified_name,
-          source_path: source_path
+          description: description,
+          included_module_qualified_names: included_module_qualified_names,
+          location: location,
+          prepended_module_qualified_names: prepended_module_qualified_names,
+          qualified_name: qualified_name
         )
       end
 
       private
 
+      # @return [String, nil]
+      def description
+        @declaration.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
+      end
+
       # @return [String]
-      def full_qualified_name
+      def qualified_name
         @declaration.name.to_s.delete_prefix('::')
       end
 
-      # @return [String]
-      def source_path
-        @declaration.location.name
+      # @return [Rucoa::Location]
+      def location
+        Location.from_rbs_location(@declaration.location)
+      end
+
+      # @return [Array<String>]
+      def included_module_qualified_names
+        @declaration.members.filter_map do |member|
+          case member
+          when ::RBS::AST::Members::Include
+            member.name.to_s.delete_prefix('::')
+          end
+        end
+      end
+
+      # @return [Array<String>]
+      def prepended_module_qualified_names
+        @declaration.members.filter_map do |member|
+          case member
+          when ::RBS::AST::Members::Prepend
+            member.name.to_s.delete_prefix('::')
+          end
+        end
       end
     end
   end

data/lib/rucoa/rubocop/autocorrector.rb

@@ -40,10 +40,10 @@ module Rucoa
 
       # @return [String]
       def path
-        if @source.untitled? || @source.path.nil?
+        if @source.untitled?
           'untitled'
         else
-          @source.path
+          @source.name
         end
       end
     end

data/lib/rucoa/rubocop/investigator.rb

@@ -41,17 +41,20 @@ module Rucoa
       # @param file [String]
       # @param offenses [Array<RuboCop::Cop::Offense>]
       # @return [void]
-      def file_finished(file, offenses)
+      def file_finished(
+        file,
+        offenses
+      )
         @offenses = offenses
         super
       end
 
       # @return [String]
       def path
-        if @source.untitled? || @source.path.nil?
+        if @source.untitled?
           'untitled'
         else
-          @source.path
+          @source.name
         end
       end
     end

data/lib/rucoa/server.rb

@@ -59,7 +59,7 @@ module Rucoa
       @source_store = SourceStore.new
 
       @definition_store = DefinitionStore.new
-      @definition_store.definitions += DefinitionArchiver.load
+      @definition_store.bulk_add(DefinitionArchiver.load)
     end
 
     # @return [void]
@@ -83,7 +83,10 @@ module Rucoa
     # @yieldparam response [Hash]
     # @param message [Hash]
     # @return [void]
-    def write(message, &block)
+    def write(
+      message,
+      &block
+    )
       if block
         write_server_request(message, &block)
       else
@@ -139,7 +142,10 @@ module Rucoa
 
     # @param message [Hash]
     # @return [void]
-    def write_server_request(message, &block)
+    def write_server_request(
+      message,
+      &block
+    )
       message = message.merge('id' => @server_request_id)
       debug do
         {

data/lib/rucoa/source.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'uri'
+
 module Rucoa
   class Source
     # @return [String]
@@ -9,8 +11,11 @@ module Rucoa
     attr_reader :uri
 
     # @param content [String]
-    # @param uri [String, nil]
-    def initialize(content:, uri: nil)
+    # @param uri [String]
+    def initialize(
+      content:,
+      uri:
+    )
       @content = content
       @uri = uri
     end
@@ -33,35 +38,49 @@ module Rucoa
     #       a_kind_of(Rucoa::Definitions::MethodDefinition)
     #     ]
     #   )
+    # @example returns empty array when failed to parse
+    #   source = Rucoa::Source.new(
+    #     content: 'class Foo',
+    #     uri: 'file:///path/to/foo.rb'
+    #   )
+    #   expect(source.definitions).to eq([])
+    # @example returns empty array when no node is found from content
+    #   source = Rucoa::Source.new(
+    #     content: '',
+    #     uri: 'file:///path/to/foo.rb'
+    #   )
+    #   expect(source.definitions).to eq([])
     def definitions
-      @definitions ||= Yard::DefinitionsLoader.load_string(
-        content: @content,
-        path: path
-      )
+      @definitions ||=
+        if parse_result.failed? || root_node.nil?
+          []
+        else
+          Yard::DefinitionsLoader.call(
+            associations: parse_result.associations,
+            root_node: parse_result.root_node
+          )
+        end
     end
 
     # @return [String, nil]
-    # @example returns path from given VSCode URI
+    # @example returns path for file URI
     #   source = Rucoa::Source.new(
     #     content: '',
     #     uri: 'file:///path/to/foo.rb'
     #   )
-    #   expect(source.path).to eq('/path/to/foo.rb')
-    # @example returns name for untitled URI
+    #   expect(source.name).to eq('/path/to/foo.rb')
+    # @example returns opaque for untitled URI
     #   source = Rucoa::Source.new(
     #     content: '',
     #     uri: 'untitled:Untitled-1'
     #   )
-    #   expect(source.path).to eq('Untitled-1')
-    def path
-      return unless @uri
-
-      return @uri.split(':', 2).last if untitled?
-
-      path = ::URI.parse(@uri).path
-      return unless path
-
-      ::CGI.unescape(path)
+    #   expect(source.name).to eq('Untitled-1')
+    def name
+      if untitled?
+        uri_object.opaque
+      else
+        uri_object.path
+      end
     end
 
     # @param position [Rucoa::Position]
@@ -70,34 +89,45 @@ module Rucoa
       root_and_descendant_nodes.reverse.find do |node|
         node.include_position?(position)
       end
-    rescue ::Parser::SyntaxError
-      nil
     end
 
     # @return [Rucoa::Nodes::Base, nil]
     def root_node
-      @root_node ||= Parser.call(@content)
-    rescue ::Parser::SyntaxError
-      nil
+      parse_result.root_node
     end
 
     # @return [Boolean]
-    def syntax_error?
-      root_node.nil?
+    def failed_to_parse?
+      parse_result.failed?
     end
 
     # @return [Boolean]
     def untitled?
-      @uri&.start_with?('untitled:')
+      uri_object.scheme == 'untitled'
     end
 
     private
 
+    # @return [Rucoa::ParseResult]
+    def parse_result
+      return @parse_result if instance_variable_defined?(:@parse_result)
+
+      @parse_result = Parser.call(
+        text: @content,
+        uri: @uri
+      )
+    end
+
     # @return [Array<Rucoa::Nodes::Base>]
     def root_and_descendant_nodes
       return [] unless root_node
 
       [root_node, *root_node.descendants]
     end
+
+    # @return [URI]
+    def uri_object
+      @uri_object ||= ::URI.parse(@uri)
+    end
   end
 end

data/lib/rucoa/source_store.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'cgi'
-require 'uri'
-
 module Rucoa
   class SourceStore
     def initialize
@@ -26,15 +23,5 @@ module Rucoa
     def each_uri(&block)
       @data.each_key(&block)
     end
-
-    private
-
-    # @param uri [String]
-    # @return [String]
-    def path_from_uri(uri)
-      ::CGI.unescape(
-        ::URI.parse(uri).path || 'untitled'
-      )
-    end
   end
 end

data/lib/rucoa/unqualified_name.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  UnqualifiedName = ::Struct.new(
+    :chained_name,
+    :module_nesting,
+    keyword_init: true
+  )
+end

data/lib/rucoa/version.rb

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

data/lib/rucoa/yard/definition_generators/attribute_reader_definition_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class AttributeReaderDefinitionGenerator < Base
+        READER_METHOD_NAMES = ::Set[
+          'attr_accessor',
+          'attr_reader'
+        ].freeze
+
+        # @example returns method definition for attr_reader node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         attr_reader :bar
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[1]).to be_a(Rucoa::Definitions::MethodDefinition)
+        # @example returns method definition for attr_accessor node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         attr_accessor :bar
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions.map(&:qualified_name)).to eq(
+        #     %w[
+        #       Foo
+        #       Foo#bar
+        #       Foo#bar=
+        #     ]
+        #   )
+        def call
+          return [] unless @node.is_a?(Nodes::SendNode) && READER_METHOD_NAMES.include?(@node.name)
+
+          @node.arguments.map do |argument|
+            Definitions::MethodDefinition.new(
+              description: description,
+              kind: :instance,
+              location: location,
+              method_name: argument.value.to_s,
+              namespace: @node.namespace,
+              types: return_types.map do |type|
+                Types::MethodType.new(
+                  parameters_string: '', # TODO
+                  return_type: type
+                )
+              end
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/yard/definition_generators/attribute_writer_definition_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class AttributeWriterDefinitionGenerator < Base
+        WRITER_METHOD_NAMES = ::Set[
+          'attr_accessor',
+          'attr_writer'
+        ].freeze
+
+        # @example returns method definition for attr_writer node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         attr_writer :bar
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[1]).to be_a(Rucoa::Definitions::MethodDefinition)
+        # @example returns method definition for attr_accessor node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         attr_accessor :bar
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions.map(&:qualified_name)).to eq(
+        #     %w[
+        #       Foo
+        #       Foo#bar
+        #       Foo#bar=
+        #     ]
+        #   )
+        def call
+          return [] unless @node.is_a?(Nodes::SendNode) && WRITER_METHOD_NAMES.include?(@node.name)
+
+          @node.arguments.map do |argument|
+            Definitions::MethodDefinition.new(
+              description: description,
+              kind: :instance,
+              location: location,
+              method_name: "#{argument.value}=",
+              namespace: @node.namespace,
+              types: return_types.map do |type|
+                Types::MethodType.new(
+                  parameters_string: 'value', # TODO
+                  return_type: type
+                )
+              end
+            )
+          end
+        end
+      end
+    end
+  end
+end