rbs-inline 0.3.0 → 0.5.0

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) { () -> void } -> void
-      # :: (AST::Declarations::ConstantDecl) -> void
-      def push_class_module_decl: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl) { () -> 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
       #
@@ -60,6 +71,9 @@ module RBS
       # @rbs override
       def visit_class_node: ...
 
+      # @rbs override
+      def visit_singleton_class_node: ...
+
       # @rbs override
       def visit_module_node: ...
 
@@ -86,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`
@@ -99,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/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,104 @@
+# Generated from lib/rbs/inline/writer.rb with RBS::Inline
+
+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) -> void
+
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
+      # @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: String
+      # @rbs return: void
+      def header: (*String lines) -> void
+
+      # @rbs uses: Array[AST::Annotations::Use]
+      # @rbs decls: Array[AST::Declarations::t]
+      # @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 rbs: _Content
+      # @rbs return: void
+      def translate_decl: (AST::Declarations::t decl, _Content rbs) -> void
+
+      # @rbs decl: AST::Declarations::ClassDecl
+      # @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 rbs: _Content
+      # @rbs return: void
+      def translate_module_decl: (AST::Declarations::ModuleDecl decl, _Content rbs) -> void
+
+      # @rbs decl: AST::Declarations::ConstantDecl
+      # @rbs rbs: _Content
+      # @rbs return: void
+      def translate_constant_decl: (AST::Declarations::ConstantDecl decl, _Content rbs) -> void
+
+      # @rbs decl: AST::Declarations::SingletonClassDecl
+      # @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::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
+
+      # 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::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

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.5.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-07-01 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
@@ -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
@@ -73,21 +74,20 @@ 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/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
 - 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/ast/comment_lines.rbs

@@ -1,27 +0,0 @@
-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: Array[[Prism::Comment, Integer]]
-
-        def initialize: (Array[Prism::Comment]) -> void
-
-        def string: () -> String
-
-        def comment_location: (Integer index) -> [Prism::Comment, Integer]?
-      end
-    end
-  end
-end

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

@@ -1,98 +0,0 @@
-module RBS
-  module Inline
-    module AST
-      class Tree
-        type token = [Symbol, String]
-
-        type tree = token | Tree | Types::t | MethodType | nil
-
-        attr_reader trees: Array[tree]
-
-        # Children but without `tWHITESPACE` tokens
-        #
-        attr_reader non_trivia_trees: Array[tree]
-
-        attr_reader type: Symbol
-
-        def initialize: (Symbol type) -> void
-
-        def <<: (tree) -> self
-
-        # Returns n-th token from the children
-        #
-        # Raises if the value is not a token or nil.
-        #
-        def nth_token: (Integer) -> token?
-
-        # Returns n-th token from the children
-        #
-        # Returns `nil` if the value is not a token.
-        #
-        def nth_token?: (Integer) -> token?
-
-        # Returns n-th token from the children
-        #
-        # Raises if the value is not token.
-        #
-        def nth_token!: (Integer) -> token
-
-        # Returns n-th tree from the children
-        #
-        # Raises if the value is not a tree or nil.
-        #
-        def nth_tree: (Integer) -> Tree?
-
-        # Returns n-th tree from the children
-        #
-        # Returns `nil` if the value is not a tree or nil.
-        #
-        def nth_tree?: (Integer) -> Tree?
-
-        # Returns n-th tree from the children
-        #
-        # Raises if the value is not a tree.
-        #
-        def nth_tree!: (Integer) -> Tree
-
-        # Returns n-th type from the children
-        #
-        # Raises if the value is not a tree or nil.
-        #
-        def nth_type: (Integer) -> Types::t?
-
-        # Returns n-th type from the children
-        #
-        # Returns `nil` if the value is not a type.
-        #
-        def nth_type?: (Integer) -> Types::t?
-
-        # Returns n-th type from the children
-        #
-        # Raises if the value is not a type.
-        #
-        def nth_type!: (Integer) -> 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?
-
-        # Returns n-th method type from the children
-        #
-        # Returns `nil` if the value is not a method type.
-        #
-        def nth_method_type?: (Integer) -> 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
-      end
-    end
-  end
-end

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