rbs-inline 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '091f44026573a60f39acf39a0b8865a3cee4a4f72401cd0ab8ce37d9e397caad'
-  data.tar.gz: 95236c91fac2461db268a7fbd81503210d0d818bad958a6b9ff03d708a28558b
+  metadata.gz: 713b2bd4c5ddd833fa1bd1a71505924081013101a8a41200a88fed55751146ba
+  data.tar.gz: 44ffe7a91c0c0afeb7e163a02de508c50f96a609ae7c64593a6b739109ac11b0
 SHA512:
-  metadata.gz: e76c5c6311109ffbac3a157625370a42f7f8b0cd2e1be58f8de4352d5e1528027acff819ecf7db6d9a6bb16bbb478adadfcb09d474816f7cc942a5a42be63729
-  data.tar.gz: 8d7d4aba2f04cac960975add67c7d7ad30366806a540cd899a11f1250a7045145a9578732c055cf75ad50d1a68949d6aea55c7f7e3077d958aafb042f7c52149
+  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

@@ -9,23 +9,13 @@ module RBS
           # @rbs returns TypeName?
           def type_name(node)
             case node
-            when Prism::ConstantReadNode
-              TypeName(node.name.to_s)
-            when Prism::ConstantPathNode
-              if node.parent
-                if parent = type_name(node.parent)
-                  if child = type_name(node.child)
-                    return parent + child
-                  end
-                end
-              else
-                type_name(node.child)&.absolute!
-              end
+            when Prism::ConstantReadNode, Prism::ConstantPathNode
+              TypeName(node.full_name)
             end
           end
         end
 
-        # @rbs! type t = ClassDecl | ModuleDecl | ConstantDecl
+        # @rbs! type t = ClassDecl | ModuleDecl | ConstantDecl | SingletonClassDecl
 
         # @rbs!
         #  interface _WithComments
@@ -237,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/cli.rb

@@ -72,15 +72,28 @@ module RBS
       def run(args)
         base_paths = [Pathname("lib"), Pathname("app")]
         output_path = nil #: Pathname?
+        opt_in = true
 
         OptionParser.new do |opts|
-          opts.on("--base=[BASE]", "The path to calculate relative path of files (defaults to #{base_paths.join(File::PATH_SEPARATOR)})") do |str|
+          opts.on("--base=BASE", "The path to calculate relative path of files (defaults to #{base_paths.join(File::PATH_SEPARATOR)})") do |str|
             # @type var str: String
             base_paths = str.split(File::PATH_SEPARATOR).map {|path| Pathname(path) }
           end
 
-          opts.on("--output=[BASE]", "The directory where the RBS files are saved at (defaults to STDOUT if not specified)") do
-            output_path = Pathname(_1)
+          opts.on("--output[=DEST]", "Save the generated RBS files under `sig/generated` or DEST if specified (defaults to output to STDOUT)") do
+            if _1
+              output_path = Pathname(_1)
+            else
+              output_path = Pathname("sig/generated")
+            end
+          end
+
+          opts.on("--opt-out", "Generates RBS files by default. Opt-out with `# rbs_inline: disabled` comment") do
+            opt_in = false
+          end
+
+          opts.on("--opt-in", "Generates RBS files only for files with `# rbs_inline: enabled` comment (default)") do
+            opt_in = true
           end
 
           opts.on("--verbose") do
@@ -126,7 +139,7 @@ module RBS
 
           logger.debug { "Parsing ruby file #{target}..." }
 
-          if (uses, decls = Parser.parse(Prism.parse_file(target.to_s)))
+          if (uses, decls = Parser.parse(Prism.parse_file(target.to_s), opt_in: opt_in))
             writer = Writer.new()
             writer.header("Generated from #{target.relative? ? target : target.relative_path_from(Pathname.pwd)} with RBS::Inline")
             writer.write(uses, decls)

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

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 # @rbs use Prism::*
 
 module RBS
@@ -36,22 +38,26 @@ module RBS
         @comments = {}
       end
 
-      # @rbs result: ParseResult[ProgramNode]
+      # @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(result)
+      def self.parse(result, opt_in:)
         instance = Parser.new()
 
-        # pp result
-
         annots = AnnotationParser.parse(result.comments)
         annots.each do |result|
           instance.comments[result.line_range.end] = result
         end
 
-        with_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
-        with_annotation = annots.any? {|result| result.annotations.any? }
+        with_enable_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
+        with_disable_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: disabled\Z/}
 
-        return unless with_magic_comment || with_annotation
+        return if with_disable_magic_comment # Skips if `rbs_inline: disabled`
+
+        if opt_in
+          # opt-in means the `rbs_inline: enable` is required.
+          return unless with_enable_magic_comment
+        end
 
         uses = [] #: Array[AST::Annotations::Use]
         annots.each do |annot|
@@ -80,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
@@ -146,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.2.0"
+    VERSION = "0.4.0"
   end
 end