rbs-inline 0.4.0 → 0.6.0

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

@@ -3,11 +3,11 @@
 module RBS
   module Inline
     module AST
-      class Tree
-        type token = [ Symbol, String ]
+      type token = [ Symbol, String ]
 
-        type tree = token | Tree | Types::t | MethodType | nil
+      type tree = token | Tree | Types::t | MethodType | nil
 
+      class Tree
         attr_reader trees: Array[tree]
 
         attr_reader type: Symbol
@@ -16,21 +16,27 @@ module RBS
         attr_reader non_trivia_trees: Array[tree]
 
         # @rbs type: Symbol
-        def initialize: (Symbol type) -> untyped
+        def initialize: (Symbol type) -> void
 
         # @rbs tok: tree
-        # @rbs returns self
+        # @rbs return: self
         def <<: (tree tok) -> self
 
         # Returns the source code associated to the tree
         def to_s: () -> String
 
+        # Returns `true` if token at the given index is of the given type
+        def token?: (untyped type, at: untyped) -> untyped
+
+        # Returns `true` if tree at the given index is of the given type
+        def tree?: (untyped type, at: untyped) -> untyped
+
         # Returns n-th token from the children
         #
         # Raises if the value is not a token or nil.
         #
         # @rbs index: Integer
-        # @rbs returns token?
+        # @rbs return: token?
         def nth_token: (Integer index) -> token?
 
         # Returns n-th token from the children
@@ -38,7 +44,7 @@ module RBS
         # Returns `nil` if the value is not a token.
         #
         # @rbs index: Integer
-        # @rbs returns token?
+        # @rbs return: token?
         def nth_token?: (Integer index) -> token?
 
         # Returns n-th token from the children
@@ -46,7 +52,7 @@ module RBS
         # Raises if the value is not token.
         #
         # @rbs index: Integer
-        # @rbs returns token
+        # @rbs return: token
         def nth_token!: (Integer index) -> token
 
         # Returns n-th tree from the children
@@ -54,7 +60,7 @@ module RBS
         # Raises if the value is not a tree or nil.
         #
         # @rbs index: Integer
-        # @rbs returns Tree?
+        # @rbs return: Tree?
         def nth_tree: (Integer index) -> Tree?
 
         # Returns n-th tree from the children
@@ -62,7 +68,7 @@ module RBS
         # Returns `nil` if the value is not a tree or nil.
         #
         # @rbs index: Integer
-        # @rbs returns Tree?
+        # @rbs return: Tree?
         def nth_tree?: (Integer index) -> Tree?
 
         # Returns n-th tree from the children
@@ -70,7 +76,7 @@ module RBS
         # Raises if the value is not a tree.
         #
         # @rbs index: Integer
-        # @rbs returns Tree
+        # @rbs return: Tree
         def nth_tree!: (Integer index) -> Tree
 
         # Returns n-th type from the children
@@ -78,7 +84,7 @@ module RBS
         # Raises if the value is not a type or nil.
         #
         # @rbs index: Integer
-        # @rbs returns Types::t?
+        # @rbs return: Types::t?
         def nth_type: (Integer index) -> Types::t?
 
         # Returns n-th type from the children
@@ -86,7 +92,7 @@ module RBS
         # Returns `nil` if the value is not a type.
         #
         # @rbs index: Integer
-        # @rbs returns Types::t?
+        # @rbs return: Types::t?
         def nth_type?: (Integer index) -> Types::t?
 
         # Returns n-th type from the children
@@ -94,7 +100,7 @@ module RBS
         # Raises if the value is not a type.
         #
         # @rbs index: Integer
-        # @rbs returns Types::t
+        # @rbs return: Types::t
         def nth_type!: (Integer index) -> Types::t
 
         # Returns n-th method type from the children
@@ -102,7 +108,7 @@ module RBS
         # Raises if the value is not a method type or `nil`.
         #
         # @rbs index: Integer
-        # @rbs returns MethodType?
+        # @rbs return: MethodType?
         def nth_method_type: (Integer index) -> MethodType?
 
         # Returns n-th method type from the children
@@ -110,7 +116,7 @@ module RBS
         # Returns `nil` if the value is not a method type.
         #
         # @rbs index: Integer
-        # @rbs returns MethodType?
+        # @rbs return: MethodType?
         def nth_method_type?: (Integer index) -> MethodType?
 
         # Returns n-th method tree from the children
@@ -118,7 +124,7 @@ module RBS
         # Raises if the value is not a method tree.
         #
         # @rbs index: Integer
-        # @rbs returns MethodType
+        # @rbs return: MethodType
         def nth_method_type!: (Integer index) -> MethodType
       end
     end

data/sig/generated/rbs/inline/cli.rbs

@@ -25,12 +25,12 @@ module RBS
         # @rbs output_path: Pathname
         def initialize: (Pathname pwd, Array[Pathname] base_paths, Pathname output_path) -> void
 
-        # :: (Pathname) -> Pathname?
+        # : (Pathname) -> Pathname?
         def calculate: (Pathname) -> Pathname?
 
         # @rbs path: Pathname
         # @rbs prefix: Pathname
-        # @rbs returns bool
+        # @rbs return: bool
         def has_prefix?: (Pathname path, prefix: Pathname) -> bool
       end
 
@@ -45,7 +45,7 @@ module RBS
       def initialize: (?stdout: IO, ?stderr: IO) -> void
 
       # @rbs args: Array[String]
-      # @rbs returns Integer
+      # @rbs return: Integer
       def run: (Array[String] args) -> Integer
     end
   end

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

@@ -4,7 +4,7 @@ module RBS
   module Inline
     module NodeUtils
       # @rbs node: Prism::Node
-      # @rbs returns TypeName?
+      # @rbs return: TypeName?
       def type_name: (Prism::Node node) -> TypeName?
     end
   end

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

@@ -5,11 +5,13 @@ use Prism::*
 module RBS
   module Inline
     class Parser < Prism::Visitor
+      type with_members = AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | AST::Declarations::SingletonClassDecl | AST::Declarations::BlockDecl
+
       # The top level declarations
       attr_reader decls: Array[AST::Declarations::t]
 
       # The surrounding declarations
-      attr_reader surrounding_decls: Array[AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl]
+      attr_reader surrounding_decls: Array[with_members]
 
       # ParsingResult associated with the line number at the end
       #
@@ -30,21 +32,30 @@ module RBS
 
       def initialize: () -> void
 
+      # Parses the given Prism result to a three tuple
+      #
+      # Returns a three tuple of:
+      #
+      # 1. An array of `use` directives
+      # 2. An array of declarations
+      # 3. An array of RBS declarations given as `@rbs!` annotation at top-level
+      #
+      # Note that only RBS declarations are allowed in the top-level `@rbs!` annotations.
+      # RBS *members* are ignored in the array.
+      #
       # @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 result, opt_in: bool) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
+      # @rbs return: [Array[AST::Annotations::Use], Array[AST::Declarations::t], Array[RBS::AST::Declarations::t]]?
+      def self.parse: (ParseResult result, opt_in: bool) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t], Array[RBS::AST::Declarations::t] ]?
 
-      # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
-      def current_class_module_decl: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil)
+      # @rbs return: with_members?
+      def current_class_module_decl: () -> with_members?
 
-      # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl
-      def current_class_module_decl!: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl)
+      # @rbs return: with_members
+      def current_class_module_decl!: () -> with_members
 
-      # :: (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 | AST::Declarations::SingletonClassDecl) { () -> void } -> void
-                                | (AST::Declarations::ConstantDecl) -> void
+      # : (with_members) { () -> void } -> void
+      def push_class_module_decl: (with_members) { () -> void } -> void
 
       # Load inner declarations and delete them from `#comments` hash
       #
@@ -89,12 +100,15 @@ module RBS
       def visit_call_node: ...
 
       # @rbs new_visibility: RBS::AST::Members::visibility?
-      # @rbs block: ^() -> void
-      # @rbs returns void
+      # @rbs &block: () -> void
+      # @rbs return: void
       def push_visibility: (RBS::AST::Members::visibility? new_visibility) { () -> void } -> void
 
+      # @rbs [A] (Node) { () -> A } -> A?
+      def process_nesting_node: [A] (Node) { () -> A } -> A?
+
       # @rbs node: Node
-      # @rbs returns bool
+      # @rbs return: bool
       def ignored_node?: (Node node) -> bool
 
       # Fetch Application annotation which is associated to `node`
@@ -102,19 +116,22 @@ module RBS
       # The application annotation is removed from `comments`.
       #
       # @rbs node: Node
-      # @rbs returns AST::Annotations::Application?
+      # @rbs return: AST::Annotations::Application?
       def application_annotation: (Node node) -> AST::Annotations::Application?
 
-      # Fetch Assertion annotation which is associated to `node`
+      # Fetch TypeAssertion annotation which is associated to `node`
       #
       # The assertion annotation is removed from `comments`.
       #
       # @rbs node: Node | Location
-      # @rbs returns AST::Annotations::Assertion?
-      def assertion_annotation: (Node | Location node) -> AST::Annotations::Assertion?
+      # @rbs return: AST::Annotations::TypeAssertion?
+      def assertion_annotation: (Node | Location node) -> AST::Annotations::TypeAssertion?
 
       # @rbs override
       def visit_constant_write_node: ...
+
+      # @rbs override
+      def visit_block_node: ...
     end
   end
 end

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

@@ -3,50 +3,80 @@
 module RBS
   module Inline
     class Writer
+      interface _Content
+        def <<: (RBS::AST::Declarations::t | RBS::AST::Members::t) -> void
+
+        def concat: (Array[RBS::AST::Declarations::t | RBS::AST::Members::t]) -> void
+      end
+
       attr_reader output: String
 
       attr_reader writer: RBS::Writer
 
       # @rbs buffer: String
-      def initialize: (?String buffer) -> untyped
+      def initialize: (?String buffer) -> void
 
       # @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 rbs_decls: Array[RBS::AST::Declarations::t]
+      def self.write: (Array[AST::Annotations::Use] uses, Array[AST::Declarations::t] decls, Array[RBS::AST::Declarations::t] rbs_decls) -> void
 
-      # @rbs lines: Array[String]
-      # @rbs returns void
+      # @rbs *lines: String
+      # @rbs return: 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 rbs_decls: Array[RBS::AST::Declarations::t] --
+      #    Top level `rbs!` declarations
+      # @rbs return: void
+      def write: (Array[AST::Annotations::Use] uses, Array[AST::Declarations::t] decls, Array[RBS::AST::Declarations::t] rbs_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 rbs: _Content
+      # @rbs return: void
+      def translate_decl: (AST::Declarations::t decl, _Content rbs) -> void
 
       # @rbs decl: AST::Declarations::ClassDecl
-      # @rbs returns RBS::AST::Declarations::Class?
-      def translate_class_decl: (AST::Declarations::ClassDecl decl) -> RBS::AST::Declarations::Class?
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_class_decl: (AST::Declarations::ClassDecl decl, _Content rbs) -> void
+
+      # @rbs members: Array[AST::Declarations::t | AST::Members::t]
+      # @rbs decl: AST::Declarations::SingletonClassDecl?
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_members: (Array[AST::Declarations::t | AST::Members::t] members, AST::Declarations::SingletonClassDecl? decl, _Content rbs) -> void
 
       # @rbs decl: AST::Declarations::ModuleDecl
-      # @rbs returns RBS::AST::Declarations::Module?
-      def translate_module_decl: (AST::Declarations::ModuleDecl decl) -> RBS::AST::Declarations::Module?
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_module_decl: (AST::Declarations::ModuleDecl decl, _Content rbs) -> void
 
       # @rbs decl: AST::Declarations::ConstantDecl
-      # @rbs returns RBS::AST::Declarations::Constant?
-      def translate_constant_decl: (AST::Declarations::ConstantDecl decl) -> RBS::AST::Declarations::Constant?
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_constant_decl: (AST::Declarations::ConstantDecl decl, _Content rbs) -> void
+
+      # @rbs decl: AST::Declarations::DataAssignDecl
+      # @rbs rbs: _Content
+      def translate_data_assign_decl: (AST::Declarations::DataAssignDecl decl, _Content rbs) -> void
+
+      # @rbs decl: AST::Declarations::StructAssignDecl
+      # @rbs rbs: _Content
+      def translate_struct_assign_decl: (AST::Declarations::StructAssignDecl decl, _Content rbs) -> void
 
       # @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 rbs: _Content
+      # @rbs return: void
+      def translate_singleton_decl: (AST::Declarations::SingletonClassDecl decl, _Content rbs) -> void
 
       # @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]?
+      # @rbs decl: AST::Declarations::SingletonClassDecl? --
+      #   The surrouding singleton class definition
+      # @rbs rbs: _Content
+      # @rbs return void
+      def translate_member: (AST::Members::t member, AST::Declarations::SingletonClassDecl? decl, _Content rbs) -> void
 
       private
 
@@ -64,9 +94,19 @@ module RBS
       # ```
       #
       # @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
+      # @rbs decl: AST::Declarations::SingletonClassDecl?
+      # @rbs return: RBS::AST::Members::MethodDefinition::kind
+      def method_kind: (AST::Members::RubyDef member, AST::Declarations::SingletonClassDecl? decl) -> RBS::AST::Members::MethodDefinition::kind
+
+      # @rbs block: AST::Declarations::BlockDecl
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_module_block_decl: (AST::Declarations::BlockDecl block, _Content rbs) -> void
+
+      # @rbs block: AST::Declarations::BlockDecl
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_class_block_decl: (AST::Declarations::BlockDecl block, _Content rbs) -> void
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs-inline
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -61,6 +61,7 @@ files:
 - exe/rbs-inline
 - lib/rbs/inline.rb
 - lib/rbs/inline/annotation_parser.rb
+- lib/rbs/inline/annotation_parser/tokenizer.rb
 - lib/rbs/inline/ast/annotations.rb
 - lib/rbs/inline/ast/comment_lines.rb
 - lib/rbs/inline/ast/declarations.rb
@@ -75,6 +76,7 @@ files:
 - rbs_collection.yaml
 - sig/generated/rbs/inline.rbs
 - sig/generated/rbs/inline/annotation_parser.rbs
+- sig/generated/rbs/inline/annotation_parser/tokenizer.rbs
 - sig/generated/rbs/inline/ast/annotations.rbs
 - sig/generated/rbs/inline/ast/comment_lines.rbs
 - sig/generated/rbs/inline/ast/declarations.rbs
@@ -108,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Inline RBS type declaration.