rbs 3.9.2 → 4.0.0.dev.1

data/lib/rbs/inline_parser.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module RBS
+  class InlineParser
+    class Result
+      attr_reader :buffer, :prism_result, :declarations, :diagnostics
+
+      def initialize(buffer, prism)
+        @buffer = buffer
+        @prism_result = prism
+        @declarations = []
+        @diagnostics = []
+      end
+    end
+
+    module Diagnostic
+      class Base
+        attr_reader :message, :location
+
+        def initialize(location, message)
+          @location = location
+          @message = message
+        end
+      end
+
+      NotImplementedYet = _ = Class.new(Base)
+      NonConstantClassName = _ = Class.new(Base)
+      NonConstantModuleName = _ = Class.new(Base)
+      TopLevelMethodDefinition = _ = Class.new(Base)
+      UnusedInlineAnnotation = _ = Class.new(Base)
+      AnnotationSyntaxError = _ = Class.new(Base)
+    end
+
+    def self.parse(buffer, prism)
+      result = Result.new(buffer, prism)
+
+      Parser.new(result).visit(prism.value)
+
+      result
+    end
+
+    class Parser < Prism::Visitor
+      attr_reader :module_nesting, :result, :comments
+
+      include AST::Ruby::Helpers::ConstantHelper
+      include AST::Ruby::Helpers::LocationHelper
+
+      def initialize(result)
+        @result = result
+        @module_nesting = []
+        @comments = CommentAssociation.build(result.buffer, result.prism_result)
+      end
+
+      def buffer
+        result.buffer
+      end
+
+      def current_module
+        module_nesting.last
+      end
+
+      def current_module!
+        current_module || raise("#current_module is nil")
+      end
+
+      def diagnostics
+        result.diagnostics
+      end
+
+      def push_module_nesting(mod)
+        module_nesting.push(mod)
+        yield
+      ensure
+        module_nesting.pop()
+      end
+
+      def skip_node?(node)
+        if ref = comments.leading_block(node)
+          if ref.block.each_paragraph([]).any? { _1.is_a?(AST::Ruby::Annotations::SkipAnnotation) }
+            ref.associate!
+            return true
+          end
+        end
+
+        false
+      end
+
+      def visit_class_node(node)
+        return if skip_node?(node)
+
+        unless class_name = constant_as_type_name(node.constant_path)
+          diagnostics << Diagnostic::NonConstantClassName.new(
+            rbs_location(node.constant_path.location),
+            "Class name must be a constant"
+          )
+          return
+        end
+
+        class_decl = AST::Ruby::Declarations::ClassDecl.new(buffer, class_name, node)
+        insert_declaration(class_decl)
+        push_module_nesting(class_decl) do
+          visit_child_nodes(node)
+        end
+
+        comments.each_enclosed_block(node) do |block|
+          report_unused_block(block)
+        end
+      end
+
+      def visit_module_node(node)
+        return if skip_node?(node)
+
+        unless module_name = constant_as_type_name(node.constant_path)
+          diagnostics << Diagnostic::NonConstantModuleName.new(
+            rbs_location(node.constant_path.location),
+            "Module name must be a constant"
+          )
+          return
+        end
+
+        module_decl = AST::Ruby::Declarations::ModuleDecl.new(buffer, module_name, node)
+        insert_declaration(module_decl)
+        push_module_nesting(module_decl) do
+          visit_child_nodes(node)
+        end
+
+        comments.each_enclosed_block(node) do |block|
+          report_unused_block(block)
+        end
+      end
+
+      def visit_def_node(node)
+        return if skip_node?(node)
+
+        if node.receiver
+          diagnostics << Diagnostic::NotImplementedYet.new(
+            rbs_location(node.receiver.location),
+            "Singleton method definition is not supported yet"
+          )
+          return
+        end
+
+        case current = current_module
+        when AST::Ruby::Declarations::ClassDecl, AST::Ruby::Declarations::ModuleDecl
+          leading_block = comments.leading_block!(node)
+
+          if node.end_keyword_loc
+            # Not an end-less def
+            end_loc = node.rparen_loc || node.parameters&.location || node.name_loc
+            trailing_block = comments.trailing_block!(end_loc)
+          end
+
+          method_type, leading_unuseds, trailing_unused = AST::Ruby::Members::MethodTypeAnnotation.build(leading_block, trailing_block, [])
+          report_unused_annotation(trailing_unused, *leading_unuseds)
+
+          defn = AST::Ruby::Members::DefMember.new(buffer, node.name, node, method_type)
+          current.members << defn
+
+          # Skip other comments in `def` node
+          comments.each_enclosed_block(node) do |block|
+            comments.associated_blocks << block
+          end
+        else
+          diagnostics << Diagnostic::TopLevelMethodDefinition.new(
+            rbs_location(node.name_loc),
+            "Top-level method definition is not supported"
+          )
+        end
+      end
+
+      def insert_declaration(decl)
+        if current_module
+          current_module.members << decl
+        else
+          result.declarations << decl
+        end
+      end
+
+      def report_unused_annotation(*annotations)
+        annotations.each do |annotation|
+          case annotation
+          when AST::Ruby::CommentBlock::AnnotationSyntaxError
+            diagnostics << Diagnostic::AnnotationSyntaxError.new(
+              annotation.location, "Syntax error: " + annotation.error.error_message
+            )
+          when AST::Ruby::Annotations::Base
+            diagnostics << Diagnostic::UnusedInlineAnnotation.new(
+              annotation.location, "Unused inline rbs annotation"
+            )
+          end
+        end
+      end
+
+      def report_unused_block(block)
+        block.each_paragraph([]) do |paragraph|
+          case paragraph
+          when Location
+            # noop
+          else
+            report_unused_annotation(paragraph)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rbs/location_aux.rb

@@ -28,6 +28,14 @@ module RBS
 
     WithChildren = self
 
+    def start_pos
+      buffer.absolute_position(_start_pos) || raise
+    end
+
+    def end_pos
+      buffer.absolute_position(_end_pos) || raise
+    end
+
     def name
       buffer.name
     end
@@ -49,11 +57,11 @@ module RBS
     end
 
     def start_loc
-      @start_loc ||= buffer.pos_to_loc(start_pos)
+      @start_loc ||= buffer.top_buffer.pos_to_loc(start_pos)
     end
 
     def end_loc
-      @end_loc ||= buffer.pos_to_loc(end_pos)
+      @end_loc ||= buffer.top_buffer.pos_to_loc(end_pos)
     end
 
     def range
@@ -61,7 +69,7 @@ module RBS
     end
 
     def source
-      @source ||= (buffer.content[range] || raise)
+      @source ||= (buffer.top_buffer.content[range] || raise)
     end
 
     def to_s
@@ -134,5 +142,29 @@ module RBS
     def required_key?(name)
       _required_keys.include?(name)
     end
+
+    def local_location
+      loc = Location.new(buffer.detach, _start_pos, _end_pos)
+
+      each_optional_key do |key|
+        value = self[key]
+        if value
+          loc.add_optional_child(key, value._start_pos...value._end_pos)
+        else
+          loc.add_optional_child(key, nil)
+        end
+      end
+
+      each_required_key do |key|
+        value = self[key] or raise
+        loc.add_required_child(key, value._start_pos...value._end_pos)
+      end
+
+      loc #: self
+    end
+
+    def local_source
+      local_location.source
+    end
   end
 end

data/lib/rbs/parser_aux.rb

@@ -71,7 +71,7 @@ module RBS
     def self.buffer(source)
       case source
       when String
-        Buffer.new(content: source, name: "a.rbs")
+        Buffer.new(content: source, name: Pathname("a.rbs"))
       when Buffer
         source
       end
@@ -110,5 +110,15 @@ module RBS
       ).each_with_object({}) do |keyword, hash| #$ Hash[String, bot]
         hash[keyword] = _ = nil
       end
+
+    def self.parse_inline_leading_annotation(source, range, variables: [])
+      buf = buffer(source)
+      _parse_inline_leading_annotation(buf, range.begin || 0, range.end || buf.last_position, variables)
+    end
+
+    def self.parse_inline_trailing_annotation(source, range, variables: [])
+      buf = buffer(source)
+      _parse_inline_trailing_annotation(buf, range.begin || 0, range.end || buf.last_position, variables)
+    end
   end
 end

data/lib/rbs/prototype/runtime.rb

@@ -50,8 +50,8 @@ module RBS
           type_name_absolute = type_name.absolute!
           @mixin_decls_cache ||= {} #: Hash[TypeName, Array[AST::Members::Mixin]]
           @mixin_decls_cache.fetch(type_name_absolute) do
-            @mixin_decls_cache[type_name_absolute] = @builder.env.class_decls[type_name_absolute].decls.flat_map do |d|
-              d.decl.members.select { |m| m.kind_of?(AST::Members::Mixin) }
+            @mixin_decls_cache[type_name_absolute] = @builder.env.class_decls[type_name_absolute].each_decl.flat_map do |decl|
+              decl.members.select { |m| m.kind_of?(AST::Members::Mixin) }
             end
           end
         end

data/lib/rbs/source.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module RBS
+  module Source
+    class RBS
+      attr_reader :buffer, :directives, :declarations
+
+      def initialize(buffer, directives, decls)
+        @buffer = buffer
+        @directives = directives
+        @declarations = decls
+      end
+
+      def each_type_name(&block)
+        if block
+          set = Set[] #: Set[TypeName]
+          declarations.each do |decl|
+            each_declaration_type_name(set, decl, &block)
+          end
+        else
+          enum_for :each_type_name
+        end
+      end
+
+      def each_declaration_type_name(names, decl, &block)
+        case decl
+        when AST::Declarations::Class
+          decl.each_decl { each_declaration_type_name(names, _1, &block) }
+          type_name = decl.name
+        when AST::Declarations::Module
+          decl.each_decl { each_declaration_type_name(names, _1, &block) }
+          type_name = decl.name
+        when AST::Declarations::Interface
+          type_name = decl.name
+        when AST::Declarations::TypeAlias
+          type_name = decl.name
+        when AST::Declarations::ModuleAlias
+          type_name = decl.new_name
+        when AST::Declarations::ClassAlias
+          type_name = decl.new_name
+        end
+
+        if type_name
+          unless names.include?(type_name)
+            yield type_name
+            names << type_name
+          end
+        end
+      end
+    end
+
+    class Ruby
+      attr_reader :buffer
+      attr_reader :prism_result
+      attr_reader :declarations
+      attr_reader :diagnostics
+
+      def initialize(buffer, prism, declarations, diagnostics)
+        @buffer = buffer
+        @prism_result = prism
+        @declarations = declarations
+        @diagnostics = diagnostics
+      end
+
+      def each_type_name(&block)
+        if block
+          names = Set[] #: Set[TypeName]
+          declarations.each do |decl|
+            each_declaration_type_name(names, decl, &block)
+          end
+        else
+          enum_for :each_type_name
+        end
+      end
+
+      def each_declaration_type_name(names, decl, &block)
+        case decl
+        when AST::Ruby::Declarations::ClassDecl
+          decl.each_decl do |d|
+            each_declaration_type_name(names, d, &block)
+          end
+          type_name = decl.class_name
+        when AST::Ruby::Declarations::ModuleDecl
+          decl.each_decl do |d|
+            each_declaration_type_name(names, d, &block)
+          end
+          type_name = decl.module_name
+        end
+
+        if type_name
+          unless names.include?(type_name)
+            yield type_name
+            names << type_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rbs/subtractor.rb

@@ -129,9 +129,10 @@ module RBS
 
       entry = @subtrahend.class_decls[owner]
       return unless entry
-      decls = entry.decls.map { |d| d.decl }
-
-      decls.each { |d| d.members.each { |m| block.call(m) } }
+      entry.each_decl do |d|
+        next unless d.is_a?(AST::Declarations::Base)
+        d.members.each { |m| block.call(m) }
+      end
     end
 
     private def mixin_exist?(owner, mixin, context:)

data/lib/rbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBS
-  VERSION = "3.9.2"
+  VERSION = "4.0.0.dev.1"
 end

data/lib/rbs.rb

@@ -10,6 +10,7 @@ require "ripper"
 require "logger"
 require "tsort"
 require "strscan"
+require "prism"
 
 require "rbs/errors"
 require "rbs/buffer"
@@ -24,8 +25,19 @@ require "rbs/ast/declarations"
 require "rbs/ast/members"
 require "rbs/ast/annotation"
 require "rbs/ast/visitor"
+require "rbs/ast/ruby/comment_block"
+require "rbs/ast/ruby/helpers/constant_helper"
+require "rbs/ast/ruby/helpers/location_helper"
+require "rbs/ast/ruby/annotations"
+require "rbs/ast/ruby/declarations"
+require "rbs/ast/ruby/members"
+require "rbs/source"
+require "rbs/inline_parser"
+require "rbs/inline_parser/comment_association"
 require "rbs/environment"
 require "rbs/environment/use_map"
+require "rbs/environment/class_entry"
+require "rbs/environment/module_entry"
 require "rbs/environment_loader"
 require "rbs/builtin_names"
 require "rbs/definition"

data/lib/rdoc/discover.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 begin
-  gem 'rdoc', '~> 6.4'
+  gem 'rdoc', '~> 6.13'
   require 'rdoc_plugin/parser'
   module RDoc
     class Parser

data/lib/rdoc_plugin/parser.rb

@@ -86,7 +86,7 @@ module RBS
       end
 
       def parse_method_alias_decl(decl:, context:, outer_name: nil)
-        alias_def = RDoc::Alias.new(nil, decl.old_name.to_s, decl.new_name.to_s, nil, decl.kind == :singleton)
+        alias_def = RDoc::Alias.new(nil, decl.old_name.to_s, decl.new_name.to_s, nil, singleton: decl.kind == :singleton)
         alias_def.comment = construct_comment(context: context, comment: comment_string(decl)) if decl.comment
         context.add_alias(alias_def)
       end
@@ -100,7 +100,7 @@ module RBS
              when ::RBS::AST::Members::AttrAccessor
                'RW'
              end
-        attribute = RDoc::Attr.new(nil, decl.name.to_s, rw, nil, decl.kind == :singleton)
+        attribute = RDoc::Attr.new(nil, decl.name.to_s, rw, nil, singleton: decl.kind == :singleton)
         attribute.visibility = decl.visibility
         attribute.comment = construct_comment(context: context, comment: comment_string(decl)) if decl.comment
         context.add_attribute(attribute)

data/rbs.gemspec

@@ -46,4 +46,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 3.1"
   spec.add_dependency "logger"
+  spec.add_dependency "prism", ">= 1.3.0"
 end

data/sig/ancestor_builder.rbs

@@ -146,7 +146,7 @@ module RBS
                             extended_modules: Array[Definition::Ancestor::Instance]?,
                          extended_interfaces: Array[Definition::Ancestor::Instance]?) -> void
 
-      def mixin_ancestors0: (AST::Declarations::Class | AST::Declarations::Module | AST::Declarations::Interface,
+      def mixin_ancestors0: (AST::Declarations::Class | AST::Declarations::Module | AST::Declarations::Interface | AST::Ruby::Declarations::ClassDecl | AST::Ruby::Declarations::ModuleDecl,
                              TypeName,
                              align_params: Substitution?,
                          included_modules: Array[Definition::Ancestor::Instance]?,

data/sig/annotate/formatter.rbs

@@ -17,8 +17,8 @@ module RBS
 
       def self.translate: (RDoc::Markup::Document) -> String?
 
-      def self.each_part: (RDoc::Markup::Document | RDoc::Comment | String) { (RDoc::Markup::Document) -> void } -> void
-                        | (RDoc::Markup::Document | RDoc::Comment | String) -> Enumerator[RDoc::Markup::Document, void]
+      def self.each_part: (RDoc::Markup::Document) { (RDoc::Markup::Document) -> void } -> void
+                        | (RDoc::Markup::Document) -> Enumerator[RDoc::Markup::Document, void]
     end
   end
 end

data/sig/annotate/rdoc_annotater.rbs

@@ -17,7 +17,7 @@ module RBS
       end
 
       interface _WithRDocComment
-        def comment: () -> (RDoc::Markup::Document | RDoc::Comment | String)
+        def comment: () -> (RDoc::Comment | String)
       end
 
       def each_part: (Array[Object & _WithRDocComment], tester: _PathTester) { ([RDoc::Markup::Document, Object & _WithRDocComment]) -> void } -> void

data/sig/ast/ruby/annotations.rbs

@@ -0,0 +1,110 @@
+module RBS
+  module AST
+    module Ruby
+      module Annotations
+        type leading_annotation = ColonMethodTypeAnnotation
+                                | MethodTypesAnnotation
+                                | SkipAnnotation
+                                | ReturnTypeAnnotation
+
+        type trailing_annotation = NodeTypeAssertion
+
+        type t = leading_annotation | trailing_annotation
+
+        class Base
+          # Location that covers all of the annotation
+          #
+          attr_reader location: Location
+
+          # Location of `@rbs`, `@rbs!`, or `:` prefix
+          #
+          attr_reader prefix_location: Location
+
+          def initialize: (Location location, Location prefix_location) -> void
+
+          def buffer: () -> Buffer
+        end
+
+        # `: TYPE` annotation attached to nodes
+        #
+        class NodeTypeAssertion < Base
+          attr_reader type: Types::t
+
+          def initialize: (location: Location, prefix_location: Location, type: Types::t) -> void
+
+          def map_type_name: () { (TypeName) -> TypeName } -> self
+        end
+
+        # `: METHOD-TYPE` annotation in leading comments
+        #
+        class ColonMethodTypeAnnotation < Base
+          attr_reader annotations: Array[AST::Annotation]
+
+          attr_reader method_type: MethodType
+
+          def initialize: (location: Location, prefix_location: Location, annotations: Array[AST::Annotation], method_type: MethodType) -> void
+
+          def map_type_name: () { (TypeName) -> TypeName } -> self
+        end
+
+        # `@rbs METHOD-TYPEs` annotation in leading comments
+        #
+        # ```
+        # @rbs () -> void | %a{foo} () -> String
+        # ^^^^                                     -- prefix_location
+        #                 ^                        -- vertical_bar_locations[0]
+        # ```
+        class MethodTypesAnnotation < Base
+          class Overload = AST::Members::MethodDefinition::Overload
+
+          attr_reader overloads: Array[Overload]
+
+          attr_reader vertical_bar_locations: Array[Location]
+
+          def initialize: (location: Location, prefix_location: Location, overloads: Array[Overload], vertical_bar_locations: Array[Location]) -> void
+
+          def map_type_name: () { (TypeName) -> TypeName } -> self
+        end
+
+        # `@rbs skip -- comment` annotation in leading comments
+        #
+        class SkipAnnotation < Base
+          attr_reader skip_location: Location
+          attr_reader comment_location: Location?
+
+          def initialize: (location: Location, prefix_location: Location, skip_location: Location, comment_location: Location?) -> void
+        end
+
+        # `@rbs return: T -- comment` annotation in leading comments
+        #
+        # ```
+        # @rbs return: String -- Returns a string
+        # ^^^                                        -- prefix_location
+        #      ^^^^^^                                -- return_location
+        #            ^                               -- colon_location
+        #                     ^^^^^^^^^^^^^^^^^^^    -- comment
+        # ```
+        class ReturnTypeAnnotation < Base
+          attr_reader return_location: Location
+
+          attr_reader colon_location: Location
+
+          attr_reader return_type: Types::t
+
+          attr_reader comment_location: Location?
+
+          def initialize: (
+            location: Location,
+            prefix_location: Location,
+            return_location: Location,
+            colon_location: Location,
+            return_type: Types::t,
+            comment_location: Location?,
+          ) -> void
+
+          def map_type_name: () { (TypeName) -> TypeName } -> self
+        end
+      end
+    end
+  end
+end