rbs-inline 0.1.0

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

@@ -0,0 +1,185 @@
+# Generated from lib/rbs/inline/ast/annotations.rb with RBS::Inline
+
+module RBS
+  module Inline
+    module AST
+      module Annotations
+        class Base
+          attr_reader source: CommentLines
+
+          attr_reader tree: Tree
+
+          # @rbs tree: Tree
+          # @rbs source: CommentLines
+          # @rbs returns void
+          def initialize: (Tree tree, CommentLines source) -> void
+        end
+
+        class VarType < Base
+          attr_reader name: Symbol
+
+          attr_reader type: Types::t?
+
+          attr_reader comment: String?
+
+          # @rbs override
+          def initialize: ...
+
+          # :: () -> bool
+          def complete?: () -> bool
+        end
+
+        # `@rbs returns T`
+        class ReturnType < Base
+          attr_reader type: Types::t?
+
+          attr_reader comment: String?
+
+          # @rbs override
+          def initialize: ...
+
+          # @rbs returns bool
+          def complete?: () -> bool
+        end
+
+        # `@rbs @foo: T` or `@rbs self.@foo: T`
+        class IvarType < Base
+          attr_reader name: Symbol
+
+          attr_reader type: Types::t?
+
+          attr_reader class_instance: bool
+
+          attr_reader comment: String?
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `#:: TYPE`
+        class Assertion < Base
+          attr_reader type: Types::t | MethodType | nil
+
+          def initialize: (untyped tree, untyped source) -> untyped
+
+          # @rbs returns bool
+          def complete?: () -> bool
+
+          # Returns a type if it's type
+          def type?: () -> Types::t?
+
+          # Returns a method type if it's a method type
+          def method_type?: () -> MethodType?
+        end
+
+        # `#[TYPE, ..., TYPE]`
+        class Application < Base
+          attr_reader types: Array[Types::t]?
+
+          # @rbs override
+          def initialize: ...
+
+          # @rbs returns bool
+          def complete?: () -> bool
+        end
+
+        # `# @rbs yields () -> void -- Comment`
+        class Yields < Base
+          # The type of block
+          #
+          # * Types::Block when syntactically correct input is given
+          # * String when syntax error is reported
+          # * `nil` when nothing is given
+          attr_reader block_type: Types::Block | String | nil
+
+          # The content of the comment or `nil`
+          attr_reader comment: String?
+
+          # If `[optional]` token is inserted just after `yields` token
+          #
+          # The Types::Block instance has correct `required` attribute based on the `[optional]` token.
+          # This is for the other cases, syntax error or omitted.
+          attr_reader optional: bool
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs %a{a} %a{a} ...`
+        class RBSAnnotation < Base
+          attr_reader contents: Array[String]
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs skip`
+        class Skip < Base
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs inherits T`
+        class Inherits < Base
+          attr_reader super_name: TypeName?
+
+          attr_reader args: Array[Types::t]?
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs override`
+        #
+        # Specify the method types as `...` (overriding super class method)
+        class Override < Base
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs use [USES]`
+        class Use < Base
+          attr_reader clauses: Array[RBS::AST::Directives::Use::clause]
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs module-self [MODULE_SELF]`
+        class ModuleSelf < Base
+          attr_reader constraint: RBS::AST::Declarations::Module::Self?
+
+          attr_reader comment: String?
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs generic [type param]`
+        #
+        # ```rb
+        # # @rbs generic X
+        # # @rbs generic in Y
+        # # @rbs generic unchecked out Z < String -- Comment here
+        # ```
+        class Generic < Base
+          # TypeParam object or `nil` if syntax error
+          attr_reader type_param: RBS::AST::TypeParam?
+
+          attr_reader comment: String?
+
+          # @rbs override
+          def initialize: ...
+        end
+
+        # `# @rbs!` annotation
+        class Embedded < Base
+          attr_reader content: String
+
+          # @rbs override
+          def initialize: ...
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# Generated from lib/rbs/inline/ast/declarations.rb with RBS::Inline
+
+module RBS
+  module Inline
+    module AST
+      module Declarations
+        module ConstantUtil
+          # @rbs node: Prism::Node
+          # @rbs returns TypeName?
+          def type_name: (Prism::Node node) -> TypeName?
+        end
+
+        type t = ClassDecl | ModuleDecl | ConstantDecl
+
+        interface _WithComments
+          def comments: () -> AnnotationParser::ParsingResult?
+        end
+
+        # @rbs module-self _WithComments
+        module Generics : _WithComments
+          # @rbs returns Array[RBS::AST::TypeParam]
+          def type_params: () -> Array[RBS::AST::TypeParam]
+        end
+
+        class Base
+        end
+
+        # @rbs generic NODE < Prism::Node
+        class ModuleOrClass[NODE < Prism::Node] < Base
+          # The node that represents the declaration
+          attr_reader node: NODE
+
+          # Leading comment
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          # Members included in the declaration
+          attr_reader members: Array[Members::t | t]
+
+          # @rbs node: NODE
+          # @rbs comments: AnnotationParser::ParsingResult?
+          def initialize: (NODE node, AnnotationParser::ParsingResult? comments) -> void
+
+          # Type parameters for the declaration
+          def type_params: () -> Array[RBS::AST::TypeParam]
+
+          def start_line: () -> Integer
+        end
+
+        class ClassDecl < ModuleOrClass[Prism::ClassNode]
+          include ConstantUtil
+
+          # Type application for super class
+          attr_reader super_app: Annotations::Application?
+
+          # @rbs node: Prism::ClassNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          # @rbs super_app: Annotations::Application?
+          # @rbs returns void
+          def initialize: (Prism::ClassNode node, AnnotationParser::ParsingResult? comments, Annotations::Application? super_app) -> void
+
+          # @rbs %a{pure}
+          %a{pure}
+          def class_name: () -> TypeName?
+
+          # @rbs %a{pure}
+          %a{pure}
+          def super_class: () -> RBS::AST::Declarations::Class::Super?
+        end
+
+        class ModuleDecl < ModuleOrClass[Prism::ModuleNode]
+          include ConstantUtil
+
+          # @rbs %a{pure}
+          %a{pure}
+          def module_name: () -> TypeName?
+
+          # @rbs %a{pure}
+          %a{pure}
+          def module_selfs: () -> Array[Annotations::ModuleSelf]
+        end
+
+        class ConstantDecl < Base
+          include ConstantUtil
+
+          attr_reader node: Prism::ConstantWriteNode
+
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          attr_reader assertion: Annotations::Assertion?
+
+          # @rbs node: Prism::ConstantWriteNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          # @rbs assertion: Annotations::Assertion?
+          def initialize: (Prism::ConstantWriteNode node, AnnotationParser::ParsingResult? comments, Annotations::Assertion? assertion) -> untyped
+
+          # @rbs %a{pure}
+          # @rbs returns Types::t
+          %a{pure}
+          def type: () -> Types::t
+
+          # @rbs %a{pure}
+          # @rbs return Types::t?
+          %a{pure}
+          def literal_type: () -> untyped
+
+          # @rbs %a{pure}
+          # @rbs returns TypeName?
+          %a{pure}
+          def constant_name: () -> TypeName?
+
+          def start_line: () -> Integer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+# Generated from lib/rbs/inline/ast/members.rb with RBS::Inline
+
+module RBS
+  module Inline
+    module AST
+      module Members
+        class Base
+          attr_reader location: Prism::Location
+
+          # @rbs location: Prism::Location
+          def initialize: (Prism::Location location) -> void
+
+          def start_line: () -> Integer
+        end
+
+        class RubyBase < Base
+        end
+
+        class RubyDef < RubyBase
+          attr_reader node: Prism::DefNode
+
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          # The visibility directly attached to the `def` node
+          #
+          # `nil` when the `def` node is not passed to `private`/`public` calls.
+          #
+          # ```rb
+          # def foo() end            # <= nil
+          # private def foo() end    # <= :private
+          # ```
+          attr_reader visibility: RBS::AST::Members::visibility?
+
+          attr_reader assertion: Annotations::Assertion?
+
+          # @rbs node: Prism::DefNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          # @rbs visibility: RBS::AST::Members::visibility?
+          # @rbs assertion: Annotations::Assertion?
+          def initialize: (Prism::DefNode node, AnnotationParser::ParsingResult? comments, RBS::AST::Members::visibility? visibility, Annotations::Assertion? assertion) -> void
+
+          # Returns the name of the method
+          def method_name: () -> Symbol
+
+          def method_type_annotations: () -> Array[Annotations::Assertion]
+
+          # Returns the `kind` of the method definition
+          #
+          # [FIXME] It only supports `self` receiver.
+          #
+          # ```rb
+          # def self.foo = ()    # :sigleton
+          # 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?]
+
+          def method_overloads: () -> Array[RBS::AST::Members::MethodDefinition::Overload]
+
+          def method_annotations: () -> Array[RBS::AST::Annotation]
+
+          def override_annotation: () -> AST::Annotations::Override?
+
+          def yields_annotation: () -> AST::Annotations::Yields?
+        end
+
+        class RubyAlias < RubyBase
+          attr_reader node: Prism::AliasMethodNode
+
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          # @rbs node: Prism::AliasMethodNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          def initialize: (Prism::AliasMethodNode node, AnnotationParser::ParsingResult? comments) -> untyped
+
+          # @rbs returns Symbol -- the name of *old* method
+          def old_name: () -> Symbol
+
+          # @rbs returns Symbol -- the name of *new* method
+          def new_name: () -> Symbol
+        end
+
+        class RubyMixin < RubyBase
+          # CallNode that calls `include`, `prepend`, and `extend` method
+          attr_reader node: Prism::CallNode
+
+          # Comments attached to the call node
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          # Possible following type application annotation
+          attr_reader application: Annotations::Application?
+
+          # @rbs node: Prism::CallNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          # @rbs application: Annotations::Application?
+          # @rbs returns void
+          def initialize: (Prism::CallNode node, AnnotationParser::ParsingResult? comments, Annotations::Application? application) -> void
+
+          # @rbs returns ::RBS::AST::Members::Include
+          #            | ::RBS::AST::Members::Extend
+          #            | ::RBS::AST::Members::Prepend
+          #            | nil
+          def rbs: () -> (::RBS::AST::Members::Include | ::RBS::AST::Members::Extend | ::RBS::AST::Members::Prepend | nil)
+        end
+
+        class RubyAttr < RubyBase
+          attr_reader node: Prism::CallNode
+
+          attr_reader comments: AnnotationParser::ParsingResult?
+
+          attr_reader assertion: Annotations::Assertion?
+
+          # @rbs node: Prism::CallNode
+          # @rbs comments: AnnotationParser::ParsingResult?
+          # @rbs assertion: Annotations::Assertion?
+          # @rbs returns void
+          def initialize: (Prism::CallNode node, AnnotationParser::ParsingResult? comments, Annotations::Assertion? assertion) -> void
+
+          # @rbs return Array[RBS::AST::Members::AttrReader | RBS::AST::Members::AttrWriter | RBS::AST::Members::AttrAccessor]?
+          def rbs: () -> untyped
+
+          # Returns the type of the attribute
+          #
+          # Returns `untyped` when not annotated.
+          def attribute_type: () -> Types::t
+        end
+
+        # `private` call without arguments
+        class RubyPrivate < RubyBase
+          attr_reader node: Prism::CallNode
+
+          # @rbs node: Prism::CallNode
+          def initialize: (Prism::CallNode node) -> void
+        end
+
+        # `public` call without arguments
+        class RubyPublic < RubyBase
+          attr_reader node: Prism::CallNode
+
+          # @rbs node: Prism::CallNode
+          def initialize: (Prism::CallNode node) -> void
+        end
+
+        class RBSBase < Base
+        end
+
+        class RBSIvar < RBSBase
+          attr_reader annotation: Annotations::IvarType
+
+          attr_reader comment: AnnotationParser::ParsingResult
+
+          # @rbs comment: AnnotationParser::ParsingResult
+          # @rbs annotation: Annotations::IvarType
+          def initialize: (AnnotationParser::ParsingResult comment, Annotations::IvarType annotation) -> void
+
+          def rbs: () -> (RBS::AST::Members::InstanceVariable | RBS::AST::Members::ClassInstanceVariable | nil)
+        end
+
+        class RBSEmbedded < RBSBase
+          attr_reader annotation: Annotations::Embedded
+
+          attr_reader comment: AnnotationParser::ParsingResult
+
+          # @rbs comment: AnnotationParser::ParsingResult
+          # @rbs annotation: Annotations::Embedded
+          def initialize: (AnnotationParser::ParsingResult comment, Annotations::Embedded annotation) -> void
+
+          # Returns the array of `RBS::AST` members
+          #
+          # Returns `RBS::ParsingError` when the `content` has syntax error.
+          def members: () -> (Array[RBS::AST::Members::t | RBS::AST::Declarations::t] | RBS::ParsingError)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# Generated from lib/rbs/inline/cli.rb with RBS::Inline
+
+module RBS
+  module Inline
+    class CLI
+      attr_reader stdout: IO
+
+      attr_reader stderr: IO
+
+      attr_reader logger: Logger
+
+      # @rbs stdout: IO
+      # @rbs stderr: IO
+      def initialize: (?stdout: IO, ?stderr: IO) -> void
+
+      # @rbs args: Array[String]
+      # @rbs returns Integer
+      def run: (Array[String] args) -> Integer
+    end
+  end
+end

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

@@ -0,0 +1,116 @@
+# Generated from lib/rbs/inline/parser.rb with RBS::Inline
+
+use Prism::*
+
+module RBS
+  module Inline
+    class Parser < Prism::Visitor
+      # 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]
+
+      # ParsingResult associated with the line number at the end
+      #
+      # ```rb
+      # # Hello
+      # # world       <= The comments hash includes `2` (line 2) to the two lines
+      # ```
+      #
+      # > [!IMPORTANT]
+      # > The values will be removed during parsing.
+      attr_reader comments: Hash[Integer, AnnotationParser::ParsingResult]
+
+      # The current visibility applied to single `def` node
+      #
+      # Assuming it's directly inside `private` or `public` calls.
+      # `nil` when the `def` node is not inside `private` or `public` calls.
+      attr_reader current_visibility: RBS::AST::Members::visibility?
+
+      def initialize: () -> void
+
+      # @rbs result: ParseResult[ProgramNode]
+      # @rbs returns [Array[AST::Annotations::Use], Array[AST::Declarations::t]]?
+      def self.parse: (ParseResult[ProgramNode] result) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
+
+      # @rbs rturns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
+      def current_class_module_decl: () -> untyped
+
+      # @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::ConstantDecl) -> void
+      def push_class_module_decl: (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl) { () -> void } -> void
+                                | (AST::Declarations::ConstantDecl) -> void
+
+      # Load inner declarations and delete them from `#comments` hash
+      #
+      # It also sorts the `members` by `#start_line`` ascending.
+      #
+      # @rbs start_line: Integer
+      # @rbs end_line: Integer
+      # @rbs members: Array[AST::Members::t | AST::Declarations::t] --
+      #   The destination.
+      #   The method doesn't insert declarations, but have it to please type checker.
+      def load_inner_annotations: (Integer start_line, Integer end_line, Array[AST::Members::t | AST::Declarations::t] members) -> void
+
+      # @rbs override
+      def visit_class_node: ...
+
+      # @rbs override
+      def visit_module_node: ...
+
+      # Returns an array of annotations from comments that is located between start_line and end_line
+      #
+      # ```rb
+      # module Foo        # line 1 (start_line)
+      #   # foo
+      #   # bar
+      # end               # line 4 (end_line)
+      # ```
+      #
+      # @rbs start_line: Integer
+      # @rbs end_line: Integer
+      def inner_annotations: (Integer start_line, Integer end_line) -> Array[AnnotationParser::ParsingResult]
+
+      # @rbs override
+      def visit_def_node: ...
+
+      # @rbs override
+      def visit_alias_method_node: ...
+
+      # @rbs override
+      def visit_call_node: ...
+
+      # @rbs new_visibility: RBS::AST::Members::visibility?
+      # @rbs block: ^() -> void
+      # @rbs returns void
+      def push_visibility: (RBS::AST::Members::visibility? new_visibility) { () -> void } -> void
+
+      # @rbs node: Node
+      # @rbs returns bool
+      def ignored_node?: (Node node) -> bool
+
+      # Fetch Application annotation which is associated to `node`
+      #
+      # The application annotation is removed from `comments`.
+      #
+      # @rbs node: Node
+      # @rbs returns AST::Annotations::Application?
+      def application_annotation: (Node node) -> AST::Annotations::Application?
+
+      # Fetch Assertion 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 override
+      def visit_constant_write_node: ...
+    end
+  end
+end

data/sig/rbs/inline/ast/comment_lines.rbs

@@ -0,0 +1,27 @@
+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/members.rbs

@@ -0,0 +1,24 @@
+# use RBS::AST::Members::MethodDefinition::Overload
+
+# module RBS
+#   module Inline
+#     module AST
+#       # module Members
+#       #   type ruby = RubyDef | RubyAlias | RubyMixin | RubyAttr | RubyPublic | RubyPrivate
+
+#       #   type rbs = RBSDef | RBSAlias | RBSAttr | RBSIvar
+
+#       #   type t = ruby | rbs
+
+#       #   class RBSDef < Base
+#       #   end
+
+#       #   class RBSAlias < Base
+#       #   end
+
+#       #   class RBSAttr < Base
+#       #   end
+#       # end
+#     end
+#   end
+# end