rbs-inline 0.2.0 → 0.4.0

data/lib/rbs/inline/writer.rb

@@ -1,20 +1,27 @@
+# rbs_inline: enabled
+
 module RBS
   module Inline
     class Writer
-      attr_reader :output
-      attr_reader :writer
+      attr_reader :output #:: String
+      attr_reader :writer #:: RBS::Writer
 
+      # @rbs buffer: String
       def initialize(buffer = +"")
         @output = buffer
         @writer = RBS::Writer.new(out: StringIO.new(buffer))
       end
 
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
       def self.write(uses, decls)
         writer = Writer.new()
         writer.write(uses, decls)
         writer.output
       end
 
+      # @rbs lines: Array[String]
+      # @rbs returns void
       def header(*lines)
         lines.each do |line|
           writer.out.puts("# " + line)
@@ -22,6 +29,9 @@ module RBS
         writer.out.puts
       end
 
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
+      # @rbs returns void
       def write(uses, decls)
         use_dirs = uses.map do |use|
           RBS::AST::Directives::Use.new(
@@ -37,6 +47,8 @@ module RBS
         writer.write(use_dirs + rbs)
       end
 
+      # @rbs decl: AST::Declarations::t
+      # @rbs returns RBS::AST::Declarations::t?
       def translate_decl(decl)
         case decl
         when AST::Declarations::ClassDecl
@@ -48,6 +60,8 @@ module RBS
         end
       end
 
+      # @rbs decl: AST::Declarations::ClassDecl
+      # @rbs returns RBS::AST::Declarations::Class?
       def translate_class_decl(decl)
         return unless decl.class_name
 
@@ -59,12 +73,14 @@ module RBS
 
         decl.members.each do |member|
           if member.is_a?(AST::Members::Base)
-            if rbs_member = translate_member(member)
+            if rbs_member = translate_member(member, decl)
               members.concat rbs_member
             end
           end
 
-          if member.is_a?(AST::Declarations::Base)
+          if member.is_a?(AST::Declarations::SingletonClassDecl)
+            members.concat translate_singleton_decl(member)
+          elsif member.is_a?(AST::Declarations::Base)
             if rbs = translate_decl(member)
               members << rbs
             end
@@ -82,6 +98,8 @@ module RBS
         )
       end
 
+      # @rbs decl: AST::Declarations::ModuleDecl
+      # @rbs returns RBS::AST::Declarations::Module?
       def translate_module_decl(decl)
         return unless decl.module_name
 
@@ -93,12 +111,14 @@ module RBS
 
         decl.members.each do |member|
           if member.is_a?(AST::Members::Base)
-            if rbs_member = translate_member(member)
+            if rbs_member = translate_member(member, decl)
               members.concat rbs_member
             end
           end
 
-          if member.is_a?(AST::Declarations::Base)
+          if member.is_a?(AST::Declarations::SingletonClassDecl)
+            members.concat translate_singleton_decl(member)
+          elsif member.is_a?(AST::Declarations::Base)
             if rbs = translate_decl(member)
               members << rbs
             end
@@ -118,6 +138,8 @@ module RBS
         )
       end
 
+      # @rbs decl: AST::Declarations::ConstantDecl
+      # @rbs returns RBS::AST::Declarations::Constant?
       def translate_constant_decl(decl)
         return unless decl.constant_name
 
@@ -133,18 +155,39 @@ module RBS
         )
       end
 
-      def translate_member(member)
+      # @rbs decl: AST::Declarations::SingletonClassDecl
+      # @rbs returns Array[RBS::AST::Members::t]
+      def translate_singleton_decl(decl)
+        members = []
+
+        decl.members.each do |member|
+          if member.is_a?(AST::Members::Base)
+            if rbs_member = translate_member(member, decl)
+              members.concat rbs_member
+            end
+          end
+        end
+
+        members
+      end
+
+      # @rbs member: AST::Members::t
+      # @rbs decl: AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl
+      # @rbs returns Array[RBS::AST::Members::t | RBS::AST::Declarations::t]?
+      def translate_member(member, decl)
         case member
         when AST::Members::RubyDef
           if member.comments
             comment = RBS::AST::Comment.new(string: member.comments.content, location: nil)
           end
 
+          kind = method_kind(member, decl)
+
           if member.override_annotation
             return [
               RBS::AST::Members::MethodDefinition.new(
                 name: member.method_name,
-                kind: member.method_kind,
+                kind: kind,
                 overloads: [],
                 annotations: [],
                 location: nil,
@@ -158,7 +201,7 @@ module RBS
           [
             RBS::AST::Members::MethodDefinition.new(
               name: member.method_name,
-              kind: member.method_kind,
+              kind: kind,
               overloads: member.method_overloads,
               annotations: member.method_annotations,
               location: nil,
@@ -205,6 +248,35 @@ module RBS
           end
         end
       end
+
+      private
+
+      # Returns the `kind` of the method definition
+      #
+      # ```rb
+      # def self.foo = ()    # :singleton
+      # class A
+      #   class << self
+      #     def bar = ()     # :singleton
+      #   end
+      # end
+      #
+      # def object.foo = ()  # Not supported (returns :instance)
+      # ```
+      #
+      # @rbs member: AST::Members::RubyDef
+      # @rbs decl: AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl
+      # @rbs returns RBS::AST::Members::MethodDefinition::kind
+      def method_kind(member, decl)
+        return :singleton if decl.is_a?(AST::Declarations::SingletonClassDecl)
+
+        case member.node.receiver
+        when Prism::SelfNode
+          :singleton
+        else
+          :instance
+        end
+      end
     end
   end
 end

data/lib/rbs/inline.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rbs_inline: enabled
 
 require_relative "inline/version"
 
@@ -18,5 +19,7 @@ require "rbs/inline/writer"
 
 module RBS
   module Inline
+    # @rbs!
+    #   type token = [Symbol, String]
   end
 end

data/rbs_collection.lock.yaml

@@ -1,10 +1,6 @@
 ---
 path: ".gem_rbs_collection"
 gems:
-- name: abbrev
-  version: '0'
-  source:
-    type: stdlib
 - name: fileutils
   version: '0'
   source:
@@ -38,7 +34,7 @@ gems:
   source:
     type: stdlib
 - name: prism
-  version: 0.24.0
+  version: 0.30.0
   source:
     type: rubygems
 - name: rake
@@ -46,11 +42,11 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: d2e93d426c927fdab90ef12e30a9875aa05d60d6
+    revision: 4bf1c9687fc24cfbb30f4759653308c816f3a69f
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs
-  version: 3.5.0.pre.2
+  version: 3.5.1
   source:
     type: rubygems
 - name: rdoc

data/rbs_collection.yaml

@@ -15,3 +15,5 @@ path: .gem_rbs_collection
 
 gems:
   - name: optparse
+  - name: ffi
+    ignore: true

data/sig/generated/rbs/inline/ast/annotations.rbs

@@ -4,6 +4,8 @@ module RBS
   module Inline
     module AST
       module Annotations
+        type t = VarType | ReturnType | Use | Inherits | Generic | ModuleSelf | Skip | Assertion | Application | RBSAnnotation | Override | IvarType | Yields | Embedded
+
         class Base
           attr_reader source: CommentLines
 

data/sig/{rbs → generated/rbs}/inline/ast/comment_lines.rbs

@@ -1,3 +1,5 @@
+# Generated from lib/rbs/inline/ast/comment_lines.rb with RBS::Inline
+
 module RBS
   module Inline
     module AST
@@ -12,15 +14,17 @@ module RBS
       #
       # We want to get a String of comment1 and comment2, `"Hello\nWorld".
       # And want to translate a location in the string into the location in comment1 and comment2.
-      #
       class CommentLines
-        attr_reader comments: Array[[Prism::Comment, Integer]]
+        attr_reader comments: Array[[ Prism::Comment, Integer ]]
 
-        def initialize: (Array[Prism::Comment]) -> void
+        # @rbs comments: Array[Prism::Comment]
+        def initialize: (Array[Prism::Comment] comments) -> untyped
 
         def string: () -> String
 
-        def comment_location: (Integer index) -> [Prism::Comment, Integer]?
+        # @rbs index: Integer
+        # @rbs returns [Prism::Comment, Integer]?
+        def comment_location: (Integer index) -> [ Prism::Comment, Integer ]?
       end
     end
   end

data/sig/generated/rbs/inline/ast/declarations.rbs

@@ -10,7 +10,7 @@ module RBS
           def type_name: (Prism::Node node) -> TypeName?
         end
 
-        type t = ClassDecl | ModuleDecl | ConstantDecl
+        type t = ClassDecl | ModuleDecl | ConstantDecl | SingletonClassDecl
 
         interface _WithComments
           def comments: () -> AnnotationParser::ParsingResult?
@@ -110,6 +110,9 @@ module RBS
 
           def start_line: () -> Integer
         end
+
+        class SingletonClassDecl < ModuleOrClass[Prism::SingletonClassNode]
+        end
       end
     end
   end

data/sig/generated/rbs/inline/ast/members.rbs

@@ -4,6 +4,12 @@ module RBS
   module Inline
     module AST
       module Members
+        type ruby = RubyDef | RubyAlias | RubyMixin | RubyAttr | RubyPublic | RubyPrivate
+
+        type rbs = RBSIvar | RBSEmbedded
+
+        type t = ruby | rbs
+
         class Base
           attr_reader location: Prism::Location
 
@@ -44,16 +50,6 @@ module RBS
 
           def method_type_annotations: () -> Array[Annotations::Assertion]
 
-          # Returns the `kind` of the method definition
-          #
-          # [FIXME] It only supports `self` receiver.
-          #
-          # ```rb
-          # def self.foo = ()    # :singleton
-          # def object.foo = ()  # Not supported (returns :instance)
-          # ```
-          def method_kind: () -> RBS::AST::Members::MethodDefinition::kind
-
           def return_type: () -> Types::t?
 
           def var_type_hash: () -> Hash[Symbol, Types::t?]
@@ -84,6 +80,8 @@ module RBS
         end
 
         class RubyMixin < RubyBase
+          include Declarations::ConstantUtil
+
           # CallNode that calls `include`, `prepend`, and `extend` method
           attr_reader node: Prism::CallNode
 

data/sig/{rbs → generated/rbs}/inline/ast/tree.rbs

@@ -1,97 +1,125 @@
+# Generated from lib/rbs/inline/ast/tree.rb with RBS::Inline
+
 module RBS
   module Inline
     module AST
       class Tree
-        type token = [Symbol, String]
+        type token = [ Symbol, String ]
 
         type tree = token | Tree | Types::t | MethodType | nil
 
         attr_reader trees: Array[tree]
 
+        attr_reader type: Symbol
+
         # Children but without `tWHITESPACE` tokens
-        #
         attr_reader non_trivia_trees: Array[tree]
 
-        attr_reader type: Symbol
+        # @rbs type: Symbol
+        def initialize: (Symbol type) -> untyped
 
-        def initialize: (Symbol type) -> void
+        # @rbs tok: tree
+        # @rbs returns self
+        def <<: (tree tok) -> self
 
-        def <<: (tree) -> self
+        # Returns the source code associated to the tree
+        def to_s: () -> String
 
         # Returns n-th token from the children
         #
         # Raises if the value is not a token or nil.
         #
-        def nth_token: (Integer) -> token?
+        # @rbs index: Integer
+        # @rbs returns token?
+        def nth_token: (Integer index) -> token?
 
         # Returns n-th token from the children
         #
         # Returns `nil` if the value is not a token.
         #
-        def nth_token?: (Integer) -> token?
+        # @rbs index: Integer
+        # @rbs returns token?
+        def nth_token?: (Integer index) -> token?
 
         # Returns n-th token from the children
         #
         # Raises if the value is not token.
         #
-        def nth_token!: (Integer) -> token
+        # @rbs index: Integer
+        # @rbs returns token
+        def nth_token!: (Integer index) -> token
 
         # Returns n-th tree from the children
         #
         # Raises if the value is not a tree or nil.
         #
-        def nth_tree: (Integer) -> Tree?
+        # @rbs index: Integer
+        # @rbs returns Tree?
+        def nth_tree: (Integer index) -> Tree?
 
         # Returns n-th tree from the children
         #
         # Returns `nil` if the value is not a tree or nil.
         #
-        def nth_tree?: (Integer) -> Tree?
+        # @rbs index: Integer
+        # @rbs returns Tree?
+        def nth_tree?: (Integer index) -> Tree?
 
         # Returns n-th tree from the children
         #
         # Raises if the value is not a tree.
         #
-        def nth_tree!: (Integer) -> Tree
+        # @rbs index: Integer
+        # @rbs returns Tree
+        def nth_tree!: (Integer index) -> Tree
 
         # Returns n-th type from the children
         #
-        # Raises if the value is not a tree or nil.
+        # Raises if the value is not a type or nil.
         #
-        def nth_type: (Integer) -> Types::t?
+        # @rbs index: Integer
+        # @rbs returns Types::t?
+        def nth_type: (Integer index) -> Types::t?
 
         # Returns n-th type from the children
         #
         # Returns `nil` if the value is not a type.
         #
-        def nth_type?: (Integer) -> Types::t?
+        # @rbs index: Integer
+        # @rbs returns Types::t?
+        def nth_type?: (Integer index) -> Types::t?
 
         # Returns n-th type from the children
         #
         # Raises if the value is not a type.
         #
-        def nth_type!: (Integer) -> Types::t
+        # @rbs index: Integer
+        # @rbs returns Types::t
+        def nth_type!: (Integer index) -> Types::t
 
         # Returns n-th method type from the children
         #
         # Raises if the value is not a method type or `nil`.
         #
-        def nth_method_type: (Integer) -> MethodType?
+        # @rbs index: Integer
+        # @rbs returns MethodType?
+        def nth_method_type: (Integer index) -> MethodType?
 
         # Returns n-th method type from the children
         #
         # Returns `nil` if the value is not a method type.
         #
-        def nth_method_type?: (Integer) -> MethodType?
+        # @rbs index: Integer
+        # @rbs returns MethodType?
+        def nth_method_type?: (Integer index) -> MethodType?
 
         # Returns n-th method tree from the children
         #
         # Raises if the value is not a method tree.
         #
-        def nth_method_type!: (Integer) -> MethodType
-
-        # Returns the source code associated to the tree
-        def to_s: () -> String
+        # @rbs index: Integer
+        # @rbs returns MethodType
+        def nth_method_type!: (Integer index) -> MethodType
       end
     end
   end

data/sig/generated/rbs/inline/node_utils.rbs

@@ -0,0 +1,11 @@
+# Generated from lib/rbs/inline/node_utils.rb with RBS::Inline
+
+module RBS
+  module Inline
+    module NodeUtils
+      # @rbs node: Prism::Node
+      # @rbs returns TypeName?
+      def type_name: (Prism::Node node) -> TypeName?
+    end
+  end
+end

data/sig/generated/rbs/inline/parser.rbs

@@ -30,9 +30,10 @@ module RBS
 
       def initialize: () -> void
 
-      # @rbs result: ParseResult[ProgramNode]
+      # @rbs result: ParseResult
+      # @rbs opt_in: bool -- `true` for *opt-out* mode, `false` for *opt-in* mode.
       # @rbs returns [Array[AST::Annotations::Use], Array[AST::Declarations::t]]?
-      def self.parse: (ParseResult[ProgramNode] result) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
+      def self.parse: (ParseResult result, opt_in: bool) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
 
       # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
       def current_class_module_decl: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil)
@@ -40,9 +41,9 @@ module RBS
       # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl
       def current_class_module_decl!: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl)
 
-      # :: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl) { () -> void } -> void
+      # :: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | AST::Declarations::SingletonClassDecl) { () -> void } -> void
       # :: (AST::Declarations::ConstantDecl) -> void
-      def push_class_module_decl: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl) { () -> void } -> void
+      def push_class_module_decl: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | AST::Declarations::SingletonClassDecl) { () -> void } -> void
                                 | (AST::Declarations::ConstantDecl) -> void
 
       # Load inner declarations and delete them from `#comments` hash
@@ -59,6 +60,9 @@ module RBS
       # @rbs override
       def visit_class_node: ...
 
+      # @rbs override
+      def visit_singleton_class_node: ...
+
       # @rbs override
       def visit_module_node: ...
 

data/sig/generated/rbs/inline/version.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/rbs/inline/version.rb with RBS::Inline
+
+module RBS
+  module Inline
+    VERSION: ::String
+  end
+end

data/sig/generated/rbs/inline/writer.rbs

@@ -0,0 +1,72 @@
+# Generated from lib/rbs/inline/writer.rb with RBS::Inline
+
+module RBS
+  module Inline
+    class Writer
+      attr_reader output: String
+
+      attr_reader writer: RBS::Writer
+
+      # @rbs buffer: String
+      def initialize: (?String buffer) -> untyped
+
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
+      def self.write: (Array[AST::Annotations::Use] uses, Array[AST::Declarations::t] decls) -> untyped
+
+      # @rbs lines: Array[String]
+      # @rbs returns void
+      def header: (*String lines) -> void
+
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
+      # @rbs returns void
+      def write: (Array[AST::Annotations::Use] uses, Array[AST::Declarations::t] decls) -> void
+
+      # @rbs decl: AST::Declarations::t
+      # @rbs returns RBS::AST::Declarations::t?
+      def translate_decl: (AST::Declarations::t decl) -> RBS::AST::Declarations::t?
+
+      # @rbs decl: AST::Declarations::ClassDecl
+      # @rbs returns RBS::AST::Declarations::Class?
+      def translate_class_decl: (AST::Declarations::ClassDecl decl) -> RBS::AST::Declarations::Class?
+
+      # @rbs decl: AST::Declarations::ModuleDecl
+      # @rbs returns RBS::AST::Declarations::Module?
+      def translate_module_decl: (AST::Declarations::ModuleDecl decl) -> RBS::AST::Declarations::Module?
+
+      # @rbs decl: AST::Declarations::ConstantDecl
+      # @rbs returns RBS::AST::Declarations::Constant?
+      def translate_constant_decl: (AST::Declarations::ConstantDecl decl) -> RBS::AST::Declarations::Constant?
+
+      # @rbs decl: AST::Declarations::SingletonClassDecl
+      # @rbs returns Array[RBS::AST::Members::t]
+      def translate_singleton_decl: (AST::Declarations::SingletonClassDecl decl) -> Array[RBS::AST::Members::t]
+
+      # @rbs member: AST::Members::t
+      # @rbs decl: AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl
+      # @rbs returns Array[RBS::AST::Members::t | RBS::AST::Declarations::t]?
+      def translate_member: (AST::Members::t member, AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl decl) -> Array[RBS::AST::Members::t | RBS::AST::Declarations::t]?
+
+      private
+
+      # Returns the `kind` of the method definition
+      #
+      # ```rb
+      # def self.foo = ()    # :singleton
+      # class A
+      #   class << self
+      #     def bar = ()     # :singleton
+      #   end
+      # end
+      #
+      # def object.foo = ()  # Not supported (returns :instance)
+      # ```
+      #
+      # @rbs member: AST::Members::RubyDef
+      # @rbs decl: AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl
+      # @rbs returns RBS::AST::Members::MethodDefinition::kind
+      def method_kind: (AST::Members::RubyDef member, AST::Declarations::ClassDecl | AST::Declarations::ModuleDecl | AST::Declarations::SingletonClassDecl decl) -> RBS::AST::Members::MethodDefinition::kind
+    end
+  end
+end

data/sig/generated/rbs/inline.rbs

@@ -0,0 +1,7 @@
+# Generated from lib/rbs/inline.rb with RBS::Inline
+
+module RBS
+  module Inline
+    type token = [ Symbol, String ]
+  end
+end