rucoa 0.9.0 → 0.10.0

data/lib/rucoa/source.rb

@@ -12,7 +12,10 @@ module Rucoa
 
     # @param content [String]
     # @param uri [String]
-    def initialize(content:, uri:)
+    def initialize(
+      content:,
+      uri:
+    )
       @content = content
       @uri = uri
     end
@@ -35,9 +38,21 @@ 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 ||=
-        if parse_result.failed?
+        if parse_result.failed? || root_node.nil?
           []
         else
           Yard::DefinitionsLoader.call(
@@ -98,8 +113,8 @@ module Rucoa
       return @parse_result if instance_variable_defined?(:@parse_result)
 
       @parse_result = Parser.call(
-        path: name,
-        text: @content
+        text: @content,
+        uri: @uri
       )
     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.9.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

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class Base
+        class << self
+          # @param comment [String]
+          # @param node [Rucoa::Nodes::Base]
+          # @return [Array<Rucoa::Definitions::Base>]
+          def call(
+            comment:,
+            node:
+          )
+            new(
+              comment: comment,
+              node: node
+            ).call
+          end
+        end
+
+        # @param comment [String]
+        # @param node [Rucoa::Nodes::Base]
+        def initialize(
+          comment:,
+          node:
+        )
+          @comment = comment
+          @node = node
+        end
+
+        # @return [Array<Rucoa::Definitions::Base>]
+        def call
+          raise ::NotImplementedError
+        end
+
+        private
+
+        # @return [String]
+        def description
+          docstring_parser.to_docstring.to_s
+        end
+
+        # @return [YARD::DocstringParser]
+        def docstring_parser
+          @docstring_parser ||= ::YARD::Logger.instance.enter_level(::Logger::FATAL) do
+            ::YARD::Docstring.parser.parse(
+              @comment,
+              ::YARD::CodeObjects::Base.new(:root, 'stub')
+            )
+          end
+        end
+
+        # @return [Rucoa::Location]
+        # @example returns source uri and entire range of target node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].location).to eq(
+        #     Rucoa::Location.new(
+        #       range: Rucoa::Range.new(
+        #         Rucoa::Position.new(
+        #           column: 0,
+        #           line: 1
+        #         ),
+        #         Rucoa::Position.new(
+        #           column: 3,
+        #           line: 2
+        #         )
+        #       ),
+        #       uri: '/path/to/foo.rb'
+        #     )
+        #   )
+        def location
+          Location.from_rucoa_node(@node)
+        end
+
+        # @return [Array<String>]
+        # @example returns annotated return types if return tag is provided
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       # @return [String]
+        #       def foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].return_types).to eq(%w[String])
+        # @example returns Object if no return tag is provided
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       def foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].return_types).to eq(%w[Object])
+        def return_types
+          types = docstring_parser.tags.select do |tag|
+            tag.tag_name == 'return'
+          end.flat_map(&:types).compact.map do |yard_type|
+            Type.new(yard_type).to_rucoa_type
+          end
+          if types.empty?
+            %w[Object]
+          else
+            types
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class ClassDefinitionGenerator < ModuleDefinitionGenerator
+        # @example returns class definition for class node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0]).to be_a(Rucoa::Definitions::ClassDefinition)
+        # @example detects single-argument include
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         include Bar
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].included_module_unqualified_names.map(&:chained_name)).to eq(%w[Bar])
+        # @example detects multi-arguments include
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         include Bar, Baz
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].included_module_unqualified_names.map(&:chained_name)).to eq(%w[Bar Baz])
+        # @example ignores non-simple include
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       class Foo
+        #         include foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0].included_module_unqualified_names.map(&:chained_name)).to eq([])
+        def call
+          return [] unless @node.is_a?(Nodes::ClassNode)
+
+          [
+            Definitions::ClassDefinition.new(
+              description: description,
+              included_module_unqualified_names: included_module_unqualified_names,
+              location: location,
+              prepended_module_unqualified_names: prepended_module_unqualified_names,
+              qualified_name: @node.qualified_name,
+              super_class_unqualified_name: UnqualifiedName.new(
+                chained_name: @node.super_class_chained_name,
+                module_nesting: @node.module_nesting
+              )
+            )
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class ConstantAssignmentDefinitionGenerator < Base
+        # @example returns constant definition for constant assignment node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       Foo = 'foo'
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0]).to be_a(Rucoa::Definitions::ConstantDefinition)
+        def call
+          return [] unless @node.is_a?(Nodes::CasgnNode)
+
+          [
+            Definitions::ConstantDefinition.new(
+              description: description,
+              location: location,
+              qualified_name: @node.qualified_name
+            )
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class MethodDefinitionGenerator < Base
+        # @example returns method definition for def node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       def foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0]).to be_a(Rucoa::Definitions::MethodDefinition)
+        # @example returns method definition for defs node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       def self.foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0]).to be_a(Rucoa::Definitions::MethodDefinition)
+        def call
+          return [] unless @node.is_a?(Nodes::DefNode) || @node.is_a?(Nodes::DefsNode)
+
+          [
+            Definitions::MethodDefinition.new(
+              description: description,
+              kind: @node.singleton? ? :singleton : :instance,
+              location: location,
+              method_name: @node.name,
+              namespace: @node.namespace,
+              types: return_types.map do |type|
+                Types::MethodType.new(
+                  parameters_string: '', # TODO
+                  return_type: type
+                )
+              end
+            )
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      class ModuleDefinitionGenerator < Base
+        # @example returns module definition for module node
+        #   definitions = Rucoa::Source.new(
+        #     content: <<~RUBY,
+        #       module Foo
+        #       end
+        #     RUBY
+        #     uri: '/path/to/foo.rb'
+        #   ).definitions
+        #   expect(definitions[0]).to be_a(Rucoa::Definitions::ModuleDefinition)
+        def call
+          return [] unless @node.is_a?(Nodes::ModuleNode)
+
+          [
+            Definitions::ModuleDefinition.new(
+              description: description,
+              included_module_unqualified_names: included_module_unqualified_names,
+              location: location,
+              prepended_module_unqualified_names: prepended_module_unqualified_names,
+              qualified_name: @node.qualified_name
+            )
+          ]
+        end
+
+        private
+
+        # @return [Array<Rucoa::UnqualifiedName>]
+        def included_module_unqualified_names
+          unqualified_names_for('include')
+        end
+
+        # @return [Array<Rucoa::UnqualifiedName>]
+        def prepended_module_unqualified_names
+          unqualified_names_for('prepend')
+        end
+
+        # @param method_name [String]
+        # @return [Array<Rucoa::UnqualifiedName>]
+        def unqualified_names_for(method_name)
+          @node.body_children.flat_map do |child|
+            next [] unless child.is_a?(Nodes::SendNode)
+            next [] unless child.name == method_name
+
+            child.arguments.filter_map do |argument|
+              next unless argument.is_a?(Nodes::ConstNode)
+
+              UnqualifiedName.new(
+                chained_name: argument.chained_name,
+                module_nesting: @node.module_nesting
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rucoa/yard/definition_generators.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Yard
+    module DefinitionGenerators
+      autoload :AttributeReaderDefinitionGenerator, 'rucoa/yard/definition_generators/attribute_reader_definition_generator'
+      autoload :AttributeWriterDefinitionGenerator, 'rucoa/yard/definition_generators/attribute_writer_definition_generator'
+      autoload :Base, 'rucoa/yard/definition_generators/base'
+      autoload :ClassDefinitionGenerator, 'rucoa/yard/definition_generators/class_definition_generator'
+      autoload :ConstantAssignmentDefinitionGenerator, 'rucoa/yard/definition_generators/constant_assignment_definition_generator'
+      autoload :MethodDefinitionGenerator, 'rucoa/yard/definition_generators/method_definition_generator'
+      autoload :ModuleDefinitionGenerator, 'rucoa/yard/definition_generators/module_definition_generator'
+    end
+  end
+end