rbs-inline 0.1.0

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

@@ -0,0 +1,98 @@
+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

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

data/sig/rbs/inline/writer.rbs

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,41 @@
+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

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

data/yard-samples/sample1.rb

@@ -0,0 +1,26 @@
+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

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rbs-inline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Soutaro Matsumoto
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0.pre
+description: Inline RBS type declaration.
+email:
+- matsumoto@soutaro.com
+executables:
+- rbs-inline
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- exe/rbs-inline
+- lib/rbs/inline.rb
+- lib/rbs/inline/annotation_parser.rb
+- lib/rbs/inline/ast/annotations.rb
+- lib/rbs/inline/ast/comment_lines.rb
+- lib/rbs/inline/ast/declarations.rb
+- lib/rbs/inline/ast/members.rb
+- lib/rbs/inline/ast/tree.rb
+- lib/rbs/inline/cli.rb
+- lib/rbs/inline/node_utils.rb
+- lib/rbs/inline/parser.rb
+- lib/rbs/inline/version.rb
+- lib/rbs/inline/writer.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/generated/rbs/inline/annotation_parser.rbs
+- sig/generated/rbs/inline/ast/annotations.rbs
+- sig/generated/rbs/inline/ast/declarations.rbs
+- sig/generated/rbs/inline/ast/members.rbs
+- sig/generated/rbs/inline/cli.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/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
+metadata:
+  homepage_uri: https://github.com/soutaro/rbs-inline
+  source_code_uri: https://github.com/soutaro/rbs-inline
+  changelog_uri: https://github.com/soutaro/rbs-inline/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Inline RBS type declaration.
+test_files: []