rbs-inline 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44afba2006b4ffed3719716d5ac515d474dc7ba9ee18c4f9b3298c9925441284
-  data.tar.gz: 2c008cd99c1de1a2cb80945eed727b74fe9450af07fd3d20299775d5ee728978
+  metadata.gz: 713b2bd4c5ddd833fa1bd1a71505924081013101a8a41200a88fed55751146ba
+  data.tar.gz: 44ffe7a91c0c0afeb7e163a02de508c50f96a609ae7c64593a6b739109ac11b0
 SHA512:
-  metadata.gz: d7d02d3e07d295c00890ac95bad4c2f7f49700a0cdddb9885dcc3c194d272ef5b387c168f675a46f2b5dc3f49aaeb5230603dbe7ebcea20087952aebb7516b66
-  data.tar.gz: 6e476d54d6db64e42cdc7a6bfe9dfb5b1454f290e2746836cc17fe77ca41db5dac2b1a01d311877af189ee7ad2bd06207f1db2aaac86e1e494dd5855e921254d
+  metadata.gz: 6507f727be79bcae3890c8b8c3c3865544022058e44d5bfd060efb5df0c91e50f2b5e43a11f284c7ea3de1066bdd0ed7e269a14c20b45cc05cafa7ad60ecffb7
+  data.tar.gz: aad87cafa19657b4d4b055527924146cb232cd96c56081bcbb24c1e1b0ff2fc24a449bdfe2132a43c2e5f5ac2affca8d615d0946b135676979556eaca4887aec

data/README.md

@@ -80,12 +80,12 @@ The gem works as a transpiler from annotated Ruby code to RBS files. Run `rbs-in
 $ bundle exec rbs-inline lib
 
 # Save generated RBS files under sig/generated
-$ bundle exec rbs-inline --output=sig/generated lib
+$ bundle exec rbs-inline --output lib
 ```
 
 You may want to use `fswatch` or likes to automatically generate RBS files when you edit the Ruby code.
 
-    $ fswatch -0 lib | xargs -0 -n1 bundle exec rbs-inline --output=sig/generated
+    $ fswatch -0 lib | xargs -0 -n1 bundle exec rbs-inline --output
 
 ## More materials
 

data/lib/rbs/inline/ast/annotations.rb

@@ -4,6 +4,27 @@ module RBS
   module Inline
     module AST
       module Annotations
+        # @rbs!
+        #   type t = VarType
+        #          | ReturnType
+        #          | Use
+        #          | Inherits
+        #          | Generic
+        #          | ModuleSelf
+        #          | Skip
+        #          | Assertion
+        #          | Application
+        #          | RBSAnnotation
+        #          | Override
+        #          | IvarType
+        #          | Yields
+        #          | Embedded
+        #        #  | Def
+        #        #  | AttrReader | AttrWriter | AttrAccessor
+        #        #  | Include | Extend | Prepend
+        #        #  | Alias
+
+
         class Base
           attr_reader :source #:: CommentLines
           attr_reader :tree #:: Tree

data/lib/rbs/inline/ast/comment_lines.rb

@@ -1,9 +1,24 @@
+# rbs_inline: enabled
+
 module RBS
   module Inline
     module AST
+      # CommentLines represents consecutive comments
+      #
+      # The comments construct one String.
+      #
+      # ```ruby
+      # # Hello       <-- Comment1
+      # # World       <-- Comment2
+      # ```
+      #
+      # 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
+        attr_reader :comments #:: Array[[Prism::Comment, Integer]]
 
+        # @rbs comments: Array[Prism::Comment]
         def initialize(comments)
           offsets = comments.map do |comment|
             comment.location.slice.index(/[^#\s]/) || 1
@@ -18,10 +33,12 @@ module RBS
           end
         end
 
-        def string
+        def string #:: String
           comments.map {|comment, offset| comment.location.slice[offset..] }.join("\n")
         end
 
+        # @rbs index: Integer
+        # @rbs returns [Prism::Comment, Integer]?
         def comment_location(index)
           comments.each do |comment, offset|
             comment_length = comment.location.length

data/lib/rbs/inline/ast/declarations.rb

@@ -15,7 +15,7 @@ module RBS
           end
         end
 
-        # @rbs! type t = ClassDecl | ModuleDecl | ConstantDecl
+        # @rbs! type t = ClassDecl | ModuleDecl | ConstantDecl | SingletonClassDecl
 
         # @rbs!
         #  interface _WithComments
@@ -227,6 +227,9 @@ module RBS
             node.location.start_line
           end
         end
+
+        class SingletonClassDecl < ModuleOrClass #[Prism::SingletonClassNode]
+        end
       end
     end
   end

data/lib/rbs/inline/ast/members.rb

@@ -4,6 +4,11 @@ module RBS
   module Inline
     module AST
       module Members
+        # @rbs!
+        #   type ruby = RubyDef | RubyAlias | RubyMixin | RubyAttr | RubyPublic | RubyPrivate
+        #   type rbs = RBSIvar | RBSEmbedded
+        #   type t = ruby | rbs
+
         class Base
           attr_reader :location #:: Prism::Location
 
@@ -64,27 +69,6 @@ module RBS
             end
           end
 
-          # 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
-            # FIXME: really hacky implementation
-            case node.receiver
-            when Prism::SelfNode
-              :singleton
-            when nil
-              :instance
-            else
-              :instance
-            end
-          end
-
           def return_type #:: Types::t?
             if assertion
               if assertion.type?
@@ -341,6 +325,8 @@ module RBS
         end
 
         class RubyMixin < RubyBase
+          include Declarations::ConstantUtil
+
           # CallNode that calls `include`, `prepend`, and `extend` method
           attr_reader :node #:: Prism::CallNode
 
@@ -371,11 +357,8 @@ module RBS
             return unless node.arguments.arguments.size == 1
 
             arg = node.arguments.arguments[0] || raise
-            if arg.is_a?(Prism::ConstantReadNode)
-              type_name = RBS::TypeName.new(name: arg.name, namespace: RBS::Namespace.empty)
-            else
-              raise
-            end
+            type_name = type_name(arg)
+            return unless type_name
 
             args = [] #: Array[Types::t]
             if application

data/lib/rbs/inline/ast/tree.rb

@@ -1,17 +1,28 @@
+# rbs_inline: enabled
+
 module RBS
   module Inline
     module AST
       class Tree
-        attr_reader :trees
-        attr_reader :type
-        attr_reader :non_trivia_trees
+        # @rbs!
+        #   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]
 
+        # @rbs type: Symbol
         def initialize(type)
           @type = type
           @trees = []
           @non_trivia_trees = []
         end
 
+        # @rbs tok: tree
+        # @rbs returns self
         def <<(tok)
           trees << tok
           unless tok.is_a?(Array) && tok[0] == :tWHITESPACE
@@ -20,7 +31,8 @@ module RBS
           self
         end
 
-        def to_s
+        # Returns the source code associated to the tree
+        def to_s #:: String
           buf = +""
 
           trees.each do |tree|
@@ -39,6 +51,12 @@ module RBS
           buf
         end
 
+        # Returns n-th token from the children
+        #
+        # Raises if the value is not a token or nil.
+        #
+        # @rbs index: Integer
+        # @rbs returns token?
         def nth_token(index)
           tok = non_trivia_trees[index]
           case tok
@@ -49,6 +67,12 @@ module RBS
           end
         end
 
+        # Returns n-th token from the children
+        #
+        # Returns `nil` if the value is not a token.
+        #
+        # @rbs index: Integer
+        # @rbs returns token?
         def nth_token?(index)
           tok = non_trivia_trees[index]
           case tok
@@ -59,10 +83,22 @@ module RBS
           end
         end
 
+        # Returns n-th token from the children
+        #
+        # Raises if the value is not token.
+        #
+        # @rbs index: Integer
+        # @rbs returns token
         def nth_token!(index)
           nth_token(index) || raise
         end
 
+        # Returns n-th tree from the children
+        #
+        # Raises if the value is not a tree or nil.
+        #
+        # @rbs index: Integer
+        # @rbs returns Tree?
         def nth_tree(index)
           tok = non_trivia_trees[index]
           case tok
@@ -73,6 +109,12 @@ module RBS
           end
         end
 
+        # Returns n-th tree from the children
+        #
+        # Returns `nil` if the value is not a tree or nil.
+        #
+        # @rbs index: Integer
+        # @rbs returns Tree?
         def nth_tree?(index)
           tok = non_trivia_trees[index]
           case tok
@@ -83,11 +125,23 @@ module RBS
           end
         end
 
+        # Returns n-th tree from the children
+        #
+        # Raises if the value is not a tree.
+        #
+        # @rbs index: Integer
+        # @rbs returns Tree
         def nth_tree!(index)
           nth_tree(index) || raise
         end
 
 
+        # Returns n-th type from the children
+        #
+        # Raises if the value is not a type or nil.
+        #
+        # @rbs index: Integer
+        # @rbs returns Types::t?
         def nth_type(index)
           tok = non_trivia_trees[index]
           case tok
@@ -98,6 +152,12 @@ module RBS
           end
         end
 
+        # Returns n-th type from the children
+        #
+        # Returns `nil` if the value is not a type.
+        #
+        # @rbs index: Integer
+        # @rbs returns Types::t?
         def nth_type?(index)
           tok = non_trivia_trees[index]
           case tok
@@ -108,10 +168,22 @@ module RBS
           end
         end
 
+        # Returns n-th type from the children
+        #
+        # Raises if the value is not a type.
+        #
+        # @rbs index: Integer
+        # @rbs returns Types::t
         def nth_type!(index)
           nth_type(index) || raise
         end
 
+        # Returns n-th method type from the children
+        #
+        # Raises if the value is not a method type or `nil`.
+        #
+        # @rbs index: Integer
+        # @rbs returns MethodType?
         def nth_method_type(index)
           tok = non_trivia_trees[index]
           case tok
@@ -122,6 +194,12 @@ module RBS
           end
         end
 
+        # Returns n-th method type from the children
+        #
+        # Returns `nil` if the value is not a method type.
+        #
+        # @rbs index: Integer
+        # @rbs returns MethodType?
         def nth_method_type?(index)
           tok = non_trivia_trees[index]
           case tok
@@ -132,6 +210,12 @@ module RBS
           end
         end
 
+        # Returns n-th method tree from the children
+        #
+        # Raises if the value is not a method tree.
+        #
+        # @rbs index: Integer
+        # @rbs returns MethodType
         def nth_method_type!(index)
           nth_method_type(index) || raise
         end

data/lib/rbs/inline/node_utils.rb

@@ -1,6 +1,10 @@
+# rbs_inline: enabled
+
 module RBS
   module Inline
     module NodeUtils
+      # @rbs node: Prism::Node
+      # @rbs returns TypeName?
       def type_name(node)
         case node
         when Prism::ConstantReadNode

data/lib/rbs/inline/parser.rb

@@ -86,7 +86,7 @@ module RBS
         current_class_module_decl or raise
       end
 
-      #:: (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(decl)
         if current = current_class_module_decl
@@ -152,6 +152,18 @@ module RBS
         load_inner_annotations(node.location.start_line, node.location.end_line, class_decl.members)
       end
 
+      # @rbs override
+      def visit_singleton_class_node(node)
+        return if ignored_node?(node)
+
+        associated_comment = comments.delete(node.location.start_line - 1)
+        singleton_decl = AST::Declarations::SingletonClassDecl.new(node, associated_comment)
+
+        push_class_module_decl(singleton_decl) do
+          visit node.body
+        end
+      end
+
       # @rbs override
       def visit_module_node(node)
         return if ignored_node?(node)

data/lib/rbs/inline/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   module Inline
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

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.29.0
+  version: 0.30.0
   source:
     type: rubygems
 - name: rake
@@ -46,11 +42,11 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: 7a105f52053ce1c708b605dfa9c1ab8473424036
+    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

@@ -41,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
@@ -60,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs-inline
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -19,7 +19,7 @@ dependencies:
         version: '0.29'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.31'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
         version: '0.29'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.30'
+        version: '0.31'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0.pre
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0.pre
+        version: 3.5.0
 description: Inline RBS type declaration.
 email:
 - matsumoto@soutaro.com
@@ -73,21 +73,19 @@ files:
 - lib/rbs/inline/writer.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
+- sig/generated/rbs/inline.rbs
 - sig/generated/rbs/inline/annotation_parser.rbs
 - sig/generated/rbs/inline/ast/annotations.rbs
+- sig/generated/rbs/inline/ast/comment_lines.rbs
 - sig/generated/rbs/inline/ast/declarations.rbs
 - sig/generated/rbs/inline/ast/members.rbs
+- sig/generated/rbs/inline/ast/tree.rbs
 - sig/generated/rbs/inline/cli.rbs
+- sig/generated/rbs/inline/node_utils.rbs
 - sig/generated/rbs/inline/parser.rbs
-- sig/rbs/inline.rbs
-- sig/rbs/inline/annotation_parser.rbs
-- sig/rbs/inline/ast/comment_lines.rbs
+- sig/generated/rbs/inline/version.rbs
+- sig/generated/rbs/inline/writer.rbs
 - sig/rbs/inline/ast/members.rbs
-- sig/rbs/inline/ast/tree.rbs
-- sig/rbs/inline/node_utils.rbs
-- sig/rbs/inline/writer.rbs
-- yard-samples/hello.rb
-- yard-samples/sample1.rb
 homepage: https://github.com/soutaro/rbs-inline
 licenses:
 - MIT

data/sig/rbs/inline/node_utils.rbs

@@ -1,7 +0,0 @@
-module RBS
-  module Inline
-    module NodeUtils
-      def type_name: (Prism::Node) -> TypeName?
-    end
-  end
-end

data/sig/rbs/inline/writer.rbs

@@ -1,27 +0,0 @@
-module RBS
-  module Inline
-    class Writer
-      attr_reader output: String
-
-      attr_reader writer: RBS::Writer
-
-      def self.write: (Array[AST::Annotations::Use], Array[AST::Declarations::t]) -> String
-
-      def initialize: (?String) -> void
-
-      def write: (Array[AST::Annotations::Use], Array[AST::Declarations::t]) -> void
-
-      def header: (*String) -> void
-
-      def translate_decl: (AST::Declarations::t) -> RBS::AST::Declarations::t?
-
-      def translate_class_decl: (AST::Declarations::ClassDecl) -> RBS::AST::Declarations::Class?
-
-      def translate_module_decl: (AST::Declarations::ModuleDecl) -> RBS::AST::Declarations::Module?
-
-      def translate_constant_decl: (AST::Declarations::ConstantDecl) -> RBS::AST::Declarations::Constant?
-
-      def translate_member: (AST::Members::t) -> Array[RBS::AST::Members::t | RBS::AST::Declarations::t]?
-    end
-  end
-end

data/sig/rbs/inline.rbs

@@ -1,41 +0,0 @@
-module RBS
-  module Inline
-    type token = [Symbol, String]
-
-    VERSION: String
-
-    module AST
-      module Declarations
-      end
-
-      module Annotations
-        type t = VarType
-               | ReturnType
-               | Use
-               | Inherits
-               | Generic
-               | ModuleSelf
-               | Skip
-               | Assertion
-               | Application
-               | RBSAnnotation
-               | Override
-               | IvarType
-               | Yields
-               | Embedded
-             #  | Def
-             #  | AttrReader | AttrWriter | AttrAccessor
-             #  | Include | Extend | Prepend
-             #  | Alias
-      end
-
-      module Members
-        type ruby = RubyDef | RubyAlias | RubyMixin | RubyAttr | RubyPublic | RubyPrivate
-
-        type rbs = RBSIvar | RBSEmbedded
-
-        type t = ruby | rbs
-      end
-    end
-  end
-end

data/yard-samples/hello.rb

@@ -1,6 +0,0 @@
-require "prism"
-
-ast = Prism.parse_file("yard-samples/sample1.rb")
-
-pp ast.value
-pp ast.comments

data/yard-samples/sample1.rb

@@ -1,26 +0,0 @@
-module Foo
-  # This is `Foo#foo` method
-  #
-  # @param i [Integer] Size of something
-  # @param j [Symbol,Integer] Something doing meaningful
-  # @return [String?] Returns a string or nil
-  #
-  #
-  # @rbs.method (Integer, String) -> void
-  #           | [A] () { () [self: String] -> A } -> A?
-  #
-  def foo(i, j)
-
-  end
-
-  # @rbs.inline
-  #   attr_reader hoge: String
-  #   attr_reader name: String?
-  def hoge
-
-  end
-
-  class Foo
-    # @rbs.inline include Foo[String]
-  end
-end